algolia 3.5.0 → 3.5.2

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

@@ -119,42 +119,6 @@ module Algolia
         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)

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

@@ -130,42 +130,6 @@ module Algolia
         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)

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

@@ -13,10 +13,10 @@ module Algolia
       # Only search for rules with matching context.
       attr_accessor :context
 
-      # Requested page of the API response.
+      # Requested page of the API response.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
       attr_accessor :page
 
-      # Maximum number of hits per page.
+      # Maximum number of hits per page.  Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).  - `hitsPerPage`: sets the number of search results (_hits_) displayed per page. - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.  For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
       attr_accessor :hits_per_page
 
       # Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.
@@ -129,56 +129,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] page Value to be assigned
-      def page=(page)
-        if page.nil?
-          raise ArgumentError, "page cannot be nil"
-        end
-
-        if page < 0
-          raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
-        end
-
-        @page = page
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] hits_per_page Value to be assigned
-      def hits_per_page=(hits_per_page)
-        if hits_per_page.nil?
-          raise ArgumentError, "hits_per_page cannot be nil"
-        end
-
-        if hits_per_page > 1000
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
-        end
-
-        if hits_per_page < 1
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
-        end
-
-        @hits_per_page = hits_per_page
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] max_values_per_facet Value to be assigned
-      def max_values_per_facet=(max_values_per_facet)
-        if max_values_per_facet.nil?
-          raise ArgumentError, "max_values_per_facet cannot be nil"
-        end
-
-        if max_values_per_facet > 1000
-          raise ArgumentError, "invalid value for \"max_values_per_facet\", must be smaller than or equal to 1000."
-        end
-
-        if max_values_per_facet < 1
-          raise ArgumentError, "invalid value for \"max_values_per_facet\", must be greater than or equal to 1."
-        end
-
-        @max_values_per_facet = max_values_per_facet
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -100,20 +100,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] page Value to be assigned
-      def page=(page)
-        if page.nil?
-          raise ArgumentError, "page cannot be nil"
-        end
-
-        if page < 0
-          raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
-        end
-
-        @page = page
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -71,8 +71,6 @@ module Algolia
 
         if attributes.key?(:_score)
           self._score = attributes[:_score]
-        else
-          self._score = nil
         end
 
         if attributes.key?(:facet_name)
@@ -88,24 +86,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] _score Value to be assigned
-      def _score=(_score)
-        if _score.nil?
-          raise ArgumentError, "_score cannot be nil"
-        end
-
-        if _score > 100
-          raise ArgumentError, "invalid value for \"_score\", must be smaller than or equal to 100."
-        end
-
-        if _score < 0
-          raise ArgumentError, "invalid value for \"_score\", must be greater than or equal to 0."
-        end
-
-        @_score = _score
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -132,42 +132,6 @@ module Algolia
         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)

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

@@ -137,42 +137,6 @@ module Algolia
         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)

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

@@ -7,6 +7,7 @@ module Algolia
   module Recommend
     # widgets returned from any rules that are applied to the current search.
     class Widgets
+      # banners defined in the merchandising studio for the given search.
       attr_accessor :banners
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -24,7 +25,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :banners => :"Banners"
+          :banners => :"Array<Banner>"
         }
       end
 
@@ -56,7 +57,9 @@ module Algolia
         }
 
         if attributes.key?(:banners)
-          self.banners = attributes[:banners]
+          if (value = attributes[:banners]).is_a?(Array)
+            self.banners = value
+          end
         end
       end
 

data/lib/algolia/models/search/banner_image.rb

@@ -27,7 +27,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :urls => :"BannerImageUrl",
+          :urls => :"Array<BannerImageUrl>",
           :title => :"String"
         }
       end
@@ -63,7 +63,9 @@ module Algolia
         }
 
         if attributes.key?(:urls)
-          self.urls = attributes[:urls]
+          if (value = attributes[:urls]).is_a?(Array)
+            self.urls = value
+          end
         end
 
         if attributes.key?(:title)

data/lib/algolia/models/search/browse_params_object.rb

@@ -181,7 +181,7 @@ module Algolia
 
       attr_accessor :exact_on_single_word_query
 
