pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{orgs_org_type_tally200_response.rb → site_trial_conditions_response.rb}

@@ -14,46 +14,74 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class OrgsOrgTypeTally200Response
-    attr_accessor :page
+  class SiteTrialConditionsResponse
+    attr_accessor :dataset
+
+    attr_accessor :grain
+
+    attr_accessor :object_type
 
     attr_accessor :id
 
-    attr_accessor :section
+    attr_accessor :scope
 
-    attr_accessor :heading
+    attr_accessor :columns
 
-    attr_accessor :lens
+    attr_accessor :rows
 
-    attr_accessor :web_url
+    # The exact count of the filtered rows on an ungrouped read, carried by the cursor; null when grouped.
+    attr_accessor :total
 
-    attr_accessor :shape
+    attr_accessor :next_cursor
 
-    attr_accessor :columns
+    attr_accessor :sort
 
-    attr_accessor :rows
+    attr_accessor :filters
+
+    attr_accessor :group_by
+
+    attr_accessor :measures
 
     attr_accessor :attribution
 
-    attr_accessor :context
+    attr_accessor :source_credit
+
+    attr_accessor :withheld_tiers
+
+    attr_accessor :withheld_columns
+
+    attr_accessor :freshness
+
+    attr_accessor :build
 
     attr_accessor :build_state
 
+    attr_accessor :restriction
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'page' => :'page',
+        :'dataset' => :'dataset',
+        :'grain' => :'grain',
+        :'object_type' => :'object_type',
         :'id' => :'id',
-        :'section' => :'section',
-        :'heading' => :'heading',
-        :'lens' => :'lens',
-        :'web_url' => :'web_url',
-        :'shape' => :'shape',
+        :'scope' => :'scope',
         :'columns' => :'columns',
         :'rows' => :'rows',
+        :'total' => :'total',
+        :'next_cursor' => :'next_cursor',
+        :'sort' => :'sort',
+        :'filters' => :'filters',
+        :'group_by' => :'group_by',
+        :'measures' => :'measures',
         :'attribution' => :'attribution',
-        :'context' => :'context',
-        :'build_state' => :'build_state'
+        :'source_credit' => :'source_credit',
+        :'withheld_tiers' => :'withheld_tiers',
+        :'withheld_columns' => :'withheld_columns',
+        :'freshness' => :'freshness',
+        :'build' => :'build',
+        :'build_state' => :'build_state',
+        :'restriction' => :'restriction'
       }
     end
 
@@ -70,26 +98,39 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'page' => :'String',
-        :'id' => :'Object',
-        :'section' => :'String',
-        :'heading' => :'String',
-        :'lens' => :'Object',
-        :'web_url' => :'String',
-        :'shape' => :'BiomarkersList200ResponseShape',
-        :'columns' => :'Array<BiomarkersList200ResponseColumnsInner>',
-        :'rows' => :'Array<OrgsOrgTypeTally200ResponseRowsInner>',
-        :'attribution' => :'Array<Object>',
-        :'context' => :'OrgsOrgTypeTally200ResponseContext',
-        :'build_state' => :'BiomarkersList200ResponseBuildState'
+        :'dataset' => :'String',
+        :'grain' => :'String',
+        :'object_type' => :'String',
+        :'id' => :'String',
+        :'scope' => :'BiomarkerCdxAssertionsResponseScope',
+        :'columns' => :'Array<DatasetColumn>',
+        :'rows' => :'Array<SiteTrialConditionsRow>',
+        :'total' => :'Integer',
+        :'next_cursor' => :'String',
+        :'sort' => :'Array<String>',
+        :'filters' => :'Array<Hash<String, Object>>',
+        :'group_by' => :'Array<String>',
+        :'measures' => :'Array<String>',
+        :'attribution' => :'Array<DatasetAttribution>',
+        :'source_credit' => :'String',
+        :'withheld_tiers' => :'Array<String>',
+        :'withheld_columns' => :'Array<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([
+        :'object_type',
         :'id',
-        :'lens',
+        :'scope',
+        :'total',
+        :'next_cursor',
+        :'restriction'
       ])
     end
 
