algolia 3.0.0.alpha.16 → 3.0.0.alpha.18

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

@@ -8,18 +8,10 @@ module Algolia
     class RecommendationsHits
       attr_accessor :hits
 
-      # Search query.
-      attr_accessor :query
-
-      # URL-encoded string of all search parameters.
-      attr_accessor :params
-
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :hits => :hits,
-          :query => :query,
-          :params => :params
+          :hits => :hits
         }
       end
 
@@ -31,9 +23,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :hits => :'Array<RecommendationsHit>',
-          :query => :String,
-          :params => :String
+          :hits => :'Array<RecommendationsHit>'
         }
       end
 
@@ -66,14 +56,6 @@ module Algolia
         else
           self.hits = nil
         end
-
-        if attributes.key?(:query)
-          self.query = attributes[:query]
-        end
-
-        if attributes.key?(:params)
-          self.params = attributes[:params]
-        end
       end
 
       # Checks equality by comparing each attribute.
@@ -82,9 +64,7 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          hits == other.hits &&
-          query == other.query &&
-          params == other.params
+          hits == other.hits
       end
 
       # @see the `==` method
@@ -96,7 +76,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [hits, query, params].hash
+        [hits].hash
       end
 
       # Builds the object from hash

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

@@ -10,8 +10,10 @@ module Algolia
         # List of class defined in oneOf (OpenAPI v3)
         def openapi_one_of
           [
-            :RecommendationsQuery,
+            :BoughtTogetherQuery,
+            :LookingSimilarQuery,
             :RecommendedForYouQuery,
+            :RelatedQuery,
             :TrendingFacetsQuery,
             :TrendingItemsQuery
           ]

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

@@ -89,12 +89,6 @@ module Algolia
 
       attr_accessor :hits
 
-      # Search query.
-      attr_accessor :query
-
-      # URL-encoded string of all search parameters.
-      attr_accessor :params
-
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -126,9 +120,7 @@ module Algolia
           :server_used => :serverUsed,
           :user_data => :userData,
           :query_id => :queryID,
-          :hits => :hits,
-          :query => :query,
-          :params => :params
+          :hits => :hits
         }
       end
 
@@ -168,9 +160,7 @@ module Algolia
           :server_used => :String,
           :user_data => :Object,
           :query_id => :String,
-          :hits => :'Array<RecommendationsHit>',
-          :query => :String,
-          :params => :String
+          :hits => :'Array<RecommendationsHit>'
         }
       end
 
@@ -337,14 +327,6 @@ module Algolia
         else
           self.hits = nil
         end
-
-        if attributes.key?(:query)
-          self.query = attributes[:query]
-        end
-
-        if attributes.key?(:params)
-          self.params = attributes[:params]
-        end
       end
 
       # Custom attribute writer method with validation
@@ -442,9 +424,7 @@ module Algolia
           server_used == other.server_used &&
           user_data == other.user_data &&
           query_id == other.query_id &&
-          hits == other.hits &&
-          query == other.query &&
-          params == other.params
+          hits == other.hits
       end
 
       # @see the `==` method
@@ -457,7 +437,7 @@ module Algolia
       # @return [Integer] Hash code
       def hash
         [ab_test_id, ab_test_variant_id, around_lat_lng, automatic_radius, exhaustive, exhaustive_facets_count, exhaustive_nb_hits, exhaustive_typo, facets, facets_stats,
-         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, query_id, hits, query, params].hash
+         hits_per_page, index, index_used, message, nb_hits, nb_pages, nb_sorted_hits, page, parsed_query, processing_time_ms, processing_timings_ms, query_after_removal, redirect, rendering_content, server_time_ms, server_used, user_data, query_id, hits].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/{base_recommended_for_you_query.rb → recommended_for_you.rb}

@@ -5,11 +5,9 @@ require 'time'
 
 module Algolia
   module Recommend
-    class BaseRecommendedForYouQuery
+    class RecommendedForYou
       attr_accessor :model
 
-      attr_accessor :query_parameters
-
       attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
@@ -38,7 +36,6 @@ module Algolia
       def self.attribute_map
         {
           :model => :model,
-          :query_parameters => :queryParameters,
           :fallback_parameters => :fallbackParameters
         }
       end
