pharmaobservatory 0.1.1 → 0.1.3

data/lib/pharmaobservatory/models/{api_v1_trials_history_and_prediction_get200_response_record_history_observations_inner.rb → sponsor_trials_row.rb}

@@ -14,34 +14,95 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInner
-    attr_accessor :kind
+  # One row of the sponsor_trials dataset: one row per trial and sponsor as filed (lead sponsor or collaborator). A grouped request returns the group columns and the measures instead, as additional properties.
+  class SponsorTrialsRow
+    # The trial's registry id (NCT number).
+    attr_accessor :trial_id
 
-    attr_accessor :as_of
+    # lead or collaborator.
+    attr_accessor :sponsor_role
 
-    attr_accessor :enrollment
+    # The sponsor name as filed.
+    attr_accessor :sponsor_name
+
+    # Legal-entity level: the organization record the sponsor resolved to (null when unresolved).
+    attr_accessor :sponsor_org_id
+
+    # Company level: the company the sponsor belongs to (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 company; a root company's group is itself.
+    attr_accessor :sponsor_group_id
+
+    # Display name of the sponsor's group.
+    attr_accessor :sponsor_group_name
+
+    # The registry's agency class for the sponsor (INDUSTRY, NIH, OTHER ...).
+    attr_accessor :sponsor_agency_class
+
+    # How the sponsor name was resolved to an organization record.
+    attr_accessor :sponsor_resolution_method
+
+    # 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
+
+    # Primary completion date.
     attr_accessor :primary_completion_date
 
-    attr_accessor :completion_date
+    # Enrollment as registered.
+    attr_accessor :enrollment
+
+    # Whether results are posted.
+    attr_accessor :were_results_reported
 
-    attr_accessor :overall_status
+    # Conditions studied, as registered.
+    attr_accessor :conditions
 
-    attr_accessor :sites
+    # Interventions, as registered.
+    attr_accessor :interventions
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'kind' => :'kind',
-        :'as_of' => :'as_of',
-        :'enrollment' => :'enrollment',
+        :'trial_id' => :'trial_id',
+        :'sponsor_role' => :'sponsor_role',
+        :'sponsor_name' => :'sponsor_name',
+        :'sponsor_org_id' => :'sponsor_org_id',
+        :'sponsor_company_id' => :'sponsor_company_id',
+        :'sponsor_company_name' => :'sponsor_company_name',
+        :'sponsor_group_id' => :'sponsor_group_id',
+        :'sponsor_group_name' => :'sponsor_group_name',
+        :'sponsor_agency_class' => :'sponsor_agency_class',
+        :'sponsor_resolution_method' => :'sponsor_resolution_method',
+        :'trial_title' => :'trial_title',
+        :'study_type' => :'study_type',
+        :'phase' => :'phase',
+        :'overall_status' => :'overall_status',
         :'start_date' => :'start_date',
+        :'start_year' => :'start_year',
         :'primary_completion_date' => :'primary_completion_date',
-        :'completion_date' => :'completion_date',
-        :'overall_status' => :'overall_status',
-        :'sites' => :'sites'
+        :'enrollment' => :'enrollment',
+        :'were_results_reported' => :'were_results_reported',
+        :'conditions' => :'conditions',
+        :'interventions' => :'interventions'
       }
     end
 
@@ -58,20 +119,54 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'kind' => :'String',
-        :'as_of' => :'String',
-        :'enrollment' => :'ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInnerEnrollment',
-        :'start_date' => :'ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInnerStartDate',
-        :'primary_completion_date' => :'ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInnerStartDate',
-        :'completion_date' => :'ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInnerStartDate',
-        :'overall_status' => :'ApiV1TrialsHistoryRecordHistoryObservationsInnerOverallStatus',
-        :'sites' => :'ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInnerSites'
+        :'trial_id' => :'String',
+        :'sponsor_role' => :'String',
+        :'sponsor_name' => :'String',
+        :'sponsor_org_id' => :'String',
+        :'sponsor_company_id' => :'String',
+        :'sponsor_company_name' => :'String',
+        :'sponsor_group_id' => :'String',
+        :'sponsor_group_name' => :'String',
+        :'sponsor_agency_class' => :'String',
+        :'sponsor_resolution_method' => :'String',
+        :'trial_title' => :'String',
+        :'study_type' => :'String',
+        :'phase' => :'String',
+        :'overall_status' => :'String',
+        :'start_date' => :'Date',
+        :'start_year' => :'Integer',
+        :'primary_completion_date' => :'Date',
+        :'enrollment' => :'Integer',
+        :'were_results_reported' => :'Boolean',
+        :'conditions' => :'Array<String>',
+        :'interventions' => :'Array<String>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'trial_id',
+        :'sponsor_role',
+        :'sponsor_name',
+        :'sponsor_org_id',
+        :'sponsor_company_id',
+        :'sponsor_company_name',
+        :'sponsor_group_id',
+        :'sponsor_group_name',
+        :'sponsor_agency_class',
+        :'sponsor_resolution_method',
+        :'trial_title',
+        :'study_type',
+        :'phase',
+        :'overall_status',
+        :'start_date',
+        :'start_year',
+        :'primary_completion_date',
+        :'enrollment',
+        :'were_results_reported',
+        :'conditions',
+        :'interventions'
       ])
     end
 
