algolia 3.39.0 → 3.40.0

data/lib/algolia/api/search_client.rb

@@ -6,6 +6,49 @@ require "openssl"
 require "base64"
 
 module Algolia
+  # Configuration options for the ingestion transporter used by *_with_transformation helpers.
+  # When passed to SearchClient.with_transformation or set via set_transformation_options,
+  # the ingestion transporter is eagerly created using Ingestion API defaults (25s timeouts,
+  # no compression). Only fields explicitly set here override those defaults.
+  # See https://www.algolia.com/doc/libraries/ruby/v3/methods/ingestion
+  class TransformationOptions
+    attr_accessor(
+      :region,
+      :connect_timeout,
+      :read_timeout,
+      :write_timeout,
+      :hosts,
+      :compression_type,
+      :header_params
+    )
+
+    def initialize(region, opts = {})
+      if region.nil? || region.to_s.strip.empty?
+        raise(
+          ArgumentError,
+          "`region` is required in `TransformationOptions`. See https://www.algolia.com/doc/libraries/ruby/v3/methods/ingestion"
+        )
+      end
+
+      valid_keys = %i[connect_timeout read_timeout write_timeout hosts compression_type header_params]
+      unknown = opts.keys - valid_keys
+      unless unknown.empty?
+        raise(
+          ArgumentError,
+          "Unknown TransformationOptions keys: #{unknown.join(", ")}. Valid keys are: #{valid_keys.join(", ")}"
+        )
+      end
+
+      @region = region
+      @connect_timeout = opts[:connect_timeout]
+      @read_timeout = opts[:read_timeout]
+      @write_timeout = opts[:write_timeout]
+      @hosts = opts[:hosts]
+      @compression_type = opts[:compression_type]
+      @header_params = opts[:header_params]
+    end
+  end
+
   class SearchClient
     attr_accessor :api_client
 
@@ -27,6 +70,10 @@ module Algolia
       end
 
       @api_client = Algolia::ApiClient.new(config)
+      @ingestion_transporter = nil
+      if config.transformation_options
+        @ingestion_transporter = _build_ingestion_transporter(config.transformation_options)
+      end
     end
 
     def self.create(app_id, api_key, opts = {})
@@ -49,6 +96,31 @@ module Algolia
       new(config)
     end
 
+    # Creates a SearchClient configured with a TransformationOptions for use with
+    # *_with_transformation helpers. The ingestion transporter is initialised eagerly using
+    # Ingestion API defaults (25s timeouts); set override fields on TransformationOptions to
+    # change specific defaults.
+    # See https://www.algolia.com/doc/libraries/ruby/v3/methods/ingestion
+    #
+    # @param app_id [String] the Algolia application ID. (required)
+    # @param api_key [String] the Algolia API key. (required)
+    # @param transformation_options [TransformationOptions] the transformation options including region and optional ingestion transporter overrides. (required)
+    # @param opts [Hash] additional configuration options passed to the search client. (optional)
+    # @return [SearchClient]
+    def self.with_transformation(app_id, api_key, transformation_options, opts = {})
+      opts = opts.dup
+      hosts = opts.delete(:hosts)
+      if hosts
+        config = Algolia::Configuration.new(app_id, api_key, hosts, "Search", opts)
+        client = new(config)
+      else
+        client = create(app_id, api_key, opts)
+      end
+
+      client.set_transformation_options(transformation_options)
+      client
+    end
+
     # Helper method to switch the API key used to authenticate the requests.
     #
     # @param api_key [String] the new API key to use.
@@ -123,10 +195,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `add_or_update_object`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `add_or_update_object`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `add_or_update_object`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `add_or_update_object`."
+      end
       # verify the required parameter 'body' is set
       if @api_client.config.client_side_validation && body.nil?
         raise ArgumentError, "Parameter `body` is required when calling `add_or_update_object`."
