Class: FinnhubRuby::InFilingResponse

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InFilingResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
183
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#acceptance_date ⇒ Object

Date the filing is submitted.



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

def acceptance_date
  @acceptance_date
end

#amend ⇒ Object

Amendment



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

def amend
  @amend
end

#document_count ⇒ Object

Number of document in this filing



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

def document_count
  @document_count
end

#documents ⇒ Object

Document for this filing.



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

def documents
  @documents
end

#filed_date ⇒ Object

Date the filing is make available to the public



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

def filed_date
  @filed_date
end

#filer_id ⇒ Object

Id of the entity submitted the filing



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

def filer_id
  @filer_id
end

#filing_id ⇒ Object

Filing Id in Alpharesearch platform



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

def filing_id
  @filing_id
end

#form ⇒ Object

Filing Form



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

def form
  @form
end

#name ⇒ Object

Filer name



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

def name
  @name
end

#page_count ⇒ Object

Estimate number of page when printing



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

def page_count
  @page_count
end

#report_date ⇒ Object

Date as which the filing is reported



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

def report_date
  @report_date
end

#source ⇒ Object

Filing Source



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

def source
  @source
end

#symbol ⇒ Object

List of symbol associate with this filing



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

def symbol
  @symbol
end

#title ⇒ Object

Filing title



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

def title
  @title
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 81

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 61

def self.attribute_map
  {
    :'filing_id' => :'filingId',
    :'title' => :'title',
    :'filer_id' => :'filerId',
    :'symbol' => :'symbol',
    :'name' => :'name',
    :'acceptance_date' => :'acceptanceDate',
    :'filed_date' => :'filedDate',
    :'report_date' => :'reportDate',
    :'form' => :'form',
    :'amend' => :'amend',
    :'source' => :'source',
    :'page_count' => :'pageCount',
    :'document_count' => :'documentCount',
    :'documents' => :'documents'
  }
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



234
235
236
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 234

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



106
107
108
109
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 106

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 86

def self.openapi_types
  {
    :'filing_id' => :'String',
    :'title' => :'String',
    :'filer_id' => :'String',
    :'symbol' => :'Object',
    :'name' => :'String',
    :'acceptance_date' => :'String',
    :'filed_date' => :'String',
    :'report_date' => :'String',
    :'form' => :'String',
    :'amend' => :'Boolean',
    :'source' => :'String',
    :'page_count' => :'Integer',
    :'document_count' => :'Integer',
    :'documents' => :'Array<DocumentResponse>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 200

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      filing_id == o.filing_id &&
      title == o.title &&
      filer_id == o.filer_id &&
      symbol == o.symbol &&
      name == o.name &&
      acceptance_date == o.acceptance_date &&
      filed_date == o.filed_date &&
      report_date == o.report_date &&
      form == o.form &&
      amend == o.amend &&
      source == o.source &&
      page_count == o.page_count &&
      document_count == o.document_count &&
      documents == o.documents
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



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
298
299
300
301
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 264

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



335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 335

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



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 241

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


221
222
223
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 227

def hash
  [filing_id, title, filer_id, symbol, name, acceptance_date, filed_date, report_date, form, amend, source, page_count, document_count, documents].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



187
188
189
190
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 187

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



311
312
313
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 311

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



317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 317

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



305
306
307
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 305

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



194
195
196
 
# File 'lib/finnhub_ruby/models/in_filing_response.rb', line 194

def valid?
  true
end