pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/{biomarkers_fda_cdx200_response_rows_inner.rb → biomarker_cdx_assertions_row.rb}

@@ -14,43 +14,79 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class BiomarkersFdaCdx200ResponseRowsInner
-    attr_accessor :cdx_entry_key
+  # One row of the biomarker_cdx_assertions dataset: one row per FDA companion diagnostic assertion for a biomarker. A grouped request returns the group columns and the measures instead, as additional properties.
+  class BiomarkerCdxAssertionsRow
+    # The assertion id.
+    attr_accessor :source_assertion_id
 
-    attr_accessor :diagnostic_name
-
-    attr_accessor :biomarker_token
+    # The biomarker's route key, the entry key for the biomarkers object type.
+    attr_accessor :route_key
 
-    attr_accessor :manufacturer_name
+    # The biomarker key.
+    attr_accessor :biomarker_id
 
-    attr_accessor :canonical_org_id
-
-    attr_accessor :org_name
+    # The biomarker as the FDA list names it.
+    attr_accessor :biomarker_token
 
-    attr_accessor :org_match_tier
+    # The companion diagnostic's name.
+    attr_accessor :diagnostic_name
 
+    # The indication.
     attr_accessor :indication
 
+    # The sample type.
     attr_accessor :sample_type
 
+    # The submission number cell as listed.
+    attr_accessor :submission_cell
+
+    # Latest decision date the list states.
     attr_accessor :latest_stated_decision_date
 
+    # Link to the FDA list.
     attr_accessor :source_url
 
+    # The manufacturer as filed.
+    attr_accessor :manufacturer_name
+
+    # Legal-entity level: the organization record the manufacturer resolved to (null when unresolved).
+    attr_accessor :manufacturer_org_id
+
+    # Company level: the company the manufacturer belongs to (null when unresolved).
+    attr_accessor :manufacturer_company_id
+
+    # Display name of the manufacturer's company.
+    attr_accessor :manufacturer_company_name
+
+    # Group level: the manufacturer's current ultimate parent company; a root company's group is itself.
+    attr_accessor :manufacturer_group_id
+
+    # Display name of the manufacturer's group.
+    attr_accessor :manufacturer_group_name
+
+    # How firmly the manufacturer name matched an organization.
+    attr_accessor :manufacturer_match_tier
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'cdx_entry_key' => :'cdx_entry_key',
-        :'diagnostic_name' => :'diagnostic_name',
+        :'source_assertion_id' => :'source_assertion_id',
+        :'route_key' => :'route_key',
+        :'biomarker_id' => :'biomarker_id',
         :'biomarker_token' => :'biomarker_token',
-        :'manufacturer_name' => :'manufacturer_name',
-        :'canonical_org_id' => :'canonical_org_id',
-        :'org_name' => :'org_name',
-        :'org_match_tier' => :'org_match_tier',
+        :'diagnostic_name' => :'diagnostic_name',
         :'indication' => :'indication',
         :'sample_type' => :'sample_type',
+        :'submission_cell' => :'submission_cell',
         :'latest_stated_decision_date' => :'latest_stated_decision_date',
-        :'source_url' => :'source_url'
+        :'source_url' => :'source_url',
+        :'manufacturer_name' => :'manufacturer_name',
+        :'manufacturer_org_id' => :'manufacturer_org_id',
+        :'manufacturer_company_id' => :'manufacturer_company_id',
+        :'manufacturer_company_name' => :'manufacturer_company_name',
+        :'manufacturer_group_id' => :'manufacturer_group_id',
+        :'manufacturer_group_name' => :'manufacturer_group_name',
+        :'manufacturer_match_tier' => :'manufacturer_match_tier'
       }
     end
 
@@ -67,25 +103,46 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'cdx_entry_key' => :'String',
-        :'diagnostic_name' => :'String',
+        :'source_assertion_id' => :'String',
+        :'route_key' => :'String',
+        :'biomarker_id' => :'String',
         :'biomarker_token' => :'String',
-        :'manufacturer_name' => :'String',
-        :'canonical_org_id' => :'String',
-        :'org_name' => :'String',
-        :'org_match_tier' => :'String',
+        :'diagnostic_name' => :'String',
         :'indication' => :'String',
         :'sample_type' => :'String',
-        :'latest_stated_decision_date' => :'String',
-        :'source_url' => :'String'
+        :'submission_cell' => :'String',
+        :'latest_stated_decision_date' => :'Date',
+        :'source_url' => :'String',
+        :'manufacturer_name' => :'String',
+        :'manufacturer_org_id' => :'String',
+        :'manufacturer_company_id' => :'String',
+        :'manufacturer_company_name' => :'String',
+        :'manufacturer_group_id' => :'String',
+        :'manufacturer_group_name' => :'String',
+        :'manufacturer_match_tier' => :'String'
       }
     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',
