pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/drug_patent_owners_row.rb

@@ -0,0 +1,357 @@
+=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 drug_patent_owners dataset: one row per drug and owning organization. A grouped request returns the group columns and the measures instead, as additional properties.
+  class DrugPatentOwnersRow
+    # The molecule key: the resolved drug a brand, a salt form or an investigational arm resolves to, and the entry key for the drugs object type. A member id (a salt or a folded trial arm) is not a value here; it redirects to its molecule.
+    attr_accessor :molecule_id
+
+    # Legal-entity level: the owning organization record as filed.
+    attr_accessor :owner_org_id
+
+    # The owner's name.
+    attr_accessor :owner_name
+
+    # Company level: the owner's company (null when the owner is not in the spine).
+    attr_accessor :owner_company_id
+
+    # Display name of the owner's company.
+    attr_accessor :owner_company_name
+
+    # Group level: the owner's current ultimate parent company; a root company's group is itself.
+    attr_accessor :owner_group_id
+
+    # Display name of the owner's group.
+    attr_accessor :owner_group_name
+
+    # True when the owner is an organization record in the spine.
+    attr_accessor :org_in_spine
+
+    # Distinct declared patents the owner holds for the drug.
+    attr_accessor :n_patents
+
+    # The earliest declared expiry.
+    attr_accessor :earliest_expiry
+
+    # The latest declared expiry.
+    attr_accessor :latest_expiry
+
+    # The best assignee-to-organization match confidence (high, med, low).
+    attr_accessor :best_match_confidence
+
+    # The records that tie the patents to the drug (orange_book, uspto_pte).
+    attr_accessor :link_bases
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'molecule_id' => :'molecule_id',
+        :'owner_org_id' => :'owner_org_id',
+        :'owner_name' => :'owner_name',
+        :'owner_company_id' => :'owner_company_id',
+        :'owner_company_name' => :'owner_company_name',
+        :'owner_group_id' => :'owner_group_id',
+        :'owner_group_name' => :'owner_group_name',
+        :'org_in_spine' => :'org_in_spine',
+        :'n_patents' => :'n_patents',
+        :'earliest_expiry' => :'earliest_expiry',
+        :'latest_expiry' => :'latest_expiry',
+        :'best_match_confidence' => :'best_match_confidence',
+        :'link_bases' => :'link_bases'
+      }
+    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
+      {
+        :'molecule_id' => :'String',
+        :'owner_org_id' => :'String',
+        :'owner_name' => :'String',
+        :'owner_company_id' => :'String',
+        :'owner_company_name' => :'String',
+        :'owner_group_id' => :'String',
+        :'owner_group_name' => :'String',
+        :'org_in_spine' => :'Boolean',
+        :'n_patents' => :'Integer',
+        :'earliest_expiry' => :'Date',
+        :'latest_expiry' => :'Date',
+        :'best_match_confidence' => :'String',
+        :'link_bases' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'molecule_id',
+        :'owner_org_id',
+        :'owner_name',
+        :'owner_company_id',
+        :'owner_company_name',
+        :'owner_group_id',
+        :'owner_group_name',
+        :'org_in_spine',
+        :'n_patents',
+        :'earliest_expiry',
+        :'latest_expiry',
+        :'best_match_confidence',
+        :'link_bases'
+      ])
+    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::DrugPatentOwnersRow` 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::DrugPatentOwnersRow`. 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?(:'molecule_id')
+        self.molecule_id = attributes[:'molecule_id']
+      end
+
+      if attributes.key?(:'owner_org_id')
+        self.owner_org_id = attributes[:'owner_org_id']
+      end
+
+      if attributes.key?(:'owner_name')
+        self.owner_name = attributes[:'owner_name']
+      end
+
+      if attributes.key?(:'owner_company_id')
+        self.owner_company_id = attributes[:'owner_company_id']
+      end
+
+      if attributes.key?(:'owner_company_name')
+        self.owner_company_name = attributes[:'owner_company_name']
+      end
+
+      if attributes.key?(:'owner_group_id')
+        self.owner_group_id = attributes[:'owner_group_id']
+      end
+
+      if attributes.key?(:'owner_group_name')
+        self.owner_group_name = attributes[:'owner_group_name']
+      end
+
+      if attributes.key?(:'org_in_spine')
+        self.org_in_spine = attributes[:'org_in_spine']
+      end
+
+      if attributes.key?(:'n_patents')
+        self.n_patents = attributes[:'n_patents']
+      end
+
+      if attributes.key?(:'earliest_expiry')
+        self.earliest_expiry = attributes[:'earliest_expiry']
+      end
+
+      if attributes.key?(:'latest_expiry')
+        self.latest_expiry = attributes[:'latest_expiry']
+      end
+
+      if attributes.key?(:'best_match_confidence')
+        self.best_match_confidence = attributes[:'best_match_confidence']
+      end
+
+      if attributes.key?(:'link_bases')
+        if (value = attributes[:'link_bases']).is_a?(Array)
+          self.link_bases = value
+        end
+      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 &&
+          molecule_id == o.molecule_id &&
+          owner_org_id == o.owner_org_id &&
+          owner_name == o.owner_name &&
+          owner_company_id == o.owner_company_id &&
+          owner_company_name == o.owner_company_name &&
+          owner_group_id == o.owner_group_id &&
+          owner_group_name == o.owner_group_name &&
+          org_in_spine == o.org_in_spine &&
+          n_patents == o.n_patents &&
+          earliest_expiry == o.earliest_expiry &&
+          latest_expiry == o.latest_expiry &&
+          best_match_confidence == o.best_match_confidence &&
+          link_bases == o.link_bases
+    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
+      [molecule_id, owner_org_id, owner_name, owner_company_id, owner_company_name, owner_group_id, owner_group_name, org_in_spine, n_patents, earliest_expiry, latest_expiry, best_match_confidence, link_bases].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