Class: Intrinio::StandardizedFinancial

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

Overview

Professional-grade historical financial data for a Company. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as-reported financial statements because of the inherent complexity of reporting standards.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ StandardizedFinancial

Initializes the object

Parameters:

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

    Model attributes in the form of hash



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 42

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

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

end

Instance Attribute Details

#data_tag ⇒ Object

Returns the value of attribute data_tag.



18
19
20
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 18

def data_tag
  @data_tag
end

#value ⇒ Object

The value for the Data Tag within the scope of the Fundamental



21
22
23
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 21

def value
  @value
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 25

def self.attribute_map
  {
    :'data_tag' => :'data_tag',
    :'value' => :'value'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



33
34
35
36
37
38
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 33

def self.swagger_types
  {
    :'data_tag' => :'DataTagSummary',
    :'value' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



73
74
75
76
77
78
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 73

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      data_tag == o.data_tag &&
      value == o.value
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



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

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



182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 182

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



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 95

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


82
83
84
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 82

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



88
89
90
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 88

def hash
  [data_tag, value].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



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

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



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

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



168
169
170
171
172
173
174
175
176
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 168

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



156
157
158
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 156

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



67
68
69
 
# File 'lib/intrinio-sdk/models/standardized_financial.rb', line 67

def valid?
  return true
end