pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/clia_certificates_row.rb

@@ -0,0 +1,568 @@
+=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 clia_certificates dataset: one row per CLIA certificate. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CliaCertificatesRow
+    # The ten-character CLIA certificate number.
+    attr_accessor :clia_number
+
+    # The laboratory's name as listed on the certificate.
+    attr_accessor :lab_name
+
+    # The organization the certificate resolved to (its canonical name).
+    attr_accessor :firm_name
+
+    # Legal-entity level: the organization record the firm resolved to (null when the firm did not resolve).
+    attr_accessor :firm_org_id
+
+    # Company level: the firm's company (null when unresolved); the entry key for the companies object type.
+    attr_accessor :firm_company_id
+
+    # Display name of the firm's company.
+    attr_accessor :firm_company_name
+
+    # Group level: the firm's current ultimate parent; a root's group is itself.
+    attr_accessor :firm_group_id
+
+    # Display name of the firm's group.
+    attr_accessor :firm_group_name
+
+    # How the certificate was attached to the organization: high, medium or low.
+    attr_accessor :match_tier
+
+    # The matcher's confidence, 0 to 1.
+    attr_accessor :match_confidence
+
+    # The laboratory's city.
+    attr_accessor :city
+
+    # The laboratory's state.
+    attr_accessor :state_region
+
+    # The five-digit postal code.
+    attr_accessor :postal5
+
+    # The country code.
+    attr_accessor :country
+
+    # Latitude in degrees (WGS84), for the map tool.
+    attr_accessor :latitude
+
+    # Longitude in degrees (WGS84), for the map tool.
+    attr_accessor :longitude
+
+    # What a pin locates (an address, a postal code or a city).
+    attr_accessor :geocode_precision
+
+    # Where the coordinates came from.
+    attr_accessor :coord_source
+
+    # True when the certificate is active on the file.
+    attr_accessor :is_active
+
+    # The CLIA certificate type (for example Compliance, Accreditation or Waiver).
+    attr_accessor :certificate_type
+
+    # The highest test complexity the certificate permits.
+    attr_accessor :complexity_ceiling
+
+    # The accreditation body the file names.
+    attr_accessor :accreditor_claimed
+
+    # The accreditation body confirmed against the accreditor's own list.
+    attr_accessor :accreditor_confirmed
+
+    # True when the laboratory holds College of American Pathologists (CAP) accreditation.
+    attr_accessor :has_cap_accreditation
+
+    # True when the laboratory holds American Society for Histocompatibility and Immunogenetics (ASHI) accreditation.
+    attr_accessor :has_ashi_accreditation
+
+    # True when the laboratory holds AABB (formerly American Association of Blood Banks) accreditation.
+    attr_accessor :has_aabb_accreditation
+
+    # The laboratory's facility type on the file.
+    attr_accessor :facility_type
+
+    # Reported annual test volume.
+    attr_accessor :annual_test_volume
+
+    # Where the volume figure came from.
+    attr_accessor :test_volume_source
+
+    # How many sites the laboratory reports.
+    attr_accessor :lab_site_count
+
+    # The vintage of the CMS Provider of Services file.
+    attr_accessor :pos_vintage
+
+    # The build date of the figures.
+    attr_accessor :as_of
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'clia_number' => :'clia_number',
+        :'lab_name' => :'lab_name',
+        :'firm_name' => :'firm_name',
+        :'firm_org_id' => :'firm_org_id',
+        :'firm_company_id' => :'firm_company_id',
+        :'firm_company_name' => :'firm_company_name',
+        :'firm_group_id' => :'firm_group_id',
+        :'firm_group_name' => :'firm_group_name',
+        :'match_tier' => :'match_tier',
+        :'match_confidence' => :'match_confidence',
+        :'city' => :'city',
+        :'state_region' => :'state_region',
+        :'postal5' => :'postal5',
+        :'country' => :'country',
+        :'latitude' => :'latitude',
+        :'longitude' => :'longitude',
+        :'geocode_precision' => :'geocode_precision',
+        :'coord_source' => :'coord_source',
+        :'is_active' => :'is_active',
+        :'certificate_type' => :'certificate_type',
+        :'complexity_ceiling' => :'complexity_ceiling',
+        :'accreditor_claimed' => :'accreditor_claimed',
+        :'accreditor_confirmed' => :'accreditor_confirmed',
+        :'has_cap_accreditation' => :'has_cap_accreditation',
+        :'has_ashi_accreditation' => :'has_ashi_accreditation',
+        :'has_aabb_accreditation' => :'has_aabb_accreditation',
+        :'facility_type' => :'facility_type',
+        :'annual_test_volume' => :'annual_test_volume',
+        :'test_volume_source' => :'test_volume_source',
+        :'lab_site_count' => :'lab_site_count',
+        :'pos_vintage' => :'pos_vintage',
+        :'as_of' => :'as_of'
+      }
+    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
+      {
+        :'clia_number' => :'String',
+        :'lab_name' => :'String',
+        :'firm_name' => :'String',
+        :'firm_org_id' => :'String',
+        :'firm_company_id' => :'String',
+        :'firm_company_name' => :'String',
+        :'firm_group_id' => :'String',
+        :'firm_group_name' => :'String',
+        :'match_tier' => :'String',
+        :'match_confidence' => :'Float',
+        :'city' => :'String',
+        :'state_region' => :'String',
+        :'postal5' => :'String',
+        :'country' => :'String',
+        :'latitude' => :'Float',
+        :'longitude' => :'Float',
+        :'geocode_precision' => :'String',
+        :'coord_source' => :'String',
+        :'is_active' => :'Boolean',
+        :'certificate_type' => :'String',
+        :'complexity_ceiling' => :'String',
+        :'accreditor_claimed' => :'Array<String>',
+        :'accreditor_confirmed' => :'Array<String>',
+        :'has_cap_accreditation' => :'Boolean',
+        :'has_ashi_accreditation' => :'Boolean',
+        :'has_aabb_accreditation' => :'Boolean',
+        :'facility_type' => :'String',
+        :'annual_test_volume' => :'Integer',
+        :'test_volume_source' => :'String',
+        :'lab_site_count' => :'Integer',
+        :'pos_vintage' => :'String',
+        :'as_of' => :'Date'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'clia_number',
+        :'lab_name',
+        :'firm_name',
+        :'firm_org_id',
+        :'firm_company_id',
+        :'firm_company_name',
+        :'firm_group_id',
+        :'firm_group_name',
+        :'match_tier',
+        :'match_confidence',
+        :'city',
+        :'state_region',
+        :'postal5',
+        :'country',
+        :'latitude',
+        :'longitude',
+        :'geocode_precision',
+        :'coord_source',
+        :'is_active',
+        :'certificate_type',
+        :'complexity_ceiling',
+        :'accreditor_claimed',
+        :'accreditor_confirmed',
+        :'has_cap_accreditation',
+        :'has_ashi_accreditation',
+        :'has_aabb_accreditation',
+        :'facility_type',
+        :'annual_test_volume',
+        :'test_volume_source',
+        :'lab_site_count',
+        :'pos_vintage',
+        :'as_of'
+      ])
+    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::CliaCertificatesRow` 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::CliaCertificatesRow`. 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?(:'clia_number')
+        self.clia_number = attributes[:'clia_number']
+      end
+
+      if attributes.key?(:'lab_name')
+        self.lab_name = attributes[:'lab_name']
+      end
+
+      if attributes.key?(:'firm_name')
+        self.firm_name = attributes[:'firm_name']
+      end
+
+      if attributes.key?(:'firm_org_id')
+        self.firm_org_id = attributes[:'firm_org_id']
+      end
+
+      if attributes.key?(:'firm_company_id')
+        self.firm_company_id = attributes[:'firm_company_id']
+      end
+
+      if attributes.key?(:'firm_company_name')
+        self.firm_company_name = attributes[:'firm_company_name']
+      end
+
+      if attributes.key?(:'firm_group_id')
+        self.firm_group_id = attributes[:'firm_group_id']
+      end
+
+      if attributes.key?(:'firm_group_name')
+        self.firm_group_name = attributes[:'firm_group_name']
+      end
+
+      if attributes.key?(:'match_tier')
+        self.match_tier = attributes[:'match_tier']
+      end
+
+      if attributes.key?(:'match_confidence')
+        self.match_confidence = attributes[:'match_confidence']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'state_region')
+        self.state_region = attributes[:'state_region']
+      end
+
+      if attributes.key?(:'postal5')
+        self.postal5 = attributes[:'postal5']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'latitude')
+        self.latitude = attributes[:'latitude']
+      end
+
+      if attributes.key?(:'longitude')
+        self.longitude = attributes[:'longitude']
+      end
+
+      if attributes.key?(:'geocode_precision')
+        self.geocode_precision = attributes[:'geocode_precision']
+      end
+
+      if attributes.key?(:'coord_source')
+        self.coord_source = attributes[:'coord_source']
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      end
+
+      if attributes.key?(:'certificate_type')
+        self.certificate_type = attributes[:'certificate_type']
+      end
+
+      if attributes.key?(:'complexity_ceiling')
+        self.complexity_ceiling = attributes[:'complexity_ceiling']
+      end
+
+      if attributes.key?(:'accreditor_claimed')
+        if (value = attributes[:'accreditor_claimed']).is_a?(Array)
+          self.accreditor_claimed = value
+        end
+      end
+
+      if attributes.key?(:'accreditor_confirmed')
+        if (value = attributes[:'accreditor_confirmed']).is_a?(Array)
+          self.accreditor_confirmed = value
+        end
+      end
+
+      if attributes.key?(:'has_cap_accreditation')
+        self.has_cap_accreditation = attributes[:'has_cap_accreditation']
+      end
+
+      if attributes.key?(:'has_ashi_accreditation')
+        self.has_ashi_accreditation = attributes[:'has_ashi_accreditation']
+      end
+
+      if attributes.key?(:'has_aabb_accreditation')
+        self.has_aabb_accreditation = attributes[:'has_aabb_accreditation']
+      end
+
+      if attributes.key?(:'facility_type')
+        self.facility_type = attributes[:'facility_type']
+      end
+
+      if attributes.key?(:'annual_test_volume')
+        self.annual_test_volume = attributes[:'annual_test_volume']
+      end
+
+      if attributes.key?(:'test_volume_source')
+        self.test_volume_source = attributes[:'test_volume_source']
+      end
+
+      if attributes.key?(:'lab_site_count')
+        self.lab_site_count = attributes[:'lab_site_count']
+      end
+
+      if attributes.key?(:'pos_vintage')
+        self.pos_vintage = attributes[:'pos_vintage']
+      end
+
+      if attributes.key?(:'as_of')
+        self.as_of = attributes[:'as_of']
+      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 &&
+          clia_number == o.clia_number &&
+          lab_name == o.lab_name &&
+          firm_name == o.firm_name &&
+          firm_org_id == o.firm_org_id &&
+          firm_company_id == o.firm_company_id &&
+          firm_company_name == o.firm_company_name &&
+          firm_group_id == o.firm_group_id &&
+          firm_group_name == o.firm_group_name &&
+          match_tier == o.match_tier &&
+          match_confidence == o.match_confidence &&
+          city == o.city &&
+          state_region == o.state_region &&
+          postal5 == o.postal5 &&
+          country == o.country &&
+          latitude == o.latitude &&
+          longitude == o.longitude &&
+          geocode_precision == o.geocode_precision &&
+          coord_source == o.coord_source &&
+          is_active == o.is_active &&
+          certificate_type == o.certificate_type &&
+          complexity_ceiling == o.complexity_ceiling &&
+          accreditor_claimed == o.accreditor_claimed &&
+          accreditor_confirmed == o.accreditor_confirmed &&
+          has_cap_accreditation == o.has_cap_accreditation &&
+          has_ashi_accreditation == o.has_ashi_accreditation &&
+          has_aabb_accreditation == o.has_aabb_accreditation &&
+          facility_type == o.facility_type &&
+          annual_test_volume == o.annual_test_volume &&
+          test_volume_source == o.test_volume_source &&
+          lab_site_count == o.lab_site_count &&
+          pos_vintage == o.pos_vintage &&
+          as_of == o.as_of
+    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
+      [clia_number, lab_name, firm_name, firm_org_id, firm_company_id, firm_company_name, firm_group_id, firm_group_name, match_tier, match_confidence, city, state_region, postal5, country, latitude, longitude, geocode_precision, coord_source, is_active, certificate_type, complexity_ceiling, accreditor_claimed, accreditor_confirmed, has_cap_accreditation, has_ashi_accreditation, has_aabb_accreditation, facility_type, annual_test_volume, test_volume_source, lab_site_count, pos_vintage, as_of].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_record_attributes.rb

