pharmaobservatory 0.1.3 → 0.1.4

data/lib/pharmaobservatory/models/condition_prevalence_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 condition_prevalence dataset: one row per prevalence figure and condition mapping. A grouped request returns the group columns and the measures instead, as additional properties.
+  class ConditionPrevalenceRow
+    # The figure's key.
+    attr_accessor :disease_prevalence_id
+
+    # The condition key, a MeSH (Medical Subject Headings) descriptor id (D followed by six to nine digits).
+    attr_accessor :condition_id
+
+    # The condition's MeSH heading.
+    attr_accessor :condition_name
+
+    # How the figure's disease maps to the condition: exact, narrower, broader, undetermined or unspecified.
+    attr_accessor :condition_mapping_relation
+
+    # The rare disease key of the figure's disease (orpha:<code>).
+    attr_accessor :disease_id
+
+    # The disease's name in the source.
+    attr_accessor :disease_name
+
+    # The Orphanet disease number.
+    attr_accessor :orpha_code
+
+    # What the figure measures: point_prevalence, lifetime_prevalence, annual_incidence, prevalence_at_birth or cases_families.
+    attr_accessor :prevalence_type
+
+    # The source's prevalence band, as filed.
+    attr_accessor :prevalence_class
+
+    # Lower bound of the prevalence band as a ratio of the population (0.0001 is 1 in 10,000).
+    attr_accessor :prevalence_lower_bound
+
+    # Upper bound of the prevalence band as a ratio of the population (0.0005 is 5 in 10,000).
+    attr_accessor :prevalence_upper_bound
+
+    # The population size the source states the band against (for example 10000 for a band per 10,000 persons).
+    attr_accessor :population_denominator
+
+    # The unit of the population denominator.
+    attr_accessor :population_unit
+
+    # The source's qualification of the figure (class_only, value_and_class and so on).
+    attr_accessor :qualification
+
+    # The source's validation status for the figure (validated or not_yet_validated).
+    attr_accessor :validation_status
+
+    # The geography the figure describes, as the source states it.
+    attr_accessor :geography
+
+    # US, EU or GB where the geography is that jurisdiction; null otherwise.
+    attr_accessor :jurisdiction_code
+
+    # The date the source assigns to the observation.
+    attr_accessor :observation_date
+
+    # The date of the source release the figure was read from.
+    attr_accessor :source_snapshot_date
+
+    # The publication reference the source cites for the figure.
+    attr_accessor :source
+
+    # The source release URL.
+    attr_accessor :source_url
+
+    # The figure's licence.
+    attr_accessor :license_name
+
+    # The credit line the licence requires.
+    attr_accessor :attribution
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'disease_prevalence_id' => :'disease_prevalence_id',
+        :'condition_id' => :'condition_id',
+        :'condition_name' => :'condition_name',
+        :'condition_mapping_relation' => :'condition_mapping_relation',
+        :'disease_id' => :'disease_id',
+        :'disease_name' => :'disease_name',
+        :'orpha_code' => :'orpha_code',
+        :'prevalence_type' => :'prevalence_type',
+        :'prevalence_class' => :'prevalence_class',
+        :'prevalence_lower_bound' => :'prevalence_lower_bound',
+        :'prevalence_upper_bound' => :'prevalence_upper_bound',
+        :'population_denominator' => :'population_denominator',
+        :'population_unit' => :'population_unit',
+        :'qualification' => :'qualification',
+        :'validation_status' => :'validation_status',
+        :'geography' => :'geography',
+        :'jurisdiction_code' => :'jurisdiction_code',
+        :'observation_date' => :'observation_date',
+        :'source_snapshot_date' => :'source_snapshot_date',
+        :'source' => :'source',
+        :'source_url' => :'source_url',
+        :'license_name' => :'license_name',
+        :'attribution' => :'attribution'
+      }
+    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
+      {
+        :'disease_prevalence_id' => :'String',
+        :'condition_id' => :'String',
+        :'condition_name' => :'String',
+        :'condition_mapping_relation' => :'String',
+        :'disease_id' => :'String',
+        :'disease_name' => :'String',
+        :'orpha_code' => :'String',
+        :'prevalence_type' => :'String',
+        :'prevalence_class' => :'String',
+        :'prevalence_lower_bound' => :'Float',
+        :'prevalence_upper_bound' => :'Float',
+        :'population_denominator' => :'Float',
+        :'population_unit' => :'String',
+        :'qualification' => :'String',
+        :'validation_status' => :'String',
+        :'geography' => :'String',
+        :'jurisdiction_code' => :'String',
+        :'observation_date' => :'Date',
+        :'source_snapshot_date' => :'Date',
+        :'source' => :'String',
+        :'source_url' => :'String',
+        :'license_name' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'disease_prevalence_id',
+        :'condition_id',
+        :'condition_name',
+        :'condition_mapping_relation',
+        :'disease_id',
+        :'disease_name',
+        :'orpha_code',
+        :'prevalence_type',
+        :'prevalence_class',
+        :'prevalence_lower_bound',
+        :'prevalence_upper_bound',
+        :'population_denominator',
+        :'population_unit',
+        :'qualification',
+        :'validation_status',
+        :'geography',
+        :'jurisdiction_code',
+        :'observation_date',
+        :'source_snapshot_date',
+        :'source',
+        :'source_url',
+        :'license_name',
+        :'attribution'
+      ])
+    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::ConditionPrevalenceRow` 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::ConditionPrevalenceRow`. 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?(:'disease_prevalence_id')
+        self.disease_prevalence_id = attributes[:'disease_prevalence_id']
+      end
+
+      if attributes.key?(:'condition_id')
+        self.condition_id = attributes[:'condition_id']
+      end
+
+      if attributes.key?(:'condition_name')
+        self.condition_name = attributes[:'condition_name']
+      end
+
+      if attributes.key?(:'condition_mapping_relation')
+        self.condition_mapping_relation = attributes[:'condition_mapping_relation']
+      end
+
+      if attributes.key?(:'disease_id')
+        self.disease_id = attributes[:'disease_id']
+      end
+
+      if attributes.key?(:'disease_name')
+        self.disease_name = attributes[:'disease_name']
+      end
+
+      if attributes.key?(:'orpha_code')
+        self.orpha_code = attributes[:'orpha_code']
+      end
+
+      if attributes.key?(:'prevalence_type')
+        self.prevalence_type = attributes[:'prevalence_type']
+      end
+
+      if attributes.key?(:'prevalence_class')
+        self.prevalence_class = attributes[:'prevalence_class']
+      end
+
+      if attributes.key?(:'prevalence_lower_bound')
+        self.prevalence_lower_bound = attributes[:'prevalence_lower_bound']
+      end
+
+      if attributes.key?(:'prevalence_upper_bound')
+        self.prevalence_upper_bound = attributes[:'prevalence_upper_bound']
+      end
+
+      if attributes.key?(:'population_denominator')
+        self.population_denominator = attributes[:'population_denominator']
+      end
+
+      if attributes.key?(:'population_unit')
+        self.population_unit = attributes[:'population_unit']
+      end
+
+      if attributes.key?(:'qualification')
+        self.qualification = attributes[:'qualification']
+      end
+
+      if attributes.key?(:'validation_status')
+        self.validation_status = attributes[:'validation_status']
+      end
+
+      if attributes.key?(:'geography')
+        self.geography = attributes[:'geography']
+      end
+
+      if attributes.key?(:'jurisdiction_code')
+        self.jurisdiction_code = attributes[:'jurisdiction_code']
+      end
+
+      if attributes.key?(:'observation_date')
+        self.observation_date = attributes[:'observation_date']
+      end
+
+      if attributes.key?(:'source_snapshot_date')
+        self.source_snapshot_date = attributes[:'source_snapshot_date']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'license_name')
+        self.license_name = attributes[:'license_name']
+      end
+
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      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 &&
+          disease_prevalence_id == o.disease_prevalence_id &&
+          condition_id == o.condition_id &&
+          condition_name == o.condition_name &&
+          condition_mapping_relation == o.condition_mapping_relation &&
+          disease_id == o.disease_id &&
+          disease_name == o.disease_name &&
+          orpha_code == o.orpha_code &&
+          prevalence_type == o.prevalence_type &&
+          prevalence_class == o.prevalence_class &&
+          prevalence_lower_bound == o.prevalence_lower_bound &&
+          prevalence_upper_bound == o.prevalence_upper_bound &&
+          population_denominator == o.population_denominator &&
+          population_unit == o.population_unit &&
+          qualification == o.qualification &&
+          validation_status == o.validation_status &&
+          geography == o.geography &&
+          jurisdiction_code == o.jurisdiction_code &&
+          observation_date == o.observation_date &&
+          source_snapshot_date == o.source_snapshot_date &&
+          source == o.source &&
+          source_url == o.source_url &&
+          license_name == o.license_name &&
+          attribution == o.attribution
+    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
+      [disease_prevalence_id, condition_id, condition_name, condition_mapping_relation, disease_id, disease_name, orpha_code, prevalence_type, prevalence_class, prevalence_lower_bound, prevalence_upper_bound, population_denominator, population_unit, qualification, validation_status, geography, jurisdiction_code, observation_date, source_snapshot_date, source, source_url, license_name, attribution].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