pharmaobservatory 0.1.3 → 0.1.4

data/lib/pharmaobservatory/models/company_funding_summary_row.rb

@@ -0,0 +1,377 @@
+=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 company_funding_summary dataset: one row per company with at least one funding event. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyFundingSummaryRow
+    # The company key (company:<key>).
+    attr_accessor :company_id
+
+    # Display name of the company.
+    attr_accessor :company_name
+
+    # Group level: the current ultimate parent company; a root company's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the group.
+    attr_accessor :group_name
+
+    # Funding events of the company, disclosed or not.
+    attr_accessor :n_rounds
+
+    # Disclosed non-dilutive amounts (grants, debt, royalty and similar), in whole US dollars.
+    attr_accessor :total_non_dilutive_usd
+
+    # Disclosed dilutive amounts (equity-issuing rounds), in whole US dollars.
+    attr_accessor :total_dilutive_usd
+
+    # Disclosed amounts of events whose instrument is not classified, kept apart from the other two totals.
+    attr_accessor :total_unclassified_usd
+
+    # Events whose instrument is not classified.
+    attr_accessor :n_unclassified_rounds
+
+    # All disclosed amounts, the sum of the three totals, in whole US dollars.
+    attr_accessor :total_raised_usd
+
+    # Date of the earliest event.
+    attr_accessor :first_funded_date
+
+    # Date of the latest event.
+    attr_accessor :last_funded_date
+
+    # The round type of the latest event.
+    attr_accessor :latest_round_type
+
+    # The date of the latest event.
+    attr_accessor :latest_round_date
+
+    # A coarse reading of the round types: public, growth_private, seed_private, unclassified or non_dilutive_only.
+    attr_accessor :stage_label
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'n_rounds' => :'n_rounds',
+        :'total_non_dilutive_usd' => :'total_non_dilutive_usd',
+        :'total_dilutive_usd' => :'total_dilutive_usd',
+        :'total_unclassified_usd' => :'total_unclassified_usd',
+        :'n_unclassified_rounds' => :'n_unclassified_rounds',
+        :'total_raised_usd' => :'total_raised_usd',
+        :'first_funded_date' => :'first_funded_date',
+        :'last_funded_date' => :'last_funded_date',
+        :'latest_round_type' => :'latest_round_type',
+        :'latest_round_date' => :'latest_round_date',
+        :'stage_label' => :'stage_label'
+      }
+    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
+      {
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'n_rounds' => :'Integer',
+        :'total_non_dilutive_usd' => :'Float',
+        :'total_dilutive_usd' => :'Float',
+        :'total_unclassified_usd' => :'Float',
+        :'n_unclassified_rounds' => :'Integer',
+        :'total_raised_usd' => :'Float',
+        :'first_funded_date' => :'Date',
+        :'last_funded_date' => :'Date',
+        :'latest_round_type' => :'String',
+        :'latest_round_date' => :'Date',
+        :'stage_label' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'n_rounds',
+        :'total_non_dilutive_usd',
+        :'total_dilutive_usd',
+        :'total_unclassified_usd',
+        :'n_unclassified_rounds',
+        :'total_raised_usd',
+        :'first_funded_date',
+        :'last_funded_date',
+        :'latest_round_type',
+        :'latest_round_date',
+        :'stage_label'
+      ])
+    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::CompanyFundingSummaryRow` 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::CompanyFundingSummaryRow`. 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?(:'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
+
+      if attributes.key?(:'n_rounds')
+        self.n_rounds = attributes[:'n_rounds']
+      end
+
+      if attributes.key?(:'total_non_dilutive_usd')
+        self.total_non_dilutive_usd = attributes[:'total_non_dilutive_usd']
+      end
+
+      if attributes.key?(:'total_dilutive_usd')
+        self.total_dilutive_usd = attributes[:'total_dilutive_usd']
+      end
+
+      if attributes.key?(:'total_unclassified_usd')
+        self.total_unclassified_usd = attributes[:'total_unclassified_usd']
+      end
+
+      if attributes.key?(:'n_unclassified_rounds')
+        self.n_unclassified_rounds = attributes[:'n_unclassified_rounds']
+      end
+
+      if attributes.key?(:'total_raised_usd')
+        self.total_raised_usd = attributes[:'total_raised_usd']
+      end
+
+      if attributes.key?(:'first_funded_date')
+        self.first_funded_date = attributes[:'first_funded_date']
+      end
+
+      if attributes.key?(:'last_funded_date')
+        self.last_funded_date = attributes[:'last_funded_date']
+      end
+
+      if attributes.key?(:'latest_round_type')
+        self.latest_round_type = attributes[:'latest_round_type']
+      end
+
+      if attributes.key?(:'latest_round_date')
+        self.latest_round_date = attributes[:'latest_round_date']
+      end
+
+      if attributes.key?(:'stage_label')
+        self.stage_label = attributes[:'stage_label']
+      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 &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          n_rounds == o.n_rounds &&
+          total_non_dilutive_usd == o.total_non_dilutive_usd &&
+          total_dilutive_usd == o.total_dilutive_usd &&
+          total_unclassified_usd == o.total_unclassified_usd &&
+          n_unclassified_rounds == o.n_unclassified_rounds &&
+          total_raised_usd == o.total_raised_usd &&
+          first_funded_date == o.first_funded_date &&
+          last_funded_date == o.last_funded_date &&
+          latest_round_type == o.latest_round_type &&
+          latest_round_date == o.latest_round_date &&
+          stage_label == o.stage_label
+    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
+      [company_id, company_name, group_id, group_name, n_rounds, total_non_dilutive_usd, total_dilutive_usd, total_unclassified_usd, n_unclassified_rounds, total_raised_usd, first_funded_date, last_funded_date, latest_round_type, latest_round_date, stage_label].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/company_programs_row.rb

@@ -40,7 +40,7 @@ module PharmaObservatory
     # The drug's name.
     attr_accessor :drug_name
 
-    # The condition key (UMLS CUI).
+    # The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits).
     attr_accessor :condition_id
 
     # The condition's name.
@@ -64,7 +64,7 @@ module PharmaObservatory
     # approved, active or abandoned.
     attr_accessor :lifecycle
 
-    # Disability-adjusted life years (millions) of the condition's global burden, IHME GBD 2021. Null for a caller without the licence for this column; see withheld_columns.
+    # Disability-adjusted life years (DALYs, millions) of the condition's global burden, from the Global Burden of Disease (GBD) 2021 study of the Institute for Health Metrics and Evaluation (IHME). Null for a caller without the licence for this column; see withheld_columns.
     attr_accessor :dalys_millions
 
     # Attribute mapping from ruby-style variable name to JSON key.