pharmaobservatory 0.1.2 → 0.1.3

data/lib/pharmaobservatory/models/pdufa_dates_row.rb

@@ -0,0 +1,487 @@
+=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 pdufa_dates dataset: one row per calendar entry. A grouped request returns the group columns and the measures instead, as additional properties.
+  class PdufaDatesRow
+    # The calendar entry id.
+    attr_accessor :pdufa_date_id
+
+    # Which lane the row came from: benzinga, sec_extraction or both.
+    attr_accessor :source
+
+    # none for a row from SEC filings; licensable for a row from the Benzinga calendar.
+    attr_accessor :restriction_tier
+
+    # The FDA decision date (PDUFA is the date under the Prescription Drug User Fee Act).
+    attr_accessor :decision_date
+
+    # Start of the date interval the source states.
+    attr_accessor :date_start
+
+    # End of the date interval the source states.
+    attr_accessor :date_end
+
+    # Precision of the date (day, month, quarter).
+    attr_accessor :date_precision
+
+    # The date as the source words it.
+    attr_accessor :date_phrase
+
+    # Event type.
+    attr_accessor :event_type
+
+    # Event category (pdufa, adcomm and so on).
+    attr_accessor :event_category
+
+    # The drug name as filed.
+    attr_accessor :drug_name
+
+    # The drug key.
+    attr_accessor :drug_id
+
+    # The molecule key.
+    attr_accessor :molecule_id
+
+    # The sponsor name as filed.
+    attr_accessor :sponsor_name
+
+    # Legal-entity level: the organization record the sponsor resolved to (null when unresolved).
+    attr_accessor :sponsor_org_id
+
+    # Company level: the company the sponsor belongs to (null when unresolved).
+    attr_accessor :sponsor_company_id
+
+    # Display name of the sponsor's company.
+    attr_accessor :sponsor_company_name
+
+    # Group level: the sponsor's current ultimate parent company; a root company's group is itself.
+    attr_accessor :sponsor_group_id
+
+    # Display name of the sponsor's group.
+    attr_accessor :sponsor_group_name
+
+    # Exchange ticker.
+    attr_accessor :ticker
+
+    # The condition key.
+    attr_accessor :condition_id
+
+    # The condition's name.
+    attr_accessor :condition_name
+
+    # The indication as the source words it.
+    attr_accessor :indication_text
+
+    # Kind of source document.
+    attr_accessor :source_type
+
+    # Link to the source document.
+    attr_accessor :source_link
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pdufa_date_id' => :'pdufa_date_id',
+        :'source' => :'source',
+        :'restriction_tier' => :'restriction_tier',
+        :'decision_date' => :'decision_date',
+        :'date_start' => :'date_start',
+        :'date_end' => :'date_end',
+        :'date_precision' => :'date_precision',
+        :'date_phrase' => :'date_phrase',
+        :'event_type' => :'event_type',
+        :'event_category' => :'event_category',
+        :'drug_name' => :'drug_name',
+        :'drug_id' => :'drug_id',
+        :'molecule_id' => :'molecule_id',
+        :'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',
+        :'condition_id' => :'condition_id',
+        :'condition_name' => :'condition_name',
+        :'indication_text' => :'indication_text',
+        :'source_type' => :'source_type',
+        :'source_link' => :'source_link'
+      }
+    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
+      {
+        :'pdufa_date_id' => :'String',
+        :'source' => :'String',
+        :'restriction_tier' => :'String',
+        :'decision_date' => :'Date',
+        :'date_start' => :'Date',
+        :'date_end' => :'Date',
+        :'date_precision' => :'String',
+        :'date_phrase' => :'String',
+        :'event_type' => :'String',
+        :'event_category' => :'String',
+        :'drug_name' => :'String',
+        :'drug_id' => :'String',
+        :'molecule_id' => :'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',
+        :'condition_id' => :'String',
+        :'condition_name' => :'String',
+        :'indication_text' => :'String',
+        :'source_type' => :'String',
+        :'source_link' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'pdufa_date_id',
+        :'source',
+        :'restriction_tier',
+        :'decision_date',
+        :'date_start',
+        :'date_end',
+        :'date_precision',
+        :'date_phrase',
+        :'event_type',
+        :'event_category',
+        :'drug_name',
+        :'drug_id',
+        :'molecule_id',
+        :'sponsor_name',
+        :'sponsor_org_id',
+        :'sponsor_company_id',
+        :'sponsor_company_name',
+        :'sponsor_group_id',
+        :'sponsor_group_name',
+        :'ticker',
+        :'condition_id',
+        :'condition_name',
+        :'indication_text',
+        :'source_type',
+        :'source_link'
+      ])
+    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::PdufaDatesRow` 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::PdufaDatesRow`. 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?(:'pdufa_date_id')
+        self.pdufa_date_id = attributes[:'pdufa_date_id']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'restriction_tier')
+        self.restriction_tier = attributes[:'restriction_tier']
+      end
+
+      if attributes.key?(:'decision_date')
+        self.decision_date = attributes[:'decision_date']
+      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?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'event_category')
+        self.event_category = attributes[:'event_category']
+      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?(:'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
+
+      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?(:'indication_text')
+        self.indication_text = attributes[:'indication_text']
+      end
+
+      if attributes.key?(:'source_type')
+        self.source_type = attributes[:'source_type']
+      end
+
+      if attributes.key?(:'source_link')
+        self.source_link = attributes[:'source_link']
+      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 &&
+          pdufa_date_id == o.pdufa_date_id &&
+          source == o.source &&
+          restriction_tier == o.restriction_tier &&
+          decision_date == o.decision_date &&
+          date_start == o.date_start &&
+          date_end == o.date_end &&
+          date_precision == o.date_precision &&
+          date_phrase == o.date_phrase &&
+          event_type == o.event_type &&
+          event_category == o.event_category &&
+          drug_name == o.drug_name &&
+          drug_id == o.drug_id &&
+          molecule_id == o.molecule_id &&
+          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 &&
+          condition_id == o.condition_id &&
+          condition_name == o.condition_name &&
+          indication_text == o.indication_text &&
+          source_type == o.source_type &&
+          source_link == o.source_link
+    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
+      [pdufa_date_id, source, restriction_tier, decision_date, date_start, date_end, date_precision, date_phrase, event_type, event_category, drug_name, drug_id, molecule_id, sponsor_name, sponsor_org_id, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, ticker, condition_id, condition_name, indication_text, source_type, source_link].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

data/lib/pharmaobservatory/models/{biomarkers_relations400_response.rb → query_error.rb}

@@ -14,19 +14,22 @@ require 'date'
 require 'time'
 
 module PharmaObservatory
-  class BiomarkersRelations400Response
-    attr_accessor :error
+  class QueryError
+    attr_accessor :error_code
 
     attr_accessor :message
 
-    attr_accessor :valid_filters
+    attr_accessor :hint
+
+    attr_accessor :docs
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'error' => :'error',
+        :'error_code' => :'error_code',
         :'message' => :'message',
-        :'valid_filters' => :'valid_filters'
+        :'hint' => :'hint',
+        :'docs' => :'docs'
       }
     end
 
