pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/rwd_source_linkages_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 rwd_source_linkages dataset: one row per data source and declared linkage. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RwdSourceLinkagesRow
+    # 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 linkage among the source's declared linkages, from 1.
+    attr_accessor :linkage_ordinal
+
+    # How many linkages the holder declared; 0 when none.
+    attr_accessor :declared_linkage_count
+
+    # Whether the holder answered Yes to Pre linked for this linkage.
+    attr_accessor :is_pre_linked
+
+    # The holder's Yes or No answer to Pre linked for this linkage.
+    attr_accessor :pre_linked_answer
+
+    # The linked data source named for this linkage, from the register's list.
+    attr_accessor :linked_data_source_name
+
+    # False when the register list for this column splits into a different number of pieces than the number of linkages declared; the row value is then null and the whole answer is in linked_data_source_name_source.
+    attr_accessor :linked_data_source_name_aligned
+
+    # The whole comma-joined answer the linked data source name was split from, kept so an unaligned row can still be read.
+    attr_accessor :linked_data_source_name_source
+
+    # True when the linked data source name is the register's Other data source sentinel.
+    attr_accessor :names_other_sentinel
+
+    # True when the linked data source name is itself a registered data source.
+    attr_accessor :names_registered_source
+
+    # The linked data source named in free text when the holder chose Other data source.
+    attr_accessor :linked_data_source_other
+
+    # False when the register list for this column splits into a different number of pieces than the number of linkages declared; the row value is then null and the whole answer is in linked_data_source_other_source.
+    attr_accessor :linked_data_source_other_aligned
+
+    # The whole answer the other-data-source text was split from.
+    attr_accessor :linked_data_source_other_source
+
+    # The linkage completeness declared for this linkage, as typed.
+    attr_accessor :linkage_completeness
+
+    # False when the register list for this column splits into a different number of pieces than the number of linkages declared; the row value is then null and the whole answer is in linkage_completeness_source.
+    attr_accessor :linkage_completeness_aligned
+
+    # The whole answer linkage completeness was split from.
+    attr_accessor :linkage_completeness_source
+
+    # The linkage variable declared for this linkage, as typed.
+    attr_accessor :linkage_variable
+
+    # False when the register list for this column splits into a different number of pieces than the number of linkages declared; the row value is then null and the whole answer is in linkage_variable_source.
+    attr_accessor :linkage_variable_aligned
+
+    # The whole answer the linkage variable was split from.
+    attr_accessor :linkage_variable_source
+
+    # The linkage strategy declared for this linkage, as typed.
+    attr_accessor :linkage_strategy
+
+    # False when the register list for this column splits into a different number of pieces than the number of linkages declared; the row value is then null and the whole answer is in linkage_strategy_source.
+    attr_accessor :linkage_strategy_aligned
+
+    # The whole answer the linkage strategy was split from.
+    attr_accessor :linkage_strategy_source
+
+    # 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',
+        :'linkage_ordinal' => :'linkage_ordinal',
+        :'declared_linkage_count' => :'declared_linkage_count',
+        :'is_pre_linked' => :'is_pre_linked',
+        :'pre_linked_answer' => :'pre_linked_answer',
+        :'linked_data_source_name' => :'linked_data_source_name',
+        :'linked_data_source_name_aligned' => :'linked_data_source_name_aligned',
+        :'linked_data_source_name_source' => :'linked_data_source_name_source',
+        :'names_other_sentinel' => :'names_other_sentinel',
+        :'names_registered_source' => :'names_registered_source',
+        :'linked_data_source_other' => :'linked_data_source_other',
+        :'linked_data_source_other_aligned' => :'linked_data_source_other_aligned',
+        :'linked_data_source_other_source' => :'linked_data_source_other_source',
+        :'linkage_completeness' => :'linkage_completeness',
+        :'linkage_completeness_aligned' => :'linkage_completeness_aligned',
+        :'linkage_completeness_source' => :'linkage_completeness_source',
+        :'linkage_variable' => :'linkage_variable',
+        :'linkage_variable_aligned' => :'linkage_variable_aligned',
+        :'linkage_variable_source' => :'linkage_variable_source',
+        :'linkage_strategy' => :'linkage_strategy',
+        :'linkage_strategy_aligned' => :'linkage_strategy_aligned',
+        :'linkage_strategy_source' => :'linkage_strategy_source',
+        :'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',
+        :'linkage_ordinal' => :'Integer',
+        :'declared_linkage_count' => :'Integer',
+        :'is_pre_linked' => :'Boolean',
+        :'pre_linked_answer' => :'String',
+        :'linked_data_source_name' => :'String',
+        :'linked_data_source_name_aligned' => :'Boolean',
+        :'linked_data_source_name_source' => :'String',
+        :'names_other_sentinel' => :'Boolean',
+        :'names_registered_source' => :'Boolean',
+        :'linked_data_source_other' => :'String',
+        :'linked_data_source_other_aligned' => :'Boolean',
+        :'linked_data_source_other_source' => :'String',
+        :'linkage_completeness' => :'String',
+        :'linkage_completeness_aligned' => :'Boolean',
+        :'linkage_completeness_source' => :'String',
+        :'linkage_variable' => :'String',
+        :'linkage_variable_aligned' => :'Boolean',
+        :'linkage_variable_source' => :'String',
+        :'linkage_strategy' => :'String',
+        :'linkage_strategy_aligned' => :'Boolean',
+        :'linkage_strategy_source' => :'String',
+        :'restriction_tier' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'data_source_id',
+        :'linkage_ordinal',
+        :'declared_linkage_count',
+        :'is_pre_linked',
+        :'pre_linked_answer',
+        :'linked_data_source_name',
+        :'linked_data_source_name_aligned',
+        :'linked_data_source_name_source',
+        :'names_other_sentinel',
+        :'names_registered_source',
+        :'linked_data_source_other',
+        :'linked_data_source_other_aligned',
+        :'linked_data_source_other_source',
+        :'linkage_completeness',
+        :'linkage_completeness_aligned',
+        :'linkage_completeness_source',
+        :'linkage_variable',
+        :'linkage_variable_aligned',
+        :'linkage_variable_source',
+        :'linkage_strategy',
+        :'linkage_strategy_aligned',
+        :'linkage_strategy_source',
+        :'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::RwdSourceLinkagesRow` 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::RwdSourceLinkagesRow`. 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?(:'linkage_ordinal')
+        self.linkage_ordinal = attributes[:'linkage_ordinal']
+      end
+
+      if attributes.key?(:'declared_linkage_count')
+        self.declared_linkage_count = attributes[:'declared_linkage_count']
+      end
+
+      if attributes.key?(:'is_pre_linked')
+        self.is_pre_linked = attributes[:'is_pre_linked']
+      end
+
+      if attributes.key?(:'pre_linked_answer')
+        self.pre_linked_answer = attributes[:'pre_linked_answer']
+      end
+
+      if attributes.key?(:'linked_data_source_name')
+        self.linked_data_source_name = attributes[:'linked_data_source_name']
+      end
+
+      if attributes.key?(:'linked_data_source_name_aligned')
+        self.linked_data_source_name_aligned = attributes[:'linked_data_source_name_aligned']
+      end
+
+      if attributes.key?(:'linked_data_source_name_source')
+        self.linked_data_source_name_source = attributes[:'linked_data_source_name_source']
+      end
+
+      if attributes.key?(:'names_other_sentinel')
+        self.names_other_sentinel = attributes[:'names_other_sentinel']
+      end
+
+      if attributes.key?(:'names_registered_source')
+        self.names_registered_source = attributes[:'names_registered_source']
+      end
+
+      if attributes.key?(:'linked_data_source_other')
+        self.linked_data_source_other = attributes[:'linked_data_source_other']
+      end
+
+      if attributes.key?(:'linked_data_source_other_aligned')
+        self.linked_data_source_other_aligned = attributes[:'linked_data_source_other_aligned']
+      end
+
+      if attributes.key?(:'linked_data_source_other_source')
+        self.linked_data_source_other_source = attributes[:'linked_data_source_other_source']
+      end
+
+      if attributes.key?(:'linkage_completeness')
+        self.linkage_completeness = attributes[:'linkage_completeness']
+      end
+
+      if attributes.key?(:'linkage_completeness_aligned')
+        self.linkage_completeness_aligned = attributes[:'linkage_completeness_aligned']
+      end
+
+      if attributes.key?(:'linkage_completeness_source')
+        self.linkage_completeness_source = attributes[:'linkage_completeness_source']
+      end
+
+      if attributes.key?(:'linkage_variable')
+        self.linkage_variable = attributes[:'linkage_variable']
+      end
+
+      if attributes.key?(:'linkage_variable_aligned')
+        self.linkage_variable_aligned = attributes[:'linkage_variable_aligned']
+      end
+
+      if attributes.key?(:'linkage_variable_source')
+        self.linkage_variable_source = attributes[:'linkage_variable_source']
+      end
+
+      if attributes.key?(:'linkage_strategy')
+        self.linkage_strategy = attributes[:'linkage_strategy']
+      end
+
+      if attributes.key?(:'linkage_strategy_aligned')
+        self.linkage_strategy_aligned = attributes[:'linkage_strategy_aligned']
+      end
+
+      if attributes.key?(:'linkage_strategy_source')
+        self.linkage_strategy_source = attributes[:'linkage_strategy_source']
+      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 &&
+          linkage_ordinal == o.linkage_ordinal &&
+          declared_linkage_count == o.declared_linkage_count &&
+          is_pre_linked == o.is_pre_linked &&
+          pre_linked_answer == o.pre_linked_answer &&
+          linked_data_source_name == o.linked_data_source_name &&
+          linked_data_source_name_aligned == o.linked_data_source_name_aligned &&
+          linked_data_source_name_source == o.linked_data_source_name_source &&
+          names_other_sentinel == o.names_other_sentinel &&
+          names_registered_source == o.names_registered_source &&
+          linked_data_source_other == o.linked_data_source_other &&
+          linked_data_source_other_aligned == o.linked_data_source_other_aligned &&
+          linked_data_source_other_source == o.linked_data_source_other_source &&
+          linkage_completeness == o.linkage_completeness &&
+          linkage_completeness_aligned == o.linkage_completeness_aligned &&
+          linkage_completeness_source == o.linkage_completeness_source &&
+          linkage_variable == o.linkage_variable &&
+          linkage_variable_aligned == o.linkage_variable_aligned &&
+          linkage_variable_source == o.linkage_variable_source &&
+          linkage_strategy == o.linkage_strategy &&
+          linkage_strategy_aligned == o.linkage_strategy_aligned &&
+          linkage_strategy_source == o.linkage_strategy_source &&
+          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, linkage_ordinal, declared_linkage_count, is_pre_linked, pre_linked_answer, linked_data_source_name, linked_data_source_name_aligned, linked_data_source_name_source, names_other_sentinel, names_registered_source, linked_data_source_other, linked_data_source_other_aligned, linked_data_source_other_source, linkage_completeness, linkage_completeness_aligned, linkage_completeness_source, linkage_variable, linkage_variable_aligned, linkage_variable_source, linkage_strategy, linkage_strategy_aligned, linkage_strategy_source, 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