pharmaobservatory 0.1.13 → 0.1.14

data/lib/pharmaobservatory/models/changes_list200_response_items_inner_entry_keys.rb

@@ -0,0 +1,237 @@
+=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
+  class ChangesList200ResponseItemsInnerEntryKeys
+    attr_accessor :trials
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'trials' => :'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
+      {
+        :'trials' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ChangesList200ResponseItemsInnerEntryKeys` 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::ChangesList200ResponseItemsInnerEntryKeys`. 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?(:'trials')
+        self.trials = attributes[:'trials']
+      else
+        self.trials = nil
+      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
+      if @trials.nil?
+        invalid_properties.push('invalid value for "trials", trials cannot be nil.')
+      end
+
+      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'
+      return false if @trials.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] trials Value to be assigned
+    def trials=(trials)
+      if trials.nil?
+        fail ArgumentError, 'trials cannot be nil'
+      end
+
+      @trials = trials
+    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 &&
+          trials == o.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
+      [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/company_financials_row.rb

@@ -61,6 +61,33 @@ module PharmaObservatory
     # The latest fiscal year the filer reported any line item.
     attr_accessor :latest_financial_fy
 
+    # The end of the latest reported quarter of the filer that has an operating cash flow figure (a 10-Q, or the Q4 derived from a 10-K); the date of the cash figure below. Repeated on every year row of the filer; null for a company with no quarterly SEC filings.
+    attr_accessor :quarter_end_date
+
+    # The date SEC received the filing of that latest quarter.
+    attr_accessor :quarter_filed_date
+
+    # Cash plus short-term investments at quarter_end_date, in USD (non-current investments are not counted).
+    attr_accessor :cash_and_investments_latest_q
+
+    # Net cash from operating activities of that latest quarter alone (year-to-date figures differenced; Q4 is the full year less nine months), in USD; negative means burning.
+    attr_accessor :operating_cash_flow_latest_q
+
+    # How many contiguous quarters burn_basis_quarterly_usd averages over, 1 or 2.
+    attr_accessor :burn_basis_quarters
+
+    # The mean quarterly operating cash flow over the latest two contiguous quarters (the latest alone when no contiguous earlier quarter has a figure), in USD; negative means burning.
+    attr_accessor :burn_basis_quarterly_usd
+
+    # An estimate, derived not reported: cash_and_investments_latest_q divided by the monthly burn (burn_basis_quarterly_usd over 3), in months at quarter_end_date, rounded to 0.1. Null whenever runway_quarterly_null_reason is set.
+    attr_accessor :runway_months_quarterly
+
+    # The version of the derivation behind runway_months_quarterly; trailing_quarter_mean_v1 is the mean of the latest two contiguous discrete quarters.
+    attr_accessor :runway_quarterly_method
+
+    # Why runway_months_quarterly is null, in precedence order: no_quarterly_facts (no 10-Q cash-flow facts: a private company or a 20-F/40-F filer), stale (the latest quarter ended over a year before the newest SEC filing loaded), no_fx_rate, no_cash_at_quarter_end, or positive_cash_flow (no burn to run out of). Null when the runway is published.
+    attr_accessor :runway_quarterly_null_reason
+
     # Total revenue for the fiscal year, in USD (a non-USD filer is converted at the calendar-year average rate; null when no rate exists).
     attr_accessor :revenue
 
@@ -172,6 +199,15 @@ module PharmaObservatory
         :'latest_shares_outstanding' => :'latest_shares_outstanding',
         :'latest_shares_outstanding_fy' => :'latest_shares_outstanding_fy',
         :'latest_financial_fy' => :'latest_financial_fy',
+        :'quarter_end_date' => :'quarter_end_date',
+        :'quarter_filed_date' => :'quarter_filed_date',
+        :'cash_and_investments_latest_q' => :'cash_and_investments_latest_q',
+        :'operating_cash_flow_latest_q' => :'operating_cash_flow_latest_q',
+        :'burn_basis_quarters' => :'burn_basis_quarters',
+        :'burn_basis_quarterly_usd' => :'burn_basis_quarterly_usd',
+        :'runway_months_quarterly' => :'runway_months_quarterly',
+        :'runway_quarterly_method' => :'runway_quarterly_method',
+        :'runway_quarterly_null_reason' => :'runway_quarterly_null_reason',
         :'revenue' => :'revenue',
         :'net_income' => :'net_income',
         :'rnd' => :'rnd',
@@ -234,6 +270,15 @@ module PharmaObservatory
         :'latest_shares_outstanding' => :'Float',
         :'latest_shares_outstanding_fy' => :'Integer',
         :'latest_financial_fy' => :'Integer',
+        :'quarter_end_date' => :'Date',
+        :'quarter_filed_date' => :'Date',
+        :'cash_and_investments_latest_q' => :'Float',
+        :'operating_cash_flow_latest_q' => :'Float',
+        :'burn_basis_quarters' => :'Integer',
+        :'burn_basis_quarterly_usd' => :'Float',
+        :'runway_months_quarterly' => :'Float',
+        :'runway_quarterly_method' => :'String',
+        :'runway_quarterly_null_reason' => :'String',
         :'revenue' => :'Float',
         :'net_income' => :'Float',
         :'rnd' => :'Float',
@@ -286,6 +331,15 @@ module PharmaObservatory
         :'latest_shares_outstanding',
         :'latest_shares_outstanding_fy',
         :'latest_financial_fy',
+        :'quarter_end_date',
+        :'quarter_filed_date',
+        :'cash_and_investments_latest_q',
+        :'operating_cash_flow_latest_q',
+        :'burn_basis_quarters',
+        :'burn_basis_quarterly_usd',
+        :'runway_months_quarterly',
+        :'runway_quarterly_method',
+        :'runway_quarterly_null_reason',
         :'revenue',
         :'net_income',
         :'rnd',
@@ -396,6 +450,42 @@ module PharmaObservatory
         self.latest_financial_fy = attributes[:'latest_financial_fy']
       end
 
+      if attributes.key?(:'quarter_end_date')
+        self.quarter_end_date = attributes[:'quarter_end_date']
+      end
+
+      if attributes.key?(:'quarter_filed_date')
+        self.quarter_filed_date = attributes[:'quarter_filed_date']
+      end
+
+      if attributes.key?(:'cash_and_investments_latest_q')
+        self.cash_and_investments_latest_q = attributes[:'cash_and_investments_latest_q']
+      end
+
+      if attributes.key?(:'operating_cash_flow_latest_q')
+        self.operating_cash_flow_latest_q = attributes[:'operating_cash_flow_latest_q']
+      end
+
+      if attributes.key?(:'burn_basis_quarters')
+        self.burn_basis_quarters = attributes[:'burn_basis_quarters']
+      end
+
+      if attributes.key?(:'burn_basis_quarterly_usd')
+        self.burn_basis_quarterly_usd = attributes[:'burn_basis_quarterly_usd']
+      end
+
+      if attributes.key?(:'runway_months_quarterly')
+        self.runway_months_quarterly = attributes[:'runway_months_quarterly']
+      end
+
+      if attributes.key?(:'runway_quarterly_method')
+        self.runway_quarterly_method = attributes[:'runway_quarterly_method']
+      end
+
+      if attributes.key?(:'runway_quarterly_null_reason')
+        self.runway_quarterly_null_reason = attributes[:'runway_quarterly_null_reason']
+      end
+
       if attributes.key?(:'revenue')
         self.revenue = attributes[:'revenue']
       end
@@ -556,6 +646,15 @@ module PharmaObservatory
           latest_shares_outstanding == o.latest_shares_outstanding &&
           latest_shares_outstanding_fy == o.latest_shares_outstanding_fy &&
           latest_financial_fy == o.latest_financial_fy &&
+          quarter_end_date == o.quarter_end_date &&
+          quarter_filed_date == o.quarter_filed_date &&
+          cash_and_investments_latest_q == o.cash_and_investments_latest_q &&
+          operating_cash_flow_latest_q == o.operating_cash_flow_latest_q &&
+          burn_basis_quarters == o.burn_basis_quarters &&
+          burn_basis_quarterly_usd == o.burn_basis_quarterly_usd &&
+          runway_months_quarterly == o.runway_months_quarterly &&
+          runway_quarterly_method == o.runway_quarterly_method &&
+          runway_quarterly_null_reason == o.runway_quarterly_null_reason &&
           revenue == o.revenue &&
           net_income == o.net_income &&
           rnd == o.rnd &&
@@ -598,7 +697,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [company_id, company_name, group_id, group_name, reporting_org_id, fiscal_year, is_public, edgar_cik, ticker, exchange, public_float_usd, public_float_fy, latest_shares_outstanding, latest_shares_outstanding_fy, latest_financial_fy, revenue, net_income, rnd, assets, equity, public_float, cash, short_term_investments, cash_and_investments, operating_cash_flow, shares_outstanding, stock_based_compensation, operating_expenses, dividends_paid, eps_basic, eps_diluted, total_liabilities, long_term_debt_noncurrent, long_term_debt_total, intangible_assets, property_plant_equipment, goodwill, inventory, accounts_payable, accounts_receivable, weighted_average_shares_basic, weighted_average_shares_diluted, burn_basis_usd, burn_basis_years, runway_months, sec_total_revenue_usd_millions].hash
+      [company_id, company_name, group_id, group_name, reporting_org_id, fiscal_year, is_public, edgar_cik, ticker, exchange, public_float_usd, public_float_fy, latest_shares_outstanding, latest_shares_outstanding_fy, latest_financial_fy, quarter_end_date, quarter_filed_date, cash_and_investments_latest_q, operating_cash_flow_latest_q, burn_basis_quarters, burn_basis_quarterly_usd, runway_months_quarterly, runway_quarterly_method, runway_quarterly_null_reason, revenue, net_income, rnd, assets, equity, public_float, cash, short_term_investments, cash_and_investments, operating_cash_flow, shares_outstanding, stock_based_compensation, operating_expenses, dividends_paid, eps_basic, eps_diluted, total_liabilities, long_term_debt_noncurrent, long_term_debt_total, intangible_assets, property_plant_equipment, goodwill, inventory, accounts_payable, accounts_receivable, weighted_average_shares_basic, weighted_average_shares_diluted, burn_basis_usd, burn_basis_years, runway_months, sec_total_revenue_usd_millions].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/condition_adverse_events_row.rb

@@ -28,13 +28,21 @@ module PharmaObservatory
     # Trials for this condition that report the term.
     attr_accessor :n_trials
 
+    # Distinct serious adverse event terms across the condition's trials. The rows are only the top 10 of these, so a row count is not the term count; use this.
+    attr_accessor :n_terms_total
+
+    # Results-posting trials of the condition that report at least one serious adverse event term.
+    attr_accessor :n_trials_total
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'condition_id' => :'condition_id',
         :'adverse_event_term' => :'adverse_event_term',
         :'subjects_affected' => :'subjects_affected',
-        :'n_trials' => :'n_trials'
+        :'n_trials' => :'n_trials',
+        :'n_terms_total' => :'n_terms_total',
+        :'n_trials_total' => :'n_trials_total'
       }
     end
 
