pharmaobservatory 0.1.2 → 0.1.3

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

@@ -14,28 +14,67 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class BiomarkersVariantMentions200ResponseRowsInner
-    attr_accessor :biomarker_id
+  # 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
 
+    # The gene symbol.
+    attr_accessor :gene_symbol
+
+    # The variant's own biomarker key.
+    attr_accessor :variant_biomarker_id
+
+    # The variant's own route key (the id its web page uses).
+    attr_accessor :variant_route_key
+
+    # The variant's display name.
+    attr_accessor :display_name
+
+    # The protein change, for example V600E.
     attr_accessor :amino_acid_change
 
+    # The kind of biomarker the row describes (a protein variant).
+    attr_accessor :biomarker_kind
+
+    # The evidence type (a literature mention, never an actionability claim).
+    attr_accessor :evidence_type
+
+    # 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
       {
-        :'biomarker_id' => :'biomarker_id',
+        :'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_pmids' => :'sample_pmids',
+        :'sample_citations' => :'sample_citations'
       }
     end
 
@@ -52,18 +91,40 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'biomarker_id' => :'String',
+        :'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_pmids' => :'Array<String>',
+        :'sample_citations' => :'Array<String>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'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
 
@@ -71,54 +132,76 @@ 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::BiomarkersVariantMentions200ResponseRowsInner` 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::BiomarkersVariantMentions200ResponseRowsInner`. 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?(:'biomarker_id')
-        self.biomarker_id = attributes[:'biomarker_id']
-      else
-        self.biomarker_id = nil
+      if attributes.key?(:'route_key')
+        self.route_key = attributes[:'route_key']
+      end
+
+      if attributes.key?(:'gene_symbol')
+        self.gene_symbol = attributes[:'gene_symbol']
+      end
+
+      if attributes.key?(:'variant_biomarker_id')
+        self.variant_biomarker_id = attributes[:'variant_biomarker_id']
+      end
+
+      if attributes.key?(:'variant_route_key')
+        self.variant_route_key = attributes[:'variant_route_key']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
       end
 
       if attributes.key?(:'amino_acid_change')
         self.amino_acid_change = attributes[:'amino_acid_change']
-      else
-        self.amino_acid_change = nil
+      end
+
+      if attributes.key?(:'biomarker_kind')
+        self.biomarker_kind = attributes[:'biomarker_kind']
+      end
+
+      if attributes.key?(:'evidence_type')
+        self.evidence_type = attributes[:'evidence_type']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
       end
 
       if attributes.key?(:'n_papers')
         self.n_papers = attributes[:'n_papers']
-      else
-        self.n_papers = nil
       end
 
       if attributes.key?(:'first_publication_year')
         self.first_publication_year = attributes[:'first_publication_year']
-      else
-        self.first_publication_year = nil
       end
 
       if attributes.key?(:'last_publication_year')
         self.last_publication_year = attributes[:'last_publication_year']
-      else
-        self.last_publication_year = nil
       end
 
       if attributes.key?(:'sample_pmids')
         if (value = attributes[:'sample_pmids']).is_a?(Array)
           self.sample_pmids = value
         end
-      else
-        self.sample_pmids = nil
+      end
+
+      if attributes.key?(:'sample_citations')
+        if (value = attributes[:'sample_citations']).is_a?(Array)
+          self.sample_citations = value
+        end
       end
     end
 
@@ -127,30 +210,6 @@ module PharmaObservatory
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @biomarker_id.nil?
-        invalid_properties.push('invalid value for "biomarker_id", biomarker_id cannot be nil.')
-      end
-
-      if @amino_acid_change.nil?
-        invalid_properties.push('invalid value for "amino_acid_change", amino_acid_change cannot be nil.')
-      end
-
-      if @n_papers.nil?
-        invalid_properties.push('invalid value for "n_papers", n_papers cannot be nil.')
-      end
-
-      if @first_publication_year.nil?
-        invalid_properties.push('invalid value for "first_publication_year", first_publication_year cannot be nil.')
-      end
-
-      if @last_publication_year.nil?
-        invalid_properties.push('invalid value for "last_publication_year", last_publication_year cannot be nil.')
-      end
-
-      if @sample_pmids.nil?
-        invalid_properties.push('invalid value for "sample_pmids", sample_pmids cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -158,86 +217,28 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @biomarker_id.nil?
-      return false if @amino_acid_change.nil?
-      return false if @n_papers.nil?
-      return false if @first_publication_year.nil?
-      return false if @last_publication_year.nil?
-      return false if @sample_pmids.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] biomarker_id Value to be assigned
-    def biomarker_id=(biomarker_id)
-      if biomarker_id.nil?
-        fail ArgumentError, 'biomarker_id cannot be nil'
-      end
-
-      @biomarker_id = biomarker_id
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] amino_acid_change Value to be assigned
-    def amino_acid_change=(amino_acid_change)
-      if amino_acid_change.nil?
-        fail ArgumentError, 'amino_acid_change cannot be nil'
-      end
-
-      @amino_acid_change = amino_acid_change
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] n_papers Value to be assigned
-    def n_papers=(n_papers)
-      if n_papers.nil?
-        fail ArgumentError, 'n_papers cannot be nil'
-      end
-
-      @n_papers = n_papers
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] first_publication_year Value to be assigned
-    def first_publication_year=(first_publication_year)
-      if first_publication_year.nil?
-        fail ArgumentError, 'first_publication_year cannot be nil'
-      end
-
-      @first_publication_year = first_publication_year
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] last_publication_year Value to be assigned
-    def last_publication_year=(last_publication_year)
-      if last_publication_year.nil?
-        fail ArgumentError, 'last_publication_year cannot be nil'
-      end
-
-      @last_publication_year = last_publication_year
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] sample_pmids Value to be assigned
-    def sample_pmids=(sample_pmids)
-      if sample_pmids.nil?
-        fail ArgumentError, 'sample_pmids cannot be nil'
-      end
-
-      @sample_pmids = sample_pmids
-    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 &&
-          biomarker_id == o.biomarker_id &&
+          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_pmids == o.sample_pmids &&
+          sample_citations == o.sample_citations
     end
 
     # @see the `==` method
@@ -249,7 +250,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [biomarker_id, amino_acid_change, n_papers, first_publication_year, last_publication_year, sample_pmids].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