pharmaobservatory 0.1.6 → 0.1.8

data/lib/pharmaobservatory/models/drug_brands_row.rb

@@ -0,0 +1,454 @@
+=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 drug_brands dataset: one row per drug and approved brand. A grouped request returns the group columns and the measures instead, as additional properties.
+  class DrugBrandsRow
+    # 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 brand key: an upper-case alphanumeric trade-name token (the brand's leading name tokens), the same key the brands pages use. Not a display name; brand_name is the display form.
+    attr_accessor :brand_key
+
+    # The brand's display name (the brand key in display case).
+    attr_accessor :brand_name
+
+    # The display name of the drug the brand is a brand of.
+    attr_accessor :molecule_name
+
+    # True when the drug is approved in at least one jurisdiction.
+    attr_accessor :approved_anywhere
+
+    # True when the drug, or a record folded under it, has a package in the US National Drug Code (NDC) directory.
+    attr_accessor :is_marketed
+
+    # The top-level Anatomical Therapeutic Chemical (ATC) class of the drug.
+    attr_accessor :atc_class
+
+    # True when the drug is a biologic.
+    attr_accessor :is_biologic
+
+    # The earliest approval year ChEMBL records for the drug.
+    attr_accessor :first_approval_year
+
+    # The FDA approval holder's name as filed, present only when the brand has exactly one holder name.
+    attr_accessor :holder_name
+
+    # Legal-entity level: the approval holder's organization record (null when the brand has no holder, more than one, or an unresolved one).
+    attr_accessor :holder_org_id
+
+    # Company level: the approval holder's company (null when unresolved).
+    attr_accessor :holder_company_id
+
+    # Display name of the approval holder's company.
+    attr_accessor :holder_company_name
+
+    # Group level: the approval holder's current ultimate parent company; a root company's group is itself.
+    attr_accessor :holder_group_id
+
+    # Display name of the approval holder's group.
+    attr_accessor :holder_group_name
+
+    # How firmly the holder name resolved to the organization (spine_unique, anchored and establishment_registry are folded onto an organization the spine already held; anchored_scoped, registry_scoped, alias_scoped and none are newly minted organizations). Null when the brand has no single holder organization.
+    attr_accessor :holder_match_scope
+
+    # Distinct approval-holder names FDA publishes for the brand (0 for a brand with no FDA applicant, an RxNorm-only brand).
+    attr_accessor :n_holder_names
+
+    # Distinct organizations those names resolve to; above 1 with a null holder_org_id means more than one company holds the brand.
+    attr_accessor :n_holder_orgs
+
+    # The ingest snapshot date the holder was read from.
+    attr_accessor :holder_as_of
+
+    # The brand's headline indication: the one most often named in the filings that disclose its revenue.
+    attr_accessor :headline_indication
+
+    # The brand's latest disclosed worldwide revenue in USD millions (null when none is disclosed).
+    attr_accessor :latest_revenue_usd_millions
+
+    # The fiscal year of latest_revenue_usd_millions.
+    attr_accessor :latest_revenue_year
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'molecule_id' => :'molecule_id',
+        :'brand_key' => :'brand_key',
+        :'brand_name' => :'brand_name',
+        :'molecule_name' => :'molecule_name',
+        :'approved_anywhere' => :'approved_anywhere',
+        :'is_marketed' => :'is_marketed',
+        :'atc_class' => :'atc_class',
+        :'is_biologic' => :'is_biologic',
+        :'first_approval_year' => :'first_approval_year',
+        :'holder_name' => :'holder_name',
+        :'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',
+        :'holder_match_scope' => :'holder_match_scope',
+        :'n_holder_names' => :'n_holder_names',
+        :'n_holder_orgs' => :'n_holder_orgs',
+        :'holder_as_of' => :'holder_as_of',
+        :'headline_indication' => :'headline_indication',
+        :'latest_revenue_usd_millions' => :'latest_revenue_usd_millions',
+        :'latest_revenue_year' => :'latest_revenue_year'
+      }
+    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',
+        :'brand_key' => :'String',
+        :'brand_name' => :'String',
+        :'molecule_name' => :'String',
+        :'approved_anywhere' => :'Boolean',
+        :'is_marketed' => :'Boolean',
+        :'atc_class' => :'String',
+        :'is_biologic' => :'Boolean',
+        :'first_approval_year' => :'Integer',
+        :'holder_name' => :'String',
+        :'holder_org_id' => :'String',
+        :'holder_company_id' => :'String',
+        :'holder_company_name' => :'String',
+        :'holder_group_id' => :'String',
+        :'holder_group_name' => :'String',
+        :'holder_match_scope' => :'String',
+        :'n_holder_names' => :'Integer',
+        :'n_holder_orgs' => :'Integer',
+        :'holder_as_of' => :'Date',
+        :'headline_indication' => :'String',
+        :'latest_revenue_usd_millions' => :'Float',
+        :'latest_revenue_year' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'molecule_id',
+        :'brand_key',
+        :'brand_name',
+        :'molecule_name',
+        :'approved_anywhere',
+        :'is_marketed',
+        :'atc_class',
+        :'is_biologic',
+        :'first_approval_year',
+        :'holder_name',
+        :'holder_org_id',
+        :'holder_company_id',
+        :'holder_company_name',
+        :'holder_group_id',
+        :'holder_group_name',
+        :'holder_match_scope',
+        :'n_holder_names',
+        :'n_holder_orgs',
+        :'holder_as_of',
+        :'headline_indication',
+        :'latest_revenue_usd_millions',
+        :'latest_revenue_year'
+      ])
+    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::DrugBrandsRow` 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::DrugBrandsRow`. 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?(:'brand_key')
+        self.brand_key = attributes[:'brand_key']
+      end
+
+      if attributes.key?(:'brand_name')
+        self.brand_name = attributes[:'brand_name']
+      end
+
+      if attributes.key?(:'molecule_name')
+        self.molecule_name = attributes[:'molecule_name']
+      end
+
+      if attributes.key?(:'approved_anywhere')
+        self.approved_anywhere = attributes[:'approved_anywhere']
+      end
+
+      if attributes.key?(:'is_marketed')
+        self.is_marketed = attributes[:'is_marketed']
+      end
+
+      if attributes.key?(:'atc_class')
+        self.atc_class = attributes[:'atc_class']
+      end
+
+      if attributes.key?(:'is_biologic')
+        self.is_biologic = attributes[:'is_biologic']
+      end
+
+      if attributes.key?(:'first_approval_year')
+        self.first_approval_year = attributes[:'first_approval_year']
+      end
+
+      if attributes.key?(:'holder_name')
+        self.holder_name = attributes[:'holder_name']
+      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?(:'holder_match_scope')
+        self.holder_match_scope = attributes[:'holder_match_scope']
+      end
+
+      if attributes.key?(:'n_holder_names')
+        self.n_holder_names = attributes[:'n_holder_names']
+      end
+
+      if attributes.key?(:'n_holder_orgs')
+        self.n_holder_orgs = attributes[:'n_holder_orgs']
+      end
+
+      if attributes.key?(:'holder_as_of')
+        self.holder_as_of = attributes[:'holder_as_of']
+      end
+
+      if attributes.key?(:'headline_indication')
+        self.headline_indication = attributes[:'headline_indication']
+      end
+
+      if attributes.key?(:'latest_revenue_usd_millions')
+        self.latest_revenue_usd_millions = attributes[:'latest_revenue_usd_millions']
+      end
+
+      if attributes.key?(:'latest_revenue_year')
+        self.latest_revenue_year = attributes[:'latest_revenue_year']
+      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 &&
+          brand_key == o.brand_key &&
+          brand_name == o.brand_name &&
+          molecule_name == o.molecule_name &&
+          approved_anywhere == o.approved_anywhere &&
+          is_marketed == o.is_marketed &&
+          atc_class == o.atc_class &&
+          is_biologic == o.is_biologic &&
+          first_approval_year == o.first_approval_year &&
+          holder_name == o.holder_name &&
+          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 &&
+          holder_match_scope == o.holder_match_scope &&
+          n_holder_names == o.n_holder_names &&
+          n_holder_orgs == o.n_holder_orgs &&
+          holder_as_of == o.holder_as_of &&
+          headline_indication == o.headline_indication &&
+          latest_revenue_usd_millions == o.latest_revenue_usd_millions &&
+          latest_revenue_year == o.latest_revenue_year
+    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, brand_key, brand_name, molecule_name, approved_anywhere, is_marketed, atc_class, is_biologic, first_approval_year, holder_name, holder_org_id, holder_company_id, holder_company_name, holder_group_id, holder_group_name, holder_match_scope, n_holder_names, n_holder_orgs, holder_as_of, headline_indication, latest_revenue_usd_millions, latest_revenue_year].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