pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/drugs_row.rb

@@ -0,0 +1,581 @@
+=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 drugs dataset: one row per resolved drug (a molecule, a combination product or an investigational drug). A grouped request returns the group columns and the measures instead, as additional properties.
+  class DrugsRow
+    # The molecule key: the resolved drug a brand, a salt form or an investigational arm resolves to, and the entry key for the drugs object type. A member id (a salt or a folded trial arm) is not a value here; it redirects to its molecule.
+    attr_accessor :molecule_id
+
+    # The drug's display name, from its lead record.
+    attr_accessor :molecule_name
+
+    # The preferred substance name in the FDA substance registry.
+    attr_accessor :substance_name
+
+    # The International Nonproprietary Name (INN) where one is recorded.
+    attr_accessor :inn_name
+
+    # The FDA Unique Ingredient Identifier (UNII) of the lead record.
+    attr_accessor :unii
+
+    # The Chemical Abstracts Service (CAS) registry number of the lead record.
+    attr_accessor :cas
+
+    # The ChEMBL compound id of the lead record.
+    attr_accessor :chembl_id
+
+    # The registry's substance type (chemical, protein, mixture and so on).
+    attr_accessor :substance_type
+
+    # The Anatomical Therapeutic Chemical (ATC) code.
+    attr_accessor :atc_code
+
+    # The top-level ATC class.
+    attr_accessor :atc_class
+
+    # The pharmacologic class the FDA registry gives the substance.
+    attr_accessor :pharm_class
+
+    # True when the substance is a biologic, by the registry, Drugs@FDA or the Purple Book.
+    attr_accessor :is_biologic
+
+    # True when the drug has a package in the US National Drug Code (NDC) directory.
+    attr_accessor :is_marketed
+
+    # True when ChEMBL records the drug as withdrawn somewhere.
+    attr_accessor :withdrawn
+
+    # True when the drug is approved in at least one jurisdiction.
+    attr_accessor :approved_anywhere
+
+    # The regulators whose approval is recorded (FDA, EMA, Health Canada).
+    attr_accessor :approved_in
+
+    # The earliest approval year ChEMBL records.
+    attr_accessor :first_approval_year
+
+    # The highest development phase reached across the folded records (4 is approved).
+    attr_accessor :max_phase
+
+    # Registered trials that study the drug or a record folded under it.
+    attr_accessor :n_trials
+
+    # Drug records folded into this drug, the lead included.
+    attr_accessor :n_members
+
+    # The drug record ids folded into this drug, the lead included. The ids other datasets name drug_id.
+    attr_accessor :member_ids
+
+    # Variant records folded under the molecule; null when the drug is not a molecule.
+    attr_accessor :variant_count
+
+    # The brand keys that resolve to the drug.
+    attr_accessor :brands
+
+    # The number of brand keys.
+    attr_accessor :brand_count
+
+    # True when the drug has a chemical-entities page.
+    attr_accessor :is_molecule
+
+    # True when the drug is a combination product of two or more components.
+    attr_accessor :is_combination
+
+    # True when the drug's current label carries a boxed warning; null when no label is on record.
+    attr_accessor :has_boxed_warning
+
+    # The canonical SMILES string of the structure (ChEMBL).
+    attr_accessor :smiles
+
+    # The InChIKey of the structure (ChEMBL).
+    attr_accessor :inchikey
+
+    # Patents that mention the drug in the SureChEMBL corpus.
+    attr_accessor :n_patent_mentions
+
+    # Distinct patent families among those mentions.
+    attr_accessor :n_patent_families
+
+    # Publication date of the earliest mentioning patent.
+    attr_accessor :first_patent_mention
+
+    # Publication date of the latest mentioning patent.
+    attr_accessor :last_patent_mention
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'molecule_id' => :'molecule_id',
+        :'molecule_name' => :'molecule_name',
+        :'substance_name' => :'substance_name',
+        :'inn_name' => :'inn_name',
+        :'unii' => :'unii',
+        :'cas' => :'cas',
+        :'chembl_id' => :'chembl_id',
+        :'substance_type' => :'substance_type',
+        :'atc_code' => :'atc_code',
+        :'atc_class' => :'atc_class',
+        :'pharm_class' => :'pharm_class',
+        :'is_biologic' => :'is_biologic',
+        :'is_marketed' => :'is_marketed',
+        :'withdrawn' => :'withdrawn',
+        :'approved_anywhere' => :'approved_anywhere',
+        :'approved_in' => :'approved_in',
+        :'first_approval_year' => :'first_approval_year',
+        :'max_phase' => :'max_phase',
+        :'n_trials' => :'n_trials',
+        :'n_members' => :'n_members',
+        :'member_ids' => :'member_ids',
+        :'variant_count' => :'variant_count',
+        :'brands' => :'brands',
+        :'brand_count' => :'brand_count',
+        :'is_molecule' => :'is_molecule',
+        :'is_combination' => :'is_combination',
+        :'has_boxed_warning' => :'has_boxed_warning',
+        :'smiles' => :'smiles',
+        :'inchikey' => :'inchikey',
+        :'n_patent_mentions' => :'n_patent_mentions',
+        :'n_patent_families' => :'n_patent_families',
+        :'first_patent_mention' => :'first_patent_mention',
+        :'last_patent_mention' => :'last_patent_mention'
+      }
+    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
+      {
+        :'molecule_id' => :'String',
+        :'molecule_name' => :'String',
+        :'substance_name' => :'String',
+        :'inn_name' => :'String',
+        :'unii' => :'String',
+        :'cas' => :'String',
+        :'chembl_id' => :'String',
+        :'substance_type' => :'String',
+        :'atc_code' => :'String',
+        :'atc_class' => :'String',
+        :'pharm_class' => :'String',
+        :'is_biologic' => :'Boolean',
+        :'is_marketed' => :'Boolean',
+        :'withdrawn' => :'Boolean',
+        :'approved_anywhere' => :'Boolean',
+        :'approved_in' => :'Array<String>',
+        :'first_approval_year' => :'Integer',
+        :'max_phase' => :'Integer',
+        :'n_trials' => :'Integer',
+        :'n_members' => :'Integer',
+        :'member_ids' => :'Array<String>',
+        :'variant_count' => :'Integer',
+        :'brands' => :'Array<String>',
+        :'brand_count' => :'Integer',
+        :'is_molecule' => :'Boolean',
+        :'is_combination' => :'Boolean',
+        :'has_boxed_warning' => :'Boolean',
+        :'smiles' => :'String',
+        :'inchikey' => :'String',
+        :'n_patent_mentions' => :'Integer',
+        :'n_patent_families' => :'Integer',
+        :'first_patent_mention' => :'Date',
+        :'last_patent_mention' => :'Date'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'molecule_id',
+        :'molecule_name',
+        :'substance_name',
+        :'inn_name',
+        :'unii',
+        :'cas',
+        :'chembl_id',
+        :'substance_type',
+        :'atc_code',
+        :'atc_class',
+        :'pharm_class',
+        :'is_biologic',
+        :'is_marketed',
+        :'withdrawn',
+        :'approved_anywhere',
+        :'approved_in',
+        :'first_approval_year',
+        :'max_phase',
+        :'n_trials',
+        :'n_members',
+        :'member_ids',
+        :'variant_count',
+        :'brands',
+        :'brand_count',
+        :'is_molecule',
+        :'is_combination',
+        :'has_boxed_warning',
+        :'smiles',
+        :'inchikey',
+        :'n_patent_mentions',
+        :'n_patent_families',
+        :'first_patent_mention',
+        :'last_patent_mention'
+      ])
+    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::DrugsRow` 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::DrugsRow`. 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?(:'molecule_id')
+        self.molecule_id = attributes[:'molecule_id']
+      end
+
+      if attributes.key?(:'molecule_name')
+        self.molecule_name = attributes[:'molecule_name']
+      end
+
+      if attributes.key?(:'substance_name')
+        self.substance_name = attributes[:'substance_name']
+      end
+
+      if attributes.key?(:'inn_name')
+        self.inn_name = attributes[:'inn_name']
+      end
+
+      if attributes.key?(:'unii')
+        self.unii = attributes[:'unii']
+      end
+
+      if attributes.key?(:'cas')
+        self.cas = attributes[:'cas']
+      end
+
+      if attributes.key?(:'chembl_id')
+        self.chembl_id = attributes[:'chembl_id']
+      end
+
+      if attributes.key?(:'substance_type')
+        self.substance_type = attributes[:'substance_type']
+      end
+
+      if attributes.key?(:'atc_code')
+        self.atc_code = attributes[:'atc_code']
+      end
+
+      if attributes.key?(:'atc_class')
+        self.atc_class = attributes[:'atc_class']
+      end
+
+      if attributes.key?(:'pharm_class')
+        self.pharm_class = attributes[:'pharm_class']
+      end
+
+      if attributes.key?(:'is_biologic')
+        self.is_biologic = attributes[:'is_biologic']
+      end
+
+      if attributes.key?(:'is_marketed')
+        self.is_marketed = attributes[:'is_marketed']
+      end
+
+      if attributes.key?(:'withdrawn')
+        self.withdrawn = attributes[:'withdrawn']
+      end
+
+      if attributes.key?(:'approved_anywhere')
+        self.approved_anywhere = attributes[:'approved_anywhere']
+      end
+
+      if attributes.key?(:'approved_in')
+        if (value = attributes[:'approved_in']).is_a?(Array)
+          self.approved_in = value
+        end
+      end
+
+      if attributes.key?(:'first_approval_year')
+        self.first_approval_year = attributes[:'first_approval_year']
+      end
+
+      if attributes.key?(:'max_phase')
+        self.max_phase = attributes[:'max_phase']
+      end
+
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
+      end
+
+      if attributes.key?(:'n_members')
+        self.n_members = attributes[:'n_members']
+      end
+
+      if attributes.key?(:'member_ids')
+        if (value = attributes[:'member_ids']).is_a?(Array)
+          self.member_ids = value
+        end
+      end
+
+      if attributes.key?(:'variant_count')
+        self.variant_count = attributes[:'variant_count']
+      end
+
+      if attributes.key?(:'brands')
+        if (value = attributes[:'brands']).is_a?(Array)
+          self.brands = value
+        end
+      end
+
+      if attributes.key?(:'brand_count')
+        self.brand_count = attributes[:'brand_count']
+      end
+
+      if attributes.key?(:'is_molecule')
+        self.is_molecule = attributes[:'is_molecule']
+      end
+
+      if attributes.key?(:'is_combination')
+        self.is_combination = attributes[:'is_combination']
+      end
+
+      if attributes.key?(:'has_boxed_warning')
+        self.has_boxed_warning = attributes[:'has_boxed_warning']
+      end
+
+      if attributes.key?(:'smiles')
+        self.smiles = attributes[:'smiles']
+      end
+
+      if attributes.key?(:'inchikey')
+        self.inchikey = attributes[:'inchikey']
+      end
+
+      if attributes.key?(:'n_patent_mentions')
+        self.n_patent_mentions = attributes[:'n_patent_mentions']
+      end
+
+      if attributes.key?(:'n_patent_families')
+        self.n_patent_families = attributes[:'n_patent_families']
+      end
+
+      if attributes.key?(:'first_patent_mention')
+        self.first_patent_mention = attributes[:'first_patent_mention']
+      end
+
+      if attributes.key?(:'last_patent_mention')
+        self.last_patent_mention = attributes[:'last_patent_mention']
+      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 &&
+          molecule_id == o.molecule_id &&
+          molecule_name == o.molecule_name &&
+          substance_name == o.substance_name &&
+          inn_name == o.inn_name &&
+          unii == o.unii &&
+          cas == o.cas &&
+          chembl_id == o.chembl_id &&
+          substance_type == o.substance_type &&
+          atc_code == o.atc_code &&
+          atc_class == o.atc_class &&
+          pharm_class == o.pharm_class &&
+          is_biologic == o.is_biologic &&
+          is_marketed == o.is_marketed &&
+          withdrawn == o.withdrawn &&
+          approved_anywhere == o.approved_anywhere &&
+          approved_in == o.approved_in &&
+          first_approval_year == o.first_approval_year &&
+          max_phase == o.max_phase &&
+          n_trials == o.n_trials &&
+          n_members == o.n_members &&
+          member_ids == o.member_ids &&
+          variant_count == o.variant_count &&
+          brands == o.brands &&
+          brand_count == o.brand_count &&
+          is_molecule == o.is_molecule &&
+          is_combination == o.is_combination &&
+          has_boxed_warning == o.has_boxed_warning &&
+          smiles == o.smiles &&
+          inchikey == o.inchikey &&
+          n_patent_mentions == o.n_patent_mentions &&
+          n_patent_families == o.n_patent_families &&
+          first_patent_mention == o.first_patent_mention &&
+          last_patent_mention == o.last_patent_mention
+    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
+      [molecule_id, molecule_name, substance_name, inn_name, unii, cas, chembl_id, substance_type, atc_code, atc_class, pharm_class, is_biologic, is_marketed, withdrawn, approved_anywhere, approved_in, first_approval_year, max_phase, n_trials, n_members, member_ids, variant_count, brands, brand_count, is_molecule, is_combination, has_boxed_warning, smiles, inchikey, n_patent_mentions, n_patent_families, first_patent_mention, last_patent_mention].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