pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{biomarkers_fda_bqp200_response_rows_inner.rb → biomarker_bqp_assertions_row.rb}

@@ -14,43 +14,103 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class BiomarkersFdaBqp200ResponseRowsInner
+  # One row of the biomarker_bqp_assertions dataset: one row per FDA Biomarker Qualification Program assertion for a biomarker. A grouped request returns the group columns and the measures instead, as additional properties.
+  class BiomarkerBqpAssertionsRow
+    # The assertion id.
+    attr_accessor :source_assertion_id
+
+    # The biomarker's route key, the entry key for the biomarkers object type.
+    attr_accessor :route_key
+
+    # The biomarker key.
+    attr_accessor :biomarker_id
+
+    # The FDA drug development tool number of the project.
     attr_accessor :ddt_number
 
+    # The FDA project id.
+    attr_accessor :ddt_project_id
+
+    # The project's name.
     attr_accessor :project_name
 
+    # The source status of the project. Only qualified means FDA-qualified; every other value is a project status.
     attr_accessor :bqp_signal
 
+    # True only when the source status is exactly qualified.
     attr_accessor :is_fda_qualified
 
+    # The submission status as the source words it.
+    attr_accessor :submission_status
+
+    # The submission stage as the source words it.
+    attr_accessor :submission_stage
+
+    # The submitter as the source names it.
     attr_accessor :submitter_name
 
-    attr_accessor :canonical_org_id
+    # Legal-entity level: the organization record the submitter resolved to (null when unresolved).
+    attr_accessor :submitter_org_id
+
+    # Company level: the company the submitter belongs to (null when unresolved).
+    attr_accessor :submitter_company_id
 
-    attr_accessor :org_name
+    # Display name of the submitter's company.
+    attr_accessor :submitter_company_name
 
-    attr_accessor :org_match_tier
+    # Group level: the submitter's current ultimate parent company; a root company's group is itself.
+    attr_accessor :submitter_group_id
 
+    # Display name of the submitter's group.
+    attr_accessor :submitter_group_name
+
+    # How the submitter name matched an organization record.
+    attr_accessor :submitter_match_tier
+
+    # The submitter's role on the project.
+    attr_accessor :submitter_role
+
+    # The biomarker's role in the project (for example a diagnostic or a surrogate endpoint).
     attr_accessor :biomarker_role
 
-    attr_accessor :snapshot_date
+    # How the biomarker role was assigned.
+    attr_accessor :biomarker_role_method
+
+    # True when the project claims a surrogate endpoint.
+    attr_accessor :is_surrogate_endpoint_claim
 
+    # Link to the FDA project page.
     attr_accessor :source_url
 
+    # The date the source list was captured.
+    attr_accessor :snapshot_date
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'source_assertion_id' => :'source_assertion_id',
+        :'route_key' => :'route_key',
+        :'biomarker_id' => :'biomarker_id',
         :'ddt_number' => :'ddt_number',
+        :'ddt_project_id' => :'ddt_project_id',
         :'project_name' => :'project_name',
         :'bqp_signal' => :'bqp_signal',
         :'is_fda_qualified' => :'is_fda_qualified',
+        :'submission_status' => :'submission_status',
+        :'submission_stage' => :'submission_stage',
         :'submitter_name' => :'submitter_name',
-        :'canonical_org_id' => :'canonical_org_id',
-        :'org_name' => :'org_name',
-        :'org_match_tier' => :'org_match_tier',
+        :'submitter_org_id' => :'submitter_org_id',
+        :'submitter_company_id' => :'submitter_company_id',
+        :'submitter_company_name' => :'submitter_company_name',
+        :'submitter_group_id' => :'submitter_group_id',
+        :'submitter_group_name' => :'submitter_group_name',
+        :'submitter_match_tier' => :'submitter_match_tier',
+        :'submitter_role' => :'submitter_role',
         :'biomarker_role' => :'biomarker_role',
-        :'snapshot_date' => :'snapshot_date',
-        :'source_url' => :'source_url'
+        :'biomarker_role_method' => :'biomarker_role_method',
+        :'is_surrogate_endpoint_claim' => :'is_surrogate_endpoint_claim',
+        :'source_url' => :'source_url',
+        :'snapshot_date' => :'snapshot_date'
       }
     end
 
