mencoro 1.0.0

data/lib/mencoro/models/keyword_listing_resource.rb

@@ -0,0 +1,798 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  # One keyword of a project, its variants and its metrics over the requested window
+  class KeywordListingResource < ApiModelBase
+    # The keyword as a human types it, picked from the variants for display.
+    attr_accessor :keyword
+
+    # The grouping key: the keyword lower-cased and unaccented. Unique within the project, and the stable way to match a row across pages.
+    attr_accessor :keyword_normalized
+
+    # Tracked queries behind this row that the current filters selected.
+    attr_accessor :variant_count
+
+    # Ids of those tracked queries. Accepted by the single tracked-query operation.
+    attr_accessor :variant_ids
+
+    # Distinct engines across the variants, not a single engine.
+    attr_accessor :engines
+
+    # Distinct ISO-3166 alpha-2 countries across the variants.
+    attr_accessor :countries
+
+    # Distinct keyword clusters the variants belong to. Empty when none of them is clustered.
+    attr_accessor :query_cluster_ids
+
+    # Whether at least one variant belongs to no cluster.
+    attr_accessor :has_unclustered_variant
+
+    # \"mixed\" when the variants disagree; otherwise the one status they share.
+    attr_accessor :status_summary
+
+    # Distinct statuses across the variants.
+    attr_accessor :statuses
+
+    # Distinct check frequencies across the variants.
+    attr_accessor :check_frequencies
+
+    # Distinct pass counts across the variants. A pass is one budget unit per check.
+    attr_accessor :n_passes_values
+
+    # The most recent completed check across the variants. Null when none has ever completed — not a check that found nothing.
+    attr_accessor :last_checked_at
+
+    # Average position in traditional search over the window. 1-based, LOWER is better.
+    attr_accessor :avg_serp_position
+
+    # Signed improvement in avgSerpPosition against the previous window. Positive is better.
+    attr_accessor :trend_serp
+
+    # Average position in shopping results over the window. 1-based, LOWER is better.
+    attr_accessor :avg_shopping_position
+
+    # Signed improvement in avgShoppingPosition. Positive is better.
+    attr_accessor :trend_shopping
+
+    # Average position of the brand mention inside the AI answer. 1-based, LOWER is better.
+    attr_accessor :avg_mention_position
+
+    # Signed improvement in avgMentionPosition. Positive is better.
+    attr_accessor :trend_mention
+
+    # Average position of a cited link to the brand. 1-based, LOWER is better.
+    attr_accessor :avg_link_position
+
+    # Signed improvement in avgLinkPosition. Positive is better.
+    attr_accessor :trend_link
+
+    # Day-to-day spread of the mention position (a standard deviation): LOWER means steadier.
+    attr_accessor :mention_position_stability
+
+    # Signed improvement in mentionPositionStability. Positive means steadier than the previous window.
+    attr_accessor :trend_stability
+
+    # 0-100 weighted sentiment score of the mentions; HIGHER is better. Null when there were no mentions to score.
+    attr_accessor :positivity_index
+
+    # Signed improvement in positivityIndex. Positive is better.
+    attr_accessor :trend_positivity
+
+    # 0-100 share of AI captures in the window that mentioned the brand; HIGHER is better.
+    attr_accessor :mention_rate
+
+    # Signed improvement in mentionRate. Positive is better.
+    attr_accessor :trend_mention_rate
+
+    # 0-100 share of traditional-search captures in the window that ranked the brand; HIGHER is better.
+    attr_accessor :serp_rate
+
+    # Signed improvement in serpRate. Positive is better.
+    attr_accessor :trend_serp_rate
+
+    # 0-100 share of the weighted AI mentions against every tracked brand; HIGHER is better.
+    attr_accessor :share_of_voice
+
+    # Signed improvement in shareOfVoice. Positive is better.
+    attr_accessor :trend_share_of_voice
+
+    # Positive brand mentions counted in the window. Zero here really is zero.
+    attr_accessor :sentiment_positive
+
+    # Neutral brand mentions counted in the window.
+    attr_accessor :sentiment_neutral
+
+    # Negative brand mentions counted in the window.
+    attr_accessor :sentiment_negative
+
+    # Mentions per AI engine per day with a capture, over the window. Not a total: the window total is not part of this contract.
+    attr_accessor :avg_mention_count
+
+    attr_accessor :mention_type_counts
+
+    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
+      {
+        :'keyword' => :'keyword',
+        :'keyword_normalized' => :'keywordNormalized',
+        :'variant_count' => :'variantCount',
+        :'variant_ids' => :'variantIds',
+        :'engines' => :'engines',
+        :'countries' => :'countries',
+        :'query_cluster_ids' => :'queryClusterIds',
+        :'has_unclustered_variant' => :'hasUnclusteredVariant',
+        :'status_summary' => :'statusSummary',
+        :'statuses' => :'statuses',
+        :'check_frequencies' => :'checkFrequencies',
+        :'n_passes_values' => :'nPassesValues',
+        :'last_checked_at' => :'lastCheckedAt',
+        :'avg_serp_position' => :'avgSerpPosition',
+        :'trend_serp' => :'trendSerp',
+        :'avg_shopping_position' => :'avgShoppingPosition',
+        :'trend_shopping' => :'trendShopping',
+        :'avg_mention_position' => :'avgMentionPosition',
+        :'trend_mention' => :'trendMention',
+        :'avg_link_position' => :'avgLinkPosition',
+        :'trend_link' => :'trendLink',
+        :'mention_position_stability' => :'mentionPositionStability',
+        :'trend_stability' => :'trendStability',
+        :'positivity_index' => :'positivityIndex',
+        :'trend_positivity' => :'trendPositivity',
+        :'mention_rate' => :'mentionRate',
+        :'trend_mention_rate' => :'trendMentionRate',
+        :'serp_rate' => :'serpRate',
+        :'trend_serp_rate' => :'trendSerpRate',
+        :'share_of_voice' => :'shareOfVoice',
+        :'trend_share_of_voice' => :'trendShareOfVoice',
+        :'sentiment_positive' => :'sentimentPositive',
+        :'sentiment_neutral' => :'sentimentNeutral',
+        :'sentiment_negative' => :'sentimentNegative',
+        :'avg_mention_count' => :'avgMentionCount',
+        :'mention_type_counts' => :'mentionTypeCounts'
+      }
+    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
+      {
+        :'keyword' => :'String',
+        :'keyword_normalized' => :'String',
+        :'variant_count' => :'Integer',
+        :'variant_ids' => :'Array<String>',
+        :'engines' => :'Array<String>',
+        :'countries' => :'Array<String>',
+        :'query_cluster_ids' => :'Array<String>',
+        :'has_unclustered_variant' => :'Boolean',
+        :'status_summary' => :'String',
+        :'statuses' => :'Array<String>',
+        :'check_frequencies' => :'Array<String>',
+        :'n_passes_values' => :'Array<Integer>',
+        :'last_checked_at' => :'Time',
+        :'avg_serp_position' => :'Float',
+        :'trend_serp' => :'Float',
+        :'avg_shopping_position' => :'Float',
+        :'trend_shopping' => :'Float',
+        :'avg_mention_position' => :'Float',
+        :'trend_mention' => :'Float',
+        :'avg_link_position' => :'Float',
+        :'trend_link' => :'Float',
+        :'mention_position_stability' => :'Float',
+        :'trend_stability' => :'Float',
+        :'positivity_index' => :'Integer',
+        :'trend_positivity' => :'Integer',
+        :'mention_rate' => :'Integer',
+        :'trend_mention_rate' => :'Integer',
+        :'serp_rate' => :'Integer',
+        :'trend_serp_rate' => :'Integer',
+        :'share_of_voice' => :'Float',
+        :'trend_share_of_voice' => :'Float',
+        :'sentiment_positive' => :'Integer',
+        :'sentiment_neutral' => :'Integer',
+        :'sentiment_negative' => :'Integer',
+        :'avg_mention_count' => :'Float',
+        :'mention_type_counts' => :'KeywordListingResourceMentionTypeCounts'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'last_checked_at',
+        :'avg_serp_position',
+        :'trend_serp',
+        :'avg_shopping_position',
+        :'trend_shopping',
+        :'avg_mention_position',
+        :'trend_mention',
+        :'avg_link_position',
+        :'trend_link',
+        :'mention_position_stability',
+        :'trend_stability',
+        :'positivity_index',
+        :'trend_positivity',
+        :'mention_rate',
+        :'trend_mention_rate',
+        :'serp_rate',
+        :'trend_serp_rate',
+        :'share_of_voice',
+        :'trend_share_of_voice',
+        :'avg_mention_count',
+      ])
+    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 `Mencoro::KeywordListingResource` 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 `Mencoro::KeywordListingResource`. 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?(:'keyword')
+        self.keyword = attributes[:'keyword']
+      else
+        self.keyword = nil
+      end
+
+      if attributes.key?(:'keyword_normalized')
+        self.keyword_normalized = attributes[:'keyword_normalized']
+      else
+        self.keyword_normalized = nil
+      end
+
+      if attributes.key?(:'variant_count')
+        self.variant_count = attributes[:'variant_count']
+      else
+        self.variant_count = nil
+      end
+
+      if attributes.key?(:'variant_ids')
+        if (value = attributes[:'variant_ids']).is_a?(Array)
+          self.variant_ids = value
+        end
+      else
+        self.variant_ids = nil
+      end
+
+      if attributes.key?(:'engines')
+        if (value = attributes[:'engines']).is_a?(Array)
+          self.engines = value
+        end
+      else
+        self.engines = nil
+      end
+
+      if attributes.key?(:'countries')
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      else
+        self.countries = nil
+      end
+
+      if attributes.key?(:'query_cluster_ids')
+        if (value = attributes[:'query_cluster_ids']).is_a?(Array)
+          self.query_cluster_ids = value
+        end
+      else
+        self.query_cluster_ids = nil
+      end
+
+      if attributes.key?(:'has_unclustered_variant')
+        self.has_unclustered_variant = attributes[:'has_unclustered_variant']
+      else
+        self.has_unclustered_variant = nil
+      end
+
+      if attributes.key?(:'status_summary')
+        self.status_summary = attributes[:'status_summary']
+      else
+        self.status_summary = nil
+      end
+
+      if attributes.key?(:'statuses')
+        if (value = attributes[:'statuses']).is_a?(Array)
+          self.statuses = value
+        end
+      else
+        self.statuses = nil
+      end
+
+      if attributes.key?(:'check_frequencies')
+        if (value = attributes[:'check_frequencies']).is_a?(Array)
+          self.check_frequencies = value
+        end
+      else
+        self.check_frequencies = nil
+      end
+
+      if attributes.key?(:'n_passes_values')
+        if (value = attributes[:'n_passes_values']).is_a?(Array)
+          self.n_passes_values = value
+        end
+      else
+        self.n_passes_values = nil
+      end
+
+      if attributes.key?(:'last_checked_at')
+        self.last_checked_at = attributes[:'last_checked_at']
+      end
+
+      if attributes.key?(:'avg_serp_position')
+        self.avg_serp_position = attributes[:'avg_serp_position']
+      end
+
+      if attributes.key?(:'trend_serp')
+        self.trend_serp = attributes[:'trend_serp']
+      end
+
+      if attributes.key?(:'avg_shopping_position')
+        self.avg_shopping_position = attributes[:'avg_shopping_position']
+      end
+
+      if attributes.key?(:'trend_shopping')
+        self.trend_shopping = attributes[:'trend_shopping']
+      end
+
+      if attributes.key?(:'avg_mention_position')
+        self.avg_mention_position = attributes[:'avg_mention_position']
+      end
+
+      if attributes.key?(:'trend_mention')
+        self.trend_mention = attributes[:'trend_mention']
+      end
+
+      if attributes.key?(:'avg_link_position')
+        self.avg_link_position = attributes[:'avg_link_position']
+      end
+
+      if attributes.key?(:'trend_link')
+        self.trend_link = attributes[:'trend_link']
+      end
+
+      if attributes.key?(:'mention_position_stability')
+        self.mention_position_stability = attributes[:'mention_position_stability']
+      end
+
+      if attributes.key?(:'trend_stability')
+        self.trend_stability = attributes[:'trend_stability']
+      end
+
+      if attributes.key?(:'positivity_index')
+        self.positivity_index = attributes[:'positivity_index']
+      end
+
+      if attributes.key?(:'trend_positivity')
+        self.trend_positivity = attributes[:'trend_positivity']
+      end
+
+      if attributes.key?(:'mention_rate')
+        self.mention_rate = attributes[:'mention_rate']
+      end
+
+      if attributes.key?(:'trend_mention_rate')
+        self.trend_mention_rate = attributes[:'trend_mention_rate']
+      end
+
+      if attributes.key?(:'serp_rate')
+        self.serp_rate = attributes[:'serp_rate']
+      end
+
+      if attributes.key?(:'trend_serp_rate')
+        self.trend_serp_rate = attributes[:'trend_serp_rate']
+      end
+
+      if attributes.key?(:'share_of_voice')
+        self.share_of_voice = attributes[:'share_of_voice']
+      end
+
+      if attributes.key?(:'trend_share_of_voice')
+        self.trend_share_of_voice = attributes[:'trend_share_of_voice']
+      end
+
+      if attributes.key?(:'sentiment_positive')
+        self.sentiment_positive = attributes[:'sentiment_positive']
+      else
+        self.sentiment_positive = nil
+      end
+
+      if attributes.key?(:'sentiment_neutral')
+        self.sentiment_neutral = attributes[:'sentiment_neutral']
+      else
+        self.sentiment_neutral = nil
+      end
+
+      if attributes.key?(:'sentiment_negative')
+        self.sentiment_negative = attributes[:'sentiment_negative']
+      else
+        self.sentiment_negative = nil
+      end
+
+      if attributes.key?(:'avg_mention_count')
+        self.avg_mention_count = attributes[:'avg_mention_count']
+      end
+
+      if attributes.key?(:'mention_type_counts')
+        self.mention_type_counts = attributes[:'mention_type_counts']
+      else
+        self.mention_type_counts = nil
+      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 @keyword.nil?
+        invalid_properties.push('invalid value for "keyword", keyword cannot be nil.')
+      end
+
+      if @keyword_normalized.nil?
+        invalid_properties.push('invalid value for "keyword_normalized", keyword_normalized cannot be nil.')
+      end
+
+      if @variant_count.nil?
+        invalid_properties.push('invalid value for "variant_count", variant_count cannot be nil.')
+      end
+
+      if @variant_ids.nil?
+        invalid_properties.push('invalid value for "variant_ids", variant_ids cannot be nil.')
+      end
+
+      if @engines.nil?
+        invalid_properties.push('invalid value for "engines", engines cannot be nil.')
+      end
+
+      if @countries.nil?
+        invalid_properties.push('invalid value for "countries", countries cannot be nil.')
+      end
+
+      if @query_cluster_ids.nil?
+        invalid_properties.push('invalid value for "query_cluster_ids", query_cluster_ids cannot be nil.')
+      end
+
+      if @has_unclustered_variant.nil?
+        invalid_properties.push('invalid value for "has_unclustered_variant", has_unclustered_variant cannot be nil.')
+      end
+
+      if @status_summary.nil?
+        invalid_properties.push('invalid value for "status_summary", status_summary cannot be nil.')
+      end
+
+      if @statuses.nil?
+        invalid_properties.push('invalid value for "statuses", statuses cannot be nil.')
+      end
+
+      if @check_frequencies.nil?
+        invalid_properties.push('invalid value for "check_frequencies", check_frequencies cannot be nil.')
+      end
+
+      if @n_passes_values.nil?
+        invalid_properties.push('invalid value for "n_passes_values", n_passes_values cannot be nil.')
+      end
+
+      if @sentiment_positive.nil?
+        invalid_properties.push('invalid value for "sentiment_positive", sentiment_positive cannot be nil.')
+      end
+
+      if @sentiment_neutral.nil?
+        invalid_properties.push('invalid value for "sentiment_neutral", sentiment_neutral cannot be nil.')
+      end
+
+      if @sentiment_negative.nil?
+        invalid_properties.push('invalid value for "sentiment_negative", sentiment_negative cannot be nil.')
+      end
+
+      if @mention_type_counts.nil?
+        invalid_properties.push('invalid value for "mention_type_counts", mention_type_counts 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 @keyword.nil?
+      return false if @keyword_normalized.nil?
+      return false if @variant_count.nil?
+      return false if @variant_ids.nil?
+      return false if @engines.nil?
+      return false if @countries.nil?
+      return false if @query_cluster_ids.nil?
+      return false if @has_unclustered_variant.nil?
+      return false if @status_summary.nil?
+      status_summary_validator = EnumAttributeValidator.new('String', ["active", "paused", "mixed"])
+      return false unless status_summary_validator.valid?(@status_summary)
+      return false if @statuses.nil?
+      return false if @check_frequencies.nil?
+      return false if @n_passes_values.nil?
+      return false if @sentiment_positive.nil?
+      return false if @sentiment_neutral.nil?
+      return false if @sentiment_negative.nil?
+      return false if @mention_type_counts.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] keyword Value to be assigned
+    def keyword=(keyword)
+      if keyword.nil?
+        fail ArgumentError, 'keyword cannot be nil'
+      end
+
+      @keyword = keyword
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] keyword_normalized Value to be assigned
+    def keyword_normalized=(keyword_normalized)
+      if keyword_normalized.nil?
+        fail ArgumentError, 'keyword_normalized cannot be nil'
+      end
+
+      @keyword_normalized = keyword_normalized
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] variant_count Value to be assigned
+    def variant_count=(variant_count)
+      if variant_count.nil?
+        fail ArgumentError, 'variant_count cannot be nil'
+      end
+
+      @variant_count = variant_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] variant_ids Value to be assigned
+    def variant_ids=(variant_ids)
+      if variant_ids.nil?
+        fail ArgumentError, 'variant_ids cannot be nil'
+      end
+
+      @variant_ids = variant_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] countries Value to be assigned
+    def countries=(countries)
+      if countries.nil?
+        fail ArgumentError, 'countries cannot be nil'
+      end
+
+      @countries = countries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] query_cluster_ids Value to be assigned
+    def query_cluster_ids=(query_cluster_ids)
+      if query_cluster_ids.nil?
+        fail ArgumentError, 'query_cluster_ids cannot be nil'
+      end
+
+      @query_cluster_ids = query_cluster_ids
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] has_unclustered_variant Value to be assigned
+    def has_unclustered_variant=(has_unclustered_variant)
+      if has_unclustered_variant.nil?
+        fail ArgumentError, 'has_unclustered_variant cannot be nil'
+      end
+
+      @has_unclustered_variant = has_unclustered_variant
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status_summary Object to be assigned
+    def status_summary=(status_summary)
+      validator = EnumAttributeValidator.new('String', ["active", "paused", "mixed"])
+      unless validator.valid?(status_summary)
+        fail ArgumentError, "invalid value for \"status_summary\", must be one of #{validator.allowable_values}."
+      end
+      @status_summary = status_summary
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] n_passes_values Value to be assigned
+    def n_passes_values=(n_passes_values)
+      if n_passes_values.nil?
+        fail ArgumentError, 'n_passes_values cannot be nil'
+      end
+
+      @n_passes_values = n_passes_values
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sentiment_positive Value to be assigned
+    def sentiment_positive=(sentiment_positive)
+      if sentiment_positive.nil?
+        fail ArgumentError, 'sentiment_positive cannot be nil'
+      end
+
+      @sentiment_positive = sentiment_positive
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sentiment_neutral Value to be assigned
+    def sentiment_neutral=(sentiment_neutral)
+      if sentiment_neutral.nil?
+        fail ArgumentError, 'sentiment_neutral cannot be nil'
+      end
+
+      @sentiment_neutral = sentiment_neutral
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sentiment_negative Value to be assigned
+    def sentiment_negative=(sentiment_negative)
+      if sentiment_negative.nil?
+        fail ArgumentError, 'sentiment_negative cannot be nil'
+      end
+
+      @sentiment_negative = sentiment_negative
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mention_type_counts Value to be assigned
+    def mention_type_counts=(mention_type_counts)
+      if mention_type_counts.nil?
+        fail ArgumentError, 'mention_type_counts cannot be nil'
+      end
+
+      @mention_type_counts = mention_type_counts
+    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 &&
+          keyword == o.keyword &&
+          keyword_normalized == o.keyword_normalized &&
+          variant_count == o.variant_count &&
+          variant_ids == o.variant_ids &&
+          engines == o.engines &&
+          countries == o.countries &&
+          query_cluster_ids == o.query_cluster_ids &&
+          has_unclustered_variant == o.has_unclustered_variant &&
+          status_summary == o.status_summary &&
+          statuses == o.statuses &&
+          check_frequencies == o.check_frequencies &&
+          n_passes_values == o.n_passes_values &&
+          last_checked_at == o.last_checked_at &&
+          avg_serp_position == o.avg_serp_position &&
+          trend_serp == o.trend_serp &&
+          avg_shopping_position == o.avg_shopping_position &&
+          trend_shopping == o.trend_shopping &&
+          avg_mention_position == o.avg_mention_position &&
+          trend_mention == o.trend_mention &&
+          avg_link_position == o.avg_link_position &&
+          trend_link == o.trend_link &&
+          mention_position_stability == o.mention_position_stability &&
+          trend_stability == o.trend_stability &&
+          positivity_index == o.positivity_index &&
+          trend_positivity == o.trend_positivity &&
+          mention_rate == o.mention_rate &&
+          trend_mention_rate == o.trend_mention_rate &&
+          serp_rate == o.serp_rate &&
+          trend_serp_rate == o.trend_serp_rate &&
+          share_of_voice == o.share_of_voice &&
+          trend_share_of_voice == o.trend_share_of_voice &&
+          sentiment_positive == o.sentiment_positive &&
+          sentiment_neutral == o.sentiment_neutral &&
+          sentiment_negative == o.sentiment_negative &&
+          avg_mention_count == o.avg_mention_count &&
+          mention_type_counts == o.mention_type_counts
+    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
+      [keyword, keyword_normalized, variant_count, variant_ids, engines, countries, query_cluster_ids, has_unclustered_variant, status_summary, statuses, check_frequencies, n_passes_values, last_checked_at, avg_serp_position, trend_serp, avg_shopping_position, trend_shopping, avg_mention_position, trend_mention, avg_link_position, trend_link, mention_position_stability, trend_stability, positivity_index, trend_positivity, mention_rate, trend_mention_rate, serp_rate, trend_serp_rate, share_of_voice, trend_share_of_voice, sentiment_positive, sentiment_neutral, sentiment_negative, avg_mention_count, mention_type_counts].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
+
+    # 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
+
+  end
+
+end