@@ -17,10 +17,13 @@ module PharmaObservatory
   class CompaniesRecordAttributes
     attr_accessor :company_funding_summary
 
+    attr_accessor :company_trial_geography
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'company_funding_summary' => :'company_funding_summary'
+        :'company_funding_summary' => :'company_funding_summary',
+        :'company_trial_geography' => :'company_trial_geography'
       }
     end
 
@@ -37,7 +40,8 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'company_funding_summary' => :'CompanyFundingSummaryRow'
+        :'company_funding_summary' => :'CompanyFundingSummaryRow',
+        :'company_trial_geography' => :'CompanyTrialGeographyRow'
       }
     end
 
@@ -66,6 +70,10 @@ module PharmaObservatory
       if attributes.key?(:'company_funding_summary')
         self.company_funding_summary = attributes[:'company_funding_summary']
       end
+
+      if attributes.key?(:'company_trial_geography')
+        self.company_trial_geography = attributes[:'company_trial_geography']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,7 +96,8 @@ module PharmaObservatory
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          company_funding_summary == o.company_funding_summary
+          company_funding_summary == o.company_funding_summary &&
+          company_trial_geography == o.company_trial_geography
     end
 
     # @see the `==` method
@@ -100,7 +109,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [company_funding_summary].hash
+      [company_funding_summary, company_trial_geography].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/company_funding_events_row.rb

