mencoro 1.0.1 → 2.0.1

data/lib/mencoro/models/operation_effect.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

data/lib/mencoro/models/organization_resource.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

data/lib/mencoro/models/per_competitor_sentiment.rb

@@ -0,0 +1,304 @@
+=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 PerCompetitorSentiment < ApiModelBase
+    attr_accessor :competitor_id
+
+    attr_accessor :positive
+
+    attr_accessor :neutral
+
+    attr_accessor :negative
+
+    attr_accessor :mention_count
+
+    attr_accessor :positivity_index
+
+    attr_accessor :mention_type_counts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'competitor_id' => :'competitorId',
+        :'positive' => :'positive',
+        :'neutral' => :'neutral',
+        :'negative' => :'negative',
+        :'mention_count' => :'mentionCount',
+        :'positivity_index' => :'positivityIndex',
+        :'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
+      {
+        :'competitor_id' => :'String',
+        :'positive' => :'Integer',
+        :'neutral' => :'Integer',
+        :'negative' => :'Integer',
+        :'mention_count' => :'Integer',
+        :'positivity_index' => :'Integer',
+        :'mention_type_counts' => :'MentionTypeCounts'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'positivity_index',
+      ])
+    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::PerCompetitorSentiment` 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::PerCompetitorSentiment`. 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?(:'competitor_id')
+        self.competitor_id = attributes[:'competitor_id']
+      else
+        self.competitor_id = nil
+      end
+
+      if attributes.key?(:'positive')
+        self.positive = attributes[:'positive']
+      else
+        self.positive = nil
+      end
+
+      if attributes.key?(:'neutral')
+        self.neutral = attributes[:'neutral']
+      else
+        self.neutral = nil
+      end
+
+      if attributes.key?(:'negative')
+        self.negative = attributes[:'negative']
+      else
+        self.negative = nil
+      end
+
+      if attributes.key?(:'mention_count')
+        self.mention_count = attributes[:'mention_count']
+      else
+        self.mention_count = nil
+      end
+
+      if attributes.key?(:'positivity_index')
+        self.positivity_index = attributes[:'positivity_index']
+      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 @competitor_id.nil?
+        invalid_properties.push('invalid value for "competitor_id", competitor_id cannot be nil.')
+      end
+
+      if @positive.nil?
+        invalid_properties.push('invalid value for "positive", positive cannot be nil.')
+      end
+
+      if @neutral.nil?
+        invalid_properties.push('invalid value for "neutral", neutral cannot be nil.')
+      end
+
+      if @negative.nil?
+        invalid_properties.push('invalid value for "negative", 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 @competitor_id.nil?
+      return false if @positive.nil?
+      return false if @neutral.nil?
+      return false if @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] competitor_id Value to be assigned
+    def competitor_id=(competitor_id)
+      if competitor_id.nil?
+        fail ArgumentError, 'competitor_id cannot be nil'
+      end
+
+      @competitor_id = competitor_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] positive Value to be assigned
+    def positive=(positive)
+      if positive.nil?
+        fail ArgumentError, 'positive cannot be nil'
+      end
+
+      @positive = positive
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] neutral Value to be assigned
+    def neutral=(neutral)
+      if neutral.nil?
+        fail ArgumentError, 'neutral cannot be nil'
+      end
+
+      @neutral = neutral
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] negative Value to be assigned
+    def negative=(negative)
+      if negative.nil?
+        fail ArgumentError, 'negative cannot be nil'
+      end
+
+      @negative = 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 &&
+          competitor_id == o.competitor_id &&
+          positive == o.positive &&
+          neutral == o.neutral &&
+          negative == o.negative &&
+          mention_count == o.mention_count &&
+          positivity_index == o.positivity_index &&
+          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
+      [competitor_id, positive, neutral, negative, mention_count, positivity_index, 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/per_engine_sentiment.rb

@@ -0,0 +1,278 @@
+=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 PerEngineSentiment < ApiModelBase
+    attr_accessor :engine
+
+    attr_accessor :positive
+
+    attr_accessor :neutral
+
+    attr_accessor :negative
+
+    attr_accessor :mention_count
+
+    attr_accessor :positivity_index
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'engine' => :'engine',
+        :'positive' => :'positive',
+        :'neutral' => :'neutral',
+        :'negative' => :'negative',
+        :'mention_count' => :'mentionCount',
+        :'positivity_index' => :'positivityIndex'
+      }
+    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
+      {
+        :'engine' => :'String',
+        :'positive' => :'Integer',
+        :'neutral' => :'Integer',
+        :'negative' => :'Integer',
+        :'mention_count' => :'Integer',
+        :'positivity_index' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'positivity_index'
+      ])
+    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::PerEngineSentiment` 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::PerEngineSentiment`. 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?(:'engine')
+        self.engine = attributes[:'engine']
+      else
+        self.engine = nil
+      end
+
+      if attributes.key?(:'positive')
+        self.positive = attributes[:'positive']
+      else
+        self.positive = nil
+      end
+
+      if attributes.key?(:'neutral')
+        self.neutral = attributes[:'neutral']
+      else
+        self.neutral = nil
+      end
+
+      if attributes.key?(:'negative')
+        self.negative = attributes[:'negative']
+      else
+        self.negative = nil
+      end
+
+      if attributes.key?(:'mention_count')
+        self.mention_count = attributes[:'mention_count']
+      else
+        self.mention_count = nil
+      end
+
+      if attributes.key?(:'positivity_index')
+        self.positivity_index = attributes[:'positivity_index']
+      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 @engine.nil?
+        invalid_properties.push('invalid value for "engine", engine cannot be nil.')
+      end
+
+      if @positive.nil?
+        invalid_properties.push('invalid value for "positive", positive cannot be nil.')
+      end
+
+      if @neutral.nil?
+        invalid_properties.push('invalid value for "neutral", neutral cannot be nil.')
+      end
+
+      if @negative.nil?
+        invalid_properties.push('invalid value for "negative", negative cannot be nil.')
+      end
+
+      if @mention_count.nil?
+        invalid_properties.push('invalid value for "mention_count", mention_count 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 @engine.nil?
+      return false if @positive.nil?
+      return false if @neutral.nil?
+      return false if @negative.nil?
+      return false if @mention_count.nil?
+      true
+    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] positive Value to be assigned
+    def positive=(positive)
+      if positive.nil?
+        fail ArgumentError, 'positive cannot be nil'
+      end
+
+      @positive = positive
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] neutral Value to be assigned
+    def neutral=(neutral)
+      if neutral.nil?
+        fail ArgumentError, 'neutral cannot be nil'
+      end
+
+      @neutral = neutral
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] negative Value to be assigned
+    def negative=(negative)
+      if negative.nil?
+        fail ArgumentError, 'negative cannot be nil'
+      end
+
+      @negative = 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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          engine == o.engine &&
+          positive == o.positive &&
+          neutral == o.neutral &&
+          negative == o.negative &&
+          mention_count == o.mention_count &&
+          positivity_index == o.positivity_index
+    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
+      [engine, positive, neutral, negative, mention_count, positivity_index].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