mencoro 1.0.1 → 2.0.0

data/lib/mencoro/models/tracked_query_mover_row.rb

@@ -0,0 +1,492 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
+
+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
+  class TrackedQueryMoverRow < ApiModelBase
+    attr_accessor :tracked_query_id
+
+    attr_accessor :query_text
+
+    attr_accessor :engine
+
+    attr_accessor :country
+
+    attr_accessor :avg_serp_position
+
+    attr_accessor :trend_serp
+
+    attr_accessor :avg_shopping_position
+
+    attr_accessor :trend_shopping
+
+    attr_accessor :avg_mention_position
+
+    attr_accessor :trend_mention
+
+    attr_accessor :avg_link_position
+
+    attr_accessor :trend_link
+
+    attr_accessor :share_of_voice
+
+    attr_accessor :trend_share_of_voice
+
+    attr_accessor :positivity_index
+
+    attr_accessor :trend_positivity
+
+    attr_accessor :sentiment_positive
+
+    attr_accessor :sentiment_neutral
+
+    attr_accessor :sentiment_negative
+
+    attr_accessor :mention_count
+
+    attr_accessor :mention_type_counts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tracked_query_id' => :'trackedQueryId',
+        :'query_text' => :'queryText',
+        :'engine' => :'engine',
+        :'country' => :'country',
+        :'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',
+        :'share_of_voice' => :'shareOfVoice',
+        :'trend_share_of_voice' => :'trendShareOfVoice',
+        :'positivity_index' => :'positivityIndex',
+        :'trend_positivity' => :'trendPositivity',
+        :'sentiment_positive' => :'sentimentPositive',
+        :'sentiment_neutral' => :'sentimentNeutral',
+        :'sentiment_negative' => :'sentimentNegative',
+        :'mention_count' => :'mentionCount',
+        :'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
+      {
+        :'tracked_query_id' => :'String',
+        :'query_text' => :'String',
+        :'engine' => :'String',
+        :'country' => :'String',
+        :'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',
+        :'share_of_voice' => :'Float',
+        :'trend_share_of_voice' => :'Float',
+        :'positivity_index' => :'Integer',
+        :'trend_positivity' => :'Integer',
+        :'sentiment_positive' => :'Integer',
+        :'sentiment_neutral' => :'Integer',
+        :'sentiment_negative' => :'Integer',
+        :'mention_count' => :'Integer',
+        :'mention_type_counts' => :'MentionTypeCounts'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'avg_serp_position',
+        :'trend_serp',
+        :'avg_shopping_position',
+        :'trend_shopping',
+        :'avg_mention_position',
+        :'trend_mention',
+        :'avg_link_position',
+        :'trend_link',
+        :'share_of_voice',
+        :'trend_share_of_voice',
+        :'positivity_index',
+        :'trend_positivity',
+      ])
+    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::TrackedQueryMoverRow` 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::TrackedQueryMoverRow`. 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?(:'tracked_query_id')
+        self.tracked_query_id = attributes[:'tracked_query_id']
+      else
+        self.tracked_query_id = nil
+      end
+
+      if attributes.key?(:'query_text')
+        self.query_text = attributes[:'query_text']
+      else
+        self.query_text = nil
+      end
+
+      if attributes.key?(:'engine')
+        self.engine = attributes[:'engine']
+      else
+        self.engine = nil
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      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?(:'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?(:'positivity_index')
+        self.positivity_index = attributes[:'positivity_index']
+      end
+
+      if attributes.key?(:'trend_positivity')
+        self.trend_positivity = attributes[:'trend_positivity']
+      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?(:'mention_count')
+        self.mention_count = attributes[:'mention_count']
+      else
+        self.mention_count = nil
+      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 @tracked_query_id.nil?
+        invalid_properties.push('invalid value for "tracked_query_id", tracked_query_id cannot be nil.')
+      end
+
+      if @query_text.nil?
+        invalid_properties.push('invalid value for "query_text", query_text cannot be nil.')
+      end
+
+      if @engine.nil?
+        invalid_properties.push('invalid value for "engine", engine cannot be nil.')
+      end
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country 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_count.nil?
+        invalid_properties.push('invalid value for "mention_count", mention_count 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 @tracked_query_id.nil?
+      return false if @query_text.nil?
+      return false if @engine.nil?
+      return false if @country.nil?
+      return false if @sentiment_positive.nil?
+      return false if @sentiment_neutral.nil?
+      return false if @sentiment_negative.nil?
+      return false if @mention_count.nil?
+      return false if @mention_type_counts.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracked_query_id Value to be assigned
+    def tracked_query_id=(tracked_query_id)
+      if tracked_query_id.nil?
+        fail ArgumentError, 'tracked_query_id cannot be nil'
+      end
+
+      @tracked_query_id = tracked_query_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] query_text Value to be assigned
+    def query_text=(query_text)
+      if query_text.nil?
+        fail ArgumentError, 'query_text cannot be nil'
+      end
+
+      @query_text = query_text
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] engine Value to be assigned
+    def engine=(engine)
+      if engine.nil?
+        fail ArgumentError, 'engine cannot be nil'
+      end
+
+      @engine = engine
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, 'country cannot be nil'
+      end
+
+      @country = country
+    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_count Value to be assigned
+    def mention_count=(mention_count)
+      if mention_count.nil?
+        fail ArgumentError, 'mention_count cannot be nil'
+      end
+
+      @mention_count = mention_count
+    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 &&
+          tracked_query_id == o.tracked_query_id &&
+          query_text == o.query_text &&
+          engine == o.engine &&
+          country == o.country &&
+          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 &&
+          share_of_voice == o.share_of_voice &&
+          trend_share_of_voice == o.trend_share_of_voice &&
+          positivity_index == o.positivity_index &&
+          trend_positivity == o.trend_positivity &&
+          sentiment_positive == o.sentiment_positive &&
+          sentiment_neutral == o.sentiment_neutral &&
+          sentiment_negative == o.sentiment_negative &&
+          mention_count == o.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
+      [tracked_query_id, query_text, engine, country, avg_serp_position, trend_serp, avg_shopping_position, trend_shopping, avg_mention_position, trend_mention, avg_link_position, trend_link, share_of_voice, trend_share_of_voice, positivity_index, trend_positivity, sentiment_positive, sentiment_neutral, sentiment_negative, 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

data/lib/mencoro/models/tracked_query_movers_response.rb

@@ -0,0 +1,202 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
+
+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
+  class TrackedQueryMoversResponse < ApiModelBase
+    attr_accessor :rows
+
+    attr_accessor :total
+
+    attr_accessor :data_dirty_since
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'rows' => :'rows',
+        :'total' => :'total',
+        :'data_dirty_since' => :'dataDirtySince'
+      }
+    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
+      {
+        :'rows' => :'Array<TrackedQueryMoverRow>',
+        :'total' => :'Integer',
+        :'data_dirty_since' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'data_dirty_since'
+      ])
+    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::TrackedQueryMoversResponse` 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::TrackedQueryMoversResponse`. 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?(:'rows')
+        if (value = attributes[:'rows']).is_a?(Array)
+          self.rows = value
+        end
+      else
+        self.rows = nil
+      end
+
+      if attributes.key?(:'total')
+        self.total = attributes[:'total']
+      else
+        self.total = nil
+      end
+
+      if attributes.key?(:'data_dirty_since')
+        self.data_dirty_since = attributes[:'data_dirty_since']
+      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 @rows.nil?
+        invalid_properties.push('invalid value for "rows", rows cannot be nil.')
+      end
+
+      if @total.nil?
+        invalid_properties.push('invalid value for "total", total 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 @rows.nil?
+      return false if @total.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rows Value to be assigned
+    def rows=(rows)
+      if rows.nil?
+        fail ArgumentError, 'rows cannot be nil'
+      end
+
+      @rows = rows
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total Value to be assigned
+    def total=(total)
+      if total.nil?
+        fail ArgumentError, 'total cannot be nil'
+      end
+
+      @total = total
+    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 &&
+          rows == o.rows &&
+          total == o.total &&
+          data_dirty_since == o.data_dirty_since
+    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
+      [rows, total, data_dirty_since].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