pharmaobservatory 0.1.7 → 0.1.8

data/lib/pharmaobservatory/models/ownership_source_coverage_row.rb

@@ -0,0 +1,465 @@
+=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 ownership_source_coverage dataset: one row per ownership source class and subject as that source names it. A grouped request returns the group columns and the measures instead, as additional properties.
+  class OwnershipSourceCoverageRow
+    # The ownership source class (for example sec_def_14a for proxy statements, sec_form_adv for Form ADV).
+    attr_accessor :source_class
+
+    # The subject as the source names it: the source's own reference for the owned company.
+    attr_accessor :subject_source_ref
+
+    # The subject's name as filed.
+    attr_accessor :subject_name
+
+    # Legal-entity level: the organization record of the subject.
+    attr_accessor :subject_org_id
+
+    # Company level: the company the subject belongs to (null when unresolved).
+    attr_accessor :subject_company_id
+
+    # Display name of the subject's company.
+    attr_accessor :subject_company_name
+
+    # Group level: the subject's current ultimate parent company; a root company's group is itself.
+    attr_accessor :subject_group_id
+
+    # Display name of the subject's group.
+    attr_accessor :subject_group_name
+
+    # The system the source class is read from (for example sec_edgar).
+    attr_accessor :source_system
+
+    # The whole-source state: loaded, served_by_dedicated_mart (13F is served by the institutional holdings datasets), no_documents_ingested or source_not_ingested.
+    attr_accessor :source_load_state
+
+    # Documents the whole source has ingested.
+    attr_accessor :source_documents_ingested
+
+    # What the source read about this subject: reported, no_reportable_owner, extraction_abstained or read_no_owner.
+    attr_accessor :coverage_state
+
+    # Documents the source ingested about this subject.
+    attr_accessor :documents_ingested
+
+    # Ownership observations the source recorded about this subject.
+    attr_accessor :observations
+
+    # Ownership relationships that currently stand.
+    attr_accessor :current_edges
+
+    # Distinct owners the source named for this subject.
+    attr_accessor :owners_distinct
+
+    # Named owners that did not resolve to an organization or investor.
+    attr_accessor :owners_unresolved
+
+    # Filings that positively stated the subject has no reportable owner.
+    attr_accessor :no_reportable_owner_statements
+
+    # Documents on which the extractor abstained.
+    attr_accessor :extraction_abstained
+
+    # The latest filing date the source holds for this subject.
+    attr_accessor :last_filing_date
+
+    # The latest as-of date among the subject's observations.
+    attr_accessor :max_as_of_date
+
+    # The licence of the source.
+    attr_accessor :source_license
+
+    # The credit line for the source.
+    attr_accessor :attribution
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'source_class' => :'source_class',
+        :'subject_source_ref' => :'subject_source_ref',
+        :'subject_name' => :'subject_name',
+        :'subject_org_id' => :'subject_org_id',
+        :'subject_company_id' => :'subject_company_id',
+        :'subject_company_name' => :'subject_company_name',
+        :'subject_group_id' => :'subject_group_id',
+        :'subject_group_name' => :'subject_group_name',
+        :'source_system' => :'source_system',
+        :'source_load_state' => :'source_load_state',
+        :'source_documents_ingested' => :'source_documents_ingested',
+        :'coverage_state' => :'coverage_state',
+        :'documents_ingested' => :'documents_ingested',
+        :'observations' => :'observations',
+        :'current_edges' => :'current_edges',
+        :'owners_distinct' => :'owners_distinct',
+        :'owners_unresolved' => :'owners_unresolved',
+        :'no_reportable_owner_statements' => :'no_reportable_owner_statements',
+        :'extraction_abstained' => :'extraction_abstained',
+        :'last_filing_date' => :'last_filing_date',
+        :'max_as_of_date' => :'max_as_of_date',
+        :'source_license' => :'source_license',
+        :'attribution' => :'attribution'
+      }
+    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
+      {
+        :'source_class' => :'String',
+        :'subject_source_ref' => :'String',
+        :'subject_name' => :'String',
+        :'subject_org_id' => :'String',
+        :'subject_company_id' => :'String',
+        :'subject_company_name' => :'String',
+        :'subject_group_id' => :'String',
+        :'subject_group_name' => :'String',
+        :'source_system' => :'String',
+        :'source_load_state' => :'String',
+        :'source_documents_ingested' => :'Integer',
+        :'coverage_state' => :'String',
+        :'documents_ingested' => :'Integer',
+        :'observations' => :'Integer',
+        :'current_edges' => :'Integer',
+        :'owners_distinct' => :'Integer',
+        :'owners_unresolved' => :'Integer',
+        :'no_reportable_owner_statements' => :'Integer',
+        :'extraction_abstained' => :'Integer',
+        :'last_filing_date' => :'Date',
+        :'max_as_of_date' => :'Date',
+        :'source_license' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'source_class',
+        :'subject_source_ref',
+        :'subject_name',
+        :'subject_org_id',
+        :'subject_company_id',
+        :'subject_company_name',
+        :'subject_group_id',
+        :'subject_group_name',
+        :'source_system',
+        :'source_load_state',
+        :'source_documents_ingested',
+        :'coverage_state',
+        :'documents_ingested',
+        :'observations',
+        :'current_edges',
+        :'owners_distinct',
+        :'owners_unresolved',
+        :'no_reportable_owner_statements',
+        :'extraction_abstained',
+        :'last_filing_date',
+        :'max_as_of_date',
+        :'source_license',
+        :'attribution'
+      ])
+    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::OwnershipSourceCoverageRow` 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::OwnershipSourceCoverageRow`. 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?(:'source_class')
+        self.source_class = attributes[:'source_class']
+      end
+
+      if attributes.key?(:'subject_source_ref')
+        self.subject_source_ref = attributes[:'subject_source_ref']
+      end
+
+      if attributes.key?(:'subject_name')
+        self.subject_name = attributes[:'subject_name']
+      end
+
+      if attributes.key?(:'subject_org_id')
+        self.subject_org_id = attributes[:'subject_org_id']
+      end
+
+      if attributes.key?(:'subject_company_id')
+        self.subject_company_id = attributes[:'subject_company_id']
+      end
+
+      if attributes.key?(:'subject_company_name')
+        self.subject_company_name = attributes[:'subject_company_name']
+      end
+
+      if attributes.key?(:'subject_group_id')
+        self.subject_group_id = attributes[:'subject_group_id']
+      end
+
+      if attributes.key?(:'subject_group_name')
+        self.subject_group_name = attributes[:'subject_group_name']
+      end
+
+      if attributes.key?(:'source_system')
+        self.source_system = attributes[:'source_system']
+      end
+
+      if attributes.key?(:'source_load_state')
+        self.source_load_state = attributes[:'source_load_state']
+      end
+
+      if attributes.key?(:'source_documents_ingested')
+        self.source_documents_ingested = attributes[:'source_documents_ingested']
+      end
+
+      if attributes.key?(:'coverage_state')
+        self.coverage_state = attributes[:'coverage_state']
+      end
+
+      if attributes.key?(:'documents_ingested')
+        self.documents_ingested = attributes[:'documents_ingested']
+      end
+
+      if attributes.key?(:'observations')
+        self.observations = attributes[:'observations']
+      end
+
+      if attributes.key?(:'current_edges')
+        self.current_edges = attributes[:'current_edges']
+      end
+
+      if attributes.key?(:'owners_distinct')
+        self.owners_distinct = attributes[:'owners_distinct']
+      end
+
+      if attributes.key?(:'owners_unresolved')
+        self.owners_unresolved = attributes[:'owners_unresolved']
+      end
+
+      if attributes.key?(:'no_reportable_owner_statements')
+        self.no_reportable_owner_statements = attributes[:'no_reportable_owner_statements']
+      end
+
+      if attributes.key?(:'extraction_abstained')
+        self.extraction_abstained = attributes[:'extraction_abstained']
+      end
+
+      if attributes.key?(:'last_filing_date')
+        self.last_filing_date = attributes[:'last_filing_date']
+      end
+
+      if attributes.key?(:'max_as_of_date')
+        self.max_as_of_date = attributes[:'max_as_of_date']
+      end
+
+      if attributes.key?(:'source_license')
+        self.source_license = attributes[:'source_license']
+      end
+
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      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 &&
+          source_class == o.source_class &&
+          subject_source_ref == o.subject_source_ref &&
+          subject_name == o.subject_name &&
+          subject_org_id == o.subject_org_id &&
+          subject_company_id == o.subject_company_id &&
+          subject_company_name == o.subject_company_name &&
+          subject_group_id == o.subject_group_id &&
+          subject_group_name == o.subject_group_name &&
+          source_system == o.source_system &&
+          source_load_state == o.source_load_state &&
+          source_documents_ingested == o.source_documents_ingested &&
+          coverage_state == o.coverage_state &&
+          documents_ingested == o.documents_ingested &&
+          observations == o.observations &&
+          current_edges == o.current_edges &&
+          owners_distinct == o.owners_distinct &&
+          owners_unresolved == o.owners_unresolved &&
+          no_reportable_owner_statements == o.no_reportable_owner_statements &&
+          extraction_abstained == o.extraction_abstained &&
+          last_filing_date == o.last_filing_date &&
+          max_as_of_date == o.max_as_of_date &&
+          source_license == o.source_license &&
+          attribution == o.attribution
+    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
+      [source_class, subject_source_ref, subject_name, subject_org_id, subject_company_id, subject_company_name, subject_group_id, subject_group_name, source_system, source_load_state, source_documents_ingested, coverage_state, documents_ingested, observations, current_edges, owners_distinct, owners_unresolved, no_reportable_owner_statements, extraction_abstained, last_filing_date, max_as_of_date, source_license, attribution].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/program_licensing_candidates_row.rb

