@algolia/client-search 5.24.0 → 5.26.0

package/dist/fetch.d.ts

@@ -1240,7 +1240,7 @@ type SemanticSearch = {
 /**
  * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
  */
-type TypoToleranceEnum = 'min' | 'strict';
+type TypoToleranceEnum = 'min' | 'strict' | 'true' | 'false';
 
 /**
  * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
@@ -2269,7 +2269,7 @@ type SecuredApiKeyRestrictions = {
 /**
  * Properties for the `addOrUpdateObject` method.
  */
-type AddOrUpdateObjectProps = {
+type AddOrUpdateObjectProps<T extends object> = {
     /**
      * Name of the index on which to perform the operation.
      */
@@ -2281,7 +2281,7 @@ type AddOrUpdateObjectProps = {
     /**
      * The record. A schemaless object with attributes that are useful in the context of search and discovery.
      */
-    body: Record<string, unknown>;
+    body: T;
 };
 /**
  * Properties for the `assignUserId` method.
@@ -2729,7 +2729,7 @@ type RestoreApiKeyProps = {
 /**
  * Properties for the `saveObject` method.
  */
-type SaveObjectProps = {
+type SaveObjectProps<T extends object> = {
     /**
      * Name of the index on which to perform the operation.
      */
@@ -2737,7 +2737,7 @@ type SaveObjectProps = {
     /**
      * The record. A schemaless object with attributes that are useful in the context of search and discovery.
      */
-    body: Record<string, unknown>;
+    body: T;
 };
 /**
  * Properties for the `saveRule` method.
@@ -3047,7 +3047,7 @@ type AccountCopyIndexOptions = {
     destinationIndexName: string;
 };
 
-declare const apiClientVersion = "5.24.0";
+declare const apiClientVersion = "5.26.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3174,7 +3174,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObjects - The `saveObjects` object.
      * @param saveObjects.indexName - The `indexName` to save `objects` in.
      * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param saveObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -3186,7 +3186,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param deleteObjects - The `deleteObjects` object.
      * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
      * @param deleteObjects.objectIDs - The objectIDs to delete.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param deleteObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -3199,7 +3199,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
      * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
      * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param partialUpdateObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
@@ -3260,7 +3260,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    addOrUpdateObject({ indexName, objectID, body }: AddOrUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
+    addOrUpdateObject<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
     /**
      * Adds a source to the list of allowed sources.
      *
@@ -3424,7 +3424,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     deleteIndex({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
-     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
+     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteBy` operation](#tag/Records/operation/deleteBy).
      *
      * Required API Key ACLs:
      *  - deleteObject
@@ -3552,7 +3552,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves an object with non-null index settings.
      *
      * Required API Key ACLs:
-     *  - search
+     *  - settings
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3736,7 +3736,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    saveObject({ indexName, body }: SaveObjectProps, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
+    saveObject<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
     /**
      * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced.  To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
      *

package/dist/node.d.cts

@@ -1240,7 +1240,7 @@ type SemanticSearch = {
 /**
  * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
  */
-type TypoToleranceEnum = 'min' | 'strict';
+type TypoToleranceEnum = 'min' | 'strict' | 'true' | 'false';
 
 /**
  * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
@@ -2269,7 +2269,7 @@ type SecuredApiKeyRestrictions = {
 /**
  * Properties for the `addOrUpdateObject` method.
  */
-type AddOrUpdateObjectProps = {
+type AddOrUpdateObjectProps<T extends object> = {
     /**
      * Name of the index on which to perform the operation.
      */
@@ -2281,7 +2281,7 @@ type AddOrUpdateObjectProps = {
     /**
      * The record. A schemaless object with attributes that are useful in the context of search and discovery.
      */
-    body: Record<string, unknown>;
+    body: T;
 };
 /**
  * Properties for the `assignUserId` method.
@@ -2729,7 +2729,7 @@ type RestoreApiKeyProps = {
 /**
  * Properties for the `saveObject` method.
  */
-type SaveObjectProps = {
+type SaveObjectProps<T extends object> = {
     /**
      * Name of the index on which to perform the operation.
      */
@@ -2737,7 +2737,7 @@ type SaveObjectProps = {
     /**
      * The record. A schemaless object with attributes that are useful in the context of search and discovery.
      */
-    body: Record<string, unknown>;
+    body: T;
 };
 /**
  * Properties for the `saveRule` method.
@@ -3047,7 +3047,7 @@ type AccountCopyIndexOptions = {
     destinationIndexName: string;
 };
 
-declare const apiClientVersion = "5.24.0";
+declare const apiClientVersion = "5.26.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3174,7 +3174,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObjects - The `saveObjects` object.
      * @param saveObjects.indexName - The `indexName` to save `objects` in.
      * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param saveObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -3186,7 +3186,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param deleteObjects - The `deleteObjects` object.
      * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
      * @param deleteObjects.objectIDs - The objectIDs to delete.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param deleteObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -3199,7 +3199,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
      * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
      * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param partialUpdateObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
@@ -3260,7 +3260,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    addOrUpdateObject({ indexName, objectID, body }: AddOrUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
+    addOrUpdateObject<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
     /**
      * Adds a source to the list of allowed sources.
      *
@@ -3424,7 +3424,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     deleteIndex({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
-     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
+     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteBy` operation](#tag/Records/operation/deleteBy).
      *
      * Required API Key ACLs:
      *  - deleteObject
@@ -3552,7 +3552,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves an object with non-null index settings.
      *
      * Required API Key ACLs:
-     *  - search
+     *  - settings
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3736,7 +3736,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    saveObject({ indexName, body }: SaveObjectProps, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
+    saveObject<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
     /**
      * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced.  To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
      *

package/dist/node.d.ts

@@ -1240,7 +1240,7 @@ type SemanticSearch = {
 /**
  * - `min`. Return matches with the lowest number of typos.   For example, if you have matches without typos, only include those.   But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos.   With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
  */
-type TypoToleranceEnum = 'min' | 'strict';
+type TypoToleranceEnum = 'min' | 'strict' | 'true' | 'false';
 
 /**
  * Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.  If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
@@ -2269,7 +2269,7 @@ type SecuredApiKeyRestrictions = {
 /**
  * Properties for the `addOrUpdateObject` method.
  */
-type AddOrUpdateObjectProps = {
+type AddOrUpdateObjectProps<T extends object> = {
     /**
      * Name of the index on which to perform the operation.
      */
@@ -2281,7 +2281,7 @@ type AddOrUpdateObjectProps = {
     /**
      * The record. A schemaless object with attributes that are useful in the context of search and discovery.
      */
-    body: Record<string, unknown>;
+    body: T;
 };
 /**
  * Properties for the `assignUserId` method.
@@ -2729,7 +2729,7 @@ type RestoreApiKeyProps = {
 /**
  * Properties for the `saveObject` method.
  */
-type SaveObjectProps = {
+type SaveObjectProps<T extends object> = {
     /**
      * Name of the index on which to perform the operation.
      */
@@ -2737,7 +2737,7 @@ type SaveObjectProps = {
     /**
      * The record. A schemaless object with attributes that are useful in the context of search and discovery.
      */
-    body: Record<string, unknown>;
+    body: T;
 };
 /**
  * Properties for the `saveRule` method.
@@ -3047,7 +3047,7 @@ type AccountCopyIndexOptions = {
     destinationIndexName: string;
 };
 
-declare const apiClientVersion = "5.24.0";
+declare const apiClientVersion = "5.26.0";
 declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
     transporter: _algolia_client_common.Transporter;
     /**
@@ -3174,7 +3174,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObjects - The `saveObjects` object.
      * @param saveObjects.indexName - The `indexName` to save `objects` in.
      * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param saveObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -3186,7 +3186,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param deleteObjects - The `deleteObjects` object.
      * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
      * @param deleteObjects.objectIDs - The objectIDs to delete.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param deleteObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -3199,7 +3199,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
      * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
      * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param partialUpdateObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
@@ -3260,7 +3260,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param addOrUpdateObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    addOrUpdateObject({ indexName, objectID, body }: AddOrUpdateObjectProps, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
+    addOrUpdateObject<T extends object>({ indexName, objectID, body }: AddOrUpdateObjectProps<T>, requestOptions?: RequestOptions): Promise<UpdatedAtWithObjectIdResponse>;
     /**
      * Adds a source to the list of allowed sources.
      *
@@ -3424,7 +3424,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      */
     deleteIndex({ indexName }: DeleteIndexProps, requestOptions?: RequestOptions): Promise<DeletedAtResponse>;
     /**
-     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
+     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteBy` operation](#tag/Records/operation/deleteBy).
      *
      * Required API Key ACLs:
      *  - deleteObject
@@ -3552,7 +3552,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * Retrieves an object with non-null index settings.
      *
      * Required API Key ACLs:
-     *  - search
+     *  - settings
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -3736,7 +3736,7 @@ declare function createSearchClient({ appId: appIdOption, apiKey: apiKeyOption,
      * @param saveObject.body - The record. A schemaless object with attributes that are useful in the context of search and discovery.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    saveObject({ indexName, body }: SaveObjectProps, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
+    saveObject<T extends object>({ indexName, body }: SaveObjectProps<T>, requestOptions?: RequestOptions): Promise<SaveObjectResponse>;
     /**
      * If a rule with the specified object ID doesn\'t exist, it\'s created. Otherwise, the existing rule is replaced.  To create or update more than one rule, use the [`batch` operation](#tag/Rules/operation/saveRules).
      *

package/dist/src/searchClient.cjs

@@ -25,7 +25,7 @@ __export(searchClient_exports, {
 });
 module.exports = __toCommonJS(searchClient_exports);
 var import_client_common = require("@algolia/client-common");
-var apiClientVersion = "5.24.0";
+var apiClientVersion = "5.26.0";
 function getDefaultHosts(appId) {
   return [
     {
@@ -386,7 +386,7 @@ function createSearchClient({
      * @param saveObjects - The `saveObjects` object.
      * @param saveObjects.indexName - The `indexName` to save `objects` in.
      * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param saveObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -403,7 +403,7 @@ function createSearchClient({
      * @param deleteObjects - The `deleteObjects` object.
      * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
      * @param deleteObjects.objectIDs - The objectIDs to delete.
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param deleteObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
      */
@@ -427,7 +427,7 @@ function createSearchClient({
      * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
      * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
      * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
-     * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+     * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
      * @param partialUpdateObjects.waitForTasks - 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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
      */
@@ -1053,7 +1053,7 @@ function createSearchClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteByQuery` operation](#tag/Records/operation/deleteBy).
+     * Deletes a record by its object ID.  To delete more than one record, use the [`batch` operation](#tag/Records/operation/batch). To delete records matching a query, use the [`deleteBy` operation](#tag/Records/operation/deleteBy).
      *
      * Required API Key ACLs:
      *  - deleteObject
@@ -1380,7 +1380,7 @@ function createSearchClient({
      * Retrieves an object with non-null index settings.
      *
      * Required API Key ACLs:
-     *  - search
+     *  - settings
      * @param getSettings - The getSettings object.
      * @param getSettings.indexName - Name of the index on which to perform the operation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.