pharmaobservatory 0.1.6 → 0.1.8

data/lib/pharmaobservatory/models/rare_disease_site_coverage_row.rb

@@ -0,0 +1,421 @@
+=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_site_coverage dataset: one row per rare disease concept, unconditionally. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RareDiseaseSiteCoverageRow
+    # 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
+
+    # Whether the concept is a group of disorders, a disorder or a subtype.
+    attr_accessor :concept_type
+
+    # The date of the registry snapshot.
+    attr_accessor :snapshot_date
+
+    # How far the exact arm reaches: no_mapping, no_trials, no_site_data or computed.
+    attr_accessor :exact_state
+
+    # MeSH conditions the disease maps to under the exact arm.
+    attr_accessor :exact_n_conditions
+
+    # Trials linked under the exact arm.
+    attr_accessor :exact_n_trials
+
+    # Trials of the exact arm with at least one geocoded site.
+    attr_accessor :exact_n_trials_with_site
+
+    # Distinct sites of the exact arm.
+    attr_accessor :exact_n_sites_total
+
+    # Sites of the exact arm published in rare_disease_trial_sites (capped at 500 per disease and arm).
+    attr_accessor :exact_n_sites_emitted
+
+    # Published sites of the exact arm that carry a coordinate.
+    attr_accessor :exact_n_sites_emitted_geocoded
+
+    # Facility listings of the exact arm with no coordinate.
+    attr_accessor :exact_n_facilities_ungeocoded
+
+    # How far the unspecified arm reaches: no_mapping, no_trials, no_site_data or computed.
+    attr_accessor :unspecified_state
+
+    # MeSH conditions the disease maps to under the unspecified arm.
+    attr_accessor :unspecified_n_conditions
+
+    # Trials linked under the unspecified arm.
+    attr_accessor :unspecified_n_trials
+
+    # Trials of the unspecified arm with at least one geocoded site.
+    attr_accessor :unspecified_n_trials_with_site
+
+    # Distinct sites of the unspecified arm.
+    attr_accessor :unspecified_n_sites_total
+
+    # Sites of the unspecified arm published in rare_disease_trial_sites (capped at 500 per disease and arm).
+    attr_accessor :unspecified_n_sites_emitted
+
+    # Published sites of the unspecified arm that carry a coordinate.
+    attr_accessor :unspecified_n_sites_emitted_geocoded
+
+    # Facility listings of the unspecified arm with no coordinate.
+    attr_accessor :unspecified_n_facilities_ungeocoded
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'orpha_code' => :'orpha_code',
+        :'concept_type' => :'concept_type',
+        :'snapshot_date' => :'snapshot_date',
+        :'exact_state' => :'exact_state',
+        :'exact_n_conditions' => :'exact_n_conditions',
+        :'exact_n_trials' => :'exact_n_trials',
+        :'exact_n_trials_with_site' => :'exact_n_trials_with_site',
+        :'exact_n_sites_total' => :'exact_n_sites_total',
+        :'exact_n_sites_emitted' => :'exact_n_sites_emitted',
+        :'exact_n_sites_emitted_geocoded' => :'exact_n_sites_emitted_geocoded',
+        :'exact_n_facilities_ungeocoded' => :'exact_n_facilities_ungeocoded',
+        :'unspecified_state' => :'unspecified_state',
+        :'unspecified_n_conditions' => :'unspecified_n_conditions',
+        :'unspecified_n_trials' => :'unspecified_n_trials',
+        :'unspecified_n_trials_with_site' => :'unspecified_n_trials_with_site',
+        :'unspecified_n_sites_total' => :'unspecified_n_sites_total',
+        :'unspecified_n_sites_emitted' => :'unspecified_n_sites_emitted',
+        :'unspecified_n_sites_emitted_geocoded' => :'unspecified_n_sites_emitted_geocoded',
+        :'unspecified_n_facilities_ungeocoded' => :'unspecified_n_facilities_ungeocoded'
+      }
+    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',
+        :'concept_type' => :'String',
+        :'snapshot_date' => :'Date',
+        :'exact_state' => :'String',
+        :'exact_n_conditions' => :'Integer',
+        :'exact_n_trials' => :'Integer',
+        :'exact_n_trials_with_site' => :'Integer',
+        :'exact_n_sites_total' => :'Integer',
+        :'exact_n_sites_emitted' => :'Integer',
+        :'exact_n_sites_emitted_geocoded' => :'Integer',
+        :'exact_n_facilities_ungeocoded' => :'Integer',
+        :'unspecified_state' => :'String',
+        :'unspecified_n_conditions' => :'Integer',
+        :'unspecified_n_trials' => :'Integer',
+        :'unspecified_n_trials_with_site' => :'Integer',
+        :'unspecified_n_sites_total' => :'Integer',
+        :'unspecified_n_sites_emitted' => :'Integer',
+        :'unspecified_n_sites_emitted_geocoded' => :'Integer',
+        :'unspecified_n_facilities_ungeocoded' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'orpha_code',
+        :'concept_type',
+        :'snapshot_date',
+        :'exact_state',
+        :'exact_n_conditions',
+        :'exact_n_trials',
+        :'exact_n_trials_with_site',
+        :'exact_n_sites_total',
+        :'exact_n_sites_emitted',
+        :'exact_n_sites_emitted_geocoded',
+        :'exact_n_facilities_ungeocoded',
+        :'unspecified_state',
+        :'unspecified_n_conditions',
+        :'unspecified_n_trials',
+        :'unspecified_n_trials_with_site',
+        :'unspecified_n_sites_total',
+        :'unspecified_n_sites_emitted',
+        :'unspecified_n_sites_emitted_geocoded',
+        :'unspecified_n_facilities_ungeocoded'
+      ])
+    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::RareDiseaseSiteCoverageRow` 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::RareDiseaseSiteCoverageRow`. 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?(:'concept_type')
+        self.concept_type = attributes[:'concept_type']
+      end
+
+      if attributes.key?(:'snapshot_date')
+        self.snapshot_date = attributes[:'snapshot_date']
+      end
+
+      if attributes.key?(:'exact_state')
+        self.exact_state = attributes[:'exact_state']
+      end
+
+      if attributes.key?(:'exact_n_conditions')
+        self.exact_n_conditions = attributes[:'exact_n_conditions']
+      end
+
+      if attributes.key?(:'exact_n_trials')
+        self.exact_n_trials = attributes[:'exact_n_trials']
+      end
+
+      if attributes.key?(:'exact_n_trials_with_site')
+        self.exact_n_trials_with_site = attributes[:'exact_n_trials_with_site']
+      end
+
+      if attributes.key?(:'exact_n_sites_total')
+        self.exact_n_sites_total = attributes[:'exact_n_sites_total']
+      end
+
+      if attributes.key?(:'exact_n_sites_emitted')
+        self.exact_n_sites_emitted = attributes[:'exact_n_sites_emitted']
+      end
+
+      if attributes.key?(:'exact_n_sites_emitted_geocoded')
+        self.exact_n_sites_emitted_geocoded = attributes[:'exact_n_sites_emitted_geocoded']
+      end
+
+      if attributes.key?(:'exact_n_facilities_ungeocoded')
+        self.exact_n_facilities_ungeocoded = attributes[:'exact_n_facilities_ungeocoded']
+      end
+
+      if attributes.key?(:'unspecified_state')
+        self.unspecified_state = attributes[:'unspecified_state']
+      end
+
+      if attributes.key?(:'unspecified_n_conditions')
+        self.unspecified_n_conditions = attributes[:'unspecified_n_conditions']
+      end
+
+      if attributes.key?(:'unspecified_n_trials')
+        self.unspecified_n_trials = attributes[:'unspecified_n_trials']
+      end
+
+      if attributes.key?(:'unspecified_n_trials_with_site')
+        self.unspecified_n_trials_with_site = attributes[:'unspecified_n_trials_with_site']
+      end
+
+      if attributes.key?(:'unspecified_n_sites_total')
+        self.unspecified_n_sites_total = attributes[:'unspecified_n_sites_total']
+      end
+
+      if attributes.key?(:'unspecified_n_sites_emitted')
+        self.unspecified_n_sites_emitted = attributes[:'unspecified_n_sites_emitted']
+      end
+
+      if attributes.key?(:'unspecified_n_sites_emitted_geocoded')
+        self.unspecified_n_sites_emitted_geocoded = attributes[:'unspecified_n_sites_emitted_geocoded']
+      end
+
+      if attributes.key?(:'unspecified_n_facilities_ungeocoded')
+        self.unspecified_n_facilities_ungeocoded = attributes[:'unspecified_n_facilities_ungeocoded']
+      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 &&
+          concept_type == o.concept_type &&
+          snapshot_date == o.snapshot_date &&
+          exact_state == o.exact_state &&
+          exact_n_conditions == o.exact_n_conditions &&
+          exact_n_trials == o.exact_n_trials &&
+          exact_n_trials_with_site == o.exact_n_trials_with_site &&
+          exact_n_sites_total == o.exact_n_sites_total &&
+          exact_n_sites_emitted == o.exact_n_sites_emitted &&
+          exact_n_sites_emitted_geocoded == o.exact_n_sites_emitted_geocoded &&
+          exact_n_facilities_ungeocoded == o.exact_n_facilities_ungeocoded &&
+          unspecified_state == o.unspecified_state &&
+          unspecified_n_conditions == o.unspecified_n_conditions &&
+          unspecified_n_trials == o.unspecified_n_trials &&
+          unspecified_n_trials_with_site == o.unspecified_n_trials_with_site &&
+          unspecified_n_sites_total == o.unspecified_n_sites_total &&
+          unspecified_n_sites_emitted == o.unspecified_n_sites_emitted &&
+          unspecified_n_sites_emitted_geocoded == o.unspecified_n_sites_emitted_geocoded &&
+          unspecified_n_facilities_ungeocoded == o.unspecified_n_facilities_ungeocoded
+    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, concept_type, snapshot_date, exact_state, exact_n_conditions, exact_n_trials, exact_n_trials_with_site, exact_n_sites_total, exact_n_sites_emitted, exact_n_sites_emitted_geocoded, exact_n_facilities_ungeocoded, unspecified_state, unspecified_n_conditions, unspecified_n_trials, unspecified_n_trials_with_site, unspecified_n_sites_total, unspecified_n_sites_emitted, unspecified_n_sites_emitted_geocoded, unspecified_n_facilities_ungeocoded].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