pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/company_trial_sites_row.rb

@@ -0,0 +1,410 @@
+=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 company_trial_sites dataset: one row per company and located site of the trials it leads. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyTrialSitesRow
+    # The company key (company:<key>) of the lead sponsor.
+    attr_accessor :company_id
+
+    # Display name of the company.
+    attr_accessor :company_name
+
+    # Group level: the current ultimate parent company; a root company's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the group.
+    attr_accessor :group_name
+
+    # The Clinical Research Map's organization key for these rows: the group when it is a public roster root, else the company when it is one, else null.
+    attr_accessor :roster_root_id
+
+    # The site key: one facility spelling from the registry; the id the site page address carries.
+    attr_accessor :site_id
+
+    # The facility name as filed in the registry.
+    attr_accessor :facility_name
+
+    # City as filed.
+    attr_accessor :city
+
+    # State or province as filed.
+    attr_accessor :state
+
+    # Country name as filed.
+    attr_accessor :country
+
+    # ISO 3166-1 alpha-2 code of the site's country, from the registry's country name; null when the name resolves to no country.
+    attr_accessor :site_country_code
+
+    # Latitude of the finest coordinate the site record has.
+    attr_accessor :latitude
+
+    # Longitude of the finest coordinate the site record has.
+    attr_accessor :longitude
+
+    # How finely the coordinate places the site (city, postal and so on).
+    attr_accessor :geo_precision
+
+    # The source of the coordinate: aact (the registry's own), geonames (GeoNames) or als (Amazon Location Service).
+    attr_accessor :coord_source
+
+    # Distinct trials the company leads that list the site.
+    attr_accessor :n_trials
+
+    # 1 is the company's busiest located site (most led trials, then site key); dense per company.
+    attr_accessor :site_rank
+
+    # The company's located site count, repeated on each of its rows.
+    attr_accessor :n_sites
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'roster_root_id' => :'roster_root_id',
+        :'site_id' => :'site_id',
+        :'facility_name' => :'facility_name',
+        :'city' => :'city',
+        :'state' => :'state',
+        :'country' => :'country',
+        :'site_country_code' => :'site_country_code',
+        :'latitude' => :'latitude',
+        :'longitude' => :'longitude',
+        :'geo_precision' => :'geo_precision',
+        :'coord_source' => :'coord_source',
+        :'n_trials' => :'n_trials',
+        :'site_rank' => :'site_rank',
+        :'n_sites' => :'n_sites'
+      }
+    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
+      {
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'roster_root_id' => :'String',
+        :'site_id' => :'String',
+        :'facility_name' => :'String',
+        :'city' => :'String',
+        :'state' => :'String',
+        :'country' => :'String',
+        :'site_country_code' => :'String',
+        :'latitude' => :'Float',
+        :'longitude' => :'Float',
+        :'geo_precision' => :'String',
+        :'coord_source' => :'String',
+        :'n_trials' => :'Integer',
+        :'site_rank' => :'Integer',
+        :'n_sites' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'roster_root_id',
+        :'site_id',
+        :'facility_name',
+        :'city',
+        :'state',
+        :'country',
+        :'site_country_code',
+        :'latitude',
+        :'longitude',
+        :'geo_precision',
+        :'coord_source',
+        :'n_trials',
+        :'site_rank',
+        :'n_sites'
+      ])
+    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::CompanyTrialSitesRow` 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::CompanyTrialSitesRow`. 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?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.key?(:'roster_root_id')
+        self.roster_root_id = attributes[:'roster_root_id']
+      end
+
+      if attributes.key?(:'site_id')
+        self.site_id = attributes[:'site_id']
+      end
+
+      if attributes.key?(:'facility_name')
+        self.facility_name = attributes[:'facility_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?(:'site_country_code')
+        self.site_country_code = attributes[:'site_country_code']
+      end
+
+      if attributes.key?(:'latitude')
+        self.latitude = attributes[:'latitude']
+      end
+
+      if attributes.key?(:'longitude')
+        self.longitude = attributes[:'longitude']
+      end
+
+      if attributes.key?(:'geo_precision')
+        self.geo_precision = attributes[:'geo_precision']
+      end
+
+      if attributes.key?(:'coord_source')
+        self.coord_source = attributes[:'coord_source']
+      end
+
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
+      end
+
+      if attributes.key?(:'site_rank')
+        self.site_rank = attributes[:'site_rank']
+      end
+
+      if attributes.key?(:'n_sites')
+        self.n_sites = attributes[:'n_sites']
+      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 &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          roster_root_id == o.roster_root_id &&
+          site_id == o.site_id &&
+          facility_name == o.facility_name &&
+          city == o.city &&
+          state == o.state &&
+          country == o.country &&
+          site_country_code == o.site_country_code &&
+          latitude == o.latitude &&
+          longitude == o.longitude &&
+          geo_precision == o.geo_precision &&
+          coord_source == o.coord_source &&
+          n_trials == o.n_trials &&
+          site_rank == o.site_rank &&
+          n_sites == o.n_sites
+    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
+      [company_id, company_name, group_id, group_name, roster_root_id, site_id, facility_name, city, state, country, site_country_code, latitude, longitude, geo_precision, coord_source, n_trials, site_rank, n_sites].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