pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{orgs_org_assets200_response_rows_inner.rb → company_programs_row.rb}

@@ -14,34 +14,79 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class OrgsOrgAssets200ResponseRowsInner
+  # One row of the company_programs dataset: one row per lead sponsor, drug and indication (a development program). A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyProgramsRow
+    # Legal-entity level: the lead sponsor's organization record.
+    attr_accessor :sponsor_org_id
+
+    # The sponsor's organization name.
+    attr_accessor :sponsor_name
+
+    # Company level: the sponsor's company (null when unresolved).
+    attr_accessor :sponsor_company_id
+
+    # Display name of the sponsor's company.
+    attr_accessor :sponsor_company_name
+
+    # Group level: the sponsor's current ultimate parent; a root's group is itself.
+    attr_accessor :sponsor_group_id
+
+    # Display name of the sponsor's group.
+    attr_accessor :sponsor_group_name
+
+    # The drug key.
     attr_accessor :drug_id
 
-    attr_accessor :drug
+    # The drug's name.
+    attr_accessor :drug_name
 
-    attr_accessor :phase
+    # The condition key (UMLS CUI).
+    attr_accessor :condition_id
 
-    attr_accessor :trials
+    # The condition's name.
+    attr_accessor :condition_name
 
-    attr_accessor :last_year
+    # Highest phase reached: 0 early phase 1 through 6 for phase 4 (marketed); -1 when unstated.
+    attr_accessor :max_phase
+
+    # Lead-sponsored trials in the program.
+    attr_accessor :n_trials
 
+    # Of those, trials in an active status.
     attr_accessor :n_active
 
+    # Latest trial start year.
+    attr_accessor :last_year
+
+    # True when the drug has been withdrawn.
     attr_accessor :withdrawn
 
-    attr_accessor :bucket
+    # 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.
+    attr_accessor :dalys_millions
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'sponsor_org_id' => :'sponsor_org_id',
+        :'sponsor_name' => :'sponsor_name',
+        :'sponsor_company_id' => :'sponsor_company_id',
+        :'sponsor_company_name' => :'sponsor_company_name',
+        :'sponsor_group_id' => :'sponsor_group_id',
+        :'sponsor_group_name' => :'sponsor_group_name',
         :'drug_id' => :'drug_id',
-        :'drug' => :'drug',
-        :'phase' => :'phase',
-        :'trials' => :'trials',
-        :'last_year' => :'last_year',
+        :'drug_name' => :'drug_name',
+        :'condition_id' => :'condition_id',
+        :'condition_name' => :'condition_name',
+        :'max_phase' => :'max_phase',
+        :'n_trials' => :'n_trials',
         :'n_active' => :'n_active',
+        :'last_year' => :'last_year',
         :'withdrawn' => :'withdrawn',
-        :'bucket' => :'bucket'
+        :'lifecycle' => :'lifecycle',
+        :'dalys_millions' => :'dalys_millions'
       }
     end
 
@@ -58,20 +103,46 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'sponsor_org_id' => :'String',
+        :'sponsor_name' => :'String',
+        :'sponsor_company_id' => :'String',
+        :'sponsor_company_name' => :'String',
+        :'sponsor_group_id' => :'String',
+        :'sponsor_group_name' => :'String',
         :'drug_id' => :'String',
-        :'drug' => :'String',
-        :'phase' => :'String',
-        :'trials' => :'Integer',
-        :'last_year' => :'Integer',
+        :'drug_name' => :'String',
+        :'condition_id' => :'String',
+        :'condition_name' => :'String',
+        :'max_phase' => :'Integer',
+        :'n_trials' => :'Integer',
         :'n_active' => :'Integer',
+        :'last_year' => :'Integer',
         :'withdrawn' => :'Boolean',
-        :'bucket' => :'String'
+        :'lifecycle' => :'String',
+        :'dalys_millions' => :'Float'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'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',
+        :'max_phase',
+        :'n_trials',
+        :'n_active',
+        :'last_year',
+        :'withdrawn',
+        :'lifecycle',
+        :'dalys_millions'
       ])
     end
 
@@ -79,104 +150,92 @@ module PharmaObservatory
     # @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::OrgsOrgAssets200ResponseRowsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::CompanyProgramsRow` 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::OrgsOrgAssets200ResponseRowsInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::CompanyProgramsRow`. 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?(:'drug_id')
-        self.drug_id = attributes[:'drug_id']
-      else
-        self.drug_id = nil
+      if attributes.key?(:'sponsor_org_id')
+        self.sponsor_org_id = attributes[:'sponsor_org_id']
       end
 
-      if attributes.key?(:'drug')
-        self.drug = attributes[:'drug']
-      else
-        self.drug = nil
+      if attributes.key?(:'sponsor_name')
+        self.sponsor_name = attributes[:'sponsor_name']
       end
 
-      if attributes.key?(:'phase')
-        self.phase = attributes[:'phase']
-      else
-        self.phase = nil
+      if attributes.key?(:'sponsor_company_id')
+        self.sponsor_company_id = attributes[:'sponsor_company_id']
       end
 
-      if attributes.key?(:'trials')
-        self.trials = attributes[:'trials']
-      else
-        self.trials = nil
+      if attributes.key?(:'sponsor_company_name')
+        self.sponsor_company_name = attributes[:'sponsor_company_name']
       end
 
-      if attributes.key?(:'last_year')
-        self.last_year = attributes[:'last_year']
-      else
-        self.last_year = nil
+      if attributes.key?(:'sponsor_group_id')
+        self.sponsor_group_id = attributes[:'sponsor_group_id']
       end
 
