Class: FinnhubRuby::SimilarityIndexInfo

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SimilarityIndexInfo

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accepted_date ⇒ Object

Accepted date %Y-%m-%d %H:%M:%S.



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

def accepted_date
  @accepted_date
end

#access_number ⇒ Object

Access number.



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

def access_number
  @access_number
end

#cik ⇒ Object

CIK.



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

def cik
  @cik
end

#filed_date ⇒ Object

Filed date %Y-%m-%d %H:%M:%S.



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

def filed_date
  @filed_date
end

#filing_url ⇒ Object

Filing’s URL.



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

def filing_url
  @filing_url
end

#form ⇒ Object

Form type.



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

def form
  @form
end

#item1 ⇒ Object

Cosine similarity of Item 1 (Business). This number is only available for Annual reports.



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

def item1
  @item1
end

#item1a ⇒ Object

Cosine similarity of Item 1A (Risk Factors). This number is available for both Annual and Quarterly reports.



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

def item1a
  @item1a
end

#item2 ⇒ Object

Cosine similarity of Item 2 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Quarterly reports.



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

def item2
  @item2
end

#item7 ⇒ Object

Cosine similarity of Item 7 (Management’s Discussion and Analysis of Financial Condition and Results of Operations). This number is only available for Annual reports.



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

def item7
  @item7
end

#item7a ⇒ Object

Cosine similarity of Item 7A (Quantitative and Qualitative Disclosures About Market Risk). This number is only available for Annual reports.



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

def item7a
  @item7a
end

#report_url ⇒ Object

Report’s URL.



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

def report_url
  @report_url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.attribute_map
  {
    :'cik' => :'cik',
    :'item1' => :'item1',
    :'item1a' => :'item1a',
    :'item2' => :'item2',
    :'item7' => :'item7',
    :'item7a' => :'item7a',
    :'access_number' => :'accessNumber',
    :'form' => :'form',
    :'filed_date' => :'filedDate',
    :'accepted_date' => :'acceptedDate',
    :'report_url' => :'reportUrl',
    :'filing_url' => :'filingUrl'
  }
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



212
213
214
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 212

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/similarity_index_info.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/similarity_index_info.rb', line 78

def self.openapi_types
  {
    :'cik' => :'String',
    :'item1' => :'Float',
    :'item1a' => :'Float',
    :'item2' => :'Float',
    :'item7' => :'Float',
    :'item7a' => :'Float',
    :'access_number' => :'String',
    :'form' => :'String',
    :'filed_date' => :'String',
    :'accepted_date' => :'String',
    :'report_url' => :'String',
    :'filing_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      cik == o.cik &&
      item1 == o.item1 &&
      item1a == o.item1a &&
      item2 == o.item2 &&
      item7 == o.item7 &&
      item7a == o.item7a &&
      access_number == o.access_number &&
      form == o.form &&
      filed_date == o.filed_date &&
      accepted_date == o.accepted_date &&
      report_url == o.report_url &&
      filing_url == o.filing_url
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



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
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 242

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



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

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 219

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


199
200
201
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 205

def hash
  [cik, item1, item1a, item2, item7, item7a, access_number, form, filed_date, accepted_date, report_url, filing_url].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



167
168
169
170
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 167

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



289
290
291
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 289

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



295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 295

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



283
284
285
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 283

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



174
175
176
 
# File 'lib/finnhub_ruby/models/similarity_index_info.rb', line 174

def valid?
  true
end