pharmaobservatory 0.1.7 → 0.1.8

data/lib/pharmaobservatory/models/sponsor_delivery_row.rb

@@ -0,0 +1,410 @@
+=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 sponsor_delivery dataset: one row per lead sponsor organization as filed. A grouped request returns the group columns and the measures instead, as additional properties.
+  class SponsorDeliveryRow
+    # Legal-entity level: the lead sponsor organization record.
+    attr_accessor :sponsor_org_id
+
+    # Display name of the sponsor organization record.
+    attr_accessor :sponsor_name
+
+    # 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
+
+    # Lead-sponsored trials of the organization.
+    attr_accessor :n_trials_total
+
+    # Trials whose planned dates come from the earliest estimate in the registry's own history.
+    attr_accessor :n_trials_with_observed_plan
+
+    # Trials with a measured difference between planned and actual enrollment; the base of the enrollment rate.
+    attr_accessor :n_trials_with_enrollment_delta
+
+    # Trials with a measured difference between planned and actual primary completion; the base of the on-time rate.
+    attr_accessor :n_trials_with_completion_delta
+
+    # Trials with an enrollment delta that reached their planned enrollment.
+    attr_accessor :n_enrollment_met
+
+    # Trials with an enrollment delta that did not reach their planned enrollment.
+    attr_accessor :n_enrollment_missed
+
+    # n_enrollment_met divided by n_trials_with_enrollment_delta; null when that base is zero.
+    attr_accessor :enrollment_hit_rate
+
+    # Median of actual enrollment as a percentage of planned, over trials with an enrollment delta.
+    attr_accessor :median_enrollment_attainment_pct
+
+    # Trials with a completion delta that were not delayed past their planned primary completion.
+    attr_accessor :n_ontime
+
+    # Trials with a completion delta that completed or are projected after their planned primary completion.
+    attr_accessor :n_slipped
+
+    # n_ontime divided by n_trials_with_completion_delta; null when that base is zero.
+    attr_accessor :on_time_rate
+
+    # Median days between planned and actual primary completion, over trials with a completion delta.
+    attr_accessor :median_completion_slip_days
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sponsor_org_id' => :'sponsor_org_id',
+        :'sponsor_name' => :'sponsor_name',
+        :'sponsor_company_id' => :'sponsor_company_id',
+        :'sponsor_company_name' => :'sponsor_company_name',
+        :'sponsor_group_id' => :'sponsor_group_id',
+        :'sponsor_group_name' => :'sponsor_group_name',
+        :'n_trials_total' => :'n_trials_total',
+        :'n_trials_with_observed_plan' => :'n_trials_with_observed_plan',
+        :'n_trials_with_enrollment_delta' => :'n_trials_with_enrollment_delta',
+        :'n_trials_with_completion_delta' => :'n_trials_with_completion_delta',
+        :'n_enrollment_met' => :'n_enrollment_met',
+        :'n_enrollment_missed' => :'n_enrollment_missed',
+        :'enrollment_hit_rate' => :'enrollment_hit_rate',
+        :'median_enrollment_attainment_pct' => :'median_enrollment_attainment_pct',
+        :'n_ontime' => :'n_ontime',
+        :'n_slipped' => :'n_slipped',
+        :'on_time_rate' => :'on_time_rate',
+        :'median_completion_slip_days' => :'median_completion_slip_days'
+      }
+    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
+      {
+        :'sponsor_org_id' => :'String',
+        :'sponsor_name' => :'String',
+        :'sponsor_company_id' => :'String',
+        :'sponsor_company_name' => :'String',
+        :'sponsor_group_id' => :'String',
+        :'sponsor_group_name' => :'String',
+        :'n_trials_total' => :'Integer',
+        :'n_trials_with_observed_plan' => :'Integer',
+        :'n_trials_with_enrollment_delta' => :'Integer',
+        :'n_trials_with_completion_delta' => :'Integer',
+        :'n_enrollment_met' => :'Integer',
+        :'n_enrollment_missed' => :'Integer',
+        :'enrollment_hit_rate' => :'Float',
+        :'median_enrollment_attainment_pct' => :'Float',
+        :'n_ontime' => :'Integer',
+        :'n_slipped' => :'Integer',
+        :'on_time_rate' => :'Float',
+        :'median_completion_slip_days' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sponsor_org_id',
+        :'sponsor_name',
+        :'sponsor_company_id',
+        :'sponsor_company_name',
+        :'sponsor_group_id',
+        :'sponsor_group_name',
+        :'n_trials_total',
+        :'n_trials_with_observed_plan',
+        :'n_trials_with_enrollment_delta',
+        :'n_trials_with_completion_delta',
+        :'n_enrollment_met',
+        :'n_enrollment_missed',
+        :'enrollment_hit_rate',
+        :'median_enrollment_attainment_pct',
+        :'n_ontime',
+        :'n_slipped',
+        :'on_time_rate',
+        :'median_completion_slip_days'
+      ])
+    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::SponsorDeliveryRow` 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::SponsorDeliveryRow`. 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?(:'sponsor_org_id')
+        self.sponsor_org_id = attributes[:'sponsor_org_id']
+      end
+
+      if attributes.key?(:'sponsor_name')
+        self.sponsor_name = attributes[:'sponsor_name']
+      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?(:'n_trials_total')
+        self.n_trials_total = attributes[:'n_trials_total']
+      end
+
+      if attributes.key?(:'n_trials_with_observed_plan')
+        self.n_trials_with_observed_plan = attributes[:'n_trials_with_observed_plan']
+      end
+
+      if attributes.key?(:'n_trials_with_enrollment_delta')
+        self.n_trials_with_enrollment_delta = attributes[:'n_trials_with_enrollment_delta']
+      end
+
+      if attributes.key?(:'n_trials_with_completion_delta')
+        self.n_trials_with_completion_delta = attributes[:'n_trials_with_completion_delta']
+      end
+
+      if attributes.key?(:'n_enrollment_met')
+        self.n_enrollment_met = attributes[:'n_enrollment_met']
+      end
+
+      if attributes.key?(:'n_enrollment_missed')
+        self.n_enrollment_missed = attributes[:'n_enrollment_missed']
+      end
+
+      if attributes.key?(:'enrollment_hit_rate')
+        self.enrollment_hit_rate = attributes[:'enrollment_hit_rate']
+      end
+
+      if attributes.key?(:'median_enrollment_attainment_pct')
+        self.median_enrollment_attainment_pct = attributes[:'median_enrollment_attainment_pct']
+      end
+
+      if attributes.key?(:'n_ontime')
+        self.n_ontime = attributes[:'n_ontime']
+      end
+
+      if attributes.key?(:'n_slipped')
+        self.n_slipped = attributes[:'n_slipped']
+      end
+
+      if attributes.key?(:'on_time_rate')
+        self.on_time_rate = attributes[:'on_time_rate']
+      end
+
+      if attributes.key?(:'median_completion_slip_days')
+        self.median_completion_slip_days = attributes[:'median_completion_slip_days']
+      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 &&
+          sponsor_org_id == o.sponsor_org_id &&
+          sponsor_name == o.sponsor_name &&
+          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 &&
+          n_trials_total == o.n_trials_total &&
+          n_trials_with_observed_plan == o.n_trials_with_observed_plan &&
+          n_trials_with_enrollment_delta == o.n_trials_with_enrollment_delta &&
+          n_trials_with_completion_delta == o.n_trials_with_completion_delta &&
+          n_enrollment_met == o.n_enrollment_met &&
+          n_enrollment_missed == o.n_enrollment_missed &&
+          enrollment_hit_rate == o.enrollment_hit_rate &&
+          median_enrollment_attainment_pct == o.median_enrollment_attainment_pct &&
+          n_ontime == o.n_ontime &&
+          n_slipped == o.n_slipped &&
+          on_time_rate == o.on_time_rate &&
+          median_completion_slip_days == o.median_completion_slip_days
+    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
+      [sponsor_org_id, sponsor_name, sponsor_company_id, sponsor_company_name, sponsor_group_id, sponsor_group_name, n_trials_total, n_trials_with_observed_plan, n_trials_with_enrollment_delta, n_trials_with_completion_delta, n_enrollment_met, n_enrollment_missed, enrollment_hit_rate, median_enrollment_attainment_pct, n_ontime, n_slipped, on_time_rate, median_completion_slip_days].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