@@ -43,15 +46,17 @@ module PharmaObservatory
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'error' => :'String',
+        :'error_code' => :'String',
         :'message' => :'String',
-        :'valid_filters' => :'Array<String>'
+        :'hint' => :'String',
+        :'docs' => :'String'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'hint',
       ])
     end
 
@@ -59,22 +64,22 @@ module PharmaObservatory
     # @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::BiomarkersRelations400Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `PharmaObservatory::QueryError` 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::BiomarkersRelations400Response`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PharmaObservatory::QueryError`. 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?(:'error')
-        self.error = attributes[:'error']
+      if attributes.key?(:'error_code')
+        self.error_code = attributes[:'error_code']
       else
-        self.error = nil
+        self.error_code = nil
       end
 
       if attributes.key?(:'message')
@@ -83,12 +88,12 @@ module PharmaObservatory
         self.message = nil
       end
 
-      if attributes.key?(:'valid_filters')
-        if (value = attributes[:'valid_filters']).is_a?(Array)
-          self.valid_filters = value
-        end
-      else
-        self.valid_filters = nil
+      if attributes.key?(:'hint')
+        self.hint = attributes[:'hint']
+      end
+
+      if attributes.key?(:'docs')
+        self.docs = attributes[:'docs']
       end
     end
 
@@ -97,18 +102,14 @@ module PharmaObservatory
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @error.nil?
-        invalid_properties.push('invalid value for "error", error cannot be nil.')
+      if @error_code.nil?
+        invalid_properties.push('invalid value for "error_code", error_code cannot be nil.')
       end
 
       if @message.nil?
         invalid_properties.push('invalid value for "message", message cannot be nil.')
       end
 
-      if @valid_filters.nil?
-        invalid_properties.push('invalid value for "valid_filters", valid_filters cannot be nil.')
-      end
-
       invalid_properties
     end
 
@@ -116,20 +117,19 @@ module PharmaObservatory
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @error.nil?
+      return false if @error_code.nil?
       return false if @message.nil?
-      return false if @valid_filters.nil?
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] error Value to be assigned
-    def error=(error)
-      if error.nil?
-        fail ArgumentError, 'error cannot be nil'
+    # @param [Object] error_code Value to be assigned
+    def error_code=(error_code)
+      if error_code.nil?
+        fail ArgumentError, 'error_code cannot be nil'
       end
 
-      @error = error
+      @error_code = error_code
     end
 
     # Custom attribute writer method with validation
@@ -142,24 +142,15 @@ module PharmaObservatory
       @message = message
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] valid_filters Value to be assigned
-    def valid_filters=(valid_filters)
-      if valid_filters.nil?
-        fail ArgumentError, 'valid_filters cannot be nil'
-      end
-
-      @valid_filters = valid_filters
-    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 &&
-          error == o.error &&
+          error_code == o.error_code &&
           message == o.message &&
-          valid_filters == o.valid_filters
+          hint == o.hint &&
+          docs == o.docs
     end
 
     # @see the `==` method
@@ -171,7 +162,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [error, message, valid_filters].hash
+      [error_code, message, hint, docs].hash
     end
 
     # Builds the object from hash