pharmaobservatory 0.1.3 → 0.1.4

data/lib/pharmaobservatory/models/company_funding_events_row.rb

@@ -0,0 +1,465 @@
+=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_funding_events dataset: one row per funding event. A grouped request returns the group columns and the measures instead, as additional properties.
+  class CompanyFundingEventsRow
+    # The funding event key.
+    attr_accessor :funding_event_id
+
+    # The issuer's name as filed.
+    attr_accessor :issuer_name
+
+    # Legal-entity level: the issuer's organization record.
+    attr_accessor :issuer_org_id
+
+    # Company level: the issuer's company (null when the issuer did not resolve to a company).
+    attr_accessor :issuer_company_id
+
+    # Display name of the issuer's company.
+    attr_accessor :issuer_company_name
+
+    # Group level: the issuer's current ultimate parent company; a root company's group is itself.
+    attr_accessor :issuer_group_id
+
+    # Display name of the issuer's group.
+    attr_accessor :issuer_group_name
+
+    # The date the source gives for the event; event_stage says what the date means.
+    attr_accessor :event_date
+
+    # The NIH fiscal year, for a grant; null for the other sources.
+    attr_accessor :fiscal_year
+
+    # The source lane: reporter (NIH RePORTER grants), form_d (SEC Form D Regulation D offerings), edgar_offerings (SEC registered offerings) or sec_extracted (financings extracted from SEC filings).
+    attr_accessor :source
+
+    # The kind of round (for example grant_nih, sbir, reg_d_private, ipo, follow_on, public_offering, atm, registered_direct, debt).
+    attr_accessor :round_type
+
+    # A finer type, such as the grant activity code, the Regulation D exemption or the SEC form.
+    attr_accessor :round_subtype
+
+    # Whether the round dilutes existing equity; null where the instrument is not classified.
+    attr_accessor :is_dilutive
+
+    # The disclosed amount in whole US dollars; null where the amount is not disclosed.
+    attr_accessor :amount_usd
+
+    # The currency the source reports the amount in.
+    attr_accessor :currency
+
+    # Whether the source states an amount for the event.
+    attr_accessor :amount_is_disclosed
+
+    # Whether the event's dollars count as capital raised, and if not why not (for example structured_source, actual_inflow, capacity, committed).
+    attr_accessor :capital_treatment
+
+    # True where the event counts as capital the issuer raised.
+    attr_accessor :is_actual_issuer_inflow
+
+    # The lifecycle stage the event's date refers to (for example sold_to_date, funded, closed, registered, announced).
+    attr_accessor :event_stage
+
+    # The National Institutes of Health institute or center that administers the grant (for example CA for the National Cancer Institute); null for the other sources.
+    attr_accessor :administering_ic
+
+    # Grant applications folded into the event; 1 for the other sources.
+    attr_accessor :n_awards
+
+    # The running total of disclosed amounts over the company's own events up to and including this one, in date order; null where the event has no company.
+    attr_accessor :cumulative_raised_usd
+
+    # Link to the filing the event was read from, where the source has one.
+    attr_accessor :source_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'funding_event_id' => :'funding_event_id',
+        :'issuer_name' => :'issuer_name',
+        :'issuer_org_id' => :'issuer_org_id',
+        :'issuer_company_id' => :'issuer_company_id',
+        :'issuer_company_name' => :'issuer_company_name',
+        :'issuer_group_id' => :'issuer_group_id',
+        :'issuer_group_name' => :'issuer_group_name',
+        :'event_date' => :'event_date',
+        :'fiscal_year' => :'fiscal_year',
+        :'source' => :'source',
+        :'round_type' => :'round_type',
+        :'round_subtype' => :'round_subtype',
+        :'is_dilutive' => :'is_dilutive',
+        :'amount_usd' => :'amount_usd',
+        :'currency' => :'currency',
+        :'amount_is_disclosed' => :'amount_is_disclosed',
+        :'capital_treatment' => :'capital_treatment',
+        :'is_actual_issuer_inflow' => :'is_actual_issuer_inflow',
+        :'event_stage' => :'event_stage',
+        :'administering_ic' => :'administering_ic',
+        :'n_awards' => :'n_awards',
+        :'cumulative_raised_usd' => :'cumulative_raised_usd',
+        :'source_url' => :'source_url'
+      }
+    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
+      {
+        :'funding_event_id' => :'String',
+        :'issuer_name' => :'String',
+        :'issuer_org_id' => :'String',
+        :'issuer_company_id' => :'String',
+        :'issuer_company_name' => :'String',
+        :'issuer_group_id' => :'String',
+        :'issuer_group_name' => :'String',
+        :'event_date' => :'Date',
+        :'fiscal_year' => :'Integer',
+        :'source' => :'String',
+        :'round_type' => :'String',
+        :'round_subtype' => :'String',
+        :'is_dilutive' => :'Boolean',
+        :'amount_usd' => :'Float',
+        :'currency' => :'String',
+        :'amount_is_disclosed' => :'Boolean',
+        :'capital_treatment' => :'String',
+        :'is_actual_issuer_inflow' => :'Boolean',
+        :'event_stage' => :'String',
+        :'administering_ic' => :'String',
+        :'n_awards' => :'Integer',
+        :'cumulative_raised_usd' => :'Float',
+        :'source_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'funding_event_id',
+        :'issuer_name',
+        :'issuer_org_id',
+        :'issuer_company_id',
+        :'issuer_company_name',
+        :'issuer_group_id',
+        :'issuer_group_name',
+        :'event_date',
+        :'fiscal_year',
+        :'source',
+        :'round_type',
+        :'round_subtype',
+        :'is_dilutive',
+        :'amount_usd',
+        :'currency',
+        :'amount_is_disclosed',
+        :'capital_treatment',
+        :'is_actual_issuer_inflow',
+        :'event_stage',
+        :'administering_ic',
+        :'n_awards',
+        :'cumulative_raised_usd',
+        :'source_url'
+      ])
+    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::CompanyFundingEventsRow` 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::CompanyFundingEventsRow`. 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?(:'funding_event_id')
+        self.funding_event_id = attributes[:'funding_event_id']
+      end
+
+      if attributes.key?(:'issuer_name')
+        self.issuer_name = attributes[:'issuer_name']
+      end
+
+      if attributes.key?(:'issuer_org_id')
+        self.issuer_org_id = attributes[:'issuer_org_id']
+      end
+
+      if attributes.key?(:'issuer_company_id')
+        self.issuer_company_id = attributes[:'issuer_company_id']
+      end
+
+      if attributes.key?(:'issuer_company_name')
+        self.issuer_company_name = attributes[:'issuer_company_name']
+      end
+
+      if attributes.key?(:'issuer_group_id')
+        self.issuer_group_id = attributes[:'issuer_group_id']
+      end
+
+      if attributes.key?(:'issuer_group_name')
+        self.issuer_group_name = attributes[:'issuer_group_name']
+      end
+
+      if attributes.key?(:'event_date')
+        self.event_date = attributes[:'event_date']
+      end
+
+      if attributes.key?(:'fiscal_year')
+        self.fiscal_year = attributes[:'fiscal_year']
+      end
+
+      if attributes.key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.key?(:'round_type')
+        self.round_type = attributes[:'round_type']
+      end
+
+      if attributes.key?(:'round_subtype')
+        self.round_subtype = attributes[:'round_subtype']
+      end
+
+      if attributes.key?(:'is_dilutive')
+        self.is_dilutive = attributes[:'is_dilutive']
+      end
+
+      if attributes.key?(:'amount_usd')
+        self.amount_usd = attributes[:'amount_usd']
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.key?(:'amount_is_disclosed')
+        self.amount_is_disclosed = attributes[:'amount_is_disclosed']
+      end
+
+      if attributes.key?(:'capital_treatment')
+        self.capital_treatment = attributes[:'capital_treatment']
+      end
+
+      if attributes.key?(:'is_actual_issuer_inflow')
+        self.is_actual_issuer_inflow = attributes[:'is_actual_issuer_inflow']
+      end
+
+      if attributes.key?(:'event_stage')
+        self.event_stage = attributes[:'event_stage']
+      end
+
+      if attributes.key?(:'administering_ic')
+        self.administering_ic = attributes[:'administering_ic']
+      end
+
+      if attributes.key?(:'n_awards')
+        self.n_awards = attributes[:'n_awards']
+      end
+
+      if attributes.key?(:'cumulative_raised_usd')
+        self.cumulative_raised_usd = attributes[:'cumulative_raised_usd']
+      end
+
+      if attributes.key?(:'source_url')
+        self.source_url = attributes[:'source_url']
+      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 &&
+          funding_event_id == o.funding_event_id &&
+          issuer_name == o.issuer_name &&
+          issuer_org_id == o.issuer_org_id &&
+          issuer_company_id == o.issuer_company_id &&
+          issuer_company_name == o.issuer_company_name &&
+          issuer_group_id == o.issuer_group_id &&
+          issuer_group_name == o.issuer_group_name &&
+          event_date == o.event_date &&
+          fiscal_year == o.fiscal_year &&
+          source == o.source &&
+          round_type == o.round_type &&
+          round_subtype == o.round_subtype &&
+          is_dilutive == o.is_dilutive &&
+          amount_usd == o.amount_usd &&
+          currency == o.currency &&
+          amount_is_disclosed == o.amount_is_disclosed &&
+          capital_treatment == o.capital_treatment &&
+          is_actual_issuer_inflow == o.is_actual_issuer_inflow &&
+          event_stage == o.event_stage &&
+          administering_ic == o.administering_ic &&
+          n_awards == o.n_awards &&
+          cumulative_raised_usd == o.cumulative_raised_usd &&
+          source_url == o.source_url
+    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
+      [funding_event_id, issuer_name, issuer_org_id, issuer_company_id, issuer_company_name, issuer_group_id, issuer_group_name, event_date, fiscal_year, source, round_type, round_subtype, is_dilutive, amount_usd, currency, amount_is_disclosed, capital_treatment, is_actual_issuer_inflow, event_stage, administering_ic, n_awards, cumulative_raised_usd, source_url].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