algolia 3.5.0 → 3.5.2

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

@@ -178,7 +178,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.
@@ -783,134 +783,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/get_api_key_response.rb

@@ -113,6 +113,8 @@ module Algolia
 
         if attributes.key?(:value)
           self.value = attributes[:value]
+        else
+          self.value = nil
         end
 
         if attributes.key?(:created_at)

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

@@ -62,8 +62,6 @@ module Algolia
           if (value = attributes[:results]).is_a?(Array)
             self.results = value
           end
-        else
-          self.results = nil
         end
       end
 

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

@@ -19,7 +19,7 @@ module Algolia
       # Attributes that can't be retrieved at query time.  This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don't want to include it in the search results. Attribute names are case-sensitive.
       attr_accessor :unretrievable_attributes
 
-      # Words for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+      # Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words). This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
       attr_accessor :disable_typo_tolerance_on_words
 
       # Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).  Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
@@ -43,7 +43,7 @@ module Algolia
       # Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive.  By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes.  To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.  **Modifier**  - `equalOnly(\"ATTRIBUTE\")`.   Support only filtering based on equality comparisons `=` and `!=`.
       attr_accessor :numeric_attributes_for_filtering
 
-      # Controls which separators are indexed.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥. By default, separator characters aren't indexed. With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, a search for `C#` would report two matches.
+      # Control which non-alphanumeric characters are indexed.  By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`). To include such characters, define them with `separatorsToIndex`.  Separators are all non-letter characters except spaces and currency characters, such as $€£¥.  With `separatorsToIndex`, Algolia treats separator characters as separate words. For example, in a search for \"Disney+\", Algolia considers \"Disney\" and \"+\" as two separate words.
       attr_accessor :separators_to_index
 
       # Attributes used for searching. Attribute names are case-sensitive.  By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered.  For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).  **Modifier**  - `unordered(\"ATTRIBUTE\")`.   Ignore the position of a match within the attribute.  Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
@@ -143,7 +143,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.
@@ -647,84 +647,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] pagination_limited_to Value to be assigned
-      def pagination_limited_to=(pagination_limited_to)
-        if pagination_limited_to.nil?
-          raise ArgumentError, "pagination_limited_to cannot be nil"
-        end
-
-        if pagination_limited_to > 20000
-          raise ArgumentError, "invalid value for \"pagination_limited_to\", must be smaller than or equal to 20000."
-        end
-
-        @pagination_limited_to = pagination_limited_to
-      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/log.rb

@@ -210,40 +210,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] query_body Value to be assigned
-      def query_body=(query_body)
-        if query_body.nil?
-          raise ArgumentError, "query_body cannot be nil"
-        end
-
-        if query_body.to_s.length > 1000
-          raise(
-            ArgumentError,
-            "invalid value for \"query_body\", the character length must be smaller than or equal to 1000."
-          )
-        end
-
-        @query_body = query_body
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] answer Value to be assigned
-      def answer=(answer)
-        if answer.nil?
-          raise ArgumentError, "answer cannot be nil"
-        end
-
-        if answer.to_s.length > 1000
-          raise(
-            ArgumentError,
-            "invalid value for \"answer\", the character length must be smaller than or equal to 1000."
-          )
-        end
-
-        @answer = answer
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

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

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

@@ -180,118 +180,6 @@ module Algolia
         end
       end
 
-      # Custom attribute writer method with validation
-      # @param [Object] filters Value to be assigned
-      def filters=(filters)
-        if filters.nil?
-          raise ArgumentError, "filters cannot be nil"
-        end
-
-        if filters < 0
-          raise ArgumentError, "invalid value for \"filters\", must be greater than or equal to 0."
-        end
-
-        @filters = filters
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] first_matched_word Value to be assigned
-      def first_matched_word=(first_matched_word)
-        if first_matched_word.nil?
-          raise ArgumentError, "first_matched_word cannot be nil"
-        end
-
-        if first_matched_word < 0
-          raise ArgumentError, "invalid value for \"first_matched_word\", must be greater than or equal to 0."
-        end
-
-        @first_matched_word = first_matched_word
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] geo_distance Value to be assigned
-      def geo_distance=(geo_distance)
-        if geo_distance.nil?
-          raise ArgumentError, "geo_distance cannot be nil"
-        end
-
-        if geo_distance < 0
-          raise ArgumentError, "invalid value for \"geo_distance\", must be greater than or equal to 0."
-        end
-
-        @geo_distance = geo_distance
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] geo_precision Value to be assigned
-      def geo_precision=(geo_precision)
-        if geo_precision.nil?
-          raise ArgumentError, "geo_precision cannot be nil"
-        end
-
-        if geo_precision < 1
-          raise ArgumentError, "invalid value for \"geo_precision\", must be greater than or equal to 1."
-        end
-
-        @geo_precision = geo_precision
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] nb_exact_words Value to be assigned
-      def nb_exact_words=(nb_exact_words)
-        if nb_exact_words.nil?
-          raise ArgumentError, "nb_exact_words cannot be nil"
-        end
-
-        if nb_exact_words < 0
-          raise ArgumentError, "invalid value for \"nb_exact_words\", must be greater than or equal to 0."
-        end
-
-        @nb_exact_words = nb_exact_words
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] nb_typos Value to be assigned
-      def nb_typos=(nb_typos)
-        if nb_typos.nil?
-          raise ArgumentError, "nb_typos cannot be nil"
-        end
-
-        if nb_typos < 0
-          raise ArgumentError, "invalid value for \"nb_typos\", must be greater than or equal to 0."
-        end
-
-        @nb_typos = nb_typos
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] proximity_distance Value to be assigned
-      def proximity_distance=(proximity_distance)
-        if proximity_distance.nil?
-          raise ArgumentError, "proximity_distance cannot be nil"
-        end
-
-        if proximity_distance < 0
-          raise ArgumentError, "invalid value for \"proximity_distance\", must be greater than or equal to 0."
-        end
-
-        @proximity_distance = proximity_distance
-      end
-
-      # Custom attribute writer method with validation
-      # @param [Object] words Value to be assigned
-      def words=(words)
-        if words.nil?
-          raise ArgumentError, "words cannot be nil"
-        end
-
-        if words < 1
-          raise ArgumentError, "invalid value for \"words\", must be greater than or equal to 1."
-        end
-
-        @words = words
-      end
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

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

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

@@ -92,38 +92,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
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)

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

@@ -9,7 +9,7 @@ module Algolia
       # Dictionary entries matching the search criteria.
       attr_accessor :hits
 
-      # 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
 
       # Number of results (hits).
@@ -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/search/search_for_facet_values_request.rb

@@ -81,20 +81,6 @@ module Algolia
         end
       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
-
       # Checks equality by comparing each attribute.
       # @param [Object] Object to be compared
       def ==(other)