algolia 3.0.0.alpha.15 → 3.0.0.alpha.17

data/lib/algolia/models/recommend/{base_recommendations_query.rb → looking_similar.rb}

@@ -5,14 +5,12 @@ require 'time'
 
 module Algolia
   module Recommend
-    class BaseRecommendationsQuery
+    class LookingSimilar
       attr_accessor :model
 
       # Unique record identifier.
       attr_accessor :object_id
 
-      attr_accessor :query_parameters
-
       attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
@@ -42,7 +40,6 @@ module Algolia
         {
           :model => :model,
           :object_id => :objectID,
-          :query_parameters => :queryParameters,
           :fallback_parameters => :fallbackParameters
         }
       end
@@ -55,10 +52,9 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :model => :RecommendationModels,
+          :model => :LookingSimilarModel,
           :object_id => :String,
-          :query_parameters => :SearchParamsObject,
-          :fallback_parameters => :SearchParamsObject
+          :fallback_parameters => :FallbackParams
         }
       end
 
@@ -71,14 +67,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::BaseRecommendationsQuery` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::LookingSimilar` 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::BaseRecommendationsQuery`. 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::LookingSimilar`. 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
@@ -96,10 +92,6 @@ module Algolia
           self.object_id = nil
         end
 
-        if attributes.key?(:query_parameters)
-          self.query_parameters = attributes[:query_parameters]
-        end
-
         if attributes.key?(:fallback_parameters)
           self.fallback_parameters = attributes[:fallback_parameters]
         end
@@ -113,7 +105,6 @@ module Algolia
         self.class == other.class &&
           model == other.model &&
           object_id == other.object_id &&
