algolia 3.0.0.alpha.14 → 3.0.0.alpha.15

data/lib/algolia/api/ingestion_client.rb

@@ -229,7 +229,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -272,7 +272,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -316,7 +316,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -361,7 +361,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?

data/lib/algolia/api/insights_client.rb

@@ -45,7 +45,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -88,7 +88,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -132,7 +132,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -177,7 +177,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?

data/lib/algolia/api/monitoring_client.rb

@@ -36,7 +36,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -79,7 +79,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -123,7 +123,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -168,7 +168,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?

data/lib/algolia/api/personalization_client.rb

@@ -45,7 +45,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -88,7 +88,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -132,7 +132,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -177,7 +177,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?

data/lib/algolia/api/query_suggestions_client.rb

@@ -89,7 +89,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -132,7 +132,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -176,7 +176,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -221,7 +221,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?

data/lib/algolia/api/recommend_client.rb

@@ -41,7 +41,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -84,7 +84,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -128,7 +128,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -173,7 +173,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?

data/lib/algolia/api/search_client.rb

@@ -580,7 +580,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -623,7 +623,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -667,7 +667,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -712,7 +712,7 @@ module Algolia
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
 
-      path = '/1{path}'.sub('{' + 'path' + '}', path.to_s)
+      path = '/{path}'.sub('{' + 'path' + '}', path.to_s)
       query_params = {}
       query_params = query_params.merge(parameters) unless parameters.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?

data/lib/algolia/models/abtesting/{currencies_value.rb → currency.rb}

@@ -5,7 +5,7 @@ require 'time'
 
 module Algolia
   module Abtesting
-    class CurrenciesValue
+    class Currency
       # Currency code.
       attr_accessor :currency
 
@@ -52,14 +52,14 @@ module Algolia
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
         unless attributes.is_a?(Hash)
-          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::CurrenciesValue` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Currency` initialize method"
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
         attributes = attributes.each_with_object({}) do |(k, v), h|
           unless self.class.attribute_map.key?(k.to_sym)
             raise ArgumentError,
-                  "`#{k}` is not a valid attribute in `Algolia::CurrenciesValue`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+                  "`#{k}` is not a valid attribute in `Algolia::Currency`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
           end
 
           h[k.to_sym] = v

data/lib/algolia/models/abtesting/variant.rb

@@ -53,7 +53,7 @@ module Algolia
       # Number of searches carried out during the A/B test.
       attr_accessor :search_count
 
-      # Number of tracked searches. This is the number of search requests where the `clickAnalytics` parameter is `true`.
+      # Number of tracked searches. Tracked searches are search requests where the `clickAnalytics` parameter is true.
       attr_accessor :tracked_search_count
 
       # A/B test traffic percentage.
@@ -106,7 +106,7 @@ module Algolia
           :click_through_rate => :Float,
           :conversion_count => :Integer,
           :conversion_rate => :Float,
-          :currencies => :'Hash<String, CurrenciesValue>',
+          :currencies => :'Hash<String, Currency>',
           :description => :String,
           :estimated_sample_size => :Integer,
           :filter_effects => :FilterEffects,
@@ -132,7 +132,6 @@ module Algolia
                   :no_result_count,
                   :purchase_rate,
                   :search_count,
-                  :tracked_search_count,
                   :user_count,
                   :tracked_user_count
                 ])
@@ -249,8 +248,6 @@ module Algolia
 
         if attributes.key?(:tracked_search_count)
           self.tracked_search_count = attributes[:tracked_search_count]
-        else
-          self.tracked_search_count = nil
         end
 
         if attributes.key?(:traffic_percentage)

data/lib/algolia/models/analytics/click_positions_inner.rb

@@ -0,0 +1,242 @@
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require 'date'
+require 'time'
+
+module Algolia
+  module Analytics
+    # Click position.
+    class ClickPositionsInner
+      # Range of positions in the search results, using the pattern `[start,end]`.  For positions 11 and up, click events are summed over the specified range. `-1` indicates the end of the list of search results.
+      attr_accessor :position
+
+      # Number of times this search has been clicked at that position.
+      attr_accessor :click_count
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :position => :position,
+          :click_count => :clickCount
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :position => :'Array<Integer>',
+          :click_count => :Integer
+        }
+      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 = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::ClickPositionsInner` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::ClickPositionsInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          end
+
+          h[k.to_sym] = v
+        end
+
+        if attributes.key?(:position)
+          if (value = attributes[:position]).is_a?(Array)
+            self.position = value
+          end
+        end
+
+        if attributes.key?(:click_count)
+          self.click_count = attributes[:click_count]
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] position Value to be assigned
+      def position=(position)
+        if position.nil?
+          raise ArgumentError, 'position cannot be nil'
+        end
+
+        if position.length > 2
+          raise ArgumentError, 'invalid value for "position", number of items must be less than or equal to 2.'
+        end
+
+        if position.length < 2
+          raise ArgumentError, 'invalid value for "position", number of items must be greater than or equal to 2.'
+        end
+
+        @position = position
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] click_count Value to be assigned
+      def click_count=(click_count)
+        if click_count.nil?
+          raise ArgumentError, 'click_count cannot be nil'
+        end
+
+        if click_count < 0
+          raise ArgumentError, 'invalid value for "click_count", must be greater than or equal to 0.'
+        end
+
+        @click_count = click_count
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          position == other.position &&
+          click_count == other.click_count
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [position, click_count].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 = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = 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.to_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type
+      # @param string type Data type
+      # @param string value Value to be deserialized
+      # @return [Object] Deserialized data
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+        when :Object
+          # generic object (usually a Hash), return directly
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+        else # model
+          # models (e.g. Pet) or oneOf
+          klass = Algolia::Analytics.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      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 = 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
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to? :to_hash
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end