pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/drug_declared_patents_row.rb

@@ -0,0 +1,447 @@
+=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_declared_patents dataset: one row per drug, patent and assignee. A grouped request returns the group columns and the measures instead, as additional properties.
+  class DrugDeclaredPatentsRow
+    # 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
+
+    # The patent id in the patent dimension.
+    attr_accessor :patent_id
+
+    # The assignee's order on the patent; -1 when there is none.
+    attr_accessor :assignee_sequence
+
+    # The patent number.
+    attr_accessor :patent_number
+
+    # The patent title.
+    attr_accessor :patent_title
+
+    # The date the patent was granted.
+    attr_accessor :patent_date
+
+    # The expiry declared for the drug.
+    attr_accessor :declared_expiry
+
+    # The drug application numbers the patent is declared against.
+    attr_accessor :appl_nos
+
+    # The record that ties the patent to the drug (orange_book or uspto_pte).
+    attr_accessor :link_basis
+
+    # Every record that ties the patent to the drug.
+    attr_accessor :link_bases
+
+    # True when the Orange Book lists a pediatric exclusivity extension.
+    attr_accessor :has_ped_extension
+
+    # The assignee as filed.
+    attr_accessor :assignee_organization
+
+    # Legal-entity level: the assignee's organization record (null when unresolved).
+    attr_accessor :assignee_org_id
+
+    # Company level: the assignee's company (null when unresolved).
+    attr_accessor :assignee_company_id
+
+    # Display name of the assignee's company.
+    attr_accessor :assignee_company_name
+
+    # Group level: the assignee's current ultimate parent company; a root company's group is itself.
+    attr_accessor :assignee_group_id
+
+    # Display name of the assignee's group.
+    attr_accessor :assignee_group_name
+
+    # True when the assignee is an organization record in the spine.
+    attr_accessor :org_in_spine
+
+    # How the assignee was matched to an organization.
+    attr_accessor :resolution_method
+
+    # The match confidence (high, med, low).
+    attr_accessor :match_confidence
+
+    # Why the assignee is, or is not, on record.
+    attr_accessor :owner_basis
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'molecule_id' => :'molecule_id',
+        :'patent_id' => :'patent_id',
+        :'assignee_sequence' => :'assignee_sequence',
+        :'patent_number' => :'patent_number',
+        :'patent_title' => :'patent_title',
+        :'patent_date' => :'patent_date',
+        :'declared_expiry' => :'declared_expiry',
+        :'appl_nos' => :'appl_nos',
+        :'link_basis' => :'link_basis',
+        :'link_bases' => :'link_bases',
+        :'has_ped_extension' => :'has_ped_extension',
+        :'assignee_organization' => :'assignee_organization',
+        :'assignee_org_id' => :'assignee_org_id',
+        :'assignee_company_id' => :'assignee_company_id',
+        :'assignee_company_name' => :'assignee_company_name',
+        :'assignee_group_id' => :'assignee_group_id',
+        :'assignee_group_name' => :'assignee_group_name',
+        :'org_in_spine' => :'org_in_spine',
+        :'resolution_method' => :'resolution_method',
+        :'match_confidence' => :'match_confidence',
+        :'owner_basis' => :'owner_basis'
+      }
+    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',
+        :'patent_id' => :'String',
+        :'assignee_sequence' => :'Integer',
+        :'patent_number' => :'String',
+        :'patent_title' => :'String',
+        :'patent_date' => :'Date',
+        :'declared_expiry' => :'Date',
+        :'appl_nos' => :'Array<String>',
+        :'link_basis' => :'String',
+        :'link_bases' => :'Array<String>',
+        :'has_ped_extension' => :'Boolean',
+        :'assignee_organization' => :'String',
+        :'assignee_org_id' => :'String',
+        :'assignee_company_id' => :'String',
+        :'assignee_company_name' => :'String',
+        :'assignee_group_id' => :'String',
+        :'assignee_group_name' => :'String',
+        :'org_in_spine' => :'Boolean',
+        :'resolution_method' => :'String',
+        :'match_confidence' => :'String',
+        :'owner_basis' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'molecule_id',
+        :'patent_id',
+        :'assignee_sequence',
+        :'patent_number',
+        :'patent_title',
+        :'patent_date',
+        :'declared_expiry',
+        :'appl_nos',
+        :'link_basis',
+        :'link_bases',
+        :'has_ped_extension',
+        :'assignee_organization',
+        :'assignee_org_id',
+        :'assignee_company_id',
+        :'assignee_company_name',
+        :'assignee_group_id',
+        :'assignee_group_name',
+        :'org_in_spine',
+        :'resolution_method',
+        :'match_confidence',
+        :'owner_basis'
+      ])
+    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::DrugDeclaredPatentsRow` 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::DrugDeclaredPatentsRow`. 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?(:'patent_id')
+        self.patent_id = attributes[:'patent_id']
+      end
+
+      if attributes.key?(:'assignee_sequence')
+        self.assignee_sequence = attributes[:'assignee_sequence']
+      end
+
+      if attributes.key?(:'patent_number')
+        self.patent_number = attributes[:'patent_number']
+      end
+
+      if attributes.key?(:'patent_title')
+        self.patent_title = attributes[:'patent_title']
+      end
+
+      if attributes.key?(:'patent_date')
+        self.patent_date = attributes[:'patent_date']
+      end
+
+      if attributes.key?(:'declared_expiry')
+        self.declared_expiry = attributes[:'declared_expiry']
+      end
+
+      if attributes.key?(:'appl_nos')
+        if (value = attributes[:'appl_nos']).is_a?(Array)
+          self.appl_nos = value
+        end
+      end
+
+      if attributes.key?(:'link_basis')
+        self.link_basis = attributes[:'link_basis']
+      end
+
+      if attributes.key?(:'link_bases')
+        if (value = attributes[:'link_bases']).is_a?(Array)
+          self.link_bases = value
+        end
+      end
+
+      if attributes.key?(:'has_ped_extension')
+        self.has_ped_extension = attributes[:'has_ped_extension']
+      end
+
+      if attributes.key?(:'assignee_organization')
+        self.assignee_organization = attributes[:'assignee_organization']
+      end
+
+      if attributes.key?(:'assignee_org_id')
+        self.assignee_org_id = attributes[:'assignee_org_id']
+      end
+
+      if attributes.key?(:'assignee_company_id')
+        self.assignee_company_id = attributes[:'assignee_company_id']
+      end
+
+      if attributes.key?(:'assignee_company_name')
+        self.assignee_company_name = attributes[:'assignee_company_name']
+      end
+
+      if attributes.key?(:'assignee_group_id')
+        self.assignee_group_id = attributes[:'assignee_group_id']
+      end
+
+      if attributes.key?(:'assignee_group_name')
+        self.assignee_group_name = attributes[:'assignee_group_name']
+      end
+
+      if attributes.key?(:'org_in_spine')
+        self.org_in_spine = attributes[:'org_in_spine']
+      end
+
+      if attributes.key?(:'resolution_method')
+        self.resolution_method = attributes[:'resolution_method']
+      end
+
+      if attributes.key?(:'match_confidence')
+        self.match_confidence = attributes[:'match_confidence']
+      end
+
+      if attributes.key?(:'owner_basis')
+        self.owner_basis = attributes[:'owner_basis']
+      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 &&
+          patent_id == o.patent_id &&
+          assignee_sequence == o.assignee_sequence &&
+          patent_number == o.patent_number &&
+          patent_title == o.patent_title &&
+          patent_date == o.patent_date &&
+          declared_expiry == o.declared_expiry &&
+          appl_nos == o.appl_nos &&
+          link_basis == o.link_basis &&
+          link_bases == o.link_bases &&
+          has_ped_extension == o.has_ped_extension &&
+          assignee_organization == o.assignee_organization &&
+          assignee_org_id == o.assignee_org_id &&
+          assignee_company_id == o.assignee_company_id &&
+          assignee_company_name == o.assignee_company_name &&
+          assignee_group_id == o.assignee_group_id &&
+          assignee_group_name == o.assignee_group_name &&
+          org_in_spine == o.org_in_spine &&
+          resolution_method == o.resolution_method &&
+          match_confidence == o.match_confidence &&
+          owner_basis == o.owner_basis
+    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, patent_id, assignee_sequence, patent_number, patent_title, patent_date, declared_expiry, appl_nos, link_basis, link_bases, has_ped_extension, assignee_organization, assignee_org_id, assignee_company_id, assignee_company_name, assignee_group_id, assignee_group_name, org_in_spine, resolution_method, match_confidence, owner_basis].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