-          query_parameters == other.query_parameters &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -126,7 +117,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [model, object_id, query_parameters, fallback_parameters].hash
+        [model, object_id, fallback_parameters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/{anchoring.rb → looking_similar_model.rb}

@@ -5,14 +5,11 @@ require 'time'
 
 module Algolia
   module Recommend
-    class Anchoring
-      IS = "is".freeze
-      STARTS_WITH = "startsWith".freeze
-      ENDS_WITH = "endsWith".freeze
-      CONTAINS = "contains".freeze
+    class LookingSimilarModel
+      LOOKING_SIMILAR = "looking-similar".freeze
 
       def self.all_vars
-        @all_vars ||= [IS, STARTS_WITH, ENDS_WITH, CONTAINS].freeze
+        @all_vars ||= [LOOKING_SIMILAR].freeze
       end
 
       # Builds the enum from string
@@ -26,9 +23,9 @@ module Algolia
       # @param [String] The enum value in the form of the string
       # @return [String] The enum value
       def build_from_hash(value)
-        return value if Anchoring.all_vars.include?(value)
+        return value if LookingSimilarModel.all_vars.include?(value)
 
-        raise "Invalid ENUM value #{value} for class #Anchoring"
+        raise "Invalid ENUM value #{value} for class #LookingSimilarModel"
       end
     end
   end

data/lib/algolia/models/recommend/looking_similar_query.rb

@@ -0,0 +1,328 @@
+# 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 Recommend
+    class LookingSimilarQuery
+      # Index name.
+      attr_accessor :index_name
+
+      # Minimum score a recommendation must have to be included in the response.
+      attr_accessor :threshold
+
+      # Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
+      attr_accessor :max_recommendations
+
+      attr_accessor :query_parameters
+
+      attr_accessor :model
+
+      # Unique record identifier.
+      attr_accessor :object_id
+
+      attr_accessor :fallback_parameters
+
+      class EnumAttributeValidator
+        attr_reader :datatype
+        attr_reader :allowable_values
+
+        def initialize(datatype, allowable_values)
+          @allowable_values = allowable_values.map do |value|
+            case datatype.to_s
+            when /Integer/i
+              value.to_i
+            when /Float/i
+              value.to_f
+            else
+              value
+            end
+          end
+        end
+
+        def valid?(value)
+          !value || allowable_values.include?(value)
+        end
+      end
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :index_name => :indexName,
+          :threshold => :threshold,
+          :max_recommendations => :maxRecommendations,
+          :query_parameters => :queryParameters,
+          :model => :model,
+          :object_id => :objectID,
+          :fallback_parameters => :fallbackParameters
+        }
+      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
+        {
+          :index_name => :String,
+          :threshold => :Float,
+          :max_recommendations => :Integer,
+          :query_parameters => :SearchParams,
+          :model => :LookingSimilarModel,
+          :object_id => :String,
+          :fallback_parameters => :FallbackParams
+        }
+      end
+
+      # List of attributes with nullable: true
+      def self.openapi_nullable
+        Set.new([])
+      end
+
+      # List of class defined in allOf (OpenAPI v3)
+      def self.openapi_all_of
+        [
+          :BaseRecommendRequest,
+          :LookingSimilar
+        ]
+      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::LookingSimilarQuery` 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::LookingSimilarQuery`. 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?(:index_name)
+          self.index_name = attributes[:index_name]
+        else
+          self.index_name = nil
+        end
+
+        if attributes.key?(:threshold)
+          self.threshold = attributes[:threshold]
+        else
+          self.threshold = nil
+        end
+
+        if attributes.key?(:max_recommendations)
+          self.max_recommendations = attributes[:max_recommendations]
+        end
+
+        if attributes.key?(:query_parameters)
+          self.query_parameters = attributes[:query_parameters]
+        end
+
+        if attributes.key?(:model)
+          self.model = attributes[:model]
+        else
+          self.model = nil
+        end
+
+        if attributes.key?(:object_id)
+          self.object_id = attributes[:object_id]
+        else
+          self.object_id = nil
+        end
+
+        if attributes.key?(:fallback_parameters)
+          self.fallback_parameters = attributes[:fallback_parameters]
+        end
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] threshold Value to be assigned
+      def threshold=(threshold)
+        if threshold.nil?
+          raise ArgumentError, 'threshold cannot be nil'
+        end
+
+        if threshold > 100
+          raise ArgumentError, 'invalid value for "threshold", must be smaller than or equal to 100.'
+        end
+
+        if threshold < 0
+          raise ArgumentError, 'invalid value for "threshold", must be greater than or equal to 0.'
+        end
+
+        @threshold = threshold
+      end
+
+      # Custom attribute writer method with validation
+      # @param [Object] max_recommendations Value to be assigned
+      def max_recommendations=(max_recommendations)
+        if max_recommendations.nil?
+          raise ArgumentError, 'max_recommendations cannot be nil'
+        end
+
+        if max_recommendations > 1000
+          raise ArgumentError, 'invalid value for "max_recommendations", must be smaller than or equal to 1000.'
+        end
+
+        if max_recommendations < 1
+          raise ArgumentError, 'invalid value for "max_recommendations", must be greater than or equal to 1.'
+        end
+
+        @max_recommendations = max_recommendations
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          index_name == other.index_name &&
+          threshold == other.threshold &&
+          max_recommendations == other.max_recommendations &&
+          query_parameters == other.query_parameters &&
+          model == other.model &&
+          object_id == other.object_id &&
+          fallback_parameters == other.fallback_parameters
+      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
+        [index_name, threshold, max_recommendations, query_parameters, model, object_id, fallback_parameters].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::Recommend.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

data/lib/algolia/models/recommend/{params.rb → params_consequence.rb}

@@ -5,23 +5,23 @@ require 'time'
 
 module Algolia
   module Recommend
-    # Parameters to apply to this search.  You can use all search parameters, plus special `automaticFacetFilters`, `automaticOptionalFacetFilters`, and `query`.
-    class Params
-      attr_accessor :query
-
+    # Filter or boost recommendations matching a facet filter.
+    class ParamsConsequence
+      # Filter recommendations that match or don't match the same `facet:facet_value` combination as the viewed item.
       attr_accessor :automatic_facet_filters
 
