pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/rwd_study_data_sources_row.rb

@@ -0,0 +1,423 @@
+=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_study_data_sources dataset: one row per registered study and named data source item. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RwdStudyDataSourcesRow
+    # The register's own Study ID. The entry key of the rwd_studies object type; the EU PAS number is an attribute.
+    attr_accessor :study_id
+
+    # The position of the item in the register's own list, from 1.
+    attr_accessor :item_ordinal
+
+    # The data source name as the study named it, from the register's Data source(s) list.
+    attr_accessor :data_source_name
+
+    # The normalised name key the study register is joined to the data source on (the study register carries no data source id).
+    attr_accessor :data_source_name_key
+
+    # Whether the name matches a registered data source.
+    attr_accessor :matched_data_source_register
+
+    # 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
+
+    # Every registered data source id the name matches (more than one when two entries share a name).
+    attr_accessor :data_source_ids
+
+    # How many register entries share the name.
+    attr_accessor :register_row_count
+
+    # The study's status as the register words it (Planned, Ongoing, Finalised, and so on).
+    attr_accessor :study_status
+
+    # mandated when a regulator required the study (a post-authorisation obligation), voluntary when the registrant says it did not, unknown when unanswered. Delivery timeliness is only comparable within a stratum.
+    attr_accessor :mandate_stratum
+
+    # The registrant's answer to whether a regulatory body required the study (Yes, No or Unknown).
+    attr_accessor :required_by_regulator
+
+    # Actual study start date.
+    attr_accessor :study_start_actual_on
+
+    # Whether the study started within five years of the snapshot.
+    attr_accessor :started_in_last_5_years
+
+    # How many distinct condition terms the study names.
+    attr_accessor :condition_count
+
+    # How many conducting institutions the study names.
+    attr_accessor :conducting_institution_count
+
+    # 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
+      {
+        :'study_id' => :'study_id',
+        :'item_ordinal' => :'item_ordinal',
+        :'data_source_name' => :'data_source_name',
+        :'data_source_name_key' => :'data_source_name_key',
+        :'matched_data_source_register' => :'matched_data_source_register',
+        :'data_source_id' => :'data_source_id',
+        :'data_source_ids' => :'data_source_ids',
+        :'register_row_count' => :'register_row_count',
+        :'study_status' => :'study_status',
+        :'mandate_stratum' => :'mandate_stratum',
+        :'required_by_regulator' => :'required_by_regulator',
+        :'study_start_actual_on' => :'study_start_actual_on',
+        :'started_in_last_5_years' => :'started_in_last_5_years',
+        :'condition_count' => :'condition_count',
+        :'conducting_institution_count' => :'conducting_institution_count',
+        :'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
+      {
+        :'study_id' => :'String',
+        :'item_ordinal' => :'Integer',
+        :'data_source_name' => :'String',
+        :'data_source_name_key' => :'String',
+        :'matched_data_source_register' => :'Boolean',
+        :'data_source_id' => :'String',
+        :'data_source_ids' => :'Array<String>',
+        :'register_row_count' => :'Integer',
+        :'study_status' => :'String',
+        :'mandate_stratum' => :'String',
+        :'required_by_regulator' => :'String',
+        :'study_start_actual_on' => :'Date',
+        :'started_in_last_5_years' => :'Boolean',
+        :'condition_count' => :'Integer',
+        :'conducting_institution_count' => :'Integer',
+        :'snapshot_label' => :'String',
+        :'accessed_month' => :'String',
+        :'restriction_tier' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'study_id',
+        :'item_ordinal',
+        :'data_source_name',
+        :'data_source_name_key',
+        :'matched_data_source_register',
+        :'data_source_id',
+        :'data_source_ids',
+        :'register_row_count',
+        :'study_status',
+        :'mandate_stratum',
+        :'required_by_regulator',
+        :'study_start_actual_on',
+        :'started_in_last_5_years',
+        :'condition_count',
+        :'conducting_institution_count',
+        :'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::RwdStudyDataSourcesRow` 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::RwdStudyDataSourcesRow`. 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?(:'study_id')
+        self.study_id = attributes[:'study_id']
+      end
+
+      if attributes.key?(:'item_ordinal')
+        self.item_ordinal = attributes[:'item_ordinal']
+      end
+
+      if attributes.key?(:'data_source_name')
+        self.data_source_name = attributes[:'data_source_name']
+      end
+
+      if attributes.key?(:'data_source_name_key')
+        self.data_source_name_key = attributes[:'data_source_name_key']
+      end
+
+      if attributes.key?(:'matched_data_source_register')
+        self.matched_data_source_register = attributes[:'matched_data_source_register']
+      end
+
+      if attributes.key?(:'data_source_id')
+        self.data_source_id = attributes[:'data_source_id']
+      end
+
+      if attributes.key?(:'data_source_ids')
+        if (value = attributes[:'data_source_ids']).is_a?(Array)
+          self.data_source_ids = value
+        end
+      end
+
+      if attributes.key?(:'register_row_count')
+        self.register_row_count = attributes[:'register_row_count']
+      end
+
+      if attributes.key?(:'study_status')
+        self.study_status = attributes[:'study_status']
+      end
+
+      if attributes.key?(:'mandate_stratum')
+        self.mandate_stratum = attributes[:'mandate_stratum']
+      end
+
+      if attributes.key?(:'required_by_regulator')
+        self.required_by_regulator = attributes[:'required_by_regulator']
+      end
+
+      if attributes.key?(:'study_start_actual_on')
+        self.study_start_actual_on = attributes[:'study_start_actual_on']
+      end
+
+      if attributes.key?(:'started_in_last_5_years')
+        self.started_in_last_5_years = attributes[:'started_in_last_5_years']
+      end
+
+      if attributes.key?(:'condition_count')
+        self.condition_count = attributes[:'condition_count']
+      end
+
+      if attributes.key?(:'conducting_institution_count')
+        self.conducting_institution_count = attributes[:'conducting_institution_count']
+      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 &&
+          study_id == o.study_id &&
+          item_ordinal == o.item_ordinal &&
+          data_source_name == o.data_source_name &&
+          data_source_name_key == o.data_source_name_key &&
+          matched_data_source_register == o.matched_data_source_register &&
+          data_source_id == o.data_source_id &&
+          data_source_ids == o.data_source_ids &&
+          register_row_count == o.register_row_count &&
+          study_status == o.study_status &&
+          mandate_stratum == o.mandate_stratum &&
+          required_by_regulator == o.required_by_regulator &&
+          study_start_actual_on == o.study_start_actual_on &&
+          started_in_last_5_years == o.started_in_last_5_years &&
+          condition_count == o.condition_count &&
+          conducting_institution_count == o.conducting_institution_count &&
+          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
+      [study_id, item_ordinal, data_source_name, data_source_name_key, matched_data_source_register, data_source_id, data_source_ids, register_row_count, study_status, mandate_stratum, required_by_regulator, study_start_actual_on, started_in_last_5_years, condition_count, conducting_institution_count, 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