pharmaobservatory 0.1.4 → 0.1.5

data/lib/pharmaobservatory/models/api_v1_whoami_get200_response_quota_buckets_requests_per_minute.rb

@@ -0,0 +1,367 @@
+=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
+  class ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute
+    attr_accessor :unit
+
+    attr_accessor :window
+
+    attr_accessor :limit
+
+    attr_accessor :used
+
+    attr_accessor :remaining
+
+    attr_accessor :resets_at
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'unit' => :'unit',
+        :'window' => :'window',
+        :'limit' => :'limit',
+        :'used' => :'used',
+        :'remaining' => :'remaining',
+        :'resets_at' => :'resets_at'
+      }
+    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
+      {
+        :'unit' => :'String',
+        :'window' => :'String',
+        :'limit' => :'Integer',
+        :'used' => :'Integer',
+        :'remaining' => :'Integer',
+        :'resets_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute` 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::ApiV1WhoamiGet200ResponseQuotaBucketsRequestsPerMinute`. 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?(:'unit')
+        self.unit = attributes[:'unit']
+      else
+        self.unit = nil
+      end
+
+      if attributes.key?(:'window')
+        self.window = attributes[:'window']
+      else
+        self.window = nil
+      end
+
+      if attributes.key?(:'limit')
+        self.limit = attributes[:'limit']
+      else
+        self.limit = nil
+      end
+
+      if attributes.key?(:'used')
+        self.used = attributes[:'used']
+      else
+        self.used = nil
+      end
+
+      if attributes.key?(:'remaining')
+        self.remaining = attributes[:'remaining']
+      else
+        self.remaining = nil
+      end
+
+      if attributes.key?(:'resets_at')
+        self.resets_at = attributes[:'resets_at']
+      else
+        self.resets_at = nil
+      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
+      if @unit.nil?
+        invalid_properties.push('invalid value for "unit", unit cannot be nil.')
+      end
+
+      if @window.nil?
+        invalid_properties.push('invalid value for "window", window cannot be nil.')
+      end
+
+      if @limit.nil?
+        invalid_properties.push('invalid value for "limit", limit cannot be nil.')
+      end
+
+      if @used.nil?
+        invalid_properties.push('invalid value for "used", used cannot be nil.')
+      end
+
+      if @remaining.nil?
+        invalid_properties.push('invalid value for "remaining", remaining cannot be nil.')
+      end
+
+      if @resets_at.nil?
+        invalid_properties.push('invalid value for "resets_at", resets_at cannot be nil.')
+      end
+
+      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'
+      return false if @unit.nil?
+      return false if @window.nil?
+      return false if @limit.nil?
+      return false if @used.nil?
+      return false if @remaining.nil?
+      return false if @resets_at.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit Value to be assigned
+    def unit=(unit)
+      if unit.nil?
+        fail ArgumentError, 'unit cannot be nil'
+      end
+
+      @unit = unit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] window Value to be assigned
+    def window=(window)
+      if window.nil?
+        fail ArgumentError, 'window cannot be nil'
+      end
+
+      @window = window
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] limit Value to be assigned
+    def limit=(limit)
+      if limit.nil?
+        fail ArgumentError, 'limit cannot be nil'
+      end
+
+      @limit = limit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] used Value to be assigned
+    def used=(used)
+      if used.nil?
+        fail ArgumentError, 'used cannot be nil'
+      end
+
+      @used = used
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] remaining Value to be assigned
+    def remaining=(remaining)
+      if remaining.nil?
+        fail ArgumentError, 'remaining cannot be nil'
+      end
+
+      @remaining = remaining
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] resets_at Value to be assigned
+    def resets_at=(resets_at)
+      if resets_at.nil?
+        fail ArgumentError, 'resets_at cannot be nil'
+      end
+
+      @resets_at = resets_at
+    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 &&
+          unit == o.unit &&
+          window == o.window &&
+          limit == o.limit &&
+          used == o.used &&
+          remaining == o.remaining &&
+          resets_at == o.resets_at
+    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
+      [unit, window, limit, used, remaining, resets_at].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/companies_row.rb

@@ -28,7 +28,7 @@ module PharmaObservatory
     # Country of the company's own legal entity, as the source states it.
     attr_accessor :country
 
-    # The organization type of the company's representative record.
+    # The organization type of the company's representative record: Academic, Government, Hospital, Industry, Nonprofit or Other (from the ROR record or the filing), or the lowercase tags investor and manufacturer that mark a minted adviser or manufacturer record.
     attr_accessor :org_type
 
     # The roles the company's organizations play (Manufacturer, Sponsor and so on).