@@ -52,8 +49,7 @@ module Algolia
       def self.types_mapping
         {
           :model => :RecommendedForYouModel,
-          :query_parameters => :RecommendedForYouQueryParameters,
-          :fallback_parameters => :RecommendedForYouQueryParameters
+          :fallback_parameters => :FallbackParams
         }
       end
 
@@ -66,14 +62,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::BaseRecommendedForYouQuery` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::RecommendedForYou` 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::BaseRecommendedForYouQuery`. 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::RecommendedForYou`. 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
@@ -85,10 +81,6 @@ module Algolia
           self.model = 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
@@ -101,7 +93,6 @@ module Algolia
 
         self.class == other.class &&
           model == other.model &&
-          query_parameters == other.query_parameters &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -114,7 +105,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [model, query_parameters, fallback_parameters].hash
+        [model, fallback_parameters].hash
       end
 
       # Builds the object from hash

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

@@ -6,19 +6,19 @@ require 'time'
 module Algolia
   module Recommend
     class RecommendedForYouQuery
-      # Index name.
+      # Index name (case-sensitive).
       attr_accessor :index_name
 
-      # Recommendations with a confidence score lower than `threshold` won't appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+      # Minimum score a recommendation must have to be included in the response.
       attr_accessor :threshold
 
-      # Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+      # 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 :model
-
       attr_accessor :query_parameters
 
+      attr_accessor :model
+
       attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
@@ -49,8 +49,8 @@ module Algolia
           :index_name => :indexName,
           :threshold => :threshold,
           :max_recommendations => :maxRecommendations,
-          :model => :model,
           :query_parameters => :queryParameters,
+          :model => :model,
           :fallback_parameters => :fallbackParameters
         }
       end
@@ -64,11 +64,11 @@ module Algolia
       def self.types_mapping
         {
           :index_name => :String,
-          :threshold => :Integer,
+          :threshold => :Float,
           :max_recommendations => :Integer,
+          :query_parameters => :SearchParams,
           :model => :RecommendedForYouModel,
-          :query_parameters => :RecommendedForYouQueryParameters,
-          :fallback_parameters => :RecommendedForYouQueryParameters
+          :fallback_parameters => :FallbackParams
         }
       end
 
@@ -81,7 +81,7 @@ module Algolia
       def self.openapi_all_of
         [
           :BaseRecommendRequest,
-          :BaseRecommendedForYouQuery
+          :RecommendedForYou
         ]
       end
 
@@ -110,22 +110,24 @@ module Algolia
 
         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?(:query_parameters)
-          self.query_parameters = attributes[:query_parameters]
-        end
-
         if attributes.key?(:fallback_parameters)
           self.fallback_parameters = attributes[:fallback_parameters]
         end
@@ -149,6 +151,24 @@ module Algolia
         @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)
@@ -158,8 +178,8 @@ module Algolia
           index_name == other.index_name &&
           threshold == other.threshold &&
           max_recommendations == other.max_recommendations &&
-          model == other.model &&
           query_parameters == other.query_parameters &&
+          model == other.model &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -172,7 +192,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, threshold, max_recommendations, model, query_parameters, fallback_parameters].hash
+        [index_name, threshold, max_recommendations, query_parameters, model, fallback_parameters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/{recommendation_models.rb → related_model.rb}

@@ -5,12 +5,11 @@ require 'time'
 
 module Algolia
   module Recommend
-    class RecommendationModels
+    class RelatedModel
       RELATED_PRODUCTS = "related-products".freeze
-      BOUGHT_TOGETHER = "bought-together".freeze
 
       def self.all_vars
-        @all_vars ||= [RELATED_PRODUCTS, BOUGHT_TOGETHER].freeze
+        @all_vars ||= [RELATED_PRODUCTS].freeze
       end
 
       # Builds the enum from string
@@ -24,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 RecommendationModels.all_vars.include?(value)
+        return value if RelatedModel.all_vars.include?(value)
 
-        raise "Invalid ENUM value #{value} for class #RecommendationModels"
+        raise "Invalid ENUM value #{value} for class #RelatedModel"
       end
     end
   end

data/lib/algolia/models/recommend/{edit.rb → related_products.rb}

@@ -5,14 +5,13 @@ require 'time'
 
 module Algolia
   module Recommend
-    class Edit
-      attr_accessor :type
+    class RelatedProducts
+      attr_accessor :model
 
-      # Text or patterns to remove from the query string.
-      attr_accessor :delete
+      # Unique record identifier.
+      attr_accessor :object_id
 
-      # Text to be added in place of the deleted text inside the query string.
-      attr_accessor :insert
+      attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
         attr_reader :datatype
@@ -39,9 +38,9 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :type => :type,
-          :delete => :delete,
-          :insert => :insert
+          :model => :model,
+          :object_id => :objectID,
+          :fallback_parameters => :fallbackParameters
         }
       end
 