+        :'biomarker_token',
+        :'diagnostic_name',
+        :'indication',
+        :'sample_type',
+        :'submission_cell',
+        :'latest_stated_decision_date',
+        :'source_url',
+        :'manufacturer_name',
+        :'manufacturer_org_id',
+        :'manufacturer_company_id',
+        :'manufacturer_company_name',
+        :'manufacturer_group_id',
+        :'manufacturer_group_name',
+        :'manufacturer_match_tier'
       ])
     end
 
@@ -93,126 +150,92 @@ 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::BiomarkersFdaCdx200ResponseRowsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::BiomarkerCdxAssertionsRow` 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::BiomarkersFdaCdx200ResponseRowsInner`. 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::BiomarkerCdxAssertionsRow`. 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?(:'cdx_entry_key')
-        self.cdx_entry_key = attributes[:'cdx_entry_key']
-      else
-        self.cdx_entry_key = nil
+      if attributes.key?(:'source_assertion_id')
+        self.source_assertion_id = attributes[:'source_assertion_id']
       end
 
-      if attributes.key?(:'diagnostic_name')
-        self.diagnostic_name = attributes[:'diagnostic_name']
-      else
-        self.diagnostic_name = nil
+      if attributes.key?(:'route_key')
+        self.route_key = attributes[:'route_key']
       end
 
-      if attributes.key?(:'biomarker_token')
-        self.biomarker_token = attributes[:'biomarker_token']
-      else
-        self.biomarker_token = nil
-      end
-
-      if attributes.key?(:'manufacturer_name')
-        self.manufacturer_name = attributes[:'manufacturer_name']
-      else
-        self.manufacturer_name = nil
-      end
-
-      if attributes.key?(:'canonical_org_id')
-        self.canonical_org_id = attributes[:'canonical_org_id']
-      else
-        self.canonical_org_id = nil
+      if attributes.key?(:'biomarker_id')
+        self.biomarker_id = attributes[:'biomarker_id']
       end
 
-      if attributes.key?(:'org_name')
-        self.org_name = attributes[:'org_name']
-      else
-        self.org_name = nil
+      if attributes.key?(:'biomarker_token')
+        self.biomarker_token = attributes[:'biomarker_token']
       end
 
-      if attributes.key?(:'org_match_tier')
-        self.org_match_tier = attributes[:'org_match_tier']
-      else
-        self.org_match_tier = nil
+      if attributes.key?(:'diagnostic_name')
+        self.diagnostic_name = attributes[:'diagnostic_name']
       end
 
       if attributes.key?(:'indication')
         self.indication = attributes[:'indication']
-      else
-        self.indication = nil
       end
 
       if attributes.key?(:'sample_type')
         self.sample_type = attributes[:'sample_type']
-      else
-        self.sample_type = nil
+      end
+
+      if attributes.key?(:'submission_cell')
+        self.submission_cell = attributes[:'submission_cell']
       end
 
       if attributes.key?(:'latest_stated_decision_date')
         self.latest_stated_decision_date = attributes[:'latest_stated_decision_date']
-      else
-        self.latest_stated_decision_date = nil
       end
 
       if attributes.key?(:'source_url')
         self.source_url = attributes[:'source_url']
-      else
-        self.source_url = nil
       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 @cdx_entry_key.nil?
-        invalid_properties.push('invalid value for "cdx_entry_key", cdx_entry_key cannot be nil.')
-      end
-
-      if @diagnostic_name.nil?
-        invalid_properties.push('invalid value for "diagnostic_name", diagnostic_name cannot be nil.')
-      end
-
-      if @biomarker_token.nil?
-        invalid_properties.push('invalid value for "biomarker_token", biomarker_token cannot be nil.')
+      if attributes.key?(:'manufacturer_name')
+        self.manufacturer_name = attributes[:'manufacturer_name']
       end
 
-      if @manufacturer_name.nil?
-        invalid_properties.push('invalid value for "manufacturer_name", manufacturer_name cannot be nil.')
+      if attributes.key?(:'manufacturer_org_id')
+        self.manufacturer_org_id = attributes[:'manufacturer_org_id']
       end
 
-      if @org_match_tier.nil?
-        invalid_properties.push('invalid value for "org_match_tier", org_match_tier cannot be nil.')
+      if attributes.key?(:'manufacturer_company_id')
+        self.manufacturer_company_id = attributes[:'manufacturer_company_id']
       end
 
-      if @indication.nil?
-        invalid_properties.push('invalid value for "indication", indication cannot be nil.')
+      if attributes.key?(:'manufacturer_company_name')
+        self.manufacturer_company_name = attributes[:'manufacturer_company_name']
       end
 
-      if @sample_type.nil?
-        invalid_properties.push('invalid value for "sample_type", sample_type cannot be nil.')
+      if attributes.key?(:'manufacturer_group_id')
+        self.manufacturer_group_id = attributes[:'manufacturer_group_id']
       end
 
-      if @latest_stated_decision_date.nil?
-        invalid_properties.push('invalid value for "latest_stated_decision_date", latest_stated_decision_date cannot be nil.')
+      if attributes.key?(:'manufacturer_group_name')
+        self.manufacturer_group_name = attributes[:'manufacturer_group_name']
       end
 
-      if @source_url.nil?
-        invalid_properties.push('invalid value for "source_url", source_url cannot be nil.')
+      if attributes.key?(:'manufacturer_match_tier')
+        self.manufacturer_match_tier = attributes[:'manufacturer_match_tier']
       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 +243,31 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @cdx_entry_key.nil?
-      return false if @diagnostic_name.nil?
-      return false if @biomarker_token.nil?
-      return false if @manufacturer_name.nil?
-      return false if @org_match_tier.nil?
-      return false if @indication.nil?
-      return false if @sample_type.nil?
-      return false if @latest_stated_decision_date.nil?
-      return false if @source_url.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] cdx_entry_key Value to be assigned
-    def cdx_entry_key=(cdx_entry_key)
-      if cdx_entry_key.nil?
-        fail ArgumentError, 'cdx_entry_key cannot be nil'
-      end
-
-      @cdx_entry_key = cdx_entry_key
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] diagnostic_name Value to be assigned
-    def diagnostic_name=(diagnostic_name)
-      if diagnostic_name.nil?
-        fail ArgumentError, 'diagnostic_name cannot be nil'
-      end
-
-      @diagnostic_name = diagnostic_name
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] biomarker_token Value to be assigned
-    def biomarker_token=(biomarker_token)
-      if biomarker_token.nil?
-        fail ArgumentError, 'biomarker_token cannot be nil'
-      end
-
-      @biomarker_token = biomarker_token
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] manufacturer_name Value to be assigned
-    def manufacturer_name=(manufacturer_name)
-      if manufacturer_name.nil?
-        fail ArgumentError, 'manufacturer_name cannot be nil'
-      end
-
-      @manufacturer_name = manufacturer_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] indication Value to be assigned
-    def indication=(indication)
-      if indication.nil?
-        fail ArgumentError, 'indication cannot be nil'
-      end
-
-      @indication = indication
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] sample_type Value to be assigned
-    def sample_type=(sample_type)
-      if sample_type.nil?
-        fail ArgumentError, 'sample_type cannot be nil'
-      end
-
-      @sample_type = sample_type
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] latest_stated_decision_date Value to be assigned
-    def latest_stated_decision_date=(latest_stated_decision_date)
-      if latest_stated_decision_date.nil?
-        fail ArgumentError, 'latest_stated_decision_date cannot be nil'
-      end
-
-      @latest_stated_decision_date = latest_stated_decision_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 &&
-          cdx_entry_key == o.cdx_entry_key &&
-          diagnostic_name == o.diagnostic_name &&
+          source_assertion_id == o.source_assertion_id &&
+          route_key == o.route_key &&
+          biomarker_id == o.biomarker_id &&
           biomarker_token == o.biomarker_token &&
-          manufacturer_name == o.manufacturer_name &&
-          canonical_org_id == o.canonical_org_id &&
-          org_name == o.org_name &&
-          org_match_tier == o.org_match_tier &&
+          diagnostic_name == o.diagnostic_name &&
           indication == o.indication &&
           sample_type == o.sample_type &&
+          submission_cell == o.submission_cell &&
           latest_stated_decision_date == o.latest_stated_decision_date &&
-          source_url == o.source_url
+          source_url == o.source_url &&
+          manufacturer_name == o.manufacturer_name &&
+          manufacturer_org_id == o.manufacturer_org_id &&
+          manufacturer_company_id == o.manufacturer_company_id &&
+          manufacturer_company_name == o.manufacturer_company_name &&
+          manufacturer_group_id == o.manufacturer_group_id &&
+          manufacturer_group_name == o.manufacturer_group_name &&
+          manufacturer_match_tier == o.manufacturer_match_tier
     end
 
     # @see the `==` method
@@ -349,7 +279,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [cdx_entry_key, diagnostic_name, biomarker_token, manufacturer_name, canonical_org_id, org_name, org_match_tier, indication, sample_type, latest_stated_decision_date, source_url].hash
+      [source_assertion_id, route_key, biomarker_id, biomarker_token, diagnostic_name, indication, sample_type, submission_cell, latest_stated_decision_date, source_url, manufacturer_name, manufacturer_org_id, manufacturer_company_id, manufacturer_company_name, manufacturer_group_id, manufacturer_group_name, manufacturer_match_tier].hash
     end
 
     # Builds the object from hash