algolia 3.27.0 → 3.28.0

data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb

@@ -398,8 +398,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/analytics/top_searches_response.rb

@@ -206,8 +206,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/analytics/top_searches_response_with_analytics.rb

@@ -206,8 +206,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb

@@ -206,8 +206,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/around_precision.rb

@@ -105,6 +105,5 @@ module Algolia
         end
       end
     end
-
   end
 end

data/lib/algolia/models/composition/around_radius.rb

@@ -105,6 +105,5 @@ module Algolia
         end
       end
     end
-
   end
 end

data/lib/algolia/models/composition/banner.rb

@@ -208,8 +208,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

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

@@ -213,8 +213,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/banner_image_url.rb

@@ -202,8 +202,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/banner_link.rb

@@ -202,8 +202,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/base_injection_query_parameters.rb

@@ -26,7 +26,7 @@ module Algolia
       # Whether the best matching attribute should be determined by minimum proximity This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting. If true, the best matching attribute is selected based on the minimum proximity of multiple matches. Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
       attr_accessor :attribute_criteria_computed_by_min_proximity
 
-      # Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
+      # Attributes to highlight By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js).
       attr_accessor :attributes_to_highlight
 
       # Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
@@ -35,7 +35,7 @@ module Algolia
       # Attributes for which to enable snippets. Attribute names are case-sensitive Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
       attr_accessor :attributes_to_snippet
 
-      # Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+      # Whether to include a `queryID` attribute in the response The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started).
       attr_accessor :click_analytics
 
       # Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
@@ -44,7 +44,7 @@ module Algolia
       # Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
       attr_accessor :disable_exact_on_attributes
 
-      # Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
+      # Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance). Attribute names are case-sensitive Returning only exact matches can help when - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes). - Reducing the number of matches when you have too many.   This can happen with attributes that are long blocks of text, such as product descriptions Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
       attr_accessor :disable_typo_tolerance_on_attributes
 
       attr_accessor :distinct
@@ -55,7 +55,7 @@ module Algolia
       # Whether to enable Personalization.
       attr_accessor :enable_personalization
 
-      # Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+      # Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking) This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
       attr_accessor :enable_re_ranking
 
       # Whether to enable rules.
@@ -65,7 +65,7 @@ module Algolia
 
       attr_accessor :facet_filters
 
-      # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
+      # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
       attr_accessor :filters
 
       # Whether the search response should include detailed ranking information.
@@ -106,7 +106,7 @@ module Algolia
       # Impact that Personalization should have on this search The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
       attr_accessor :personalization_impact
 
-      # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+      # Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries  This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings. This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages. To support this, you must place the CJK language **first**  **You should always specify a query language.** If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages), or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters. This can lead to unexpected search results. For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations).
       attr_accessor :query_languages
 
       attr_accessor :query_type
@@ -725,8 +725,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/batch_composition_action.rb

@@ -104,6 +104,5 @@ module Algolia
         end
       end
     end
-
   end
 end

data/lib/algolia/models/composition/batch_params.rb

@@ -206,8 +206,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition.rb

@@ -237,8 +237,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_behavior.rb

@@ -203,8 +203,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_id_ranking_info.rb

@@ -214,8 +214,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_rule.rb

@@ -273,8 +273,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_rule_consequence.rb

@@ -204,8 +204,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_rules_batch_params.rb

@@ -204,8 +204,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_run_applied_rules.rb

@@ -204,8 +204,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_run_search_response.rb

@@ -215,8 +215,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_source.rb

@@ -203,8 +203,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/composition_source_search.rb

@@ -213,8 +213,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/compositions_search_response.rb

@@ -205,8 +205,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

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

@@ -231,8 +231,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/dedup_positioning.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# 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 Composition
+    class DedupPositioning
+      HIGHEST = "highest".freeze
+      HIGHEST_INJECTED = "highestInjected".freeze
+
+      def self.all_vars
+        @all_vars ||= [HIGHEST, HIGHEST_INJECTED].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if DedupPositioning.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #DedupPositioning"
+      end
+    end
+  end
+end

data/lib/algolia/models/composition/deduplication.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+# 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 Composition
+    # Deduplication configures the methods used to resolve duplicate items between main search results and injected group results.
+    class Deduplication
+      attr_accessor :positioning
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :positioning => :positioning
+        }
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :positioning => :"DedupPositioning"
+        }
+      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 = {})
+        if (!attributes.is_a?(Hash))
+          raise(
+            ArgumentError,
+            "The input argument (attributes) must be a hash in `Algolia::Deduplication` initialize method"
+          )
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) { |(k, v), h|
+          if (!self.class.attribute_map.key?(k.to_sym))
+            raise(
+              ArgumentError,
+              "`#{k}` is not a valid attribute in `Algolia::Deduplication`. 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
+        }
+
+        if attributes.key?(:positioning)
+          self.positioning = attributes[:positioning]
+        else
+          self.positioning = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if self.equal?(other)
+        self.class == other.class &&
+          positioning == other.positioning
+      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
+        [positioning].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::Composition.const_get(type)
+          klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
+            .build_from_hash(value)
+        end
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      end
+
+      # Returns the object in the form of hash
+      # @return [Hash] Returns the object in the form of hash
+      def to_hash
+        hash = {}
+        self.class.attribute_map.each_pair do |attr, param|
+          value = send(attr)
+          if value.nil?
+            is_nullable = self.class.openapi_nullable.include?(attr)
+            next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+          end
+
+          hash[param] = _to_hash(value)
+        end
+
+        hash
+      end
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to?(:to_hash)
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/algolia/models/composition/delete_composition_action.rb

@@ -205,8 +205,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/delete_composition_rule_action.rb

@@ -205,8 +205,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/distinct.rb

@@ -105,6 +105,5 @@ module Algolia
         end
       end
     end
-
   end
 end

data/lib/algolia/models/composition/error_base.rb

@@ -202,8 +202,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/exhaustive.rb

@@ -243,8 +243,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/external.rb

@@ -219,8 +219,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/external_injected_item.rb

@@ -205,8 +205,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/external_injection.rb

@@ -216,8 +216,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/external_source.rb

@@ -204,8 +204,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end

data/lib/algolia/models/composition/facet_filters.rb

@@ -105,6 +105,5 @@ module Algolia
         end
       end
     end
-
   end
 end

data/lib/algolia/models/composition/facet_hits.rb

@@ -228,8 +228,6 @@ module Algolia
           value
         end
       end
-
     end
-
   end
 end