pharmaobservatory 0.1.0

data/lib/pharmaobservatory/models/api_v1_rwd_study_screen_get200_response.rb

@@ -0,0 +1,387 @@
+=begin
+#Pharma Observatory Public REST API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+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
+  class ApiV1RwdStudyScreenGet200Response
+    attr_accessor :filters
+
+    attr_accessor :matched_studies
+
+    attr_accessor :register_total
+
+    attr_accessor :delivery_distribution
+
+    attr_accessor :coverage_caveat
+
+    attr_accessor :tier_provisional_note
+
+    attr_accessor :build_state
+
+    attr_accessor :restriction
+
+    # false means a condition was named and the condition mart is not built in this warehouse, so the filter could not run and matched_studies, register_total and delivery_distribution are unknown (null), not zero. true means the filter ran, or no condition was named.
+    attr_accessor :condition_filter_built
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'filters' => :'filters',
+        :'matched_studies' => :'matched_studies',
+        :'register_total' => :'register_total',
+        :'delivery_distribution' => :'delivery_distribution',
+        :'coverage_caveat' => :'coverage_caveat',
+        :'tier_provisional_note' => :'tier_provisional_note',
+        :'build_state' => :'build_state',
+        :'restriction' => :'restriction',
+        :'condition_filter_built' => :'condition_filter_built'
+      }
+    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
+      {
+        :'filters' => :'ApiV1RwdStudyScreenGet200ResponseFilters',
+        :'matched_studies' => :'Integer',
+        :'register_total' => :'Integer',
+        :'delivery_distribution' => :'ApiV1RwdStudyScreenGet200ResponseDeliveryDistribution',
+        :'coverage_caveat' => :'String',
+        :'tier_provisional_note' => :'String',
+        :'build_state' => :'ApiV1BiomarkerAssayScreenGet200ResponseBuildState',
+        :'restriction' => :'ApiV1ConditionsConditionIdBurdenVsEvidenceGet200ResponseRestriction',
+        :'condition_filter_built' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'matched_studies',
+        :'register_total',
+        :'delivery_distribution',
+      ])
+    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::ApiV1RwdStudyScreenGet200Response` 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::ApiV1RwdStudyScreenGet200Response`. 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?(:'filters')
+        self.filters = attributes[:'filters']
+      else
+        self.filters = nil
+      end
+
+      if attributes.key?(:'matched_studies')
+        self.matched_studies = attributes[:'matched_studies']
+      else
+        self.matched_studies = nil
+      end
+
+      if attributes.key?(:'register_total')
+        self.register_total = attributes[:'register_total']
+      else
+        self.register_total = nil
+      end
+
+      if attributes.key?(:'delivery_distribution')
+        self.delivery_distribution = attributes[:'delivery_distribution']
+      else
+        self.delivery_distribution = nil
+      end
+
+      if attributes.key?(:'coverage_caveat')
+        self.coverage_caveat = attributes[:'coverage_caveat']
+      else
+        self.coverage_caveat = nil
+      end
+
+      if attributes.key?(:'tier_provisional_note')
+        self.tier_provisional_note = attributes[:'tier_provisional_note']
+      else
+        self.tier_provisional_note = nil
+      end
+
+      if attributes.key?(:'build_state')
+        self.build_state = attributes[:'build_state']
+      else
+        self.build_state = nil
+      end
+
+      if attributes.key?(:'restriction')
+        self.restriction = attributes[:'restriction']
+      else
+        self.restriction = nil
+      end
+
+      if attributes.key?(:'condition_filter_built')
+        self.condition_filter_built = attributes[:'condition_filter_built']
+      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
+      if @filters.nil?
+        invalid_properties.push('invalid value for "filters", filters cannot be nil.')
+      end
+
+      if @coverage_caveat.nil?
+        invalid_properties.push('invalid value for "coverage_caveat", coverage_caveat cannot be nil.')
+      end
+
+      if @tier_provisional_note.nil?
+        invalid_properties.push('invalid value for "tier_provisional_note", tier_provisional_note cannot be nil.')
+      end
+
+      if @build_state.nil?
+        invalid_properties.push('invalid value for "build_state", build_state cannot be nil.')
+      end
+
+      if @restriction.nil?
+        invalid_properties.push('invalid value for "restriction", restriction cannot be nil.')
+      end
+
+      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'
+      return false if @filters.nil?
+      return false if @coverage_caveat.nil?
+      return false if @tier_provisional_note.nil?
+      return false if @build_state.nil?
+      return false if @restriction.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] filters Value to be assigned
+    def filters=(filters)
+      if filters.nil?
+        fail ArgumentError, 'filters cannot be nil'
+      end
+
+      @filters = filters
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] coverage_caveat Value to be assigned
+    def coverage_caveat=(coverage_caveat)
+      if coverage_caveat.nil?
+        fail ArgumentError, 'coverage_caveat cannot be nil'
+      end
+
+      @coverage_caveat = coverage_caveat
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tier_provisional_note Value to be assigned
+    def tier_provisional_note=(tier_provisional_note)
+      if tier_provisional_note.nil?
+        fail ArgumentError, 'tier_provisional_note cannot be nil'
+      end
+
+      @tier_provisional_note = tier_provisional_note
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] build_state Value to be assigned
+    def build_state=(build_state)
+      if build_state.nil?
+        fail ArgumentError, 'build_state cannot be nil'
+      end
+
+      @build_state = build_state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] restriction Value to be assigned
+    def restriction=(restriction)
+      if restriction.nil?
+        fail ArgumentError, 'restriction cannot be nil'
+      end
+
+      @restriction = restriction
+    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 &&
+          filters == o.filters &&
+          matched_studies == o.matched_studies &&
+          register_total == o.register_total &&
+          delivery_distribution == o.delivery_distribution &&
+          coverage_caveat == o.coverage_caveat &&
+          tier_provisional_note == o.tier_provisional_note &&
+          build_state == o.build_state &&
+          restriction == o.restriction &&
+          condition_filter_built == o.condition_filter_built
+    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
+      [filters, matched_studies, register_total, delivery_distribution, coverage_caveat, tier_provisional_note, build_state, restriction, condition_filter_built].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