-      # Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY/NYC\" are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
+      # Determine which plurals and synonyms should be considered an exact matches.  By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching. For example:  - \"swimsuit\" and \"swimsuits\" are treated the same - \"swimsuit\" and \"swimwear\" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).  - `ignorePlurals`.   Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.  - `singleWordSynonym`.   Single-word synonyms, such as \"NY\" = \"NYC\", are considered exact matches.  - `multiWordsSynonym`.   Multi-word synonyms, such as \"NY\" = \"New York\", are considered exact matches.
       attr_accessor :alternatives_as_exact
 
       # Advanced search syntax features you want to support.  - `exactPhrase`.   Phrases in quotes must match exactly.   For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\".  - `excludeWords`.   Query words prefixed with a `-` must not occur in a record.   For example, `search -engine` matches records that contain \"search\" but not \"engine\".  This setting only has an effect if `advancedSyntax` is true.
@@ -776,134 +776,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] page Value to be assigned
-      def page=(page)
-        if page.nil?
-          raise ArgumentError, "page cannot be nil"
-        end
-
-        if page < 0
-          raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
-        end
-
-        @page = page
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] length Value to be assigned
-      def length=(length)
-        if length.nil?
-          raise ArgumentError, "length cannot be nil"
-        end
-
-        if length > 1000
-          raise ArgumentError, "invalid value for \"length\", must be smaller than or equal to 1000."
-        end
-
-        if length < 0
-          raise ArgumentError, "invalid value for \"length\", must be greater than or equal to 0."
-        end
-
-        @length = length
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] minimum_around_radius Value to be assigned
-      def minimum_around_radius=(minimum_around_radius)
-        if minimum_around_radius.nil?
-          raise ArgumentError, "minimum_around_radius cannot be nil"
-        end
-
-        if minimum_around_radius < 1
-          raise ArgumentError, "invalid value for \"minimum_around_radius\", must be greater than or equal to 1."
-        end
-
-        @minimum_around_radius = minimum_around_radius
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] personalization_impact Value to be assigned
-      def personalization_impact=(personalization_impact)
-        if personalization_impact.nil?
-          raise ArgumentError, "personalization_impact cannot be nil"
-        end
-
-        if personalization_impact > 100
-          raise ArgumentError, "invalid value for \"personalization_impact\", must be smaller than or equal to 100."
-        end
-
-        if personalization_impact < 0
-          raise ArgumentError, "invalid value for \"personalization_impact\", must be greater than or equal to 0."
-        end
-
-        @personalization_impact = personalization_impact
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] hits_per_page Value to be assigned
-      def hits_per_page=(hits_per_page)
-        if hits_per_page.nil?
-          raise ArgumentError, "hits_per_page cannot be nil"
-        end
-
-        if hits_per_page > 1000
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
-        end
-
-        if hits_per_page < 1
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
-        end
-
-        @hits_per_page = hits_per_page
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] min_proximity Value to be assigned
-      def min_proximity=(min_proximity)
-        if min_proximity.nil?
-          raise ArgumentError, "min_proximity cannot be nil"
-        end
-
-        if min_proximity > 7
-          raise ArgumentError, "invalid value for \"min_proximity\", must be smaller than or equal to 7."
-        end
-
-        if min_proximity < 1
-          raise ArgumentError, "invalid value for \"min_proximity\", must be greater than or equal to 1."
-        end
-
-        @min_proximity = min_proximity
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] max_facet_hits Value to be assigned
-      def max_facet_hits=(max_facet_hits)
-        if max_facet_hits.nil?
-          raise ArgumentError, "max_facet_hits cannot be nil"
-        end
-
-        if max_facet_hits > 100
-          raise ArgumentError, "invalid value for \"max_facet_hits\", must be smaller than or equal to 100."
-        end
-
-        @max_facet_hits = max_facet_hits
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] max_values_per_facet Value to be assigned
-      def max_values_per_facet=(max_values_per_facet)
-        if max_values_per_facet.nil?
-          raise ArgumentError, "max_values_per_facet cannot be nil"
-        end
-
-        if max_values_per_facet > 1000
-          raise ArgumentError, "invalid value for \"max_values_per_facet\", must be smaller than or equal to 1000."
-        end
-
-        @max_values_per_facet = max_values_per_facet
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

data/lib/algolia/models/search/browse_response.rb

@@ -20,6 +20,9 @@ module Algolia
 
       attr_accessor :exhaustive
 
+      # Rules applied to the query.
+      attr_accessor :applied_rules
+
       # See the `facetsCount` field of the `exhaustive` object in the response.
       attr_accessor :exhaustive_facets_count
 
@@ -110,6 +113,7 @@ module Algolia
           :around_lat_lng => :aroundLatLng,
           :automatic_radius => :automaticRadius,
           :exhaustive => :exhaustive,
