Class: Intrinio::Filing

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/models/filing.rb

Overview

A filing submitted to the SEC by a company

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Filing

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
182
 
# File 'lib/intrinio-sdk/models/filing.rb', line 112

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'filing_date')
    self.filing_date = attributes[:'filing_date']
  end

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

  if attributes.has_key?(:'period_end_date')
    self.period_end_date = attributes[:'period_end_date']
  end

  if attributes.has_key?(:'report_type')
    self.report_type = attributes[:'report_type']
  end

  if attributes.has_key?(:'sec_unique_id')
    self.sec_unique_id = attributes[:'sec_unique_id']
  end

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

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

  if attributes.has_key?(:'instance_url')
    self.instance_url = attributes[:'instance_url']
  end

  if attributes.has_key?(:'industry_category')
    self.industry_category = attributes[:'industry_category']
  end

  if attributes.has_key?(:'industry_group')
    self.industry_group = attributes[:'industry_group']
  end

  if attributes.has_key?(:'word_count')
    self.word_count = attributes[:'word_count']
  end

  if attributes.has_key?(:'earnings_disclosed_at')
    self.earnings_disclosed_at = attributes[:'earnings_disclosed_at']
  end

  if attributes.has_key?(:'earnings_disclosed_8k_id')
    self.earnings_disclosed_8k_id = attributes[:'earnings_disclosed_8k_id']
  end

  if attributes.has_key?(:'earnings_8k_url')
    self.earnings_8k_url = attributes[:'earnings_8k_url']
  end

  if attributes.has_key?(:'company')
    self.company = attributes[:'company']
  end

end

Instance Attribute Details

#accepted_date ⇒ Object

The date and time when the filing was accepted by SEC



25
26
27
 
# File 'lib/intrinio-sdk/models/filing.rb', line 25

def accepted_date
  @accepted_date
end

#company ⇒ Object

Returns the value of attribute company.



63
64
65
 
# File 'lib/intrinio-sdk/models/filing.rb', line 63

def company
  @company
end

#earnings_8k_url ⇒ Object

The URL to the 8-K filing page on the SEC site where earnings were first disclosed



61
62
63
 
# File 'lib/intrinio-sdk/models/filing.rb', line 61

def earnings_8k_url
  @earnings_8k_url
end

#earnings_disclosed_8k_id ⇒ Object

The Intrinio ID of the 8-K filing where earnings were first disclosed



58
59
60
 
# File 'lib/intrinio-sdk/models/filing.rb', line 58

def earnings_disclosed_8k_id
  @earnings_disclosed_8k_id
end

#earnings_disclosed_at ⇒ Object

The date and time when the earnings information was first disclosed via 8-K filing



55
56
57
 
# File 'lib/intrinio-sdk/models/filing.rb', line 55

def earnings_disclosed_at
  @earnings_disclosed_at
end

#filing_date ⇒ Object

The date when the filing was submitted to the SEC by the company



22
23
24
 
# File 'lib/intrinio-sdk/models/filing.rb', line 22

def filing_date
  @filing_date
end

#filing_url ⇒ Object

The URL to the filing page on the SEC site



37
38
39
 
# File 'lib/intrinio-sdk/models/filing.rb', line 37

def filing_url
  @filing_url
end

#id ⇒ Object

The Intrinio ID of the Filing



19
20
21
 
# File 'lib/intrinio-sdk/models/filing.rb', line 19

def id
  @id
end

#industry_category ⇒ Object

The company’s operating industry category



46
47
48
 
# File 'lib/intrinio-sdk/models/filing.rb', line 46

def industry_category
  @industry_category
end

#industry_group ⇒ Object

The company’s operating industry group



49
50
51
 
# File 'lib/intrinio-sdk/models/filing.rb', line 49

def industry_group
  @industry_group
end

#instance_url ⇒ Object

The URL for the XBRL filing for the report



43
44
45
 
# File 'lib/intrinio-sdk/models/filing.rb', line 43

def instance_url
  @instance_url
end

#period_end_date ⇒ Object

The ending date of the fiscal period for the filing



28
29
30
 
# File 'lib/intrinio-sdk/models/filing.rb', line 28

def period_end_date
  @period_end_date
end

#report_type ⇒ Object

The filing <a href="docs.intrinio.com/documentation/sec_filing_report_types" target="_blank">report type</a>



