algolia 3.10.2 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd4fd82006d6c1d476f2a5990f20e71863de4daab0b1d34e8ed60f73db4863e8
-  data.tar.gz: f35d07b8971f883cefde61736b1e5e083ab100668b6cc52c721767ed70c8033a
+  metadata.gz: e03e27a671f4b6127d02f16243cb618a72c903783922e011e4554618460461f3
+  data.tar.gz: f294f28279df6d8c8a926d1f0316d9446e81408ff4634548aa483bbc6b0ccc3d
 SHA512:
-  metadata.gz: 31d4c9f1d4cc7c4dc5b837f023b20dd1d6fbbb34397dd2bdb58519630af04e3189350d400b68fdca4b415d963615038ee61804f6093a45b7b93c5ef425eaaec4
-  data.tar.gz: 3294d75374a89dadde273ddaffb85c97509134a416eb145a9cdd054792ff94df08e0f393b2c9db15f419346208ca5b338ea3c75d341b8659bda2b0aaf66abbb8
+  metadata.gz: 67bfbead5107d4e2ff34f09ead938fb187369e7dfe262a844ecd3ffab78193e59c424d1f5fda64fd84346cc745361f4ee08cb772948d7df0d04454a2ef4c3b6e
+  data.tar.gz: aa6e751a43e053fd96364d4b0711663e2f3b1a2be571b61f1c7eaa5a94ea2ec561fb8b8fd91f2e14dafca308691663bf3ce9840916c59e7eda3c60a92ad0729c

data/.github/ISSUE_TEMPLATE/Bug_report.yml

@@ -27,7 +27,7 @@ body:
     id: client
     attributes:
       label: Client
-      description: Which API are you targetting?
+      description: Which API are you targeting?
       options:
         - All
         - AB testing