@@ -79,6 +79,9 @@ module PharmaObservatory
     # Grant applications folded into the event; 1 for the other sources.
     attr_accessor :n_awards
 
+    # Whether the event is life-sciences capital: a grant is always true, a Regulation D offering follows the filer's self-declared industry group, and an extracted financing follows the filer's SIC code. Never null; a filer that cannot be classified is false.
+    attr_accessor :is_biomedical
+
     # The running total of disclosed amounts over the company's own events up to and including this one, in date order; null where the event has no company.
     attr_accessor :cumulative_raised_usd
 
@@ -109,6 +112,7 @@ module PharmaObservatory
         :'event_stage' => :'event_stage',
         :'administering_ic' => :'administering_ic',
         :'n_awards' => :'n_awards',
+        :'is_biomedical' => :'is_biomedical',
         :'cumulative_raised_usd' => :'cumulative_raised_usd',
         :'source_url' => :'source_url'
       }
@@ -148,6 +152,7 @@ module PharmaObservatory
         :'event_stage' => :'String',
         :'administering_ic' => :'String',
         :'n_awards' => :'Integer',
+        :'is_biomedical' => :'Boolean',
         :'cumulative_raised_usd' => :'Float',
         :'source_url' => :'String'
       }
@@ -177,6 +182,7 @@ module PharmaObservatory
         :'event_stage',
         :'administering_ic',
         :'n_awards',