-      if attributes.key?(:'n_active')
-        self.n_active = attributes[:'n_active']
-      else
-        self.n_active = nil
+      if attributes.key?(:'sponsor_group_name')
+        self.sponsor_group_name = attributes[:'sponsor_group_name']
       end
 
-      if attributes.key?(:'withdrawn')
-        self.withdrawn = attributes[:'withdrawn']
-      else
-        self.withdrawn = nil
+      if attributes.key?(:'drug_id')
+        self.drug_id = attributes[:'drug_id']
       end
 
-      if attributes.key?(:'bucket')
-        self.bucket = attributes[:'bucket']
-      else
-        self.bucket = nil
+      if attributes.key?(:'drug_name')
+        self.drug_name = attributes[:'drug_name']
       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 @drug_id.nil?
-        invalid_properties.push('invalid value for "drug_id", drug_id cannot be nil.')
+      if attributes.key?(:'condition_id')
+        self.condition_id = attributes[:'condition_id']
       end
 
-      if @drug.nil?
-        invalid_properties.push('invalid value for "drug", drug cannot be nil.')
+      if attributes.key?(:'condition_name')
+        self.condition_name = attributes[:'condition_name']
       end
 
-      if @phase.nil?
-        invalid_properties.push('invalid value for "phase", phase cannot be nil.')
+      if attributes.key?(:'max_phase')
+        self.max_phase = attributes[:'max_phase']
       end
 
-      if @trials.nil?
-        invalid_properties.push('invalid value for "trials", trials cannot be nil.')
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
       end
 
-      if @last_year.nil?
-        invalid_properties.push('invalid value for "last_year", last_year cannot be nil.')
+      if attributes.key?(:'n_active')
+        self.n_active = attributes[:'n_active']
       end
 
-      if @n_active.nil?
-        invalid_properties.push('invalid value for "n_active", n_active cannot be nil.')
+      if attributes.key?(:'last_year')
+        self.last_year = attributes[:'last_year']
       end
 
-      if @withdrawn.nil?
-        invalid_properties.push('invalid value for "withdrawn", withdrawn cannot be nil.')
+      if attributes.key?(:'withdrawn')
+        self.withdrawn = attributes[:'withdrawn']
+      end
+
+      if attributes.key?(:'lifecycle')
+        self.lifecycle = attributes[:'lifecycle']
       end
 
-      if @bucket.nil?
-        invalid_properties.push('invalid value for "bucket", bucket cannot be nil.')
+      if attributes.key?(:'dalys_millions')
+        self.dalys_millions = attributes[:'dalys_millions']
       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
 
@@ -184,110 +243,31 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @drug_id.nil?
-      return false if @drug.nil?
-      return false if @phase.nil?
-      return false if @trials.nil?
-      return false if @last_year.nil?
-      return false if @n_active.nil?
-      return false if @withdrawn.nil?
-      return false if @bucket.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] drug_id Value to be assigned
-    def drug_id=(drug_id)
-      if drug_id.nil?
-        fail ArgumentError, 'drug_id cannot be nil'
-      end
-
-      @drug_id = drug_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] drug Value to be assigned
-    def drug=(drug)
-      if drug.nil?
-        fail ArgumentError, 'drug cannot be nil'
-      end
-
-      @drug = drug
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] phase Value to be assigned
-    def phase=(phase)
-      if phase.nil?
-        fail ArgumentError, 'phase cannot be nil'
-      end
-
-      @phase = phase
-    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
-
-    # Custom attribute writer method with validation
-    # @param [Object] last_year Value to be assigned
-    def last_year=(last_year)
-      if last_year.nil?
-        fail ArgumentError, 'last_year cannot be nil'
-      end
-
-      @last_year = last_year
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] n_active Value to be assigned
-    def n_active=(n_active)
-      if n_active.nil?
-        fail ArgumentError, 'n_active cannot be nil'
-      end
-
-      @n_active = n_active
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] withdrawn Value to be assigned
-    def withdrawn=(withdrawn)
-      if withdrawn.nil?
-        fail ArgumentError, 'withdrawn cannot be nil'
-      end
-
-      @withdrawn = withdrawn
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] bucket Value to be assigned
-    def bucket=(bucket)
-      if bucket.nil?
-        fail ArgumentError, 'bucket cannot be nil'
-      end
-
-      @bucket = bucket
-    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 &&
+          sponsor_org_id == o.sponsor_org_id &&
+          sponsor_name == o.sponsor_name &&
+          sponsor_company_id == o.sponsor_company_id &&
+          sponsor_company_name == o.sponsor_company_name &&
+          sponsor_group_id == o.sponsor_group_id &&
+          sponsor_group_name == o.sponsor_group_name &&
           drug_id == o.drug_id &&
-          drug == o.drug &&
-          phase == o.phase &&
-          trials == o.trials &&
-          last_year == o.last_year &&
+          drug_name == o.drug_name &&
+          condition_id == o.condition_id &&
+          condition_name == o.condition_name &&
+          max_phase == o.max_phase &&
+          n_trials == o.n_trials &&
           n_active == o.n_active &&
+          last_year == o.last_year &&
           withdrawn == o.withdrawn &&
-          bucket == o.bucket
+          lifecycle == o.lifecycle &&
+          dalys_millions == o.dalys_millions
     end
 
     # @see the `==` method
@@ -299,7 +279,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [drug_id, drug, phase, trials, last_year, n_active, withdrawn, bucket].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, max_phase, n_trials, n_active, last_year, withdrawn, lifecycle, dalys_millions].hash
     end
 
     # Builds the object from hash