data/lib/pharmaobservatory/models/condition_trials_row.rb

@@ -34,9 +34,12 @@ module PharmaObservatory
     # The registry's study type (INTERVENTIONAL, OBSERVATIONAL or EXPANDED_ACCESS).
     attr_accessor :study_type
 
-    # The trial phase label (Phase 1, Phase 2, Phase 3, Phase 4, Not Applicable and so on).
+    # The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those.
     attr_accessor :phase
 
+    # The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code.
+    attr_accessor :phase_label
+
     # The registry's overall recruitment status (COMPLETED, RECRUITING, TERMINATED and so on).
     attr_accessor :overall_status
 
@@ -76,7 +79,7 @@ module PharmaObservatory
     # Display name of the lead sponsor's group.
     attr_accessor :sponsor_group_name
 
-    # The registry's declared funder class of the lead sponsor (INDUSTRY, NIH for the US National Institutes of Health, OTHER and so on).
+    # The funder class the registry declared for the sponsor (INDUSTRY, NIH, FED, OTHER_GOV, NETWORK, OTHER, INDIV, AMBIG, UNKNOWN). UNKNOWN is the registry's own code for a class it does not state. Null when the trial has no lead sponsor row.
     attr_accessor :sponsor_agency_class
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -89,6 +92,7 @@ module PharmaObservatory
         :'trial_title' => :'trial_title',
         :'study_type' => :'study_type',
         :'phase' => :'phase',
+        :'phase_label' => :'phase_label',
         :'overall_status' => :'overall_status',
         :'start_date' => :'start_date',
         :'start_year' => :'start_year',
@@ -126,6 +130,7 @@ module PharmaObservatory
         :'trial_title' => :'String',
         :'study_type' => :'String',
         :'phase' => :'String',
+        :'phase_label' => :'String',
         :'overall_status' => :'String',
         :'start_date' => :'Date',
         :'start_year' => :'Integer',
@@ -153,6 +158,7 @@ module PharmaObservatory
         :'trial_title',
         :'study_type',
         :'phase',
+        :'phase_label',
         :'overall_status',
         :'start_date',
         :'start_year',
@@ -214,6 +220,10 @@ module PharmaObservatory
         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
@@ -298,6 +308,7 @@ module PharmaObservatory
           trial_title == o.trial_title &&
           study_type == o.study_type &&
           phase == o.phase &&
+          phase_label == o.phase_label &&
           overall_status == o.overall_status &&
           start_date == o.start_date &&
           start_year == o.start_year &&
@@ -323,7 +334,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [condition_id, condition_name, trial_id, is_direct, trial_title, study_type, phase, overall_status, start_date, start_year, primary_completion_date, last_update_posted_date, enrollment, were_results_reported, sponsor_name, sponsor_org_id, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, sponsor_agency_class].hash
+      [condition_id, condition_name, trial_id, is_direct, trial_title, study_type, phase, phase_label, overall_status, start_date, start_year, primary_completion_date, last_update_posted_date, enrollment, were_results_reported, sponsor_name, sponsor_org_id, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, sponsor_agency_class].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/legal_entities_row.rb

@@ -31,7 +31,7 @@ module PharmaObservatory
     # Country as the source states it.
     attr_accessor :country
 
-    # Organization type.
+    # Organization type: Academic, Government, Hospital, Industry, Nonprofit or Other (from the ROR record or the filing), or the lowercase tags investor and manufacturer that mark a minted adviser or manufacturer record.
     attr_accessor :org_type
 
     # Central index key (CIK) in EDGAR, the US Securities and Exchange Commission (SEC) filing system, when it files.

data/lib/pharmaobservatory/models/site_trials_row.rb

@@ -28,9 +28,12 @@ module PharmaObservatory
     # INTERVENTIONAL or OBSERVATIONAL.
     attr_accessor :study_type
 
-    # The trial phase label.
+    # The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those.
     attr_accessor :phase
 
+    # The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code.
+    attr_accessor :phase_label
+
     # The registry's overall status.
     attr_accessor :overall_status
 
@@ -69,6 +72,7 @@ module PharmaObservatory
         :'trial_title' => :'trial_title',
         :'study_type' => :'study_type',
         :'phase' => :'phase',
+        :'phase_label' => :'phase_label',
         :'overall_status' => :'overall_status',
         :'start_date' => :'start_date',
         :'start_year' => :'start_year',
@@ -100,6 +104,7 @@ module PharmaObservatory
         :'trial_title' => :'String',
         :'study_type' => :'String',
         :'phase' => :'String',
