pharmaobservatory 0.1.3 → 0.1.4

data/lib/pharmaobservatory/models/conditions_row.rb

@@ -0,0 +1,304 @@
+=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 conditions dataset: one row per condition. A grouped request returns the group columns and the measures instead, as additional properties.
+  class ConditionsRow
+    # The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits).
+    attr_accessor :condition_id
+
+    # The condition's MeSH heading.
+    attr_accessor :condition_name
+
+    # The condition's primary MeSH disease category.
+    attr_accessor :primary_category
+
+    # The MeSH tree branches the condition sits under (C and F03 codes).
+    attr_accessor :categories
+
+    # True when the condition sits under the MeSH neoplasms branch (C04).
+    attr_accessor :is_neoplasm
+
+    # The condition's MeSH tree numbers.
+    attr_accessor :tree_numbers
+
+    # Trials tagged with the condition or with a condition beneath it in the MeSH tree.
+    attr_accessor :n_trials
+
+    # Trials tagged with the condition itself.
+    attr_accessor :n_direct_trials
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'condition_id' => :'condition_id',
+        :'condition_name' => :'condition_name',
+        :'primary_category' => :'primary_category',
+        :'categories' => :'categories',
+        :'is_neoplasm' => :'is_neoplasm',
+        :'tree_numbers' => :'tree_numbers',
+        :'n_trials' => :'n_trials',
+        :'n_direct_trials' => :'n_direct_trials'
+      }
+    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
+      {
+        :'condition_id' => :'String',
+        :'condition_name' => :'String',
+        :'primary_category' => :'String',
+        :'categories' => :'Array<String>',
+        :'is_neoplasm' => :'Boolean',
+        :'tree_numbers' => :'Array<String>',
+        :'n_trials' => :'Integer',
+        :'n_direct_trials' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'condition_id',
+        :'condition_name',
+        :'primary_category',
+        :'categories',
+        :'is_neoplasm',
+        :'tree_numbers',
+        :'n_trials',
+        :'n_direct_trials'
+      ])
+    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::ConditionsRow` 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::ConditionsRow`. 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?(:'condition_id')
+        self.condition_id = attributes[:'condition_id']
+      end
+
+      if attributes.key?(:'condition_name')
+        self.condition_name = attributes[:'condition_name']
+      end
+
+      if attributes.key?(:'primary_category')
+        self.primary_category = attributes[:'primary_category']
+      end
+
+      if attributes.key?(:'categories')
+        if (value = attributes[:'categories']).is_a?(Array)
+          self.categories = value
+        end
+      end
+
+      if attributes.key?(:'is_neoplasm')
+        self.is_neoplasm = attributes[:'is_neoplasm']
+      end
+
+      if attributes.key?(:'tree_numbers')
+        if (value = attributes[:'tree_numbers']).is_a?(Array)
+          self.tree_numbers = value
+        end
+      end
+
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
+      end
+
+      if attributes.key?(:'n_direct_trials')
+        self.n_direct_trials = attributes[:'n_direct_trials']
+      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 &&
+          condition_id == o.condition_id &&
+          condition_name == o.condition_name &&
+          primary_category == o.primary_category &&
+          categories == o.categories &&
+          is_neoplasm == o.is_neoplasm &&
+          tree_numbers == o.tree_numbers &&
+          n_trials == o.n_trials &&
+          n_direct_trials == o.n_direct_trials
+    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
+      [condition_id, condition_name, primary_category, categories, is_neoplasm, tree_numbers, n_trials, n_direct_trials].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/drug_patent_cliff_row.rb

@@ -25,7 +25,7 @@ module PharmaObservatory
     # The drug's pharmacologic class.
     attr_accessor :pharm_class
 
-    # The drug's ATC class.
+    # The drug's Anatomical Therapeutic Chemical (ATC) class.
     attr_accessor :atc_class
 
     # The brand name.

data/lib/pharmaobservatory/models/institutional_holdings_row.rb

@@ -37,12 +37,15 @@ module PharmaObservatory
     # Display name of the issuer's group.
     attr_accessor :issuer_group_name
 
-    # The security's CUSIP reference.
+    # 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
 
@@ -100,6 +103,7 @@ module PharmaObservatory
         :'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',
@@ -140,6 +144,7 @@ module PharmaObservatory
         :'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',
@@ -170,6 +175,7 @@ module PharmaObservatory
         :'issuer_group_name',
         :'security_ref',
         :'holder_name',
+        :'holder_identity_key',
         :'holder_kind',
         :'holder_org_id',
         :'holder_company_id',
@@ -240,6 +246,10 @@ module PharmaObservatory
         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
@@ -330,6 +340,7 @@ module PharmaObservatory
           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 &&
@@ -356,7 +367,7 @@ module PharmaObservatory
     # 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_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
+      [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

data/lib/pharmaobservatory/models/legal_entities_row.rb

@@ -34,7 +34,7 @@ module PharmaObservatory
     # Organization type.
     attr_accessor :org_type
 
-    # SEC EDGAR central index key, when it files.
+    # Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, when it files.
     attr_accessor :edgar_cik
 
     # Exchange ticker, when listed.