pharmaobservatory 0.1.6 → 0.1.7

data/lib/pharmaobservatory/models/catalysts_row.rb

@@ -0,0 +1,623 @@
+=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 catalysts dataset: one row per dated forward event. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CatalystsRow
+    # The event key: event_type, a colon and source_record_id. Unique.
+    attr_accessor :event_id
+
+    # What the event is: readout (a trial's primary completion), patent_cliff (loss of exclusivity), pdufa (an FDA decision date or advisory committee) or press_release (a Benzinga press-release event).
+    attr_accessor :event_type
+
+    # The kind of event within its type. readout: primary_completion. patent_cliff: the cliff basis (curated_loe, orange_book_patent, pte_expiry, bpcia_exclusivity). pdufa: the calendar's own category (pdufa, advisory_committee and others). press_release: the Benzinga event token, lowercased (clinical_trial_result, pdufa_assignment, data_presentation and others). Open vocabulary on the last two.
+    attr_accessor :event_category
+
+    # The lane the row came from: ctgov (ClinicalTrials.gov), drug_exclusivity (the exclusivity registers), benzinga, both or sec_extraction (the PDUFA calendar, the same values as pdufa_dates) or benzinga_press_release.
+    attr_accessor :source
+
+    # The key of the row in its source, to join back to trials.trial_id, drug_patent_cliff.drug_id, pdufa_dates.pdufa_date_id or the press-release event id.
+    attr_accessor :source_record_id
+
+    # none for an open row (ClinicalTrials.gov, the exclusivity registers, the SEC lane of the PDUFA calendar); licensable for a Benzinga row (the calendar or a press release). The api view gates rows on it.
+    attr_accessor :restriction_tier
+
+    # The date the calendar sorts on: a readout's primary completion date, the cliff date, the decision date, or the end of the press-release event's date window.
+    attr_accessor :event_date
+
+    # The calendar year of event_date; the x axis of a by-year count.
+    attr_accessor :event_year
+
+    # Start of the date interval the source states (the first day of the month for a readout the registry filed by month).
+    attr_accessor :date_start
+
+    # End of the date interval the source states.
+    attr_accessor :date_end
+
+    # Precision of the date (day, month, quarter, half, year, fuzzy, relative). A readout is month where the registry filed only a month, in which case event_date is the last day of that month.
+    attr_accessor :date_precision
+
+    # The date as the source words it (an ISO date for a readout and a cliff; the press release's own phrase, such as H2 2026).
+    attr_accessor :date_phrase
+
+    # For a readout, whether the registry's completion date is estimated or actual (an anticipated date counts as estimated); null on the other legs.
+    attr_accessor :date_status
+
+    # The ClinicalTrials.gov registry id (readout rows).
+    attr_accessor :trial_id
+
+    # The trial's brief title (readout rows).
+    attr_accessor :trial_title
+
+    # The registry's phase code (readout rows).
+    attr_accessor :phase
+
+    # The trial phase as a display label (readout rows).
+    attr_accessor :phase_label
+
+    # The registry's overall status code (readout rows).
+    attr_accessor :overall_status
+
+    # The registry ids a press-release event names; null on the other legs.
+    attr_accessor :related_trial_ids
+
+    # The outcome a press-release event reports (a decided event stays in the forward book); null on the other legs.
+    attr_accessor :outcome
+
+    # The indication as the source words it (PDUFA and press-release rows).
+    attr_accessor :indication_text
+
+    # The condition key (PDUFA rows).
+    attr_accessor :condition_id
+
+    # The condition's name (PDUFA rows).
+    attr_accessor :condition_name
+
+    # Kind of source document (SEC filing for the SEC lane, Press release for a press-release event); null on the open legs.
+    attr_accessor :source_type
+
+    # Link to the source document (PDUFA and press-release rows).
+    attr_accessor :source_url
+
+    # The drug name as filed or its display name; null on a readout (its drugs are the list drug_ids).
+    attr_accessor :drug_name
+
+    # The drug key of a patent-cliff, PDUFA or press-release row; null on a readout and where the drug did not resolve.
+    attr_accessor :drug_id
+
+    # The molecule key (PDUFA and press-release rows).
+    attr_accessor :molecule_id
+
+    # Every drug key of the event: a readout carries each drug of its trial, sorted; the other legs carry their one drug, or an empty array. The drug predicate of a watchlist is '<drug>' = ANY(drug_ids).
+    attr_accessor :drug_ids
+
+    # What the organization is on the row: lead_sponsor (readout), applicant (patent cliff, the FDA applicant of record), sponsor (PDUFA) or issuer (press release, the company the ticker names).
+    attr_accessor :sponsor_role
+
+    # The organization's name as filed; null on a press-release row (the source names a ticker, not an organization).
+    attr_accessor :sponsor_name
+
+    # Legal-entity level: the organization record (a readout's lead sponsor, a cliff's applicant, a PDUFA row's filing organization; for a press release the identity hub's resolved entity for the ticker). Null when unresolved.
+    attr_accessor :sponsor_org_id
+
+    # Company level: the company the organization belongs to (null when unresolved).
+    attr_accessor :sponsor_company_id
+
+    # Display name of the organization's company.
+    attr_accessor :sponsor_company_name
+
+    # Group level: the organization's current ultimate parent company; a root company's group is itself.
+    attr_accessor :sponsor_group_id
+
+    # Display name of the organization's group.
+    attr_accessor :sponsor_group_name
+
+    # Exchange ticker (PDUFA and press-release rows).
+    attr_accessor :ticker
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'event_id' => :'event_id',
+        :'event_type' => :'event_type',
+        :'event_category' => :'event_category',
+        :'source' => :'source',
+        :'source_record_id' => :'source_record_id',
+        :'restriction_tier' => :'restriction_tier',
+        :'event_date' => :'event_date',
+        :'event_year' => :'event_year',
+        :'date_start' => :'date_start',
+        :'date_end' => :'date_end',
+        :'date_precision' => :'date_precision',
+        :'date_phrase' => :'date_phrase',
+        :'date_status' => :'date_status',
+        :'trial_id' => :'trial_id',
+        :'trial_title' => :'trial_title',
+        :'phase' => :'phase',
+        :'phase_label' => :'phase_label',
+        :'overall_status' => :'overall_status',
+        :'related_trial_ids' => :'related_trial_ids',
+        :'outcome' => :'outcome',
+        :'indication_text' => :'indication_text',
+        :'condition_id' => :'condition_id',
+        :'condition_name' => :'condition_name',
+        :'source_type' => :'source_type',
+        :'source_url' => :'source_url',
+        :'drug_name' => :'drug_name',
+        :'drug_id' => :'drug_id',
+        :'molecule_id' => :'molecule_id',
+        :'drug_ids' => :'drug_ids',
+        :'sponsor_role' => :'sponsor_role',
+        :'sponsor_name' => :'sponsor_name',
+        :'sponsor_org_id' => :'sponsor_org_id',
+        :'sponsor_company_id' => :'sponsor_company_id',
+        :'sponsor_company_name' => :'sponsor_company_name',
+        :'sponsor_group_id' => :'sponsor_group_id',
+        :'sponsor_group_name' => :'sponsor_group_name',
+        :'ticker' => :'ticker'
+      }
+    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
+      {
+        :'event_id' => :'String',
+        :'event_type' => :'String',
+        :'event_category' => :'String',
+        :'source' => :'String',
+        :'source_record_id' => :'String',
+        :'restriction_tier' => :'String',
+        :'event_date' => :'Date',
+        :'event_year' => :'Integer',
+        :'date_start' => :'Date',
+        :'date_end' => :'Date',
+        :'date_precision' => :'String',
+        :'date_phrase' => :'String',
+        :'date_status' => :'String',
+        :'trial_id' => :'String',
+        :'trial_title' => :'String',
+        :'phase' => :'String',
+        :'phase_label' => :'String',
+        :'overall_status' => :'String',
+        :'related_trial_ids' => :'Array<String>',
+        :'outcome' => :'String',
+        :'indication_text' => :'String',
+        :'condition_id' => :'String',
+        :'condition_name' => :'String',
+        :'source_type' => :'String',
+        :'source_url' => :'String',
+        :'drug_name' => :'String',
+        :'drug_id' => :'String',
+        :'molecule_id' => :'String',
+        :'drug_ids' => :'Array<String>',
+        :'sponsor_role' => :'String',
+        :'sponsor_name' => :'String',
+        :'sponsor_org_id' => :'String',
+        :'sponsor_company_id' => :'String',
+        :'sponsor_company_name' => :'String',
+        :'sponsor_group_id' => :'String',
+        :'sponsor_group_name' => :'String',
+        :'ticker' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'event_id',
+        :'event_type',
+        :'event_category',
+        :'source',
+        :'source_record_id',
+        :'restriction_tier',
+        :'event_date',
+        :'event_year',
+        :'date_start',
+        :'date_end',
+        :'date_precision',
+        :'date_phrase',
+        :'date_status',
+        :'trial_id',
+        :'trial_title',
+        :'phase',
+        :'phase_label',
+        :'overall_status',
+        :'related_trial_ids',
+        :'outcome',
+        :'indication_text',
+        :'condition_id',
+        :'condition_name',
+        :'source_type',
+        :'source_url',
+        :'drug_name',
+        :'drug_id',
+        :'molecule_id',
+        :'drug_ids',
+        :'sponsor_role',
+        :'sponsor_name',
+        :'sponsor_org_id',
+        :'sponsor_company_id',
+        :'sponsor_company_name',
+        :'sponsor_group_id',
+        :'sponsor_group_name',
+        :'ticker'
+      ])
+    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::CatalystsRow` 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::CatalystsRow`. 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?(:'event_id')
+        self.event_id = attributes[:'event_id']
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'event_category')
+        self.event_category = attributes[:'event_category']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'source_record_id')
+        self.source_record_id = attributes[:'source_record_id']
+      end
+
+      if attributes.key?(:'restriction_tier')
+        self.restriction_tier = attributes[:'restriction_tier']
+      end
+
+      if attributes.key?(:'event_date')
+        self.event_date = attributes[:'event_date']
+      end
+
+      if attributes.key?(:'event_year')
+        self.event_year = attributes[:'event_year']
+      end
+
+      if attributes.key?(:'date_start')
+        self.date_start = attributes[:'date_start']
+      end
+
+      if attributes.key?(:'date_end')
+        self.date_end = attributes[:'date_end']
+      end
+
+      if attributes.key?(:'date_precision')
+        self.date_precision = attributes[:'date_precision']
+      end
+
+      if attributes.key?(:'date_phrase')
+        self.date_phrase = attributes[:'date_phrase']
+      end
+
+      if attributes.key?(:'date_status')
+        self.date_status = attributes[:'date_status']
+      end
+
+      if attributes.key?(:'trial_id')
+        self.trial_id = attributes[:'trial_id']
+      end
+
+      if attributes.key?(:'trial_title')
+        self.trial_title = attributes[:'trial_title']
+      end
+
+      if attributes.key?(:'phase')
+        self.phase = attributes[:'phase']
+      end
+
+      if attributes.key?(:'phase_label')
+        self.phase_label = attributes[:'phase_label']
+      end
+
+      if attributes.key?(:'overall_status')
+        self.overall_status = attributes[:'overall_status']
+      end
+
+      if attributes.key?(:'related_trial_ids')
+        if (value = attributes[:'related_trial_ids']).is_a?(Array)
+          self.related_trial_ids = value
+        end
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      end
+
+      if attributes.key?(:'indication_text')
+        self.indication_text = attributes[:'indication_text']
+      end
+
+      if attributes.key?(:'condition_id')
+        self.condition_id = attributes[:'condition_id']
+      end
+
+      if attributes.key?(:'condition_name')
+        self.condition_name = attributes[:'condition_name']
+      end
+
+      if attributes.key?(:'source_type')
+        self.source_type = attributes[:'source_type']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      end
+
+      if attributes.key?(:'drug_name')
+        self.drug_name = attributes[:'drug_name']
+      end
+
+      if attributes.key?(:'drug_id')
+        self.drug_id = attributes[:'drug_id']
+      end
+
+      if attributes.key?(:'molecule_id')
+        self.molecule_id = attributes[:'molecule_id']
+      end
+
+      if attributes.key?(:'drug_ids')
+        if (value = attributes[:'drug_ids']).is_a?(Array)
+          self.drug_ids = value
+        end
+      end
+
+      if attributes.key?(:'sponsor_role')
+        self.sponsor_role = attributes[:'sponsor_role']
+      end
+
+      if attributes.key?(:'sponsor_name')
+        self.sponsor_name = attributes[:'sponsor_name']
+      end
+
+      if attributes.key?(:'sponsor_org_id')
+        self.sponsor_org_id = attributes[:'sponsor_org_id']
+      end
+
+      if attributes.key?(:'sponsor_company_id')
+        self.sponsor_company_id = attributes[:'sponsor_company_id']
+      end
+
+      if attributes.key?(:'sponsor_company_name')
+        self.sponsor_company_name = attributes[:'sponsor_company_name']
+      end
+
+      if attributes.key?(:'sponsor_group_id')
+        self.sponsor_group_id = attributes[:'sponsor_group_id']
+      end
+
+      if attributes.key?(:'sponsor_group_name')
+        self.sponsor_group_name = attributes[:'sponsor_group_name']
+      end
+
+      if attributes.key?(:'ticker')
+        self.ticker = attributes[:'ticker']
+      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 &&
+          event_id == o.event_id &&
+          event_type == o.event_type &&
+          event_category == o.event_category &&
+          source == o.source &&
+          source_record_id == o.source_record_id &&
+          restriction_tier == o.restriction_tier &&
+          event_date == o.event_date &&
+          event_year == o.event_year &&
+          date_start == o.date_start &&
+          date_end == o.date_end &&
+          date_precision == o.date_precision &&
+          date_phrase == o.date_phrase &&
+          date_status == o.date_status &&
+          trial_id == o.trial_id &&
+          trial_title == o.trial_title &&
+          phase == o.phase &&
+          phase_label == o.phase_label &&
+          overall_status == o.overall_status &&
+          related_trial_ids == o.related_trial_ids &&
+          outcome == o.outcome &&
+          indication_text == o.indication_text &&
+          condition_id == o.condition_id &&
+          condition_name == o.condition_name &&
+          source_type == o.source_type &&
+          source_url == o.source_url &&
+          drug_name == o.drug_name &&
+          drug_id == o.drug_id &&
+          molecule_id == o.molecule_id &&
+          drug_ids == o.drug_ids &&
+          sponsor_role == o.sponsor_role &&
+          sponsor_name == o.sponsor_name &&
+          sponsor_org_id == o.sponsor_org_id &&
+          sponsor_company_id == o.sponsor_company_id &&
+          sponsor_company_name == o.sponsor_company_name &&
+          sponsor_group_id == o.sponsor_group_id &&
+          sponsor_group_name == o.sponsor_group_name &&
+          ticker == o.ticker
+    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
+      [event_id, event_type, event_category, source, source_record_id, restriction_tier, event_date, event_year, date_start, date_end, date_precision, date_phrase, date_status, trial_id, trial_title, phase, phase_label, overall_status, related_trial_ids, outcome, indication_text, condition_id, condition_name, source_type, source_url, drug_name, drug_id, molecule_id, drug_ids, sponsor_role, sponsor_name, sponsor_org_id, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, ticker].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