pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/rwd_source_age_bands_row.rb

@@ -0,0 +1,344 @@
+=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_source_age_bands dataset: one row per data source and declared age band. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RwdSourceAgeBandsRow
+    # The register Data source ID. The entry key of the rwd_sources object type. On a row built from a study's data source name it is null unless the name reaches exactly one registered source (see data_source_ids).
+    attr_accessor :data_source_id
+
+    # The position of the age band in the source's declared list, from 1.
+    attr_accessor :band_ordinal
+
+    # The age band label as the holder declared it. Bands can overlap (see is_nested_scheme); never sum them.
+    attr_accessor :age_band
+
+    # The population size the holder declared for the source (all registered persons).
+    attr_accessor :population_size
+
+    # The active population size the holder declared for the source.
+    attr_accessor :active_population_size
+
+    # Whether the holder published a population size breakdown by age band at all.
+    attr_accessor :has_population_breakdown
+
+    # Whether the holder published an active population breakdown by age band at all.
+    attr_accessor :has_active_population_breakdown
+
+    # True when the source's bands overlap, so a sum over bands double counts.
+    attr_accessor :is_nested_scheme
+
+    # The label of the catalogue snapshot the row was read from (a date).
+    attr_accessor :snapshot_label
+
+    # 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
+      {
+        :'data_source_id' => :'data_source_id',
+        :'band_ordinal' => :'band_ordinal',
+        :'age_band' => :'age_band',
+        :'population_size' => :'population_size',
+        :'active_population_size' => :'active_population_size',
+        :'has_population_breakdown' => :'has_population_breakdown',
+        :'has_active_population_breakdown' => :'has_active_population_breakdown',
+        :'is_nested_scheme' => :'is_nested_scheme',
+        :'snapshot_label' => :'snapshot_label',
+        :'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
+      {
+        :'data_source_id' => :'String',
+        :'band_ordinal' => :'Integer',
+        :'age_band' => :'String',
+        :'population_size' => :'Integer',
+        :'active_population_size' => :'Integer',
+        :'has_population_breakdown' => :'Boolean',
+        :'has_active_population_breakdown' => :'Boolean',
+        :'is_nested_scheme' => :'Boolean',
+        :'snapshot_label' => :'String',
+        :'accessed_month' => :'String',
+        :'restriction_tier' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'data_source_id',
+        :'band_ordinal',
+        :'age_band',
+        :'population_size',
+        :'active_population_size',
+        :'has_population_breakdown',
+        :'has_active_population_breakdown',
+        :'is_nested_scheme',
+        :'snapshot_label',
+        :'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::RwdSourceAgeBandsRow` 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::RwdSourceAgeBandsRow`. 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?(:'data_source_id')
+        self.data_source_id = attributes[:'data_source_id']
+      end
+
+      if attributes.key?(:'band_ordinal')
+        self.band_ordinal = attributes[:'band_ordinal']
+      end
+
+      if attributes.key?(:'age_band')
+        self.age_band = attributes[:'age_band']
+      end
+
+      if attributes.key?(:'population_size')
+        self.population_size = attributes[:'population_size']
+      end
+
+      if attributes.key?(:'active_population_size')
+        self.active_population_size = attributes[:'active_population_size']
+      end
+
+      if attributes.key?(:'has_population_breakdown')
+        self.has_population_breakdown = attributes[:'has_population_breakdown']
+      end
+
+      if attributes.key?(:'has_active_population_breakdown')
+        self.has_active_population_breakdown = attributes[:'has_active_population_breakdown']
+      end
+
+      if attributes.key?(:'is_nested_scheme')
+        self.is_nested_scheme = attributes[:'is_nested_scheme']
+      end
+
+      if attributes.key?(:'snapshot_label')
+        self.snapshot_label = attributes[:'snapshot_label']
+      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 &&
+          data_source_id == o.data_source_id &&
+          band_ordinal == o.band_ordinal &&
+          age_band == o.age_band &&
+          population_size == o.population_size &&
+          active_population_size == o.active_population_size &&
+          has_population_breakdown == o.has_population_breakdown &&
+          has_active_population_breakdown == o.has_active_population_breakdown &&
+          is_nested_scheme == o.is_nested_scheme &&
+          snapshot_label == o.snapshot_label &&
+          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
+      [data_source_id, band_ordinal, age_band, population_size, active_population_size, has_population_breakdown, has_active_population_breakdown, is_nested_scheme, snapshot_label, 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