@@ -67,25 +127,58 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'source_assertion_id' => :'String',
+        :'route_key' => :'String',
+        :'biomarker_id' => :'String',
         :'ddt_number' => :'String',
+        :'ddt_project_id' => :'String',
         :'project_name' => :'String',
         :'bqp_signal' => :'String',
         :'is_fda_qualified' => :'Boolean',
+        :'submission_status' => :'String',
+        :'submission_stage' => :'String',
         :'submitter_name' => :'String',
-        :'canonical_org_id' => :'Object',
-        :'org_name' => :'Object',
-        :'org_match_tier' => :'String',
+        :'submitter_org_id' => :'String',
+        :'submitter_company_id' => :'String',
+        :'submitter_company_name' => :'String',
+        :'submitter_group_id' => :'String',
+        :'submitter_group_name' => :'String',
+        :'submitter_match_tier' => :'String',
+        :'submitter_role' => :'String',
         :'biomarker_role' => :'String',
-        :'snapshot_date' => :'String',
-        :'source_url' => :'String'
+        :'biomarker_role_method' => :'String',
+        :'is_surrogate_endpoint_claim' => :'Boolean',
+        :'source_url' => :'String',
+        :'snapshot_date' => :'Date'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'canonical_org_id',
-        :'org_name',
+        :'source_assertion_id',
+        :'route_key',
+        :'biomarker_id',
+        :'ddt_number',
+        :'ddt_project_id',
+        :'project_name',
+        :'bqp_signal',
+        :'is_fda_qualified',
+        :'submission_status',
+        :'submission_stage',
+        :'submitter_name',
+        :'submitter_org_id',
+        :'submitter_company_id',
+        :'submitter_company_name',
+        :'submitter_group_id',
+        :'submitter_group_name',
+        :'submitter_match_tier',
+        :'submitter_role',
+        :'biomarker_role',
+        :'biomarker_role_method',
+        :'is_surrogate_endpoint_claim',
+        :'source_url',
+        :'snapshot_date'
       ])
     end
 
