mencoro 1.0.1 → 2.0.0

data/lib/mencoro/models/competitor_co_occurrence_response.rb

@@ -0,0 +1,166 @@
+=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 CompetitorCoOccurrenceResponse < ApiModelBase
+    attr_accessor :competitors
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'competitors' => :'competitors'
+      }
+    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
+      {
+        :'competitors' => :'Array<CompetitorCoOccurrenceRow>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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::CompetitorCoOccurrenceResponse` 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::CompetitorCoOccurrenceResponse`. 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?(:'competitors')
+        if (value = attributes[:'competitors']).is_a?(Array)
+          self.competitors = value
+        end
+      else
+        self.competitors = 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 @competitors.nil?
+        invalid_properties.push('invalid value for "competitors", competitors 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 @competitors.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] competitors Value to be assigned
+    def competitors=(competitors)
+      if competitors.nil?
+        fail ArgumentError, 'competitors cannot be nil'
+      end
+
+      @competitors = competitors
+    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 &&
+          competitors == o.competitors
+    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
+      [competitors].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/competitor_co_occurrence_row.rb

@@ -0,0 +1,318 @@
+=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 CompetitorCoOccurrenceRow < ApiModelBase
+    attr_accessor :competitor_id
+
+    attr_accessor :shared_response_count
+
+    attr_accessor :brand_wins
+
+    attr_accessor :competitor_wins
+
+    attr_accessor :ties
+
+    attr_accessor :win_rate
+
+    attr_accessor :avg_own_position
+
+    attr_accessor :avg_competitor_position
+
+    attr_accessor :example_query_text
+
+    attr_accessor :example_ai_response_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'competitor_id' => :'competitorId',
+        :'shared_response_count' => :'sharedResponseCount',
+        :'brand_wins' => :'brandWins',
+        :'competitor_wins' => :'competitorWins',
+        :'ties' => :'ties',
+        :'win_rate' => :'winRate',
+        :'avg_own_position' => :'avgOwnPosition',
+        :'avg_competitor_position' => :'avgCompetitorPosition',
+        :'example_query_text' => :'exampleQueryText',
+        :'example_ai_response_id' => :'exampleAiResponseId'
+      }
+    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',
+        :'shared_response_count' => :'Integer',
+        :'brand_wins' => :'Integer',
+        :'competitor_wins' => :'Integer',
+        :'ties' => :'Integer',
+        :'win_rate' => :'Integer',
+        :'avg_own_position' => :'Float',
+        :'avg_competitor_position' => :'Float',
+        :'example_query_text' => :'String',
+        :'example_ai_response_id' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'win_rate',
+        :'avg_own_position',
+        :'avg_competitor_position',
+        :'example_query_text',
+        :'example_ai_response_id'
+      ])
+    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::CompetitorCoOccurrenceRow` 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::CompetitorCoOccurrenceRow`. 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?(:'shared_response_count')
+        self.shared_response_count = attributes[:'shared_response_count']
+      else
+        self.shared_response_count = nil
+      end
+
+      if attributes.key?(:'brand_wins')
+        self.brand_wins = attributes[:'brand_wins']
+      else
+        self.brand_wins = nil
+      end
+
+      if attributes.key?(:'competitor_wins')
+        self.competitor_wins = attributes[:'competitor_wins']
+      else
+        self.competitor_wins = nil
+      end
+
+      if attributes.key?(:'ties')
+        self.ties = attributes[:'ties']
+      else
+        self.ties = nil
+      end
+
+      if attributes.key?(:'win_rate')
+        self.win_rate = attributes[:'win_rate']
+      end
+
+      if attributes.key?(:'avg_own_position')
+        self.avg_own_position = attributes[:'avg_own_position']
+      end
+
+      if attributes.key?(:'avg_competitor_position')
+        self.avg_competitor_position = attributes[:'avg_competitor_position']
+      end
+
+      if attributes.key?(:'example_query_text')
+        self.example_query_text = attributes[:'example_query_text']
+      end
+
+      if attributes.key?(:'example_ai_response_id')
+        self.example_ai_response_id = attributes[:'example_ai_response_id']
+      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 @shared_response_count.nil?
+        invalid_properties.push('invalid value for "shared_response_count", shared_response_count cannot be nil.')
+      end
+
+      if @brand_wins.nil?
+        invalid_properties.push('invalid value for "brand_wins", brand_wins cannot be nil.')
+      end
+
+      if @competitor_wins.nil?
+        invalid_properties.push('invalid value for "competitor_wins", competitor_wins cannot be nil.')
+      end
+
+      if @ties.nil?
+        invalid_properties.push('invalid value for "ties", ties 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 @shared_response_count.nil?
+      return false if @brand_wins.nil?
+      return false if @competitor_wins.nil?
+      return false if @ties.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] shared_response_count Value to be assigned
+    def shared_response_count=(shared_response_count)
+      if shared_response_count.nil?
+        fail ArgumentError, 'shared_response_count cannot be nil'
+      end
+
+      @shared_response_count = shared_response_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] brand_wins Value to be assigned
+    def brand_wins=(brand_wins)
+      if brand_wins.nil?
+        fail ArgumentError, 'brand_wins cannot be nil'
+      end
+
+      @brand_wins = brand_wins
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] competitor_wins Value to be assigned
+    def competitor_wins=(competitor_wins)
+      if competitor_wins.nil?
+        fail ArgumentError, 'competitor_wins cannot be nil'
+      end
+
+      @competitor_wins = competitor_wins
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ties Value to be assigned
+    def ties=(ties)
+      if ties.nil?
+        fail ArgumentError, 'ties cannot be nil'
+      end
+
+      @ties = ties
+    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 &&
+          shared_response_count == o.shared_response_count &&
+          brand_wins == o.brand_wins &&
+          competitor_wins == o.competitor_wins &&
+          ties == o.ties &&
+          win_rate == o.win_rate &&
+          avg_own_position == o.avg_own_position &&
+          avg_competitor_position == o.avg_competitor_position &&
+          example_query_text == o.example_query_text &&
+          example_ai_response_id == o.example_ai_response_id
+    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, shared_response_count, brand_wins, competitor_wins, ties, win_rate, avg_own_position, avg_competitor_position, example_query_text, example_ai_response_id].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/competitor_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/competitor_share_of_voice.rb

@@ -0,0 +1,174 @@
+=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 CompetitorShareOfVoice < ApiModelBase
+    attr_accessor :competitor_id
+
+    attr_accessor :share_of_voice
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'competitor_id' => :'competitorId',
+        :'share_of_voice' => :'shareOfVoice'
+      }
+    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',
+        :'share_of_voice' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'share_of_voice'
+      ])
+    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::CompetitorShareOfVoice` 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::CompetitorShareOfVoice`. 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?(:'share_of_voice')
+        self.share_of_voice = attributes[:'share_of_voice']
+      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
+
+      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?
+      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
+
+    # 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 &&
+          share_of_voice == o.share_of_voice
+    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, share_of_voice].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/create_competitor_request.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/create_invitation200_response.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