mencoro 1.0.1 → 2.0.1

data/lib/mencoro/models/cluster_breakdown_row.rb

@@ -0,0 +1,580 @@
+=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 ClusterBreakdownRow < ApiModelBase
+    attr_accessor :cluster_id
+
+    attr_accessor :cluster_name
+
+    attr_accessor :query_count
+
+    attr_accessor :keyword_count
+
+    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 :mention_position_stability
+
+    attr_accessor :trend_stability
+
+    attr_accessor :serp_position_stability
+
+    attr_accessor :trend_serp_stability
+
+    attr_accessor :shopping_position_stability
+
+    attr_accessor :trend_shopping_stability
+
+    attr_accessor :positivity_index
+
+    attr_accessor :trend_positivity
+
+    attr_accessor :mention_rate
+
+    attr_accessor :trend_mention_rate
+
+    attr_accessor :serp_rate
+
+    attr_accessor :trend_serp_rate
+
+    attr_accessor :shopping_rate
+
+    attr_accessor :trend_shopping_rate
+
+    attr_accessor :share_of_voice
+
+    attr_accessor :trend_share_of_voice
+
+    attr_accessor :sentiment_positive
+
+    attr_accessor :sentiment_neutral
+
+    attr_accessor :sentiment_negative
+
+    attr_accessor :avg_mention_count
+
+    attr_accessor :mention_type_counts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'cluster_id' => :'clusterId',
+        :'cluster_name' => :'clusterName',
+        :'query_count' => :'queryCount',
+        :'keyword_count' => :'keywordCount',
+        :'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',
+        :'serp_position_stability' => :'serpPositionStability',
+        :'trend_serp_stability' => :'trendSerpStability',
+        :'shopping_position_stability' => :'shoppingPositionStability',
+        :'trend_shopping_stability' => :'trendShoppingStability',
+        :'positivity_index' => :'positivityIndex',
+        :'trend_positivity' => :'trendPositivity',
+        :'mention_rate' => :'mentionRate',
+        :'trend_mention_rate' => :'trendMentionRate',
+        :'serp_rate' => :'serpRate',
+        :'trend_serp_rate' => :'trendSerpRate',
+        :'shopping_rate' => :'shoppingRate',
+        :'trend_shopping_rate' => :'trendShoppingRate',
+        :'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
+      {
+        :'cluster_id' => :'String',
+        :'cluster_name' => :'String',
+        :'query_count' => :'Integer',
+        :'keyword_count' => :'Integer',
+        :'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',
+        :'serp_position_stability' => :'Float',
+        :'trend_serp_stability' => :'Float',
+        :'shopping_position_stability' => :'Float',
+        :'trend_shopping_stability' => :'Float',
+        :'positivity_index' => :'Integer',
+        :'trend_positivity' => :'Integer',
+        :'mention_rate' => :'Integer',
+        :'trend_mention_rate' => :'Integer',
+        :'serp_rate' => :'Integer',
+        :'trend_serp_rate' => :'Integer',
+        :'shopping_rate' => :'Integer',
+        :'trend_shopping_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' => :'MentionTypeCounts'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'cluster_id',
+        :'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',
+        :'serp_position_stability',
+        :'trend_serp_stability',
+        :'shopping_position_stability',
+        :'trend_shopping_stability',
+        :'positivity_index',
+        :'trend_positivity',
+        :'mention_rate',
+        :'trend_mention_rate',
+        :'serp_rate',
+        :'trend_serp_rate',
+        :'shopping_rate',
+        :'trend_shopping_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::ClusterBreakdownRow` 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::ClusterBreakdownRow`. 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?(:'cluster_id')
+        self.cluster_id = attributes[:'cluster_id']
+      end
+
+      if attributes.key?(:'cluster_name')
+        self.cluster_name = attributes[:'cluster_name']
+      else
+        self.cluster_name = nil
+      end
+
+      if attributes.key?(:'query_count')
+        self.query_count = attributes[:'query_count']
+      else
+        self.query_count = nil
+      end
+
+      if attributes.key?(:'keyword_count')
+        self.keyword_count = attributes[:'keyword_count']
+      else
+        self.keyword_count = 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?(:'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?(:'serp_position_stability')
+        self.serp_position_stability = attributes[:'serp_position_stability']
+      end
+
+      if attributes.key?(:'trend_serp_stability')
+        self.trend_serp_stability = attributes[:'trend_serp_stability']
+      end
+
+      if attributes.key?(:'shopping_position_stability')
+        self.shopping_position_stability = attributes[:'shopping_position_stability']
+      end
+
+      if attributes.key?(:'trend_shopping_stability')
+        self.trend_shopping_stability = attributes[:'trend_shopping_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?(:'shopping_rate')
+        self.shopping_rate = attributes[:'shopping_rate']
+      end
+
+      if attributes.key?(:'trend_shopping_rate')
+        self.trend_shopping_rate = attributes[:'trend_shopping_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 @cluster_name.nil?
+        invalid_properties.push('invalid value for "cluster_name", cluster_name cannot be nil.')
+      end
+
+      if @query_count.nil?
+        invalid_properties.push('invalid value for "query_count", query_count cannot be nil.')
+      end
+
+      if @keyword_count.nil?
+        invalid_properties.push('invalid value for "keyword_count", keyword_count 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 @cluster_name.nil?
+      return false if @query_count.nil?
+      return false if @keyword_count.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] cluster_name Value to be assigned
+    def cluster_name=(cluster_name)
+      if cluster_name.nil?
+        fail ArgumentError, 'cluster_name cannot be nil'
+      end
+
+      @cluster_name = cluster_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] query_count Value to be assigned
+    def query_count=(query_count)
+      if query_count.nil?
+        fail ArgumentError, 'query_count cannot be nil'
+      end
+
+      @query_count = query_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] keyword_count Value to be assigned
+    def keyword_count=(keyword_count)
+      if keyword_count.nil?
+        fail ArgumentError, 'keyword_count cannot be nil'
+      end
+
+      @keyword_count = keyword_count
+    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 &&
+          cluster_id == o.cluster_id &&
+          cluster_name == o.cluster_name &&
+          query_count == o.query_count &&
+          keyword_count == o.keyword_count &&
+          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 &&
+          serp_position_stability == o.serp_position_stability &&
+          trend_serp_stability == o.trend_serp_stability &&
+          shopping_position_stability == o.shopping_position_stability &&
+          trend_shopping_stability == o.trend_shopping_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 &&
+          shopping_rate == o.shopping_rate &&
+          trend_shopping_rate == o.trend_shopping_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
+      [cluster_id, cluster_name, query_count, keyword_count, 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, serp_position_stability, trend_serp_stability, shopping_position_stability, trend_shopping_stability, positivity_index, trend_positivity, mention_rate, trend_mention_rate, serp_rate, trend_serp_rate, shopping_rate, trend_shopping_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

data/lib/mencoro/models/cluster_membership_request_data.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#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