@@ -93,126 +186,116 @@ 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::BiomarkersFdaBqp200ResponseRowsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::BiomarkerBqpAssertionsRow` 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::BiomarkersFdaBqp200ResponseRowsInner`. 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::BiomarkerBqpAssertionsRow`. 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?(:'source_assertion_id')
+        self.source_assertion_id = attributes[:'source_assertion_id']
+      end
+
+      if attributes.key?(:'route_key')
+        self.route_key = attributes[:'route_key']
+      end
+
+      if attributes.key?(:'biomarker_id')
+        self.biomarker_id = attributes[:'biomarker_id']
+      end
+
       if attributes.key?(:'ddt_number')
         self.ddt_number = attributes[:'ddt_number']
-      else
-        self.ddt_number = nil
+      end
+
+      if attributes.key?(:'ddt_project_id')
+        self.ddt_project_id = attributes[:'ddt_project_id']
       end
 
       if attributes.key?(:'project_name')
         self.project_name = attributes[:'project_name']
-      else
-        self.project_name = nil
       end
 
       if attributes.key?(:'bqp_signal')
         self.bqp_signal = attributes[:'bqp_signal']
-      else
-        self.bqp_signal = nil
       end
 
       if attributes.key?(:'is_fda_qualified')
         self.is_fda_qualified = attributes[:'is_fda_qualified']
-      else
-        self.is_fda_qualified = nil
       end
 
-      if attributes.key?(:'submitter_name')
-        self.submitter_name = attributes[:'submitter_name']
-      else
-        self.submitter_name = nil
+      if attributes.key?(:'submission_status')
+        self.submission_status = attributes[:'submission_status']
       end
 
-      if attributes.key?(:'canonical_org_id')
-        self.canonical_org_id = attributes[:'canonical_org_id']
-      else
-        self.canonical_org_id = nil
+      if attributes.key?(:'submission_stage')
+        self.submission_stage = attributes[:'submission_stage']
       end
 
-      if attributes.key?(:'org_name')
-        self.org_name = attributes[:'org_name']
-      else
-        self.org_name = nil
+      if attributes.key?(:'submitter_name')
+        self.submitter_name = attributes[:'submitter_name']
       end
 
-      if attributes.key?(:'org_match_tier')
-        self.org_match_tier = attributes[:'org_match_tier']
-      else
-        self.org_match_tier = nil
+      if attributes.key?(:'submitter_org_id')
+        self.submitter_org_id = attributes[:'submitter_org_id']
       end
 
-      if attributes.key?(:'biomarker_role')
-        self.biomarker_role = attributes[:'biomarker_role']
-      else
-        self.biomarker_role = nil
+      if attributes.key?(:'submitter_company_id')
+        self.submitter_company_id = attributes[:'submitter_company_id']
       end
 
-      if attributes.key?(:'snapshot_date')
-        self.snapshot_date = attributes[:'snapshot_date']
-      else
-        self.snapshot_date = nil
+      if attributes.key?(:'submitter_company_name')
+        self.submitter_company_name = attributes[:'submitter_company_name']
       end
 
-      if attributes.key?(:'source_url')
-        self.source_url = attributes[:'source_url']
-      else
-        self.source_url = nil
+      if attributes.key?(:'submitter_group_id')
+        self.submitter_group_id = attributes[:'submitter_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 @ddt_number.nil?
-        invalid_properties.push('invalid value for "ddt_number", ddt_number cannot be nil.')
+      if attributes.key?(:'submitter_group_name')
+        self.submitter_group_name = attributes[:'submitter_group_name']
       end
 
-      if @project_name.nil?
-        invalid_properties.push('invalid value for "project_name", project_name cannot be nil.')
+      if attributes.key?(:'submitter_match_tier')
+        self.submitter_match_tier = attributes[:'submitter_match_tier']
       end
 
-      if @bqp_signal.nil?
-        invalid_properties.push('invalid value for "bqp_signal", bqp_signal cannot be nil.')
+      if attributes.key?(:'submitter_role')
+        self.submitter_role = attributes[:'submitter_role']
       end
 
-      if @is_fda_qualified.nil?
-        invalid_properties.push('invalid value for "is_fda_qualified", is_fda_qualified cannot be nil.')
-      end
-
-      if @submitter_name.nil?
-        invalid_properties.push('invalid value for "submitter_name", submitter_name cannot be nil.')
+      if attributes.key?(:'biomarker_role')
+        self.biomarker_role = attributes[:'biomarker_role']
       end
 
-      if @org_match_tier.nil?
-        invalid_properties.push('invalid value for "org_match_tier", org_match_tier cannot be nil.')
+      if attributes.key?(:'biomarker_role_method')
+        self.biomarker_role_method = attributes[:'biomarker_role_method']
       end
 
-      if @biomarker_role.nil?
-        invalid_properties.push('invalid value for "biomarker_role", biomarker_role cannot be nil.')
+      if attributes.key?(:'is_surrogate_endpoint_claim')
+        self.is_surrogate_endpoint_claim = attributes[:'is_surrogate_endpoint_claim']
       end
 
-      if @snapshot_date.nil?
-        invalid_properties.push('invalid value for "snapshot_date", snapshot_date cannot be nil.')
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
       end
 
-      if @source_url.nil?
-        invalid_properties.push('invalid value for "source_url", source_url cannot be nil.')
+      if attributes.key?(:'snapshot_date')
+        self.snapshot_date = attributes[:'snapshot_date']
       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
 
@@ -220,124 +303,37 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @ddt_number.nil?
-      return false if @project_name.nil?
-      return false if @bqp_signal.nil?
-      return false if @is_fda_qualified.nil?
-      return false if @submitter_name.nil?
-      return false if @org_match_tier.nil?
-      return false if @biomarker_role.nil?
-      return false if @snapshot_date.nil?
-      return false if @source_url.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] ddt_number Value to be assigned
-    def ddt_number=(ddt_number)
-      if ddt_number.nil?
-        fail ArgumentError, 'ddt_number cannot be nil'
-      end
-
-      @ddt_number = ddt_number
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] project_name Value to be assigned
-    def project_name=(project_name)
-      if project_name.nil?
-        fail ArgumentError, 'project_name cannot be nil'
-      end
-
-      @project_name = project_name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] bqp_signal Value to be assigned
-    def bqp_signal=(bqp_signal)
-      if bqp_signal.nil?
-        fail ArgumentError, 'bqp_signal cannot be nil'
-      end
-
-      @bqp_signal = bqp_signal
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] is_fda_qualified Value to be assigned
-    def is_fda_qualified=(is_fda_qualified)
-      if is_fda_qualified.nil?
-        fail ArgumentError, 'is_fda_qualified cannot be nil'
-      end
-
-      @is_fda_qualified = is_fda_qualified
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] submitter_name Value to be assigned
-    def submitter_name=(submitter_name)
-      if submitter_name.nil?
-        fail ArgumentError, 'submitter_name cannot be nil'
-      end
-
-      @submitter_name = submitter_name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] org_match_tier Value to be assigned
-    def org_match_tier=(org_match_tier)
-      if org_match_tier.nil?
-        fail ArgumentError, 'org_match_tier cannot be nil'
-      end
-
-      @org_match_tier = org_match_tier
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] biomarker_role Value to be assigned
-    def biomarker_role=(biomarker_role)
-      if biomarker_role.nil?
-        fail ArgumentError, 'biomarker_role cannot be nil'
-      end
-
-      @biomarker_role = biomarker_role
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] snapshot_date Value to be assigned
-    def snapshot_date=(snapshot_date)
-      if snapshot_date.nil?
-        fail ArgumentError, 'snapshot_date cannot be nil'
-      end
-
-      @snapshot_date = snapshot_date
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] source_url Value to be assigned
-    def source_url=(source_url)
-      if source_url.nil?
-        fail ArgumentError, 'source_url cannot be nil'
-      end
-
-      @source_url = source_url
-    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 &&
+          source_assertion_id == o.source_assertion_id &&
+          route_key == o.route_key &&
+          biomarker_id == o.biomarker_id &&
           ddt_number == o.ddt_number &&
+          ddt_project_id == o.ddt_project_id &&
           project_name == o.project_name &&
           bqp_signal == o.bqp_signal &&
           is_fda_qualified == o.is_fda_qualified &&
+          submission_status == o.submission_status &&
+          submission_stage == o.submission_stage &&
           submitter_name == o.submitter_name &&
-          canonical_org_id == o.canonical_org_id &&
-          org_name == o.org_name &&
-          org_match_tier == o.org_match_tier &&
+          submitter_org_id == o.submitter_org_id &&
+          submitter_company_id == o.submitter_company_id &&
+          submitter_company_name == o.submitter_company_name &&
+          submitter_group_id == o.submitter_group_id &&
+          submitter_group_name == o.submitter_group_name &&
+          submitter_match_tier == o.submitter_match_tier &&
+          submitter_role == o.submitter_role &&
           biomarker_role == o.biomarker_role &&
-          snapshot_date == o.snapshot_date &&
-          source_url == o.source_url
+          biomarker_role_method == o.biomarker_role_method &&
+          is_surrogate_endpoint_claim == o.is_surrogate_endpoint_claim &&
+          source_url == o.source_url &&
+          snapshot_date == o.snapshot_date
     end
 
     # @see the `==` method
@@ -349,7 +345,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ddt_number, project_name, bqp_signal, is_fda_qualified, submitter_name, canonical_org_id, org_name, org_match_tier, biomarker_role, snapshot_date, source_url].hash
+      [source_assertion_id, route_key, biomarker_id, ddt_number, ddt_project_id, project_name, bqp_signal, is_fda_qualified, submission_status, submission_stage, submitter_name, submitter_org_id, submitter_company_id, submitter_company_name, submitter_group_id, submitter_group_name, submitter_match_tier, submitter_role, biomarker_role, biomarker_role_method, is_surrogate_endpoint_claim, source_url, snapshot_date].hash
     end
 
     # Builds the object from hash