+        :'phase_label' => :'String',
         :'overall_status' => :'String',
         :'start_date' => :'Date',
         :'start_year' => :'Integer',
@@ -121,6 +126,7 @@ module PharmaObservatory
         :'trial_title',
         :'study_type',
         :'phase',
+        :'phase_label',
         :'overall_status',
         :'start_date',
         :'start_year',
@@ -170,6 +176,10 @@ module PharmaObservatory
         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
@@ -236,6 +246,7 @@ module PharmaObservatory
           trial_title == o.trial_title &&
           study_type == o.study_type &&
           phase == o.phase &&
+          phase_label == o.phase_label &&
           overall_status == o.overall_status &&
           start_date == o.start_date &&
           start_year == o.start_year &&
@@ -257,7 +268,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [site_id, trial_id, trial_title, study_type, phase, overall_status, start_date, start_year, enrollment, lead_sponsor_name, lead_sponsor_org_id, lead_sponsor_company_id, lead_sponsor_company_name, lead_sponsor_group_id, lead_sponsor_group_name].hash
+      [site_id, trial_id, trial_title, study_type, phase, phase_label, overall_status, start_date, start_year, enrollment, lead_sponsor_name, lead_sponsor_org_id, lead_sponsor_company_id, lead_sponsor_company_name, lead_sponsor_group_id, lead_sponsor_group_name].hash
     end
 
     # Builds the object from hash

data/lib/pharmaobservatory/models/sponsor_trials_row.rb

@@ -40,7 +40,7 @@ module PharmaObservatory
     # Display name of the sponsor's group.
     attr_accessor :sponsor_group_name
 
-    # The registry's agency class for the sponsor (INDUSTRY, NIH for the US National Institutes of Health, OTHER ...).
+    # The funder class the registry declared for the sponsor (INDUSTRY, NIH, FED, OTHER_GOV, NETWORK, OTHER, INDIV, AMBIG, UNKNOWN). UNKNOWN is the registry's own code for a class it does not state.
     attr_accessor :sponsor_agency_class
 
     # How the sponsor name was resolved to an organization record.
@@ -52,9 +52,12 @@ module PharmaObservatory
     # INTERVENTIONAL or OBSERVATIONAL.
     attr_accessor :study_type
 
-    # The trial phase label.
+    # The registry's phase code (PHASE1, PHASE2, PHASE2/PHASE3, NA and so on). Null when the registry gives no phase (observational and expanded-access trials); phase_label carries the display label for those.
     attr_accessor :phase
 
+    # The trial phase as a display label (Phase 2, Phase 3, Observational, Not applicable, Expanded access, Unknown). The same trial's phase column holds the registry code.
+    attr_accessor :phase_label
+
     # The registry's overall status.
     attr_accessor :overall_status
 
@@ -95,6 +98,7 @@ module PharmaObservatory
         :'trial_title' => :'trial_title',
         :'study_type' => :'study_type',
         :'phase' => :'phase',
+        :'phase_label' => :'phase_label',
         :'overall_status' => :'overall_status',
         :'start_date' => :'start_date',
         :'start_year' => :'start_year',
@@ -132,6 +136,7 @@ module PharmaObservatory
         :'trial_title' => :'String',
         :'study_type' => :'String',
         :'phase' => :'String',
+        :'phase_label' => :'String',
         :'overall_status' => :'String',
         :'start_date' => :'Date',
         :'start_year' => :'Integer',
@@ -159,6 +164,7 @@ module PharmaObservatory
         :'trial_title',
         :'study_type',
         :'phase',
+        :'phase_label',
         :'overall_status',
         :'start_date',
         :'start_year',
@@ -238,6 +244,10 @@ module PharmaObservatory
         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
@@ -308,6 +318,7 @@ module PharmaObservatory
           trial_title == o.trial_title &&
           study_type == o.study_type &&
           phase == o.phase &&
+          phase_label == o.phase_label &&
           overall_status == o.overall_status &&
           start_date == o.start_date &&
           start_year == o.start_year &&
@@ -327,7 +338,7 @@ module PharmaObservatory
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [trial_id, sponsor_role, sponsor_name, sponsor_org_id, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, sponsor_agency_class, sponsor_resolution_method, trial_title, study_type, phase, overall_status, start_date, start_year, primary_completion_date, enrollment, were_results_reported, conditions, interventions].hash
+      [trial_id, sponsor_role, sponsor_name, sponsor_org_id, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, sponsor_agency_class, sponsor_resolution_method, trial_title, study_type, phase, phase_label, overall_status, start_date, start_year, primary_completion_date, enrollment, were_results_reported, conditions, interventions].hash
     end
 
     # Builds the object from hash