pharmaobservatory 0.1.7 → 0.1.8

data/lib/pharmaobservatory/models/legal_entity_sec_filings_row.rb

@@ -0,0 +1,370 @@
+=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 legal_entity_sec_filings dataset: one row per SEC filer organization known only from its Form D filings. A grouped request returns the group columns and the measures instead, as additional properties.
+  class LegalEntitySecFilingsRow
+    # Legal-entity level: the SEC filer organization record.
+    attr_accessor :org_id
+
+    # Display name of the filer organization record.
+    attr_accessor :org_name
+
+    # Company level: the company the filer belongs to (null when unresolved).
+    attr_accessor :company_id
+
+    # Display name of the filer's company.
+    attr_accessor :company_name
+
+    # Group level: the filer's current ultimate parent company; a root company's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the filer's group.
+    attr_accessor :group_name
+
+    # The filer's 10-digit SEC Central Index Key (CIK).
+    attr_accessor :edgar_cik
+
+    # The jurisdiction of incorporation as the latest filing states it (a US state or a country, free text); null when blank.
+    attr_accessor :jurisdiction_of_inc
+
+    # The entity type the latest filing states (Corporation, Limited Liability Company, Limited Partnership, General Partnership, Business Trust or Other); null when blank.
+    attr_accessor :entity_type
+
+    # The filer's free-text description when it ticked entity type Other.
+    attr_accessor :entity_type_other_desc
+
+    # The filing's year-of-incorporation choice (Over Five Years Ago, Within Last Five Years or Yet to Be Formed); null when blank.
+    attr_accessor :year_of_inc_band
+
+    # The year of incorporation when the filing gives a four-digit year.
+    attr_accessor :year_of_inc
+
+    # The industry groups the filer's in-scope filings name.
+    attr_accessor :industry_group_types
+
+    # Earlier names the filer states, other than its current name.
+    attr_accessor :previous_names
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'org_id' => :'org_id',
+        :'org_name' => :'org_name',
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'edgar_cik' => :'edgar_cik',
+        :'jurisdiction_of_inc' => :'jurisdiction_of_inc',
+        :'entity_type' => :'entity_type',
+        :'entity_type_other_desc' => :'entity_type_other_desc',
+        :'year_of_inc_band' => :'year_of_inc_band',
+        :'year_of_inc' => :'year_of_inc',
+        :'industry_group_types' => :'industry_group_types',
+        :'previous_names' => :'previous_names'
+      }
+    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
+      {
+        :'org_id' => :'String',
+        :'org_name' => :'String',
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'edgar_cik' => :'String',
+        :'jurisdiction_of_inc' => :'String',
+        :'entity_type' => :'String',
+        :'entity_type_other_desc' => :'String',
+        :'year_of_inc_band' => :'String',
+        :'year_of_inc' => :'Integer',
+        :'industry_group_types' => :'Array<String>',
+        :'previous_names' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'org_id',
+        :'org_name',
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'edgar_cik',
+        :'jurisdiction_of_inc',
+        :'entity_type',
+        :'entity_type_other_desc',
+        :'year_of_inc_band',
+        :'year_of_inc',
+        :'industry_group_types',
+        :'previous_names'
+      ])
+    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::LegalEntitySecFilingsRow` 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::LegalEntitySecFilingsRow`. 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?(:'org_id')
+        self.org_id = attributes[:'org_id']
+      end
+
+      if attributes.key?(:'org_name')
+        self.org_name = attributes[:'org_name']
+      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?(:'edgar_cik')
+        self.edgar_cik = attributes[:'edgar_cik']
+      end
+
+      if attributes.key?(:'jurisdiction_of_inc')
+        self.jurisdiction_of_inc = attributes[:'jurisdiction_of_inc']
+      end
+
+      if attributes.key?(:'entity_type')
+        self.entity_type = attributes[:'entity_type']
+      end
+
+      if attributes.key?(:'entity_type_other_desc')
+        self.entity_type_other_desc = attributes[:'entity_type_other_desc']
+      end
+
+      if attributes.key?(:'year_of_inc_band')
+        self.year_of_inc_band = attributes[:'year_of_inc_band']
+      end
+
+      if attributes.key?(:'year_of_inc')
+        self.year_of_inc = attributes[:'year_of_inc']
+      end
+
+      if attributes.key?(:'industry_group_types')
+        if (value = attributes[:'industry_group_types']).is_a?(Array)
+          self.industry_group_types = value
+        end
+      end
+
+      if attributes.key?(:'previous_names')
+        if (value = attributes[:'previous_names']).is_a?(Array)
+          self.previous_names = value
+        end
+      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 &&
+          org_id == o.org_id &&
+          org_name == o.org_name &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          edgar_cik == o.edgar_cik &&
+          jurisdiction_of_inc == o.jurisdiction_of_inc &&
+          entity_type == o.entity_type &&
+          entity_type_other_desc == o.entity_type_other_desc &&
+          year_of_inc_band == o.year_of_inc_band &&
+          year_of_inc == o.year_of_inc &&
+          industry_group_types == o.industry_group_types &&
+          previous_names == o.previous_names
+    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
+      [org_id, org_name, company_id, company_name, group_id, group_name, edgar_cik, jurisdiction_of_inc, entity_type, entity_type_other_desc, year_of_inc_band, year_of_inc, industry_group_types, previous_names].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