@@ -79,200 +174,120 @@ 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::ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::SponsorTrialsRow` 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::ApiV1TrialsHistoryAndPredictionGet200ResponseRecordHistoryObservationsInner`. 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::SponsorTrialsRow`. 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?(:'kind')
-        self.kind = attributes[:'kind']
-      else
-        self.kind = nil
-      end
-
-      if attributes.key?(:'as_of')
-        self.as_of = attributes[:'as_of']
-      else
-        self.as_of = nil
+      if attributes.key?(:'trial_id')
+        self.trial_id = attributes[:'trial_id']
       end
 
-      if attributes.key?(:'enrollment')
-        self.enrollment = attributes[:'enrollment']
-      else
-        self.enrollment = nil
+      if attributes.key?(:'sponsor_role')
+        self.sponsor_role = attributes[:'sponsor_role']
       end
 
-      if attributes.key?(:'start_date')
-        self.start_date = attributes[:'start_date']
-      else
-        self.start_date = nil
+      if attributes.key?(:'sponsor_name')
+        self.sponsor_name = attributes[:'sponsor_name']
       end
 
-      if attributes.key?(:'primary_completion_date')
-        self.primary_completion_date = attributes[:'primary_completion_date']
-      else
-        self.primary_completion_date = nil
+      if attributes.key?(:'sponsor_org_id')
+        self.sponsor_org_id = attributes[:'sponsor_org_id']
       end
 
-      if attributes.key?(:'completion_date')
-        self.completion_date = attributes[:'completion_date']
-      else
-        self.completion_date = nil
+      if attributes.key?(:'sponsor_company_id')
+        self.sponsor_company_id = attributes[:'sponsor_company_id']
       end
 
-      if attributes.key?(:'overall_status')
-        self.overall_status = attributes[:'overall_status']
-      else
-        self.overall_status = nil
+      if attributes.key?(:'sponsor_company_name')
+        self.sponsor_company_name = attributes[:'sponsor_company_name']
       end
 
-      if attributes.key?(:'sites')
-        self.sites = attributes[:'sites']
-      else
-        self.sites = nil
+      if attributes.key?(:'sponsor_group_id')
+        self.sponsor_group_id = attributes[:'sponsor_group_id']
       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 @kind.nil?
-        invalid_properties.push('invalid value for "kind", kind cannot be nil.')
+      if attributes.key?(:'sponsor_group_name')
+        self.sponsor_group_name = attributes[:'sponsor_group_name']
       end
 
-      if @as_of.nil?
-        invalid_properties.push('invalid value for "as_of", as_of cannot be nil.')
+      if attributes.key?(:'sponsor_agency_class')
+        self.sponsor_agency_class = attributes[:'sponsor_agency_class']
       end
 
-      if @enrollment.nil?
-        invalid_properties.push('invalid value for "enrollment", enrollment cannot be nil.')
+      if attributes.key?(:'sponsor_resolution_method')
+        self.sponsor_resolution_method = attributes[:'sponsor_resolution_method']
       end
 
-      if @start_date.nil?
-        invalid_properties.push('invalid value for "start_date", start_date cannot be nil.')
+      if attributes.key?(:'trial_title')
+        self.trial_title = attributes[:'trial_title']
       end
 
-      if @primary_completion_date.nil?
-        invalid_properties.push('invalid value for "primary_completion_date", primary_completion_date cannot be nil.')
+      if attributes.key?(:'study_type')
+        self.study_type = attributes[:'study_type']
       end
 
-      if @completion_date.nil?
-        invalid_properties.push('invalid value for "completion_date", completion_date cannot be nil.')
+      if attributes.key?(:'phase')
+        self.phase = attributes[:'phase']
       end
 
-      if @overall_status.nil?
-        invalid_properties.push('invalid value for "overall_status", overall_status cannot be nil.')
+      if attributes.key?(:'overall_status')
+        self.overall_status = attributes[:'overall_status']
       end
 
-      if @sites.nil?
-        invalid_properties.push('invalid value for "sites", sites cannot be nil.')
+      if attributes.key?(:'start_date')
+        self.start_date = attributes[:'start_date']
       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 @kind.nil?
-      return false if @as_of.nil?
-      return false if @enrollment.nil?
-      return false if @start_date.nil?
-      return false if @primary_completion_date.nil?
-      return false if @completion_date.nil?
-      return false if @overall_status.nil?
-      return false if @sites.nil?
-      true
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] kind Value to be assigned
-    def kind=(kind)
-      if kind.nil?
-        fail ArgumentError, 'kind cannot be nil'
+      if attributes.key?(:'start_year')
+        self.start_year = attributes[:'start_year']
       end
 
-      @kind = kind
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] as_of Value to be assigned
-    def as_of=(as_of)
-      if as_of.nil?
-        fail ArgumentError, 'as_of cannot be nil'
+      if attributes.key?(:'primary_completion_date')
+        self.primary_completion_date = attributes[:'primary_completion_date']
       end
 
-      @as_of = as_of
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] enrollment Value to be assigned
-    def enrollment=(enrollment)
-      if enrollment.nil?
-        fail ArgumentError, 'enrollment cannot be nil'
+      if attributes.key?(:'enrollment')
+        self.enrollment = attributes[:'enrollment']
       end
 
-      @enrollment = enrollment
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] start_date Value to be assigned
-    def start_date=(start_date)
-      if start_date.nil?
-        fail ArgumentError, 'start_date cannot be nil'
+      if attributes.key?(:'were_results_reported')
+        self.were_results_reported = attributes[:'were_results_reported']
       end
 
-      @start_date = start_date
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] primary_completion_date Value to be assigned
-    def primary_completion_date=(primary_completion_date)
-      if primary_completion_date.nil?
-        fail ArgumentError, 'primary_completion_date cannot be nil'
+      if attributes.key?(:'conditions')
+        if (value = attributes[:'conditions']).is_a?(Array)
+          self.conditions = value
+        end
       end
 
-      @primary_completion_date = primary_completion_date
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] completion_date Value to be assigned
-    def completion_date=(completion_date)
-      if completion_date.nil?
-        fail ArgumentError, 'completion_date cannot be nil'
+      if attributes.key?(:'interventions')
+        if (value = attributes[:'interventions']).is_a?(Array)
+          self.interventions = value
+        end
       end
-
-      @completion_date = completion_date
     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'
-      end
-
-      @overall_status = overall_status
+    # 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
 
-    # Custom attribute writer method with validation
-    # @param [Object] sites Value to be assigned
-    def sites=(sites)
-      if sites.nil?
-        fail ArgumentError, 'sites cannot be nil'
-      end
-
-      @sites = sites
+    # 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.
@@ -280,14 +295,27 @@ module PharmaObservatory
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          kind == o.kind &&
-          as_of == o.as_of &&
-          enrollment == o.enrollment &&
+          trial_id == o.trial_id &&
+          sponsor_role == o.sponsor_role &&
+          sponsor_name == o.sponsor_name &&
+          sponsor_org_id == o.sponsor_org_id &&
+          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 &&
+          sponsor_agency_class == o.sponsor_agency_class &&
+          sponsor_resolution_method == o.sponsor_resolution_method &&
+          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 &&
           primary_completion_date == o.primary_completion_date &&
-          completion_date == o.completion_date &&
-          overall_status == o.overall_status &&
-          sites == o.sites
+          enrollment == o.enrollment &&
+          were_results_reported == o.were_results_reported &&
+          conditions == o.conditions &&
+          interventions == o.interventions
     end
 
     # @see the `==` method
@@ -299,7 +327,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [kind, as_of, enrollment, start_date, primary_completion_date, completion_date, overall_status, sites].hash
+      [trial_id, sponsor_role, sponsor_name, sponsor_org_id, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, sponsor_agency_class, sponsor_resolution_method, trial_title, study_type, phase, overall_status, start_date, start_year, primary_completion_date, enrollment, were_results_reported, conditions, interventions].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.13.0
 =end
 
 module PharmaObservatory
-  VERSION = '0.1.1'
+  VERSION = '0.1.3'
 end