+          :applied_rules => :appliedRules,
           :exhaustive_facets_count => :exhaustiveFacetsCount,
           :exhaustive_nb_hits => :exhaustiveNbHits,
           :exhaustive_typo => :exhaustiveTypo,
@@ -154,6 +158,7 @@ module Algolia
           :around_lat_lng => :"String",
           :automatic_radius => :"String",
           :exhaustive => :"Exhaustive",
+          :applied_rules => :"Array<Object>",
           :exhaustive_facets_count => :"Boolean",
           :exhaustive_nb_hits => :"Boolean",
           :exhaustive_typo => :"Boolean",
@@ -245,6 +250,12 @@ module Algolia
           self.exhaustive = attributes[:exhaustive]
         end
 
+        if attributes.key?(:applied_rules)
+          if (value = attributes[:applied_rules]).is_a?(Array)
+            self.applied_rules = value
+          end
+        end
+
         if attributes.key?(:exhaustive_facets_count)
           self.exhaustive_facets_count = attributes[:exhaustive_facets_count]
         end
@@ -372,67 +383,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] ab_test_variant_id Value to be assigned
-      def ab_test_variant_id=(ab_test_variant_id)
-        if ab_test_variant_id.nil?
-          raise ArgumentError, "ab_test_variant_id cannot be nil"
-        end
-
-        if ab_test_variant_id < 1
-          raise ArgumentError, "invalid value for \"ab_test_variant_id\", must be greater than or equal to 1."
-        end
-
-        @ab_test_variant_id = ab_test_variant_id
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] around_lat_lng Value to be assigned
-      def around_lat_lng=(around_lat_lng)
-        if around_lat_lng.nil?
-          raise ArgumentError, "around_lat_lng cannot be nil"
-        end
-
-        pattern = /^(-?\d+(\.\d+)?),\s*(-?\d+(\.\d+)?)$/
-        if around_lat_lng !~ pattern
-          raise ArgumentError, "invalid value for \"around_lat_lng\", must conform to the pattern #{pattern}."
-        end
-
-        @around_lat_lng = around_lat_lng
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] page Value to be assigned
-      def page=(page)
-        if page.nil?
-          raise ArgumentError, "page cannot be nil"
-        end
-
-        if page < 0
-          raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
-        end
-
-        @page = page
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] hits_per_page Value to be assigned
-      def hits_per_page=(hits_per_page)
-        if hits_per_page.nil?
-          raise ArgumentError, "hits_per_page cannot be nil"
-        end
-
-        if hits_per_page > 1000
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
-        end
-
-        if hits_per_page < 1
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
-        end
-
-        @hits_per_page = hits_per_page
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)
@@ -443,6 +393,7 @@ module Algolia
           around_lat_lng == other.around_lat_lng &&
           automatic_radius == other.automatic_radius &&
           exhaustive == other.exhaustive &&
+          applied_rules == other.applied_rules &&
           exhaustive_facets_count == other.exhaustive_facets_count &&
           exhaustive_nb_hits == other.exhaustive_nb_hits &&
           exhaustive_typo == other.exhaustive_typo &&
@@ -488,6 +439,7 @@ module Algolia
           around_lat_lng,
           automatic_radius,
           exhaustive,
+          applied_rules,
           exhaustive_facets_count,
           exhaustive_nb_hits,
           exhaustive_typo,

data/lib/algolia/models/search/condition.rb

@@ -98,21 +98,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] context Value to be assigned
-      def context=(context)
-        if context.nil?
-          raise ArgumentError, "context cannot be nil"
-        end
-
-        pattern = /[A-Za-z0-9_-]+/
-        if context !~ pattern
-          raise ArgumentError, "invalid value for \"context\", must conform to the pattern #{pattern}."
-        end
-
-        @context = context
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

data/lib/algolia/models/search/consequence.rb

@@ -105,34 +105,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] promote Value to be assigned
-      def promote=(promote)
-        if promote.nil?
-          raise ArgumentError, "promote cannot be nil"
-        end
-
-        if promote.length > 300
-          raise ArgumentError, "invalid value for \"promote\", number of items must be less than or equal to 300."
-        end
-
-        @promote = promote
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] hide Value to be assigned
-      def hide=(hide)
-        if hide.nil?
-          raise ArgumentError, "hide cannot be nil"
-        end
-
-        if hide.length > 50
-          raise ArgumentError, "invalid value for \"hide\", number of items must be less than or equal to 50."
-        end
-
-        @hide = hide
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)