algolia 3.10.2 → 3.12.0

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

@@ -1,3 +1,5 @@
+# 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"
@@ -45,7 +47,6 @@ module Algolia
 
         SchemaMismatchError = Class.new(StandardError)
 
-        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
         def find_and_cast_into_type(klass, data)
           return if data.nil?
 
@@ -84,12 +85,12 @@ module Algolia
               if const.respond_to?(:openapi_one_of)
                 # nested oneOf model
                 model = const.build(data)
-              elsif const.respond_to?(:acceptable_attributes)
-                # raise if data contains keys that are not known to the model
-                raise unless (data.keys - const.acceptable_attributes).empty?
-                model = const.build_from_hash(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
               else
-                # maybe it's an enum
+                # maybe it's an enum, or doens't have discriminators
                 model = const.build_from_hash(data)
               end
 

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

@@ -1,3 +1,5 @@
+# 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"
@@ -18,11 +20,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"

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

@@ -1,3 +1,5 @@
+# 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"
@@ -33,11 +35,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -45,7 +47,6 @@ module Algolia
 
         SchemaMismatchError = Class.new(StandardError)
 
-        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
         def find_and_cast_into_type(klass, data)
           return if data.nil?
 
@@ -84,12 +85,12 @@ module Algolia
               if const.respond_to?(:openapi_one_of)
                 # nested oneOf model
                 model = const.build(data)
-              elsif const.respond_to?(:acceptable_attributes)
-                # raise if data contains keys that are not known to the model
-                raise unless (data.keys - const.acceptable_attributes).empty?
-                model = const.build_from_hash(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
               else
-                # maybe it's an enum
+                # maybe it's an enum, or doens't have discriminators
                 model = const.build_from_hash(data)
               end
 

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

@@ -1,3 +1,5 @@
+# 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"
@@ -20,11 +22,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -28,11 +30,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -140,6 +142,12 @@ module Algolia
       # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
       attr_accessor :max_facet_hits
 
+      # Characters for which diacritics should be preserved.  By default, Algolia removes diacritics from letters. For example, `é` becomes `e`. If this causes issues in your search, you can specify characters that should keep their diacritics.
+      attr_accessor :keep_diacritics_on_characters
+
+      # Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive.  The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.  Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order.  - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
+      attr_accessor :custom_ranking
+
       # 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.
       attr_accessor :attributes_to_retrieve
 
@@ -294,6 +302,8 @@ module Algolia
           :custom_normalization => :customNormalization,
           :attribute_for_distinct => :attributeForDistinct,
           :max_facet_hits => :maxFacetHits,
+          :keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
+          :custom_ranking => :customRanking,
           :attributes_to_retrieve => :attributesToRetrieve,
           :ranking => :ranking,
           :relevancy_strictness => :relevancyStrictness,
@@ -335,11 +345,6 @@ module Algolia
         }
       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
         {
@@ -390,6 +395,8 @@ module Algolia
           :custom_normalization => :"Hash<String, Hash<String, String>>",
           :attribute_for_distinct => :"String",
           :max_facet_hits => :"Integer",
+          :keep_diacritics_on_characters => :"String",
+          :custom_ranking => :"Array<String>",
           :attributes_to_retrieve => :"Array<String>",
           :ranking => :"Array<String>",
           :relevancy_strictness => :"Integer",
@@ -693,6 +700,16 @@ module Algolia
           self.max_facet_hits = attributes[:max_facet_hits]
         end
 
+        if attributes.key?(:keep_diacritics_on_characters)
+          self.keep_diacritics_on_characters = attributes[:keep_diacritics_on_characters]
+        end
+
+        if attributes.key?(:custom_ranking)
+          if (value = attributes[:custom_ranking]).is_a?(Array)
+            self.custom_ranking = value
+          end
+        end
+
         if attributes.key?(:attributes_to_retrieve)
           if (value = attributes[:attributes_to_retrieve]).is_a?(Array)
             self.attributes_to_retrieve = value
@@ -918,6 +935,8 @@ module Algolia
           custom_normalization == other.custom_normalization &&
           attribute_for_distinct == other.attribute_for_distinct &&
           max_facet_hits == other.max_facet_hits &&
+          keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
+          custom_ranking == other.custom_ranking &&
           attributes_to_retrieve == other.attributes_to_retrieve &&
           ranking == other.ranking &&
           relevancy_strictness == other.relevancy_strictness &&
@@ -1015,6 +1034,8 @@ module Algolia
           custom_normalization,
           attribute_for_distinct,
           max_facet_hits,
+          keep_diacritics_on_characters,
+          custom_ranking,
           attributes_to_retrieve,
           ranking,
           relevancy_strictness,

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

@@ -1,3 +1,5 @@
+# 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"

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

@@ -1,3 +1,5 @@
+# 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"
@@ -15,11 +17,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -17,11 +19,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -15,11 +17,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -8,24 +10,19 @@ module Algolia
     # Object ID of the recommendation you want to exclude.
     class HideConsequenceObject
       # Unique record identifier.
-      attr_accessor :object_id
+      attr_accessor :algolia_object_id
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :object_id => :objectID
+          :algolia_object_id => :objectID
         }
       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
         {
-          :object_id => :"String"
+          :algolia_object_id => :"String"
         }
       end
 
@@ -59,8 +56,8 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:object_id)
-          self.object_id = attributes[:object_id]
+        if attributes.key?(:algolia_object_id)
+          self.algolia_object_id = attributes[:algolia_object_id]
         end
       end
 
