pharmaobservatory 0.1.1 → 0.1.3

data/lib/pharmaobservatory/models/{api_v1_rwd_study_screen_get200_response_delivery_distribution.rb → biomarker_variant_mentions_row.rb}

@@ -14,37 +14,67 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class ApiV1RwdStudyScreenGet200ResponseDeliveryDistribution
-    attr_accessor :pairs
+  # One row of the biomarker_variant_mentions dataset: one row per protein variant biomarker with literature mentions. A grouped request returns the group columns and the measures instead, as additional properties.
+  class BiomarkerVariantMentionsRow
+    # The route key of the gene the variants belong to, the entry key for the biomarkers object type.
+    attr_accessor :route_key
 
-    attr_accessor :backfilled
+    # The gene symbol.
+    attr_accessor :gene_symbol
 
-    attr_accessor :comparable
+    # The variant's own biomarker key.
+    attr_accessor :variant_biomarker_id
 
-    attr_accessor :median
+    # The variant's own route key (the id its web page uses).
+    attr_accessor :variant_route_key
 
-    attr_accessor :p25
+    # The variant's display name.
+    attr_accessor :display_name
 
-    attr_accessor :p75
+    # The protein change, for example V600E.
+    attr_accessor :amino_acid_change
 
-    attr_accessor :late30
+    # The kind of biomarker the row describes (a protein variant).
+    attr_accessor :biomarker_kind
 
-    attr_accessor :floor
+    # The evidence type (a literature mention, never an actionability claim).
+    attr_accessor :evidence_type
 
-    attr_accessor :suppressed
+    # The source of the evidence.
+    attr_accessor :source
+
+    # Distinct papers that name the variant.
+    attr_accessor :n_papers
+
+    # Earliest publication year.
+    attr_accessor :first_publication_year
+
+    # Latest publication year.
+    attr_accessor :last_publication_year
+
+    # Up to five sample PubMed ids, newest first.
+    attr_accessor :sample_pmids
+
+    # Up to five sample citations, newest first.
+    attr_accessor :sample_citations
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'pairs' => :'pairs',
-        :'backfilled' => :'backfilled',
-        :'comparable' => :'comparable',
-        :'median' => :'median',
-        :'p25' => :'p25',
-        :'p75' => :'p75',
-        :'late30' => :'late30',
-        :'floor' => :'floor',
-        :'suppressed' => :'suppressed'
+        :'route_key' => :'route_key',
+        :'gene_symbol' => :'gene_symbol',
+        :'variant_biomarker_id' => :'variant_biomarker_id',
+        :'variant_route_key' => :'variant_route_key',
+        :'display_name' => :'display_name',
+        :'amino_acid_change' => :'amino_acid_change',
+        :'biomarker_kind' => :'biomarker_kind',
+        :'evidence_type' => :'evidence_type',
+        :'source' => :'source',
+        :'n_papers' => :'n_papers',
+        :'first_publication_year' => :'first_publication_year',
+        :'last_publication_year' => :'last_publication_year',
+        :'sample_pmids' => :'sample_pmids',
+        :'sample_citations' => :'sample_citations'
       }
     end
 
@@ -61,24 +91,40 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'pairs' => :'Integer',
-        :'backfilled' => :'Integer',
-        :'comparable' => :'Integer',
-        :'median' => :'Float',
-        :'p25' => :'Float',
-        :'p75' => :'Float',
-        :'late30' => :'Integer',
-        :'floor' => :'Integer',
-        :'suppressed' => :'Boolean'
+        :'route_key' => :'String',
+        :'gene_symbol' => :'String',
+        :'variant_biomarker_id' => :'String',
+        :'variant_route_key' => :'String',
+        :'display_name' => :'String',
+        :'amino_acid_change' => :'String',
+        :'biomarker_kind' => :'String',
+        :'evidence_type' => :'String',
+        :'source' => :'String',
+        :'n_papers' => :'Integer',
+        :'first_publication_year' => :'Integer',
+        :'last_publication_year' => :'Integer',
+        :'sample_pmids' => :'Array<String>',
+        :'sample_citations' => :'Array<String>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'median',
-        :'p25',
-        :'p75',
+        :'route_key',
+        :'gene_symbol',
+        :'variant_biomarker_id',
+        :'variant_route_key',
+        :'display_name',
+        :'amino_acid_change',
+        :'biomarker_kind',
+        :'evidence_type',
+        :'source',
+        :'n_papers',
+        :'first_publication_year',
+        :'last_publication_year',
+        :'sample_pmids',
+        :'sample_citations'
       ])
     end
 
@@ -86,102 +132,84 @@ 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::ApiV1RwdStudyScreenGet200ResponseDeliveryDistribution` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::BiomarkerVariantMentionsRow` 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::ApiV1RwdStudyScreenGet200ResponseDeliveryDistribution`. 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::BiomarkerVariantMentionsRow`. 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?(:'pairs')
-        self.pairs = attributes[:'pairs']
-      else
-        self.pairs = nil
+      if attributes.key?(:'route_key')
+        self.route_key = attributes[:'route_key']
       end
 
-      if attributes.key?(:'backfilled')
-        self.backfilled = attributes[:'backfilled']
-      else
-        self.backfilled = nil
+      if attributes.key?(:'gene_symbol')
+        self.gene_symbol = attributes[:'gene_symbol']
       end
 
-      if attributes.key?(:'comparable')
-        self.comparable = attributes[:'comparable']
-      else
-        self.comparable = nil
+      if attributes.key?(:'variant_biomarker_id')
+        self.variant_biomarker_id = attributes[:'variant_biomarker_id']
       end
 
