pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/company_trial_geography_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_geography dataset: one row per company on the public roster directory or leading a trial with a site. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyTrialGeographyRow
+    # The company key (company:<key>).
+    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
+
+    # True when the company is a public roster root: an organization the public Clinical Research Map lists.
+    attr_accessor :is_public_roster_root
+
+    # The Clinical Research Map's organization key for this company: the group when it is a public roster root, else the company when it is one, else null.
+    attr_accessor :roster_root_id
+
+    # For a public roster root, the lead-trial count the public organizations list sorts on; null for a company that is not one.
+    attr_accessor :roster_lead_trials
+
+    # ISO 3166-1 alpha-2 code of the company's legal-entity domicile; null when unknown.
+    attr_accessor :domicile_country
+
+    # ISO 3166-1 alpha-2 code of the country holding the most of the company's own located led-trial sites; null when none resolves.
+    attr_accessor :site_country
+
+    # The country the map places the company under: domicile_country, else site_country; null when neither is known.
+    attr_accessor :map_country
+
+    # Which signal map_country came from: domicile or trial_sites; null exactly when map_country is null.
+    attr_accessor :map_country_basis
+
+    # The company's own located led-trial sites.
+    attr_accessor :n_located_sites
+
+    # The company's led-trial sites with no coordinate, which the map does not draw.
+    attr_accessor :n_unlocated_sites
+
+    # Distinct resolved countries among the company's located led-trial sites.
+    attr_accessor :n_site_countries
+
+    # Located led-trial sites whose country name resolves to no country code; they do not vote for site_country.
+    attr_accessor :n_unresolved_sites
+
+    # For a public roster root, the country the public Clinical Research Map shows the organization under, as published; null for a non-root.
+    attr_accessor :roster_map_country
+
+    # For a public roster root, which signal the public map's country came from: domicile or trial_sites; null for a non-root or an unknown country.
+    attr_accessor :roster_map_country_basis
+
+    # For a public roster root, the located sites the public map draws the organization at (its group fold); null for a non-root.
+    attr_accessor :roster_n_located_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',
+        :'is_public_roster_root' => :'is_public_roster_root',
+        :'roster_root_id' => :'roster_root_id',
+        :'roster_lead_trials' => :'roster_lead_trials',
+        :'domicile_country' => :'domicile_country',
+        :'site_country' => :'site_country',
+        :'map_country' => :'map_country',
+        :'map_country_basis' => :'map_country_basis',
+        :'n_located_sites' => :'n_located_sites',
+        :'n_unlocated_sites' => :'n_unlocated_sites',
+        :'n_site_countries' => :'n_site_countries',
+        :'n_unresolved_sites' => :'n_unresolved_sites',
+        :'roster_map_country' => :'roster_map_country',
+        :'roster_map_country_basis' => :'roster_map_country_basis',
+        :'roster_n_located_sites' => :'roster_n_located_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',
+        :'is_public_roster_root' => :'Boolean',
+        :'roster_root_id' => :'String',
+        :'roster_lead_trials' => :'Integer',
+        :'domicile_country' => :'String',
+        :'site_country' => :'String',
+        :'map_country' => :'String',
+        :'map_country_basis' => :'String',
+        :'n_located_sites' => :'Integer',
+        :'n_unlocated_sites' => :'Integer',
+        :'n_site_countries' => :'Integer',
+        :'n_unresolved_sites' => :'Integer',
+        :'roster_map_country' => :'String',
+        :'roster_map_country_basis' => :'String',
+        :'roster_n_located_sites' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'is_public_roster_root',
+        :'roster_root_id',
+        :'roster_lead_trials',
+        :'domicile_country',
+        :'site_country',
+        :'map_country',
+        :'map_country_basis',
+        :'n_located_sites',
+        :'n_unlocated_sites',
+        :'n_site_countries',
+        :'n_unresolved_sites',
+        :'roster_map_country',
+        :'roster_map_country_basis',
+        :'roster_n_located_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::CompanyTrialGeographyRow` 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::CompanyTrialGeographyRow`. 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?(:'is_public_roster_root')
+        self.is_public_roster_root = attributes[:'is_public_roster_root']
+      end
+
+      if attributes.key?(:'roster_root_id')
+        self.roster_root_id = attributes[:'roster_root_id']
+      end
+
+      if attributes.key?(:'roster_lead_trials')
+        self.roster_lead_trials = attributes[:'roster_lead_trials']
+      end
+
+      if attributes.key?(:'domicile_country')
+        self.domicile_country = attributes[:'domicile_country']
+      end
+
+      if attributes.key?(:'site_country')
+        self.site_country = attributes[:'site_country']
+      end
+
+      if attributes.key?(:'map_country')
+        self.map_country = attributes[:'map_country']
+      end
+
+      if attributes.key?(:'map_country_basis')
+        self.map_country_basis = attributes[:'map_country_basis']
+      end
+
+      if attributes.key?(:'n_located_sites')
+        self.n_located_sites = attributes[:'n_located_sites']
+      end
+
+      if attributes.key?(:'n_unlocated_sites')
+        self.n_unlocated_sites = attributes[:'n_unlocated_sites']
+      end
+
+      if attributes.key?(:'n_site_countries')
+        self.n_site_countries = attributes[:'n_site_countries']
+      end
+
+      if attributes.key?(:'n_unresolved_sites')
+        self.n_unresolved_sites = attributes[:'n_unresolved_sites']
+      end
+
+      if attributes.key?(:'roster_map_country')
+        self.roster_map_country = attributes[:'roster_map_country']
+      end
+
+      if attributes.key?(:'roster_map_country_basis')
+        self.roster_map_country_basis = attributes[:'roster_map_country_basis']
+      end
+
+      if attributes.key?(:'roster_n_located_sites')
+        self.roster_n_located_sites = attributes[:'roster_n_located_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 &&
+          is_public_roster_root == o.is_public_roster_root &&
+          roster_root_id == o.roster_root_id &&
+          roster_lead_trials == o.roster_lead_trials &&
+          domicile_country == o.domicile_country &&
+          site_country == o.site_country &&
+          map_country == o.map_country &&
+          map_country_basis == o.map_country_basis &&
+          n_located_sites == o.n_located_sites &&
+          n_unlocated_sites == o.n_unlocated_sites &&
+          n_site_countries == o.n_site_countries &&
+          n_unresolved_sites == o.n_unresolved_sites &&
+          roster_map_country == o.roster_map_country &&
+          roster_map_country_basis == o.roster_map_country_basis &&
+          roster_n_located_sites == o.roster_n_located_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, is_public_roster_root, roster_root_id, roster_lead_trials, domicile_country, site_country, map_country, map_country_basis, n_located_sites, n_unlocated_sites, n_site_countries, n_unresolved_sites, roster_map_country, roster_map_country_basis, roster_n_located_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