-      attr_accessor :automatic_optional_facet_filters
+      # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+      attr_accessor :filters
 
-      attr_accessor :rendering_content
+      # Filters to promote or demote records in the search results.  Optional filters work like facet filters, but they don't exclude records from the search results. Records that match the optional filter rank before records that don't match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you're using a negative filter `facet:-value`, matching records rank after records that don't match.
+      attr_accessor :optional_filters
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :query => :query,
           :automatic_facet_filters => :automaticFacetFilters,
-          :automatic_optional_facet_filters => :automaticOptionalFacetFilters,
-          :rendering_content => :renderingContent
+          :filters => :filters,
+          :optional_filters => :optionalFilters
         }
       end
 
@@ -33,10 +33,9 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :query => :ConsequenceQuery,
-          :automatic_facet_filters => :AutomaticFacetFilters,
-          :automatic_optional_facet_filters => :AutomaticFacetFilters,
-          :rendering_content => :RenderingContent
+          :automatic_facet_filters => :'Array<AutoFacetFilter>',
+          :filters => :String,
+          :optional_filters => :'Array<String>'
         }
       end
 
@@ -49,33 +48,33 @@ 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::Params` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::ParamsConsequence` 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::Params`. 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::ParamsConsequence`. 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?(:query)
-          self.query = attributes[:query]
-        end
-
         if attributes.key?(:automatic_facet_filters)
-          self.automatic_facet_filters = attributes[:automatic_facet_filters]
+          if (value = attributes[:automatic_facet_filters]).is_a?(Array)
+            self.automatic_facet_filters = value
+          end
         end
 
-        if attributes.key?(:automatic_optional_facet_filters)
-          self.automatic_optional_facet_filters = attributes[:automatic_optional_facet_filters]
+        if attributes.key?(:filters)
+          self.filters = attributes[:filters]
         end
 
-        if attributes.key?(:rendering_content)
-          self.rendering_content = attributes[:rendering_content]
+        if attributes.key?(:optional_filters)
+          if (value = attributes[:optional_filters]).is_a?(Array)
+            self.optional_filters = value
+          end
         end
       end
 
@@ -85,10 +84,9 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          query == other.query &&
           automatic_facet_filters == other.automatic_facet_filters &&
-          automatic_optional_facet_filters == other.automatic_optional_facet_filters &&
-          rendering_content == other.rendering_content
+          filters == other.filters &&
+          optional_filters == other.optional_filters
       end
 
       # @see the `==` method
@@ -100,7 +98,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [query, automatic_facet_filters, automatic_optional_facet_filters, rendering_content].hash
+        [automatic_facet_filters, filters, optional_filters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/{promote_object_id.rb → promote_consequence_object.rb}

@@ -5,12 +5,12 @@ require 'time'
 
 module Algolia
   module Recommend
-    # Record to promote.
-    class PromoteObjectID
+    # Object ID and position of the recommendation you want to pin.
+    class PromoteConsequenceObject
       # Unique record identifier.
       attr_accessor :object_id
 
-      # Position in the search results where you want to show the promoted records.
+      # Index in the list of recommendations where to place this item.
       attr_accessor :position
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -43,14 +43,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::PromoteObjectID` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::PromoteConsequenceObject` 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::PromoteObjectID`. 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::PromoteConsequenceObject`. 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
@@ -58,17 +58,27 @@ module Algolia
 
         if attributes.key?(:object_id)
           self.object_id = attributes[:object_id]
-        else
-          self.object_id = nil
         end
 
         if attributes.key?(:position)
           self.position = attributes[:position]
-        else
-          self.position = nil
         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 < 0
+          raise ArgumentError, 'invalid value for "position", must be greater than or equal to 0.'
+        end
+
+        @position = position
+      end
+
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)