@@ -54,7 +62,9 @@ module PharmaObservatory
         :'condition_id' => :'String',
         :'adverse_event_term' => :'String',
         :'subjects_affected' => :'Float',
-        :'n_trials' => :'Integer'
+        :'n_trials' => :'Integer',
+        :'n_terms_total' => :'Integer',
+        :'n_trials_total' => :'Integer'
       }
     end
 
@@ -64,7 +74,9 @@ module PharmaObservatory
         :'condition_id',
         :'adverse_event_term',
         :'subjects_affected',
-        :'n_trials'
+        :'n_trials',
+        :'n_terms_total',
+        :'n_trials_total'
       ])
     end
 
@@ -99,6 +111,14 @@ module PharmaObservatory
       if attributes.key?(:'n_trials')
         self.n_trials = attributes[:'n_trials']
       end
+
+      if attributes.key?(:'n_terms_total')
+        self.n_terms_total = attributes[:'n_terms_total']
+      end
+
+      if attributes.key?(:'n_trials_total')
+        self.n_trials_total = attributes[:'n_trials_total']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -124,7 +144,9 @@ module PharmaObservatory
           condition_id == o.condition_id &&
           adverse_event_term == o.adverse_event_term &&
           subjects_affected == o.subjects_affected &&
-          n_trials == o.n_trials
+          n_trials == o.n_trials &&
+          n_terms_total == o.n_terms_total &&
+          n_trials_total == o.n_trials_total
     end
 
     # @see the `==` method
@@ -136,7 +158,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [condition_id, adverse_event_term, subjects_affected, n_trials].hash
+      [condition_id, adverse_event_term, subjects_affected, n_trials, n_terms_total, n_trials_total].hash
     end
 
     # Builds the object from hash