-      if attributes.key?(:'median')
-        self.median = attributes[:'median']
-      else
-        self.median = nil
+      if attributes.key?(:'variant_route_key')
+        self.variant_route_key = attributes[:'variant_route_key']
       end
 
-      if attributes.key?(:'p25')
-        self.p25 = attributes[:'p25']
-      else
-        self.p25 = nil
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
       end
 
-      if attributes.key?(:'p75')
-        self.p75 = attributes[:'p75']
-      else
-        self.p75 = nil
+      if attributes.key?(:'amino_acid_change')
+        self.amino_acid_change = attributes[:'amino_acid_change']
       end
 
-      if attributes.key?(:'late30')
-        self.late30 = attributes[:'late30']
-      else
-        self.late30 = nil
+      if attributes.key?(:'biomarker_kind')
+        self.biomarker_kind = attributes[:'biomarker_kind']
       end
 
-      if attributes.key?(:'floor')
-        self.floor = attributes[:'floor']
-      else
-        self.floor = nil
+      if attributes.key?(:'evidence_type')
+        self.evidence_type = attributes[:'evidence_type']
       end
 
-      if attributes.key?(:'suppressed')
-        self.suppressed = attributes[:'suppressed']
-      else
-        self.suppressed = nil
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
       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 @pairs.nil?
-        invalid_properties.push('invalid value for "pairs", pairs cannot be nil.')
+      if attributes.key?(:'n_papers')
+        self.n_papers = attributes[:'n_papers']
       end
 
-      if @backfilled.nil?
-        invalid_properties.push('invalid value for "backfilled", backfilled cannot be nil.')
+      if attributes.key?(:'first_publication_year')
+        self.first_publication_year = attributes[:'first_publication_year']
       end
 
-      if @comparable.nil?
-        invalid_properties.push('invalid value for "comparable", comparable cannot be nil.')
+      if attributes.key?(:'last_publication_year')
+        self.last_publication_year = attributes[:'last_publication_year']
       end
 
-      if @late30.nil?
-        invalid_properties.push('invalid value for "late30", late30 cannot be nil.')
-      end
-
-      if @floor.nil?
-        invalid_properties.push('invalid value for "floor", floor cannot be nil.')
+      if attributes.key?(:'sample_pmids')
+        if (value = attributes[:'sample_pmids']).is_a?(Array)
+          self.sample_pmids = value
+        end
       end
 
-      if @suppressed.nil?
-        invalid_properties.push('invalid value for "suppressed", suppressed cannot be nil.')
+      if attributes.key?(:'sample_citations')
+        if (value = attributes[:'sample_citations']).is_a?(Array)
+          self.sample_citations = 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
       invalid_properties
     end
 
@@ -189,89 +217,28 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @pairs.nil?
-      return false if @backfilled.nil?
-      return false if @comparable.nil?
-      return false if @late30.nil?
-      return false if @floor.nil?
-      return false if @suppressed.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] pairs Value to be assigned
-    def pairs=(pairs)
-      if pairs.nil?
-        fail ArgumentError, 'pairs cannot be nil'
-      end
-
-      @pairs = pairs
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] backfilled Value to be assigned
-    def backfilled=(backfilled)
-      if backfilled.nil?
-        fail ArgumentError, 'backfilled cannot be nil'
-      end
-
-      @backfilled = backfilled
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] comparable Value to be assigned
-    def comparable=(comparable)
-      if comparable.nil?
-        fail ArgumentError, 'comparable cannot be nil'
-      end
-
-      @comparable = comparable
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] late30 Value to be assigned
-    def late30=(late30)
-      if late30.nil?
-        fail ArgumentError, 'late30 cannot be nil'
-      end
-
-      @late30 = late30
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] floor Value to be assigned
-    def floor=(floor)
-      if floor.nil?
-        fail ArgumentError, 'floor cannot be nil'
-      end
-
-      @floor = floor
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] suppressed Value to be assigned
-    def suppressed=(suppressed)
-      if suppressed.nil?
-        fail ArgumentError, 'suppressed cannot be nil'
-      end
-
-      @suppressed = suppressed
-    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 &&
-          pairs == o.pairs &&
-          backfilled == o.backfilled &&
-          comparable == o.comparable &&
-          median == o.median &&
-          p25 == o.p25 &&
-          p75 == o.p75 &&
-          late30 == o.late30 &&
-          floor == o.floor &&
-          suppressed == o.suppressed
+          route_key == o.route_key &&
+          gene_symbol == o.gene_symbol &&
+          variant_biomarker_id == o.variant_biomarker_id &&
+          variant_route_key == o.variant_route_key &&
+          display_name == o.display_name &&
+          amino_acid_change == o.amino_acid_change &&
+          biomarker_kind == o.biomarker_kind &&
+          evidence_type == o.evidence_type &&
+          source == o.source &&
+          n_papers == o.n_papers &&
+          first_publication_year == o.first_publication_year &&
+          last_publication_year == o.last_publication_year &&
+          sample_pmids == o.sample_pmids &&
+          sample_citations == o.sample_citations
     end
 
     # @see the `==` method
@@ -283,7 +250,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pairs, backfilled, comparable, median, p25, p75, late30, floor, suppressed].hash
+      [route_key, gene_symbol, variant_biomarker_id, variant_route_key, display_name, amino_acid_change, biomarker_kind, evidence_type, source, n_papers, first_publication_year, last_publication_year, sample_pmids, sample_citations].hash
     end
 
     # Builds the object from hash