pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/brand_revenue_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 brand_revenue dataset: one row per drug, brand, reporting company, fiscal year, basis and geography. A grouped request returns the group columns and the measures instead, as additional properties.
+  class BrandRevenueRow
+    # 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 brand key: an upper-case alphanumeric trade-name token (the brand's leading name tokens), the same key the brands pages use. Not a display name; brand_name is the display form.
+    attr_accessor :brand_key
+
+    # The product name as filed.
+    attr_accessor :product_name
+
+    # Legal-entity level: the SEC filer that reported the figure, as filed (edgar:<CIK>).
+    attr_accessor :reporter_org_id
+
+    # Company level: the reporting company's company (null when unresolved).
+    attr_accessor :reporter_company_id
+
+    # Display name of the reporting company's company.
+    attr_accessor :reporter_company_name
+
+    # Group level: the reporting company's current ultimate parent company; a root company's group is itself.
+    attr_accessor :reporter_group_id
+
+    # Display name of the reporting company's group.
+    attr_accessor :reporter_group_name
+
+    # The fiscal year of the figure.
+    attr_accessor :fiscal_year
+
+    # The standardised basis: worldwide, us, ex_us, region or country.
+    attr_accessor :revenue_basis
+
+    # The normalised geography: worldwide, us or ex_us for the spine (equal to the basis), the filer's own label for a region or country line.
+    attr_accessor :geography
+
+    # The figure in USD millions (null where no unit or exchange rate is available).
+    attr_accessor :revenue_usd_millions
+
+    # The figure as reported, in reporting_unit and revenue_currency; can be negative for adjustment or return lines.
+    attr_accessor :revenue_amount
+
+    # The filing's currency (ISO code).
+    attr_accessor :revenue_currency
+
+    # The filing's reporting unit (units, thousands, millions or billions); null when the filing did not state a readable one.
+    attr_accessor :reporting_unit
+
+    # True when the figure comes from the filing for its own fiscal year, false when it is a comparative year read from a later filing.
+    attr_accessor :as_reported
+
+    # Distinct filings that report the figure.
+    attr_accessor :n_filings
+
+    # True when several filings report the figure and differ by more than one percent.
+    attr_accessor :restated
+
+    # The extraction's confidence in the line, 0 to 1.
+    attr_accessor :confidence
+
+    # The link to the SEC filing the figure was extracted from.
+    attr_accessor :source_url
+
+    # The sentence of the filing the figure was extracted from.
+    attr_accessor :evidence_quote
+
+    # How the product name matched the brand: alias_prefix, product_prefix or curated_alias. A label of the mechanism, not a confidence.
+    attr_accessor :match_method
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'molecule_id' => :'molecule_id',
+        :'brand_key' => :'brand_key',
+        :'product_name' => :'product_name',
+        :'reporter_org_id' => :'reporter_org_id',
+        :'reporter_company_id' => :'reporter_company_id',
+        :'reporter_company_name' => :'reporter_company_name',
+        :'reporter_group_id' => :'reporter_group_id',
+        :'reporter_group_name' => :'reporter_group_name',
+        :'fiscal_year' => :'fiscal_year',
+        :'revenue_basis' => :'revenue_basis',
+        :'geography' => :'geography',
+        :'revenue_usd_millions' => :'revenue_usd_millions',
+        :'revenue_amount' => :'revenue_amount',
+        :'revenue_currency' => :'revenue_currency',
+        :'reporting_unit' => :'reporting_unit',
+        :'as_reported' => :'as_reported',
+        :'n_filings' => :'n_filings',
+        :'restated' => :'restated',
+        :'confidence' => :'confidence',
+        :'source_url' => :'source_url',
+        :'evidence_quote' => :'evidence_quote',
+        :'match_method' => :'match_method'
+      }
+    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',
+        :'brand_key' => :'String',
+        :'product_name' => :'String',
+        :'reporter_org_id' => :'String',
+        :'reporter_company_id' => :'String',
+        :'reporter_company_name' => :'String',
+        :'reporter_group_id' => :'String',
+        :'reporter_group_name' => :'String',
+        :'fiscal_year' => :'Integer',
+        :'revenue_basis' => :'String',
+        :'geography' => :'String',
+        :'revenue_usd_millions' => :'Float',
+        :'revenue_amount' => :'Float',
+        :'revenue_currency' => :'String',
+        :'reporting_unit' => :'String',
+        :'as_reported' => :'Boolean',
+        :'n_filings' => :'Integer',
+        :'restated' => :'Boolean',
+        :'confidence' => :'Float',
+        :'source_url' => :'String',
+        :'evidence_quote' => :'String',
+        :'match_method' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'molecule_id',
+        :'brand_key',
+        :'product_name',
+        :'reporter_org_id',
+        :'reporter_company_id',
+        :'reporter_company_name',
+        :'reporter_group_id',
+        :'reporter_group_name',
+        :'fiscal_year',
+        :'revenue_basis',
+        :'geography',
+        :'revenue_usd_millions',
+        :'revenue_amount',
+        :'revenue_currency',
+        :'reporting_unit',
+        :'as_reported',
+        :'n_filings',
+        :'restated',
+        :'confidence',
+        :'source_url',
+        :'evidence_quote',
+        :'match_method'
+      ])
+    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::BrandRevenueRow` 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::BrandRevenueRow`. 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?(:'brand_key')
+        self.brand_key = attributes[:'brand_key']
+      end
+
+      if attributes.key?(:'product_name')
+        self.product_name = attributes[:'product_name']
+      end
+
+      if attributes.key?(:'reporter_org_id')
+        self.reporter_org_id = attributes[:'reporter_org_id']
+      end
+
+      if attributes.key?(:'reporter_company_id')
+        self.reporter_company_id = attributes[:'reporter_company_id']
+      end
+
+      if attributes.key?(:'reporter_company_name')
+        self.reporter_company_name = attributes[:'reporter_company_name']
+      end
+
+      if attributes.key?(:'reporter_group_id')
+        self.reporter_group_id = attributes[:'reporter_group_id']
+      end
+
+      if attributes.key?(:'reporter_group_name')
+        self.reporter_group_name = attributes[:'reporter_group_name']
+      end
+
+      if attributes.key?(:'fiscal_year')
+        self.fiscal_year = attributes[:'fiscal_year']
+      end
+
+      if attributes.key?(:'revenue_basis')
+        self.revenue_basis = attributes[:'revenue_basis']
+      end
+
+      if attributes.key?(:'geography')
+        self.geography = attributes[:'geography']
+      end
+
+      if attributes.key?(:'revenue_usd_millions')
+        self.revenue_usd_millions = attributes[:'revenue_usd_millions']
+      end
+
+      if attributes.key?(:'revenue_amount')
+        self.revenue_amount = attributes[:'revenue_amount']
+      end
+
+      if attributes.key?(:'revenue_currency')
+        self.revenue_currency = attributes[:'revenue_currency']
+      end
+
+      if attributes.key?(:'reporting_unit')
+        self.reporting_unit = attributes[:'reporting_unit']
+      end
+
+      if attributes.key?(:'as_reported')
+        self.as_reported = attributes[:'as_reported']
+      end
+
+      if attributes.key?(:'n_filings')
+        self.n_filings = attributes[:'n_filings']
+      end
+
+      if attributes.key?(:'restated')
+        self.restated = attributes[:'restated']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'evidence_quote')
+        self.evidence_quote = attributes[:'evidence_quote']
+      end
+
+      if attributes.key?(:'match_method')
+        self.match_method = attributes[:'match_method']
+      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 &&
+          brand_key == o.brand_key &&
+          product_name == o.product_name &&
+          reporter_org_id == o.reporter_org_id &&
+          reporter_company_id == o.reporter_company_id &&
+          reporter_company_name == o.reporter_company_name &&
+          reporter_group_id == o.reporter_group_id &&
+          reporter_group_name == o.reporter_group_name &&
+          fiscal_year == o.fiscal_year &&
+          revenue_basis == o.revenue_basis &&
+          geography == o.geography &&
+          revenue_usd_millions == o.revenue_usd_millions &&
+          revenue_amount == o.revenue_amount &&
+          revenue_currency == o.revenue_currency &&
+          reporting_unit == o.reporting_unit &&
+          as_reported == o.as_reported &&
+          n_filings == o.n_filings &&
+          restated == o.restated &&
+          confidence == o.confidence &&
+          source_url == o.source_url &&
+          evidence_quote == o.evidence_quote &&
+          match_method == o.match_method
+    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, brand_key, product_name, reporter_org_id, reporter_company_id, reporter_company_name, reporter_group_id, reporter_group_name, fiscal_year, revenue_basis, geography, revenue_usd_millions, revenue_amount, revenue_currency, reporting_unit, as_reported, n_filings, restated, confidence, source_url, evidence_quote, match_method].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