class Intrinio::Fundamental

Attributes

company[RW]

The Company that the Fundamental was belongs to

end_date[RW]

The period start date

filing_date[RW]

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

fiscal_period[RW]

The fiscal period

fiscal_year[RW]

The fiscal year

id[RW]

The Intrinio ID of the Fundamental

is_latest[RW]

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>)

start_date[RW]

The period start date

statement_code[RW]

The code of the financial statement that the Fundamental represents

type[RW]

The type of Fundamental

Public Class Methods

attribute_map() click to toggle source

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

# 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
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
swagger_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/intrinio-sdk/models/fundamental.rb, line 196
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/intrinio-sdk/models/fundamental.rb, line 154
def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/intrinio-sdk/models/fundamental.rb, line 276
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/intrinio-sdk/models/fundamental.rb, line 270
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/intrinio-sdk/models/fundamental.rb, line 169
def type=(type)
  validator = EnumAttributeValidator.new('String', ["reported", "restated", "calculated"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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