pharmaobservatory 0.1.4 → 0.1.6

data/lib/pharmaobservatory/models/investors_row.rb

@@ -0,0 +1,421 @@
+=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 investors dataset: one row per canonical investor (a Form ADV adviser or an NIH RePORTER funding agency). A grouped request returns the group columns and the measures instead, as additional properties.
+  class InvestorsRow
+    # The investor key, the id the web page uses: adv:<CRD> for a Form ADV adviser, lei:<LEI> where one is known, agency:<slug> for an NIH RePORTER funding agency, investor:<hash> for a name-resolved investor.
+    attr_accessor :investor_id
+
+    # The investor's legal or display name.
+    attr_accessor :legal_name
+
+    # venture_capital, private_equity, hedge_fund (from the plurality of the adviser's Form ADV Item 7.B fund types), government_agency or other.
+    attr_accessor :investor_type
+
+    # The source lane: sec_adv (Form ADV advisers) or reporter (NIH RePORTER funding agencies).
+    attr_accessor :source
+
+    # The adviser's main-office country, or United States for an NIH funding agency.
+    attr_accessor :country
+
+    # Regulatory assets under management (RAUM) in whole US dollars, as the adviser reports it on Form ADV. Null for an agency or an adviser that reports none.
+    attr_accessor :raum_usd
+
+    # The RAUM band the amount falls in.
+    attr_accessor :raum_band
+
+    # True for an exempt reporting adviser (ERA), false for a registered adviser, null for an agency.
+    attr_accessor :is_era
+
+    # True when the investor is life-sciences focused, false when it is not, null when no signal exists. Read it with is_life_sciences_focused_basis.
+    attr_accessor :is_life_sciences_focused
+
+    # Where is_life_sciences_focused came from: human or agent (a recorded classification), override (a curator's call), edge_share (the share of its portfolio edges in life-sciences issuers) or classifier (the Form 13F biomedical value share). Null exactly when the flag is null.
+    attr_accessor :is_life_sciences_focused_basis
+
+    # Private funds the adviser reports on Form ADV Item 7.B.
+    attr_accessor :private_fund_count
+
+    # The adviser's total private-fund gross asset value (GAV) in whole US dollars, a firm-level figure.
+    attr_accessor :total_private_fund_gav
+
+    # Distinct portfolio companies named against the investor in S-1 and 424B offering holder tables. 0 usually means no named-holder link was observed.
+    attr_accessor :portfolio_co_count
+
+    # Current Form 13F positions reported by the managers that resolve to this investor, summed over its manager keys. 0 when none resolves.
+    attr_accessor :holdings_position_count
+
+    # Legal-entity level: the investor's organization record where the link resolves (null otherwise). An advfirm:<CRD> shell resolves to no legal-entity record and no company.
+    attr_accessor :org_id
+
+    # Company level: the investor's company (null when unresolved).
+    attr_accessor :company_id
+
+    # Display name of the investor's company.
+    attr_accessor :company_name
+
+    # Group level: the investor's company's current ultimate parent; a root's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the investor's group.
+    attr_accessor :group_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'investor_id' => :'investor_id',
+        :'legal_name' => :'legal_name',
+        :'investor_type' => :'investor_type',
+        :'source' => :'source',
+        :'country' => :'country',
+        :'raum_usd' => :'raum_usd',
+        :'raum_band' => :'raum_band',
+        :'is_era' => :'is_era',
+        :'is_life_sciences_focused' => :'is_life_sciences_focused',
+        :'is_life_sciences_focused_basis' => :'is_life_sciences_focused_basis',
+        :'private_fund_count' => :'private_fund_count',
+        :'total_private_fund_gav' => :'total_private_fund_gav',
+        :'portfolio_co_count' => :'portfolio_co_count',
+        :'holdings_position_count' => :'holdings_position_count',
+        :'org_id' => :'org_id',
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name'
+      }
+    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
+      {
+        :'investor_id' => :'String',
+        :'legal_name' => :'String',
+        :'investor_type' => :'String',
+        :'source' => :'String',
+        :'country' => :'String',
+        :'raum_usd' => :'Float',
+        :'raum_band' => :'String',
+        :'is_era' => :'Boolean',
+        :'is_life_sciences_focused' => :'Boolean',
+        :'is_life_sciences_focused_basis' => :'String',
+        :'private_fund_count' => :'Integer',
+        :'total_private_fund_gav' => :'Float',
+        :'portfolio_co_count' => :'Integer',
+        :'holdings_position_count' => :'Integer',
+        :'org_id' => :'String',
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'investor_id',
+        :'legal_name',
+        :'investor_type',
+        :'source',
+        :'country',
+        :'raum_usd',
+        :'raum_band',
+        :'is_era',
+        :'is_life_sciences_focused',
+        :'is_life_sciences_focused_basis',
+        :'private_fund_count',
+        :'total_private_fund_gav',
+        :'portfolio_co_count',
+        :'holdings_position_count',
+        :'org_id',
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name'
+      ])
+    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::InvestorsRow` 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::InvestorsRow`. 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?(:'investor_id')
+        self.investor_id = attributes[:'investor_id']
+      end
+
+      if attributes.key?(:'legal_name')
+        self.legal_name = attributes[:'legal_name']
+      end
+
+      if attributes.key?(:'investor_type')
+        self.investor_type = attributes[:'investor_type']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'raum_usd')
+        self.raum_usd = attributes[:'raum_usd']
+      end
+
+      if attributes.key?(:'raum_band')
+        self.raum_band = attributes[:'raum_band']
+      end
+
+      if attributes.key?(:'is_era')
+        self.is_era = attributes[:'is_era']
+      end
+
+      if attributes.key?(:'is_life_sciences_focused')
+        self.is_life_sciences_focused = attributes[:'is_life_sciences_focused']
+      end
+
+      if attributes.key?(:'is_life_sciences_focused_basis')
+        self.is_life_sciences_focused_basis = attributes[:'is_life_sciences_focused_basis']
+      end
+
+      if attributes.key?(:'private_fund_count')
+        self.private_fund_count = attributes[:'private_fund_count']
+      end
+
+      if attributes.key?(:'total_private_fund_gav')
+        self.total_private_fund_gav = attributes[:'total_private_fund_gav']
+      end
+
+      if attributes.key?(:'portfolio_co_count')
+        self.portfolio_co_count = attributes[:'portfolio_co_count']
+      end
+
+      if attributes.key?(:'holdings_position_count')
+        self.holdings_position_count = attributes[:'holdings_position_count']
+      end
+
+      if attributes.key?(:'org_id')
+        self.org_id = attributes[:'org_id']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      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 &&
+          investor_id == o.investor_id &&
+          legal_name == o.legal_name &&
+          investor_type == o.investor_type &&
+          source == o.source &&
+          country == o.country &&
+          raum_usd == o.raum_usd &&
+          raum_band == o.raum_band &&
+          is_era == o.is_era &&
+          is_life_sciences_focused == o.is_life_sciences_focused &&
+          is_life_sciences_focused_basis == o.is_life_sciences_focused_basis &&
+          private_fund_count == o.private_fund_count &&
+          total_private_fund_gav == o.total_private_fund_gav &&
+          portfolio_co_count == o.portfolio_co_count &&
+          holdings_position_count == o.holdings_position_count &&
+          org_id == o.org_id &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name
+    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
+      [investor_id, legal_name, investor_type, source, country, raum_usd, raum_band, is_era, is_life_sciences_focused, is_life_sciences_focused_basis, private_fund_count, total_private_fund_gav, portfolio_co_count, holdings_position_count, org_id, company_id, company_name, group_id, group_name].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

data/lib/pharmaobservatory/models/legal_entities_record.rb

@@ -74,8 +74,8 @@ module PharmaObservatory
         :'datasets' => :'Array<DatasetListing>',
         :'attribution' => :'Array<DatasetAttribution>',
         :'source_credit' => :'String',
-        :'freshness' => :'BiomarkerCdxAssertionsResponseFreshness',
-        :'build' => :'BiomarkerCdxAssertionsResponseBuild',
+        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
+        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/legal_entities_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerCdxAssertionsResponseScope',
+        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<LegalEntitiesRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerCdxAssertionsResponseFreshness',
-        :'build' => :'BiomarkerCdxAssertionsResponseBuild',
+        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
+        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/legal_entities_row.rb

@@ -31,7 +31,7 @@ module PharmaObservatory
     # Country as the source states it.
     attr_accessor :country
 
-    # Organization type.
+    # Organization type: Academic, Government, Hospital, Industry, Nonprofit or Other (from the Research Organization Registry (ROR) record or the filing), or the lowercase tags investor and manufacturer that mark a minted adviser or manufacturer record.
     attr_accessor :org_type
 
     # Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, when it files.