pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/rare_disease_trial_sites_row.rb

@@ -0,0 +1,412 @@
+=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_trial_sites dataset: one row per disease, mapping arm and site. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RareDiseaseTrialSitesRow
+    # 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
+
+    # exact or unspecified: the mapping arm the site's trials belong to.
+    attr_accessor :mapping_arm
+
+    # The site key: one facility spelling from the registry; joins the sites dataset.
+    attr_accessor :site_id
+
+    # The site's rank by trial count within its disease and arm (1 is the most trials); a position in a list, not a quality score.
+    attr_accessor :site_rank
+
+    # The facility name as filed in the registry.
+    attr_accessor :site_name
+
+    # The facility's city as filed.
+    attr_accessor :city
+
+    # The facility's state or region as filed.
+    attr_accessor :state
+
+    # The facility's country as filed.
+    attr_accessor :country
+
+    # The site's latitude in degrees; null when no coordinate is known.
+    attr_accessor :latitude
+
+    # The site's longitude in degrees; null when no coordinate is known.
+    attr_accessor :longitude
+
+    # The source of the coordinate: aact (the registry's own), geonames (GeoNames) or als (Amazon Location Service).
+    attr_accessor :coord_source
+
+    # The MeSH condition ids through which the disease reaches the site's trials.
+    attr_accessor :condition_ids
+
+    # Registered trials of this disease and arm that list the site.
+    attr_accessor :n_trials
+
+    # Those trials whose own condition list names the mapped condition.
+    attr_accessor :n_trials_direct
+
+    # Those trials that are recruiting, not yet recruiting, active or enrolling by invitation.
+    attr_accessor :n_active_trials
+
+    # The earliest start year among those trials.
+    attr_accessor :first_trial_year
+
+    # The latest start year among those trials.
+    attr_accessor :last_trial_year
+
+    # The latest registry update among those trials.
+    attr_accessor :last_update_posted_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'orpha_code' => :'orpha_code',
+        :'mapping_arm' => :'mapping_arm',
+        :'site_id' => :'site_id',
+        :'site_rank' => :'site_rank',
+        :'site_name' => :'site_name',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'country' => :'country',
+        :'latitude' => :'latitude',
+        :'longitude' => :'longitude',
+        :'coord_source' => :'coord_source',
+        :'condition_ids' => :'condition_ids',
+        :'n_trials' => :'n_trials',
+        :'n_trials_direct' => :'n_trials_direct',
+        :'n_active_trials' => :'n_active_trials',
+        :'first_trial_year' => :'first_trial_year',
+        :'last_trial_year' => :'last_trial_year',
+        :'last_update_posted_date' => :'last_update_posted_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
+      {
+        :'orpha_code' => :'String',
+        :'mapping_arm' => :'String',
+        :'site_id' => :'String',
+        :'site_rank' => :'Integer',
+        :'site_name' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'country' => :'String',
+        :'latitude' => :'Float',
+        :'longitude' => :'Float',
+        :'coord_source' => :'String',
+        :'condition_ids' => :'Array<String>',
+        :'n_trials' => :'Integer',
+        :'n_trials_direct' => :'Integer',
+        :'n_active_trials' => :'Integer',
+        :'first_trial_year' => :'Integer',
+        :'last_trial_year' => :'Integer',
+        :'last_update_posted_date' => :'Date'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'orpha_code',
+        :'mapping_arm',
+        :'site_id',
+        :'site_rank',
+        :'site_name',
+        :'city',
+        :'state',
+        :'country',
+        :'latitude',
+        :'longitude',
+        :'coord_source',
+        :'condition_ids',
+        :'n_trials',
+        :'n_trials_direct',
+        :'n_active_trials',
+        :'first_trial_year',
+        :'last_trial_year',
+        :'last_update_posted_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::RareDiseaseTrialSitesRow` 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::RareDiseaseTrialSitesRow`. 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?(:'mapping_arm')
+        self.mapping_arm = attributes[:'mapping_arm']
+      end
+
+      if attributes.key?(:'site_id')
+        self.site_id = attributes[:'site_id']
+      end
+
+      if attributes.key?(:'site_rank')
+        self.site_rank = attributes[:'site_rank']
+      end
+
+      if attributes.key?(:'site_name')
+        self.site_name = attributes[:'site_name']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'latitude')
+        self.latitude = attributes[:'latitude']
+      end
+
+      if attributes.key?(:'longitude')
+        self.longitude = attributes[:'longitude']
+      end
+
+      if attributes.key?(:'coord_source')
+        self.coord_source = attributes[:'coord_source']
+      end
+
+      if attributes.key?(:'condition_ids')
+        if (value = attributes[:'condition_ids']).is_a?(Array)
+          self.condition_ids = value
+        end
+      end
+
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
+      end
+
+      if attributes.key?(:'n_trials_direct')
+        self.n_trials_direct = attributes[:'n_trials_direct']
+      end
+
+      if attributes.key?(:'n_active_trials')
+        self.n_active_trials = attributes[:'n_active_trials']
+      end
+
+      if attributes.key?(:'first_trial_year')
+        self.first_trial_year = attributes[:'first_trial_year']
+      end
+
+      if attributes.key?(:'last_trial_year')
+        self.last_trial_year = attributes[:'last_trial_year']
+      end
+
+      if attributes.key?(:'last_update_posted_date')
+        self.last_update_posted_date = attributes[:'last_update_posted_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 &&
+          orpha_code == o.orpha_code &&
+          mapping_arm == o.mapping_arm &&
+          site_id == o.site_id &&
+          site_rank == o.site_rank &&
+          site_name == o.site_name &&
+          city == o.city &&
+          state == o.state &&
+          country == o.country &&
+          latitude == o.latitude &&
+          longitude == o.longitude &&
+          coord_source == o.coord_source &&
+          condition_ids == o.condition_ids &&
+          n_trials == o.n_trials &&
+          n_trials_direct == o.n_trials_direct &&
+          n_active_trials == o.n_active_trials &&
+          first_trial_year == o.first_trial_year &&
+          last_trial_year == o.last_trial_year &&
+          last_update_posted_date == o.last_update_posted_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
+      [orpha_code, mapping_arm, site_id, site_rank, site_name, city, state, country, latitude, longitude, coord_source, condition_ids, n_trials, n_trials_direct, n_active_trials, first_trial_year, last_trial_year, last_update_posted_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