pharmaobservatory 0.1.2 → 0.1.4

data/lib/pharmaobservatory/models/companies_row.rb

@@ -0,0 +1,500 @@
+=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 companies dataset: one row per company. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompaniesRow
+    # The company key (company:<key>).
+    attr_accessor :company_id
+
+    # The company's display name: its own legal entity's name where one is known.
+    attr_accessor :company_name
+
+    # Which source supplied the name: gleif_legal_name, edgar_registrant, ror or sponsor_display_name.
+    attr_accessor :name_basis
+
+    # Country of the company's own legal entity, as the source states it.
+    attr_accessor :country
+
+    # The organization type of the company's representative record.
+    attr_accessor :org_type
+
+    # The roles the company's organizations play (Manufacturer, Sponsor and so on).
+    attr_accessor :org_kinds
+
+    # Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, of the representative record, when it files.
+    attr_accessor :edgar_cik
+
+    # Exchange ticker of the representative record, when listed.
+    attr_accessor :edgar_ticker
+
+    # Legal-entity level: the organization record the company's page shows.
+    attr_accessor :representative_org_id
+
+    # The direct owner company (part_of), null for a root.
+    attr_accessor :parent_company_id
+
+    # Display name of the direct owner company.
+    attr_accessor :parent_company_name
+
+    # Date the ownership link began, when every hop is dated.
+    attr_accessor :part_of_since
+
+    # Precision of part_of_since (day, month or year).
+    attr_accessor :part_of_since_precision
+
+    # Group level: the current ultimate parent company; a root company's group is itself. Current ownership only; dated links are in company_members.
+    attr_accessor :group_id
+
+    # Display name of the group.
+    attr_accessor :group_name
+
+    # Hops from this company to its ultimate parent (0 for a root).
+    attr_accessor :rollup_depth
+
+    # Registered legal entities that are members of the company.
+    attr_accessor :n_legal_entities
+
+    # Companies folded into this one.
+    attr_accessor :n_member_companies
+
+    # Trials the company's organizations lead.
+    attr_accessor :num_lead_trials
+
+    # Trials the company's organizations collaborate on.
+    attr_accessor :num_collaborator_trials
+
+    # Trials the company's organizations lead or collaborate on.
+    attr_accessor :num_trials
+
+    # Planned enrollment across led trials.
+    attr_accessor :total_lead_enrollment
+
+    # Led trials started in the recent window.
+    attr_accessor :num_recent_lead_trials
+
+    # Trial activity score (interventional lead trials and enrollment, weighted toward recent).
+    attr_accessor :activity_score
+
+    # True when the company is admitted to the company roster (lead-trial activity, more than one legal entity or a recorded manufacturer role); false rows carry null firmographic, trial-count and activity columns.
+    attr_accessor :is_admitted
+
+    # True when the company has a public organization page.
+    attr_accessor :has_public_page
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'name_basis' => :'name_basis',
+        :'country' => :'country',
+        :'org_type' => :'org_type',
+        :'org_kinds' => :'org_kinds',
+        :'edgar_cik' => :'edgar_cik',
+        :'edgar_ticker' => :'edgar_ticker',
+        :'representative_org_id' => :'representative_org_id',
+        :'parent_company_id' => :'parent_company_id',
+        :'parent_company_name' => :'parent_company_name',
+        :'part_of_since' => :'part_of_since',
+        :'part_of_since_precision' => :'part_of_since_precision',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'rollup_depth' => :'rollup_depth',
+        :'n_legal_entities' => :'n_legal_entities',
+        :'n_member_companies' => :'n_member_companies',
+        :'num_lead_trials' => :'num_lead_trials',
+        :'num_collaborator_trials' => :'num_collaborator_trials',
+        :'num_trials' => :'num_trials',
+        :'total_lead_enrollment' => :'total_lead_enrollment',
+        :'num_recent_lead_trials' => :'num_recent_lead_trials',
+        :'activity_score' => :'activity_score',
+        :'is_admitted' => :'is_admitted',
+        :'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
+      {
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'name_basis' => :'String',
+        :'country' => :'String',
+        :'org_type' => :'String',
+        :'org_kinds' => :'Array<String>',
+        :'edgar_cik' => :'String',
+        :'edgar_ticker' => :'String',
+        :'representative_org_id' => :'String',
+        :'parent_company_id' => :'String',
+        :'parent_company_name' => :'String',
+        :'part_of_since' => :'Date',
+        :'part_of_since_precision' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'rollup_depth' => :'Integer',
+        :'n_legal_entities' => :'Integer',
+        :'n_member_companies' => :'Integer',
+        :'num_lead_trials' => :'Integer',
+        :'num_collaborator_trials' => :'Integer',
+        :'num_trials' => :'Integer',
+        :'total_lead_enrollment' => :'Integer',
+        :'num_recent_lead_trials' => :'Integer',
+        :'activity_score' => :'Float',
+        :'is_admitted' => :'Boolean',
+        :'has_public_page' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'company_id',
+        :'company_name',
+        :'name_basis',
+        :'country',
+        :'org_type',
+        :'org_kinds',
+        :'edgar_cik',
+        :'edgar_ticker',
+        :'representative_org_id',
+        :'parent_company_id',
+        :'parent_company_name',
+        :'part_of_since',
+        :'part_of_since_precision',
+        :'group_id',
+        :'group_name',
+        :'rollup_depth',
+        :'n_legal_entities',
+        :'n_member_companies',
+        :'num_lead_trials',
+        :'num_collaborator_trials',
+        :'num_trials',
+        :'total_lead_enrollment',
+        :'num_recent_lead_trials',
+        :'activity_score',
+        :'is_admitted',
+        :'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::CompaniesRow` 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::CompaniesRow`. 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?(:'name_basis')
+        self.name_basis = attributes[:'name_basis']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'org_type')
+        self.org_type = attributes[:'org_type']
+      end
+
+      if attributes.key?(:'org_kinds')
+        if (value = attributes[:'org_kinds']).is_a?(Array)
+          self.org_kinds = value
+        end
+      end
+
+      if attributes.key?(:'edgar_cik')
+        self.edgar_cik = attributes[:'edgar_cik']
+      end
+
+      if attributes.key?(:'edgar_ticker')
+        self.edgar_ticker = attributes[:'edgar_ticker']
+      end
+
+      if attributes.key?(:'representative_org_id')
+        self.representative_org_id = attributes[:'representative_org_id']
+      end
+
+      if attributes.key?(:'parent_company_id')
+        self.parent_company_id = attributes[:'parent_company_id']
+      end
+
+      if attributes.key?(:'parent_company_name')
+        self.parent_company_name = attributes[:'parent_company_name']
+      end
+
+      if attributes.key?(:'part_of_since')
+        self.part_of_since = attributes[:'part_of_since']
+      end
+
+      if attributes.key?(:'part_of_since_precision')
+        self.part_of_since_precision = attributes[:'part_of_since_precision']
+      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?(:'rollup_depth')
+        self.rollup_depth = attributes[:'rollup_depth']
+      end
+
+      if attributes.key?(:'n_legal_entities')
+        self.n_legal_entities = attributes[:'n_legal_entities']
+      end
+
+      if attributes.key?(:'n_member_companies')
+        self.n_member_companies = attributes[:'n_member_companies']
+      end
+
+      if attributes.key?(:'num_lead_trials')
+        self.num_lead_trials = attributes[:'num_lead_trials']
+      end
+
+      if attributes.key?(:'num_collaborator_trials')
+        self.num_collaborator_trials = attributes[:'num_collaborator_trials']
+      end
+
+      if attributes.key?(:'num_trials')
+        self.num_trials = attributes[:'num_trials']
+      end
+
+      if attributes.key?(:'total_lead_enrollment')
+        self.total_lead_enrollment = attributes[:'total_lead_enrollment']
+      end
+
+      if attributes.key?(:'num_recent_lead_trials')
+        self.num_recent_lead_trials = attributes[:'num_recent_lead_trials']
+      end
+
+      if attributes.key?(:'activity_score')
+        self.activity_score = attributes[:'activity_score']
+      end
+
+      if attributes.key?(:'is_admitted')
+        self.is_admitted = attributes[:'is_admitted']
+      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 &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          name_basis == o.name_basis &&
+          country == o.country &&
+          org_type == o.org_type &&
+          org_kinds == o.org_kinds &&
+          edgar_cik == o.edgar_cik &&
+          edgar_ticker == o.edgar_ticker &&
+          representative_org_id == o.representative_org_id &&
+          parent_company_id == o.parent_company_id &&
+          parent_company_name == o.parent_company_name &&
+          part_of_since == o.part_of_since &&
+          part_of_since_precision == o.part_of_since_precision &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          rollup_depth == o.rollup_depth &&
+          n_legal_entities == o.n_legal_entities &&
+          n_member_companies == o.n_member_companies &&
+          num_lead_trials == o.num_lead_trials &&
+          num_collaborator_trials == o.num_collaborator_trials &&
+          num_trials == o.num_trials &&
+          total_lead_enrollment == o.total_lead_enrollment &&
+          num_recent_lead_trials == o.num_recent_lead_trials &&
+          activity_score == o.activity_score &&
+          is_admitted == o.is_admitted &&
+          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
+      [company_id, company_name, name_basis, country, org_type, org_kinds, edgar_cik, edgar_ticker, representative_org_id, parent_company_id, parent_company_name, part_of_since, part_of_since_precision, group_id, group_name, rollup_depth, n_legal_entities, n_member_companies, num_lead_trials, num_collaborator_trials, num_trials, total_lead_enrollment, num_recent_lead_trials, activity_score, is_admitted, 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