pharmaobservatory 0.1.1 → 0.1.3

data/lib/pharmaobservatory/models/{api_v1_trials_discontinuation_reasons_get200_response_trials_inner.rb → site_trials_row.rb}

@@ -14,28 +14,71 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class ApiV1TrialsDiscontinuationReasonsGet200ResponseTrialsInner
-    attr_accessor :nct_id
+  # One row of the site_trials dataset: one row per site and trial. A grouped request returns the group columns and the measures instead, as additional properties.
+  class SiteTrialsRow
+    # The site key: one facility spelling from the registry.
+    attr_accessor :site_id
 
-    attr_accessor :brief_title
+    # The trial's registry id (NCT number).
+    attr_accessor :trial_id
 
+    # The trial's brief title.
+    attr_accessor :trial_title
+
+    # INTERVENTIONAL or OBSERVATIONAL.
+    attr_accessor :study_type
+
+    # The trial phase label.
+    attr_accessor :phase
+
+    # The registry's overall status.
     attr_accessor :overall_status
 
+    # Trial start date.
+    attr_accessor :start_date
+
+    # Year of the trial start.
+    attr_accessor :start_year
+
+    # Enrollment as registered for the whole trial.
+    attr_accessor :enrollment
+
+    # The lead sponsor's name as filed.
     attr_accessor :lead_sponsor_name
 
-    attr_accessor :phase
+    # Legal-entity level: the organization record the lead sponsor resolved to (null when unresolved).
+    attr_accessor :lead_sponsor_org_id
+
+    # Company level: the company the lead sponsor belongs to (null when unresolved).
+    attr_accessor :lead_sponsor_company_id
 
-    attr_accessor :why_stopped
+    # Display name of the lead sponsor's company.
+    attr_accessor :lead_sponsor_company_name
+
+    # Group level: the lead sponsor's current ultimate parent company; a root company's group is itself.
+    attr_accessor :lead_sponsor_group_id
+
+    # Display name of the lead sponsor's group.
+    attr_accessor :lead_sponsor_group_name
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'nct_id' => :'nct_id',
-        :'brief_title' => :'brief_title',
+        :'site_id' => :'site_id',
+        :'trial_id' => :'trial_id',
+        :'trial_title' => :'trial_title',
+        :'study_type' => :'study_type',
+        :'phase' => :'phase',
         :'overall_status' => :'overall_status',
+        :'start_date' => :'start_date',
+        :'start_year' => :'start_year',
+        :'enrollment' => :'enrollment',
         :'lead_sponsor_name' => :'lead_sponsor_name',
-        :'phase' => :'phase',
-        :'why_stopped' => :'why_stopped'
+        :'lead_sponsor_org_id' => :'lead_sponsor_org_id',
+        :'lead_sponsor_company_id' => :'lead_sponsor_company_id',
+        :'lead_sponsor_company_name' => :'lead_sponsor_company_name',
+        :'lead_sponsor_group_id' => :'lead_sponsor_group_id',
+        :'lead_sponsor_group_name' => :'lead_sponsor_group_name'
       }
     end
 
@@ -52,19 +95,42 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'nct_id' => :'String',
-        :'brief_title' => :'String',
+        :'site_id' => :'String',
+        :'trial_id' => :'String',
+        :'trial_title' => :'String',
+        :'study_type' => :'String',
+        :'phase' => :'String',
         :'overall_status' => :'String',
+        :'start_date' => :'Date',
+        :'start_year' => :'Integer',
+        :'enrollment' => :'Integer',
         :'lead_sponsor_name' => :'String',
-        :'phase' => :'String',
-        :'why_stopped' => :'String'
+        :'lead_sponsor_org_id' => :'String',
+        :'lead_sponsor_company_id' => :'String',
+        :'lead_sponsor_company_name' => :'String',
+        :'lead_sponsor_group_id' => :'String',
+        :'lead_sponsor_group_name' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'why_stopped'
+        :'site_id',
+        :'trial_id',
+        :'trial_title',
+        :'study_type',
+        :'phase',
+        :'overall_status',
+        :'start_date',
+        :'start_year',
+        :'enrollment',
+        :'lead_sponsor_name',
+        :'lead_sponsor_org_id',
+        :'lead_sponsor_company_id',
+        :'lead_sponsor_company_name',
+        :'lead_sponsor_group_id',
+        :'lead_sponsor_group_name'
       ])
     end
 
@@ -72,143 +138,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::ApiV1TrialsDiscontinuationReasonsGet200ResponseTrialsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::SiteTrialsRow` 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::ApiV1TrialsDiscontinuationReasonsGet200ResponseTrialsInner`. 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::SiteTrialsRow`. 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?(:'nct_id')
-        self.nct_id = attributes[:'nct_id']
-      else
-        self.nct_id = nil
+      if attributes.key?(:'site_id')
+        self.site_id = attributes[:'site_id']
       end
 
-      if attributes.key?(:'brief_title')
-        self.brief_title = attributes[:'brief_title']
-      else
-        self.brief_title = nil
+      if attributes.key?(:'trial_id')
+        self.trial_id = attributes[:'trial_id']
       end
 
-      if attributes.key?(:'overall_status')
-        self.overall_status = attributes[:'overall_status']
-      else
-        self.overall_status = nil
+      if attributes.key?(:'trial_title')
+        self.trial_title = attributes[:'trial_title']
       end
 
-      if attributes.key?(:'lead_sponsor_name')
-        self.lead_sponsor_name = attributes[:'lead_sponsor_name']
-      else
-        self.lead_sponsor_name = nil
+      if attributes.key?(:'study_type')
+        self.study_type = attributes[:'study_type']
       end
 
       if attributes.key?(:'phase')
         self.phase = attributes[:'phase']
-      else
-        self.phase = nil
       end
 
-      if attributes.key?(:'why_stopped')
-        self.why_stopped = attributes[:'why_stopped']
-      else
-        self.why_stopped = nil
+      if attributes.key?(:'overall_status')
+        self.overall_status = attributes[:'overall_status']
       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 @nct_id.nil?
-        invalid_properties.push('invalid value for "nct_id", nct_id cannot be nil.')
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
       end
 
-      if @brief_title.nil?
-        invalid_properties.push('invalid value for "brief_title", brief_title cannot be nil.')
+      if attributes.key?(:'start_year')
+        self.start_year = attributes[:'start_year']
       end
 
-      if @overall_status.nil?
-        invalid_properties.push('invalid value for "overall_status", overall_status cannot be nil.')
+      if attributes.key?(:'enrollment')
+        self.enrollment = attributes[:'enrollment']
       end
 
-      if @lead_sponsor_name.nil?
-        invalid_properties.push('invalid value for "lead_sponsor_name", lead_sponsor_name cannot be nil.')
+      if attributes.key?(:'lead_sponsor_name')
+        self.lead_sponsor_name = attributes[:'lead_sponsor_name']
       end
 
-      if @phase.nil?
-        invalid_properties.push('invalid value for "phase", phase cannot be nil.')
+      if attributes.key?(:'lead_sponsor_org_id')
+        self.lead_sponsor_org_id = attributes[:'lead_sponsor_org_id']
       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 @nct_id.nil?
-      return false if @brief_title.nil?
-      return false if @overall_status.nil?
-      return false if @lead_sponsor_name.nil?
-      return false if @phase.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] nct_id Value to be assigned
-    def nct_id=(nct_id)
-      if nct_id.nil?
-        fail ArgumentError, 'nct_id cannot be nil'
+      if attributes.key?(:'lead_sponsor_company_id')
+        self.lead_sponsor_company_id = attributes[:'lead_sponsor_company_id']
       end
 
-      @nct_id = nct_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] brief_title Value to be assigned
-    def brief_title=(brief_title)
-      if brief_title.nil?
-        fail ArgumentError, 'brief_title cannot be nil'
+      if attributes.key?(:'lead_sponsor_company_name')
+        self.lead_sponsor_company_name = attributes[:'lead_sponsor_company_name']
       end
 
-      @brief_title = brief_title
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] overall_status Value to be assigned
-    def overall_status=(overall_status)
-      if overall_status.nil?
-        fail ArgumentError, 'overall_status cannot be nil'
+      if attributes.key?(:'lead_sponsor_group_id')
+        self.lead_sponsor_group_id = attributes[:'lead_sponsor_group_id']
       end
 
-      @overall_status = overall_status
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] lead_sponsor_name Value to be assigned
-    def lead_sponsor_name=(lead_sponsor_name)
-      if lead_sponsor_name.nil?
-        fail ArgumentError, 'lead_sponsor_name cannot be nil'
+      if attributes.key?(:'lead_sponsor_group_name')
+        self.lead_sponsor_group_name = attributes[:'lead_sponsor_group_name']
       end
-
-      @lead_sponsor_name = lead_sponsor_name
     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
+    # 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
 
-      @phase = phase
+    # 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.
@@ -216,12 +231,21 @@ module PharmaObservatory
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          nct_id == o.nct_id &&
-          brief_title == o.brief_title &&
+          site_id == o.site_id &&
+          trial_id == o.trial_id &&
+          trial_title == o.trial_title &&
+          study_type == o.study_type &&
+          phase == o.phase &&
           overall_status == o.overall_status &&
+          start_date == o.start_date &&
+          start_year == o.start_year &&
+          enrollment == o.enrollment &&
           lead_sponsor_name == o.lead_sponsor_name &&
-          phase == o.phase &&
-          why_stopped == o.why_stopped
+          lead_sponsor_org_id == o.lead_sponsor_org_id &&
+          lead_sponsor_company_id == o.lead_sponsor_company_id &&
+          lead_sponsor_company_name == o.lead_sponsor_company_name &&
+          lead_sponsor_group_id == o.lead_sponsor_group_id &&
+          lead_sponsor_group_name == o.lead_sponsor_group_name
     end
 
     # @see the `==` method
@@ -233,7 +257,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [nct_id, brief_title, overall_status, lead_sponsor_name, phase, why_stopped].hash
+      [site_id, trial_id, trial_title, study_type, phase, overall_status, start_date, start_year, enrollment, lead_sponsor_name, lead_sponsor_org_id, lead_sponsor_company_id, lead_sponsor_company_name, lead_sponsor_group_id, lead_sponsor_group_name].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/{api_v1_licensing_candidates_get200_response.rb → sites_record.rb}

@@ -14,12 +14,24 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class ApiV1LicensingCandidatesGet200Response
-    attr_accessor :condition_id
+  class SitesRecord
+    attr_accessor :object_type
 
-    attr_accessor :condition_name
+    attr_accessor :id
 
-    attr_accessor :candidates
+    attr_accessor :record
+
+    attr_accessor :attributes
+
+    attr_accessor :datasets
+
+    attr_accessor :attribution
+
+    attr_accessor :source_credit
+
+    attr_accessor :freshness
+
+    attr_accessor :build
 
     attr_accessor :build_state
 
@@ -28,9 +40,15 @@ module PharmaObservatory
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'condition_id' => :'condition_id',
-        :'condition_name' => :'condition_name',
-        :'candidates' => :'candidates',
+        :'object_type' => :'object_type',
+        :'id' => :'id',
+        :'record' => :'record',
+        :'attributes' => :'attributes',
+        :'datasets' => :'datasets',
+        :'attribution' => :'attribution',
+        :'source_credit' => :'source_credit',
+        :'freshness' => :'freshness',
+        :'build' => :'build',
         :'build_state' => :'build_state',
         :'restriction' => :'restriction'
       }
@@ -49,17 +67,24 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'condition_id' => :'String',
-        :'condition_name' => :'String',
-        :'candidates' => :'Array<ApiV1LicensingCandidatesGet200ResponseCandidatesInner>',
-        :'build_state' => :'ApiV1BiomarkerAssayScreenGet200ResponseBuildState',
-        :'restriction' => :'ApiV1ConditionsConditionIdBurdenVsEvidenceGet200ResponseRestriction'
+        :'object_type' => :'String',
+        :'id' => :'String',
+        :'record' => :'SitesRow',
+        :'attributes' => :'SitesRecordAttributes',
+        :'datasets' => :'Array<DatasetListing>',
+        :'attribution' => :'Array<DatasetAttribution>',
+        :'source_credit' => :'String',
+        :'freshness' => :'BiomarkerCdxAssertionsResponseFreshness',
+        :'build' => :'BiomarkerCdxAssertionsResponseBuild',
+        :'build_state' => :'DatasetBuildState',
+        :'restriction' => :'Hash<String, Object>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'restriction'
       ])
     end
 
@@ -67,48 +92,74 @@ 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::ApiV1LicensingCandidatesGet200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::SitesRecord` 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::ApiV1LicensingCandidatesGet200Response`. 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::SitesRecord`. 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?(:'condition_id')
-        self.condition_id = attributes[:'condition_id']
+      if attributes.key?(:'object_type')
+        self.object_type = attributes[:'object_type']
       else
