algolia 3.8.2 → 3.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbf3a0681721633040ecb0140b17558a30960ea7269bc92b811ee7e3061b0c01
-  data.tar.gz: a6192d821fed7c69849d2c0464235d3c83bf47377ac94d270a459e96849033d8
+  metadata.gz: cd4fd82006d6c1d476f2a5990f20e71863de4daab0b1d34e8ed60f73db4863e8
+  data.tar.gz: f35d07b8971f883cefde61736b1e5e083ab100668b6cc52c721767ed70c8033a
 SHA512:
-  metadata.gz: 7bfcf91d318232cffaa4af72e6979cb0fd561d4c299c25e497a17c54809749249c787d4741803d43435dbb7362ea16cfd45c8a5c240ae981d9f0e8607ed784cf
-  data.tar.gz: 29b4a760a9a5ae9d6f409cada459e5db1e69e219590aef04ad9ca1e0069578660cb841ee6980c41b1ad086c208f0b6a79f82c07e206dad6e307af02a3028298f
+  metadata.gz: 31d4c9f1d4cc7c4dc5b837f023b20dd1d6fbbb34397dd2bdb58519630af04e3189350d400b68fdca4b415d963615038ee61804f6093a45b7b93c5ef425eaaec4
+  data.tar.gz: 3294d75374a89dadde273ddaffb85c97509134a416eb145a9cdd054792ff94df08e0f393b2c9db15f419346208ca5b338ea3c75d341b8659bda2b0aaf66abbb8

data/.github/workflows/do-not-edit-this-repository.yml

@@ -1,7 +1,7 @@
 name: Do not edit files in this repository
 
 on:
-  pull_request:
+  pull_request_target:
     types:
       - opened
       - synchronize

data/.github/workflows/release.yml

@@ -21,9 +21,9 @@ jobs:
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2.2
+          ruby-version: 3.3.6
           bundler-cache: true
 
