pharmaobservatory 0.1.0 → 0.1.2

data/lib/pharmaobservatory/models/orgs_institutional13f200_response_rows_inner.rb

@@ -0,0 +1,684 @@
+=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
+  class OrgsInstitutional13f200ResponseRowsInner
+    attr_accessor :owner_rollup_id
+
+    attr_accessor :owner_display_name
+
+    attr_accessor :owner_identity_key
+
+    attr_accessor :owner_kind
+
+    attr_accessor :subject_source_ref
+
+    attr_accessor :subject_org_id
+
+    attr_accessor :reported_value_amount
+
+    attr_accessor :reported_value_currency
+
+    attr_accessor :equity_shares_standing
+
+    attr_accessor :percent_basis
+
+    attr_accessor :reported_percent
+
+    attr_accessor :edge_state
+
+    attr_accessor :last_filing_date
+
+    attr_accessor :first_observed_date
+
+    attr_accessor :issuer_name
+
+    attr_accessor :other_holdings
+
+    attr_accessor :other_identified_companies
+
+    attr_accessor :also_holds
+
+    attr_accessor :restriction_tier
+
+    attr_accessor :source_license
+
+    attr_accessor :attribution
+
+    attr_accessor :contains_personal_data
+
+    attr_accessor :privacy_status
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'owner_rollup_id' => :'owner_rollup_id',
+        :'owner_display_name' => :'owner_display_name',
+        :'owner_identity_key' => :'owner_identity_key',
+        :'owner_kind' => :'owner_kind',
+        :'subject_source_ref' => :'subject_source_ref',
+        :'subject_org_id' => :'subject_org_id',
+        :'reported_value_amount' => :'reported_value_amount',
+        :'reported_value_currency' => :'reported_value_currency',
+        :'equity_shares_standing' => :'equity_shares_standing',
+        :'percent_basis' => :'percent_basis',
+        :'reported_percent' => :'reported_percent',
+        :'edge_state' => :'edge_state',
+        :'last_filing_date' => :'last_filing_date',
+        :'first_observed_date' => :'first_observed_date',
+        :'issuer_name' => :'issuer_name',
+        :'other_holdings' => :'other_holdings',
+        :'other_identified_companies' => :'other_identified_companies',
+        :'also_holds' => :'also_holds',
+        :'restriction_tier' => :'restriction_tier',
+        :'source_license' => :'source_license',
+        :'attribution' => :'attribution',
+        :'contains_personal_data' => :'contains_personal_data',
+        :'privacy_status' => :'privacy_status'
+      }
+    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
+      {
+        :'owner_rollup_id' => :'String',
+        :'owner_display_name' => :'String',
+        :'owner_identity_key' => :'String',
+        :'owner_kind' => :'String',
+        :'subject_source_ref' => :'String',
+        :'subject_org_id' => :'String',
+        :'reported_value_amount' => :'Float',
+        :'reported_value_currency' => :'String',
+        :'equity_shares_standing' => :'Float',
+        :'percent_basis' => :'String',
+        :'reported_percent' => :'Object',
+        :'edge_state' => :'String',
+        :'last_filing_date' => :'String',
+        :'first_observed_date' => :'String',
+        :'issuer_name' => :'String',
+        :'other_holdings' => :'Integer',
+        :'other_identified_companies' => :'Integer',
+        :'also_holds' => :'Array<String>',
+        :'restriction_tier' => :'String',
+        :'source_license' => :'String',
+        :'attribution' => :'String',
+        :'contains_personal_data' => :'Boolean',
+        :'privacy_status' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'reported_percent',
+        :'other_holdings',
+        :'other_identified_companies',
+      ])
+    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::OrgsInstitutional13f200ResponseRowsInner` 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::OrgsInstitutional13f200ResponseRowsInner`. 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?(:'owner_rollup_id')
+        self.owner_rollup_id = attributes[:'owner_rollup_id']
+      else
+        self.owner_rollup_id = nil
+      end
+
+      if attributes.key?(:'owner_display_name')
+        self.owner_display_name = attributes[:'owner_display_name']
+      else
+        self.owner_display_name = nil
+      end
+
+      if attributes.key?(:'owner_identity_key')
+        self.owner_identity_key = attributes[:'owner_identity_key']
+      else
+        self.owner_identity_key = nil
+      end
+
+      if attributes.key?(:'owner_kind')
+        self.owner_kind = attributes[:'owner_kind']
+      else
+        self.owner_kind = nil
+      end
+
+      if attributes.key?(:'subject_source_ref')
+        self.subject_source_ref = attributes[:'subject_source_ref']
+      else
+        self.subject_source_ref = nil
+      end
+
+      if attributes.key?(:'subject_org_id')
+        self.subject_org_id = attributes[:'subject_org_id']
+      else
+        self.subject_org_id = nil
+      end
+
+      if attributes.key?(:'reported_value_amount')
+        self.reported_value_amount = attributes[:'reported_value_amount']
+      else
+        self.reported_value_amount = nil
+      end
+
+      if attributes.key?(:'reported_value_currency')
+        self.reported_value_currency = attributes[:'reported_value_currency']
+      else
+        self.reported_value_currency = nil
+      end
+
+      if attributes.key?(:'equity_shares_standing')
+        self.equity_shares_standing = attributes[:'equity_shares_standing']
+      else
+        self.equity_shares_standing = nil
+      end
+
+      if attributes.key?(:'percent_basis')
+        self.percent_basis = attributes[:'percent_basis']
+      else
+        self.percent_basis = nil
+      end
+
+      if attributes.key?(:'reported_percent')
+        self.reported_percent = attributes[:'reported_percent']
+      else
+        self.reported_percent = nil
+      end
+
+      if attributes.key?(:'edge_state')
+        self.edge_state = attributes[:'edge_state']
+      else
+        self.edge_state = nil
+      end
+
+      if attributes.key?(:'last_filing_date')
+        self.last_filing_date = attributes[:'last_filing_date']
+      else
+        self.last_filing_date = nil
+      end
+
+      if attributes.key?(:'first_observed_date')
+        self.first_observed_date = attributes[:'first_observed_date']
+      else
+        self.first_observed_date = nil
+      end
+
+      if attributes.key?(:'issuer_name')
+        self.issuer_name = attributes[:'issuer_name']
+      else
+        self.issuer_name = nil
+      end
+
+      if attributes.key?(:'other_holdings')
+        self.other_holdings = attributes[:'other_holdings']
+      else
+        self.other_holdings = nil
+      end
+
+      if attributes.key?(:'other_identified_companies')
+        self.other_identified_companies = attributes[:'other_identified_companies']
+      else
+        self.other_identified_companies = nil
+      end
+
+      if attributes.key?(:'also_holds')
+        if (value = attributes[:'also_holds']).is_a?(Array)
+          self.also_holds = value
+        end
+      else
+        self.also_holds = nil
+      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?(:'attribution')
+        self.attribution = attributes[:'attribution']
+      end
+
+      if attributes.key?(:'contains_personal_data')
+        self.contains_personal_data = attributes[:'contains_personal_data']
+      end
+
+      if attributes.key?(:'privacy_status')
+        self.privacy_status = attributes[:'privacy_status']
+      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
+      if @owner_rollup_id.nil?
+        invalid_properties.push('invalid value for "owner_rollup_id", owner_rollup_id cannot be nil.')
+      end
+
+      if @owner_display_name.nil?
+        invalid_properties.push('invalid value for "owner_display_name", owner_display_name cannot be nil.')
+      end
+
+      if @owner_identity_key.nil?
+        invalid_properties.push('invalid value for "owner_identity_key", owner_identity_key cannot be nil.')
+      end
+
+      if @owner_kind.nil?
+        invalid_properties.push('invalid value for "owner_kind", owner_kind cannot be nil.')
+      end
+
+      if @subject_source_ref.nil?
+        invalid_properties.push('invalid value for "subject_source_ref", subject_source_ref cannot be nil.')
+      end
+
+      if @subject_org_id.nil?
+        invalid_properties.push('invalid value for "subject_org_id", subject_org_id cannot be nil.')
+      end
+
+      if @reported_value_amount.nil?
+        invalid_properties.push('invalid value for "reported_value_amount", reported_value_amount cannot be nil.')
+      end
+
+      if @reported_value_currency.nil?
+        invalid_properties.push('invalid value for "reported_value_currency", reported_value_currency cannot be nil.')
+      end
+
+      if @equity_shares_standing.nil?
+        invalid_properties.push('invalid value for "equity_shares_standing", equity_shares_standing cannot be nil.')
+      end
+
+      if @percent_basis.nil?
+        invalid_properties.push('invalid value for "percent_basis", percent_basis cannot be nil.')
+      end
+
+      if @edge_state.nil?
+        invalid_properties.push('invalid value for "edge_state", edge_state cannot be nil.')
+      end
+
+      if @last_filing_date.nil?
+        invalid_properties.push('invalid value for "last_filing_date", last_filing_date cannot be nil.')
+      end
+
+      if @first_observed_date.nil?
+        invalid_properties.push('invalid value for "first_observed_date", first_observed_date cannot be nil.')
+      end
+
+      if @issuer_name.nil?
+        invalid_properties.push('invalid value for "issuer_name", issuer_name cannot be nil.')
+      end
+
+      if @also_holds.nil?
+        invalid_properties.push('invalid value for "also_holds", also_holds cannot be nil.')
+      end
+
+      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'
+      return false if @owner_rollup_id.nil?
+      return false if @owner_display_name.nil?
+      return false if @owner_identity_key.nil?
+      return false if @owner_kind.nil?
+      return false if @subject_source_ref.nil?
+      return false if @subject_org_id.nil?
+      return false if @reported_value_amount.nil?
+      return false if @reported_value_currency.nil?
+      return false if @equity_shares_standing.nil?
+      return false if @percent_basis.nil?
+      return false if @edge_state.nil?
+      return false if @last_filing_date.nil?
+      return false if @first_observed_date.nil?
+      return false if @issuer_name.nil?
+      return false if @also_holds.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owner_rollup_id Value to be assigned
+    def owner_rollup_id=(owner_rollup_id)
+      if owner_rollup_id.nil?
+        fail ArgumentError, 'owner_rollup_id cannot be nil'
+      end
+
+      @owner_rollup_id = owner_rollup_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owner_display_name Value to be assigned
+    def owner_display_name=(owner_display_name)
+      if owner_display_name.nil?
+        fail ArgumentError, 'owner_display_name cannot be nil'
+      end
+
+      @owner_display_name = owner_display_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owner_identity_key Value to be assigned
+    def owner_identity_key=(owner_identity_key)
+      if owner_identity_key.nil?
+        fail ArgumentError, 'owner_identity_key cannot be nil'
+      end
+
+      @owner_identity_key = owner_identity_key
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] owner_kind Value to be assigned
+    def owner_kind=(owner_kind)
+      if owner_kind.nil?
+        fail ArgumentError, 'owner_kind cannot be nil'
+      end
+
+      @owner_kind = owner_kind
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subject_source_ref Value to be assigned
+    def subject_source_ref=(subject_source_ref)
+      if subject_source_ref.nil?
+        fail ArgumentError, 'subject_source_ref cannot be nil'
+      end
+
+      @subject_source_ref = subject_source_ref
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] subject_org_id Value to be assigned
+    def subject_org_id=(subject_org_id)
+      if subject_org_id.nil?
+        fail ArgumentError, 'subject_org_id cannot be nil'
+      end
+
+      @subject_org_id = subject_org_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reported_value_amount Value to be assigned
+    def reported_value_amount=(reported_value_amount)
+      if reported_value_amount.nil?
+        fail ArgumentError, 'reported_value_amount cannot be nil'
+      end
+
+      @reported_value_amount = reported_value_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reported_value_currency Value to be assigned
+    def reported_value_currency=(reported_value_currency)
+      if reported_value_currency.nil?
+        fail ArgumentError, 'reported_value_currency cannot be nil'
+      end
+
+      @reported_value_currency = reported_value_currency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] equity_shares_standing Value to be assigned
+    def equity_shares_standing=(equity_shares_standing)
+      if equity_shares_standing.nil?
+        fail ArgumentError, 'equity_shares_standing cannot be nil'
+      end
+
+      @equity_shares_standing = equity_shares_standing
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] percent_basis Value to be assigned
+    def percent_basis=(percent_basis)
+      if percent_basis.nil?
+        fail ArgumentError, 'percent_basis cannot be nil'
+      end
+
+      @percent_basis = percent_basis
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] edge_state Value to be assigned
+    def edge_state=(edge_state)
+      if edge_state.nil?
+        fail ArgumentError, 'edge_state cannot be nil'
+      end
+
+      @edge_state = edge_state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_filing_date Value to be assigned
+    def last_filing_date=(last_filing_date)
+      if last_filing_date.nil?
+        fail ArgumentError, 'last_filing_date cannot be nil'
+      end
+
+      @last_filing_date = last_filing_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_observed_date Value to be assigned
+    def first_observed_date=(first_observed_date)
+      if first_observed_date.nil?
+        fail ArgumentError, 'first_observed_date cannot be nil'
+      end
+
+      @first_observed_date = first_observed_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] issuer_name Value to be assigned
+    def issuer_name=(issuer_name)
+      if issuer_name.nil?
+        fail ArgumentError, 'issuer_name cannot be nil'
+      end
+
+      @issuer_name = issuer_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] also_holds Value to be assigned
+    def also_holds=(also_holds)
+      if also_holds.nil?
+        fail ArgumentError, 'also_holds cannot be nil'
+      end
+
+      @also_holds = also_holds
+    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 &&
+          owner_rollup_id == o.owner_rollup_id &&
+          owner_display_name == o.owner_display_name &&
+          owner_identity_key == o.owner_identity_key &&
+          owner_kind == o.owner_kind &&
+          subject_source_ref == o.subject_source_ref &&
+          subject_org_id == o.subject_org_id &&
+          reported_value_amount == o.reported_value_amount &&
+          reported_value_currency == o.reported_value_currency &&
+          equity_shares_standing == o.equity_shares_standing &&
+          percent_basis == o.percent_basis &&
+          reported_percent == o.reported_percent &&
+          edge_state == o.edge_state &&
+          last_filing_date == o.last_filing_date &&
+          first_observed_date == o.first_observed_date &&
+          issuer_name == o.issuer_name &&
+          other_holdings == o.other_holdings &&
+          other_identified_companies == o.other_identified_companies &&
+          also_holds == o.also_holds &&
+          restriction_tier == o.restriction_tier &&
+          source_license == o.source_license &&
+          attribution == o.attribution &&
+          contains_personal_data == o.contains_personal_data &&
+          privacy_status == o.privacy_status
+    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
+      [owner_rollup_id, owner_display_name, owner_identity_key, owner_kind, subject_source_ref, subject_org_id, reported_value_amount, reported_value_currency, equity_shares_standing, percent_basis, reported_percent, edge_state, last_filing_date, first_observed_date, issuer_name, other_holdings, other_identified_companies, also_holds, restriction_tier, source_license, attribution, contains_personal_data, privacy_status].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