-        self.condition_id = nil
+        self.object_type = nil
       end
 
-      if attributes.key?(:'condition_name')
-        self.condition_name = attributes[:'condition_name']
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       else
-        self.condition_name = nil
+        self.id = nil
       end
 
-      if attributes.key?(:'candidates')
-        if (value = attributes[:'candidates']).is_a?(Array)
-          self.candidates = value
+      if attributes.key?(:'record')
+        self.record = attributes[:'record']
+      else
+        self.record = nil
+      end
+
+      if attributes.key?(:'attributes')
+        self.attributes = attributes[:'attributes']
+      end
+
+      if attributes.key?(:'datasets')
+        if (value = attributes[:'datasets']).is_a?(Array)
+          self.datasets = value
         end
       else
-        self.candidates = nil
+        self.datasets = nil
+      end
+
+      if attributes.key?(:'attribution')
+        if (value = attributes[:'attribution']).is_a?(Array)
+          self.attribution = value
+        end
+      end
+
+      if attributes.key?(:'source_credit')
+        self.source_credit = attributes[:'source_credit']
+      end
+
+      if attributes.key?(:'freshness')
+        self.freshness = attributes[:'freshness']
+      end
+
+      if attributes.key?(:'build')
+        self.build = attributes[:'build']
       end
 
       if attributes.key?(:'build_state')
         self.build_state = attributes[:'build_state']