+        :'is_biomedical',
         :'cumulative_raised_usd',
         :'source_url'
       ])
@@ -282,6 +288,10 @@ module PharmaObservatory
         self.n_awards = attributes[:'n_awards']
       end
 
+      if attributes.key?(:'is_biomedical')
+        self.is_biomedical = attributes[:'is_biomedical']
+      end
+
       if attributes.key?(:'cumulative_raised_usd')
         self.cumulative_raised_usd = attributes[:'cumulative_raised_usd']
       end
@@ -332,6 +342,7 @@ module PharmaObservatory
           event_stage == o.event_stage &&
           administering_ic == o.administering_ic &&
           n_awards == o.n_awards &&
+          is_biomedical == o.is_biomedical &&
           cumulative_raised_usd == o.cumulative_raised_usd &&
           source_url == o.source_url
     end
@@ -345,7 +356,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [funding_event_id, issuer_name, issuer_org_id, issuer_company_id, issuer_company_name, issuer_group_id, issuer_group_name, event_date, fiscal_year, source, round_type, round_subtype, is_dilutive, amount_usd, currency, amount_is_disclosed, capital_treatment, is_actual_issuer_inflow, event_stage, administering_ic, n_awards, cumulative_raised_usd, source_url].hash
+      [funding_event_id, issuer_name, issuer_org_id, issuer_company_id, issuer_company_name, issuer_group_id, issuer_group_name, event_date, fiscal_year, source, round_type, round_subtype, is_dilutive, amount_usd, currency, amount_is_disclosed, capital_treatment, is_actual_issuer_inflow, event_stage, administering_ic, n_awards, is_biomedical, cumulative_raised_usd, source_url].hash
     end
 
     # Builds the object from hash