pharmaobservatory 0.1.2 → 0.1.4

data/lib/pharmaobservatory/models/ownership_positions_row.rb

@@ -0,0 +1,674 @@
+=begin
+#Pharma Observatory Public REST API
+
+#Read-only REST API over the Pharma Observatory biomedical data platform. Reference: https://pharmaobservatory.com/api-reference
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PharmaObservatory
+  # One row of the ownership_positions dataset: one row per owner, owned company, filing family and measured dimension (the owner's consolidated current position). A grouped request returns the group columns and the measures instead, as additional properties.
+  class OwnershipPositionsRow
+    # The position id. For a position whose owner name is withheld it is an opaque handle that derives nothing from the owner and is stable only while the other positions of the same owned company, filing family and dimension are unchanged.
+    attr_accessor :position_id
+
+    # The filing family: sec_forms_3_4_5 (insiders), sec_schedules_13d_g (beneficial owners), sec_form_adv (investment adviser control persons) or sec_def_14a (proxy-statement tables).
+    attr_accessor :source_class
+
+    # What the position measures: insider_reporting, beneficial_ownership, voting_power, economic_interest or control. Positions of different dimensions are different measurements and are not added.
+    attr_accessor :ownership_dimension
+
+    # The owner's relationship to the company as the filing family states it.
+    attr_accessor :relationship_type
+
+    # The owned company as filed.
+    attr_accessor :subject_name
+
+    # Legal-entity level: the owned company's organization record.
+    attr_accessor :subject_org_id
+
+    # Company level: the owned company (null when unresolved).
+    attr_accessor :subject_company_id
+
+    # Display name of the owned company.
+    attr_accessor :subject_company_name
+
+    # Group level: the owned company's current ultimate parent; a root's group is itself.
+    attr_accessor :subject_group_id
+
+    # Display name of the owned company's group.
+    attr_accessor :subject_group_name
+
+    # The owner's name as filed. Null for an owner whose filing does not mark the name public (see owner_name_is_public).
+    attr_accessor :owner_name
+
+    # True when the filing marks the owner's name public. When false every column that could identify the owner is null (name, identity key, person id, investor id, organization and company columns, source_url and the dates); the position and its figures stay.
+    attr_accessor :owner_name_is_public
+
+    # What the owner is: organization, natural_person, reporting_group or unknown.
+    attr_accessor :owner_kind
+
+    # The owner's stable identity (an SEC registration number or an adviser registration number); null when the name is withheld.
+    attr_accessor :owner_identity_key
+
+    # The key of an owner who is a natural person; null for other owners and when the name is withheld.
+    attr_accessor :owner_person_id
+
+    # The key of the owner in the investor directory when it is one; null when the name is withheld.
+    attr_accessor :owner_investor_id
+
+    # Legal-entity level: the owner's organization record (null when the owner is not an organization, is unresolved or is withheld).
+    attr_accessor :owner_org_id
+
+    # Company level: the owner's company (null when unresolved or when the name is withheld).
+    attr_accessor :owner_company_id
+
+    # Display name of the owner's company.
+    attr_accessor :owner_company_name
+
+    # Group level: the owner's current ultimate parent; a root's group is itself (null when the owner is withheld).
+    attr_accessor :owner_group_id
+
+    # Display name of the owner's group.
+    attr_accessor :owner_group_name
+
+    # How the share figure was reached: sum_standing_balances (insider balances), group_reported_maximum (a joint filing's maximum, never a sum of its filers) or no_quantity (the source gives none). Read a share figure with its basis.
+    attr_accessor :shares_basis
+
+    # Shares the owner holds, on the shares_basis. Null when the source gives no quantity.
+    attr_accessor :shares
+
+    # Of those shares, the part held directly.
+    attr_accessor :shares_direct
+
+    # Of those shares, the part held indirectly.
+    attr_accessor :shares_indirect
+
+    # Shares underlying derivative positions such as options, reported apart and never added to shares.
+    attr_accessor :derivative_underlying_shares
+
+    # How the percentage was reached, for example single_reporting_person, uniform_group_percent or single_band.
+    attr_accessor :percent_basis
+
+    # The percentage the filing reports, on the percentage_basis.
+    attr_accessor :reported_percent
+
+    # The low end of a reported band, for a source that reports a band.
+    attr_accessor :reported_percent_low
+
+    # The high end of a reported band, for a source that reports a band.
+    attr_accessor :reported_percent_high
+
+    # What the percentage is of: beneficial_ownership, voting_power or economic_interest. Percentages of different bases are not comparable.
+    attr_accessor :percentage_basis
+
+    # standing, ceased or no_longer_reported, for the owner's position as a whole.
+    attr_accessor :edge_state
+
+    # Positions the row consolidates.
+    attr_accessor :position_count
+
+    # Of those, positions still standing.
+    attr_accessor :standing_position_count
+
+    # Of those, positions reported ceased.
+    attr_accessor :ceased_position_count
+
+    # Of those, positions the filer no longer reports.
+    attr_accessor :no_longer_reported_position_count
+
+    # Date the position was first reported; null when the owner's name is withheld.
+    attr_accessor :first_observed_date
+
+    # Date of the latest reported activity; null when the owner's name is withheld.
+    attr_accessor :last_activity_date
+
+    # Date of the latest filing; null when the owner's name is withheld.
+    attr_accessor :last_filing_date
+
+    # A link to the latest filing; null when the owner's name is withheld, because the filing names the owner.
+    attr_accessor :source_url
+
+    # True when the row names a natural person.
+    attr_accessor :contains_personal_data
+
+    # The filing's privacy status for the owner: not_applicable, pending_review, approved_public_fields, restricted or protected.
+    attr_accessor :privacy_status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'position_id' => :'position_id',
+        :'source_class' => :'source_class',
+        :'ownership_dimension' => :'ownership_dimension',
+        :'relationship_type' => :'relationship_type',
+        :'subject_name' => :'subject_name',
+        :'subject_org_id' => :'subject_org_id',
+        :'subject_company_id' => :'subject_company_id',
+        :'subject_company_name' => :'subject_company_name',
+        :'subject_group_id' => :'subject_group_id',
+        :'subject_group_name' => :'subject_group_name',
+        :'owner_name' => :'owner_name',
+        :'owner_name_is_public' => :'owner_name_is_public',
+        :'owner_kind' => :'owner_kind',
+        :'owner_identity_key' => :'owner_identity_key',
+        :'owner_person_id' => :'owner_person_id',
+        :'owner_investor_id' => :'owner_investor_id',
+        :'owner_org_id' => :'owner_org_id',
+        :'owner_company_id' => :'owner_company_id',
+        :'owner_company_name' => :'owner_company_name',
+        :'owner_group_id' => :'owner_group_id',
+        :'owner_group_name' => :'owner_group_name',
+        :'shares_basis' => :'shares_basis',
+        :'shares' => :'shares',
+        :'shares_direct' => :'shares_direct',
+        :'shares_indirect' => :'shares_indirect',
+        :'derivative_underlying_shares' => :'derivative_underlying_shares',
+        :'percent_basis' => :'percent_basis',
+        :'reported_percent' => :'reported_percent',
+        :'reported_percent_low' => :'reported_percent_low',
+        :'reported_percent_high' => :'reported_percent_high',
+        :'percentage_basis' => :'percentage_basis',
+        :'edge_state' => :'edge_state',
+        :'position_count' => :'position_count',
+        :'standing_position_count' => :'standing_position_count',
+        :'ceased_position_count' => :'ceased_position_count',
+        :'no_longer_reported_position_count' => :'no_longer_reported_position_count',
+        :'first_observed_date' => :'first_observed_date',
+        :'last_activity_date' => :'last_activity_date',
+        :'last_filing_date' => :'last_filing_date',
+        :'source_url' => :'source_url',
+        :'contains_personal_data' => :'contains_personal_data',
+        :'privacy_status' => :'privacy_status'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'position_id' => :'String',
+        :'source_class' => :'String',
+        :'ownership_dimension' => :'String',
+        :'relationship_type' => :'String',
+        :'subject_name' => :'String',
+        :'subject_org_id' => :'String',
+        :'subject_company_id' => :'String',
+        :'subject_company_name' => :'String',
+        :'subject_group_id' => :'String',
+        :'subject_group_name' => :'String',
+        :'owner_name' => :'String',
+        :'owner_name_is_public' => :'Boolean',
+        :'owner_kind' => :'String',
+        :'owner_identity_key' => :'String',
+        :'owner_person_id' => :'String',
+        :'owner_investor_id' => :'String',
+        :'owner_org_id' => :'String',
+        :'owner_company_id' => :'String',
+        :'owner_company_name' => :'String',
+        :'owner_group_id' => :'String',
+        :'owner_group_name' => :'String',
+        :'shares_basis' => :'String',
+        :'shares' => :'Float',
+        :'shares_direct' => :'Float',
+        :'shares_indirect' => :'Float',
+        :'derivative_underlying_shares' => :'Float',
+        :'percent_basis' => :'String',
+        :'reported_percent' => :'Float',
+        :'reported_percent_low' => :'Float',
+        :'reported_percent_high' => :'Float',
+        :'percentage_basis' => :'String',
+        :'edge_state' => :'String',
+        :'position_count' => :'Integer',
+        :'standing_position_count' => :'Integer',
+        :'ceased_position_count' => :'Integer',
+        :'no_longer_reported_position_count' => :'Integer',
+        :'first_observed_date' => :'Date',
+        :'last_activity_date' => :'Date',
+        :'last_filing_date' => :'Date',
+        :'source_url' => :'String',
+        :'contains_personal_data' => :'Boolean',
+        :'privacy_status' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'position_id',
+        :'source_class',
+        :'ownership_dimension',
+        :'relationship_type',
+        :'subject_name',
+        :'subject_org_id',
+        :'subject_company_id',
+        :'subject_company_name',
+        :'subject_group_id',
+        :'subject_group_name',
+        :'owner_name',
+        :'owner_name_is_public',
+        :'owner_kind',
+        :'owner_identity_key',
+        :'owner_person_id',
+        :'owner_investor_id',
+        :'owner_org_id',
+        :'owner_company_id',
+        :'owner_company_name',
+        :'owner_group_id',
+        :'owner_group_name',
+        :'shares_basis',
+        :'shares',
+        :'shares_direct',
+        :'shares_indirect',
+        :'derivative_underlying_shares',
+        :'percent_basis',
+        :'reported_percent',
+        :'reported_percent_low',
+        :'reported_percent_high',
+        :'percentage_basis',
+        :'edge_state',
+        :'position_count',
+        :'standing_position_count',
+        :'ceased_position_count',
+        :'no_longer_reported_position_count',
+        :'first_observed_date',
+        :'last_activity_date',
+        :'last_filing_date',
+        :'source_url',
+        :'contains_personal_data',
+        :'privacy_status'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::OwnershipPositionsRow` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::OwnershipPositionsRow`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'position_id')
+        self.position_id = attributes[:'position_id']
+      end
+
+      if attributes.key?(:'source_class')
+        self.source_class = attributes[:'source_class']
+      end
+
+      if attributes.key?(:'ownership_dimension')
+        self.ownership_dimension = attributes[:'ownership_dimension']
+      end
+
+      if attributes.key?(:'relationship_type')
+        self.relationship_type = attributes[:'relationship_type']
+      end
+
+      if attributes.key?(:'subject_name')
+        self.subject_name = attributes[:'subject_name']
+      end
+
+      if attributes.key?(:'subject_org_id')
+        self.subject_org_id = attributes[:'subject_org_id']
+      end
+
+      if attributes.key?(:'subject_company_id')
+        self.subject_company_id = attributes[:'subject_company_id']
+      end
+
+      if attributes.key?(:'subject_company_name')
+        self.subject_company_name = attributes[:'subject_company_name']
+      end
+
+      if attributes.key?(:'subject_group_id')
+        self.subject_group_id = attributes[:'subject_group_id']
+      end
+
+      if attributes.key?(:'subject_group_name')
+        self.subject_group_name = attributes[:'subject_group_name']
+      end
+
+      if attributes.key?(:'owner_name')
+        self.owner_name = attributes[:'owner_name']
+      end
+
+      if attributes.key?(:'owner_name_is_public')
+        self.owner_name_is_public = attributes[:'owner_name_is_public']
+      end
+
+      if attributes.key?(:'owner_kind')
+        self.owner_kind = attributes[:'owner_kind']
+      end
+
+      if attributes.key?(:'owner_identity_key')
+        self.owner_identity_key = attributes[:'owner_identity_key']
+      end
+
+      if attributes.key?(:'owner_person_id')
+        self.owner_person_id = attributes[:'owner_person_id']
+      end
+
+      if attributes.key?(:'owner_investor_id')
+        self.owner_investor_id = attributes[:'owner_investor_id']
+      end
+
+      if attributes.key?(:'owner_org_id')
+        self.owner_org_id = attributes[:'owner_org_id']
+      end
+
+      if attributes.key?(:'owner_company_id')
+        self.owner_company_id = attributes[:'owner_company_id']
+      end
+
+      if attributes.key?(:'owner_company_name')
+        self.owner_company_name = attributes[:'owner_company_name']
+      end
+
+      if attributes.key?(:'owner_group_id')
+        self.owner_group_id = attributes[:'owner_group_id']
+      end
+
+      if attributes.key?(:'owner_group_name')
+        self.owner_group_name = attributes[:'owner_group_name']
+      end
+
+      if attributes.key?(:'shares_basis')
+        self.shares_basis = attributes[:'shares_basis']
+      end
+
+      if attributes.key?(:'shares')
+        self.shares = attributes[:'shares']
+      end
+
+      if attributes.key?(:'shares_direct')
+        self.shares_direct = attributes[:'shares_direct']
+      end
+
+      if attributes.key?(:'shares_indirect')
+        self.shares_indirect = attributes[:'shares_indirect']
+      end
+
+      if attributes.key?(:'derivative_underlying_shares')
+        self.derivative_underlying_shares = attributes[:'derivative_underlying_shares']
+      end
+
+      if attributes.key?(:'percent_basis')
+        self.percent_basis = attributes[:'percent_basis']
+      end
+
+      if attributes.key?(:'reported_percent')
+        self.reported_percent = attributes[:'reported_percent']
+      end
+
+      if attributes.key?(:'reported_percent_low')
+        self.reported_percent_low = attributes[:'reported_percent_low']
+      end
+
+      if attributes.key?(:'reported_percent_high')
+        self.reported_percent_high = attributes[:'reported_percent_high']
+      end
+
+      if attributes.key?(:'percentage_basis')
+        self.percentage_basis = attributes[:'percentage_basis']
+      end
+
+      if attributes.key?(:'edge_state')
+        self.edge_state = attributes[:'edge_state']
+      end
+
+      if attributes.key?(:'position_count')
+        self.position_count = attributes[:'position_count']
+      end
+
+      if attributes.key?(:'standing_position_count')
+        self.standing_position_count = attributes[:'standing_position_count']
+      end
+
+      if attributes.key?(:'ceased_position_count')
+        self.ceased_position_count = attributes[:'ceased_position_count']
+      end
+
+      if attributes.key?(:'no_longer_reported_position_count')
+        self.no_longer_reported_position_count = attributes[:'no_longer_reported_position_count']
+      end
+
+      if attributes.key?(:'first_observed_date')
+        self.first_observed_date = attributes[:'first_observed_date']
+      end
+
+      if attributes.key?(:'last_activity_date')
+        self.last_activity_date = attributes[:'last_activity_date']
+      end
+
+      if attributes.key?(:'last_filing_date')
+        self.last_filing_date = attributes[:'last_filing_date']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'contains_personal_data')
+        self.contains_personal_data = attributes[:'contains_personal_data']
+      end
+
+      if attributes.key?(:'privacy_status')
+        self.privacy_status = attributes[:'privacy_status']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          position_id == o.position_id &&
+          source_class == o.source_class &&
+          ownership_dimension == o.ownership_dimension &&
+          relationship_type == o.relationship_type &&
+          subject_name == o.subject_name &&
+          subject_org_id == o.subject_org_id &&
+          subject_company_id == o.subject_company_id &&
+          subject_company_name == o.subject_company_name &&
+          subject_group_id == o.subject_group_id &&
+          subject_group_name == o.subject_group_name &&
+          owner_name == o.owner_name &&
+          owner_name_is_public == o.owner_name_is_public &&
+          owner_kind == o.owner_kind &&
+          owner_identity_key == o.owner_identity_key &&
+          owner_person_id == o.owner_person_id &&
+          owner_investor_id == o.owner_investor_id &&
+          owner_org_id == o.owner_org_id &&
+          owner_company_id == o.owner_company_id &&
+          owner_company_name == o.owner_company_name &&
+          owner_group_id == o.owner_group_id &&
+          owner_group_name == o.owner_group_name &&
+          shares_basis == o.shares_basis &&
+          shares == o.shares &&
+          shares_direct == o.shares_direct &&
+          shares_indirect == o.shares_indirect &&
+          derivative_underlying_shares == o.derivative_underlying_shares &&
+          percent_basis == o.percent_basis &&
+          reported_percent == o.reported_percent &&
+          reported_percent_low == o.reported_percent_low &&
+          reported_percent_high == o.reported_percent_high &&
+          percentage_basis == o.percentage_basis &&
+          edge_state == o.edge_state &&
+          position_count == o.position_count &&
+          standing_position_count == o.standing_position_count &&
+          ceased_position_count == o.ceased_position_count &&
+          no_longer_reported_position_count == o.no_longer_reported_position_count &&
+          first_observed_date == o.first_observed_date &&
+          last_activity_date == o.last_activity_date &&
+          last_filing_date == o.last_filing_date &&
+          source_url == o.source_url &&
+          contains_personal_data == o.contains_personal_data &&
+          privacy_status == o.privacy_status
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [position_id, source_class, ownership_dimension, relationship_type, subject_name, subject_org_id, subject_company_id, subject_company_name, subject_group_id, subject_group_name, owner_name, owner_name_is_public, owner_kind, owner_identity_key, owner_person_id, owner_investor_id, owner_org_id, owner_company_id, owner_company_name, owner_group_id, owner_group_name, shares_basis, shares, shares_direct, shares_indirect, derivative_underlying_shares, percent_basis, reported_percent, reported_percent_low, reported_percent_high, percentage_basis, edge_state, position_count, standing_position_count, ceased_position_count, no_longer_reported_position_count, first_observed_date, last_activity_date, last_filing_date, source_url, contains_personal_data, privacy_status].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = PharmaObservatory.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # 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
+    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
+
+  end
+
+end