class Intrinio::Owner

Insider and institutional owners of securities covered by Intrinio

Attributes

business_address[RW]

The owner's business address

business_phone_no[RW]

The owner's business phone number

company_id[RW]

The Intrinio ID for the company for which the Security is issued

country_inc[RW]

The country in which the owner is incorporated

created_on[RW]

The date and time when the data was created

id[RW]

The Intrinio ID for the Owner

institutional[RW]

A boolean to include only insider owners who have filed forms 3, 4, or 5 with the SEC

mailing_address[RW]

The owner's mailing address

name[RW]

The name of the owner

owner_cik[RW]

The Central Index Key issued by the SEC, which is the unique identifier all owner filings

state[RW]

The state in which the owner is located

state_inc[RW]

The state in which the owner is incorporated

updated_on[RW]

The date and time when the data was last updated.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/intrinio-sdk/models/owner.rb, line 59
def self.attribute_map
  {
    :'id' => :'id',
    :'company_id' => :'company_id',
    :'owner_cik' => :'owner_cik',
    :'name' => :'name',
    :'state' => :'state',
    :'state_inc' => :'state_inc',
    :'country_inc' => :'country_inc',
    :'business_address' => :'business_address',
    :'business_phone_no' => :'business_phone_no',
    :'mailing_address' => :'mailing_address',
    :'institutional' => :'institutional',
    :'updated_on' => :'updated_on',
    :'created_on' => :'created_on'
  }
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/owner.rb, line 98
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?(:'company_id')
    self.company_id = attributes[:'company_id']
  end

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

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

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

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

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

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/intrinio-sdk/models/owner.rb, line 78
def self.swagger_types
  {
    :'id' => :'String',
    :'company_id' => :'String',
    :'owner_cik' => :'String',
    :'name' => :'String',
    :'state' => :'String',
    :'state_inc' => :'String',
    :'country_inc' => :'String',
    :'business_address' => :'String',
    :'business_phone_no' => :'String',
    :'mailing_address' => :'String',
    :'institutional' => :'BOOLEAN',
    :'updated_on' => :'DateTime',
    :'created_on' => :'DateTime'
  }
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/owner.rb, line 173
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      company_id == o.company_id &&
      owner_cik == o.owner_cik &&
      name == o.name &&
      state == o.state &&
      state_inc == o.state_inc &&
      country_inc == o.country_inc &&
      business_address == o.business_address &&
      business_phone_no == o.business_phone_no &&
      mailing_address == o.mailing_address &&
      institutional == o.institutional &&
      updated_on == o.updated_on &&
      created_on == o.created_on
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/owner.rb, line 227
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/owner.rb, line 293
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/owner.rb, line 206
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/owner.rb, line 193
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/owner.rb, line 199
def hash
  [id, company_id, owner_cik, name, state, state_inc, country_inc, business_address, business_phone_no, mailing_address, institutional, updated_on, created_on].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/owner.rb, line 160
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/owner.rb, line 273
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/owner.rb, line 279
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/owner.rb, line 267
def to_s
  to_hash.to_s
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/owner.rb, line 167
def valid?
  return true
end