Class: FinnhubRuby::SearchBody

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SearchBody

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
247
248
249
250
251
252
253
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 153

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#acts ⇒ Object

List of SEC’s exchanges act to search, comma separated. Look at /filter endpoint to see all available values.



64
65
66
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 64

def acts
  @acts
end

#caps ⇒ Object

List of market capitalization to search, comma separated. Look at /filter endpoint to see all available values.



67
68
69
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 67

def caps
  @caps
end

#ch_ids ⇒ Object

List of Companies House number to search, comma separated (Max: 50).



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

def ch_ids
  @ch_ids
end

#ciks ⇒ Object

List of SEC Center Index Key to search, comma separated (Max: 50).



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

def ciks
  @ciks
end

#countries ⇒ Object

List of sources to search, comma separated (Max: 50). Look at /filter endpoint to see all available values.



61
62
63
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 61

def countries
  @countries
end

#cusips ⇒ Object

List of cusip to search, comma separated (Max: 50).



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

def cusips
  @cusips
end

#exchanges ⇒ Object

List of exchanges to search, comma separated (Max: 50). Look at /filter endpoint to see all available values.



58
59
60
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 58

def exchanges
  @exchanges
end

#exhibits ⇒ Object

List of exhibits to search, comma separated (Max: 50). Look at /filter endpoint to see all available values.



55
56
57
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 55

def exhibits
  @exhibits
end

#forms ⇒ Object

List of forms to search, comma separated (Max: 50). Look at /filter endpoint to see all available values.



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

def forms
  @forms
end

#from_date ⇒ Object

Search from date in format: YYYY-MM-DD, default from the last 2 years



70
71
72
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 70

def from_date
  @from_date
end

#gics ⇒ Object

List of gics to search, comma separated (Max: 50). Look at /filter endpoint to see all available values.



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

def gics
  @gics
end

#highlighted ⇒ Object

Enable highlight in returned filings. If enabled, only return 10 results each time



82
83
84
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 82

def highlighted
  @highlighted
end

#isins ⇒ Object

List of isin to search, comma separated (Max: 50).



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

def isins
  @isins
end

#naics ⇒ Object

List of sources to search, comma separated (Max: 50). Look at /filter endpoint to see all available values.



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

def naics
  @naics
end

#page ⇒ Object

Use for pagination, default to page 1



76
77
78
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 76

def page
  @page
end

#query ⇒ Object

Search query



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

def query
  @query
end

#sedar_ids ⇒ Object

List of SEDAR issuer number to search, comma separated (Max: 50).



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

def sedar_ids
  @sedar_ids
end

#sedols ⇒ Object

List of sedols to search, comma separated (Max: 50).



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

def sedols
  @sedols
end

#sort ⇒ Object

Sort result by, default: sortMostRecent. Look at /filter endpoint to see all available values.



79
80
81
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 79

def sort
  @sort
end

#sources ⇒ Object

List of sources to search, comma separated (Max: 50). Look at /filter endpoint to see all available values.



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

def sources
  @sources
end

#symbols ⇒ Object

List of symbols to search, comma separated (Max: 50).



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

def symbols
  @symbols
end

#to_date ⇒ Object

Search to date in format: YYYY-MM-DD, default to today



73
74
75
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 73

def to_date
  @to_date
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



113
114
115
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 113

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 85

def self.attribute_map
  {
    :'query' => :'query',
    :'isins' => :'isins',
    :'cusips' => :'cusips',
    :'ciks' => :'ciks',
    :'sedar_ids' => :'sedarIds',
    :'ch_ids' => :'chIds',
    :'symbols' => :'symbols',
    :'sedols' => :'sedols',
    :'sources' => :'sources',
    :'forms' => :'forms',
    :'gics' => :'gics',
    :'naics' => :'naics',
    :'exhibits' => :'exhibits',
    :'exchanges' => :'exchanges',
    :'countries' => :'countries',
    :'acts' => :'acts',
    :'caps' => :'caps',
    :'from_date' => :'fromDate',
    :'to_date' => :'toDate',
    :'page' => :'page',
    :'sort' => :'sort',
    :'highlighted' => :'highlighted'
  }
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



317
318
319
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 317

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



146
147
148
149
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 146

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

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 118

def self.openapi_types
  {
    :'query' => :'String',
    :'isins' => :'String',
    :'cusips' => :'String',
    :'ciks' => :'String',
    :'sedar_ids' => :'String',
    :'ch_ids' => :'String',
    :'symbols' => :'String',
    :'sedols' => :'String',
    :'sources' => :'String',
    :'forms' => :'String',
    :'gics' => :'String',
    :'naics' => :'String',
    :'exhibits' => :'String',
    :'exchanges' => :'String',
    :'countries' => :'String',
    :'acts' => :'String',
    :'caps' => :'String',
    :'from_date' => :'String',
    :'to_date' => :'String',
    :'page' => :'String',
    :'sort' => :'String',
    :'highlighted' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 275

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      query == o.query &&
      isins == o.isins &&
      cusips == o.cusips &&
      ciks == o.ciks &&
      sedar_ids == o.sedar_ids &&
      ch_ids == o.ch_ids &&
      symbols == o.symbols &&
      sedols == o.sedols &&
      sources == o.sources &&
      forms == o.forms &&
      gics == o.gics &&
      naics == o.naics &&
      exhibits == o.exhibits &&
      exchanges == o.exchanges &&
      countries == o.countries &&
      acts == o.acts &&
      caps == o.caps &&
      from_date == o.from_date &&
      to_date == o.to_date &&
      page == o.page &&
      sort == o.sort &&
      highlighted == o.highlighted
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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 347

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 418

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



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 324

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


304
305
306
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 304

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



310
311
312
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 310

def hash
  [query, isins, cusips, ciks, sedar_ids, ch_ids, symbols, sedols, sources, forms, gics, naics, exhibits, exchanges, countries, acts, caps, from_date, to_date, page, sort, highlighted].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



257
258
259
260
261
262
263
264
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 257

def list_invalid_properties
  invalid_properties = Array.new
  if @query.nil?
    invalid_properties.push('invalid value for "query", query 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



394
395
396
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 394

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 400

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



388
389
390
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 388

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



268
269
270
271
 
# File 'lib/finnhub_ruby/models/search_body.rb', line 268

def valid?
  return false if @query.nil?
  true
end