chore: generated code for commit e89bb79. [skip ci]

Co-authored-by: Clément Vannicatte <[email protected]>

Author: algolia-bot

clients/algoliasearch-client-javascript/packages/client-search/model/clientMethodProps.ts

@@ -806,6 +806,28 @@ export type GetSecuredApiKeyRemainingValidityOptions = {
   securedApiKey: string;
 };
 
+export type DeleteObjectsOptions = Pick<ChunkedBatchOptions, 'indexName'> & {
+  /**
+   * The objectIDs to delete.
+   */
+  objectIDs: string[];
+};
+
+export type PartialUpdateObjectsOptions = Pick<
+  ChunkedBatchOptions,
+  'indexName' | 'objects'
+> & {
+  /**
+   *To be provided if non-existing objects are passed, otherwise, the call will fail.
+   */
+  createIfNotExists?: boolean;
+};
+
+export type SaveObjectsOptions = Pick<
+  ChunkedBatchOptions,
+  'indexName' | 'objects'
+>;
+
 export type ChunkedBatchOptions = ReplaceAllObjectsOptions & {
   /**
    * The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.

clients/algoliasearch-client-javascript/packages/client-search/src/searchClient.ts

@@ -27,10 +27,13 @@ import type { BrowseResponse } from '../model/browseResponse';
 import type {
   BrowseOptions,
   ChunkedBatchOptions,
+  DeleteObjectsOptions,
+  PartialUpdateObjectsOptions,
   ReplaceAllObjectsOptions,
+  SaveObjectsOptions,
   WaitForApiKeyOptions,
-  WaitForTaskOptions,
   WaitForAppTaskOptions,
+  WaitForTaskOptions,
   AddOrUpdateObjectProps,
   AssignUserIdProps,
   BatchProps,
@@ -577,6 +580,74 @@ export function createSearchClient({
       return responses;
     },
 
+    /**
+     * Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+     *
+     * @summary Helper: Saves the given array of objects in the given index. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+     * @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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
+     */
+    async saveObjects(
+      { indexName, objects }: SaveObjectsOptions,
+      requestOptions?: RequestOptions
+    ): Promise<BatchResponse[]> {
+      return await this.chunkedBatch(
+        { indexName, objects, action: 'addObject' },
+        requestOptions
+      );
+    },
+
+    /**
+     * Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
+     *
+     * @summary Helper: Deletes every records for the given objectIDs. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objectIDs in it.
+     * @param deleteObjects - The `deleteObjects` object.
+     * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
+     * @param deleteObjects.objectIDs - The objectIDs to delete.
+     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
+     */
+    async deleteObjects(
+      { indexName, objectIDs }: DeleteObjectsOptions,
+      requestOptions?: RequestOptions
+    ): Promise<BatchResponse[]> {
+      return await this.chunkedBatch(
+        {
+          indexName,
+          objects: objectIDs.map((objectID) => ({ objectID })),
+          action: 'deleteObject',
+        },
+        requestOptions
+      );
+    },
+
+    /**
+     * Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+     *
+     * @summary Helper: Replaces object content of all the given objects according to their respective `objectID` field. The `chunkedBatch` helper is used under the hood, which creates a `batch` requests with at most 1000 objects in it.
+     * @param partialUpdateObjects - The `partialUpdateObjects` object.
+     * @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 requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+     */
+    async partialUpdateObjects(
+      { indexName, objects, createIfNotExists }: PartialUpdateObjectsOptions,
+      requestOptions?: RequestOptions
+    ): Promise<BatchResponse[]> {
+      return await this.chunkedBatch(
+        {
+          indexName,
+          objects,
+          action: createIfNotExists
+            ? 'partialUpdateObject'
+            : 'partialUpdateObjectNoCreate',
+        },
+        requestOptions
+      );
+    },
+
     /**
      * Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
      * See https://api-clients-automation.netlify.app/docs/contributing/add-new-api-client#5-helpers for implementation details.
@@ -586,7 +657,7 @@ export function createSearchClient({
      * @param replaceAllObjects.indexName - The `indexName` to replace `objects` in.
      * @param replaceAllObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
      * @param replaceAllObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `objects.length / batchSize`. Defaults to 1000.
-     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
+     * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch`, `operationIndex` and `getTask` method and merged with the transporter requestOptions.
      */
     async replaceAllObjects(
       { indexName, objects, batchSize }: ReplaceAllObjectsOptions,
@@ -647,7 +718,6 @@ export function createSearchClient({
 
       return { copyOperationResponse, batchResponses, moveOperationResponse };
     },
-
     /**
      * Creates a new API key with specific permissions and restrictions.
      *