Class: Intrinio::Fundamental

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Fundamental

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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?(:'statement_code')
    self.statement_code = attributes[:'statement_code']
  end

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#company ⇒ Object

The Company that the Fundamental was belongs to



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

def company
  @company
end

#end_date ⇒ Object

The period start date



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

def end_date
  @end_date
end

#filing_date ⇒ Object

The date and time when the Fundamental was filed with the SEC



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

def filing_date
  @filing_date
end

#fiscal_period ⇒ Object

The fiscal period



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

def fiscal_period
  @fiscal_period
end

#fiscal_year ⇒ Object

The fiscal year



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

def fiscal_year
  @fiscal_year
end

#id ⇒ Object

The Intrinio ID of the Fundamental



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

def id
  @id
end

#is_latest ⇒ Object

Is this the latest fundamental available based on the company’s most recent filings? Use the Lookup Fundamental endpoint to find the latest fundamental (<a href="docs.intrinio.com/documentation/web_api/lookup_fundamental_v2" target="_blank">reference</a>)



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

def is_latest
  @is_latest
end

#start_date ⇒ Object

The period start date



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

def start_date
  @start_date
end

#statement_code ⇒ Object

The code of the financial statement that the Fundamental represents



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

def statement_code
  @statement_code
end

#type ⇒ Object

The type of Fundamental



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

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 71

def self.attribute_map
  {
    :'id' => :'id',
    :'statement_code' => :'statement_code',
    :'fiscal_year' => :'fiscal_year',
    :'fiscal_period' => :'fiscal_period',
    :'type' => :'type',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'filing_date' => :'filing_date',
    :'is_latest' => :'is_latest',
    :'company' => :'company'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 87

def self.swagger_types
  {
    :'id' => :'String',
    :'statement_code' => :'String',
    :'fiscal_year' => :'Float',
    :'fiscal_period' => :'String',
    :'type' => :'String',
    :'start_date' => :'Date',
    :'end_date' => :'Date',
    :'filing_date' => :'DateTime',
    :'is_latest' => :'BOOLEAN',
    :'company' => :'CompanySummary'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 179

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      statement_code == o.statement_code &&
      fiscal_year == o.fiscal_year &&
      fiscal_period == o.fiscal_period &&
      type == o.type &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      filing_date == o.filing_date &&
      is_latest == o.is_latest &&
      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



230
231
232
233
234
235
236
237
238
239
240
241
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
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 230

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 296

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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 209

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


196
197
198
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 196

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



202
203
204
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 202

def hash
  [id, statement_code, fiscal_year, fiscal_period, type, start_date, end_date, filing_date, is_latest, 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



154
155
156
157
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 154

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



276
277
278
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 276

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



282
283
284
285
286
287
288
289
290
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 282

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



270
271
272
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 270

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



161
162
163
164
165
 
# File 'lib/intrinio-sdk/models/fundamental.rb', line 161

def valid?
  type_validator = EnumAttributeValidator.new('String', ["reported", "restated", "calculated"])
  return false unless type_validator.valid?(@type)
  return true
end