31
32
33
 
# File 'lib/intrinio-sdk/models/filing.rb', line 31

def report_type
  @report_type
end

#report_url ⇒ Object

The URL to the actual report on the SEC site



40
41
42
 
# File 'lib/intrinio-sdk/models/filing.rb', line 40

def report_url
  @report_url
end

#sec_unique_id ⇒ Object

A unique identifier for the filing provided by the SEC



34
35
36
 
# File 'lib/intrinio-sdk/models/filing.rb', line 34

def sec_unique_id
  @sec_unique_id
end

#word_count ⇒ Object

The number of words in the filing



52
53
54
 
# File 'lib/intrinio-sdk/models/filing.rb', line 52

def word_count
  @word_count
end

Class Method Details

.attribute_map ⇒ Object

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



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/intrinio-sdk/models/filing.rb', line 67

def self.attribute_map
  {
    :'id' => :'id',
    :'filing_date' => :'filing_date',
    :'accepted_date' => :'accepted_date',
    :'period_end_date' => :'period_end_date',
    :'report_type' => :'report_type',
    :'sec_unique_id' => :'sec_unique_id',
    :'filing_url' => :'filing_url',
    :'report_url' => :'report_url',
    :'instance_url' => :'instance_url',
    :'industry_category' => :'industry_category',
    :'industry_group' => :'industry_group',
    :'word_count' => :'word_count',
    :'earnings_disclosed_at' => :'earnings_disclosed_at',
    :'earnings_disclosed_8k_id' => :'earnings_disclosed_8k_id',
    :'earnings_8k_url' => :'earnings_8k_url',
    :'company' => :'company'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/intrinio-sdk/models/filing.rb', line 89

def self.swagger_types
  {
    :'id' => :'String',
    :'filing_date' => :'Date',
    :'accepted_date' => :'DateTime',
    :'period_end_date' => :'Date',
    :'report_type' => :'String',
    :'sec_unique_id' => :'String',
    :'filing_url' => :'String',
    :'report_url' => :'String',
    :'instance_url' => :'String',
    :'industry_category' => :'String',
    :'industry_group' => :'String',
    :'word_count' => :'Integer',
    :'earnings_disclosed_at' => :'DateTime',
    :'earnings_disclosed_8k_id' => :'String',
    :'earnings_8k_url' => :'String',
    :'company' => :'CompanySummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/intrinio-sdk/models/filing.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      filing_date == o.filing_date &&
      accepted_date == o.accepted_date &&
      period_end_date == o.period_end_date &&
      report_type == o.report_type &&
      sec_unique_id == o.sec_unique_id &&
      filing_url == o.filing_url &&
      report_url == o.report_url &&
      instance_url == o.instance_url &&
      industry_category == o.industry_category &&
      industry_group == o.industry_group &&
      word_count == o.word_count &&
      earnings_disclosed_at == o.earnings_disclosed_at &&
      earnings_disclosed_8k_id == o.earnings_disclosed_8k_id &&
      earnings_8k_url == o.earnings_8k_url &&
      company == o.company
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



256
257
258
259
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
 
# File 'lib/intrinio-sdk/models/filing.rb', line 256

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = Intrinio.const_get(type).new
    temp_model.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



322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/intrinio-sdk/models/filing.rb', line 322

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/intrinio-sdk/models/filing.rb', line 235

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


222
223
224
 
# File 'lib/intrinio-sdk/models/filing.rb', line 222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



228
229
230
 
# File 'lib/intrinio-sdk/models/filing.rb', line 228

def hash
  [id, filing_date, accepted_date, period_end_date, report_type, sec_unique_id, filing_url, report_url, instance_url, industry_category, industry_group, word_count, earnings_disclosed_at, earnings_disclosed_8k_id, earnings_8k_url, company].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



186
187
188
189
 
# File 'lib/intrinio-sdk/models/filing.rb', line 186

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



302
303
304
 
# File 'lib/intrinio-sdk/models/filing.rb', line 302

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



308
309
310
311
312
313
314
315
316
 
# File 'lib/intrinio-sdk/models/filing.rb', line 308

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



296
297
298
 
# File 'lib/intrinio-sdk/models/filing.rb', line 296

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



193
194
195
 
# File 'lib/intrinio-sdk/models/filing.rb', line 193

def valid?
  return true
end