algolia 3.5.0 → 3.5.2

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

@@ -16,7 +16,7 @@ module Algolia
       # Page of search results to retrieve.
       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
 
       # Date and time when the object was updated, in RFC 3339 format.
@@ -112,38 +112,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/settings_response.rb

@@ -18,7 +18,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.
@@ -42,7 +42,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.
@@ -142,7 +142,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.
@@ -655,84 +655,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/user_hit.rb

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

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

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

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

@@ -7,6 +7,7 @@ module Algolia
   module Search
     # 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/user_agent.rb

@@ -8,8 +8,14 @@ module Algolia
 
     # Adds a segment to the UserAgent
     #
-    def add(segment, version)
-      @value += format("; %<segment>s (%<version>s)", segment: segment, version: version)
+    def add(segment, version = nil)
+      if version.nil?
+        @value += format("; %<segment>s", segment: segment)
+      else
+        @value += format("; %<segment>s (%<version>s)", segment: segment, version: version)
+      end
+
+      self
     end
   end
 end

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # 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.
 
 module Algolia
-  VERSION = "3.5.0".freeze
+  VERSION = "3.5.2".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.2
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -419,8 +419,6 @@ files:
 - lib/algolia/models/personalization/get_user_token_response.rb
 - lib/algolia/models/personalization/personalization_strategy_params.rb
 - lib/algolia/models/personalization/set_personalization_strategy_response.rb
-- lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb
-- lib/algolia/models/query-suggestions/base_query_suggestions_configuration_with_index.rb
 - lib/algolia/models/query-suggestions/base_response.rb
 - lib/algolia/models/query-suggestions/config_status.rb
 - lib/algolia/models/query-suggestions/configuration.rb
@@ -428,14 +426,9 @@ files:
 - lib/algolia/models/query-suggestions/configuration_with_index.rb
 - lib/algolia/models/query-suggestions/error_base.rb
 - lib/algolia/models/query-suggestions/facet.rb
-- lib/algolia/models/query-suggestions/get_config_status200_response.rb
-- lib/algolia/models/query-suggestions/get_log_file200_response.rb
 - lib/algolia/models/query-suggestions/languages.rb
 - lib/algolia/models/query-suggestions/log_file.rb
 - lib/algolia/models/query-suggestions/log_level.rb
-- lib/algolia/models/query-suggestions/query_suggestions_configuration.rb
-- lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb
-- lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb
 - lib/algolia/models/query-suggestions/source_index.rb
 - lib/algolia/models/recommend/advanced_syntax_features.rb
 - lib/algolia/models/recommend/alternatives_as_exact.rb
@@ -447,7 +440,6 @@ files:
 - lib/algolia/models/recommend/banner_image.rb
 - lib/algolia/models/recommend/banner_image_url.rb
 - lib/algolia/models/recommend/banner_link.rb
-- lib/algolia/models/recommend/banners.rb
 - lib/algolia/models/recommend/boolean_string.rb
 - lib/algolia/models/recommend/bought_together_query.rb
 - lib/algolia/models/recommend/condition.rb
@@ -540,7 +532,6 @@ files:
 - lib/algolia/models/search/banner_image.rb
 - lib/algolia/models/search/banner_image_url.rb
 - lib/algolia/models/search/banner_link.rb
-- lib/algolia/models/search/banners.rb
 - lib/algolia/models/search/batch_assign_user_ids_params.rb
 - lib/algolia/models/search/batch_dictionary_entries_params.rb
 - lib/algolia/models/search/batch_dictionary_entries_request.rb

data/lib/algolia/models/query-suggestions/base_query_suggestions_configuration_response.rb

@@ -1,230 +0,0 @@
-# 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 QuerySuggestions
-    class BaseQuerySuggestionsConfigurationResponse
-      # API key used to read from your source index.
-      attr_accessor :source_indices_api_key
-
-      # API key used to write and configure your Query Suggestions index.
-      attr_accessor :suggestions_indices_api_key
-
-      # API key used to read from external Algolia indices.
-      attr_accessor :external_indices_api_key
-
-      # Attribute mapping from ruby-style variable name to JSON key.
-      def self.attribute_map
-        {
-          :source_indices_api_key => :sourceIndicesAPIKey,
-          :suggestions_indices_api_key => :suggestionsIndicesAPIKey,
-          :external_indices_api_key => :externalIndicesAPIKey
-        }
-      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
-        {
-          :source_indices_api_key => :String,
-          :suggestions_indices_api_key => :String,
-          :external_indices_api_key => :String
-        }
-      end
-
-      # List of attributes with nullable: true
-      def self.openapi_nullable
-        Set.new([])
-      end
-
-      # Initializes the object
-      # @param [Hash] attributes Model attributes in the form of hash
-      def initialize(attributes = {})
-        unless attributes.is_a?(Hash)
-          raise(
-            ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::BaseQuerySuggestionsConfigurationResponse` 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::BaseQuerySuggestionsConfigurationResponse`. 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?(:source_indices_api_key)
-          self.source_indices_api_key = attributes[:source_indices_api_key]
-        end
-
-        if attributes.key?(:suggestions_indices_api_key)
-          self.suggestions_indices_api_key = attributes[:suggestions_indices_api_key]
-        end
-
-        if attributes.key?(:external_indices_api_key)
-          self.external_indices_api_key = attributes[:external_indices_api_key]
-        end
-      end
-
-      # Checks equality by comparing each attribute.
-      # @param [Object] Object to be compared
-      def ==(other)
-        return true if equal?(other)
-
-        self.class == other.class &&
-          source_indices_api_key == other.source_indices_api_key &&
-          suggestions_indices_api_key == other.suggestions_indices_api_key &&
-          external_indices_api_key == other.external_indices_api_key
-      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
-        [source_indices_api_key, suggestions_indices_api_key, external_indices_api_key].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
-          # model
-        else
-          # models (e.g. Pet) or oneOf
-          klass = Algolia::QuerySuggestions.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