-      - uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31
+      - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32
         with:
           await-release: false

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+## [3.10.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.10.1...3.10.2)
+
+- [0481473fe0](https://github.com/algolia/api-clients-automation/commit/0481473fe0) chore: trigger auto close pr ([#4250](https://github.com/algolia/api-clients-automation/pull/4250)) by [@shortcuts](https://github.com/shortcuts/)
+- [2856fa34a3](https://github.com/algolia/api-clients-automation/commit/2856fa34a3) fix(ruby): Set default hits_per_page for SearchClient#browse_objects using accessor ([#4253](https://github.com/algolia/api-clients-automation/pull/4253)) by [@dtyoung](https://github.com/dtyoung/)
+- [bc8939f542](https://github.com/algolia/api-clients-automation/commit/bc8939f542) fix(clients): support dict in helpers ([#4254](https://github.com/algolia/api-clients-automation/pull/4254)) by [@shortcuts](https://github.com/shortcuts/)
+- [679a8cdb60](https://github.com/algolia/api-clients-automation/commit/679a8cdb60) fix(specs): endpoint level timeout for ingestion ([#4251](https://github.com/algolia/api-clients-automation/pull/4251)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.10.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.10.0...3.10.1)
+
+- [6fb57f9ba](https://github.com/algolia/api-clients-automation/commit/6fb57f9ba) fix(clients): lock version ([#4228](https://github.com/algolia/api-clients-automation/pull/4228)) by [@millotp](https://github.com/millotp/)
+- [3f5ceb540](https://github.com/algolia/api-clients-automation/commit/3f5ceb540) fix(ruby): handle unknown attributes in index_exists ([#4231](https://github.com/algolia/api-clients-automation/pull/4231)) by [@millotp](https://github.com/millotp/)
+- [cd59f445e](https://github.com/algolia/api-clients-automation/commit/cd59f445e) fix(specs): enable watcher for push ([#4229](https://github.com/algolia/api-clients-automation/pull/4229)) by [@shortcuts](https://github.com/shortcuts/)
+- [baf7d6f4d](https://github.com/algolia/api-clients-automation/commit/baf7d6f4d) fix(specs): add `ignoreConjugations` to `AlternativesAsExact` ([#4230](https://github.com/algolia/api-clients-automation/pull/4230)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.10.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.9.0...3.10.0)
+
+- [866d859f8](https://github.com/algolia/api-clients-automation/commit/866d859f8) fix(specs): different summaries for saveObject/addOrUpdate methods ([#4223](https://github.com/algolia/api-clients-automation/pull/4223)) by [@kai687](https://github.com/kai687/)
+- [baf16c689](https://github.com/algolia/api-clients-automation/commit/baf16c689) feat(specs): add `watch` to `pushTask` ingestion ([#4224](https://github.com/algolia/api-clients-automation/pull/4224)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.9.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.8.2...3.9.0)
+
+- [068fdacb5](https://github.com/algolia/api-clients-automation/commit/068fdacb5) feat(specs): add info and link about indexing rate limits ([#4136](https://github.com/algolia/api-clients-automation/pull/4136)) by [@kai687](https://github.com/kai687/)
+- [9e0235697](https://github.com/algolia/api-clients-automation/commit/9e0235697) fix(specs): `nb_api_calls` in `getLogs` response is optional ([#4142](https://github.com/algolia/api-clients-automation/pull/4142)) by [@shortcuts](https://github.com/shortcuts/)
+- [56fd73fb6](https://github.com/algolia/api-clients-automation/commit/56fd73fb6) chore(deps): dependencies 2024-11-25 ([#4145](https://github.com/algolia/api-clients-automation/pull/4145)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [b728c5f25](https://github.com/algolia/api-clients-automation/commit/b728c5f25) fix(specs): `consequence` is required when saving rules ([#4146](https://github.com/algolia/api-clients-automation/pull/4146)) by [@shortcuts](https://github.com/shortcuts/)
+- [afd94fac8](https://github.com/algolia/api-clients-automation/commit/afd94fac8) fix(specs): `saveRule` response type ([#4170](https://github.com/algolia/api-clients-automation/pull/4170)) by [@shortcuts](https://github.com/shortcuts/)
+- [2325c61b8](https://github.com/algolia/api-clients-automation/commit/2325c61b8) feat(clients): allow batch size on objects helper ([#4172](https://github.com/algolia/api-clients-automation/pull/4172)) by [@shortcuts](https://github.com/shortcuts/)
+- [aae74cb38](https://github.com/algolia/api-clients-automation/commit/aae74cb38) fix(specs): remove SFCC source type ([#4190](https://github.com/algolia/api-clients-automation/pull/4190)) by [@millotp](https://github.com/millotp/)
+- [b4809e789](https://github.com/algolia/api-clients-automation/commit/b4809e789) fix(ruby): expose static helper ([#4191](https://github.com/algolia/api-clients-automation/pull/4191)) by [@millotp](https://github.com/millotp/)
+- [254052857](https://github.com/algolia/api-clients-automation/commit/254052857) fix(specs): add sourceType to listTasks ([#4193](https://github.com/algolia/api-clients-automation/pull/4193)) by [@millotp](https://github.com/millotp/)
+- [106d64313](https://github.com/algolia/api-clients-automation/commit/106d64313) feat(generators): allow per-spec timeouts ([#4173](https://github.com/algolia/api-clients-automation/pull/4173)) by [@shortcuts](https://github.com/shortcuts/)
+- [9e1e60f9e](https://github.com/algolia/api-clients-automation/commit/9e1e60f9e) chore(deps): dependencies 2024-12-09 ([#4197](https://github.com/algolia/api-clients-automation/pull/4197)) by [@algolia-bot](https://github.com/algolia-bot/)
+
 ## [3.8.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.8.1...3.8.2)
 
 - [f97e44ce0](https://github.com/algolia/api-clients-automation/commit/f97e44ce0) fix(cts): add tests for HTML error ([#4097](https://github.com/algolia/api-clients-automation/pull/4097)) by [@millotp](https://github.com/millotp/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.8.2)
+    algolia (3.10.2)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
@@ -12,21 +12,23 @@ GEM
   specs:
     base64 (0.2.0)
     connection_pool (2.4.1)
-    faraday (2.11.0)
-      faraday-net_http (>= 2.0, < 3.4)
+    faraday (2.12.2)
+      faraday-net_http (>= 2.0, < 3.5)
+      json
       logger
-    faraday-net_http (3.3.0)
-      net-http
-    faraday-net_http_persistent (2.1.0)
+    faraday-net_http (3.4.0)
+      net-http (>= 0.5.0)
+    faraday-net_http_persistent (2.3.0)
       faraday (~> 2.5)
-      net-http-persistent (~> 4.0)
-    logger (1.6.1)
-    net-http (0.4.1)
+      net-http-persistent (>= 4.0.4, < 5)
+    json (2.9.0)
+    logger (1.6.2)
+    net-http (0.6.0)
       uri
-    net-http-persistent (4.0.4)
+    net-http-persistent (4.0.5)
       connection_pool (~> 2.2)
     rake (13.2.1)
-    uri (0.13.1)
+    uri (1.0.2)
 
 PLATFORMS
   aarch64-linux
@@ -34,7 +36,7 @@ PLATFORMS
 
 DEPENDENCIES
   algolia!
-  bundler
+  bundler (>= 2.4.10)
   rake
 
 BUNDLED WITH

data/algolia.gemspec

@@ -30,6 +30,6 @@ Gem::Specification.new do |s|
 
   s.add_dependency 'net-http-persistent'
 
-  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'bundler', '>= 2.4.10'
   s.add_development_dependency 'rake'
 end

data/lib/algolia/api/abtesting_client.rb

@@ -21,6 +21,18 @@ module Algolia
         region = nil
       end
 
+      if opts.nil? || opts[:connect_timeout].nil?
+        opts[:connect_timeout] = 2000
+      end
+
+      if opts.nil? || opts[:read_timeout].nil?
+        opts[:read_timeout] = 5000
+      end
+
+      if opts.nil? || opts[:write_timeout].nil?
+        opts[:write_timeout] = 30000
+      end
+
       if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
         raise "`region` must be one of the following: #{regions.join(", ")}"
       end

data/lib/algolia/api/analytics_client.rb

@@ -21,6 +21,18 @@ module Algolia
         region = nil
       end
 
+      if opts.nil? || opts[:connect_timeout].nil?
+        opts[:connect_timeout] = 2000
+      end
+
+      if opts.nil? || opts[:read_timeout].nil?
+        opts[:read_timeout] = 5000
+      end
+
+      if opts.nil? || opts[:write_timeout].nil?
+        opts[:write_timeout] = 30000
+      end
+
       if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
         raise "`region` must be one of the following: #{regions.join(", ")}"
       end

data/lib/algolia/api/ingestion_client.rb

@@ -21,6 +21,18 @@ module Algolia
         region = nil
       end
 
+      if opts.nil? || opts[:connect_timeout].nil?
+        opts[:connect_timeout] = 25000
+      end
+
+      if opts.nil? || opts[:read_timeout].nil?
+        opts[:read_timeout] = 25000
+      end
+
+      if opts.nil? || opts[:write_timeout].nil?
+        opts[:write_timeout] = 25000
+      end
+
       if region.nil? || !region.is_a?(String) || !regions.include?(region)
         raise "`region` is required and must be one of the following: #{regions.join(", ")}"
       end
@@ -1847,6 +1859,7 @@ module Algolia
     # @param action [Array<ActionType>] Actions for filtering the list of tasks.
     # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status.
     # @param source_id [Array<String>] Source IDs for filtering the list of tasks.
+    # @param source_type [Array<SourceType>] Filters the tasks with the specified source type.
     # @param destination_id [Array<String>] Destination IDs for filtering the list of tasks.
     # @param trigger_type [Array<TriggerType>] Type of task trigger for filtering the list of tasks.
     # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
@@ -1859,6 +1872,7 @@ module Algolia
       action = nil,
       enabled = nil,
       source_id = nil,
+      source_type = nil,
       destination_id = nil,
       trigger_type = nil,
       sort = nil,
@@ -1872,6 +1886,7 @@ module Algolia
       query_params[:action] = @api_client.build_collection_param(action, :csv) unless action.nil?
       query_params[:enabled] = enabled unless enabled.nil?
       query_params[:sourceID] = @api_client.build_collection_param(source_id, :csv) unless source_id.nil?
+      query_params[:sourceType] = @api_client.build_collection_param(source_type, :csv) unless source_type.nil?
       unless destination_id.nil?
         query_params[:destinationID] = @api_client.build_collection_param(destination_id, :csv)
       end
@@ -1907,6 +1922,7 @@ module Algolia
     # @param action [Array<ActionType>] Actions for filtering the list of tasks.
     # @param enabled [Boolean] Whether to filter the list of tasks by the `enabled` status.
     # @param source_id [Array<String>] Source IDs for filtering the list of tasks.
+    # @param source_type [Array<SourceType>] Filters the tasks with the specified source type.
     # @param destination_id [Array<String>] Destination IDs for filtering the list of tasks.
     # @param trigger_type [Array<TriggerType>] Type of task trigger for filtering the list of tasks.
     # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
@@ -1919,6 +1935,7 @@ module Algolia
       action = nil,
       enabled = nil,
       source_id = nil,
+      source_type = nil,
       destination_id = nil,
       trigger_type = nil,
       sort = nil,
@@ -1931,6 +1948,7 @@ module Algolia
         action,
         enabled,
         source_id,
+        source_type,
         destination_id,
         trigger_type,
         sort,
@@ -2114,9 +2132,10 @@ module Algolia
     #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
+    # @param watch [Boolean] When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def push_task_with_http_info(task_id, push_task_payload, request_options = {})
+    def push_task_with_http_info(task_id, push_task_payload, watch = nil, request_options = {})
       # 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 `push_task`."
@@ -2128,9 +2147,11 @@ module Algolia
 
       path = "/2/tasks/{taskID}/push".sub("{" + "taskID" + "}", Transport.encode_uri(task_id.to_s))
       query_params = {}
+      query_params[:watch] = watch unless watch.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+      request_options[:timeout] ||= 180000
 
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(push_task_payload)
 
@@ -2153,11 +2174,12 @@ module Algolia
     #   - editSettings
     # @param task_id [String] Unique identifier of a task. (required)
     # @param push_task_payload [PushTaskPayload] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required)
+    # @param watch [Boolean] When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [RunResponse]
-    def push_task(task_id, push_task_payload, request_options = {})
-      response = push_task_with_http_info(task_id, push_task_payload, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse")
+    # @return [WatchResponse]
+    def push_task(task_id, push_task_payload, watch = nil, request_options = {})
+      response = push_task_with_http_info(task_id, push_task_payload, watch, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
     end
 
     # Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
@@ -2614,6 +2636,7 @@ module Algolia
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+      request_options[:timeout] ||= 180000
 
       post_body = request_options[:debug_body]
 
@@ -2636,10 +2659,10 @@ module Algolia
     #   - editSettings
     # @param source_id [String] Unique identifier of a source. (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [SourceWatchResponse]
+    # @return [WatchResponse]
     def trigger_docker_source_discover(source_id, request_options = {})
       response = trigger_docker_source_discover_with_http_info(source_id, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::SourceWatchResponse")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
     end
 
     # Try a transformation before creating it.
@@ -3092,6 +3115,7 @@ module Algolia
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+      request_options[:timeout] ||= 180000
 
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_create)
 
@@ -3114,10 +3138,10 @@ module Algolia
     #   - editSettings
     # @param source_create [SourceCreate]
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [SourceWatchResponse]
+    # @return [WatchResponse]
     def validate_source(source_create = nil, request_options = {})
       response = validate_source_with_http_info(source_create, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::SourceWatchResponse")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
     end
 
     # Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
@@ -3145,6 +3169,7 @@ module Algolia
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
       header_params = {}
       header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+      request_options[:timeout] ||= 180000
 
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(source_update)
 
@@ -3168,10 +3193,10 @@ module Algolia
     # @param source_id [String] Unique identifier of a source. (required)
     # @param source_update [SourceUpdate]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
-    # @return [SourceWatchResponse]
+    # @return [WatchResponse]
     def validate_source_before_update(source_id, source_update, request_options = {})
       response = validate_source_before_update_with_http_info(source_id, source_update, request_options)
-      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::SourceWatchResponse")
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::WatchResponse")
     end
 
   end

data/lib/algolia/api/insights_client.rb

@@ -21,6 +21,18 @@ module Algolia
         region = nil
       end
 
+      if opts.nil? || opts[:connect_timeout].nil?
+        opts[:connect_timeout] = 2000
+      end
+
+      if opts.nil? || opts[:read_timeout].nil?
+        opts[:read_timeout] = 5000
+      end
+
+      if opts.nil? || opts[:write_timeout].nil?
+        opts[:write_timeout] = 30000
+      end
+
       if !region.nil? && (!region.is_a?(String) || !regions.include?(region))
         raise "`region` must be one of the following: #{regions.join(", ")}"
       end

data/lib/algolia/api/personalization_client.rb

@@ -21,6 +21,18 @@ module Algolia
         region = nil
       end
 
+      if opts.nil? || opts[:connect_timeout].nil?
+        opts[:connect_timeout] = 2000
+      end
+
+      if opts.nil? || opts[:read_timeout].nil?
+        opts[:read_timeout] = 5000
+      end
+
+      if opts.nil? || opts[:write_timeout].nil?
+        opts[:write_timeout] = 30000
+      end
+
       if region.nil? || !region.is_a?(String) || !regions.include?(region)
         raise "`region` is required and must be one of the following: #{regions.join(", ")}"
       end

data/lib/algolia/api/query_suggestions_client.rb

@@ -21,6 +21,18 @@ module Algolia
         region = nil
       end
 
+      if opts.nil? || opts[:connect_timeout].nil?
+        opts[:connect_timeout] = 2000
+      end
+
+      if opts.nil? || opts[:read_timeout].nil?
+        opts[:read_timeout] = 5000
+      end
+
+      if opts.nil? || opts[:write_timeout].nil?
+        opts[:write_timeout] = 30000
+      end
+
       if region.nil? || !region.is_a?(String) || !regions.include?(region)
         raise "`region` is required and must be one of the following: #{regions.join(", ")}"
       end