pharmaobservatory 0.1.3 → 0.1.4

data/lib/pharmaobservatory/models/companies_record_attributes.rb

@@ -0,0 +1,220 @@
+=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
+  class CompaniesRecordAttributes
+    attr_accessor :company_funding_summary
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'company_funding_summary' => :'company_funding_summary'
+      }
+    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_funding_summary' => :'CompanyFundingSummaryRow'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CompaniesRecordAttributes` 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::CompaniesRecordAttributes`. 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_funding_summary')
+        self.company_funding_summary = attributes[:'company_funding_summary']
+      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_funding_summary == o.company_funding_summary
+    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_funding_summary].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/companies_row.rb

@@ -34,13 +34,13 @@ module PharmaObservatory
     # The roles the company's organizations play (Manufacturer, Sponsor and so on).
     attr_accessor :org_kinds
 
-    # SEC EDGAR central index key of the representative record, when it files.
+    # 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 page shows.
+    # 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.
@@ -88,6 +88,12 @@ module PharmaObservatory
     # 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
       {
@@ -114,7 +120,9 @@ module PharmaObservatory
         :'num_trials' => :'num_trials',
         :'total_lead_enrollment' => :'total_lead_enrollment',
         :'num_recent_lead_trials' => :'num_recent_lead_trials',
-        :'activity_score' => :'activity_score'
+        :'activity_score' => :'activity_score',
+        :'is_admitted' => :'is_admitted',
+        :'has_public_page' => :'has_public_page'
       }
     end
 
@@ -154,7 +162,9 @@ module PharmaObservatory
         :'num_trials' => :'Integer',
         :'total_lead_enrollment' => :'Integer',
         :'num_recent_lead_trials' => :'Integer',
-        :'activity_score' => :'Float'
+        :'activity_score' => :'Float',
+        :'is_admitted' => :'Boolean',
+        :'has_public_page' => :'Boolean'
       }
     end
 
@@ -184,7 +194,9 @@ module PharmaObservatory
         :'num_trials',
         :'total_lead_enrollment',
         :'num_recent_lead_trials',
-        :'activity_score'
+        :'activity_score',
+        :'is_admitted',
+        :'has_public_page'
       ])
     end
 
@@ -301,6 +313,14 @@ module PharmaObservatory
       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?
@@ -346,7 +366,9 @@ module PharmaObservatory
           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
+          activity_score == o.activity_score &&
+          is_admitted == o.is_admitted &&
+          has_public_page == o.has_public_page
     end
 
     # @see the `==` method
@@ -358,7 +380,7 @@ module PharmaObservatory
     # 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].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