pharmaobservatory 0.1.4 → 0.1.6

data/lib/pharmaobservatory/models/suppliers_row.rb

@@ -0,0 +1,544 @@
+=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 suppliers dataset: one row per research supplier published in the public Scientist.com marketplace with at least one located site. A grouped request returns the group columns and the measures instead, as additional properties.
+  class SuppliersRow
+    # The supplier id: the Scientist.com provider id as text, the id in the supplier page address (/suppliers/<id>). A supplier is not a company.
+    attr_accessor :provider_id
+
+    # The supplier's name as listed on the marketplace.
+    attr_accessor :name
+
+    # The supplier's company type as the marketplace spells it (small-business, academic-core and so on). An open set; null when the supplier lists none.
+    attr_accessor :company_type
+
+    # The supplier's marketplace tier word; null when the marketplace assigns none.
+    attr_accessor :marketplace_tier
+
+    # The service areas the supplier lists, one array element each (empty when none). Filter with 'Biology' = ANY(service_areas).
+    attr_accessor :service_areas
+
+    # ISO 3166-1 alpha-2 country code of the supplier's headquarters point (null when unknown).
+    attr_accessor :hq_country
+
+    # The broad world region of hq_country, from the country_regions reference table; other when the country is unknown or in none of the six regions.
+    attr_accessor :hq_region
+
+    # Latitude of the supplier's headquarters point: the Headquarters site, else the first site by category then site id.
+    attr_accessor :hq_latitude
+
+    # Longitude of the supplier's headquarters point.
+    attr_accessor :hq_longitude
+
+    # How many located sites the supplier has.
+    attr_accessor :n_sites
+
+    # How many distinct countries the supplier's sites are in.
+    attr_accessor :n_countries
+
+    # True when the supplier's organization is a contract research organization (CRO) under the one organization-level definition.
+    attr_accessor :is_cro
+
+    # True when the supplier name matches a registered trial sponsor. A name match, not a verified identity.
+    attr_accessor :is_trial_sponsor
+
+    # Registered trials where an organization matched to the supplier by name is lead sponsor or collaborator.
+    attr_accessor :n_trials
+
+    # The subset of n_trials where the matched organization is the lead sponsor.
+    attr_accessor :n_lead_trials
+
+    # The website the supplier listed; a third-party address, not vouched for.
+    attr_accessor :website
+
+    # The supplier's page on the Scientist.com marketplace; the marketplace asks a visitor to sign in.
+    attr_accessor :profile_url
+
+    # The path of the supplier's logo on our own origin (/supplier-logos/<sha>.png); null when it has none.
+    attr_accessor :logo_path
+
+    # True when the supplier wrote a profile description. The description text is not published.
+    attr_accessor :has_description
+
+    # SAM.gov self-certified veteran-owned designation.
+    attr_accessor :is_veteran_owned
+
+    # SAM.gov self-certified woman-owned designation.
+    attr_accessor :is_woman_owned
+
+    # SAM.gov self-certified minority-owned designation (8(a) or small disadvantaged business).
+    attr_accessor :is_minority_owned
+
+    # SAM.gov self-certified HUBZone (historically underutilized business zone) designation.
+    attr_accessor :is_hubzone
+
+    # Legal-entity level: the organization record the supplier resolved to. Null when the supplier has no organization record of its own.
+    attr_accessor :supplier_org_id
+
+    # Company level: the company the supplier's organization belongs to (null when none).
+    attr_accessor :supplier_company_id
+
+    # Display name of the supplier's company.
+    attr_accessor :supplier_company_name
+
+    # Group level: the supplier's company's current ultimate parent company; a root company's group is itself.
+    attr_accessor :supplier_group_id
+
+    # Display name of the supplier's group.
+    attr_accessor :supplier_group_name
+
+    # How the supplier was linked to its organization record, so a caller can apply a confidence floor. The supplier pages on organization pages show only provider_ror_exact, provider_edgar_exact and supplier_curated.
+    attr_accessor :org_link_method
+
+    # True when the supplier has a public page on the web (every row of this dataset does).
+    attr_accessor :has_public_page
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'provider_id' => :'provider_id',
+        :'name' => :'name',
+        :'company_type' => :'company_type',
+        :'marketplace_tier' => :'marketplace_tier',
+        :'service_areas' => :'service_areas',
+        :'hq_country' => :'hq_country',
+        :'hq_region' => :'hq_region',
+        :'hq_latitude' => :'hq_latitude',
+        :'hq_longitude' => :'hq_longitude',
+        :'n_sites' => :'n_sites',
+        :'n_countries' => :'n_countries',
+        :'is_cro' => :'is_cro',
+        :'is_trial_sponsor' => :'is_trial_sponsor',
+        :'n_trials' => :'n_trials',
+        :'n_lead_trials' => :'n_lead_trials',
+        :'website' => :'website',
+        :'profile_url' => :'profile_url',
+        :'logo_path' => :'logo_path',
+        :'has_description' => :'has_description',
+        :'is_veteran_owned' => :'is_veteran_owned',
+        :'is_woman_owned' => :'is_woman_owned',
+        :'is_minority_owned' => :'is_minority_owned',
+        :'is_hubzone' => :'is_hubzone',
+        :'supplier_org_id' => :'supplier_org_id',
+        :'supplier_company_id' => :'supplier_company_id',
+        :'supplier_company_name' => :'supplier_company_name',
+        :'supplier_group_id' => :'supplier_group_id',
+        :'supplier_group_name' => :'supplier_group_name',
+        :'org_link_method' => :'org_link_method',
+        :'has_public_page' => :'has_public_page'
+      }
+    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
+      {
+        :'provider_id' => :'String',
+        :'name' => :'String',
+        :'company_type' => :'String',
+        :'marketplace_tier' => :'String',
+        :'service_areas' => :'Array<String>',
+        :'hq_country' => :'String',
+        :'hq_region' => :'String',
+        :'hq_latitude' => :'Float',
+        :'hq_longitude' => :'Float',
+        :'n_sites' => :'Integer',
+        :'n_countries' => :'Integer',
+        :'is_cro' => :'Boolean',
+        :'is_trial_sponsor' => :'Boolean',
+        :'n_trials' => :'Integer',
+        :'n_lead_trials' => :'Integer',
+        :'website' => :'String',
+        :'profile_url' => :'String',
+        :'logo_path' => :'String',
+        :'has_description' => :'Boolean',
+        :'is_veteran_owned' => :'Boolean',
+        :'is_woman_owned' => :'Boolean',
+        :'is_minority_owned' => :'Boolean',
+        :'is_hubzone' => :'Boolean',
+        :'supplier_org_id' => :'String',
+        :'supplier_company_id' => :'String',
+        :'supplier_company_name' => :'String',
+        :'supplier_group_id' => :'String',
+        :'supplier_group_name' => :'String',
+        :'org_link_method' => :'String',
+        :'has_public_page' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'provider_id',
+        :'name',
+        :'company_type',
+        :'marketplace_tier',
+        :'service_areas',
+        :'hq_country',
+        :'hq_region',
+        :'hq_latitude',
+        :'hq_longitude',
+        :'n_sites',
+        :'n_countries',
+        :'is_cro',
+        :'is_trial_sponsor',
+        :'n_trials',
+        :'n_lead_trials',
+        :'website',
+        :'profile_url',
+        :'logo_path',
+        :'has_description',
+        :'is_veteran_owned',
+        :'is_woman_owned',
+        :'is_minority_owned',
+        :'is_hubzone',
+        :'supplier_org_id',
+        :'supplier_company_id',
+        :'supplier_company_name',
+        :'supplier_group_id',
+        :'supplier_group_name',
+        :'org_link_method',
+        :'has_public_page'
+      ])
+    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::SuppliersRow` 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::SuppliersRow`. 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?(:'provider_id')
+        self.provider_id = attributes[:'provider_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'company_type')
+        self.company_type = attributes[:'company_type']
+      end
+
+      if attributes.key?(:'marketplace_tier')
+        self.marketplace_tier = attributes[:'marketplace_tier']
+      end
+
+      if attributes.key?(:'service_areas')
+        if (value = attributes[:'service_areas']).is_a?(Array)
+          self.service_areas = value
+        end
+      end
+
+      if attributes.key?(:'hq_country')
+        self.hq_country = attributes[:'hq_country']
+      end
+
+      if attributes.key?(:'hq_region')
+        self.hq_region = attributes[:'hq_region']
+      end
+
+      if attributes.key?(:'hq_latitude')
+        self.hq_latitude = attributes[:'hq_latitude']
+      end
+
+      if attributes.key?(:'hq_longitude')
+        self.hq_longitude = attributes[:'hq_longitude']
+      end
+
+      if attributes.key?(:'n_sites')
+        self.n_sites = attributes[:'n_sites']
+      end
+
+      if attributes.key?(:'n_countries')
+        self.n_countries = attributes[:'n_countries']
+      end
+
+      if attributes.key?(:'is_cro')
+        self.is_cro = attributes[:'is_cro']
+      end
+
+      if attributes.key?(:'is_trial_sponsor')
+        self.is_trial_sponsor = attributes[:'is_trial_sponsor']
+      end
+
+      if attributes.key?(:'n_trials')
+        self.n_trials = attributes[:'n_trials']
+      end
+
+      if attributes.key?(:'n_lead_trials')
+        self.n_lead_trials = attributes[:'n_lead_trials']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      end
+
+      if attributes.key?(:'profile_url')
+        self.profile_url = attributes[:'profile_url']
+      end
+
+      if attributes.key?(:'logo_path')
+        self.logo_path = attributes[:'logo_path']
+      end
+
+      if attributes.key?(:'has_description')
+        self.has_description = attributes[:'has_description']
+      end
+
+      if attributes.key?(:'is_veteran_owned')
+        self.is_veteran_owned = attributes[:'is_veteran_owned']
+      end
+
+      if attributes.key?(:'is_woman_owned')
+        self.is_woman_owned = attributes[:'is_woman_owned']
+      end
+
+      if attributes.key?(:'is_minority_owned')
+        self.is_minority_owned = attributes[:'is_minority_owned']
+      end
+
+      if attributes.key?(:'is_hubzone')
+        self.is_hubzone = attributes[:'is_hubzone']
+      end
+
+      if attributes.key?(:'supplier_org_id')
+        self.supplier_org_id = attributes[:'supplier_org_id']
+      end
+
+      if attributes.key?(:'supplier_company_id')
+        self.supplier_company_id = attributes[:'supplier_company_id']
+      end
+
+      if attributes.key?(:'supplier_company_name')
+        self.supplier_company_name = attributes[:'supplier_company_name']
+      end
+
+      if attributes.key?(:'supplier_group_id')
+        self.supplier_group_id = attributes[:'supplier_group_id']
+      end
+
+      if attributes.key?(:'supplier_group_name')
+        self.supplier_group_name = attributes[:'supplier_group_name']
+      end
+
+      if attributes.key?(:'org_link_method')
+        self.org_link_method = attributes[:'org_link_method']
+      end
+
+      if attributes.key?(:'has_public_page')
+        self.has_public_page = attributes[:'has_public_page']
+      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 &&
+          provider_id == o.provider_id &&
+          name == o.name &&
+          company_type == o.company_type &&
+          marketplace_tier == o.marketplace_tier &&
+          service_areas == o.service_areas &&
+          hq_country == o.hq_country &&
+          hq_region == o.hq_region &&
+          hq_latitude == o.hq_latitude &&
+          hq_longitude == o.hq_longitude &&
+          n_sites == o.n_sites &&
+          n_countries == o.n_countries &&
+          is_cro == o.is_cro &&
+          is_trial_sponsor == o.is_trial_sponsor &&
+          n_trials == o.n_trials &&
+          n_lead_trials == o.n_lead_trials &&
+          website == o.website &&
+          profile_url == o.profile_url &&
+          logo_path == o.logo_path &&
+          has_description == o.has_description &&
+          is_veteran_owned == o.is_veteran_owned &&
+          is_woman_owned == o.is_woman_owned &&
+          is_minority_owned == o.is_minority_owned &&
+          is_hubzone == o.is_hubzone &&
+          supplier_org_id == o.supplier_org_id &&
+          supplier_company_id == o.supplier_company_id &&
+          supplier_company_name == o.supplier_company_name &&
+          supplier_group_id == o.supplier_group_id &&
+          supplier_group_name == o.supplier_group_name &&
+          org_link_method == o.org_link_method &&
+          has_public_page == o.has_public_page
+    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
+      [provider_id, name, company_type, marketplace_tier, service_areas, hq_country, hq_region, hq_latitude, hq_longitude, n_sites, n_countries, is_cro, is_trial_sponsor, n_trials, n_lead_trials, website, profile_url, logo_path, has_description, is_veteran_owned, is_woman_owned, is_minority_owned, is_hubzone, supplier_org_id, supplier_company_id, supplier_company_name, supplier_group_id, supplier_group_name, org_link_method, has_public_page].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