@@ -49,9 +49,15 @@ module PharmaObservatory
     # Every MeSH descriptor id at or above the condition in the tree, the condition itself included. Filter a subtree with = ANY.
     attr_accessor :condition_ancestor_ids
 
-    # Highest phase reached: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated.
+    # Highest phase reached on the 0 to 4 scale: 0 not reported, 1 through 4 for phase 1 through phase 4 (4 is marketed); a split phase folds up to its higher phase.
     attr_accessor :max_phase
 
+    # The furthest phase reached with the split phases kept: Early 1, Phase 1, Phase 1/2, Phase 2, Phase 2/3, Phase 3, Phase 4, or Not reported. max_phase is the same value folded onto 0 to 4 (a split phase counts as its higher phase).
+    attr_accessor :max_phase_label
+
+    # The finest phase rank behind max_phase_label: 6 Phase 4, 5 Phase 3, 4 Phase 2/3, 3 Phase 2, 2 Phase 1/2, 1 Phase 1, 0 Early 1, -1 not reported. Sort on it to order programs by furthest phase with the split phases kept; max_phase is the same value folded onto 0 to 4.
+    attr_accessor :max_phase_fine_rank
+
     # Lead-sponsored trials in the program.
     attr_accessor :n_trials
 
@@ -94,6 +100,8 @@ module PharmaObservatory
         :'condition_name' => :'condition_name',
         :'condition_ancestor_ids' => :'condition_ancestor_ids',
         :'max_phase' => :'max_phase',
