algolia 3.27.0 → 3.28.0

data/lib/algolia/api/composition_client.rb

@@ -11,6 +11,18 @@ module Algolia
       raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
       raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
+      if config.connect_timeout.nil?
+        config.connect_timeout = 2000
+      end
+
+      if config.read_timeout.nil?
+        config.read_timeout = 5000
+      end
+
+      if config.write_timeout.nil?
+        config.write_timeout = 30000
+      end
+
       @api_client = Algolia::ApiClient.new(config)
     end
 
@@ -27,22 +39,10 @@ module Algolia
         .shuffle
 
       config = Algolia::Configuration.new(app_id, api_key, hosts, "Composition", opts)
-      create_with_config(config)
+      new(config)
     end
 
     def self.create_with_config(config)
-      if config.connect_timeout.nil?
-        config.connect_timeout = 2000
-      end
-
-      if config.read_timeout.nil?
-        config.read_timeout = 5000
-      end
-
-      if config.write_timeout.nil?
-        config.write_timeout = 30000
-      end
-
       new(config)
     end
 
@@ -386,7 +386,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Composition::Composition")
     end
 
-    # Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+    # Retrieves a rule by its ID.  To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/composition/search-composition-rules).
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -426,7 +426,7 @@ module Algolia
       @api_client.call_api(:GET, path, new_options)
     end
 
-    # Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](#tag/Rules/operation/searchRules).
+    # Retrieves a rule by its ID.  To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/composition/search-composition-rules).
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -648,7 +648,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Composition::TaskIDResponse")
     end
 
-    # Upsert a Composition Rule for the specified composition ID.
+    # If a composition rule with the provided ID already exists, it's replaced. Otherwise, a new one is added.
     #
     # Required API Key ACLs:
     #   - editSettings
@@ -692,7 +692,7 @@ module Algolia
       @api_client.call_api(:PUT, path, new_options)
     end
 
-    # Upsert a Composition Rule for the specified composition ID.
+    # If a composition rule with the provided ID already exists, it's replaced. Otherwise, a new one is added.
     #
     # Required API Key ACLs:
     #   - editSettings

data/lib/algolia/api/ingestion_client.rb

@@ -11,6 +11,18 @@ module Algolia
       raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
       raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
+      if config.connect_timeout.nil?
+        config.connect_timeout = 25000
+      end
+
+      if config.read_timeout.nil?
+        config.read_timeout = 25000
+      end
+
+      if config.write_timeout.nil?
+        config.write_timeout = 25000
+      end
+
       @api_client = Algolia::ApiClient.new(config)
     end
 
@@ -34,22 +46,10 @@ module Algolia
         )
 
       config = Algolia::Configuration.new(app_id, api_key, hosts, "Ingestion", opts)
-      create_with_config(config)
+      new(config)
     end
 
     def self.create_with_config(config)
-      if config.connect_timeout.nil?
-        config.connect_timeout = 25000
-      end
-
-      if config.read_timeout.nil?
-        config.read_timeout = 25000
-      end
-
-      if config.write_timeout.nil?
-        config.write_timeout = 25000
-      end
-
       new(config)
     end
 
@@ -2149,7 +2149,7 @@ module Algolia
       )
     end
 
-    # Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
+    # Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2200,7 +2200,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
+    # Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
     #
     # Required API Key ACLs:
     #   - addObject

data/lib/algolia/api/insights_client.rb

@@ -11,6 +11,18 @@ module Algolia
       raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
       raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
+      if config.connect_timeout.nil?
+        config.connect_timeout = 2000
+      end
+
+      if config.read_timeout.nil?
+        config.read_timeout = 5000
+      end
+
+      if config.write_timeout.nil?
+        config.write_timeout = 30000
+      end
+
       @api_client = Algolia::ApiClient.new(config)
     end
 
@@ -34,22 +46,10 @@ module Algolia
         )
 
       config = Algolia::Configuration.new(app_id, api_key, hosts, "Insights", opts)
-      create_with_config(config)
+      new(config)
     end
 
     def self.create_with_config(config)
-      if config.connect_timeout.nil?
-        config.connect_timeout = 2000
-      end
-
-      if config.read_timeout.nil?
-        config.read_timeout = 5000
-      end
-
-      if config.write_timeout.nil?
-        config.write_timeout = 30000
-      end
-
       new(config)
     end
 

data/lib/algolia/api/monitoring_client.rb

