pharmaobservatory 0.1.8 → 0.1.9

data/lib/pharmaobservatory/models/company_firmographics_row.rb

@@ -0,0 +1,566 @@
+=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_firmographics dataset: one row per company with at least one organization record. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyFirmographicsRow
+    # Company level: the company the row is about; the entry key for the companies object type.
+    attr_accessor :company_id
+
+    # Display name of the company.
+    attr_accessor :company_name
+
+    # Group level: the company's current ultimate parent; a root's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the group.
+    attr_accessor :group_name
+
+    # The earliest of the ROR and Wikidata founding years, else our provider profile, else the GLEIF entity creation year last (GLEIF dates re-registrations and reused shells wrongly).
+    attr_accessor :founded_year
+
+    # The source that supplied founded year.
+    attr_accessor :founded_year_source
+
+    # public when an organization record of the company carries an SEC filer id (not a Form D-only filer), else private.
+    attr_accessor :status
+
+    # Headquarters city: GLEIF, then SEC filing business address, then ROR, then Wikidata.
+    attr_accessor :hq_city
+
+    # The source that supplied hq city.
+    attr_accessor :hq_city_source
+
+    # Headquarters country: GLEIF, then ROR, then Wikidata.
+    attr_accessor :hq_country
+
+    # The source that supplied hq country.
+    attr_accessor :hq_country_source
+
+    # Primary industry: SEC standard industrial classification description, then ROR organization type, then Wikidata industry.
+    attr_accessor :primary_industry
+
+    # The source that supplied primary industry.
+    attr_accessor :primary_industry_source
+
+    # Website: ROR, then Wikidata, then our provider profile.
+    attr_accessor :website
+
+    # The source that supplied website.
+    attr_accessor :website_source
+
+    # Latest employee headcount from Wikidata; a zero or negative value is treated as absent.
+    attr_accessor :employees
+
+    # The source that supplied employees.
+    attr_accessor :employees_source
+
+    # The date Wikidata states for the headcount.
+    attr_accessor :employees_as_of
+
+    # Service areas from our provider profile (the pipe-separated list, split).
+    attr_accessor :verticals
+
+    # The source that supplied verticals.
+    attr_accessor :verticals_source
+
+    # Legal name: GLEIF, then Wikidata, then our provider profile's official name.
+    attr_accessor :legal_name
+
+    # The source that supplied legal name.
+    attr_accessor :legal_name_source
+
+    # Corporate parent name: GLEIF group name, then Wikidata parent, then our provider profile's parent. This is a stated source value, not the company's ladder group.
+    attr_accessor :corporate_parent
+
+    # The source that supplied corporate parent.
+    attr_accessor :corporate_parent_source
+
+    # Legal form: GLEIF, then Wikidata.
+    attr_accessor :legal_form
+
+    # The source that supplied legal form.
+    attr_accessor :legal_form_source
+
+    # The Wikidata item id of the organization record whose profile supplies the five fields below.
+    attr_accessor :wikidata_qid
+
+    # Wikipedia page: ROR, then Wikidata.
+    attr_accessor :wikipedia_url
+
+    # LinkedIn organization id from the Wikidata profile.
+    attr_accessor :linkedin
+
+    # X (Twitter) username from the Wikidata profile.
+    attr_accessor :x_handle
+
+    # Facebook id from the Wikidata profile.
+    attr_accessor :facebook
+
+    # The Wikidata short description.
+    attr_accessor :short_description
+
+    # 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',
+        :'founded_year' => :'founded_year',
+        :'founded_year_source' => :'founded_year_source',
+        :'status' => :'status',
+        :'hq_city' => :'hq_city',
+        :'hq_city_source' => :'hq_city_source',
+        :'hq_country' => :'hq_country',
+        :'hq_country_source' => :'hq_country_source',
+        :'primary_industry' => :'primary_industry',
+        :'primary_industry_source' => :'primary_industry_source',
+        :'website' => :'website',
+        :'website_source' => :'website_source',
+        :'employees' => :'employees',
+        :'employees_source' => :'employees_source',
+        :'employees_as_of' => :'employees_as_of',
+        :'verticals' => :'verticals',
+        :'verticals_source' => :'verticals_source',
+        :'legal_name' => :'legal_name',
+        :'legal_name_source' => :'legal_name_source',
+        :'corporate_parent' => :'corporate_parent',
+        :'corporate_parent_source' => :'corporate_parent_source',
+        :'legal_form' => :'legal_form',
+        :'legal_form_source' => :'legal_form_source',
+        :'wikidata_qid' => :'wikidata_qid',
+        :'wikipedia_url' => :'wikipedia_url',
+        :'linkedin' => :'linkedin',
+        :'x_handle' => :'x_handle',
+        :'facebook' => :'facebook',
+        :'short_description' => :'short_description'
+      }
+    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',
+        :'founded_year' => :'Integer',
+        :'founded_year_source' => :'String',
+        :'status' => :'String',
+        :'hq_city' => :'String',
+        :'hq_city_source' => :'String',
+        :'hq_country' => :'String',
+        :'hq_country_source' => :'String',
+        :'primary_industry' => :'String',
+        :'primary_industry_source' => :'String',
+        :'website' => :'String',
+        :'website_source' => :'String',
+        :'employees' => :'Integer',
+        :'employees_source' => :'String',
+        :'employees_as_of' => :'Date',
+        :'verticals' => :'Array<String>',
+        :'verticals_source' => :'String',
+        :'legal_name' => :'String',
+        :'legal_name_source' => :'String',
+        :'corporate_parent' => :'String',
+        :'corporate_parent_source' => :'String',
+        :'legal_form' => :'String',
+        :'legal_form_source' => :'String',
+        :'wikidata_qid' => :'String',
+        :'wikipedia_url' => :'String',
+        :'linkedin' => :'String',
+        :'x_handle' => :'String',
+        :'facebook' => :'String',
+        :'short_description' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'founded_year',
+        :'founded_year_source',
+        :'status',
+        :'hq_city',
+        :'hq_city_source',
+        :'hq_country',
+        :'hq_country_source',
+        :'primary_industry',
+        :'primary_industry_source',
+        :'website',
+        :'website_source',
+        :'employees',
+        :'employees_source',
+        :'employees_as_of',
+        :'verticals',
+        :'verticals_source',
+        :'legal_name',
+        :'legal_name_source',
+        :'corporate_parent',
+        :'corporate_parent_source',
+        :'legal_form',
+        :'legal_form_source',
+        :'wikidata_qid',
+        :'wikipedia_url',
+        :'linkedin',
+        :'x_handle',
+        :'facebook',
+        :'short_description'
+      ])
+    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::CompanyFirmographicsRow` 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::CompanyFirmographicsRow`. 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?(:'founded_year')
+        self.founded_year = attributes[:'founded_year']
+      end
+
+      if attributes.key?(:'founded_year_source')
+        self.founded_year_source = attributes[:'founded_year_source']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'hq_city')
+        self.hq_city = attributes[:'hq_city']
+      end
+
+      if attributes.key?(:'hq_city_source')
+        self.hq_city_source = attributes[:'hq_city_source']
+      end
+
+      if attributes.key?(:'hq_country')
+        self.hq_country = attributes[:'hq_country']
+      end
+
+      if attributes.key?(:'hq_country_source')
+        self.hq_country_source = attributes[:'hq_country_source']
+      end
+
+      if attributes.key?(:'primary_industry')
+        self.primary_industry = attributes[:'primary_industry']
+      end
+
+      if attributes.key?(:'primary_industry_source')
+        self.primary_industry_source = attributes[:'primary_industry_source']
+      end
+
+      if attributes.key?(:'website')
+        self.website = attributes[:'website']
+      end
+
+      if attributes.key?(:'website_source')
+        self.website_source = attributes[:'website_source']
+      end
+
+      if attributes.key?(:'employees')
+        self.employees = attributes[:'employees']
+      end
+
+      if attributes.key?(:'employees_source')
+        self.employees_source = attributes[:'employees_source']
+      end
+
+      if attributes.key?(:'employees_as_of')
+        self.employees_as_of = attributes[:'employees_as_of']
+      end
+
+      if attributes.key?(:'verticals')
+        if (value = attributes[:'verticals']).is_a?(Array)
+          self.verticals = value
+        end
+      end
+
+      if attributes.key?(:'verticals_source')
+        self.verticals_source = attributes[:'verticals_source']
+      end
+
+      if attributes.key?(:'legal_name')
+        self.legal_name = attributes[:'legal_name']
+      end
+
+      if attributes.key?(:'legal_name_source')
+        self.legal_name_source = attributes[:'legal_name_source']
+      end
+
+      if attributes.key?(:'corporate_parent')
+        self.corporate_parent = attributes[:'corporate_parent']
+      end
+
+      if attributes.key?(:'corporate_parent_source')
+        self.corporate_parent_source = attributes[:'corporate_parent_source']
+      end
+
+      if attributes.key?(:'legal_form')
+        self.legal_form = attributes[:'legal_form']
+      end
+
+      if attributes.key?(:'legal_form_source')
+        self.legal_form_source = attributes[:'legal_form_source']
+      end
+
+      if attributes.key?(:'wikidata_qid')
+        self.wikidata_qid = attributes[:'wikidata_qid']
+      end
+
+      if attributes.key?(:'wikipedia_url')
+        self.wikipedia_url = attributes[:'wikipedia_url']
+      end
+
+      if attributes.key?(:'linkedin')
+        self.linkedin = attributes[:'linkedin']
+      end
+
+      if attributes.key?(:'x_handle')
+        self.x_handle = attributes[:'x_handle']
+      end
+
+      if attributes.key?(:'facebook')
+        self.facebook = attributes[:'facebook']
+      end
+
+      if attributes.key?(:'short_description')
+        self.short_description = attributes[:'short_description']
+      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 &&
+          founded_year == o.founded_year &&
+          founded_year_source == o.founded_year_source &&
+          status == o.status &&
+          hq_city == o.hq_city &&
+          hq_city_source == o.hq_city_source &&
+          hq_country == o.hq_country &&
+          hq_country_source == o.hq_country_source &&
+          primary_industry == o.primary_industry &&
+          primary_industry_source == o.primary_industry_source &&
+          website == o.website &&
+          website_source == o.website_source &&
+          employees == o.employees &&
+          employees_source == o.employees_source &&
+          employees_as_of == o.employees_as_of &&
+          verticals == o.verticals &&
+          verticals_source == o.verticals_source &&
+          legal_name == o.legal_name &&
+          legal_name_source == o.legal_name_source &&
+          corporate_parent == o.corporate_parent &&
+          corporate_parent_source == o.corporate_parent_source &&
+          legal_form == o.legal_form &&
+          legal_form_source == o.legal_form_source &&
+          wikidata_qid == o.wikidata_qid &&
+          wikipedia_url == o.wikipedia_url &&
+          linkedin == o.linkedin &&
+          x_handle == o.x_handle &&
+          facebook == o.facebook &&
+          short_description == o.short_description
+    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, founded_year, founded_year_source, status, hq_city, hq_city_source, hq_country, hq_country_source, primary_industry, primary_industry_source, website, website_source, employees, employees_source, employees_as_of, verticals, verticals_source, legal_name, legal_name_source, corporate_parent, corporate_parent_source, legal_form, legal_form_source, wikidata_qid, wikipedia_url, linkedin, x_handle, facebook, short_description].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

data/lib/pharmaobservatory/models/company_funding_events_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
+        :'scope' => :'AnimalWelfareAssurancesResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<CompanyFundingEventsRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
-        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
+        :'freshness' => :'AnimalWelfareAssurancesResponseFreshness',
+        :'build' => :'AnimalWelfareAssurancesResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/company_funding_summary_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
+        :'scope' => :'AnimalWelfareAssurancesResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<CompanyFundingSummaryRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
-        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
+        :'freshness' => :'AnimalWelfareAssurancesResponseFreshness',
+        :'build' => :'AnimalWelfareAssurancesResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/company_members_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
+        :'scope' => :'AnimalWelfareAssurancesResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<CompanyMembersRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
-        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
+        :'freshness' => :'AnimalWelfareAssurancesResponseFreshness',
+        :'build' => :'AnimalWelfareAssurancesResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/company_programs_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
+        :'scope' => :'AnimalWelfareAssurancesResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<CompanyProgramsRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
-        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
+        :'freshness' => :'AnimalWelfareAssurancesResponseFreshness',
+        :'build' => :'AnimalWelfareAssurancesResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }