pharmaobservatory 0.1.2 → 0.1.4

data/lib/pharmaobservatory/models/drug_patent_cliff_row.rb

@@ -0,0 +1,498 @@
+=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_cliff dataset: one row per drug whose exclusivity ends in the future. A grouped request returns the group columns and the measures instead, as additional properties.
+  class DrugPatentCliffRow
+    # The drug key.
+    attr_accessor :drug_id
+
+    # The drug's name.
+    attr_accessor :drug_name
+
+    # The drug's pharmacologic class.
+    attr_accessor :pharm_class
+
+    # The drug's Anatomical Therapeutic Chemical (ATC) class.
+    attr_accessor :atc_class
+
+    # The brand name.
+    attr_accessor :brand
+
+    # Other candidate brand names, comma separated.
+    attr_accessor :candidate_brands
+
+    # The date exclusivity is expected to end (loss of exclusivity); always in the future when the dataset is built.
+    attr_accessor :cliff_date
+
+    # The year of cliff_date.
+    attr_accessor :cliff_year
+
+    # Which regime set the date: curated_loe, orange_book_patent, pte_expiry or bpcia_exclusivity.
+    attr_accessor :cliff_basis
+
+    # Source of a curated date (null on the other bases).
+    attr_accessor :cliff_source
+
+    # Confidence of a curated date (null on the other bases).
+    attr_accessor :cliff_confidence
+
+    # True when a generic is already marketed.
+    attr_accessor :has_generic
+
+    # True when a biosimilar is already marketed.
+    attr_accessor :biosimilar_available
+
+    # The brand or originator applicant as the Orange Book or Purple Book names it.
+    attr_accessor :applicant_name
+
+    # Legal-entity level: the organization record the applicant resolved to (null when unresolved).
+    attr_accessor :applicant_org_id
+
+    # Company level: the company the applicant belongs to (null when unresolved).
+    attr_accessor :applicant_company_id
+
+    # Display name of the applicant's company.
+    attr_accessor :applicant_company_name
+
+    # Group level: the applicant's current ultimate parent company; a root company's group is itself.
+    attr_accessor :applicant_group_id
+
+    # Display name of the applicant's group.
+    attr_accessor :applicant_group_name
+
+    # How the applicant name matched an organization record.
+    attr_accessor :applicant_match_scope
+
+    # Latest-year Medicare Part B and D spend for the drug, in US dollars.
+    attr_accessor :medicare_spend
+
+    # The year of medicare_spend.
+    attr_accessor :medicare_spend_year
+
+    # Latest full-year disclosed worldwide revenue, in US millions.
+    attr_accessor :disclosed_revenue_usd_millions
+
+    # The fiscal year of the disclosed revenue.
+    attr_accessor :disclosed_revenue_year
+
+    # The single size axis in US dollars: disclosed revenue when present, else Medicare spend.
+    attr_accessor :size_usd
+
+    # Which source size_usd used: disclosed_worldwide_revenue, medicare_spend or none.
+    attr_accessor :size_basis
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'drug_id' => :'drug_id',
+        :'drug_name' => :'drug_name',
+        :'pharm_class' => :'pharm_class',
+        :'atc_class' => :'atc_class',
+        :'brand' => :'brand',
+        :'candidate_brands' => :'candidate_brands',
+        :'cliff_date' => :'cliff_date',
+        :'cliff_year' => :'cliff_year',
+        :'cliff_basis' => :'cliff_basis',
+        :'cliff_source' => :'cliff_source',
+        :'cliff_confidence' => :'cliff_confidence',
+        :'has_generic' => :'has_generic',
+        :'biosimilar_available' => :'biosimilar_available',
+        :'applicant_name' => :'applicant_name',
+        :'applicant_org_id' => :'applicant_org_id',
+        :'applicant_company_id' => :'applicant_company_id',
+        :'applicant_company_name' => :'applicant_company_name',
+        :'applicant_group_id' => :'applicant_group_id',
+        :'applicant_group_name' => :'applicant_group_name',
+        :'applicant_match_scope' => :'applicant_match_scope',
+        :'medicare_spend' => :'medicare_spend',
+        :'medicare_spend_year' => :'medicare_spend_year',
+        :'disclosed_revenue_usd_millions' => :'disclosed_revenue_usd_millions',
+        :'disclosed_revenue_year' => :'disclosed_revenue_year',
+        :'size_usd' => :'size_usd',
+        :'size_basis' => :'size_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
+      {
+        :'drug_id' => :'String',
+        :'drug_name' => :'String',
+        :'pharm_class' => :'String',
+        :'atc_class' => :'String',
+        :'brand' => :'String',
+        :'candidate_brands' => :'String',
+        :'cliff_date' => :'Date',
+        :'cliff_year' => :'Integer',
+        :'cliff_basis' => :'String',
+        :'cliff_source' => :'String',
+        :'cliff_confidence' => :'String',
+        :'has_generic' => :'Boolean',
+        :'biosimilar_available' => :'Boolean',
+        :'applicant_name' => :'String',
+        :'applicant_org_id' => :'String',
+        :'applicant_company_id' => :'String',
+        :'applicant_company_name' => :'String',
+        :'applicant_group_id' => :'String',
+        :'applicant_group_name' => :'String',
+        :'applicant_match_scope' => :'String',
+        :'medicare_spend' => :'Float',
+        :'medicare_spend_year' => :'Integer',
+        :'disclosed_revenue_usd_millions' => :'Float',
+        :'disclosed_revenue_year' => :'Integer',
+        :'size_usd' => :'Float',
+        :'size_basis' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'drug_id',
+        :'drug_name',
+        :'pharm_class',
+        :'atc_class',
+        :'brand',
+        :'candidate_brands',
+        :'cliff_date',
+        :'cliff_year',
+        :'cliff_basis',
+        :'cliff_source',
+        :'cliff_confidence',
+        :'has_generic',
+        :'biosimilar_available',
+        :'applicant_name',
+        :'applicant_org_id',
+        :'applicant_company_id',
+        :'applicant_company_name',
+        :'applicant_group_id',
+        :'applicant_group_name',
+        :'applicant_match_scope',
+        :'medicare_spend',
+        :'medicare_spend_year',
+        :'disclosed_revenue_usd_millions',
+        :'disclosed_revenue_year',
+        :'size_usd',
+        :'size_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::DrugPatentCliffRow` 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::DrugPatentCliffRow`. 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?(:'drug_id')
+        self.drug_id = attributes[:'drug_id']
+      end
+
+      if attributes.key?(:'drug_name')
+        self.drug_name = attributes[:'drug_name']
+      end
+
+      if attributes.key?(:'pharm_class')
+        self.pharm_class = attributes[:'pharm_class']
+      end
+
+      if attributes.key?(:'atc_class')
+        self.atc_class = attributes[:'atc_class']
+      end
+
+      if attributes.key?(:'brand')
+        self.brand = attributes[:'brand']
+      end
+
+      if attributes.key?(:'candidate_brands')
+        self.candidate_brands = attributes[:'candidate_brands']
+      end
+
+      if attributes.key?(:'cliff_date')
+        self.cliff_date = attributes[:'cliff_date']
+      end
+
+      if attributes.key?(:'cliff_year')
+        self.cliff_year = attributes[:'cliff_year']
+      end
+
+      if attributes.key?(:'cliff_basis')
+        self.cliff_basis = attributes[:'cliff_basis']
+      end
+
+      if attributes.key?(:'cliff_source')
+        self.cliff_source = attributes[:'cliff_source']
+      end
+
+      if attributes.key?(:'cliff_confidence')
+        self.cliff_confidence = attributes[:'cliff_confidence']
+      end
+
+      if attributes.key?(:'has_generic')
+        self.has_generic = attributes[:'has_generic']
+      end
+
+      if attributes.key?(:'biosimilar_available')
+        self.biosimilar_available = attributes[:'biosimilar_available']
+      end
+
+      if attributes.key?(:'applicant_name')
+        self.applicant_name = attributes[:'applicant_name']
+      end
+
+      if attributes.key?(:'applicant_org_id')
+        self.applicant_org_id = attributes[:'applicant_org_id']
+      end
+
+      if attributes.key?(:'applicant_company_id')
+        self.applicant_company_id = attributes[:'applicant_company_id']
+      end
+
+      if attributes.key?(:'applicant_company_name')
+        self.applicant_company_name = attributes[:'applicant_company_name']
+      end
+
+      if attributes.key?(:'applicant_group_id')
+        self.applicant_group_id = attributes[:'applicant_group_id']
+      end
+
+      if attributes.key?(:'applicant_group_name')
+        self.applicant_group_name = attributes[:'applicant_group_name']
+      end
+
+      if attributes.key?(:'applicant_match_scope')
+        self.applicant_match_scope = attributes[:'applicant_match_scope']
+      end
+
+      if attributes.key?(:'medicare_spend')
+        self.medicare_spend = attributes[:'medicare_spend']
+      end
+
+      if attributes.key?(:'medicare_spend_year')
+        self.medicare_spend_year = attributes[:'medicare_spend_year']
+      end
+
+      if attributes.key?(:'disclosed_revenue_usd_millions')
+        self.disclosed_revenue_usd_millions = attributes[:'disclosed_revenue_usd_millions']
+      end
+
+      if attributes.key?(:'disclosed_revenue_year')
+        self.disclosed_revenue_year = attributes[:'disclosed_revenue_year']
+      end
+
+      if attributes.key?(:'size_usd')
+        self.size_usd = attributes[:'size_usd']
+      end
+
+      if attributes.key?(:'size_basis')
+        self.size_basis = attributes[:'size_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 &&
+          drug_id == o.drug_id &&
+          drug_name == o.drug_name &&
+          pharm_class == o.pharm_class &&
+          atc_class == o.atc_class &&
+          brand == o.brand &&
+          candidate_brands == o.candidate_brands &&
+          cliff_date == o.cliff_date &&
+          cliff_year == o.cliff_year &&
+          cliff_basis == o.cliff_basis &&
+          cliff_source == o.cliff_source &&
+          cliff_confidence == o.cliff_confidence &&
+          has_generic == o.has_generic &&
+          biosimilar_available == o.biosimilar_available &&
+          applicant_name == o.applicant_name &&
+          applicant_org_id == o.applicant_org_id &&
+          applicant_company_id == o.applicant_company_id &&
+          applicant_company_name == o.applicant_company_name &&
+          applicant_group_id == o.applicant_group_id &&
+          applicant_group_name == o.applicant_group_name &&
+          applicant_match_scope == o.applicant_match_scope &&
+          medicare_spend == o.medicare_spend &&
+          medicare_spend_year == o.medicare_spend_year &&
+          disclosed_revenue_usd_millions == o.disclosed_revenue_usd_millions &&
+          disclosed_revenue_year == o.disclosed_revenue_year &&
+          size_usd == o.size_usd &&
+          size_basis == o.size_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
+      [drug_id, drug_name, pharm_class, atc_class, brand, candidate_brands, cliff_date, cliff_year, cliff_basis, cliff_source, cliff_confidence, has_generic, biosimilar_available, applicant_name, applicant_org_id, applicant_company_id, applicant_company_name, applicant_group_id, applicant_group_name, applicant_match_scope, medicare_spend, medicare_spend_year, disclosed_revenue_usd_millions, disclosed_revenue_year, size_usd, size_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