@@ -11,18 +11,6 @@ module Algolia
       raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
       raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
-      @api_client = Algolia::ApiClient.new(config)
-    end
-
-    def self.create(app_id, api_key, opts = {})
-      hosts = []
-      hosts << Transport::StatefulHost.new("status.algolia.com", accept: CallType::READ | CallType::WRITE)
-
-      config = Algolia::Configuration.new(app_id, api_key, hosts, "Monitoring", opts)
-      create_with_config(config)
-    end
-
-    def self.create_with_config(config)
       if config.connect_timeout.nil?
         config.connect_timeout = 2000
       end
@@ -35,6 +23,18 @@ module Algolia
         config.write_timeout = 30000
       end
 
+      @api_client = Algolia::ApiClient.new(config)
+    end
+
+    def self.create(app_id, api_key, opts = {})
+      hosts = []
+      hosts << Transport::StatefulHost.new("status.algolia.com", accept: CallType::READ | CallType::WRITE)
+
+      config = Algolia::Configuration.new(app_id, api_key, hosts, "Monitoring", opts)
+      new(config)
+    end
+
+    def self.create_with_config(config)
       new(config)
     end
 

data/lib/algolia/api/personalization_client.rb

@@ -11,6 +11,18 @@ module Algolia
       raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
       raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
+      if config.connect_timeout.nil?
+        config.connect_timeout = 2000
+      end
+
+      if config.read_timeout.nil?
+        config.read_timeout = 5000
+      end
+
+      if config.write_timeout.nil?
+        config.write_timeout = 30000
+      end
+
       @api_client = Algolia::ApiClient.new(config)
     end
 
@@ -34,22 +46,10 @@ module Algolia
         )
 
       config = Algolia::Configuration.new(app_id, api_key, hosts, "Personalization", opts)
-      create_with_config(config)
+      new(config)
     end
 
     def self.create_with_config(config)
-      if config.connect_timeout.nil?
-        config.connect_timeout = 2000
-      end
-
-      if config.read_timeout.nil?
-        config.read_timeout = 5000
-      end
-
-      if config.write_timeout.nil?
-        config.write_timeout = 30000
-      end
-
       new(config)
     end
 

data/lib/algolia/api/query_suggestions_client.rb

@@ -11,6 +11,18 @@ module Algolia
       raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
       raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
+      if config.connect_timeout.nil?
+        config.connect_timeout = 2000
+      end
+
+      if config.read_timeout.nil?
+        config.read_timeout = 5000
+      end
+
+      if config.write_timeout.nil?
+        config.write_timeout = 30000
+      end
+
       @api_client = Algolia::ApiClient.new(config)
     end
 
@@ -34,22 +46,10 @@ module Algolia
         )
 
       config = Algolia::Configuration.new(app_id, api_key, hosts, "QuerySuggestions", opts)
-      create_with_config(config)
+      new(config)
     end
 
     def self.create_with_config(config)
-      if config.connect_timeout.nil?
-        config.connect_timeout = 2000
-      end
-
-      if config.read_timeout.nil?
-        config.read_timeout = 5000
-      end
-
-      if config.write_timeout.nil?
-        config.write_timeout = 30000
-      end
-
       new(config)
     end
 

data/lib/algolia/api/recommend_client.rb

@@ -11,6 +11,18 @@ module Algolia
       raise "`app_id` is missing." if config.app_id.nil? || config.app_id == ""
       raise "`api_key` is missing." if config.api_key.nil? || config.api_key == ""
 
+      if config.connect_timeout.nil?
+        config.connect_timeout = 2000
+      end
+
+      if config.read_timeout.nil?
+        config.read_timeout = 5000
+      end
+
+      if config.write_timeout.nil?
+        config.write_timeout = 30000
+      end
+
       @api_client = Algolia::ApiClient.new(config)
     end
 
@@ -27,22 +39,10 @@ module Algolia
         .shuffle
 
       config = Algolia::Configuration.new(app_id, api_key, hosts, "Recommend", opts)
-      create_with_config(config)
+      new(config)
     end
 
     def self.create_with_config(config)
-      if config.connect_timeout.nil?
-        config.connect_timeout = 2000
-      end
-
-      if config.read_timeout.nil?
-        config.read_timeout = 5000
-      end
-
-      if config.write_timeout.nil?
-        config.write_timeout = 30000
-      end
-
       new(config)
     end