Class: FinnhubRuby::DocumentResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
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
111
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 73

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

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

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

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

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

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

Instance Attribute Details

#document_id ⇒ Object

AlphaResearch internal document id.



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

def document_id
  @document_id
end

#excerpts ⇒ Object

Highlighted excerpts for this document



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

def excerpts
  @excerpts
end

#format ⇒ Object

Format of this document (can be html or pdf)



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

def format
  @format
end

#hits ⇒ Object

Number of hit in this document



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

def hits
  @hits
end

#title ⇒ Object

Title for this document.



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

def title
  @title
end

#url ⇒ Object

Link to render this document



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

def url
  @url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 37

def self.attribute_map
  {
    :'document_id' => :'documentId',
    :'title' => :'title',
    :'hits' => :'hits',
    :'url' => :'url',
    :'format' => :'format',
    :'excerpts' => :'excerpts'
  }
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



154
155
156
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 154

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 54

def self.openapi_types
  {
    :'document_id' => :'String',
    :'title' => :'String',
    :'hits' => :'String',
    :'url' => :'String',
    :'format' => :'String',
    :'excerpts' => :'Array<ExcerptResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



128
129
130
131
132
133
134
135
136
137
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 128

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_id == o.document_id &&
      title == o.title &&
      hits == o.hits &&
      url == o.url &&
      format == o.format &&
      excerpts == o.excerpts
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



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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 255

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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 161

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


141
142
143
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 141

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [document_id, title, hits, url, format, excerpts].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



115
116
117
118
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 115

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



231
232
233
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 231

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



237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 237

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



225
226
227
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 225

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



122
123
124
 
# File 'lib/finnhub_ruby/models/document_response.rb', line 122

def valid?
  true
end