pharmaobservatory 0.1.5 → 0.1.7

data/lib/pharmaobservatory/models/rwd_register_provenance_row.rb

@@ -0,0 +1,531 @@
+=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 rwd_register_provenance dataset: one row per register export. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RwdRegisterProvenanceRow
+    # Which of the five exports the row concerns: study, data_source_human, data_source_veterinary, institution or network. The entry key of the rwd_registers object type.
+    attr_accessor :register_key
+
+    # The register's plain-words label.
+    attr_accessor :register_label
+
+    # The register's position in the lane's order.
+    attr_accessor :register_ordinal
+
+    # The landed source name of the export.
+    attr_accessor :provenance_source
+
+    # True when the export held no rows at the source.
+    attr_accessor :export_is_empty_at_source
+
+    # How many rows the export landed.
+    attr_accessor :landed_rows
+
+    # The status of the latest landing run.
+    attr_accessor :build_status
+
+    # The snapshot id of the latest landing run.
+    attr_accessor :build_snapshot_id
+
+    # The row count of the latest landing run.
+    attr_accessor :build_row_count
+
+    # When the latest landing run started (UTC).
+    attr_accessor :build_started_at
+
+    # When the latest landing run finished (UTC).
+    attr_accessor :build_finished_at
+
+    # The snapshot id of the last completed landing.
+    attr_accessor :last_completed_snapshot_id
+
+    # The row count of the last completed landing.
+    attr_accessor :last_completed_row_count
+
+    # When the last completed landing finished (UTC).
+    attr_accessor :last_completed_at
+
+    # The cutoff of the registrant clock: the snapshot date less twelve months; a record last updated before it counts as older than twelve months.
+    attr_accessor :registrant_clock_asof
+
+    # Whether the export carries an update date column.
+    attr_accessor :register_publishes_update_date
+
+    # How many records carry an update date.
+    attr_accessor :records_with_an_update_date
+
+    # How many records were last updated more than twelve months before the snapshot.
+    attr_accessor :records_updated_over_twelve_months
+
+    # The share of records with an update date that are older than twelve months.
+    attr_accessor :share_updated_over_twelve_months
+
+    # Whether the export carries EMA's Outdated flag.
+    attr_accessor :register_publishes_outdated_flag
+
+    # How many records EMA flags Outdated.
+    attr_accessor :records_ema_flags_outdated
+
+    # How many records have no Outdated flag value.
+    attr_accessor :records_outdated_flag_blank
+
+    # How many columns of the export this lane lands.
+    attr_accessor :columns_landed
+
+    # How many columns of the export the lane withholds (contact details of named individuals).
+    attr_accessor :columns_withheld
+
+    # The label of the catalogue snapshot the row was read from (a date).
+    attr_accessor :snapshot_label
+
+    # The date of the catalogue snapshot.
+    attr_accessor :snapshot_date
+
+    # The month and year the catalogue was accessed (YYYY-MM), which EMA's site asks to be cited with its URL.
+    attr_accessor :accessed_month
+
+    # The license restriction tier of the row's source. Every row of this dataset is licensable (PROVISIONAL, legal read pending).
+    attr_accessor :restriction_tier
+
+    # The attribution line EMA requires, including the catalogue URL and the access month; quote it with any figure taken from the row.
+    attr_accessor :attribution
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'register_key' => :'register_key',
+        :'register_label' => :'register_label',
+        :'register_ordinal' => :'register_ordinal',
+        :'provenance_source' => :'provenance_source',
+        :'export_is_empty_at_source' => :'export_is_empty_at_source',
+        :'landed_rows' => :'landed_rows',
+        :'build_status' => :'build_status',
+        :'build_snapshot_id' => :'build_snapshot_id',
+        :'build_row_count' => :'build_row_count',
+        :'build_started_at' => :'build_started_at',
+        :'build_finished_at' => :'build_finished_at',
+        :'last_completed_snapshot_id' => :'last_completed_snapshot_id',
+        :'last_completed_row_count' => :'last_completed_row_count',
+        :'last_completed_at' => :'last_completed_at',
+        :'registrant_clock_asof' => :'registrant_clock_asof',
+        :'register_publishes_update_date' => :'register_publishes_update_date',
+        :'records_with_an_update_date' => :'records_with_an_update_date',
+        :'records_updated_over_twelve_months' => :'records_updated_over_twelve_months',
+        :'share_updated_over_twelve_months' => :'share_updated_over_twelve_months',
+        :'register_publishes_outdated_flag' => :'register_publishes_outdated_flag',
+        :'records_ema_flags_outdated' => :'records_ema_flags_outdated',
+        :'records_outdated_flag_blank' => :'records_outdated_flag_blank',
+        :'columns_landed' => :'columns_landed',
+        :'columns_withheld' => :'columns_withheld',
+        :'snapshot_label' => :'snapshot_label',
+        :'snapshot_date' => :'snapshot_date',
+        :'accessed_month' => :'accessed_month',
+        :'restriction_tier' => :'restriction_tier',
+        :'attribution' => :'attribution'
+      }
+    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
+      {
+        :'register_key' => :'String',
+        :'register_label' => :'String',
+        :'register_ordinal' => :'Integer',
+        :'provenance_source' => :'String',
+        :'export_is_empty_at_source' => :'Boolean',
+        :'landed_rows' => :'Integer',
+        :'build_status' => :'String',
+        :'build_snapshot_id' => :'String',
+        :'build_row_count' => :'Integer',
+        :'build_started_at' => :'Time',
+        :'build_finished_at' => :'Time',
+        :'last_completed_snapshot_id' => :'String',
+        :'last_completed_row_count' => :'Integer',
+        :'last_completed_at' => :'Time',
+        :'registrant_clock_asof' => :'Date',
+        :'register_publishes_update_date' => :'Boolean',
+        :'records_with_an_update_date' => :'Integer',
+        :'records_updated_over_twelve_months' => :'Integer',
+        :'share_updated_over_twelve_months' => :'Float',
+        :'register_publishes_outdated_flag' => :'Boolean',
+        :'records_ema_flags_outdated' => :'Integer',
+        :'records_outdated_flag_blank' => :'Integer',
+        :'columns_landed' => :'Integer',
+        :'columns_withheld' => :'Integer',
+        :'snapshot_label' => :'String',
+        :'snapshot_date' => :'Date',
+        :'accessed_month' => :'String',
+        :'restriction_tier' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'register_key',
+        :'register_label',
+        :'register_ordinal',
+        :'provenance_source',
+        :'export_is_empty_at_source',
+        :'landed_rows',
+        :'build_status',
+        :'build_snapshot_id',
+        :'build_row_count',
+        :'build_started_at',
+        :'build_finished_at',
+        :'last_completed_snapshot_id',
+        :'last_completed_row_count',
+        :'last_completed_at',
+        :'registrant_clock_asof',
+        :'register_publishes_update_date',
+        :'records_with_an_update_date',
+        :'records_updated_over_twelve_months',
+        :'share_updated_over_twelve_months',
+        :'register_publishes_outdated_flag',
+        :'records_ema_flags_outdated',
+        :'records_outdated_flag_blank',
+        :'columns_landed',
+        :'columns_withheld',
+        :'snapshot_label',
+        :'snapshot_date',
+        :'accessed_month',
+        :'restriction_tier',
+        :'attribution'
+      ])
+    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::RwdRegisterProvenanceRow` 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::RwdRegisterProvenanceRow`. 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?(:'register_key')
+        self.register_key = attributes[:'register_key']
+      end
+
+      if attributes.key?(:'register_label')
+        self.register_label = attributes[:'register_label']
+      end
+
+      if attributes.key?(:'register_ordinal')
+        self.register_ordinal = attributes[:'register_ordinal']
+      end
+
+      if attributes.key?(:'provenance_source')
+        self.provenance_source = attributes[:'provenance_source']
+      end
+
+      if attributes.key?(:'export_is_empty_at_source')
+        self.export_is_empty_at_source = attributes[:'export_is_empty_at_source']
+      end
+
+      if attributes.key?(:'landed_rows')
+        self.landed_rows = attributes[:'landed_rows']
+      end
+
+      if attributes.key?(:'build_status')
+        self.build_status = attributes[:'build_status']
+      end
+
+      if attributes.key?(:'build_snapshot_id')
+        self.build_snapshot_id = attributes[:'build_snapshot_id']
+      end
+
+      if attributes.key?(:'build_row_count')
+        self.build_row_count = attributes[:'build_row_count']
+      end
+
+      if attributes.key?(:'build_started_at')
+        self.build_started_at = attributes[:'build_started_at']
+      end
+
+      if attributes.key?(:'build_finished_at')
+        self.build_finished_at = attributes[:'build_finished_at']
+      end
+
+      if attributes.key?(:'last_completed_snapshot_id')
+        self.last_completed_snapshot_id = attributes[:'last_completed_snapshot_id']
+      end
+
+      if attributes.key?(:'last_completed_row_count')
+        self.last_completed_row_count = attributes[:'last_completed_row_count']
+      end
+
+      if attributes.key?(:'last_completed_at')
+        self.last_completed_at = attributes[:'last_completed_at']
+      end
+
+      if attributes.key?(:'registrant_clock_asof')
+        self.registrant_clock_asof = attributes[:'registrant_clock_asof']
+      end
+
+      if attributes.key?(:'register_publishes_update_date')
+        self.register_publishes_update_date = attributes[:'register_publishes_update_date']
+      end
+
+      if attributes.key?(:'records_with_an_update_date')
+        self.records_with_an_update_date = attributes[:'records_with_an_update_date']
+      end
+
+      if attributes.key?(:'records_updated_over_twelve_months')
+        self.records_updated_over_twelve_months = attributes[:'records_updated_over_twelve_months']
+      end
+
+      if attributes.key?(:'share_updated_over_twelve_months')
+        self.share_updated_over_twelve_months = attributes[:'share_updated_over_twelve_months']
+      end
+
+      if attributes.key?(:'register_publishes_outdated_flag')
+        self.register_publishes_outdated_flag = attributes[:'register_publishes_outdated_flag']
+      end
+
+      if attributes.key?(:'records_ema_flags_outdated')
+        self.records_ema_flags_outdated = attributes[:'records_ema_flags_outdated']
+      end
+
+      if attributes.key?(:'records_outdated_flag_blank')
+        self.records_outdated_flag_blank = attributes[:'records_outdated_flag_blank']
+      end
+
+      if attributes.key?(:'columns_landed')
+        self.columns_landed = attributes[:'columns_landed']
+      end
+
+      if attributes.key?(:'columns_withheld')
+        self.columns_withheld = attributes[:'columns_withheld']
+      end
+
+      if attributes.key?(:'snapshot_label')
+        self.snapshot_label = attributes[:'snapshot_label']
+      end
+
+      if attributes.key?(:'snapshot_date')
+        self.snapshot_date = attributes[:'snapshot_date']
+      end
+
+      if attributes.key?(:'accessed_month')
+        self.accessed_month = attributes[:'accessed_month']
+      end
+
+      if attributes.key?(:'restriction_tier')
+        self.restriction_tier = attributes[:'restriction_tier']
+      end
+
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      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 &&
+          register_key == o.register_key &&
+          register_label == o.register_label &&
+          register_ordinal == o.register_ordinal &&
+          provenance_source == o.provenance_source &&
+          export_is_empty_at_source == o.export_is_empty_at_source &&
+          landed_rows == o.landed_rows &&
+          build_status == o.build_status &&
+          build_snapshot_id == o.build_snapshot_id &&
+          build_row_count == o.build_row_count &&
+          build_started_at == o.build_started_at &&
+          build_finished_at == o.build_finished_at &&
+          last_completed_snapshot_id == o.last_completed_snapshot_id &&
+          last_completed_row_count == o.last_completed_row_count &&
+          last_completed_at == o.last_completed_at &&
+          registrant_clock_asof == o.registrant_clock_asof &&
+          register_publishes_update_date == o.register_publishes_update_date &&
+          records_with_an_update_date == o.records_with_an_update_date &&
+          records_updated_over_twelve_months == o.records_updated_over_twelve_months &&
+          share_updated_over_twelve_months == o.share_updated_over_twelve_months &&
+          register_publishes_outdated_flag == o.register_publishes_outdated_flag &&
+          records_ema_flags_outdated == o.records_ema_flags_outdated &&
+          records_outdated_flag_blank == o.records_outdated_flag_blank &&
+          columns_landed == o.columns_landed &&
+          columns_withheld == o.columns_withheld &&
+          snapshot_label == o.snapshot_label &&
+          snapshot_date == o.snapshot_date &&
+          accessed_month == o.accessed_month &&
+          restriction_tier == o.restriction_tier &&
+          attribution == o.attribution
+    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
+      [register_key, register_label, register_ordinal, provenance_source, export_is_empty_at_source, landed_rows, build_status, build_snapshot_id, build_row_count, build_started_at, build_finished_at, last_completed_snapshot_id, last_completed_row_count, last_completed_at, registrant_clock_asof, register_publishes_update_date, records_with_an_update_date, records_updated_over_twelve_months, share_updated_over_twelve_months, register_publishes_outdated_flag, records_ema_flags_outdated, records_outdated_flag_blank, columns_landed, columns_withheld, snapshot_label, snapshot_date, accessed_month, restriction_tier, attribution].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