+        :'max_phase_label' => :'max_phase_label',
+        :'max_phase_fine_rank' => :'max_phase_fine_rank',
         :'n_trials' => :'n_trials',
         :'n_active' => :'n_active',
         :'last_year' => :'last_year',
@@ -131,6 +139,8 @@ module PharmaObservatory
         :'condition_name' => :'String',
         :'condition_ancestor_ids' => :'Array<String>',
         :'max_phase' => :'Integer',
+        :'max_phase_label' => :'String',
+        :'max_phase_fine_rank' => :'Integer',
         :'n_trials' => :'Integer',
         :'n_active' => :'Integer',
         :'last_year' => :'Integer',
@@ -158,6 +168,8 @@ module PharmaObservatory
         :'condition_name',
         :'condition_ancestor_ids',
         :'max_phase',
+        :'max_phase_label',
+        :'max_phase_fine_rank',
         :'n_trials',
         :'n_active',
         :'last_year',
@@ -236,6 +248,14 @@ module PharmaObservatory
         self.max_phase = attributes[:'max_phase']
       end
 
+      if attributes.key?(:'max_phase_label')
+        self.max_phase_label = attributes[:'max_phase_label']
+      end
+
+      if attributes.key?(:'max_phase_fine_rank')
+        self.max_phase_fine_rank = attributes[:'max_phase_fine_rank']
+      end
+
       if attributes.key?(:'n_trials')
         self.n_trials = attributes[:'n_trials']
       end
@@ -305,6 +325,8 @@ module PharmaObservatory
           condition_name == o.condition_name &&
           condition_ancestor_ids == o.condition_ancestor_ids &&
           max_phase == o.max_phase &&
+          max_phase_label == o.max_phase_label &&
+          max_phase_fine_rank == o.max_phase_fine_rank &&
           n_trials == o.n_trials &&
           n_active == o.n_active &&
           last_year == o.last_year &&
@@ -325,7 +347,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [sponsor_org_id, sponsor_name, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, drug_id, drug_name, condition_id, condition_name, condition_ancestor_ids, max_phase, n_trials, n_active, last_year, last_update_year, withdrawn, cause_name, dalys_millions, deaths_millions, druggability].hash
+      [sponsor_org_id, sponsor_name, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, drug_id, drug_name, condition_id, condition_name, condition_ancestor_ids, max_phase, max_phase_label, max_phase_fine_rank, n_trials, n_active, last_year, last_update_year, withdrawn, cause_name, dalys_millions, deaths_millions, druggability].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/programs_row.rb

@@ -37,7 +37,7 @@ module PharmaObservatory
     # True for a specific disease, false for a broad MeSH umbrella condition.
     attr_accessor :is_indication
 
-    # Highest phase reached across the program's trials: 0 not reported, 1 through 4 for phase 1 through phase 4 (the 0 to 4 scale; see caveats).
+    # Highest phase reached across the program's trials: 0 not reported, 1 through 4 for phase 1 through phase 4 (the 0 to 4 scale shared with company_programs; see caveats).
     attr_accessor :max_phase
 
     # Distinct trials of the program, across all sponsors.