intrinio-sdk 6.42.0 → 6.43.0

data/lib/intrinio-sdk/models/etf_nav_flow.rb

@@ -0,0 +1,529 @@
+=begin
+#Intrinio API
+
+#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
+
+OpenAPI spec version: 2.115.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: unset
+
+=end
+
+require 'date'
+
+module Intrinio
+  # NAV (Net Asset Value) and flows data for an Exchange Traded Fund (ETF) on a specific date
+  class ETFNavFlow
+    # The date of the NAV flows data
+    attr_accessor :as_of_date
+
+    # Daily NAV return as a decimal (percentage)
+    attr_accessor :nav_return_daily
+
+    # One month NAV return as a decimal (percentage)
+    attr_accessor :nav_return_one_month
+
+    # Three month NAV return as a decimal (percentage)
+    attr_accessor :nav_return_three_month
+
+    # Year-to-date NAV return as a decimal (percentage)
+    attr_accessor :nav_return_ytd
+
+    # One year NAV return as a decimal (percentage)
+    attr_accessor :nav_return_one_year
+
+    # NAV return 1 year prior as a decimal (percentage)
+    attr_accessor :nav_return_1_year_prior
+
+    # NAV return 2 years prior as a decimal (percentage)
+    attr_accessor :nav_return_2_year_prior
+
+    # NAV return 3 years prior as a decimal (percentage)
+    attr_accessor :nav_return_3_year_prior
+
+    # NAV return 4 years prior as a decimal (percentage)
+    attr_accessor :nav_return_4_year_prior
+
+    # NAV return 5 years prior as a decimal (percentage)
+    attr_accessor :nav_return_5_year_prior
+
+    # Three year annualized NAV return as a decimal (percentage)
+    attr_accessor :nav_annualized_return_three_year
+
+    # Five year annualized NAV return as a decimal (percentage)
+    attr_accessor :nav_annualized_return_five_year
+
+    # Ten year annualized NAV return as a decimal (percentage)
+    attr_accessor :nav_annualized_return_ten_year
+
+    # Annualized NAV return since inception as a decimal (percentage)
+    attr_accessor :nav_annualized_return_inception
+
+    # Net asset value unadjusted for splits or dividends
+    attr_accessor :nav_unadjusted
+
+    # Net asset value adjusted for splits only
+    attr_accessor :nav_split_adjusted
+
+    # Net asset value adjusted for both splits and dividends
+    attr_accessor :nav_split_dividend_adjusted
+
+    # Daily net flows in dollars
+    attr_accessor :net_flows_daily
+
+    # One month net flows in dollars
+    attr_accessor :net_flows_one_month
+
+    # Three month net flows in dollars
+    attr_accessor :net_flows_three_month
+
+    # Year-to-date net flows in dollars
+    attr_accessor :net_flows_ytd
+
+    # One year net flows in dollars
+    attr_accessor :net_flows_one_year
+
+    # Three year net flows in dollars
+    attr_accessor :net_flows_three_year
+
+    # Five year net flows in dollars
+    attr_accessor :net_flows_five_year
+
+    # Ten year net flows in dollars
+    attr_accessor :net_flows_ten_year
+
+    # Net flows 1 year prior in dollars
+    attr_accessor :net_flows_1_year_prior
+
+    # Net flows 2 years prior in dollars
+    attr_accessor :net_flows_2_year_prior
+
+    # Net flows 3 years prior in dollars
+    attr_accessor :net_flows_3_year_prior
+
+    # Net flows 4 years prior in dollars
+    attr_accessor :net_flows_4_year_prior
+
+    # Net flows 5 years prior in dollars
+    attr_accessor :net_flows_5_year_prior
+
+    # Net flows since inception in dollars
+    attr_accessor :net_flows_inception
+
+    # Shares outstanding unadjusted for splits
+    attr_accessor :share_outstanding_unadjusted
+
+    # Shares outstanding adjusted for splits
+    attr_accessor :share_outstanding_split_adjusted
+
+    # Total net assets in dollars
+    attr_accessor :total_net_assets
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'as_of_date' => :'as_of_date',
+        :'nav_return_daily' => :'nav_return_daily',
+        :'nav_return_one_month' => :'nav_return_one_month',
+        :'nav_return_three_month' => :'nav_return_three_month',
+        :'nav_return_ytd' => :'nav_return_ytd',
+        :'nav_return_one_year' => :'nav_return_one_year',
+        :'nav_return_1_year_prior' => :'nav_return_1_year_prior',
+        :'nav_return_2_year_prior' => :'nav_return_2_year_prior',
+        :'nav_return_3_year_prior' => :'nav_return_3_year_prior',
+        :'nav_return_4_year_prior' => :'nav_return_4_year_prior',
+        :'nav_return_5_year_prior' => :'nav_return_5_year_prior',
+        :'nav_annualized_return_three_year' => :'nav_annualized_return_three_year',
+        :'nav_annualized_return_five_year' => :'nav_annualized_return_five_year',
+        :'nav_annualized_return_ten_year' => :'nav_annualized_return_ten_year',
+        :'nav_annualized_return_inception' => :'nav_annualized_return_inception',
+        :'nav_unadjusted' => :'nav_unadjusted',
+        :'nav_split_adjusted' => :'nav_split_adjusted',
+        :'nav_split_dividend_adjusted' => :'nav_split_dividend_adjusted',
+        :'net_flows_daily' => :'net_flows_daily',
+        :'net_flows_one_month' => :'net_flows_one_month',
+        :'net_flows_three_month' => :'net_flows_three_month',
+        :'net_flows_ytd' => :'net_flows_ytd',
+        :'net_flows_one_year' => :'net_flows_one_year',
+        :'net_flows_three_year' => :'net_flows_three_year',
+        :'net_flows_five_year' => :'net_flows_five_year',
+        :'net_flows_ten_year' => :'net_flows_ten_year',
+        :'net_flows_1_year_prior' => :'net_flows_1_year_prior',
+        :'net_flows_2_year_prior' => :'net_flows_2_year_prior',
+        :'net_flows_3_year_prior' => :'net_flows_3_year_prior',
+        :'net_flows_4_year_prior' => :'net_flows_4_year_prior',
+        :'net_flows_5_year_prior' => :'net_flows_5_year_prior',
+        :'net_flows_inception' => :'net_flows_inception',
+        :'share_outstanding_unadjusted' => :'share_outstanding_unadjusted',
+        :'share_outstanding_split_adjusted' => :'share_outstanding_split_adjusted',
+        :'total_net_assets' => :'total_net_assets'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'as_of_date' => :'Date',
+        :'nav_return_daily' => :'Float',
+        :'nav_return_one_month' => :'Float',
+        :'nav_return_three_month' => :'Float',
+        :'nav_return_ytd' => :'Float',
+        :'nav_return_one_year' => :'Float',
+        :'nav_return_1_year_prior' => :'Float',
+        :'nav_return_2_year_prior' => :'Float',
+        :'nav_return_3_year_prior' => :'Float',
+        :'nav_return_4_year_prior' => :'Float',
+        :'nav_return_5_year_prior' => :'Float',
+        :'nav_annualized_return_three_year' => :'Float',
+        :'nav_annualized_return_five_year' => :'Float',
+        :'nav_annualized_return_ten_year' => :'Float',
+        :'nav_annualized_return_inception' => :'Float',
+        :'nav_unadjusted' => :'Float',
+        :'nav_split_adjusted' => :'Float',
+        :'nav_split_dividend_adjusted' => :'Float',
+        :'net_flows_daily' => :'Float',
+        :'net_flows_one_month' => :'Float',
+        :'net_flows_three_month' => :'Float',
+        :'net_flows_ytd' => :'Float',
+        :'net_flows_one_year' => :'Float',
+        :'net_flows_three_year' => :'Float',
+        :'net_flows_five_year' => :'Float',
+        :'net_flows_ten_year' => :'Float',
+        :'net_flows_1_year_prior' => :'Float',
+        :'net_flows_2_year_prior' => :'Float',
+        :'net_flows_3_year_prior' => :'Float',
+        :'net_flows_4_year_prior' => :'Float',
+        :'net_flows_5_year_prior' => :'Float',
+        :'net_flows_inception' => :'Float',
+        :'share_outstanding_unadjusted' => :'Float',
+        :'share_outstanding_split_adjusted' => :'Float',
+        :'total_net_assets' => :'Float'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'as_of_date')
+        self.as_of_date = attributes[:'as_of_date']
+      end
+
+      if attributes.has_key?(:'nav_return_daily')
+        self.nav_return_daily = attributes[:'nav_return_daily']
+      end
+
+      if attributes.has_key?(:'nav_return_one_month')
+        self.nav_return_one_month = attributes[:'nav_return_one_month']
+      end
+
+      if attributes.has_key?(:'nav_return_three_month')
+        self.nav_return_three_month = attributes[:'nav_return_three_month']
+      end
+
+      if attributes.has_key?(:'nav_return_ytd')
+        self.nav_return_ytd = attributes[:'nav_return_ytd']
+      end
+
+      if attributes.has_key?(:'nav_return_one_year')
+        self.nav_return_one_year = attributes[:'nav_return_one_year']
+      end
+
+      if attributes.has_key?(:'nav_return_1_year_prior')
+        self.nav_return_1_year_prior = attributes[:'nav_return_1_year_prior']
+      end
+
+      if attributes.has_key?(:'nav_return_2_year_prior')
+        self.nav_return_2_year_prior = attributes[:'nav_return_2_year_prior']
+      end
+
+      if attributes.has_key?(:'nav_return_3_year_prior')
+        self.nav_return_3_year_prior = attributes[:'nav_return_3_year_prior']
+      end
+
+      if attributes.has_key?(:'nav_return_4_year_prior')
+        self.nav_return_4_year_prior = attributes[:'nav_return_4_year_prior']
+      end
+
+      if attributes.has_key?(:'nav_return_5_year_prior')
+        self.nav_return_5_year_prior = attributes[:'nav_return_5_year_prior']
+      end
+
+      if attributes.has_key?(:'nav_annualized_return_three_year')
+        self.nav_annualized_return_three_year = attributes[:'nav_annualized_return_three_year']
+      end
+
+      if attributes.has_key?(:'nav_annualized_return_five_year')
+        self.nav_annualized_return_five_year = attributes[:'nav_annualized_return_five_year']
+      end
+
+      if attributes.has_key?(:'nav_annualized_return_ten_year')
+        self.nav_annualized_return_ten_year = attributes[:'nav_annualized_return_ten_year']
+      end
+
+      if attributes.has_key?(:'nav_annualized_return_inception')
+        self.nav_annualized_return_inception = attributes[:'nav_annualized_return_inception']
+      end
+
+      if attributes.has_key?(:'nav_unadjusted')
+        self.nav_unadjusted = attributes[:'nav_unadjusted']
+      end
+
+      if attributes.has_key?(:'nav_split_adjusted')
+        self.nav_split_adjusted = attributes[:'nav_split_adjusted']
+      end
+
+      if attributes.has_key?(:'nav_split_dividend_adjusted')
+        self.nav_split_dividend_adjusted = attributes[:'nav_split_dividend_adjusted']
+      end
+
+      if attributes.has_key?(:'net_flows_daily')
+        self.net_flows_daily = attributes[:'net_flows_daily']
+      end
+
+      if attributes.has_key?(:'net_flows_one_month')
+        self.net_flows_one_month = attributes[:'net_flows_one_month']
+      end
+
+      if attributes.has_key?(:'net_flows_three_month')
+        self.net_flows_three_month = attributes[:'net_flows_three_month']
+      end
+
+      if attributes.has_key?(:'net_flows_ytd')
+        self.net_flows_ytd = attributes[:'net_flows_ytd']
+      end
+
+      if attributes.has_key?(:'net_flows_one_year')
+        self.net_flows_one_year = attributes[:'net_flows_one_year']
+      end
+
+      if attributes.has_key?(:'net_flows_three_year')
+        self.net_flows_three_year = attributes[:'net_flows_three_year']
+      end
+
+      if attributes.has_key?(:'net_flows_five_year')
+        self.net_flows_five_year = attributes[:'net_flows_five_year']
+      end
+
+      if attributes.has_key?(:'net_flows_ten_year')
+        self.net_flows_ten_year = attributes[:'net_flows_ten_year']
+      end
+
+      if attributes.has_key?(:'net_flows_1_year_prior')
+        self.net_flows_1_year_prior = attributes[:'net_flows_1_year_prior']
+      end
+
+      if attributes.has_key?(:'net_flows_2_year_prior')
+        self.net_flows_2_year_prior = attributes[:'net_flows_2_year_prior']
+      end
+
+      if attributes.has_key?(:'net_flows_3_year_prior')
+        self.net_flows_3_year_prior = attributes[:'net_flows_3_year_prior']
+      end
+
+      if attributes.has_key?(:'net_flows_4_year_prior')
+        self.net_flows_4_year_prior = attributes[:'net_flows_4_year_prior']
+      end
+
+      if attributes.has_key?(:'net_flows_5_year_prior')
+        self.net_flows_5_year_prior = attributes[:'net_flows_5_year_prior']
+      end
+
+      if attributes.has_key?(:'net_flows_inception')
+        self.net_flows_inception = attributes[:'net_flows_inception']
+      end
+
+      if attributes.has_key?(:'share_outstanding_unadjusted')
+        self.share_outstanding_unadjusted = attributes[:'share_outstanding_unadjusted']
+      end
+
+      if attributes.has_key?(:'share_outstanding_split_adjusted')
+        self.share_outstanding_split_adjusted = attributes[:'share_outstanding_split_adjusted']
+      end
+
+      if attributes.has_key?(:'total_net_assets')
+        self.total_net_assets = attributes[:'total_net_assets']
+      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
+      invalid_properties = Array.new
+      return 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?
+      return 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 &&
+          as_of_date == o.as_of_date &&
+          nav_return_daily == o.nav_return_daily &&
+          nav_return_one_month == o.nav_return_one_month &&
+          nav_return_three_month == o.nav_return_three_month &&
+          nav_return_ytd == o.nav_return_ytd &&
+          nav_return_one_year == o.nav_return_one_year &&
+          nav_return_1_year_prior == o.nav_return_1_year_prior &&
+          nav_return_2_year_prior == o.nav_return_2_year_prior &&
+          nav_return_3_year_prior == o.nav_return_3_year_prior &&
+          nav_return_4_year_prior == o.nav_return_4_year_prior &&
+          nav_return_5_year_prior == o.nav_return_5_year_prior &&
+          nav_annualized_return_three_year == o.nav_annualized_return_three_year &&
+          nav_annualized_return_five_year == o.nav_annualized_return_five_year &&
+          nav_annualized_return_ten_year == o.nav_annualized_return_ten_year &&
+          nav_annualized_return_inception == o.nav_annualized_return_inception &&
+          nav_unadjusted == o.nav_unadjusted &&
+          nav_split_adjusted == o.nav_split_adjusted &&
+          nav_split_dividend_adjusted == o.nav_split_dividend_adjusted &&
+          net_flows_daily == o.net_flows_daily &&
+          net_flows_one_month == o.net_flows_one_month &&
+          net_flows_three_month == o.net_flows_three_month &&
+          net_flows_ytd == o.net_flows_ytd &&
+          net_flows_one_year == o.net_flows_one_year &&
+          net_flows_three_year == o.net_flows_three_year &&
+          net_flows_five_year == o.net_flows_five_year &&
+          net_flows_ten_year == o.net_flows_ten_year &&
+          net_flows_1_year_prior == o.net_flows_1_year_prior &&
+          net_flows_2_year_prior == o.net_flows_2_year_prior &&
+          net_flows_3_year_prior == o.net_flows_3_year_prior &&
+          net_flows_4_year_prior == o.net_flows_4_year_prior &&
+          net_flows_5_year_prior == o.net_flows_5_year_prior &&
+          net_flows_inception == o.net_flows_inception &&
+          share_outstanding_unadjusted == o.share_outstanding_unadjusted &&
+          share_outstanding_split_adjusted == o.share_outstanding_split_adjusted &&
+          total_net_assets == o.total_net_assets
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [as_of_date, nav_return_daily, nav_return_one_month, nav_return_three_month, nav_return_ytd, nav_return_one_year, nav_return_1_year_prior, nav_return_2_year_prior, nav_return_3_year_prior, nav_return_4_year_prior, nav_return_5_year_prior, nav_annualized_return_three_year, nav_annualized_return_five_year, nav_annualized_return_ten_year, nav_annualized_return_inception, nav_unadjusted, nav_split_adjusted, nav_split_dividend_adjusted, net_flows_daily, net_flows_one_month, net_flows_three_month, net_flows_ytd, net_flows_one_year, net_flows_three_year, net_flows_five_year, net_flows_ten_year, net_flows_1_year_prior, net_flows_2_year_prior, net_flows_3_year_prior, net_flows_4_year_prior, net_flows_5_year_prior, net_flows_inception, share_outstanding_unadjusted, share_outstanding_split_adjusted, total_net_assets].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.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
+        temp_model = Intrinio.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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