pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{biomarkers_literature200_response_rows_inner.rb → biomarker_literature_row.rb}

@@ -14,28 +14,55 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class BiomarkersLiterature200ResponseRowsInner
+  # One row of the biomarker_literature dataset: one row per gene and paper. A grouped request returns the group columns and the measures instead, as additional properties.
+  class BiomarkerLiteratureRow
+    # The route key of the gene the paper names, the entry key for the biomarkers object type.
+    attr_accessor :route_key
+
+    # The gene symbol.
+    attr_accessor :gene_symbol
+
+    # The PubMed id.
     attr_accessor :pmid
 
+    # The evidence type (a publication mention).
+    attr_accessor :evidence_type
+
+    # The paper's title.
     attr_accessor :title
 
+    # The journal's NLM id.
+    attr_accessor :journal_nlm_id
+
+    # The journal's title.
     attr_accessor :journal_title
 
+    # The publication year.
     attr_accessor :pub_year
 
+    # Citations, where iCite carries them (null is not measured, never zero).
     attr_accessor :citation_count
 
+    # The iCite relative citation ratio, where measured.
     attr_accessor :relative_citation_ratio
 
+    # The page's fixed order: newest year first, then citations.
+    attr_accessor :display_order
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'route_key' => :'route_key',
+        :'gene_symbol' => :'gene_symbol',
         :'pmid' => :'pmid',
+        :'evidence_type' => :'evidence_type',
         :'title' => :'title',
+        :'journal_nlm_id' => :'journal_nlm_id',
         :'journal_title' => :'journal_title',
         :'pub_year' => :'pub_year',
         :'citation_count' => :'citation_count',
-        :'relative_citation_ratio' => :'relative_citation_ratio'
+        :'relative_citation_ratio' => :'relative_citation_ratio',
+        :'display_order' => :'display_order'
       }
     end
 
@@ -52,18 +79,34 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'route_key' => :'String',
+        :'gene_symbol' => :'String',
         :'pmid' => :'String',
+        :'evidence_type' => :'String',
         :'title' => :'String',
+        :'journal_nlm_id' => :'String',
         :'journal_title' => :'String',
         :'pub_year' => :'Integer',
         :'citation_count' => :'Integer',
-        :'relative_citation_ratio' => :'Float'
+        :'relative_citation_ratio' => :'Float',
+        :'display_order' => :'Integer'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'route_key',
+        :'gene_symbol',
+        :'pmid',
+        :'evidence_type',
+        :'title',
+        :'journal_nlm_id',
+        :'journal_title',
+        :'pub_year',
+        :'citation_count',
+        :'relative_citation_ratio',
+        :'display_order'
       ])
     end
 
@@ -71,52 +114,60 @@ 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::BiomarkersLiterature200ResponseRowsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::BiomarkerLiteratureRow` 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::BiomarkersLiterature200ResponseRowsInner`. 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::BiomarkerLiteratureRow`. 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?(:'route_key')
+        self.route_key = attributes[:'route_key']
+      end
+
+      if attributes.key?(:'gene_symbol')
+        self.gene_symbol = attributes[:'gene_symbol']
+      end
+
       if attributes.key?(:'pmid')
         self.pmid = attributes[:'pmid']
-      else
-        self.pmid = nil
+      end
+
+      if attributes.key?(:'evidence_type')
+        self.evidence_type = attributes[:'evidence_type']
       end
 
       if attributes.key?(:'title')
         self.title = attributes[:'title']
-      else
-        self.title = nil
+      end
+
+      if attributes.key?(:'journal_nlm_id')
+        self.journal_nlm_id = attributes[:'journal_nlm_id']
       end
 
       if attributes.key?(:'journal_title')
         self.journal_title = attributes[:'journal_title']
-      else
-        self.journal_title = nil
       end
 
       if attributes.key?(:'pub_year')
         self.pub_year = attributes[:'pub_year']
-      else
-        self.pub_year = nil
       end
 
       if attributes.key?(:'citation_count')
         self.citation_count = attributes[:'citation_count']
-      else
-        self.citation_count = nil
       end
 
       if attributes.key?(:'relative_citation_ratio')
         self.relative_citation_ratio = attributes[:'relative_citation_ratio']
-      else
-        self.relative_citation_ratio = nil
+      end
+
+      if attributes.key?(:'display_order')
+        self.display_order = attributes[:'display_order']
       end
     end
 
@@ -125,30 +176,6 @@ module PharmaObservatory
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @pmid.nil?
-        invalid_properties.push('invalid value for "pmid", pmid cannot be nil.')
-      end
-
-      if @title.nil?
-        invalid_properties.push('invalid value for "title", title cannot be nil.')
-      end
-
-      if @journal_title.nil?
-        invalid_properties.push('invalid value for "journal_title", journal_title cannot be nil.')
-      end
-
-      if @pub_year.nil?
-        invalid_properties.push('invalid value for "pub_year", pub_year cannot be nil.')
-      end
-
-      if @citation_count.nil?
-        invalid_properties.push('invalid value for "citation_count", citation_count cannot be nil.')
-      end
-
-      if @relative_citation_ratio.nil?
-        invalid_properties.push('invalid value for "relative_citation_ratio", relative_citation_ratio cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -156,86 +183,25 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @pmid.nil?
-      return false if @title.nil?
-      return false if @journal_title.nil?
-      return false if @pub_year.nil?
-      return false if @citation_count.nil?
-      return false if @relative_citation_ratio.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] pmid Value to be assigned
-    def pmid=(pmid)
-      if pmid.nil?
-        fail ArgumentError, 'pmid cannot be nil'
-      end
-
-      @pmid = pmid
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] title Value to be assigned
-    def title=(title)
-      if title.nil?
-        fail ArgumentError, 'title cannot be nil'
-      end
-
-      @title = title
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] journal_title Value to be assigned
-    def journal_title=(journal_title)
-      if journal_title.nil?
-        fail ArgumentError, 'journal_title cannot be nil'
-      end
-
-      @journal_title = journal_title
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] pub_year Value to be assigned
-    def pub_year=(pub_year)
-      if pub_year.nil?
-        fail ArgumentError, 'pub_year cannot be nil'
-      end
-
-      @pub_year = pub_year
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] citation_count Value to be assigned
-    def citation_count=(citation_count)
-      if citation_count.nil?
-        fail ArgumentError, 'citation_count cannot be nil'
-      end
-
-      @citation_count = citation_count
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] relative_citation_ratio Value to be assigned
-    def relative_citation_ratio=(relative_citation_ratio)
-      if relative_citation_ratio.nil?
-        fail ArgumentError, 'relative_citation_ratio cannot be nil'
-      end
-
-      @relative_citation_ratio = relative_citation_ratio
-    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 &&
+          route_key == o.route_key &&
+          gene_symbol == o.gene_symbol &&
           pmid == o.pmid &&
+          evidence_type == o.evidence_type &&
           title == o.title &&
+          journal_nlm_id == o.journal_nlm_id &&
           journal_title == o.journal_title &&
           pub_year == o.pub_year &&
           citation_count == o.citation_count &&
-          relative_citation_ratio == o.relative_citation_ratio
+          relative_citation_ratio == o.relative_citation_ratio &&
+          display_order == o.display_order
     end
 
     # @see the `==` method
@@ -247,7 +213,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [pmid, title, journal_title, pub_year, citation_count, relative_citation_ratio].hash
+      [route_key, gene_symbol, pmid, evidence_type, title, journal_nlm_id, journal_title, pub_year, citation_count, relative_citation_ratio, display_order].hash
     end
 
     # Builds the object from hash