@@ -97,58 +138,38 @@ 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::OrgsOrgTypeTally200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::SiteTrialConditionsResponse` 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::OrgsOrgTypeTally200Response`. 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::SiteTrialConditionsResponse`. 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?(:'page')
-        self.page = attributes[:'page']
+      if attributes.key?(:'dataset')
+        self.dataset = attributes[:'dataset']
       else
-        self.page = nil
+        self.dataset = nil
       end
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      else
-        self.id = nil
+      if attributes.key?(:'grain')
+        self.grain = attributes[:'grain']
       end
 
-      if attributes.key?(:'section')
-        self.section = attributes[:'section']
-      else
-        self.section = nil
+      if attributes.key?(:'object_type')
+        self.object_type = attributes[:'object_type']
       end
 
-      if attributes.key?(:'heading')
-        self.heading = attributes[:'heading']
-      else
-        self.heading = nil
-      end
-
-      if attributes.key?(:'lens')
-        self.lens = attributes[:'lens']
-      else
-        self.lens = nil
-      end
-
-      if attributes.key?(:'web_url')
-        self.web_url = attributes[:'web_url']
-      else
-        self.web_url = nil
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
       end
 
-      if attributes.key?(:'shape')
-        self.shape = attributes[:'shape']
-      else
-        self.shape = nil
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
       end
 
       if attributes.key?(:'columns')
@@ -167,50 +188,86 @@ module PharmaObservatory
         self.rows = nil
       end
 
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end
+
+      if attributes.key?(:'sort')
+        if (value = attributes[:'sort']).is_a?(Array)
+          self.sort = value
+        end
+      end
+
+      if attributes.key?(:'filters')
+        if (value = attributes[:'filters']).is_a?(Array)
+          self.filters = value
+        end
+      end
+
+      if attributes.key?(:'group_by')
+        if (value = attributes[:'group_by']).is_a?(Array)
+          self.group_by = value
+        end
+      end
+
+      if attributes.key?(:'measures')
+        if (value = attributes[:'measures']).is_a?(Array)
+          self.measures = value
+        end
+      end
+
       if attributes.key?(:'attribution')
         if (value = attributes[:'attribution']).is_a?(Array)
           self.attribution = value
         end
-      else
-        self.attribution = nil
       end
 
-      if attributes.key?(:'context')
-        self.context = attributes[:'context']
-      else
-        self.context = nil
+      if attributes.key?(:'source_credit')
+        self.source_credit = attributes[:'source_credit']
       end
 
-      if attributes.key?(:'build_state')
-        self.build_state = attributes[:'build_state']
-      else
-        self.build_state = nil
+      if attributes.key?(:'withheld_tiers')
+        if (value = attributes[:'withheld_tiers']).is_a?(Array)
+          self.withheld_tiers = value
+        end
       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 @page.nil?
-        invalid_properties.push('invalid value for "page", page cannot be nil.')
+      if attributes.key?(:'withheld_columns')
+        if (value = attributes[:'withheld_columns']).is_a?(Array)
+          self.withheld_columns = value
+        end
       end
 
-      if @section.nil?
-        invalid_properties.push('invalid value for "section", section cannot be nil.')
+      if attributes.key?(:'freshness')
+        self.freshness = attributes[:'freshness']
       end
 
-      if @heading.nil?
-        invalid_properties.push('invalid value for "heading", heading cannot be nil.')
+      if attributes.key?(:'build')
+        self.build = attributes[:'build']
       end
 
-      if @web_url.nil?
-        invalid_properties.push('invalid value for "web_url", web_url cannot be nil.')
+      if attributes.key?(:'build_state')
+        self.build_state = attributes[:'build_state']
+      end
+
+      if attributes.key?(:'restriction')
+        if (value = attributes[:'restriction']).is_a?(Hash)
+          self.restriction = value
+        end
       end
+    end
 
-      if @shape.nil?
-        invalid_properties.push('invalid value for "shape", shape cannot be nil.')
+    # 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 @dataset.nil?
+        invalid_properties.push('invalid value for "dataset", dataset cannot be nil.')
       end
 
       if @columns.nil?
@@ -221,18 +278,6 @@ module PharmaObservatory
         invalid_properties.push('invalid value for "rows", rows cannot be nil.')
       end
 
-      if @attribution.nil?
-        invalid_properties.push('invalid value for "attribution", attribution cannot be nil.')
-      end
-
-      if @context.nil?
-        invalid_properties.push('invalid value for "context", context cannot be nil.')
-      end
-
-      if @build_state.nil?
-        invalid_properties.push('invalid value for "build_state", build_state cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -240,67 +285,20 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @page.nil?
-      return false if @section.nil?
-      return false if @heading.nil?
-      return false if @web_url.nil?
-      return false if @shape.nil?
+      return false if @dataset.nil?
       return false if @columns.nil?
       return false if @rows.nil?
-      return false if @attribution.nil?
-      return false if @context.nil?
-      return false if @build_state.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] page Value to be assigned
-    def page=(page)
-      if page.nil?
-        fail ArgumentError, 'page cannot be nil'
-      end
-
-      @page = page
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] section Value to be assigned
-    def section=(section)
-      if section.nil?
-        fail ArgumentError, 'section cannot be nil'
-      end
-
-      @section = section
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] heading Value to be assigned
-    def heading=(heading)
-      if heading.nil?
-        fail ArgumentError, 'heading cannot be nil'
-      end
-
-      @heading = heading
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] web_url Value to be assigned
-    def web_url=(web_url)
-      if web_url.nil?
-        fail ArgumentError, 'web_url cannot be nil'
+    # @param [Object] dataset Value to be assigned
+    def dataset=(dataset)
+      if dataset.nil?
+        fail ArgumentError, 'dataset cannot be nil'
       end
 
-      @web_url = web_url
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] shape Value to be assigned
-    def shape=(shape)
-      if shape.nil?
-        fail ArgumentError, 'shape cannot be nil'
-      end
-
-      @shape = shape
+      @dataset = dataset
     end
 
     # Custom attribute writer method with validation
@@ -323,53 +321,32 @@ module PharmaObservatory
       @rows = rows
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] attribution Value to be assigned
-    def attribution=(attribution)
-      if attribution.nil?
-        fail ArgumentError, 'attribution cannot be nil'
-      end
-
-      @attribution = attribution
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] context Value to be assigned
-    def context=(context)
-      if context.nil?
-        fail ArgumentError, 'context cannot be nil'
-      end
-
-      @context = context
-    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'
-      end
-
-      @build_state = build_state
-    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 &&
-          page == o.page &&
+          dataset == o.dataset &&
+          grain == o.grain &&
+          object_type == o.object_type &&
           id == o.id &&
-          section == o.section &&
-          heading == o.heading &&
-          lens == o.lens &&
-          web_url == o.web_url &&
-          shape == o.shape &&
+          scope == o.scope &&
           columns == o.columns &&
           rows == o.rows &&
+          total == o.total &&
+          next_cursor == o.next_cursor &&
+          sort == o.sort &&
+          filters == o.filters &&
+          group_by == o.group_by &&
+          measures == o.measures &&
           attribution == o.attribution &&
-          context == o.context &&
-          build_state == o.build_state
+          source_credit == o.source_credit &&
+          withheld_tiers == o.withheld_tiers &&
+          withheld_columns == o.withheld_columns &&
+          freshness == o.freshness &&
+          build == o.build &&
+          build_state == o.build_state &&
+          restriction == o.restriction
     end
 
     # @see the `==` method
@@ -381,7 +358,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [page, id, section, heading, lens, web_url, shape, columns, rows, attribution, context, build_state].hash
+      [dataset, grain, object_type, id, scope, columns, rows, total, next_cursor, sort, filters, group_by, measures, attribution, source_credit, withheld_tiers, withheld_columns, freshness, build, build_state, restriction].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/{biomarkers_sample_screening200_response_context_coverage_counts.rb → site_trial_conditions_row.rb}

@@ -14,16 +14,35 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class BiomarkersSampleScreening200ResponseContextCoverageCounts
-    attr_accessor :resolved_single_ssm
+  # One row of the site_trial_conditions dataset: one row per site, trial and condition. A grouped request returns the group columns and the measures instead, as additional properties.
+  class SiteTrialConditionsRow
+    # The site key: one facility spelling from the registry.
+    attr_accessor :site_id
 
-    attr_accessor :multiple_exact_ssms
+    # The trial's registry id (NCT number).
+    attr_accessor :trial_id
+
+    # The condition key (a MeSH, Medical Subject Headings, descriptor id).
+    attr_accessor :condition_id
+
+    # The condition's name.
+    attr_accessor :condition_name
+
+    # The registry's overall status of the trial.
+    attr_accessor :overall_status
+
+    # Year of the trial start.
+    attr_accessor :start_year
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'resolved_single_ssm' => :'resolved_single_ssm',
-        :'multiple_exact_ssms' => :'multiple_exact_ssms'
+        :'site_id' => :'site_id',
+        :'trial_id' => :'trial_id',
+        :'condition_id' => :'condition_id',
+        :'condition_name' => :'condition_name',
+        :'overall_status' => :'overall_status',
+        :'start_year' => :'start_year'
       }
     end
 
@@ -40,14 +59,24 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'resolved_single_ssm' => :'Integer',
-        :'multiple_exact_ssms' => :'Integer'
+        :'site_id' => :'String',
+        :'trial_id' => :'String',
+        :'condition_id' => :'String',
+        :'condition_name' => :'String',
+        :'overall_status' => :'String',
+        :'start_year' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'site_id',
+        :'trial_id',
+        :'condition_id',
+        :'condition_name',
+        :'overall_status',
+        :'start_year'
       ])
     end
 
@@ -55,28 +84,40 @@ 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::BiomarkersSampleScreening200ResponseContextCoverageCounts` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::SiteTrialConditionsRow` 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::BiomarkersSampleScreening200ResponseContextCoverageCounts`. 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::SiteTrialConditionsRow`. 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?(:'resolved_single_ssm')
-        self.resolved_single_ssm = attributes[:'resolved_single_ssm']
-      else
-        self.resolved_single_ssm = nil
+      if attributes.key?(:'site_id')
+        self.site_id = attributes[:'site_id']
       end
 
-      if attributes.key?(:'multiple_exact_ssms')
-        self.multiple_exact_ssms = attributes[:'multiple_exact_ssms']
-      else
-        self.multiple_exact_ssms = nil
+      if attributes.key?(:'trial_id')
+        self.trial_id = attributes[:'trial_id']
+      end
+
+      if attributes.key?(:'condition_id')
+        self.condition_id = attributes[:'condition_id']
+      end
+
+      if attributes.key?(:'condition_name')
+        self.condition_name = attributes[:'condition_name']
+      end
+
+      if attributes.key?(:'overall_status')
+        self.overall_status = attributes[:'overall_status']
+      end
+
+      if attributes.key?(:'start_year')
+        self.start_year = attributes[:'start_year']
       end
     end
 
@@ -85,14 +126,6 @@ module PharmaObservatory
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @resolved_single_ssm.nil?
-        invalid_properties.push('invalid value for "resolved_single_ssm", resolved_single_ssm cannot be nil.')
-      end
-
-      if @multiple_exact_ssms.nil?
-        invalid_properties.push('invalid value for "multiple_exact_ssms", multiple_exact_ssms cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -100,38 +133,20 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @resolved_single_ssm.nil?
-      return false if @multiple_exact_ssms.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] resolved_single_ssm Value to be assigned
-    def resolved_single_ssm=(resolved_single_ssm)
-      if resolved_single_ssm.nil?
-        fail ArgumentError, 'resolved_single_ssm cannot be nil'
-      end
-
-      @resolved_single_ssm = resolved_single_ssm
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] multiple_exact_ssms Value to be assigned
-    def multiple_exact_ssms=(multiple_exact_ssms)
-      if multiple_exact_ssms.nil?
-        fail ArgumentError, 'multiple_exact_ssms cannot be nil'
-      end
-
-      @multiple_exact_ssms = multiple_exact_ssms
-    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 &&
-          resolved_single_ssm == o.resolved_single_ssm &&
-          multiple_exact_ssms == o.multiple_exact_ssms
+          site_id == o.site_id &&
+          trial_id == o.trial_id &&
+          condition_id == o.condition_id &&
+          condition_name == o.condition_name &&
+          overall_status == o.overall_status &&
+          start_year == o.start_year
     end
 
     # @see the `==` method
@@ -143,7 +158,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [resolved_single_ssm, multiple_exact_ssms].hash
+      [site_id, trial_id, condition_id, condition_name, overall_status, start_year].hash
     end
 
     # Builds the object from hash