pharmaobservatory 0.1.1 → 0.1.3

data/lib/pharmaobservatory/models/{api_v1_trials_records_get200_response_trials_inner_linked_drugs_inner_brands_inner.rb → biomarker_cdx_assertions_response_scope.rb}

@@ -14,16 +14,41 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class ApiV1TrialsRecordsGet200ResponseTrialsInnerLinkedDrugsInnerBrandsInner
-    attr_accessor :brand_key
+  class BiomarkerCdxAssertionsResponseScope
+    attr_accessor :kind
+
+    attr_accessor :group_id
+
+    attr_accessor :group_name
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
 
-    attr_accessor :brand_name
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'brand_key' => :'brand_key',
-        :'brand_name' => :'brand_name'
+        :'kind' => :'kind',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name'
       }
     end
 
@@ -40,14 +65,17 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'brand_key' => :'String',
-        :'brand_name' => :'String'
+        :'kind' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'group_id',
+        :'group_name'
       ])
     end
 
@@ -55,28 +83,28 @@ 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::ApiV1TrialsRecordsGet200ResponseTrialsInnerLinkedDrugsInnerBrandsInner` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::BiomarkerCdxAssertionsResponseScope` 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::ApiV1TrialsRecordsGet200ResponseTrialsInnerLinkedDrugsInnerBrandsInner`. 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::BiomarkerCdxAssertionsResponseScope`. 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?(:'brand_key')
-        self.brand_key = attributes[:'brand_key']
-      else
-        self.brand_key = nil
+      if attributes.key?(:'kind')
+        self.kind = attributes[:'kind']
       end
 
-      if attributes.key?(:'brand_name')
-        self.brand_name = attributes[:'brand_name']
-      else
-        self.brand_name = nil
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
       end
     end
 
@@ -85,14 +113,6 @@ module PharmaObservatory
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @brand_key.nil?
-        invalid_properties.push('invalid value for "brand_key", brand_key cannot be nil.')
-      end
-
-      if @brand_name.nil?
-        invalid_properties.push('invalid value for "brand_name", brand_name cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -100,29 +120,19 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @brand_key.nil?
-      return false if @brand_name.nil?
+      kind_validator = EnumAttributeValidator.new('String', ["company", "group"])
+      return false unless kind_validator.valid?(@kind)
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] brand_key Value to be assigned
-    def brand_key=(brand_key)
-      if brand_key.nil?
-        fail ArgumentError, 'brand_key cannot be nil'
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] kind Object to be assigned
+    def kind=(kind)
+      validator = EnumAttributeValidator.new('String', ["company", "group"])
+      unless validator.valid?(kind)
+        fail ArgumentError, "invalid value for \"kind\", must be one of #{validator.allowable_values}."
       end
-
-      @brand_key = brand_key
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] brand_name Value to be assigned
-    def brand_name=(brand_name)
-      if brand_name.nil?
-        fail ArgumentError, 'brand_name cannot be nil'
-      end
-
-      @brand_name = brand_name
+      @kind = kind
     end
 
     # Checks equality by comparing each attribute.
@@ -130,8 +140,9 @@ module PharmaObservatory
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          brand_key == o.brand_key &&
-          brand_name == o.brand_name
+          kind == o.kind &&
+          group_id == o.group_id &&
+          group_name == o.group_name
     end
 
     # @see the `==` method
@@ -143,7 +154,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [brand_key, brand_name].hash
+      [kind, group_id, group_name].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/biomarker_cdx_assertions_row.rb

@@ -0,0 +1,399 @@
+=begin
+#Pharma Observatory Public REST API
+
+#Read-only REST API over the Pharma Observatory biomedical data platform. Reference: https://pharmaobservatory.com/api-reference
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.13.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PharmaObservatory
+  # 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
+
+    # 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 biomarker as the FDA list names it.
+    attr_accessor :biomarker_token
+
+    # 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
+      {
+        :'source_assertion_id' => :'source_assertion_id',
+        :'route_key' => :'route_key',
+        :'biomarker_id' => :'biomarker_id',
+        :'biomarker_token' => :'biomarker_token',
+        :'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',
+        :'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
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'source_assertion_id' => :'String',
+        :'route_key' => :'String',
+        :'biomarker_id' => :'String',
+        :'biomarker_token' => :'String',
+        :'diagnostic_name' => :'String',
+        :'indication' => :'String',
+        :'sample_type' => :'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([
+        :'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
+
+    # Initializes the object
+    # @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::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::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?(:'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?(:'biomarker_token')
+        self.biomarker_token = attributes[:'biomarker_token']
+      end
+
+      if attributes.key?(:'diagnostic_name')
+        self.diagnostic_name = attributes[:'diagnostic_name']
+      end
+
+      if attributes.key?(:'indication')
+        self.indication = attributes[:'indication']
+      end
+
+      if attributes.key?(:'sample_type')
+        self.sample_type = attributes[:'sample_type']
+      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']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'manufacturer_name')
+        self.manufacturer_name = attributes[:'manufacturer_name']
+      end
+
+      if attributes.key?(:'manufacturer_org_id')
+        self.manufacturer_org_id = attributes[:'manufacturer_org_id']
+      end
+
+      if attributes.key?(:'manufacturer_company_id')
+        self.manufacturer_company_id = attributes[:'manufacturer_company_id']
+      end
+
+      if attributes.key?(:'manufacturer_company_name')
+        self.manufacturer_company_name = attributes[:'manufacturer_company_name']
+      end
+
+      if attributes.key?(:'manufacturer_group_id')
+        self.manufacturer_group_id = attributes[:'manufacturer_group_id']
+      end
+
+      if attributes.key?(:'manufacturer_group_name')
+        self.manufacturer_group_name = attributes[:'manufacturer_group_name']
+      end
+
+      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
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    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 &&
+          biomarker_token == o.biomarker_token &&
+          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 &&
+          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
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def 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
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = PharmaObservatory.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end