=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://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.23.0

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

=end

require 'date'

module Intrinio
  # Zacks earnings-per-share (EPS) growth rates from analysts for thousands of stocks.  Zacks storied research team aggregates and validates the estimates.  Each Growth Rate includes metadata about the corresponding Company.
  class ZacksEPSGrowthRate
    # The Zacks common exchange ticker
    attr_accessor :ticker

    # The company name
    attr_accessor :company_name

    # The Zacks industry group number
    attr_accessor :industry_group_number

    # The Zacks industry group name
    attr_accessor :industry_group_name

    # The current fiscal year
    attr_accessor :fiscal_year_0

    # The next fiscal year
    attr_accessor :fiscal_year_1

    # The fiscal year after the next fiscal year
    attr_accessor :fiscal_year_2

    # The company's last 5 year actual percentage earnings-per-share (EPS) growth rate
    attr_accessor :company_last_5_year_actual

    # The company's current fiscal year / last fiscal year percentage earnings-per-share (EPS) growth rate
    attr_accessor :company_fiscal_year_1_vs_fiscal_year_0

    # The company's next fiscal year / current fiscal year percentage earnings-per-share (EPS) growth rate
    attr_accessor :company_fiscal_year_2_vs_fiscal_year_1

    # The company's long term growth rate mean estimate
    attr_accessor :company_long_term_growth_mean

    # The company's forward (current fiscal year) price-to-earnings (P/E) ratio
    attr_accessor :company_fiscal_year_1_forward_price_to_earnings

    # The industry's last 5 year actual percentage earnings-per-share (EPS) growth rate
    attr_accessor :industry_last_5_year_actual

    # The industry's current fiscal year / last fiscal year percentage earnings-per-share (EPS) growth rate
    attr_accessor :industry_fiscal_year_1_vs_fiscal_year_0

    # The industry's next fiscal year / current fiscal year percentage earnings-per-share (EPS) growth rate
    attr_accessor :industry_fiscal_year_2_vs_fiscal_year_1

    # The industry's long term growth rate mean estimate
    attr_accessor :industry_long_term_growth_mean

    # The industry's forward (current fiscal year) price-to-earnings (P/E) ratio
    attr_accessor :industry_fiscal_year_1_forward_price_to_earnings

    # The S&P 500's last 5 year actual percentage earnings-per-share (EPS) growth rate
    attr_accessor :sp500_last_5_year_actual

    # The S&P 500's current fiscal year / last fiscal year percentage earnings-per-share (EPS) growth rate
    attr_accessor :sp500_fiscal_year_1_vs_fiscal_year_0

    # The S&P 500's next fiscal year / current fiscal year percentage earnings-per-share (EPS) growth rate
    attr_accessor :sp500_fiscal_year_2_vs_fiscal_year_1

    # The S&P 500's long term growth rate mean estimate
    attr_accessor :sp500_long_term_growth

    # The S&P 500's forward (current fiscal year) price-to-earnings (P/E) ratio
    attr_accessor :sp500_fiscal_year_1_price_to_earnings

    attr_accessor :company


    # Attribute mapping from ruby-style variable name to JSON key.
    def self.attribute_map
      {
        :'ticker' => :'ticker',
        :'company_name' => :'company_name',
        :'industry_group_number' => :'industry_group_number',
        :'industry_group_name' => :'industry_group_name',
        :'fiscal_year_0' => :'fiscal_year_0',
        :'fiscal_year_1' => :'fiscal_year_1',
        :'fiscal_year_2' => :'fiscal_year_2',
        :'company_last_5_year_actual' => :'company_last_5_year_actual',
        :'company_fiscal_year_1_vs_fiscal_year_0' => :'company_fiscal_year_1_vs_fiscal_year_0',
        :'company_fiscal_year_2_vs_fiscal_year_1' => :'company_fiscal_year_2_vs_fiscal_year_1',
        :'company_long_term_growth_mean' => :'company_long_term_growth_mean',
        :'company_fiscal_year_1_forward_price_to_earnings' => :'company_fiscal_year_1_forward_price_to_earnings',
        :'industry_last_5_year_actual' => :'industry_last_5_year_actual',
        :'industry_fiscal_year_1_vs_fiscal_year_0' => :'industry_fiscal_year_1_vs_fiscal_year_0',
        :'industry_fiscal_year_2_vs_fiscal_year_1' => :'industry_fiscal_year_2_vs_fiscal_year_1',
        :'industry_long_term_growth_mean' => :'industry_long_term_growth_mean',
        :'industry_fiscal_year_1_forward_price_to_earnings' => :'industry_fiscal_year_1_forward_price_to_earnings',
        :'sp500_last_5_year_actual' => :'sp500_last_5_year_actual',
        :'sp500_fiscal_year_1_vs_fiscal_year_0' => :'sp500_fiscal_year_1_vs_fiscal_year_0',
        :'sp500_fiscal_year_2_vs_fiscal_year_1' => :'sp500_fiscal_year_2_vs_fiscal_year_1',
        :'sp500_long_term_growth' => :'sp500_long_term_growth',
        :'sp500_fiscal_year_1_price_to_earnings' => :'sp500_fiscal_year_1_price_to_earnings',
        :'company' => :'company'
      }
    end

    # Attribute type mapping.
    def self.swagger_types
      {
        :'ticker' => :'String',
        :'company_name' => :'String',
        :'industry_group_number' => :'String',
        :'industry_group_name' => :'String',
        :'fiscal_year_0' => :'Integer',
        :'fiscal_year_1' => :'Integer',
        :'fiscal_year_2' => :'Integer',
        :'company_last_5_year_actual' => :'Float',
        :'company_fiscal_year_1_vs_fiscal_year_0' => :'Float',
        :'company_fiscal_year_2_vs_fiscal_year_1' => :'Float',
        :'company_long_term_growth_mean' => :'Float',
        :'company_fiscal_year_1_forward_price_to_earnings' => :'Float',
        :'industry_last_5_year_actual' => :'Float',
        :'industry_fiscal_year_1_vs_fiscal_year_0' => :'Float',
        :'industry_fiscal_year_2_vs_fiscal_year_1' => :'Float',
        :'industry_long_term_growth_mean' => :'Float',
        :'industry_fiscal_year_1_forward_price_to_earnings' => :'Float',
        :'sp500_last_5_year_actual' => :'Float',
        :'sp500_fiscal_year_1_vs_fiscal_year_0' => :'Float',
        :'sp500_fiscal_year_2_vs_fiscal_year_1' => :'Float',
        :'sp500_long_term_growth' => :'Float',
        :'sp500_fiscal_year_1_price_to_earnings' => :'Float',
        :'company' => :'CompanySummary'
      }
    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?(:'ticker')
        self.ticker = attributes[:'ticker']
      end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      if attributes.has_key?(:'company')
        self.company = attributes[:'company']
      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 &&
          ticker == o.ticker &&
          company_name == o.company_name &&
          industry_group_number == o.industry_group_number &&
          industry_group_name == o.industry_group_name &&
          fiscal_year_0 == o.fiscal_year_0 &&
          fiscal_year_1 == o.fiscal_year_1 &&
          fiscal_year_2 == o.fiscal_year_2 &&
          company_last_5_year_actual == o.company_last_5_year_actual &&
          company_fiscal_year_1_vs_fiscal_year_0 == o.company_fiscal_year_1_vs_fiscal_year_0 &&
          company_fiscal_year_2_vs_fiscal_year_1 == o.company_fiscal_year_2_vs_fiscal_year_1 &&
          company_long_term_growth_mean == o.company_long_term_growth_mean &&
          company_fiscal_year_1_forward_price_to_earnings == o.company_fiscal_year_1_forward_price_to_earnings &&
          industry_last_5_year_actual == o.industry_last_5_year_actual &&
          industry_fiscal_year_1_vs_fiscal_year_0 == o.industry_fiscal_year_1_vs_fiscal_year_0 &&
          industry_fiscal_year_2_vs_fiscal_year_1 == o.industry_fiscal_year_2_vs_fiscal_year_1 &&
          industry_long_term_growth_mean == o.industry_long_term_growth_mean &&
          industry_fiscal_year_1_forward_price_to_earnings == o.industry_fiscal_year_1_forward_price_to_earnings &&
          sp500_last_5_year_actual == o.sp500_last_5_year_actual &&
          sp500_fiscal_year_1_vs_fiscal_year_0 == o.sp500_fiscal_year_1_vs_fiscal_year_0 &&
          sp500_fiscal_year_2_vs_fiscal_year_1 == o.sp500_fiscal_year_2_vs_fiscal_year_1 &&
          sp500_long_term_growth == o.sp500_long_term_growth &&
          sp500_fiscal_year_1_price_to_earnings == o.sp500_fiscal_year_1_price_to_earnings &&
          company == o.company
    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
      [ticker, company_name, industry_group_number, industry_group_name, fiscal_year_0, fiscal_year_1, fiscal_year_2, company_last_5_year_actual, company_fiscal_year_1_vs_fiscal_year_0, company_fiscal_year_2_vs_fiscal_year_1, company_long_term_growth_mean, company_fiscal_year_1_forward_price_to_earnings, industry_last_5_year_actual, industry_fiscal_year_1_vs_fiscal_year_0, industry_fiscal_year_2_vs_fiscal_year_1, industry_long_term_growth_mean, industry_fiscal_year_1_forward_price_to_earnings, sp500_last_5_year_actual, sp500_fiscal_year_1_vs_fiscal_year_0, sp500_fiscal_year_2_vs_fiscal_year_1, sp500_long_term_growth, sp500_fiscal_year_1_price_to_earnings, company].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