pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/enforcement_events_row.rb

@@ -0,0 +1,476 @@
+=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 enforcement_events dataset: one row per enforcement event. A grouped request returns the group columns and the measures instead, as additional properties.
+  class EnforcementEventsRow
+    # The event id: a hash of the lane and the lane's own key, unique across lanes.
+    attr_accessor :event_id
+
+    # The lane the event came from: inspection_483 (an FDA inspection), import_refusal, warning_letter, untitled_letter, debarment or recall.
+    attr_accessor :source
+
+    # The event date: the inspection date, refusal date, letter issue date (posted date when there is none), debarment effective date or recall initiation date.
+    attr_accessor :event_date
+
+    # The regulatory domain of the event, derived from the lane's own classifier: drug, biologic, device, veterinary, food, cosmetic, tobacco or other.
+    attr_accessor :domain
+
+    # True when domain is drug, biologic or device.
+    attr_accessor :is_biomedical
+
+    # A one-line description: the inspection product type, the refused product, the letter subject, the debarment type or the recalled product.
+    attr_accessor :headline
+
+    # The lane's supporting text: the cited regulations of an inspection, the refusal charges, the issuing office of a warning letter, the debarment term and citation, or the recall reason.
+    attr_accessor :detail
+
+    # The inspection outcome (NAI no action indicated, VAI voluntary action indicated, OAI official action indicated); null for every other lane.
+    attr_accessor :classification
+
+    # The recall severity class (Class I, II or III); null for every other lane.
+    attr_accessor :recall_class
+
+    # True when the inspection ended with a Form 483 of observations; null for every other lane.
+    attr_accessor :had_483
+
+    # The regulator's page for the event, where the lane has one.
+    attr_accessor :source_url
+
+    # The lane's own reference, where it has one: the letter id, debarment id or recall number.
+    attr_accessor :source_ref
+
+    # The FDA device class of an import-refusal product, from the device classification dimension; null for every other lane.
+    attr_accessor :device_class
+
+    # The medical specialty of an import-refusal device product; null for every other lane.
+    attr_accessor :device_specialty
+
+    # True for a device event the biomedical view hides by default (a low-signal commodity class).
+    attr_accessor :is_low_signal_device
+
+    # The firm's name as filed with the regulator (the party named on the record, an individual for an individual debarment).
+    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 well the firm name was attached to an organization: high, medium or low name-and-geography matches, registry (the operating firm of a registered facility), ambiguous or unresolved.
+    attr_accessor :match_tier
+
+    # The route that attached the firm: fei_bridge (the FDA establishment identifier bridge), fei_firm_mint or fei_firm_fold (the operating firm's registry record), firm_name_geo (name and geography), firm_name_only (name alone) or unresolved.
+    attr_accessor :org_resolution_method
+
+    # True when the firm was attached to an organization. A false row is kept with null firm ids and the name as filed, so an empty read for a company is not proof of no enforcement history.
+    attr_accessor :is_org_resolved
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event_id' => :'event_id',
+        :'source' => :'source',
+        :'event_date' => :'event_date',
+        :'domain' => :'domain',
+        :'is_biomedical' => :'is_biomedical',
+        :'headline' => :'headline',
+        :'detail' => :'detail',
+        :'classification' => :'classification',
+        :'recall_class' => :'recall_class',
+        :'had_483' => :'had_483',
+        :'source_url' => :'source_url',
+        :'source_ref' => :'source_ref',
+        :'device_class' => :'device_class',
+        :'device_specialty' => :'device_specialty',
+        :'is_low_signal_device' => :'is_low_signal_device',
+        :'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',
+        :'org_resolution_method' => :'org_resolution_method',
+        :'is_org_resolved' => :'is_org_resolved'
+      }
+    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
+      {
+        :'event_id' => :'String',
+        :'source' => :'String',
+        :'event_date' => :'Date',
+        :'domain' => :'String',
+        :'is_biomedical' => :'Boolean',
+        :'headline' => :'String',
+        :'detail' => :'String',
+        :'classification' => :'String',
+        :'recall_class' => :'String',
+        :'had_483' => :'Boolean',
+        :'source_url' => :'String',
+        :'source_ref' => :'String',
+        :'device_class' => :'String',
+        :'device_specialty' => :'String',
+        :'is_low_signal_device' => :'Boolean',
+        :'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',
+        :'org_resolution_method' => :'String',
+        :'is_org_resolved' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'event_id',
+        :'source',
+        :'event_date',
+        :'domain',
+        :'is_biomedical',
+        :'headline',
+        :'detail',
+        :'classification',
+        :'recall_class',
+        :'had_483',
+        :'source_url',
+        :'source_ref',
+        :'device_class',
+        :'device_specialty',
+        :'is_low_signal_device',
+        :'firm_name',
+        :'firm_org_id',
+        :'firm_company_id',
+        :'firm_company_name',
+        :'firm_group_id',
+        :'firm_group_name',
+        :'match_tier',
+        :'org_resolution_method',
+        :'is_org_resolved'
+      ])
+    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::EnforcementEventsRow` 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::EnforcementEventsRow`. 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?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'event_date')
+        self.event_date = attributes[:'event_date']
+      end
+
+      if attributes.key?(:'domain')
+        self.domain = attributes[:'domain']
+      end
+
+      if attributes.key?(:'is_biomedical')
+        self.is_biomedical = attributes[:'is_biomedical']
+      end
+
+      if attributes.key?(:'headline')
+        self.headline = attributes[:'headline']
+      end
+
+      if attributes.key?(:'detail')
+        self.detail = attributes[:'detail']
+      end
+
+      if attributes.key?(:'classification')
+        self.classification = attributes[:'classification']
+      end
+
+      if attributes.key?(:'recall_class')
+        self.recall_class = attributes[:'recall_class']
+      end
+
+      if attributes.key?(:'had_483')
+        self.had_483 = attributes[:'had_483']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'source_ref')
+        self.source_ref = attributes[:'source_ref']
+      end
+
+      if attributes.key?(:'device_class')
+        self.device_class = attributes[:'device_class']
+      end
+
+      if attributes.key?(:'device_specialty')
+        self.device_specialty = attributes[:'device_specialty']
+      end
+
+      if attributes.key?(:'is_low_signal_device')
+        self.is_low_signal_device = attributes[:'is_low_signal_device']
+      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?(:'org_resolution_method')
+        self.org_resolution_method = attributes[:'org_resolution_method']
+      end
+
+      if attributes.key?(:'is_org_resolved')
+        self.is_org_resolved = attributes[:'is_org_resolved']
+      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 &&
+          event_id == o.event_id &&
+          source == o.source &&
+          event_date == o.event_date &&
+          domain == o.domain &&
+          is_biomedical == o.is_biomedical &&
+          headline == o.headline &&
+          detail == o.detail &&
+          classification == o.classification &&
+          recall_class == o.recall_class &&
+          had_483 == o.had_483 &&
+          source_url == o.source_url &&
+          source_ref == o.source_ref &&
+          device_class == o.device_class &&
+          device_specialty == o.device_specialty &&
+          is_low_signal_device == o.is_low_signal_device &&
+          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 &&
+          org_resolution_method == o.org_resolution_method &&
+          is_org_resolved == o.is_org_resolved
+    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
+      [event_id, source, event_date, domain, is_biomedical, headline, detail, classification, recall_class, had_483, source_url, source_ref, device_class, device_specialty, is_low_signal_device, firm_name, firm_org_id, firm_company_id, firm_company_name, firm_group_id, firm_group_name, match_tier, org_resolution_method, is_org_resolved].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