pharmaobservatory 0.1.2 → 0.1.4

data/lib/pharmaobservatory/models/institutional_holdings_row.rb

@@ -0,0 +1,487 @@
+=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 institutional_holdings dataset: one row per institutional manager and issuer security (current standing position). A grouped request returns the group columns and the measures instead, as additional properties.
+  class InstitutionalHoldingsRow
+    # The holding line id.
+    attr_accessor :holding_id
+
+    # The security issuer as filed.
+    attr_accessor :issuer_name
+
+    # Legal-entity level: the issuer's organization record (null when unresolved).
+    attr_accessor :issuer_org_id
+
+    # Company level: the issuer's company (null when unresolved).
+    attr_accessor :issuer_company_id
+
+    # Display name of the issuer's company.
+    attr_accessor :issuer_company_name
+
+    # Group level: the issuer's current ultimate parent; a root's group is itself.
+    attr_accessor :issuer_group_id
+
+    # Display name of the issuer's group.
+    attr_accessor :issuer_group_name
+
+    # The security's CUSIP (Committee on Uniform Securities Identification Procedures) identifier.
+    attr_accessor :security_ref
+
+    # The institutional manager's name.
+    attr_accessor :holder_name
+
+    # The institutional manager's stable identity (an SEC registration number), the key that groups all of one manager's holdings.
+    attr_accessor :holder_identity_key
+
+    # Manager kind.
+    attr_accessor :holder_kind
+
+    # Legal-entity level: the manager's organization record (null when unresolved).
+    attr_accessor :holder_org_id
+
+    # Company level: the manager's company (null when unresolved).
+    attr_accessor :holder_company_id
+
+    # Display name of the manager's company.
+    attr_accessor :holder_company_name
+
+    # Group level: the manager's current ultimate parent.
+    attr_accessor :holder_group_id
+
+    # Display name of the manager's group.
+    attr_accessor :holder_group_name
+
+    # Reported value of the position.
+    attr_accessor :reported_value_amount
+
+    # Currency of the reported value.
+    attr_accessor :reported_value_currency
+
+    # Shares standing.
+    attr_accessor :shares
+
+    # The basis the percent is measured on.
+    attr_accessor :percent_basis
+
+    # Reported share of the issuer.
+    attr_accessor :reported_percent
+
+    # State of the position (standing, ceased, no longer reported).
+    attr_accessor :edge_state
+
+    # First filing date the position was observed.
+    attr_accessor :first_observed_date
+
+    # Latest filing date the position was reported.
+    attr_accessor :last_filing_date
+
+    # Whether the holder is a natural person.
+    attr_accessor :contains_personal_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'holding_id' => :'holding_id',
+        :'issuer_name' => :'issuer_name',
+        :'issuer_org_id' => :'issuer_org_id',
+        :'issuer_company_id' => :'issuer_company_id',
+        :'issuer_company_name' => :'issuer_company_name',
+        :'issuer_group_id' => :'issuer_group_id',
+        :'issuer_group_name' => :'issuer_group_name',
+        :'security_ref' => :'security_ref',
+        :'holder_name' => :'holder_name',
+        :'holder_identity_key' => :'holder_identity_key',
+        :'holder_kind' => :'holder_kind',
+        :'holder_org_id' => :'holder_org_id',
+        :'holder_company_id' => :'holder_company_id',
+        :'holder_company_name' => :'holder_company_name',
+        :'holder_group_id' => :'holder_group_id',
+        :'holder_group_name' => :'holder_group_name',
+        :'reported_value_amount' => :'reported_value_amount',
+        :'reported_value_currency' => :'reported_value_currency',
+        :'shares' => :'shares',
+        :'percent_basis' => :'percent_basis',
+        :'reported_percent' => :'reported_percent',
+        :'edge_state' => :'edge_state',
+        :'first_observed_date' => :'first_observed_date',
+        :'last_filing_date' => :'last_filing_date',
+        :'contains_personal_data' => :'contains_personal_data'
+      }
+    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
+      {
+        :'holding_id' => :'String',
+        :'issuer_name' => :'String',
+        :'issuer_org_id' => :'String',
+        :'issuer_company_id' => :'String',
+        :'issuer_company_name' => :'String',
+        :'issuer_group_id' => :'String',
+        :'issuer_group_name' => :'String',
+        :'security_ref' => :'String',
+        :'holder_name' => :'String',
+        :'holder_identity_key' => :'String',
+        :'holder_kind' => :'String',
+        :'holder_org_id' => :'String',
+        :'holder_company_id' => :'String',
+        :'holder_company_name' => :'String',
+        :'holder_group_id' => :'String',
+        :'holder_group_name' => :'String',
+        :'reported_value_amount' => :'Float',
+        :'reported_value_currency' => :'String',
+        :'shares' => :'Float',
+        :'percent_basis' => :'String',
+        :'reported_percent' => :'Float',
+        :'edge_state' => :'String',
+        :'first_observed_date' => :'Date',
+        :'last_filing_date' => :'Date',
+        :'contains_personal_data' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'holding_id',
+        :'issuer_name',
+        :'issuer_org_id',
+        :'issuer_company_id',
+        :'issuer_company_name',
+        :'issuer_group_id',
+        :'issuer_group_name',
+        :'security_ref',
+        :'holder_name',
+        :'holder_identity_key',
+        :'holder_kind',
+        :'holder_org_id',
+        :'holder_company_id',
+        :'holder_company_name',
+        :'holder_group_id',
+        :'holder_group_name',
+        :'reported_value_amount',
+        :'reported_value_currency',
+        :'shares',
+        :'percent_basis',
+        :'reported_percent',
+        :'edge_state',
+        :'first_observed_date',
+        :'last_filing_date',
+        :'contains_personal_data'
+      ])
+    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::InstitutionalHoldingsRow` 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::InstitutionalHoldingsRow`. 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?(:'holding_id')
+        self.holding_id = attributes[:'holding_id']
+      end
+
+      if attributes.key?(:'issuer_name')
+        self.issuer_name = attributes[:'issuer_name']
+      end
+
+      if attributes.key?(:'issuer_org_id')
+        self.issuer_org_id = attributes[:'issuer_org_id']
+      end
+
+      if attributes.key?(:'issuer_company_id')
+        self.issuer_company_id = attributes[:'issuer_company_id']
+      end
+
+      if attributes.key?(:'issuer_company_name')
+        self.issuer_company_name = attributes[:'issuer_company_name']
+      end
+
+      if attributes.key?(:'issuer_group_id')
+        self.issuer_group_id = attributes[:'issuer_group_id']
+      end
+
+      if attributes.key?(:'issuer_group_name')
+        self.issuer_group_name = attributes[:'issuer_group_name']
+      end
+
+      if attributes.key?(:'security_ref')
+        self.security_ref = attributes[:'security_ref']
+      end
+
+      if attributes.key?(:'holder_name')
+        self.holder_name = attributes[:'holder_name']
+      end
+
+      if attributes.key?(:'holder_identity_key')
+        self.holder_identity_key = attributes[:'holder_identity_key']
+      end
+
+      if attributes.key?(:'holder_kind')
+        self.holder_kind = attributes[:'holder_kind']
+      end
+
+      if attributes.key?(:'holder_org_id')
+        self.holder_org_id = attributes[:'holder_org_id']
+      end
+
+      if attributes.key?(:'holder_company_id')
+        self.holder_company_id = attributes[:'holder_company_id']
+      end
+
+      if attributes.key?(:'holder_company_name')
+        self.holder_company_name = attributes[:'holder_company_name']
+      end
+
+      if attributes.key?(:'holder_group_id')
+        self.holder_group_id = attributes[:'holder_group_id']
+      end
+
+      if attributes.key?(:'holder_group_name')
+        self.holder_group_name = attributes[:'holder_group_name']
+      end
+
+      if attributes.key?(:'reported_value_amount')
+        self.reported_value_amount = attributes[:'reported_value_amount']
+      end
+
+      if attributes.key?(:'reported_value_currency')
+        self.reported_value_currency = attributes[:'reported_value_currency']
+      end
+
+      if attributes.key?(:'shares')
+        self.shares = attributes[:'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?(:'edge_state')
+        self.edge_state = attributes[:'edge_state']
+      end
+
+      if attributes.key?(:'first_observed_date')
+        self.first_observed_date = attributes[:'first_observed_date']
+      end
+
+      if attributes.key?(:'last_filing_date')
+        self.last_filing_date = attributes[:'last_filing_date']
+      end
+
+      if attributes.key?(:'contains_personal_data')
+        self.contains_personal_data = attributes[:'contains_personal_data']
+      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 &&
+          holding_id == o.holding_id &&
+          issuer_name == o.issuer_name &&
+          issuer_org_id == o.issuer_org_id &&
+          issuer_company_id == o.issuer_company_id &&
+          issuer_company_name == o.issuer_company_name &&
+          issuer_group_id == o.issuer_group_id &&
+          issuer_group_name == o.issuer_group_name &&
+          security_ref == o.security_ref &&
+          holder_name == o.holder_name &&
+          holder_identity_key == o.holder_identity_key &&
+          holder_kind == o.holder_kind &&
+          holder_org_id == o.holder_org_id &&
+          holder_company_id == o.holder_company_id &&
+          holder_company_name == o.holder_company_name &&
+          holder_group_id == o.holder_group_id &&
+          holder_group_name == o.holder_group_name &&
+          reported_value_amount == o.reported_value_amount &&
+          reported_value_currency == o.reported_value_currency &&
+          shares == o.shares &&
+          percent_basis == o.percent_basis &&
+          reported_percent == o.reported_percent &&
+          edge_state == o.edge_state &&
+          first_observed_date == o.first_observed_date &&
+          last_filing_date == o.last_filing_date &&
+          contains_personal_data == o.contains_personal_data
+    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
+      [holding_id, issuer_name, issuer_org_id, issuer_company_id, issuer_company_name, issuer_group_id, issuer_group_name, security_ref, holder_name, holder_identity_key, holder_kind, holder_org_id, holder_company_id, holder_company_name, holder_group_id, holder_group_name, reported_value_amount, reported_value_currency, shares, percent_basis, reported_percent, edge_state, first_observed_date, last_filing_date, contains_personal_data].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