@@ -53,9 +52,9 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :type => :EditType,
-          :delete => :String,
-          :insert => :String
+          :model => :RelatedModel,
+          :object_id => :String,
+          :fallback_parameters => :FallbackParams
         }
       end
 
@@ -68,29 +67,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::Edit` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::RelatedProducts` 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::Edit`. 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::RelatedProducts`. 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?(:type)
-          self.type = attributes[:type]
+        if attributes.key?(:model)
+          self.model = attributes[:model]
+        else
+          self.model = nil
         end
 
-        if attributes.key?(:delete)
-          self.delete = attributes[:delete]
+        if attributes.key?(:object_id)
+          self.object_id = attributes[:object_id]
+        else
+          self.object_id = nil
         end
 
-        if attributes.key?(:insert)
-          self.insert = attributes[:insert]
+        if attributes.key?(:fallback_parameters)
+          self.fallback_parameters = attributes[:fallback_parameters]
         end
       end
 
@@ -100,9 +103,9 @@ module Algolia
         return true if equal?(other)
 
         self.class == other.class &&
-          type == other.type &&
-          delete == other.delete &&
-          insert == other.insert
+          model == other.model &&
+          object_id == other.object_id &&
+          fallback_parameters == other.fallback_parameters
       end
 
       # @see the `==` method
@@ -114,7 +117,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [type, delete, insert].hash
+        [model, object_id, fallback_parameters].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/recommend/{recommendations_query.rb → related_query.rb}

@@ -5,23 +5,23 @@ require 'time'
 
 module Algolia
   module Recommend
-    class RecommendationsQuery
-      # Index name.
+    class RelatedQuery
+      # Index name (case-sensitive).
       attr_accessor :index_name
 
-      # Recommendations with a confidence score lower than `threshold` won't appear in results. > **Note**: Each recommendation has a confidence score of 0 to 100. The closer the score is to 100, the more relevant the recommendations are.
+      # Minimum score a recommendation must have to be included in the response.
       attr_accessor :threshold
 
-      # Maximum number of recommendations to retrieve. If 0, all recommendations will be returned.
+      # 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 :query_parameters
-
       attr_accessor :fallback_parameters
 
       class EnumAttributeValidator
@@ -52,9 +52,9 @@ module Algolia
           :index_name => :indexName,
           :threshold => :threshold,
           :max_recommendations => :maxRecommendations,
+          :query_parameters => :queryParameters,
           :model => :model,
           :object_id => :objectID,
-          :query_parameters => :queryParameters,
           :fallback_parameters => :fallbackParameters
         }
       end
@@ -68,12 +68,12 @@ module Algolia
       def self.types_mapping
         {
           :index_name => :String,
-          :threshold => :Integer,
+          :threshold => :Float,
           :max_recommendations => :Integer,
-          :model => :RecommendationModels,
+          :query_parameters => :SearchParams,
+          :model => :RelatedModel,
           :object_id => :String,
-          :query_parameters => :SearchParamsObject,
-          :fallback_parameters => :SearchParamsObject
+          :fallback_parameters => :FallbackParams
         }
       end
 
@@ -86,7 +86,7 @@ module Algolia
       def self.openapi_all_of
         [
           :BaseRecommendRequest,
-          :BaseRecommendationsQuery
+          :RelatedProducts
         ]
       end
 
@@ -94,14 +94,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::RecommendationsQuery` initialize method"
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::RelatedQuery` 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::RecommendationsQuery`. 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::RelatedQuery`. 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
@@ -115,12 +115,18 @@ module Algolia
 
         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
@@ -133,10 +139,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
@@ -160,6 +162,24 @@ module Algolia
         @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)
@@ -169,9 +189,9 @@ module Algolia
           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 &&
-          query_parameters == other.query_parameters &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -184,7 +204,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, threshold, max_recommendations, model, object_id, query_parameters, fallback_parameters].hash
+        [index_name, threshold, max_recommendations, query_parameters, model, object_id, fallback_parameters].hash
       end
 
       # Builds the object from hash