pharmaobservatory 0.1.6 → 0.1.8

data/lib/pharmaobservatory/models/rare_disease_investigators_row.rb

@@ -0,0 +1,436 @@
+=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 rare_disease_investigators dataset: one row per disease and principal investigator on a directly mapped trial. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RareDiseaseInvestigatorsRow
+    # The ORPHA code of the disease, the digits in the web page address (/rare-diseases/558). The entry key of the rare_diseases object type.
+    attr_accessor :orpha_code
+
+    # The disease's preferred English name.
+    attr_accessor :disease_name
+
+    # The investigator's resolved person key.
+    attr_accessor :investigator_person_id
+
+    # The investigator's name as the registry filed it.
+    attr_accessor :investigator_person_name
+
+    # What the person's identity rests on: curated, npi, orcid, reporter, affinity or self.
+    attr_accessor :identity_basis
+
+    # Name fragments merged into this person.
+    attr_accessor :merged_fragment_count
+
+    # True when another investigator of the same disease shares the name.
+    attr_accessor :name_is_ambiguous_in_disease
+
+    # Exact direct trials of the disease that name the person as principal investigator.
+    attr_accessor :pi_trial_count
+
+    # The earliest start date among those trials.
+    attr_accessor :first_trial_start_date
+
+    # The latest start date among those trials.
+    attr_accessor :last_trial_start_date
+
+    # The year of the latest start.
+    attr_accessor :last_trial_start_year
+
+    # One of the trials that names the person (the latest started).
+    attr_accessor :evidence_trial_id
+
+    # The latest registry update among those trials.
+    attr_accessor :last_record_update_date
+
+    # The registry's latest update date the snapshot reflects.
+    attr_accessor :registry_reference_date
+
+    # How recent the latest trial start is against the registry snapshot: within_5_years, 5_to_10_years, over_10_years or no_start_date.
+    attr_accessor :recency_state
+
+    # The sites of the person's trials as the registry lists them.
+    attr_accessor :trial_site_names
+
+    # How many such sites.
+    attr_accessor :trial_site_count
+
+    # The affiliations the registry states for the person.
+    attr_accessor :stated_affiliations
+
+    # How many stated affiliations.
+    attr_accessor :stated_affiliation_count
+
+    # trial_site when a trial site is listed, stated_affiliation_only when only an affiliation is stated, none otherwise.
+    attr_accessor :affiliation_evidence
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'orpha_code' => :'orpha_code',
+        :'disease_name' => :'disease_name',
+        :'investigator_person_id' => :'investigator_person_id',
+        :'investigator_person_name' => :'investigator_person_name',
+        :'identity_basis' => :'identity_basis',
+        :'merged_fragment_count' => :'merged_fragment_count',
+        :'name_is_ambiguous_in_disease' => :'name_is_ambiguous_in_disease',
+        :'pi_trial_count' => :'pi_trial_count',
+        :'first_trial_start_date' => :'first_trial_start_date',
+        :'last_trial_start_date' => :'last_trial_start_date',
+        :'last_trial_start_year' => :'last_trial_start_year',
+        :'evidence_trial_id' => :'evidence_trial_id',
+        :'last_record_update_date' => :'last_record_update_date',
+        :'registry_reference_date' => :'registry_reference_date',
+        :'recency_state' => :'recency_state',
+        :'trial_site_names' => :'trial_site_names',
+        :'trial_site_count' => :'trial_site_count',
+        :'stated_affiliations' => :'stated_affiliations',
+        :'stated_affiliation_count' => :'stated_affiliation_count',
+        :'affiliation_evidence' => :'affiliation_evidence'
+      }
+    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
+      {
+        :'orpha_code' => :'String',
+        :'disease_name' => :'String',
+        :'investigator_person_id' => :'String',
+        :'investigator_person_name' => :'String',
+        :'identity_basis' => :'String',
+        :'merged_fragment_count' => :'Integer',
+        :'name_is_ambiguous_in_disease' => :'Boolean',
+        :'pi_trial_count' => :'Integer',
+        :'first_trial_start_date' => :'Date',
+        :'last_trial_start_date' => :'Date',
+        :'last_trial_start_year' => :'Integer',
+        :'evidence_trial_id' => :'String',
+        :'last_record_update_date' => :'Date',
+        :'registry_reference_date' => :'Date',
+        :'recency_state' => :'String',
+        :'trial_site_names' => :'Array<String>',
+        :'trial_site_count' => :'Integer',
+        :'stated_affiliations' => :'Array<String>',
+        :'stated_affiliation_count' => :'Integer',
+        :'affiliation_evidence' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'orpha_code',
+        :'disease_name',
+        :'investigator_person_id',
+        :'investigator_person_name',
+        :'identity_basis',
+        :'merged_fragment_count',
+        :'name_is_ambiguous_in_disease',
+        :'pi_trial_count',
+        :'first_trial_start_date',
+        :'last_trial_start_date',
+        :'last_trial_start_year',
+        :'evidence_trial_id',
+        :'last_record_update_date',
+        :'registry_reference_date',
+        :'recency_state',
+        :'trial_site_names',
+        :'trial_site_count',
+        :'stated_affiliations',
+        :'stated_affiliation_count',
+        :'affiliation_evidence'
+      ])
+    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::RareDiseaseInvestigatorsRow` 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::RareDiseaseInvestigatorsRow`. 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?(:'orpha_code')
+        self.orpha_code = attributes[:'orpha_code']
+      end
+
+      if attributes.key?(:'disease_name')
+        self.disease_name = attributes[:'disease_name']
+      end
+
+      if attributes.key?(:'investigator_person_id')
+        self.investigator_person_id = attributes[:'investigator_person_id']
+      end
+
+      if attributes.key?(:'investigator_person_name')
+        self.investigator_person_name = attributes[:'investigator_person_name']
+      end
+
+      if attributes.key?(:'identity_basis')
+        self.identity_basis = attributes[:'identity_basis']
+      end
+
+      if attributes.key?(:'merged_fragment_count')
+        self.merged_fragment_count = attributes[:'merged_fragment_count']
+      end
+
+      if attributes.key?(:'name_is_ambiguous_in_disease')
+        self.name_is_ambiguous_in_disease = attributes[:'name_is_ambiguous_in_disease']
+      end
+
+      if attributes.key?(:'pi_trial_count')
+        self.pi_trial_count = attributes[:'pi_trial_count']
+      end
+
+      if attributes.key?(:'first_trial_start_date')
+        self.first_trial_start_date = attributes[:'first_trial_start_date']
+      end
+
+      if attributes.key?(:'last_trial_start_date')
+        self.last_trial_start_date = attributes[:'last_trial_start_date']
+      end
+
+      if attributes.key?(:'last_trial_start_year')
+        self.last_trial_start_year = attributes[:'last_trial_start_year']
+      end
+
+      if attributes.key?(:'evidence_trial_id')
+        self.evidence_trial_id = attributes[:'evidence_trial_id']
+      end
+
+      if attributes.key?(:'last_record_update_date')
+        self.last_record_update_date = attributes[:'last_record_update_date']
+      end
+
+      if attributes.key?(:'registry_reference_date')
+        self.registry_reference_date = attributes[:'registry_reference_date']
+      end
+
+      if attributes.key?(:'recency_state')
+        self.recency_state = attributes[:'recency_state']
+      end
+
+      if attributes.key?(:'trial_site_names')
+        if (value = attributes[:'trial_site_names']).is_a?(Array)
+          self.trial_site_names = value
+        end
+      end
+
+      if attributes.key?(:'trial_site_count')
+        self.trial_site_count = attributes[:'trial_site_count']
+      end
+
+      if attributes.key?(:'stated_affiliations')
+        if (value = attributes[:'stated_affiliations']).is_a?(Array)
+          self.stated_affiliations = value
+        end
+      end
+
+      if attributes.key?(:'stated_affiliation_count')
+        self.stated_affiliation_count = attributes[:'stated_affiliation_count']
+      end
+
+      if attributes.key?(:'affiliation_evidence')
+        self.affiliation_evidence = attributes[:'affiliation_evidence']
+      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 &&
+          orpha_code == o.orpha_code &&
+          disease_name == o.disease_name &&
+          investigator_person_id == o.investigator_person_id &&
+          investigator_person_name == o.investigator_person_name &&
+          identity_basis == o.identity_basis &&
+          merged_fragment_count == o.merged_fragment_count &&
+          name_is_ambiguous_in_disease == o.name_is_ambiguous_in_disease &&
+          pi_trial_count == o.pi_trial_count &&
+          first_trial_start_date == o.first_trial_start_date &&
+          last_trial_start_date == o.last_trial_start_date &&
+          last_trial_start_year == o.last_trial_start_year &&
+          evidence_trial_id == o.evidence_trial_id &&
+          last_record_update_date == o.last_record_update_date &&
+          registry_reference_date == o.registry_reference_date &&
+          recency_state == o.recency_state &&
+          trial_site_names == o.trial_site_names &&
+          trial_site_count == o.trial_site_count &&
+          stated_affiliations == o.stated_affiliations &&
+          stated_affiliation_count == o.stated_affiliation_count &&
+          affiliation_evidence == o.affiliation_evidence
+    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
+      [orpha_code, disease_name, investigator_person_id, investigator_person_name, identity_basis, merged_fragment_count, name_is_ambiguous_in_disease, pi_trial_count, first_trial_start_date, last_trial_start_date, last_trial_start_year, evidence_trial_id, last_record_update_date, registry_reference_date, recency_state, trial_site_names, trial_site_count, stated_affiliations, stated_affiliation_count, affiliation_evidence].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