pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/rwd_coverage_row.rb

@@ -0,0 +1,410 @@
+=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_coverage dataset: one row per chain and step. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RwdCoverageRow
+    # Which denominator chain the row belongs to.
+    attr_accessor :chain_key
+
+    # The chain's plain-words label.
+    attr_accessor :chain_label
+
+    # True when the chain's steps partition the denominator (they sum to it); false when steps overlap.
+    attr_accessor :chain_is_a_partition
+
+    # The step's position in the chain; 0 is the denominator itself, published as a step so the chain reads top to bottom.
+    attr_accessor :step_ordinal
+
+    # The step's key.
+    attr_accessor :step_key
+
+    # The step's plain-words label.
+    attr_accessor :step_label
+
+    # 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 measured count at this step.
+    attr_accessor :measured_value
+
+    # Which denominator the step is read against.
+    attr_accessor :denominator_key
+
+    # The denominator's plain-words label.
+    attr_accessor :denominator_label
+
+    # The denominator's value.
+    attr_accessor :denominator_value
+
+    # measured_value over denominator_value, as a fraction.
+    attr_accessor :share_of_denominator
+
+    # How the step is derived.
+    attr_accessor :derivation_note
+
+    # 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
+      {
+        :'chain_key' => :'chain_key',
+        :'chain_label' => :'chain_label',
+        :'chain_is_a_partition' => :'chain_is_a_partition',
+        :'step_ordinal' => :'step_ordinal',
+        :'step_key' => :'step_key',
+        :'step_label' => :'step_label',
+        :'register_key' => :'register_key',
+        :'measured_value' => :'measured_value',
+        :'denominator_key' => :'denominator_key',
+        :'denominator_label' => :'denominator_label',
+        :'denominator_value' => :'denominator_value',
+        :'share_of_denominator' => :'share_of_denominator',
+        :'derivation_note' => :'derivation_note',
+        :'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
+      {
+        :'chain_key' => :'String',
+        :'chain_label' => :'String',
+        :'chain_is_a_partition' => :'Boolean',
+        :'step_ordinal' => :'Integer',
+        :'step_key' => :'String',
+        :'step_label' => :'String',
+        :'register_key' => :'String',
+        :'measured_value' => :'Integer',
+        :'denominator_key' => :'String',
+        :'denominator_label' => :'String',
+        :'denominator_value' => :'Integer',
+        :'share_of_denominator' => :'Float',
+        :'derivation_note' => :'String',
+        :'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([
+        :'chain_key',
+        :'chain_label',
+        :'chain_is_a_partition',
+        :'step_ordinal',
+        :'step_key',
+        :'step_label',
+        :'register_key',
+        :'measured_value',
+        :'denominator_key',
+        :'denominator_label',
+        :'denominator_value',
+        :'share_of_denominator',
+        :'derivation_note',
+        :'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::RwdCoverageRow` 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::RwdCoverageRow`. 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?(:'chain_key')
+        self.chain_key = attributes[:'chain_key']
+      end
+
+      if attributes.key?(:'chain_label')
+        self.chain_label = attributes[:'chain_label']
+      end
+
+      if attributes.key?(:'chain_is_a_partition')
+        self.chain_is_a_partition = attributes[:'chain_is_a_partition']
+      end
+
+      if attributes.key?(:'step_ordinal')
+        self.step_ordinal = attributes[:'step_ordinal']
+      end
+
+      if attributes.key?(:'step_key')
+        self.step_key = attributes[:'step_key']
+      end
+
+      if attributes.key?(:'step_label')
+        self.step_label = attributes[:'step_label']
+      end
+
+      if attributes.key?(:'register_key')
+        self.register_key = attributes[:'register_key']
+      end
+
+      if attributes.key?(:'measured_value')
+        self.measured_value = attributes[:'measured_value']
+      end
+
+      if attributes.key?(:'denominator_key')
+        self.denominator_key = attributes[:'denominator_key']
+      end
+
+      if attributes.key?(:'denominator_label')
+        self.denominator_label = attributes[:'denominator_label']
+      end
+
+      if attributes.key?(:'denominator_value')
+        self.denominator_value = attributes[:'denominator_value']
+      end
+
+      if attributes.key?(:'share_of_denominator')
+        self.share_of_denominator = attributes[:'share_of_denominator']
+      end
+
+      if attributes.key?(:'derivation_note')
+        self.derivation_note = attributes[:'derivation_note']
+      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 &&
+          chain_key == o.chain_key &&
+          chain_label == o.chain_label &&
+          chain_is_a_partition == o.chain_is_a_partition &&
+          step_ordinal == o.step_ordinal &&
+          step_key == o.step_key &&
+          step_label == o.step_label &&
+          register_key == o.register_key &&
+          measured_value == o.measured_value &&
+          denominator_key == o.denominator_key &&
+          denominator_label == o.denominator_label &&
+          denominator_value == o.denominator_value &&
+          share_of_denominator == o.share_of_denominator &&
+          derivation_note == o.derivation_note &&
+          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
+      [chain_key, chain_label, chain_is_a_partition, step_ordinal, step_key, step_label, register_key, measured_value, denominator_key, denominator_label, denominator_value, share_of_denominator, derivation_note, 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