pharmaobservatory 0.1.6 → 0.1.8

data/lib/pharmaobservatory/models/rare_disease_organizations_row.rb

@@ -0,0 +1,454 @@
+=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 rare_disease_organizations dataset: one row per organization evidence assertion scoped to a disease. A grouped request returns the group columns and the measures instead, as additional properties.
+  class RareDiseaseOrganizationsRow
+    # disease_relation when connection_value is a relation to the disease, disease_function when it is a function the organization performs for it.
+    attr_accessor :connection_kind
+
+    # The identifier of the assertion.
+    attr_accessor :assertion_id
+
+    # The ORPHA code of the disease, the digits in the web page address (/rare-diseases/558). The entry key of the rare_diseases object type.
+    attr_accessor :orpha_code
+
+    # The disease's preferred English name.
+    attr_accessor :disease_name
+
+    # The organization's name as filed.
+    attr_accessor :organization_name
+
+    # Legal-entity level: the organization record the assertion is on.
+    attr_accessor :organization_org_id
+
+    # Company level: the organization's company (null when unresolved).
+    attr_accessor :organization_company_id
+
+    # Display name of the organization's company.
+    attr_accessor :organization_company_name
+
+    # Group level: the organization's current ultimate parent company; a root company's group is itself.
+    attr_accessor :organization_group_id
+
+    # Display name of the organization's group.
+    attr_accessor :organization_group_name
+
+    # The relation (a predicate) or the function, according to connection_kind.
+    attr_accessor :connection_value
+
+    # The kind of evidence the assertion rests on.
+    attr_accessor :evidence_type
+
+    # How authoritative the source is for the claim.
+    attr_accessor :authority_class
+
+    # The source the assertion was read from.
+    attr_accessor :source_key
+
+    # The record in the source the assertion comes from.
+    attr_accessor :source_record_id
+
+    # A link to the source record, where it has one.
+    attr_accessor :source_url
+
+    # The registry trial id the assertion names, where it names one.
+    attr_accessor :evidence_trial_id
+
+    # When the assertion was observed in the source (UTC).
+    attr_accessor :observed_at
+
+    # When the assertion was last verified against the source (UTC).
+    attr_accessor :last_verified_at
+
+    # The derivation's confidence in the assertion.
+    attr_accessor :confidence
+
+    # The licence of the source the assertion was read from.
+    attr_accessor :license_name
+
+    # The attribution line the source requires; 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
+      {
+        :'connection_kind' => :'connection_kind',
+        :'assertion_id' => :'assertion_id',
+        :'orpha_code' => :'orpha_code',
+        :'disease_name' => :'disease_name',
+        :'organization_name' => :'organization_name',
+        :'organization_org_id' => :'organization_org_id',
+        :'organization_company_id' => :'organization_company_id',
+        :'organization_company_name' => :'organization_company_name',
+        :'organization_group_id' => :'organization_group_id',
+        :'organization_group_name' => :'organization_group_name',
+        :'connection_value' => :'connection_value',
+        :'evidence_type' => :'evidence_type',
+        :'authority_class' => :'authority_class',
+        :'source_key' => :'source_key',
+        :'source_record_id' => :'source_record_id',
+        :'source_url' => :'source_url',
+        :'evidence_trial_id' => :'evidence_trial_id',
+        :'observed_at' => :'observed_at',
+        :'last_verified_at' => :'last_verified_at',
+        :'confidence' => :'confidence',
+        :'license_name' => :'license_name',
+        :'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
+      {
+        :'connection_kind' => :'String',
+        :'assertion_id' => :'String',
+        :'orpha_code' => :'String',
+        :'disease_name' => :'String',
+        :'organization_name' => :'String',
+        :'organization_org_id' => :'String',
+        :'organization_company_id' => :'String',
+        :'organization_company_name' => :'String',
+        :'organization_group_id' => :'String',
+        :'organization_group_name' => :'String',
+        :'connection_value' => :'String',
+        :'evidence_type' => :'String',
+        :'authority_class' => :'String',
+        :'source_key' => :'String',
+        :'source_record_id' => :'String',
+        :'source_url' => :'String',
+        :'evidence_trial_id' => :'String',
+        :'observed_at' => :'Time',
+        :'last_verified_at' => :'Time',
+        :'confidence' => :'Float',
+        :'license_name' => :'String',
+        :'attribution' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'connection_kind',
+        :'assertion_id',
+        :'orpha_code',
+        :'disease_name',
+        :'organization_name',
+        :'organization_org_id',
+        :'organization_company_id',
+        :'organization_company_name',
+        :'organization_group_id',
+        :'organization_group_name',
+        :'connection_value',
+        :'evidence_type',
+        :'authority_class',
+        :'source_key',
+        :'source_record_id',
+        :'source_url',
+        :'evidence_trial_id',
+        :'observed_at',
+        :'last_verified_at',
+        :'confidence',
+        :'license_name',
+        :'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::RareDiseaseOrganizationsRow` 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::RareDiseaseOrganizationsRow`. 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?(:'connection_kind')
+        self.connection_kind = attributes[:'connection_kind']
+      end
+
+      if attributes.key?(:'assertion_id')
+        self.assertion_id = attributes[:'assertion_id']
+      end
+
+      if attributes.key?(:'orpha_code')
+        self.orpha_code = attributes[:'orpha_code']
+      end
+
+      if attributes.key?(:'disease_name')
+        self.disease_name = attributes[:'disease_name']
+      end
+
+      if attributes.key?(:'organization_name')
+        self.organization_name = attributes[:'organization_name']
+      end
+
+      if attributes.key?(:'organization_org_id')
+        self.organization_org_id = attributes[:'organization_org_id']
+      end
+
+      if attributes.key?(:'organization_company_id')
+        self.organization_company_id = attributes[:'organization_company_id']
+      end
+
+      if attributes.key?(:'organization_company_name')
+        self.organization_company_name = attributes[:'organization_company_name']
+      end
+
+      if attributes.key?(:'organization_group_id')
+        self.organization_group_id = attributes[:'organization_group_id']
+      end
+
+      if attributes.key?(:'organization_group_name')
+        self.organization_group_name = attributes[:'organization_group_name']
+      end
+
+      if attributes.key?(:'connection_value')
+        self.connection_value = attributes[:'connection_value']
+      end
+
+      if attributes.key?(:'evidence_type')
+        self.evidence_type = attributes[:'evidence_type']
+      end
+
+      if attributes.key?(:'authority_class')
+        self.authority_class = attributes[:'authority_class']
+      end
+
+      if attributes.key?(:'source_key')
+        self.source_key = attributes[:'source_key']
+      end
+
+      if attributes.key?(:'source_record_id')
+        self.source_record_id = attributes[:'source_record_id']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'evidence_trial_id')
+        self.evidence_trial_id = attributes[:'evidence_trial_id']
+      end
+
+      if attributes.key?(:'observed_at')
+        self.observed_at = attributes[:'observed_at']
+      end
+
+      if attributes.key?(:'last_verified_at')
+        self.last_verified_at = attributes[:'last_verified_at']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'license_name')
+        self.license_name = attributes[:'license_name']
+      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 &&
+          connection_kind == o.connection_kind &&
+          assertion_id == o.assertion_id &&
+          orpha_code == o.orpha_code &&
+          disease_name == o.disease_name &&
+          organization_name == o.organization_name &&
+          organization_org_id == o.organization_org_id &&
+          organization_company_id == o.organization_company_id &&
+          organization_company_name == o.organization_company_name &&
+          organization_group_id == o.organization_group_id &&
+          organization_group_name == o.organization_group_name &&
+          connection_value == o.connection_value &&
+          evidence_type == o.evidence_type &&
+          authority_class == o.authority_class &&
+          source_key == o.source_key &&
+          source_record_id == o.source_record_id &&
+          source_url == o.source_url &&
+          evidence_trial_id == o.evidence_trial_id &&
+          observed_at == o.observed_at &&
+          last_verified_at == o.last_verified_at &&
+          confidence == o.confidence &&
+          license_name == o.license_name &&
+          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
+      [connection_kind, assertion_id, orpha_code, disease_name, organization_name, organization_org_id, organization_company_id, organization_company_name, organization_group_id, organization_group_name, connection_value, evidence_type, authority_class, source_key, source_record_id, source_url, evidence_trial_id, observed_at, last_verified_at, confidence, license_name, 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