pharmaobservatory 0.1.4 → 0.1.6

data/lib/pharmaobservatory/models/trial_research_payments_row.rb

@@ -0,0 +1,366 @@
+=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 trial_research_payments dataset: one row per trial, paying manufacturer and program year. A grouped request returns the group columns and the measures instead, as additional properties.
+  class TrialResearchPaymentsRow
+    # The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number).
+    attr_accessor :trial_id
+
+    # A stable key for the trial, payer and program year row.
+    attr_accessor :payment_key
+
+    # The paying manufacturer's name as reported.
+    attr_accessor :payer_name
+
+    # Legal-entity level: the payer rolled up to its ultimate parent organization record (null when unresolved). Payments from subsidiaries of one parent share one row per trial and program year.
+    attr_accessor :payer_org_id
+
+    # Company level: the company the payer belongs to (null when unresolved).
+    attr_accessor :payer_company_id
+
+    # The payer's company name.
+    attr_accessor :payer_company_name
+
+    # Group level: the current ultimate parent of the payer's company.
+    attr_accessor :payer_group_id
+
+    # The ultimate parent company's name.
+    attr_accessor :payer_group_name
+
+    # The Open Payments program year of the payments.
+    attr_accessor :program_year
+
+    # Payment records behind the row.
+    attr_accessor :research_payments
+
+    # Total reported dollars for the row, counted once.
+    attr_accessor :total_amount_usd
+
+    # Distinct resolved principal investigators named on the payment records.
+    attr_accessor :pi_count
+
+    # True when any payment record in the row was disputed by the recipient.
+    attr_accessor :any_disputed
+
+    # True when any payment record in the row was marked as preclinical research.
+    attr_accessor :any_preclinical
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'trial_id' => :'trial_id',
+        :'payment_key' => :'payment_key',
+        :'payer_name' => :'payer_name',
+        :'payer_org_id' => :'payer_org_id',
+        :'payer_company_id' => :'payer_company_id',
+        :'payer_company_name' => :'payer_company_name',
+        :'payer_group_id' => :'payer_group_id',
+        :'payer_group_name' => :'payer_group_name',
+        :'program_year' => :'program_year',
+        :'research_payments' => :'research_payments',
+        :'total_amount_usd' => :'total_amount_usd',
+        :'pi_count' => :'pi_count',
+        :'any_disputed' => :'any_disputed',
+        :'any_preclinical' => :'any_preclinical'
+      }
+    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
+      {
+        :'trial_id' => :'String',
+        :'payment_key' => :'String',
+        :'payer_name' => :'String',
+        :'payer_org_id' => :'String',
+        :'payer_company_id' => :'String',
+        :'payer_company_name' => :'String',
+        :'payer_group_id' => :'String',
+        :'payer_group_name' => :'String',
+        :'program_year' => :'Integer',
+        :'research_payments' => :'Integer',
+        :'total_amount_usd' => :'Float',
+        :'pi_count' => :'Integer',
+        :'any_disputed' => :'Boolean',
+        :'any_preclinical' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'trial_id',
+        :'payment_key',
+        :'payer_name',
+        :'payer_org_id',
+        :'payer_company_id',
+        :'payer_company_name',
+        :'payer_group_id',
+        :'payer_group_name',
+        :'program_year',
+        :'research_payments',
+        :'total_amount_usd',
+        :'pi_count',
+        :'any_disputed',
+        :'any_preclinical'
+      ])
+    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::TrialResearchPaymentsRow` 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::TrialResearchPaymentsRow`. 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?(:'trial_id')
+        self.trial_id = attributes[:'trial_id']
+      end
+
+      if attributes.key?(:'payment_key')
+        self.payment_key = attributes[:'payment_key']
+      end
+
+      if attributes.key?(:'payer_name')
+        self.payer_name = attributes[:'payer_name']
+      end
+
+      if attributes.key?(:'payer_org_id')
+        self.payer_org_id = attributes[:'payer_org_id']
+      end
+
+      if attributes.key?(:'payer_company_id')
+        self.payer_company_id = attributes[:'payer_company_id']
+      end
+
+      if attributes.key?(:'payer_company_name')
+        self.payer_company_name = attributes[:'payer_company_name']
+      end
+
+      if attributes.key?(:'payer_group_id')
+        self.payer_group_id = attributes[:'payer_group_id']
+      end
+
+      if attributes.key?(:'payer_group_name')
+        self.payer_group_name = attributes[:'payer_group_name']
+      end
+
+      if attributes.key?(:'program_year')
+        self.program_year = attributes[:'program_year']
+      end
+
+      if attributes.key?(:'research_payments')
+        self.research_payments = attributes[:'research_payments']
+      end
+
+      if attributes.key?(:'total_amount_usd')
+        self.total_amount_usd = attributes[:'total_amount_usd']
+      end
+
+      if attributes.key?(:'pi_count')
+        self.pi_count = attributes[:'pi_count']
+      end
+
+      if attributes.key?(:'any_disputed')
+        self.any_disputed = attributes[:'any_disputed']
+      end
+
+      if attributes.key?(:'any_preclinical')
+        self.any_preclinical = attributes[:'any_preclinical']
+      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 &&
+          trial_id == o.trial_id &&
+          payment_key == o.payment_key &&
+          payer_name == o.payer_name &&
+          payer_org_id == o.payer_org_id &&
+          payer_company_id == o.payer_company_id &&
+          payer_company_name == o.payer_company_name &&
+          payer_group_id == o.payer_group_id &&
+          payer_group_name == o.payer_group_name &&
+          program_year == o.program_year &&
+          research_payments == o.research_payments &&
+          total_amount_usd == o.total_amount_usd &&
+          pi_count == o.pi_count &&
+          any_disputed == o.any_disputed &&
+          any_preclinical == o.any_preclinical
+    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
+      [trial_id, payment_key, payer_name, payer_org_id, payer_company_id, payer_company_name, payer_group_id, payer_group_name, program_year, research_payments, total_amount_usd, pi_count, any_disputed, any_preclinical].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