algolia 3.42.2 → 3.42.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d61077a66bcc7105679f9ed7dcd6b1a4a4ed67b5f10e751604d271382b300a70
-  data.tar.gz: 808ddcec7d187c1a992dc0be37f3b1bc595b1e533b30a9cd6909946a36e041b9
+  metadata.gz: c7ee727296f4ef0f5097f1e9a17f8b76e0a2e04303aeaaa1b84a78a8cc3e899e
+  data.tar.gz: 340f56004e8c495e8585bf43dc0b5a8cf36208c69b239b3d029e7b6b9428e8b7
 SHA512:
-  metadata.gz: c944074227fd43acaf224ead099d48c079316bf98a66afa793e1ac7b84810a0f5a1823f5433ec488df788c2a4cc10efdf4d29134f53f6541f508f4ee359d4637
-  data.tar.gz: 1386f223055c7d8a511283a94647ac8c27995451584c12febb9211d6f6ccee1c42faa2cc59fe24b069bafa64847de6d826d8ec8c971f2ebd5d302c627c1a7b7c
+  metadata.gz: 0c50e49997bdfb4101478f6800ce76397c73d51e7755a1c7c425e6c6565d7c4435c04d792707fbee1c1cc3efc7a7cc8ef2fea740312d579651338c4cac953563
+  data.tar.gz: 2d38395ca0ec5f708b0ba6a3210ff2c60d988829aac5cf80b8de2e767f408722932c899e86902555df17d064569612d9bf86ed5f115f9ee4f6bdff3c1b8a6821

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [3.42.3](https://github.com/algolia/algoliasearch-client-ruby/compare/3.42.2...3.42.3)
+
+- [772f7055cc](https://github.com/algolia/api-clients-automation/commit/772f7055cc) fix(clients): add warning in replace_all_objects for empty objects ([#6610](https://github.com/algolia/api-clients-automation/pull/6610)) by [@eric-zaharia](https://github.com/eric-zaharia/)
+- [ac68c1a79c](https://github.com/algolia/api-clients-automation/commit/ac68c1a79c) fix(specs): add facetFilters back to recommend fallbackParameters ([#6727](https://github.com/algolia/api-clients-automation/pull/6727)) by [@raed667](https://github.com/raed667/)
+
 ## [3.42.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.42.1...3.42.2)
 
 - [035c03ecad](https://github.com/algolia/api-clients-automation/commit/035c03ecad) fix(specs): BREAKING CHANGE – remove recommend query params overridden by the API ([#6604](https://github.com/algolia/api-clients-automation/pull/6604)) by [@raed667](https://github.com/raed667/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.42.2)
+    algolia (3.42.3)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/api/search_client.rb

@@ -3542,6 +3542,8 @@ module Algolia
     # in order to transform records before indexing them to Algolia.
     # `set_transformation_options` must have been called, or the client created via `SearchClient.with_transformation`.
     #
+    # Warning: Calling this method with an empty `objects` array will delete all records currently in the given `index_name`.
+    #
     # @param index_name [String] the `index_name` to replace objects in. (required)
     # @param objects [Array] the array of objects to store in the given Algolia `index_name`. (required)
     # @param batch_size [Integer] the size of each chunk of objects sent in a single push call. (optional, default: 1000)
@@ -3559,6 +3561,12 @@ module Algolia
     )
       assert_ingestion_transporter!
 
+      if objects.empty?
+        @api_client.logger.warn(
+          "replace_all_objects_with_transformation was called with an empty list of objects, which will delete all records currently in the \"#{index_name}\" index."
+        )
+      end
+
       opts = Algolia::ChunkedHelperOptions.resolve(
         chunked_options,
         default_max_retries: Algolia::ChunkedHelperOptions::DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES
@@ -4049,6 +4057,8 @@ module Algolia
 
     # Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
     #
+    # Warning: Calling this method with an empty `objects` array will delete all records currently in the given `index_name`.
+    #
     # @param index_name [String] The `index_name` to replace `objects` in.
     # @param objects [Array] The array of `objects` to store in the given Algolia `index_name`.
     # @param batch_size [int] The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
@@ -4064,6 +4074,12 @@ module Algolia
       request_options = {},
       chunked_options = nil
     )
+      if objects.empty?
+        @api_client.logger.warn(
+          "replace_all_objects was called with an empty list of objects, which will delete all records currently in the \"#{index_name}\" index."
+        )
+      end
+
       opts = Algolia::ChunkedHelperOptions.resolve(
         chunked_options,
         default_max_retries: Algolia::ChunkedHelperOptions::DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES

data/lib/algolia/api_client.rb

@@ -8,11 +8,15 @@ module Algolia
 
     attr_accessor :transporter
 
+    # The logger, shared with the requester when it provides one.
+    attr_reader :logger
+
     # Initializes the ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
       @requester = config.requester || Http::HttpRequester.new("net_http_persistent", LoggerHelper.create)
+      @logger = (@requester.logger if @requester.respond_to?(:logger)) || LoggerHelper.create
       @transporter = Transport::Transport.new(config, @requester)
     end
 

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

@@ -0,0 +1,109 @@
+# 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 Recommend
+    # Filter the search by facet values, so that only records with the same facet values are retrieved.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`.  While it's best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
+    module FacetFilters
+      class << self
+      # List of class defined in oneOf (OpenAPI v3)
+        def openapi_one_of
+          [
+            :"Array<FacetFilters>",
+            :"String"
+          ]
+        end
+
+        # Builds the object
+        # @param [Mixed] Data to be matched against the list of oneOf items
+        # @return [Object] Returns the model or the data itself
+        def build(data)
+          # Go through the list of oneOf items and attempt to identify the appropriate one.
+          # Note:
+          # - We do not attempt to check whether exactly one item matches.
+          # - No advanced validation of types in some cases (e.g. "x: { type: string }" will happily match { x: 123 })
+          #   due to the way the deserialization is made in the base_object template (it just casts without verifying).
+          # - TODO: scalar values are de facto behaving as if they were nullable.
+          # - TODO: logging when debugging is set.
+          openapi_one_of.each do |klass|
+            begin
+              # "nullable: true"
+              next if klass == :AnyType
+              typed_data = find_and_cast_into_type(klass, data)
+              return typed_data if typed_data
+              # rescue all errors so we keep iterating even if the current item lookup raises
+            rescue
+            end
+          end
+
+          openapi_one_of.include?(:AnyType) ? data : nil
+        end
+
+        private
+
+        SchemaMismatchError = Class.new(StandardError)
+
+        def find_and_cast_into_type(klass, data)
+          return if data.nil?
+
+          case klass.to_s
+          when "Boolean"
+            return data if data.instance_of?(TrueClass) || data.instance_of?(FalseClass)
+          when "Float"
+            return data if data.instance_of?(Float)
+          when "Integer"
+            return data if data.instance_of?(Integer)
+          when "Time"
+            return Time.parse(data)
+          when "Date"
+            return Date.parse(data)
+          when "String"
+            return data if data.instance_of?(String)
+            # "type: object"
+          when "Object"
+            return data if data.instance_of?(Hash)
+            # "type: array"
+          when /\AArray<(?<sub_type>.+)>\z/
+            if data.instance_of?(Array)
+              sub_type = Regexp.last_match[:sub_type]
+              return data.map { |item| find_and_cast_into_type(sub_type, item) }
+            end
+            # "type: object" with "additionalProperties: { ... }"
+          when /\AHash<String, (?<sub_type>.+)>\z/
+            if data.instance_of?(Hash) && data.keys.all? { |k| k.instance_of?(Symbol) || k.instance_of?(String) }
+              sub_type = Regexp.last_match[:sub_type]
+              return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
+            end
+            # model
+          else
+            const = Algolia::Recommend.const_get(klass)
+            if const
+              if const.respond_to?(:openapi_one_of)
+                # nested oneOf model
+                model = const.build(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, or doens't have discriminators
+                model = const.build_from_hash(data)
+              end
+
+              return model if model
+            end
+          end
+
+          # if no match by now, raise
+          raise
+        rescue
+          raise SchemaMismatchError, "#{data} doesn't match the #{klass} type"
+        end
+      end
+    end
+  end
+end

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

@@ -242,6 +242,8 @@ module Algolia
 
       attr_accessor :re_ranking_apply_filter
 
+      attr_accessor :facet_filters
+
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
@@ -327,7 +329,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
           :rendering_content => :renderingContent,
           :enable_re_ranking => :enableReRanking,
-          :re_ranking_apply_filter => :reRankingApplyFilter
+          :re_ranking_apply_filter => :reRankingApplyFilter,
+          :facet_filters => :facetFilters
         }
       end
 
@@ -416,7 +419,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
           :rendering_content => :"RenderingContent",
           :enable_re_ranking => :"Boolean",
-          :re_ranking_apply_filter => :"ReRankingApplyFilter"
+          :re_ranking_apply_filter => :"ReRankingApplyFilter",
+          :facet_filters => :"FacetFilters"
         }
       end
 
@@ -849,6 +853,10 @@ module Algolia
         if attributes.key?(:re_ranking_apply_filter)
           self.re_ranking_apply_filter = attributes[:re_ranking_apply_filter]
         end
+
+        if attributes.key?(:facet_filters)
+          self.facet_filters = attributes[:facet_filters]
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -938,7 +946,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
           rendering_content == other.rendering_content &&
           enable_re_ranking == other.enable_re_ranking &&
-          re_ranking_apply_filter == other.re_ranking_apply_filter
+          re_ranking_apply_filter == other.re_ranking_apply_filter &&
+          facet_filters == other.facet_filters
       end
 
       # @see the `==` method
@@ -1033,7 +1042,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity,
           rendering_content,
           enable_re_ranking,
-          re_ranking_apply_filter
+          re_ranking_apply_filter,
+          facet_filters
         ].hash
       end
 

data/lib/algolia/version.rb

@@ -3,5 +3,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.42.2"
+  VERSION = "3.42.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.42.2
+  version: 3.42.3
 platform: ruby
 authors:
 - https://alg.li/support
@@ -734,6 +734,7 @@ files:
 - lib/algolia/models/recommend/error_base.rb
 - lib/algolia/models/recommend/exact_on_single_word_query.rb
 - lib/algolia/models/recommend/exhaustive.rb
+- lib/algolia/models/recommend/facet_filters.rb
 - lib/algolia/models/recommend/facet_ordering.rb
 - lib/algolia/models/recommend/facet_stats.rb
 - lib/algolia/models/recommend/fallback_params.rb