pharmaobservatory 0.1.4 → 0.1.6

data/lib/pharmaobservatory/models/supplier_capability_esg_row.rb

@@ -0,0 +1,480 @@
+=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 supplier_capability_esg dataset: one row per trial, contract research organization and attribution method. A grouped request returns the group columns and the measures instead, as additional properties.
+  class SupplierCapabilityEsgRow
+    # The trial's ClinicalTrials.gov registry id (NCT, National Clinical Trial, number).
+    attr_accessor :trial_id
+
+    # Legal-entity level: the contract research organization's organization record.
+    attr_accessor :vendor_org_id
+
+    # The organization's name as filed.
+    attr_accessor :vendor_name
+
+    # Company level: the contract research organization's company (null when unresolved).
+    attr_accessor :vendor_company_id
+
+    # Display name of the contract research organization's company.
+    attr_accessor :vendor_company_name
+
+    # Group level: the contract research organization's current ultimate parent; a root's group is itself.
+    attr_accessor :vendor_group_id
+
+    # Display name of the contract research organization's group.
+    attr_accessor :vendor_group_name
+
+    # How the vendor was inferred for the trial: sponsor_match or collaborator_match (the organization is named on the registry record and is on the curated list) or llm_extraction.
+    attr_accessor :cro_attribution_method
+
+    # Confidence of the inference, 0 to 1.
+    attr_accessor :cro_confidence
+
+    # The registry's phase code of the trial (PHASE1, PHASE2, PHASE3 and so on). Null when the registry gives none.
+    attr_accessor :phase
+
+    # Start year of the trial.
+    attr_accessor :start_year
+
+    # The trial's lead sponsor as filed.
+    attr_accessor :lead_sponsor_name
+
+    # Countries of the trial's facilities. Filter on one country (for example facility_countries=United States) to match trials that list it.
+    attr_accessor :facility_countries
+
+    # The MeSH (Medical Subject Headings) condition ids of the trial, direct and ancestor (D followed by six to nine digits). Filter on one id (for example condition_ids=D003316) to scope the rows to a condition.
+    attr_accessor :condition_ids
+
+    # True when the trial has both a planned and an actual enrollment, so its attainment is graded.
+    attr_accessor :enrollment_delta_known
+
+    # True when actual enrollment reached the plan. Null when not graded.
+    attr_accessor :enrollment_met
+
+    # Actual enrollment as a percentage of planned. Null when not graded.
+    attr_accessor :enrollment_attainment_pct
+
+    # The vendor's climate target state in the open lane (extracted from its SEC filings): disclosed when a net-zero or near-term target is claimed, true_negative when only a no is filed, not_disclosed otherwise, including a vendor the lane does not cover. The same value on every row of the vendor.
+    attr_accessor :climate_target_state
+
+    # The vendor's diversity target state in the open lane, over the has_dei_targets claim, by the same rule.
+    attr_accessor :diversity_target_state
+
+    # The vendor's extracted claims (any type) that carry a value.
+    attr_accessor :esg_claim_count
+
+    # The latest disclosure date among the vendor's extracted claims.
+    attr_accessor :esg_latest_disclosure_date
+
+    # The vendor's climate target state in the Science Based Targets initiative lane, by the same rule. Null for a caller without the licence for this column; see withheld_columns.
+    attr_accessor :sbti_climate_target_state
+
+    # The vendor's SBTi claims that carry a value. Null for a caller without the licence for this column; see withheld_columns.
+    attr_accessor :sbti_claim_count
+
+    # The latest disclosure date among the vendor's SBTi claims. Null for a caller without the licence for this column; see withheld_columns.
+    attr_accessor :sbti_latest_disclosure_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'trial_id' => :'trial_id',
+        :'vendor_org_id' => :'vendor_org_id',
+        :'vendor_name' => :'vendor_name',
+        :'vendor_company_id' => :'vendor_company_id',
+        :'vendor_company_name' => :'vendor_company_name',
+        :'vendor_group_id' => :'vendor_group_id',
+        :'vendor_group_name' => :'vendor_group_name',
+        :'cro_attribution_method' => :'cro_attribution_method',
+        :'cro_confidence' => :'cro_confidence',
+        :'phase' => :'phase',
+        :'start_year' => :'start_year',
+        :'lead_sponsor_name' => :'lead_sponsor_name',
+        :'facility_countries' => :'facility_countries',
+        :'condition_ids' => :'condition_ids',
+        :'enrollment_delta_known' => :'enrollment_delta_known',
+        :'enrollment_met' => :'enrollment_met',
+        :'enrollment_attainment_pct' => :'enrollment_attainment_pct',
+        :'climate_target_state' => :'climate_target_state',
+        :'diversity_target_state' => :'diversity_target_state',
+        :'esg_claim_count' => :'esg_claim_count',
+        :'esg_latest_disclosure_date' => :'esg_latest_disclosure_date',
+        :'sbti_climate_target_state' => :'sbti_climate_target_state',
+        :'sbti_claim_count' => :'sbti_claim_count',
+        :'sbti_latest_disclosure_date' => :'sbti_latest_disclosure_date'
+      }
+    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',
+        :'vendor_org_id' => :'String',
+        :'vendor_name' => :'String',
+        :'vendor_company_id' => :'String',
+        :'vendor_company_name' => :'String',
+        :'vendor_group_id' => :'String',
+        :'vendor_group_name' => :'String',
+        :'cro_attribution_method' => :'String',
+        :'cro_confidence' => :'Float',
+        :'phase' => :'String',
+        :'start_year' => :'Integer',
+        :'lead_sponsor_name' => :'String',
+        :'facility_countries' => :'Array<String>',
+        :'condition_ids' => :'Array<String>',
+        :'enrollment_delta_known' => :'Boolean',
+        :'enrollment_met' => :'Boolean',
+        :'enrollment_attainment_pct' => :'Float',
+        :'climate_target_state' => :'String',
+        :'diversity_target_state' => :'String',
+        :'esg_claim_count' => :'Integer',
+        :'esg_latest_disclosure_date' => :'Date',
+        :'sbti_climate_target_state' => :'String',
+        :'sbti_claim_count' => :'Integer',
+        :'sbti_latest_disclosure_date' => :'Date'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'trial_id',
+        :'vendor_org_id',
+        :'vendor_name',
+        :'vendor_company_id',
+        :'vendor_company_name',
+        :'vendor_group_id',
+        :'vendor_group_name',
+        :'cro_attribution_method',
+        :'cro_confidence',
+        :'phase',
+        :'start_year',
+        :'lead_sponsor_name',
+        :'facility_countries',
+        :'condition_ids',
+        :'enrollment_delta_known',
+        :'enrollment_met',
+        :'enrollment_attainment_pct',
+        :'climate_target_state',
+        :'diversity_target_state',
+        :'esg_claim_count',
+        :'esg_latest_disclosure_date',
+        :'sbti_climate_target_state',
+        :'sbti_claim_count',
+        :'sbti_latest_disclosure_date'
+      ])
+    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::SupplierCapabilityEsgRow` 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::SupplierCapabilityEsgRow`. 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?(:'vendor_org_id')
+        self.vendor_org_id = attributes[:'vendor_org_id']
+      end
+
+      if attributes.key?(:'vendor_name')
+        self.vendor_name = attributes[:'vendor_name']
+      end
+
+      if attributes.key?(:'vendor_company_id')
+        self.vendor_company_id = attributes[:'vendor_company_id']
+      end
+
+      if attributes.key?(:'vendor_company_name')
+        self.vendor_company_name = attributes[:'vendor_company_name']
+      end
+
+      if attributes.key?(:'vendor_group_id')
+        self.vendor_group_id = attributes[:'vendor_group_id']
+      end
+
+      if attributes.key?(:'vendor_group_name')
+        self.vendor_group_name = attributes[:'vendor_group_name']
+      end
+
+      if attributes.key?(:'cro_attribution_method')
+        self.cro_attribution_method = attributes[:'cro_attribution_method']
+      end
+
+      if attributes.key?(:'cro_confidence')
+        self.cro_confidence = attributes[:'cro_confidence']
+      end
+
+      if attributes.key?(:'phase')
+        self.phase = attributes[:'phase']
+      end
+
+      if attributes.key?(:'start_year')
+        self.start_year = attributes[:'start_year']
+      end
+
+      if attributes.key?(:'lead_sponsor_name')
+        self.lead_sponsor_name = attributes[:'lead_sponsor_name']
+      end
+
+      if attributes.key?(:'facility_countries')
+        if (value = attributes[:'facility_countries']).is_a?(Array)
+          self.facility_countries = value
+        end
+      end
+
+      if attributes.key?(:'condition_ids')
+        if (value = attributes[:'condition_ids']).is_a?(Array)
+          self.condition_ids = value
+        end
+      end
+
+      if attributes.key?(:'enrollment_delta_known')
+        self.enrollment_delta_known = attributes[:'enrollment_delta_known']
+      end
+
+      if attributes.key?(:'enrollment_met')
+        self.enrollment_met = attributes[:'enrollment_met']
+      end
+
+      if attributes.key?(:'enrollment_attainment_pct')
+        self.enrollment_attainment_pct = attributes[:'enrollment_attainment_pct']
+      end
+
+      if attributes.key?(:'climate_target_state')
+        self.climate_target_state = attributes[:'climate_target_state']
+      end
+
+      if attributes.key?(:'diversity_target_state')
+        self.diversity_target_state = attributes[:'diversity_target_state']
+      end
+
+      if attributes.key?(:'esg_claim_count')
+        self.esg_claim_count = attributes[:'esg_claim_count']
+      end
+
+      if attributes.key?(:'esg_latest_disclosure_date')
+        self.esg_latest_disclosure_date = attributes[:'esg_latest_disclosure_date']
+      end
+
+      if attributes.key?(:'sbti_climate_target_state')
+        self.sbti_climate_target_state = attributes[:'sbti_climate_target_state']
+      end
+
+      if attributes.key?(:'sbti_claim_count')
+        self.sbti_claim_count = attributes[:'sbti_claim_count']
+      end
+
+      if attributes.key?(:'sbti_latest_disclosure_date')
+        self.sbti_latest_disclosure_date = attributes[:'sbti_latest_disclosure_date']
+      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 &&
+          vendor_org_id == o.vendor_org_id &&
+          vendor_name == o.vendor_name &&
+          vendor_company_id == o.vendor_company_id &&
+          vendor_company_name == o.vendor_company_name &&
+          vendor_group_id == o.vendor_group_id &&
+          vendor_group_name == o.vendor_group_name &&
+          cro_attribution_method == o.cro_attribution_method &&
+          cro_confidence == o.cro_confidence &&
+          phase == o.phase &&
+          start_year == o.start_year &&
+          lead_sponsor_name == o.lead_sponsor_name &&
+          facility_countries == o.facility_countries &&
+          condition_ids == o.condition_ids &&
+          enrollment_delta_known == o.enrollment_delta_known &&
+          enrollment_met == o.enrollment_met &&
+          enrollment_attainment_pct == o.enrollment_attainment_pct &&
+          climate_target_state == o.climate_target_state &&
+          diversity_target_state == o.diversity_target_state &&
+          esg_claim_count == o.esg_claim_count &&
+          esg_latest_disclosure_date == o.esg_latest_disclosure_date &&
+          sbti_climate_target_state == o.sbti_climate_target_state &&
+          sbti_claim_count == o.sbti_claim_count &&
+          sbti_latest_disclosure_date == o.sbti_latest_disclosure_date
+    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, vendor_org_id, vendor_name, vendor_company_id, vendor_company_name, vendor_group_id, vendor_group_name, cro_attribution_method, cro_confidence, phase, start_year, lead_sponsor_name, facility_countries, condition_ids, enrollment_delta_known, enrollment_met, enrollment_attainment_pct, climate_target_state, diversity_target_state, esg_claim_count, esg_latest_disclosure_date, sbti_climate_target_state, sbti_claim_count, sbti_latest_disclosure_date].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