@@ -69,7 +66,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          object_id == other.object_id
+          algolia_object_id == other.algolia_object_id
       end
 
       # @see the `==` method
@@ -81,7 +78,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [object_id].hash
+        [algolia_object_id].hash
       end
 
       # Builds the object from hash

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

@@ -1,3 +1,5 @@
+# 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"
@@ -45,7 +47,6 @@ module Algolia
 
         SchemaMismatchError = Class.new(StandardError)
 
-        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
         def find_and_cast_into_type(klass, data)
           return if data.nil?
 
@@ -84,12 +85,12 @@ module Algolia
               if const.respond_to?(:openapi_one_of)
                 # nested oneOf model
                 model = const.build(data)
-              elsif const.respond_to?(:acceptable_attributes)
-                # raise if data contains keys that are not known to the model
-                raise unless (data.keys - const.acceptable_attributes).empty?
-                model = const.build_from_hash(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
               else
-                # maybe it's an enum
+                # maybe it's an enum, or doens't have discriminators
                 model = const.build_from_hash(data)
               end
 

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

@@ -1,3 +1,5 @@
+# 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"
@@ -28,9 +30,12 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
+      # Returns the keys that uniquely identify this oneOf variant when present
+      def self.discriminator_attributes
+        [
+          :matchLevel,
+          :matchedWords
+        ]
       end
 
       # Attribute type mapping.

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

@@ -1,3 +1,5 @@
+# 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"
@@ -46,7 +48,6 @@ module Algolia
 
         SchemaMismatchError = Class.new(StandardError)
 
-        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
         def find_and_cast_into_type(klass, data)
           return if data.nil?
 
@@ -85,12 +86,12 @@ module Algolia
               if const.respond_to?(:openapi_one_of)
                 # nested oneOf model
                 model = const.build(data)
-              elsif const.respond_to?(:acceptable_attributes)
-                # raise if data contains keys that are not known to the model
-                raise unless (data.keys - const.acceptable_attributes).empty?
-                model = const.build_from_hash(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
               else
-                # maybe it's an enum
+                # maybe it's an enum, or doens't have discriminators
                 model = const.build_from_hash(data)
               end
 

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

@@ -1,3 +1,5 @@
+# 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"
@@ -17,11 +19,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -44,7 +46,6 @@ module Algolia
 
         SchemaMismatchError = Class.new(StandardError)
 
-        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
         def find_and_cast_into_type(klass, data)
           return if data.nil?
 
@@ -83,12 +84,12 @@ module Algolia
               if const.respond_to?(:openapi_one_of)
                 # nested oneOf model
                 model = const.build(data)
-              elsif const.respond_to?(:acceptable_attributes)
-                # raise if data contains keys that are not known to the model
-                raise unless (data.keys - const.acceptable_attributes).empty?
-                model = const.build_from_hash(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
               else
-                # maybe it's an enum
+                # maybe it's an enum, or doens't have discriminators
                 model = const.build_from_hash(data)
               end
 

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

@@ -1,3 +1,5 @@
+# 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"

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

@@ -1,3 +1,5 @@
+# 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"
@@ -20,7 +22,7 @@ module Algolia
       attr_accessor :model
 
       # Unique record identifier.
-      attr_accessor :object_id
+      attr_accessor :algolia_object_id
 
       attr_accessor :fallback_parameters
 
@@ -32,16 +34,11 @@ module Algolia
           :max_recommendations => :maxRecommendations,
           :query_parameters => :queryParameters,
           :model => :model,
-          :object_id => :objectID,
+          :algolia_object_id => :objectID,
           :fallback_parameters => :fallbackParameters
         }
       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
         {
@@ -50,7 +47,7 @@ module Algolia
           :max_recommendations => :"Integer",
           :query_parameters => :"RecommendSearchParams",
           :model => :"LookingSimilarModel",
-          :object_id => :"String",
+          :algolia_object_id => :"String",
           :fallback_parameters => :"FallbackParams"
         }
       end
@@ -119,10 +116,10 @@ module Algolia
           self.model = nil
         end
 
-        if attributes.key?(:object_id)
-          self.object_id = attributes[:object_id]
+        if attributes.key?(:algolia_object_id)
+          self.algolia_object_id = attributes[:algolia_object_id]
         else
-          self.object_id = nil
+          self.algolia_object_id = nil
         end
 
         if attributes.key?(:fallback_parameters)
@@ -140,7 +137,7 @@ module Algolia
           max_recommendations == other.max_recommendations &&
           query_parameters == other.query_parameters &&
           model == other.model &&
-          object_id == other.object_id &&
+          algolia_object_id == other.algolia_object_id &&
           fallback_parameters == other.fallback_parameters
       end
 
@@ -153,7 +150,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_name, threshold, max_recommendations, query_parameters, model, object_id, fallback_parameters].hash
+        [index_name, threshold, max_recommendations, query_parameters, model, algolia_object_id, fallback_parameters].hash
       end
 
       # Builds the object from hash

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

@@ -1,3 +1,5 @@
+# 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"

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

@@ -1,3 +1,5 @@
+# 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"
@@ -24,11 +26,6 @@ module Algolia
         }
       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
         {

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

@@ -1,3 +1,5 @@
+# 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"
@@ -45,7 +47,6 @@ module Algolia
 
         SchemaMismatchError = Class.new(StandardError)
 
-        # Note: 'File' is missing here because in the regular case we get the data _after_ a call to JSON.parse.
         def find_and_cast_into_type(klass, data)
           return if data.nil?
 
@@ -84,12 +85,12 @@ module Algolia
               if const.respond_to?(:openapi_one_of)
                 # nested oneOf model
                 model = const.build(data)
-              elsif const.respond_to?(:acceptable_attributes)
-                # raise if data contains keys that are not known to the model
-                raise unless (data.keys - const.acceptable_attributes).empty?
-                model = const.build_from_hash(data)
+              elsif const.respond_to?(:discriminator_attributes)
+                if const.discriminator_attributes.all? { |attr| data.key?(attr) }
+                  model = const.build_from_hash(data)
+                end
               else
-                # maybe it's an enum
+                # maybe it's an enum, or doens't have discriminators
                 model = const.build_from_hash(data)
               end