@@ -229,6 +309,10 @@ module Algolia
       if @api_client.config.client_side_validation && x_algolia_user_id.nil?
         raise ArgumentError, "Parameter `x_algolia_user_id` is required when calling `assign_user_id`."
       end
+      # verify the required parameter 'x_algolia_user_id' is not empty
+      if @api_client.config.client_side_validation && x_algolia_user_id.empty?
+        raise ArgumentError, "Parameter `x_algolia_user_id` is required when calling `assign_user_id`."
+      end
       # verify the required parameter 'assign_user_id_params' is set
       if @api_client.config.client_side_validation && assign_user_id_params.nil?
         raise ArgumentError, "Parameter `assign_user_id_params` is required when calling `assign_user_id`."
@@ -280,6 +364,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `batch`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `batch`."
+      end
       # verify the required parameter 'batch_write_params' is set
       if @api_client.config.client_side_validation && batch_write_params.nil?
         raise ArgumentError, "Parameter `batch_write_params` is required when calling `batch`."
@@ -331,6 +419,10 @@ module Algolia
       if @api_client.config.client_side_validation && x_algolia_user_id.nil?
         raise ArgumentError, "Parameter `x_algolia_user_id` is required when calling `batch_assign_user_ids`."
       end
+      # verify the required parameter 'x_algolia_user_id' is not empty
+      if @api_client.config.client_side_validation && x_algolia_user_id.empty?
+        raise ArgumentError, "Parameter `x_algolia_user_id` is required when calling `batch_assign_user_ids`."
+      end
       # verify the required parameter 'batch_assign_user_ids_params' is set
       if @api_client.config.client_side_validation && batch_assign_user_ids_params.nil?
         raise(
@@ -445,6 +537,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `browse`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `browse`."
+      end
 
       path = "/1/indexes/{indexName}/browse".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -490,6 +586,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `clear_objects`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `clear_objects`."
+      end
 
       path = "/1/indexes/{indexName}/clear".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -535,6 +635,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `clear_rules`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `clear_rules`."
+      end
 
       path = "/1/indexes/{indexName}/rules/clear".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -582,6 +686,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `clear_synonyms`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `clear_synonyms`."
+      end
 
       path = "/1/indexes/{indexName}/synonyms/clear".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -627,6 +735,10 @@ module Algolia
       if @api_client.config.client_side_validation && path.nil?
         raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
       end
+      # verify the required parameter 'path' is not empty
+      if @api_client.config.client_side_validation && path.empty?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_delete`."
+      end
 
       path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
@@ -670,6 +782,10 @@ module Algolia
       if @api_client.config.client_side_validation && path.nil?
         raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
       end
+      # verify the required parameter 'path' is not empty
+      if @api_client.config.client_side_validation && path.empty?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_get`."
+      end
 
       path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
@@ -714,6 +830,10 @@ module Algolia
       if @api_client.config.client_side_validation && path.nil?
         raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
       end
+      # verify the required parameter 'path' is not empty
+      if @api_client.config.client_side_validation && path.empty?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_post`."
+      end
 
       path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
@@ -759,6 +879,10 @@ module Algolia
       if @api_client.config.client_side_validation && path.nil?
         raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
       end
+      # verify the required parameter 'path' is not empty
+      if @api_client.config.client_side_validation && path.empty?
+        raise ArgumentError, "Parameter `path` is required when calling `custom_put`."
+      end
 
       path = "/{path}".sub("{" + "path" + "}", path.to_s)
       query_params = {}
@@ -804,6 +928,10 @@ module Algolia
       if @api_client.config.client_side_validation && key.nil?
         raise ArgumentError, "Parameter `key` is required when calling `delete_api_key`."
       end
+      # verify the required parameter 'key' is not empty
+      if @api_client.config.client_side_validation && key.empty?
+        raise ArgumentError, "Parameter `key` is required when calling `delete_api_key`."
+      end
 
       path = "/1/keys/{key}".sub("{" + "key" + "}", Transport.encode_uri(key.to_s))
       query_params = {}
@@ -849,6 +977,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `delete_by`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `delete_by`."
+      end
       # verify the required parameter 'delete_by_params' is set
       if @api_client.config.client_side_validation && delete_by_params.nil?
         raise ArgumentError, "Parameter `delete_by_params` is required when calling `delete_by`."
@@ -898,6 +1030,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `delete_index`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `delete_index`."
+      end
 
       path = "/1/indexes/{indexName}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -943,10 +1079,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `delete_object`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `delete_object`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_object`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_object`."
+      end
 
       path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
         "{" + "objectID" + "}",
@@ -997,10 +1141,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `delete_rule`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `delete_rule`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_rule`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_rule`."
+      end
 
       path = "/1/indexes/{indexName}/rules/{objectID}"
         .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
@@ -1050,6 +1202,10 @@ module Algolia
       if @api_client.config.client_side_validation && source.nil?
         raise ArgumentError, "Parameter `source` is required when calling `delete_source`."
       end
+      # verify the required parameter 'source' is not empty
+      if @api_client.config.client_side_validation && source.empty?
+        raise ArgumentError, "Parameter `source` is required when calling `delete_source`."
+      end
 
       path = "/1/security/sources/{source}".sub("{" + "source" + "}", Transport.encode_uri(source.to_s))
       query_params = {}
@@ -1096,10 +1252,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `delete_synonym`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `delete_synonym`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_synonym`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `delete_synonym`."
+      end
 
       path = "/1/indexes/{indexName}/synonyms/{objectID}"
         .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
@@ -1149,6 +1313,10 @@ module Algolia
       if @api_client.config.client_side_validation && key.nil?
         raise ArgumentError, "Parameter `key` is required when calling `get_api_key`."
       end
+      # verify the required parameter 'key' is not empty
+      if @api_client.config.client_side_validation && key.empty?
+        raise ArgumentError, "Parameter `key` is required when calling `get_api_key`."
+      end
 
       path = "/1/keys/{key}".sub("{" + "key" + "}", Transport.encode_uri(key.to_s))
       query_params = {}
@@ -1365,10 +1533,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `get_object`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `get_object`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_object`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_object`."
+      end
 
       path = "/1/indexes/{indexName}/{objectID}".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s)).sub(
         "{" + "objectID" + "}",
@@ -1467,10 +1643,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `get_rule`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `get_rule`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_rule`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_rule`."
+      end
 
       path = "/1/indexes/{indexName}/rules/{objectID}"
         .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
@@ -1519,6 +1703,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `get_settings`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `get_settings`."
+      end
 
       path = "/1/indexes/{indexName}/settings".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -1603,10 +1791,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `get_synonym`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `get_synonym`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_synonym`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `get_synonym`."
+      end
 
       path = "/1/indexes/{indexName}/synonyms/{objectID}"
         .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
@@ -1655,6 +1851,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `get_task`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `get_task`."
+      end
       # verify the required parameter 'task_id' is set
       if @api_client.config.client_side_validation && task_id.nil?
         raise ArgumentError, "Parameter `task_id` is required when calling `get_task`."
@@ -1745,6 +1945,10 @@ module Algolia
       if @api_client.config.client_side_validation && user_id.nil?
         raise ArgumentError, "Parameter `user_id` is required when calling `get_user_id`."
       end
+      # verify the required parameter 'user_id' is not empty
+      if @api_client.config.client_side_validation && user_id.empty?
+        raise ArgumentError, "Parameter `user_id` is required when calling `get_user_id`."
+      end
 
       path = "/1/clusters/mapping/{userID}".sub("{" + "userID" + "}", Transport.encode_uri(user_id.to_s))
       query_params = {}
@@ -2040,6 +2244,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `operation_index`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `operation_index`."
+      end
       # verify the required parameter 'operation_index_params' is set
       if @api_client.config.client_side_validation && operation_index_params.nil?
         raise ArgumentError, "Parameter `operation_index_params` is required when calling `operation_index`."
@@ -2098,10 +2306,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `partial_update_object`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `partial_update_object`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `partial_update_object`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `partial_update_object`."
+      end
       # verify the required parameter 'attributes_to_update' is set
       if @api_client.config.client_side_validation && attributes_to_update.nil?
         raise ArgumentError, "Parameter `attributes_to_update` is required when calling `partial_update_object`."
@@ -2172,6 +2388,10 @@ module Algolia
       if @api_client.config.client_side_validation && user_id.nil?
         raise ArgumentError, "Parameter `user_id` is required when calling `remove_user_id`."
       end
+      # verify the required parameter 'user_id' is not empty
+      if @api_client.config.client_side_validation && user_id.empty?
+        raise ArgumentError, "Parameter `user_id` is required when calling `remove_user_id`."
+      end
 
       path = "/1/clusters/mapping/{userID}".sub("{" + "userID" + "}", Transport.encode_uri(user_id.to_s))
       query_params = {}
@@ -2260,6 +2480,10 @@ module Algolia
       if @api_client.config.client_side_validation && key.nil?
         raise ArgumentError, "Parameter `key` is required when calling `restore_api_key`."
       end
+      # verify the required parameter 'key' is not empty
+      if @api_client.config.client_side_validation && key.empty?
+        raise ArgumentError, "Parameter `key` is required when calling `restore_api_key`."
+      end
 
       path = "/1/keys/{key}/restore".sub("{" + "key" + "}", Transport.encode_uri(key.to_s))
       query_params = {}
@@ -2305,6 +2529,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `save_object`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `save_object`."
+      end
       # verify the required parameter 'body' is set
       if @api_client.config.client_side_validation && body.nil?
         raise ArgumentError, "Parameter `body` is required when calling `save_object`."
@@ -2357,10 +2585,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `save_rule`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `save_rule`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `save_rule`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `save_rule`."
+      end
       # verify the required parameter 'rule' is set
       if @api_client.config.client_side_validation && rule.nil?
         raise ArgumentError, "Parameter `rule` is required when calling `save_rule`."
@@ -2424,6 +2660,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `save_rules`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `save_rules`."
+      end
       # verify the required parameter 'rules' is set
       if @api_client.config.client_side_validation && rules.nil?
         raise ArgumentError, "Parameter `rules` is required when calling `save_rules`."
@@ -2492,10 +2732,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `save_synonym`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `save_synonym`."
+      end
       # verify the required parameter 'algolia_object_id' is set
       if @api_client.config.client_side_validation && algolia_object_id.nil?
         raise ArgumentError, "Parameter `algolia_object_id` is required when calling `save_synonym`."
       end
+      # verify the required parameter 'algolia_object_id' is not empty
+      if @api_client.config.client_side_validation && algolia_object_id.empty?
+        raise ArgumentError, "Parameter `algolia_object_id` is required when calling `save_synonym`."
+      end
       # verify the required parameter 'synonym_hit' is set
       if @api_client.config.client_side_validation && synonym_hit.nil?
         raise ArgumentError, "Parameter `synonym_hit` is required when calling `save_synonym`."
@@ -2565,6 +2813,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `save_synonyms`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `save_synonyms`."
+      end
       # verify the required parameter 'synonym_hit' is set
       if @api_client.config.client_side_validation && synonym_hit.nil?
         raise ArgumentError, "Parameter `synonym_hit` is required when calling `save_synonyms`."
@@ -2748,10 +3000,18 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `search_for_facet_values`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `search_for_facet_values`."
+      end
       # verify the required parameter 'facet_name' is set
       if @api_client.config.client_side_validation && facet_name.nil?
         raise ArgumentError, "Parameter `facet_name` is required when calling `search_for_facet_values`."
       end
+      # verify the required parameter 'facet_name' is not empty
+      if @api_client.config.client_side_validation && facet_name.empty?
+        raise ArgumentError, "Parameter `facet_name` is required when calling `search_for_facet_values`."
+      end
 
       path = "/1/indexes/{indexName}/facets/{facetName}/query"
         .sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
@@ -2809,6 +3069,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `search_rules`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `search_rules`."
+      end
 
       path = "/1/indexes/{indexName}/rules/search".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -2855,6 +3119,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `search_single_index`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `search_single_index`."
+      end
 
       path = "/1/indexes/{indexName}/query".sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
       query_params = {}
@@ -2901,6 +3169,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `search_synonyms`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `search_synonyms`."
+      end
 
       path = "/1/indexes/{indexName}/synonyms/search".sub(
         "{" + "indexName" + "}",
@@ -3043,6 +3315,10 @@ module Algolia
       if @api_client.config.client_side_validation && index_name.nil?
         raise ArgumentError, "Parameter `index_name` is required when calling `set_settings`."
       end
+      # verify the required parameter 'index_name' is not empty
+      if @api_client.config.client_side_validation && index_name.empty?
+        raise ArgumentError, "Parameter `index_name` is required when calling `set_settings`."
+      end
       # verify the required parameter 'index_settings' is set
       if @api_client.config.client_side_validation && index_settings.nil?
         raise ArgumentError, "Parameter `index_settings` is required when calling `set_settings`."
@@ -3095,6 +3371,10 @@ module Algolia
       if @api_client.config.client_side_validation && key.nil?
         raise ArgumentError, "Parameter `key` is required when calling `update_api_key`."
       end
+      # verify the required parameter 'key' is not empty
+      if @api_client.config.client_side_validation && key.empty?
+        raise ArgumentError, "Parameter `key` is required when calling `update_api_key`."
+      end
       # verify the required parameter 'api_key' is set
       if @api_client.config.client_side_validation && api_key.nil?
         raise ArgumentError, "Parameter `api_key` is required when calling `update_api_key`."
@@ -3132,18 +3412,231 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Search::UpdateApiKeyResponse")
     end
 
+    # The parent search config MUST NOT leak into the ingestion transporter.
+    def _build_ingestion_transporter(transformation_options)
+      hosts = if transformation_options.hosts
+        transformation_options.hosts
+      else
+        [
+          Transport::StatefulHost.new(
+            "data.#{transformation_options.region}.algolia.com",
+            accept: CallType::READ | CallType::WRITE
+          )
+        ]
+      end
+
+      opts = {}
+      unless transformation_options.connect_timeout.nil?
+        opts[:connect_timeout] = transformation_options.connect_timeout
+      end
+
+      opts[:read_timeout] = transformation_options.read_timeout unless transformation_options.read_timeout.nil?
+      opts[:write_timeout] = transformation_options.write_timeout unless transformation_options.write_timeout.nil?
+      unless transformation_options.compression_type.nil?
+        opts[:compression_type] = transformation_options.compression_type
+      end
+
+      config = Algolia::Configuration.new(
+        @api_client.config.app_id,
+        @api_client.config.api_key,
+        hosts,
+        "Ingestion",
+        opts
+      )
+
+      if transformation_options.header_params
+        config.header_params = config.header_params.merge(transformation_options.header_params)
+      end
+
+      Algolia::IngestionClient.create_with_config(config)
+    end
+
+    # Helper: Sets (or replaces) the ingestion transporter used by *_with_transformation helpers.
+    #
+    # @param transformation_options [TransformationOptions] the transformation options including region and optional ingestion transporter overrides. (required)
+    def set_transformation_options(transformation_options)
+      raise ArgumentError, "`transformation_options` must not be nil" if transformation_options.nil?
+      @ingestion_transporter = _build_ingestion_transporter(transformation_options)
+    end
+
+    def assert_ingestion_transporter!
+      if @ingestion_transporter.nil?
+        raise(
+          ArgumentError,
+          "`transformation_options` must be set in the client config before calling this method. It defaults to the Ingestion API defaults. See https://www.algolia.com/doc/libraries/ruby/v3/methods/ingestion/"
+        )
+      end
+    end
+
+    # Helper: Similar to the `save_objects` method but requires a Push connector to be created first,
+    # 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`.
+    #
+    # @param index_name [String] the `index_name` where the operation will be performed. (required)
+    # @param objects [Array] the array of objects to store in the given Algolia `index_name`. (required)
+    # @param wait_for_tasks [Boolean] whether to wait until every task has been processed. (optional, default: false)
+    # @param batch_size [Integer] the size of each chunk of objects sent in a single push call. (optional, default: 1000)
+    # @param request_options [Hash] the request options to send along with the query. (optional)
+    #
+    # @return [Array<Ingestion::WatchResponse>]
+    def save_objects_with_transformation(
+      index_name,
+      objects,
+      wait_for_tasks = false,
+      batch_size = 1000,
+      request_options = {},
+      chunked_options = nil
+    )
+      assert_ingestion_transporter!
+
+      @ingestion_transporter.chunked_push(
+        index_name,
+        objects,
+        Ingestion::Action::ADD_OBJECT,
+        wait_for_tasks,
+        batch_size,
+        nil,
+        request_options,
+        chunked_options
+      )
+    end
+
+    # Helper: Similar to the `partial_update_objects` method but requires a Push connector to be created first,
+    # 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`.
+    #
+    # @param index_name [String] the `index_name` where the operation will be performed. (required)
+    # @param objects [Array] the array of objects to update in the given Algolia `index_name`. (required)
+    # @param create_if_not_exists [Boolean] whether to create objects that do not exist. (optional, default: false)
+    # @param wait_for_tasks [Boolean] whether to wait until every task has been processed. (optional, default: false)
+    # @param batch_size [Integer] the size of each chunk of objects sent in a single push call. (optional, default: 1000)
+    # @param request_options [Hash] the request options to send along with the query. (optional)
+    #
+    # @return [Array<Ingestion::WatchResponse>]
+    def partial_update_objects_with_transformation(
+      index_name,
+      objects,
+      create_if_not_exists = false,
+      wait_for_tasks = false,
+      batch_size = 1000,
+      request_options = {},
+      chunked_options = nil
+    )
+      assert_ingestion_transporter!
+
+      action = create_if_not_exists ? Ingestion::Action::PARTIAL_UPDATE_OBJECT : Ingestion::Action::PARTIAL_UPDATE_OBJECT_NO_CREATE
+
+      @ingestion_transporter.chunked_push(
+        index_name,
+        objects,
+        action,
+        wait_for_tasks,
+        batch_size,
+        nil,
+        request_options,
+        chunked_options
+      )
+    end
+
+    # Helper: Similar to the `replace_all_objects` method but requires a Push connector to be created first,
+    # 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`.
+    #
+    # @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)
+    # @param scopes [Array] the scopes to keep from the index. (optional, default: settings, rules, synonyms)
+    # @param request_options [Hash] the request options to send along with the query. (optional)
+    #
+    # @return [Search::ReplaceAllObjectsWithTransformationResponse]
+    def replace_all_objects_with_transformation(
+      index_name,
+      objects,
+      batch_size = 1000,
+      scopes = [Search::ScopeType::SETTINGS, Search::ScopeType::RULES, Search::ScopeType::SYNONYMS],
+      request_options = {},
+      chunked_options = nil
+    )
+      assert_ingestion_transporter!
+
+      opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
+      tmp_index_name = index_name + "_tmp_" + rand(10_000_000).to_s
+
+      begin
+        copy_operation_response = operation_index(
+          index_name,
+          Search::OperationIndexParams.new(
+            operation: Search::OperationType::COPY,
+            destination: tmp_index_name,
+            scope: scopes
+          ),
+          request_options
+        )
+
+        watch_responses = @ingestion_transporter.chunked_push(
+          tmp_index_name,
+          objects,
+          Ingestion::Action::ADD_OBJECT,
+          true,
+          batch_size,
+          index_name,
+          request_options,
+          opts
+        )
+
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
+
+        copy_operation_response = operation_index(
+          index_name,
+          Search::OperationIndexParams.new(
+            operation: Search::OperationType::COPY,
+            destination: tmp_index_name,
+            scope: scopes
+          ),
+          request_options
+        )
+
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
+
+        move_operation_response = operation_index(
+          tmp_index_name,
+          Search::OperationIndexParams.new(
+            operation: Search::OperationType::MOVE,
+            destination: index_name
+          ),
+          request_options
+        )
+
+        wait_for_task(tmp_index_name, move_operation_response.task_id, opts.max_retries)
+
+        search_watch_responses = watch_responses.map do |wr|
+          Search::WatchResponse.build_from_hash(wr.to_hash)
+        end
+
+        Search::ReplaceAllObjectsWithTransformationResponse.new(
+          copy_operation_response: copy_operation_response,
+          watch_responses: search_watch_responses,
+          move_operation_response: move_operation_response
+        )
+      rescue Exception => e
+        delete_index(tmp_index_name)
+
+        raise e
+      end
+    end
+
     # Helper: Wait for a task to be published (completed) for a given `index_name` and `task_id`.
     #
     # @param index_name [String] the `index_name` where the operation was performed. (required)
     # @param task_id [Integer] the `task_id` returned in the method response. (required)
-    # @param max_retries [Integer] the maximum number of retries. (optional, default to 50)
+    # @param max_retries [Integer] the maximum number of retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES)
     # @param timeout [Proc] the function to decide how long to wait between retries. (optional)
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `get_task` method.
     # @return [Http::Response] the last get_task response
     def wait_for_task(
       index_name,
       task_id,
-      max_retries = 50,
+      max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
       timeout = -> (retry_count) { [retry_count * 200, 5000].min },
       request_options = {}
     )
@@ -3158,19 +3651,22 @@ module Algolia
         sleep(timeout.call(retries) / 1000.0)
       end
 
-      raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+      raise(
+        ApiError,
+        "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+      )
     end
 
     # Helper: Wait for an application-level task to be published (completed) for a given `task_id`.
     #
     # @param task_id [Integer] the `task_id` returned in the method response. (required)
-    # @param max_retries [Integer] the maximum number of retries. (optional, default to 50)
+    # @param max_retries [Integer] the maximum number of retries. (optional, default to Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES)
     # @param timeout [Proc] the function to decide how long to wait between retries. (optional)
     # @param request_options [Hash] the requestOptions to send along with the query, they will be forwarded to the `get_task` method.
     # @return [Http::Response] the last get_task response
     def wait_for_app_task(
       task_id,
-      max_retries = 50,
+      max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
       timeout = -> (retry_count) { [retry_count * 200, 5000].min },
       request_options = {}
     )
@@ -3185,7 +3681,10 @@ module Algolia
         sleep(timeout.call(retries) / 1000.0)
       end
 
-      raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+      raise(
+        ApiError,
+        "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+      )
     end
 
     # Helper: Wait for an API key to be added, updated or deleted based on a given `operation`.
@@ -3201,7 +3700,7 @@ module Algolia
       key,
       operation,
       api_key = Search::ApiKey.new,
-      max_retries = 50,
+      max_retries = Algolia::ChunkedHelperOptions::DEFAULT_MAX_RETRIES,
       timeout = -> (retry_count) { [retry_count * 200, 5000].min },
       request_options = {}
     )
@@ -3224,7 +3723,10 @@ module Algolia
           sleep(timeout.call(retries) / 1000.0)
         end
 
-        raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+        raise(
+          ApiError,
+          "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+        )
       end
 
       while retries < max_retries
@@ -3243,7 +3745,10 @@ module Algolia
         sleep(timeout.call(retries) / 1000.0)
       end
 
-      raise ApiError, "The maximum number of retries exceeded. (#{max_retries})"
+      raise(
+        ApiError,
+        "Stopped waiting for the task after #{max_retries} retries. This does not mean the operation failed; it may still complete. If you need to keep polling, retry with a higher max_retries."
+      )
     end
 
     # Helper: Iterate on the `browse` method of the client to allow aggregating objects of an index.
@@ -3421,14 +3926,22 @@ module Algolia
     #
     # @return [BatchResponse]
     #
-    def save_objects(index_name, objects, wait_for_tasks = false, batch_size = 1000, request_options = {})
+    def save_objects(
+      index_name,
+      objects,
+      wait_for_tasks = false,
+      batch_size = 1000,
+      request_options = {},
+      chunked_options = nil
+    )
       chunked_batch(
         index_name,
         objects,
         Search::Action::ADD_OBJECT,
         wait_for_tasks,
         batch_size,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3442,14 +3955,22 @@ module Algolia
     #
     # @return [BatchResponse]
     #
-    def delete_objects(index_name, object_ids, wait_for_tasks = false, batch_size = 1000, request_options = {})
+    def delete_objects(
+      index_name,
+      object_ids,
+      wait_for_tasks = false,
+      batch_size = 1000,
+      request_options = {},
+      chunked_options = nil
+    )
       chunked_batch(
         index_name,
         object_ids.map { |id| {"objectID" => id} },
         Search::Action::DELETE_OBJECT,
         wait_for_tasks,
         batch_size,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3470,7 +3991,8 @@ module Algolia
       create_if_not_exists,
       wait_for_tasks = false,
       batch_size = 1000,
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
       chunked_batch(
         index_name,
@@ -3478,7 +4000,8 @@ module Algolia
         create_if_not_exists ? Search::Action::PARTIAL_UPDATE_OBJECT : Search::Action::PARTIAL_UPDATE_OBJECT_NO_CREATE,
         wait_for_tasks,
         batch_size,
-        request_options
+        request_options,
+        chunked_options
       )
     end
 
@@ -3499,8 +4022,10 @@ module Algolia
       action = Action::ADD_OBJECT,
       wait_for_tasks = false,
       batch_size = 1000,
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
+      opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
       responses = []
       objects.each_slice(batch_size) do |chunk|
         requests = chunk.map do |object|
@@ -3512,7 +4037,7 @@ module Algolia
 
       if wait_for_tasks
         responses.each do |response|
-          wait_for_task(index_name, response.task_id)
+          wait_for_task(index_name, response.task_id, opts.max_retries)
         end
       end
 
@@ -3533,8 +4058,10 @@ module Algolia
       objects,
       batch_size = 1000,
       scopes = [Search::ScopeType::SETTINGS, Search::ScopeType::RULES, Search::ScopeType::SYNONYMS],
-      request_options = {}
+      request_options = {},
+      chunked_options = nil
     )
+      opts = Algolia::ChunkedHelperOptions.resolve(chunked_options)
       tmp_index_name = index_name + "_tmp_" + rand(10_000_000).to_s
 
       begin
@@ -3554,10 +4081,11 @@ module Algolia
           Search::Action::ADD_OBJECT,
           true,
           batch_size,
-          request_options
+          request_options,
+          opts
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
 
         copy_operation_response = operation_index(
           index_name,
@@ -3569,7 +4097,7 @@ module Algolia
           request_options
         )
 
-        wait_for_task(tmp_index_name, copy_operation_response.task_id)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id, opts.max_retries)
 
         move_operation_response = operation_index(
           tmp_index_name,
@@ -3580,7 +4108,7 @@ module Algolia
           request_options
         )
 
-        wait_for_task(tmp_index_name, move_operation_response.task_id)
+        wait_for_task(tmp_index_name, move_operation_response.task_id, opts.max_retries)
 
         Search::ReplaceAllObjectsResponse.new(
           copy_operation_response: copy_operation_response,