=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.34.0

Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset

=end

require 'date'

module Intrinio
  # A dividend record for the identifier
  class DividendRecord
    # Amount of dividend in US dollars
    attr_accessor :ex_dividend

    # The 3-digit currency code the dividend amount was reported in
    attr_accessor :currency

    # Date dividend was announced
    attr_accessor :announcement_date

    # Date before which holders-of-record will receive the dividend
    attr_accessor :record_date

    # Date the divdiend was paid
    attr_accessor :pay_date

    # Identifies payment frequency of announced dividend
    attr_accessor :frequency

    # Status of the dividend
    attr_accessor :status

    # The forward dividend yield
    attr_accessor :forward_yield

    # The forward dividend rate
    attr_accessor :forward_rate

    # The last reported day the stock starts trading without the value of its next dividend payment
    attr_accessor :last_ex_dividend_date

    attr_accessor :security

    class EnumAttributeValidator
      attr_reader :datatype
      attr_reader :allowable_values

      def initialize(datatype, allowable_values)
        @allowable_values = allowable_values.map do |value|
          case datatype.to_s
          when /Integer/i
            value.to_i
          when /Float/i
            value.to_f
          else
            value
          end
        end
      end

      def valid?(value)
        !value || allowable_values.include?(value)
      end
    end

    # Attribute mapping from ruby-style variable name to JSON key.
    def self.attribute_map
      {
        :'ex_dividend' => :'ex_dividend',
        :'currency' => :'currency',
        :'announcement_date' => :'announcement_date',
        :'record_date' => :'record_date',
        :'pay_date' => :'pay_date',
        :'frequency' => :'frequency',
        :'status' => :'status',
        :'forward_yield' => :'forward_yield',
        :'forward_rate' => :'forward_rate',
        :'last_ex_dividend_date' => :'last_ex_dividend_date',
        :'security' => :'security'
      }
    end

    # Attribute type mapping.
    def self.swagger_types
      {
        :'ex_dividend' => :'Float',
        :'currency' => :'String',
        :'announcement_date' => :'Date',
        :'record_date' => :'Date',
        :'pay_date' => :'Date',
        :'frequency' => :'String',
        :'status' => :'String',
        :'forward_yield' => :'Float',
        :'forward_rate' => :'Float',
        :'last_ex_dividend_date' => :'Date',
        :'security' => :'SecuritySummary'
      }
    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?(:'ex_dividend')
        self.ex_dividend = attributes[:'ex_dividend']
      end

      if attributes.has_key?(:'currency')
        self.currency = attributes[:'currency']
      end

      if attributes.has_key?(:'announcement_date')
        self.announcement_date = attributes[:'announcement_date']
      end

      if attributes.has_key?(:'record_date')
        self.record_date = attributes[:'record_date']
      end

      if attributes.has_key?(:'pay_date')
        self.pay_date = attributes[:'pay_date']
      end

      if attributes.has_key?(:'frequency')
        self.frequency = attributes[:'frequency']
      end

      if attributes.has_key?(:'status')
        self.status = attributes[:'status']
      end

      if attributes.has_key?(:'forward_yield')
        self.forward_yield = attributes[:'forward_yield']
      end

      if attributes.has_key?(:'forward_rate')
        self.forward_rate = attributes[:'forward_rate']
      end

      if attributes.has_key?(:'last_ex_dividend_date')
        self.last_ex_dividend_date = attributes[:'last_ex_dividend_date']
      end

      if attributes.has_key?(:'security')
        self.security = attributes[:'security']
      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?
      status_validator = EnumAttributeValidator.new('String', ["P", "X", "S", "R"])
      return false unless status_validator.valid?(@status)
      return true
    end

    # Custom attribute writer method checking allowed values (enum).
    # @param [Object] status Object to be assigned
    def status=(status)
      validator = EnumAttributeValidator.new('String', ["P", "X", "S", "R"])
      unless validator.valid?(status)
        fail ArgumentError, "invalid value for 'status', must be one of #{validator.allowable_values}."
      end
      @status = status
    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 &&
          ex_dividend == o.ex_dividend &&
          currency == o.currency &&
          announcement_date == o.announcement_date &&
          record_date == o.record_date &&
          pay_date == o.pay_date &&
          frequency == o.frequency &&
          status == o.status &&
          forward_yield == o.forward_yield &&
          forward_rate == o.forward_rate &&
          last_ex_dividend_date == o.last_ex_dividend_date &&
          security == o.security
    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
      [ex_dividend, currency, announcement_date, record_date, pay_date, frequency, status, forward_yield, forward_rate, last_ex_dividend_date, security].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