Class: Intrinio::CompanySharesOutstanding

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

Overview

The summary of a company that submits filings to the SEC and has a security traded primarily on a US exchange

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CompanySharesOutstanding

Initializes the object

Parameters:

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

    Model attributes in the form of hash



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 68

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

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

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

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

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

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

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

end

Instance Attribute Details

#end_date ⇒ Object

End date of the filing period



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

def end_date
  @end_date
end

#security_exchange_name ⇒ Object

The name of the secuirty exchange



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

def security_exchange_name
  @security_exchange_name
end

#shares_outstanding ⇒ Object

The amount of stock currently held by all shareholders



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

def shares_outstanding
  @shares_outstanding
end

#title_of_security ⇒ Object

The description of the security type



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

def title_of_security
  @title_of_security
end

#trading_symbol ⇒ Object

The symbol under which the security is traded in the exchange



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

def trading_symbol
  @trading_symbol
end

#xbrl_axis ⇒ Object

The xbrl concept axis member reported to the SEC.



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

def xbrl_axis
  @xbrl_axis
end

#xbrl_member ⇒ Object

Provides information about the class of stock as reported in XBRL



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

def xbrl_member
  @xbrl_member
end

Class Method Details

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 41

def self.attribute_map
  {
    :'xbrl_axis' => :'xbrl_axis',
    :'xbrl_member' => :'xbrl_member',
    :'end_date' => :'end_date',
    :'title_of_security' => :'title_of_security',
    :'trading_symbol' => :'trading_symbol',
    :'security_exchange_name' => :'security_exchange_name',
    :'shares_outstanding' => :'shares_outstanding'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 54

def self.swagger_types
  {
    :'xbrl_axis' => :'String',
    :'xbrl_member' => :'String',
    :'end_date' => :'Date',
    :'title_of_security' => :'String',
    :'trading_symbol' => :'String',
    :'security_exchange_name' => :'String',
    :'shares_outstanding' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 119

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      xbrl_axis == o.xbrl_axis &&
      xbrl_member == o.xbrl_member &&
      end_date == o.end_date &&
      title_of_security == o.title_of_security &&
      trading_symbol == o.trading_symbol &&
      security_exchange_name == o.security_exchange_name &&
      shares_outstanding == o.shares_outstanding
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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 167

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



233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 233

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 146

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


133
134
135
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 133

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



139
140
141
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 139

def hash
  [xbrl_axis, xbrl_member, end_date, title_of_security, trading_symbol, security_exchange_name, shares_outstanding].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



106
107
108
109
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 106

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



213
214
215
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 213

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



219
220
221
222
223
224
225
226
227
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 219

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



207
208
209
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 207

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



113
114
115
 
# File 'lib/intrinio-sdk/models/company_shares_outstanding.rb', line 113

def valid?
  return true
end