pharmaobservatory 0.1.8 → 0.1.9

data/lib/pharmaobservatory/models/company_timeline_row.rb

@@ -0,0 +1,498 @@
+=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 company_timeline dataset: one row per company, source lane, source record and event type. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyTimelineRow
+    # md5 of the lane, event type, source record and company: a stable surrogate id for the row.
+    attr_accessor :timeline_event_id
+
+    # Company level: the company the row is about; the entry key for the companies object type.
+    attr_accessor :company_id
+
+    # Display name of the company.
+    attr_accessor :company_name
+
+    # Group level: the company's current ultimate parent; a root's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the group.
+    attr_accessor :group_name
+
+    # Legal-entity level: the organization record the lane reported the event on (the lowest id when several records of the company report it).
+    attr_accessor :reporting_org_id
+
+    # The lane that supplied the event.
+    attr_accessor :source_key
+
+    # The lane's own key for the thing that happened (trial id, funding event id, patent id, enforcement event id, statement id).
+    attr_accessor :source_entity_key
+
+    # The fine event vocabulary; funding types are the funding round types verbatim.
+    attr_accessor :event_type
+
+    # The family of the event type, assigned by name from the lane registry: clinical, capital, intellectual_property, regulatory, compliance or other.
+    attr_accessor :event_family
+
+    # The first day consistent with the evidence, never the raw value when the evidence is coarser than a day.
+    attr_accessor :event_date
+
+    # How precise the evidence is: day, month, quarter, half or year.
+    attr_accessor :date_precision
+
+    # The last day consistent with the evidence; equals event_date at day precision.
+    attr_accessor :precision_window_end
+
+    # Where the precision claim comes from. Provenance for an audit, not a vocabulary to branch on.
+    attr_accessor :date_precision_basis
+
+    # True when the company did something across an interval (a trial). Independent of date_precision.
+    attr_accessor :is_period
+
+    # The end of a real period; null for a non-period row and for an open-ended period.
+    attr_accessor :span_end_date
+
+    # True when the end (or the event itself, for a decision still ahead) is planned rather than realized.
+    attr_accessor :span_end_is_projected
+
+    # Presentation label for the event, not a stable contract.
+    attr_accessor :display_label
+
+    # Presentation detail, including any amount as formatted text.
+    attr_accessor :detail_text
+
+    # What link_ref points at: trial, funding_event, patent, external or none.
+    attr_accessor :link_kind
+
+    # The natural id of the linked thing, or an absolute URL when link_kind is external; null exactly when link_kind is none.
+    attr_accessor :link_ref
+
+    # The tier vocabulary is none or licensable. Every row here is none: every lane is an open source, and a data test fails if a restricted lane is ever admitted.
+    attr_accessor :restriction_tier
+
+    # The licence of the lane's source.
+    attr_accessor :source_license
+
+    # Whether the lane's licence permits commercial use.
+    attr_accessor :commercial_use_allowed
+
+    # The credit line the lane's source requires; show it wherever the event is shown. Null when none is owed.
+    attr_accessor :attribution
+
+    # The lane's display name.
+    attr_accessor :source_label
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'timeline_event_id' => :'timeline_event_id',
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'reporting_org_id' => :'reporting_org_id',
+        :'source_key' => :'source_key',
+        :'source_entity_key' => :'source_entity_key',
+        :'event_type' => :'event_type',
+        :'event_family' => :'event_family',
+        :'event_date' => :'event_date',
+        :'date_precision' => :'date_precision',
+        :'precision_window_end' => :'precision_window_end',
+        :'date_precision_basis' => :'date_precision_basis',
+        :'is_period' => :'is_period',
+        :'span_end_date' => :'span_end_date',
+        :'span_end_is_projected' => :'span_end_is_projected',
+        :'display_label' => :'display_label',
+        :'detail_text' => :'detail_text',
+        :'link_kind' => :'link_kind',
+        :'link_ref' => :'link_ref',
+        :'restriction_tier' => :'restriction_tier',
+        :'source_license' => :'source_license',
+        :'commercial_use_allowed' => :'commercial_use_allowed',
+        :'attribution' => :'attribution',
+        :'source_label' => :'source_label'
+      }
+    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
+      {
+        :'timeline_event_id' => :'String',
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'reporting_org_id' => :'String',
+        :'source_key' => :'String',
+        :'source_entity_key' => :'String',
+        :'event_type' => :'String',
+        :'event_family' => :'String',
+        :'event_date' => :'Date',
+        :'date_precision' => :'String',
+        :'precision_window_end' => :'Date',
+        :'date_precision_basis' => :'String',
+        :'is_period' => :'Boolean',
+        :'span_end_date' => :'Date',
+        :'span_end_is_projected' => :'Boolean',
+        :'display_label' => :'String',
+        :'detail_text' => :'String',
+        :'link_kind' => :'String',
+        :'link_ref' => :'String',
+        :'restriction_tier' => :'String',
+        :'source_license' => :'String',
+        :'commercial_use_allowed' => :'Boolean',
+        :'attribution' => :'String',
+        :'source_label' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'timeline_event_id',
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'reporting_org_id',
+        :'source_key',
+        :'source_entity_key',
+        :'event_type',
+        :'event_family',
+        :'event_date',
+        :'date_precision',
+        :'precision_window_end',
+        :'date_precision_basis',
+        :'is_period',
+        :'span_end_date',
+        :'span_end_is_projected',
+        :'display_label',
+        :'detail_text',
+        :'link_kind',
+        :'link_ref',
+        :'restriction_tier',
+        :'source_license',
+        :'commercial_use_allowed',
+        :'attribution',
+        :'source_label'
+      ])
+    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::CompanyTimelineRow` 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::CompanyTimelineRow`. 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?(:'timeline_event_id')
+        self.timeline_event_id = attributes[:'timeline_event_id']
+      end
+
+      if attributes.key?(:'company_id')
+        self.company_id = attributes[:'company_id']
+      end
+
+      if attributes.key?(:'company_name')
+        self.company_name = attributes[:'company_name']
+      end
+
+      if attributes.key?(:'group_id')
+        self.group_id = attributes[:'group_id']
+      end
+
+      if attributes.key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.key?(:'reporting_org_id')
+        self.reporting_org_id = attributes[:'reporting_org_id']
+      end
+
+      if attributes.key?(:'source_key')
+        self.source_key = attributes[:'source_key']
+      end
+
+      if attributes.key?(:'source_entity_key')
+        self.source_entity_key = attributes[:'source_entity_key']
+      end
+
+      if attributes.key?(:'event_type')
+        self.event_type = attributes[:'event_type']
+      end
+
+      if attributes.key?(:'event_family')
+        self.event_family = attributes[:'event_family']
+      end
+
+      if attributes.key?(:'event_date')
+        self.event_date = attributes[:'event_date']
+      end
+
+      if attributes.key?(:'date_precision')
+        self.date_precision = attributes[:'date_precision']
+      end
+
+      if attributes.key?(:'precision_window_end')
+        self.precision_window_end = attributes[:'precision_window_end']
+      end
+
+      if attributes.key?(:'date_precision_basis')
+        self.date_precision_basis = attributes[:'date_precision_basis']
+      end
+
+      if attributes.key?(:'is_period')
+        self.is_period = attributes[:'is_period']
+      end
+
+      if attributes.key?(:'span_end_date')
+        self.span_end_date = attributes[:'span_end_date']
+      end
+
+      if attributes.key?(:'span_end_is_projected')
+        self.span_end_is_projected = attributes[:'span_end_is_projected']
+      end
+
+      if attributes.key?(:'display_label')
+        self.display_label = attributes[:'display_label']
+      end
+
+      if attributes.key?(:'detail_text')
+        self.detail_text = attributes[:'detail_text']
+      end
+
+      if attributes.key?(:'link_kind')
+        self.link_kind = attributes[:'link_kind']
+      end
+
+      if attributes.key?(:'link_ref')
+        self.link_ref = attributes[:'link_ref']
+      end
+
+      if attributes.key?(:'restriction_tier')
+        self.restriction_tier = attributes[:'restriction_tier']
+      end
+
+      if attributes.key?(:'source_license')
+        self.source_license = attributes[:'source_license']
+      end
+
+      if attributes.key?(:'commercial_use_allowed')
+        self.commercial_use_allowed = attributes[:'commercial_use_allowed']
+      end
+
+      if attributes.key?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      end
+
+      if attributes.key?(:'source_label')
+        self.source_label = attributes[:'source_label']
+      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 &&
+          timeline_event_id == o.timeline_event_id &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          reporting_org_id == o.reporting_org_id &&
+          source_key == o.source_key &&
+          source_entity_key == o.source_entity_key &&
+          event_type == o.event_type &&
+          event_family == o.event_family &&
+          event_date == o.event_date &&
+          date_precision == o.date_precision &&
+          precision_window_end == o.precision_window_end &&
+          date_precision_basis == o.date_precision_basis &&
+          is_period == o.is_period &&
+          span_end_date == o.span_end_date &&
+          span_end_is_projected == o.span_end_is_projected &&
+          display_label == o.display_label &&
+          detail_text == o.detail_text &&
+          link_kind == o.link_kind &&
+          link_ref == o.link_ref &&
+          restriction_tier == o.restriction_tier &&
+          source_license == o.source_license &&
+          commercial_use_allowed == o.commercial_use_allowed &&
+          attribution == o.attribution &&
+          source_label == o.source_label
+    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
+      [timeline_event_id, company_id, company_name, group_id, group_name, reporting_org_id, source_key, source_entity_key, event_type, event_family, event_date, date_precision, precision_window_end, date_precision_basis, is_period, span_end_date, span_end_is_projected, display_label, detail_text, link_kind, link_ref, restriction_tier, source_license, commercial_use_allowed, attribution, source_label].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/company_trial_geography_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
+        :'scope' => :'AnimalWelfareAssurancesResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<CompanyTrialGeographyRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
-        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
+        :'freshness' => :'AnimalWelfareAssurancesResponseFreshness',
+        :'build' => :'AnimalWelfareAssurancesResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }

data/lib/pharmaobservatory/models/company_trial_sites_response.rb

@@ -102,7 +102,7 @@ module PharmaObservatory
         :'grain' => :'String',
         :'object_type' => :'String',
         :'id' => :'String',
-        :'scope' => :'BiomarkerAssayEvidenceResponseScope',
+        :'scope' => :'AnimalWelfareAssurancesResponseScope',
         :'columns' => :'Array<DatasetColumn>',
         :'rows' => :'Array<CompanyTrialSitesRow>',
         :'total' => :'Integer',
@@ -115,8 +115,8 @@ module PharmaObservatory
         :'source_credit' => :'String',
         :'withheld_tiers' => :'Array<String>',
         :'withheld_columns' => :'Array<String>',
-        :'freshness' => :'BiomarkerAssayEvidenceResponseFreshness',
-        :'build' => :'BiomarkerAssayEvidenceResponseBuild',
+        :'freshness' => :'AnimalWelfareAssurancesResponseFreshness',
+        :'build' => :'AnimalWelfareAssurancesResponseBuild',
         :'build_state' => :'DatasetBuildState',
         :'restriction' => :'Hash<String, Object>'
       }