-      else
-        self.build_state = nil
       end
 
       if attributes.key?(:'restriction')
-        self.restriction = attributes[:'restriction']
-      else
-        self.restriction = nil
+        if (value = attributes[:'restriction']).is_a?(Hash)
+          self.restriction = value
+        end
       end
     end
 
@@ -117,24 +168,20 @@ module PharmaObservatory
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @condition_id.nil?
-        invalid_properties.push('invalid value for "condition_id", condition_id cannot be nil.')
+      if @object_type.nil?
+        invalid_properties.push('invalid value for "object_type", object_type cannot be nil.')
       end
 
-      if @condition_name.nil?
-        invalid_properties.push('invalid value for "condition_name", condition_name cannot be nil.')
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
       end
 
-      if @candidates.nil?
-        invalid_properties.push('invalid value for "candidates", candidates cannot be nil.')
+      if @record.nil?
+        invalid_properties.push('invalid value for "record", record cannot be nil.')
       end
 
-      if @build_state.nil?
-        invalid_properties.push('invalid value for "build_state", build_state cannot be nil.')
-      end
-
-      if @restriction.nil?
-        invalid_properties.push('invalid value for "restriction", restriction cannot be nil.')
+      if @datasets.nil?
+        invalid_properties.push('invalid value for "datasets", datasets cannot be nil.')
       end
 
       invalid_properties
@@ -144,62 +191,51 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @condition_id.nil?
-      return false if @condition_name.nil?
-      return false if @candidates.nil?
-      return false if @build_state.nil?
-      return false if @restriction.nil?
+      return false if @object_type.nil?
+      return false if @id.nil?
+      return false if @record.nil?
+      return false if @datasets.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] condition_id Value to be assigned
-    def condition_id=(condition_id)
-      if condition_id.nil?
-        fail ArgumentError, 'condition_id cannot be nil'
-      end
-
-      @condition_id = condition_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] condition_name Value to be assigned
-    def condition_name=(condition_name)
-      if condition_name.nil?
-        fail ArgumentError, 'condition_name cannot be nil'
+    # @param [Object] object_type Value to be assigned
+    def object_type=(object_type)
+      if object_type.nil?
+        fail ArgumentError, 'object_type cannot be nil'
       end
 
-      @condition_name = condition_name
+      @object_type = object_type
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] candidates Value to be assigned
-    def candidates=(candidates)
-      if candidates.nil?
-        fail ArgumentError, 'candidates cannot be nil'
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
       end
 
-      @candidates = candidates
+      @id = id
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] build_state Value to be assigned
-    def build_state=(build_state)
-      if build_state.nil?
-        fail ArgumentError, 'build_state cannot be nil'
+    # @param [Object] record Value to be assigned
+    def record=(record)
+      if record.nil?
+        fail ArgumentError, 'record cannot be nil'
       end
 
-      @build_state = build_state
+      @record = record
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] restriction Value to be assigned
-    def restriction=(restriction)
-      if restriction.nil?
-        fail ArgumentError, 'restriction cannot be nil'
+    # @param [Object] datasets Value to be assigned
+    def datasets=(datasets)
+      if datasets.nil?
+        fail ArgumentError, 'datasets cannot be nil'
       end
 
-      @restriction = restriction
+      @datasets = datasets
     end
 
     # Checks equality by comparing each attribute.
@@ -207,9 +243,15 @@ module PharmaObservatory
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          condition_id == o.condition_id &&
-          condition_name == o.condition_name &&
-          candidates == o.candidates &&
+          object_type == o.object_type &&
+          id == o.id &&
+          record == o.record &&
+          attributes == o.attributes &&
+          datasets == o.datasets &&
+          attribution == o.attribution &&
+          source_credit == o.source_credit &&
+          freshness == o.freshness &&
+          build == o.build &&
           build_state == o.build_state &&
           restriction == o.restriction
     end
@@ -223,7 +265,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [condition_id, condition_name, candidates, build_state, restriction].hash
+      [object_type, id, record, attributes, datasets, attribution, source_credit, freshness, build, build_state, restriction].hash
     end
 
     # Builds the object from hash