algolia 3.5.3 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 579d49fc4b1ff43b579a660ee660f29ede78c357d8be8c6e114815f3c2fbba0d
-  data.tar.gz: 9b7cde4698aea7d6def55213e7f36ff32d8db3c57451c3abe3478ec3ab17a463
+  metadata.gz: 2b69b808ce96019740c30c69c06a65099eaab82d19970c84d232e04d14e817ce
+  data.tar.gz: 91215450649fb00e5cd29de2d8ac38b2c3a1fe64df5598cddd12091ce77263c8
 SHA512:
-  metadata.gz: c438ef675f78aac07488a8e2ddd20dab0f0528d3bc3f7a9a95206a9ae2e66ad17935c42f29a4b431747fbf6071343090248535aecc3c3f998f83c3c92d77f8f9
-  data.tar.gz: c975b0cfe14004c921688ebe712750a5c8fe4806d7b26df2e82b54082ec411ab555ece86451414c88a67c5ad761ec63c92a28da776b745d97c15e13f20b4b1c4
+  metadata.gz: 97c9bcc12f6fa8f7860fbb2daecb2711ed67553f2050d0c770bf7ee5d3f138160715d32a853197f922cddb8258554ced95f407571f78fb2431845279ae5a518a
+  data.tar.gz: c9430142c056ff019be74f2f73b67617825681dee9454d18f9e3c51df485d0a31f07f7f5dc21e541182ff22a18c102856a9a02c757f02c7b5f9268107ce63df0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## [3.6.0](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.4...3.6.0)
+
+- [46ba4b50a](https://github.com/algolia/api-clients-automation/commit/46ba4b50a) fix(ruby): provide default ttl ([#4027](https://github.com/algolia/api-clients-automation/pull/4027)) by [@millotp](https://github.com/millotp/)
+- [312d33731](https://github.com/algolia/api-clients-automation/commit/312d33731) feat(specs): add missing message attribute to GetObjectsResponse [skip-bc] ([#4029](https://github.com/algolia/api-clients-automation/pull/4029)) by [@kombucha](https://github.com/kombucha/)
+- [32f9f4d16](https://github.com/algolia/api-clients-automation/commit/32f9f4d16) fix(specs): support synonyms type in camel case [skip-bc] ([#4031](https://github.com/algolia/api-clients-automation/pull/4031)) by [@shortcuts](https://github.com/shortcuts/)
+- [7f5fe6b68](https://github.com/algolia/api-clients-automation/commit/7f5fe6b68) feat(clients): expose waitForTasks to batch helpers [skip-bc] ([#4030](https://github.com/algolia/api-clients-automation/pull/4030)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.5.4](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.3...3.5.4)
+
+- [1f36e8f93](https://github.com/algolia/api-clients-automation/commit/1f36e8f93) fix(specs): results in getObjects is required ([#4024](https://github.com/algolia/api-clients-automation/pull/4024)) by [@shortcuts](https://github.com/shortcuts/)
+
 ## [3.5.3](https://github.com/algolia/algoliasearch-client-ruby/compare/3.5.2...3.5.3)
 
 - [fe2c8440e](https://github.com/algolia/api-clients-automation/commit/fe2c8440e) docs(analytics): constrain pagination only to limit query parameter ([#4012](https://github.com/algolia/api-clients-automation/pull/4012)) by [@febeck](https://github.com/febeck/)

data/Gemfile.lock

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

data/lib/algolia/api/search_client.rb

@@ -3333,16 +3333,17 @@ module Algolia
     #
     # @param index_name [String]: The `index_name` to save `objects` in.
     # @param objects [Array]: The array of `objects` to store in the given Algolia `indexName`.
+    # @param wait_for_tasks [Boolean]: Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
     # @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 [BatchResponse]
     #
-    def save_objects(index_name, objects, request_options = {})
+    def save_objects(index_name, objects, wait_for_tasks = false, request_options = {})
       chunked_batch(
         index_name,
         objects,
         Search::Action::ADD_OBJECT,
-        false,
+        wait_for_tasks,
         1000,
         request_options
       )
@@ -3352,16 +3353,17 @@ module Algolia
     #
     # @param index_name [String]: The `index_name` to delete `object_ids` from.
     # @param object_ids [Array]: The object_ids to delete.
+    # @param wait_for_tasks [Boolean]: Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
     # @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 [BatchResponse]
     #
-    def delete_objects(index_name, object_ids, request_options = {})
+    def delete_objects(index_name, object_ids, wait_for_tasks = false, request_options = {})
       chunked_batch(
         index_name,
         object_ids.map { |id| {"objectID" => id} },
         Search::Action::DELETE_OBJECT,
-        false,
+        wait_for_tasks,
         1000,
         request_options
       )
@@ -3372,16 +3374,17 @@ module Algolia
     # @param index_name [String]: The `index_name` to delete `object_ids` from.
     # @param objects [Array]: The objects to partially update.
     # @param create_if_not_exists [Boolean]: To be provided if non-existing objects are passed, otherwise, the call will fail.
+    # @param wait_for_tasks [Boolean] Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
     # @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 [BatchResponse]
     #
-    def partial_update_objects(index_name, objects, create_if_not_exists, request_options = {})
+    def partial_update_objects(index_name, objects, create_if_not_exists, wait_for_tasks = false, request_options = {})
       chunked_batch(
         index_name,
         objects,
         create_if_not_exists ? Search::Action::PARTIAL_UPDATE_OBJECT : Search::Action::PARTIAL_UPDATE_OBJECT_NO_CREATE,
-        false,
+        wait_for_tasks,
         1000,
         request_options
       )

data/lib/algolia/defaults.rb

@@ -0,0 +1,5 @@
+module Algolia
+  module Defaults
+    TTL = 300
+  end
+end

data/lib/algolia/models/search/get_objects_response.rb

@@ -6,12 +6,16 @@ require "time"
 module Algolia
   module Search
     class GetObjectsResponse
+      # An optional status message.
+      attr_accessor :message
+
       # Retrieved records.
       attr_accessor :results
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
+          :message => :message,
           :results => :results
         }
       end
@@ -24,6 +28,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
+          :message => :"String",
           :results => :"Array<Object>"
         }
       end
@@ -58,10 +63,16 @@ module Algolia
           h[k.to_sym] = v
         }
 
+        if attributes.key?(:message)
+          self.message = attributes[:message]
+        end
+
         if attributes.key?(:results)
           if (value = attributes[:results]).is_a?(Array)
             self.results = value
           end
+        else
+          self.results = nil
         end
       end
 
@@ -70,6 +81,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
+          message == other.message &&
           results == other.results
       end
 
@@ -82,7 +94,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [results].hash
+        [message, results].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/search/synonym_type.rb

@@ -11,9 +11,21 @@ module Algolia
       ALTCORRECTION1 = "altcorrection1".freeze
       ALTCORRECTION2 = "altcorrection2".freeze
       PLACEHOLDER = "placeholder".freeze
+      ONE_WAY_SYNONYM = "oneWaySynonym".freeze
+      ALT_CORRECTION1 = "altCorrection1".freeze
+      ALT_CORRECTION2 = "altCorrection2".freeze
 
       def self.all_vars
-        @all_vars ||= [SYNONYM, ONEWAYSYNONYM, ALTCORRECTION1, ALTCORRECTION2, PLACEHOLDER].freeze
+        @all_vars ||= [
+          SYNONYM,
+          ONEWAYSYNONYM,
+          ALTCORRECTION1,
+          ALTCORRECTION2,
+          PLACEHOLDER,
+          ONE_WAY_SYNONYM,
+          ALT_CORRECTION1,
+          ALT_CORRECTION2
+        ].freeze
       end
 
       # Builds the enum from string

data/lib/algolia/version.rb

@@ -1,5 +1,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 
 module Algolia
-  VERSION = "3.5.3".freeze
+  VERSION = "3.6.0".freeze
 end

data/lib/algolia.rb

@@ -5,6 +5,7 @@
 # Common files
 require "algolia/api_client"
 require "algolia/api_error"
+require "algolia/defaults"
 require "algolia/error"
 require "algolia/version"
 require "algolia/configuration"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.5.3
+  version: 3.6.0
 platform: ruby
 authors:
 - https://alg.li/support
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-21 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -143,6 +143,7 @@ files:
 - lib/algolia/api_client.rb
 - lib/algolia/api_error.rb
 - lib/algolia/configuration.rb
+- lib/algolia/defaults.rb
 - lib/algolia/error.rb
 - lib/algolia/logger_helper.rb
 - lib/algolia/models/abtesting/ab_test.rb