data/.github/workflows/release.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.3.6
+          ruby-version: 3.4.1
           bundler-cache: true
 
       - uses: rubygems/release-gem@a25424ba2ba8b387abc8ef40807c2c85b96cbe32

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [3.11.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.10.2...3.11.0)
+
+- [b569646304](https://github.com/algolia/api-clients-automation/commit/b569646304) fix(specs): drop singer from ingestion specs ([#4281](https://github.com/algolia/api-clients-automation/pull/4281)) by [@shortcuts](https://github.com/shortcuts/)
+- [b2b5acddab](https://github.com/algolia/api-clients-automation/commit/b2b5acddab) chore(deps): dependencies 2024-12-30 ([#4286](https://github.com/algolia/api-clients-automation/pull/4286)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [37223c9779](https://github.com/algolia/api-clients-automation/commit/37223c9779) feat(clients): cleanup after replaceAllObjects failure ([#3824](https://github.com/algolia/api-clients-automation/pull/3824)) by [@millotp](https://github.com/millotp/)
+- [47b567fd0d](https://github.com/algolia/api-clients-automation/commit/47b567fd0d) chore(deps): dependencies 2025-01-06 ([#4299](https://github.com/algolia/api-clients-automation/pull/4299)) by [@algolia-bot](https://github.com/algolia-bot/)
+- [5328ce8333](https://github.com/algolia/api-clients-automation/commit/5328ce8333) feat(specs): add notification settings to tasks ([#4297](https://github.com/algolia/api-clients-automation/pull/4297)) by [@millotp](https://github.com/millotp/)
+- [653b4f32c0](https://github.com/algolia/api-clients-automation/commit/653b4f32c0) fix(ruby): use discriminators for oneOf ([#4310](https://github.com/algolia/api-clients-automation/pull/4310)) by [@millotp](https://github.com/millotp/)
+- [e7b3898f06](https://github.com/algolia/api-clients-automation/commit/e7b3898f06) feat(clients): add optionnal scopes to replaceAllObjects ([#4296](https://github.com/algolia/api-clients-automation/pull/4296)) by [@millotp](https://github.com/millotp/)
+- [47193ad3d1](https://github.com/algolia/api-clients-automation/commit/47193ad3d1) chore: revert release ([#4314](https://github.com/algolia/api-clients-automation/pull/4314)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [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/)

data/Gemfile.lock

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

data/lib/algolia/api/ingestion_client.rb

@@ -1862,6 +1862,7 @@ module Algolia
     # @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 with_email_notifications [Boolean] If specified, the response only includes tasks with notifications.email.enabled set to this value.
     # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
     # @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)
@@ -1875,6 +1876,7 @@ module Algolia
       source_type = nil,
       destination_id = nil,
       trigger_type = nil,
+      with_email_notifications = nil,
       sort = nil,
       order = nil,
       request_options = {}
@@ -1892,6 +1894,7 @@ module Algolia
       end
 
       query_params[:triggerType] = @api_client.build_collection_param(trigger_type, :csv) unless trigger_type.nil?
+      query_params[:withEmailNotifications] = with_email_notifications unless with_email_notifications.nil?
       query_params[:sort] = sort unless sort.nil?
       query_params[:order] = order unless order.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -1925,6 +1928,7 @@ module Algolia
     # @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 with_email_notifications [Boolean] If specified, the response only includes tasks with notifications.email.enabled set to this value.
     # @param sort [TaskSortKeys] Property by which to sort the list of tasks. (default to 'createdAt')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
     # @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)
@@ -1938,6 +1942,7 @@ module Algolia
       source_type = nil,
       destination_id = nil,
       trigger_type = nil,
+      with_email_notifications = nil,
       sort = nil,
       order = nil,
       request_options = {}
@@ -1951,6 +1956,7 @@ module Algolia
         source_type,
         destination_id,
         trigger_type,
+        with_email_notifications,
         sort,
         order,
         request_options
@@ -2616,7 +2622,7 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Array<Ingestion::Transformation>")
     end
 
-    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
+    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
     #
     # Required API Key ACLs:
     #   - addObject
@@ -2651,7 +2657,7 @@ module Algolia
       @api_client.call_api(:POST, path, new_options)
     end
 
-    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
+    # Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
     #
     # Required API Key ACLs:
     #   - addObject

data/lib/algolia/api/search_client.rb

@@ -3472,69 +3472,74 @@ module Algolia
     # @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.
+    # @param scopes [Array] The `scopes` to keep from the index. Defaults to `['settings', 'rules', 'synonyms']`.
     # @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 [Array<ReplaceAllObjectsResponse>]
-    def replace_all_objects(index_name, objects, batch_size = 1000, request_options = {})
+    def replace_all_objects(
+      index_name,
+      objects,
+      batch_size = 1000,
+      scopes = [Search::ScopeType::SETTINGS, Search::ScopeType::RULES, Search::ScopeType::SYNONYMS],
+      request_options = {}
+    )
       tmp_index_name = index_name + "_tmp_" + rand(10_000_000).to_s
 
-      copy_operation_response = operation_index(
-        index_name,
-        Search::OperationIndexParams.new(
-          operation: Search::OperationType::COPY,
-          destination: tmp_index_name,
-          scope: [
-            Search::ScopeType::SETTINGS,
-            Search::ScopeType::RULES,
-            Search::ScopeType::SYNONYMS
-          ]
-        ),
-        request_options
-      )
+      begin
+        copy_operation_response = operation_index(
+          index_name,
+          Search::OperationIndexParams.new(
+            operation: Search::OperationType::COPY,
+            destination: tmp_index_name,
+            scope: scopes
+          ),
+          request_options
+        )
 
-      batch_responses = chunked_batch(
-        tmp_index_name,
-        objects,
-        Search::Action::ADD_OBJECT,
-        true,
-        batch_size,
-        request_options
-      )
+        batch_responses = chunked_batch(
+          tmp_index_name,
+          objects,
+          Search::Action::ADD_OBJECT,
+          true,
+          batch_size,
+          request_options
+        )
 
-      wait_for_task(tmp_index_name, copy_operation_response.task_id)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id)
 
-      copy_operation_response = operation_index(
-        index_name,
-        Search::OperationIndexParams.new(
-          operation: Search::OperationType::COPY,
-          destination: tmp_index_name,
-          scope: [
-            Search::ScopeType::SETTINGS,
-            Search::ScopeType::RULES,
-            Search::ScopeType::SYNONYMS
-          ]
-        ),
-        request_options
-      )
+        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)
+        wait_for_task(tmp_index_name, copy_operation_response.task_id)
 
-      move_operation_response = operation_index(
-        tmp_index_name,
-        Search::OperationIndexParams.new(
-          operation: Search::OperationType::MOVE,
-          destination: index_name
-        ),
-        request_options
-      )
+        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)
+        wait_for_task(tmp_index_name, move_operation_response.task_id)
 
-      Search::ReplaceAllObjectsResponse.new(
-        copy_operation_response: copy_operation_response,
-        batch_responses: batch_responses,
-        move_operation_response: move_operation_response
-      )
+        Search::ReplaceAllObjectsResponse.new(
+          copy_operation_response: copy_operation_response,
+          batch_responses: batch_responses,
+          move_operation_response: move_operation_response
+        )
+      rescue Exception => e
+        delete_index(tmp_index_name)
+
+        raise e
+      end
     end
 
     def index_exists?(index_name)

data/lib/algolia/models/abtesting/ab_test.rb

@@ -57,11 +57,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/ab_test_configuration.rb

@@ -22,11 +22,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/ab_test_response.rb

@@ -24,11 +24,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/ab_tests_variant.rb

@@ -24,11 +24,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb

@@ -27,9 +27,11 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
+      # Returns the keys that uniquely identify this oneOf variant when present
+      def self.discriminator_attributes
+        [
+          :customSearchParameters
+        ]
       end
 
       # Attribute type mapping.

data/lib/algolia/models/abtesting/add_ab_tests_request.rb

@@ -24,11 +24,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/add_ab_tests_variant.rb

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

data/lib/algolia/models/abtesting/currency.rb

@@ -28,11 +28,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/empty_search.rb

@@ -17,11 +17,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/empty_search_filter.rb

@@ -21,11 +21,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

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

@@ -18,11 +18,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/estimate_ab_test_request.rb

@@ -19,11 +19,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/estimate_ab_test_response.rb

@@ -20,11 +20,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/estimate_configuration.rb

@@ -22,11 +22,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/filter_effects.rb

@@ -19,11 +19,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/list_ab_tests_response.rb

@@ -24,11 +24,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/minimum_detectable_effect.rb

@@ -20,11 +20,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/outliers.rb

@@ -17,11 +17,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/outliers_filter.rb

@@ -21,11 +21,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/schedule_ab_test_response.rb

@@ -16,11 +16,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb

@@ -28,11 +28,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/abtesting/variant.rb

@@ -91,11 +91,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/click_position.rb

@@ -21,11 +21,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/currency_code.rb

@@ -21,11 +21,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb

@@ -28,11 +28,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/daily_average_clicks.rb

@@ -24,11 +24,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/daily_click_through_rates.rb

@@ -28,11 +28,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/daily_conversion_rates.rb

@@ -28,11 +28,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/daily_no_click_rates.rb

@@ -28,11 +28,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {

data/lib/algolia/models/analytics/daily_no_results_rates.rb

@@ -28,11 +28,6 @@ module Algolia
         }
       end
 
-      # Returns all the JSON keys this model knows about
-      def self.acceptable_attributes
-        attribute_map.values
-      end
-
       # Attribute type mapping.
       def self.types_mapping
         {