pharmaobservatory 0.1.4 → 0.1.6

data/lib/pharmaobservatory/models/managers_row.rb

@@ -0,0 +1,377 @@
+=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 managers dataset: one row per Form 13F manager with at least one current holding in the retained issuer set. A grouped request returns the group columns and the measures instead, as additional properties.
+  class ManagersRow
+    # The manager key, the id the web page uses: edgar_cik:<10-digit filer CIK>, or party:sec-cik:<ref> for a filer whose CIK is malformed. The same value as holder_identity_key on institutional_holdings.
+    attr_accessor :manager_id
+
+    # The manager's name as filed (the longest variant), falling back to the manager key.
+    attr_accessor :name
+
+    # How many spellings of the name the filings carry.
+    attr_accessor :name_variant_count
+
+    # The manager's investor key where the link resolves; null when the manager resolves to no investor or its rows disagree (see investor_link_conflict).
+    attr_accessor :investor_id
+
+    # True when the manager's own holding rows resolve to different investors, so no investor is linked.
+    attr_accessor :investor_link_conflict
+
+    # Legal-entity level: the manager's organization record when all its rows agree on one (null otherwise).
+    attr_accessor :org_id
+
+    # Company level: the manager's company (null when unresolved).
+    attr_accessor :company_id
+
+    # Display name of the manager's company.
+    attr_accessor :company_name
+
+    # Group level: the manager's company's current ultimate parent; a root's group is itself.
+    attr_accessor :group_id
+
+    # Display name of the manager's group.
+    attr_accessor :group_name
+
+    # Current positions the manager reports, one per issuer security.
+    attr_accessor :position_count
+
+    # Distinct issuer securities (CUSIPs) across those positions.
+    attr_accessor :issuer_count
+
+    # Of those positions, the ones with a reported value (a position whose filing scale was ambiguous has none).
+    attr_accessor :valued_position_count
+
+    # The earliest filing date a current position was first observed.
+    attr_accessor :first_observed_date
+
+    # The latest filing date among the manager's positions.
+    attr_accessor :last_filing_date
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'manager_id' => :'manager_id',
+        :'name' => :'name',
+        :'name_variant_count' => :'name_variant_count',
+        :'investor_id' => :'investor_id',
+        :'investor_link_conflict' => :'investor_link_conflict',
+        :'org_id' => :'org_id',
+        :'company_id' => :'company_id',
+        :'company_name' => :'company_name',
+        :'group_id' => :'group_id',
+        :'group_name' => :'group_name',
+        :'position_count' => :'position_count',
+        :'issuer_count' => :'issuer_count',
+        :'valued_position_count' => :'valued_position_count',
+        :'first_observed_date' => :'first_observed_date',
+        :'last_filing_date' => :'last_filing_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
+      {
+        :'manager_id' => :'String',
+        :'name' => :'String',
+        :'name_variant_count' => :'Integer',
+        :'investor_id' => :'String',
+        :'investor_link_conflict' => :'Boolean',
+        :'org_id' => :'String',
+        :'company_id' => :'String',
+        :'company_name' => :'String',
+        :'group_id' => :'String',
+        :'group_name' => :'String',
+        :'position_count' => :'Integer',
+        :'issuer_count' => :'Integer',
+        :'valued_position_count' => :'Integer',
+        :'first_observed_date' => :'Date',
+        :'last_filing_date' => :'Date'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'manager_id',
+        :'name',
+        :'name_variant_count',
+        :'investor_id',
+        :'investor_link_conflict',
+        :'org_id',
+        :'company_id',
+        :'company_name',
+        :'group_id',
+        :'group_name',
+        :'position_count',
+        :'issuer_count',
+        :'valued_position_count',
+        :'first_observed_date',
+        :'last_filing_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::ManagersRow` 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::ManagersRow`. 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?(:'manager_id')
+        self.manager_id = attributes[:'manager_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'name_variant_count')
+        self.name_variant_count = attributes[:'name_variant_count']
+      end
+
+      if attributes.key?(:'investor_id')
+        self.investor_id = attributes[:'investor_id']
+      end
+
+      if attributes.key?(:'investor_link_conflict')
+        self.investor_link_conflict = attributes[:'investor_link_conflict']
+      end
+
+      if attributes.key?(:'org_id')
+        self.org_id = attributes[:'org_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?(:'position_count')
+        self.position_count = attributes[:'position_count']
+      end
+
+      if attributes.key?(:'issuer_count')
+        self.issuer_count = attributes[:'issuer_count']
+      end
+
+      if attributes.key?(:'valued_position_count')
+        self.valued_position_count = attributes[:'valued_position_count']
+      end
+
+      if attributes.key?(:'first_observed_date')
+        self.first_observed_date = attributes[:'first_observed_date']
+      end
+
+      if attributes.key?(:'last_filing_date')
+        self.last_filing_date = attributes[:'last_filing_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 &&
+          manager_id == o.manager_id &&
+          name == o.name &&
+          name_variant_count == o.name_variant_count &&
+          investor_id == o.investor_id &&
+          investor_link_conflict == o.investor_link_conflict &&
+          org_id == o.org_id &&
+          company_id == o.company_id &&
+          company_name == o.company_name &&
+          group_id == o.group_id &&
+          group_name == o.group_name &&
+          position_count == o.position_count &&
+          issuer_count == o.issuer_count &&
+          valued_position_count == o.valued_position_count &&
+          first_observed_date == o.first_observed_date &&
+          last_filing_date == o.last_filing_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
+      [manager_id, name, name_variant_count, investor_id, investor_link_conflict, org_id, company_id, company_name, group_id, group_name, position_count, issuer_count, valued_position_count, first_observed_date, last_filing_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