pharmaobservatory 0.1.7 → 0.1.9

data/lib/pharmaobservatory/models/investigator_inspections_row.rb

@@ -0,0 +1,377 @@
+=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 investigator_inspections dataset: one row per resolved investigator and BIMO inspection record (inspection by deficiency code). A grouped request returns the group columns and the measures instead, as additional properties.
+  class InvestigatorInspectionsRow
+    # The investigator's resolved person key, the id in the web page address (/people/<id>). The entry key of the investigators object type.
+    attr_accessor :investigator_person_id
+
+    # The record id of the inspection and deficiency code.
+    attr_accessor :bimo_record_id
+
+    # The CLIIL investigator code; two codes under one name may be different people.
+    attr_accessor :bimo_investigator_id
+
+    # The inspected investigator's name as CLIIL files it ('last, first').
+    attr_accessor :inspected_investigator_name
+
+    # The inspection's date.
+    attr_accessor :inspection_date
+
+    # The inspection type code as CLIIL files it (DA or FC).
+    attr_accessor :inspection_type
+
+    # The FDA inspection classification: NAI (no action indicated), VAI (voluntary action indicated) or OAI (official action indicated).
+    attr_accessor :inspection_classification
+
+    # The deficiency code as CLIIL codes it (null when the record carries none).
+    attr_accessor :deficiency_code
+
+    # True when the inspection cited a deficiency.
+    attr_accessor :has_deficiency
+
+    # The inspected site's name.
+    attr_accessor :site_name
+
+    # The inspected site's city.
+    attr_accessor :site_city
+
+    # The inspected site's state.
+    attr_accessor :site_state
+
+    # The inspected site's country.
+    attr_accessor :site_country
+
+    # How the CLIIL investigator was matched to the person: low is a bare-name match that reaches exactly one person (the only tier published; an ambiguous or unresolved name has no person and no row).
+    attr_accessor :match_tier
+
+    # The match's confidence (0.45 for the low tier).
+    attr_accessor :match_confidence
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'investigator_person_id' => :'investigator_person_id',
+        :'bimo_record_id' => :'bimo_record_id',
+        :'bimo_investigator_id' => :'bimo_investigator_id',
+        :'inspected_investigator_name' => :'inspected_investigator_name',
+        :'inspection_date' => :'inspection_date',
+        :'inspection_type' => :'inspection_type',
+        :'inspection_classification' => :'inspection_classification',
+        :'deficiency_code' => :'deficiency_code',
+        :'has_deficiency' => :'has_deficiency',
+        :'site_name' => :'site_name',
+        :'site_city' => :'site_city',
+        :'site_state' => :'site_state',
+        :'site_country' => :'site_country',
+        :'match_tier' => :'match_tier',
+        :'match_confidence' => :'match_confidence'
+      }
+    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
+      {
+        :'investigator_person_id' => :'String',
+        :'bimo_record_id' => :'String',
+        :'bimo_investigator_id' => :'String',
+        :'inspected_investigator_name' => :'String',
+        :'inspection_date' => :'Date',
+        :'inspection_type' => :'String',
+        :'inspection_classification' => :'String',
+        :'deficiency_code' => :'String',
+        :'has_deficiency' => :'Boolean',
+        :'site_name' => :'String',
+        :'site_city' => :'String',
+        :'site_state' => :'String',
+        :'site_country' => :'String',
+        :'match_tier' => :'String',
+        :'match_confidence' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'investigator_person_id',
+        :'bimo_record_id',
+        :'bimo_investigator_id',
+        :'inspected_investigator_name',
+        :'inspection_date',
+        :'inspection_type',
+        :'inspection_classification',
+        :'deficiency_code',
+        :'has_deficiency',
+        :'site_name',
+        :'site_city',
+        :'site_state',
+        :'site_country',
+        :'match_tier',
+        :'match_confidence'
+      ])
+    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::InvestigatorInspectionsRow` 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::InvestigatorInspectionsRow`. 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?(:'investigator_person_id')
+        self.investigator_person_id = attributes[:'investigator_person_id']
+      end
+
+      if attributes.key?(:'bimo_record_id')
+        self.bimo_record_id = attributes[:'bimo_record_id']
+      end
+
+      if attributes.key?(:'bimo_investigator_id')
+        self.bimo_investigator_id = attributes[:'bimo_investigator_id']
+      end
+
+      if attributes.key?(:'inspected_investigator_name')
+        self.inspected_investigator_name = attributes[:'inspected_investigator_name']
+      end
+
+      if attributes.key?(:'inspection_date')
+        self.inspection_date = attributes[:'inspection_date']
+      end
+
+      if attributes.key?(:'inspection_type')
+        self.inspection_type = attributes[:'inspection_type']
+      end
+
+      if attributes.key?(:'inspection_classification')
+        self.inspection_classification = attributes[:'inspection_classification']
+      end
+
+      if attributes.key?(:'deficiency_code')
+        self.deficiency_code = attributes[:'deficiency_code']
+      end
+
+      if attributes.key?(:'has_deficiency')
+        self.has_deficiency = attributes[:'has_deficiency']
+      end
+
+      if attributes.key?(:'site_name')
+        self.site_name = attributes[:'site_name']
+      end
+
+      if attributes.key?(:'site_city')
+        self.site_city = attributes[:'site_city']
+      end
+
+      if attributes.key?(:'site_state')
+        self.site_state = attributes[:'site_state']
+      end
+
+      if attributes.key?(:'site_country')
+        self.site_country = attributes[:'site_country']
+      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
+    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 &&
+          investigator_person_id == o.investigator_person_id &&
+          bimo_record_id == o.bimo_record_id &&
+          bimo_investigator_id == o.bimo_investigator_id &&
+          inspected_investigator_name == o.inspected_investigator_name &&
+          inspection_date == o.inspection_date &&
+          inspection_type == o.inspection_type &&
+          inspection_classification == o.inspection_classification &&
+          deficiency_code == o.deficiency_code &&
+          has_deficiency == o.has_deficiency &&
+          site_name == o.site_name &&
+          site_city == o.site_city &&
+          site_state == o.site_state &&
+          site_country == o.site_country &&
+          match_tier == o.match_tier &&
+          match_confidence == o.match_confidence
+    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
+      [investigator_person_id, bimo_record_id, bimo_investigator_id, inspected_investigator_name, inspection_date, inspection_type, inspection_classification, deficiency_code, has_deficiency, site_name, site_city, site_state, site_country, match_tier, match_confidence].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