pharmaobservatory 0.1.1 → 0.1.3

data/lib/pharmaobservatory/models/biomarker_bqp_assertions_row.rb

@@ -0,0 +1,465 @@
+=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_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
+
+    # 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
+
+    # Display name of the submitter's company.
+    attr_accessor :submitter_company_name
+
+    # 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
+
+    # 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',
+        :'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',
+        :'biomarker_role_method' => :'biomarker_role_method',
+        :'is_surrogate_endpoint_claim' => :'is_surrogate_endpoint_claim',
+        :'source_url' => :'source_url',
+        :'snapshot_date' => :'snapshot_date'
+      }
+    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',
+        :'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',
+        :'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',
+        :'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([
+        :'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
+
+    # 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::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::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']
+      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']
+      end
+
+      if attributes.key?(:'bqp_signal')
+        self.bqp_signal = attributes[:'bqp_signal']
+      end
+
+      if attributes.key?(:'is_fda_qualified')
+        self.is_fda_qualified = attributes[:'is_fda_qualified']
+      end
+
+      if attributes.key?(:'submission_status')
+        self.submission_status = attributes[:'submission_status']
+      end
+
+      if attributes.key?(:'submission_stage')
+        self.submission_stage = attributes[:'submission_stage']
+      end
+
+      if attributes.key?(:'submitter_name')
+        self.submitter_name = attributes[:'submitter_name']
+      end
+
+      if attributes.key?(:'submitter_org_id')
+        self.submitter_org_id = attributes[:'submitter_org_id']
+      end
+
+      if attributes.key?(:'submitter_company_id')
+        self.submitter_company_id = attributes[:'submitter_company_id']
+      end
+
+      if attributes.key?(:'submitter_company_name')
+        self.submitter_company_name = attributes[:'submitter_company_name']
+      end
+
+      if attributes.key?(:'submitter_group_id')
+        self.submitter_group_id = attributes[:'submitter_group_id']
+      end
+
+      if attributes.key?(:'submitter_group_name')
+        self.submitter_group_name = attributes[:'submitter_group_name']
+      end
+
+      if attributes.key?(:'submitter_match_tier')
+        self.submitter_match_tier = attributes[:'submitter_match_tier']
+      end
+
+      if attributes.key?(:'submitter_role')
+        self.submitter_role = attributes[:'submitter_role']
+      end
+
+      if attributes.key?(:'biomarker_role')
+        self.biomarker_role = attributes[:'biomarker_role']
+      end
+
+      if attributes.key?(:'biomarker_role_method')
+        self.biomarker_role_method = attributes[:'biomarker_role_method']
+      end
+
+      if attributes.key?(:'is_surrogate_endpoint_claim')
+        self.is_surrogate_endpoint_claim = attributes[:'is_surrogate_endpoint_claim']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      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
+
+    # 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 &&
+          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 &&
+          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 &&
+          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
+    # @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, 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
+    # @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