@algolia/ingestion 1.41.0 → 1.42.0

package/dist/src/ingestionClient.js

@@ -1,6 +1,6 @@
 // src/ingestionClient.ts
 import { createAuth, createIterablePromise, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "1.41.0";
+var apiClientVersion = "1.42.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -256,6 +256,11 @@ function createIngestionClient({
     },
     /**
      * Creates a new task.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param taskCreate - Request body for creating a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -287,6 +292,11 @@ function createIngestionClient({
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
      *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     *
      * @deprecated
      * @param taskCreate - Request body for creating a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -321,6 +331,11 @@ function createIngestionClient({
     },
     /**
      * Creates a new transformation.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param transformationCreate - Request body for creating a transformation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -521,6 +536,11 @@ function createIngestionClient({
     },
     /**
      * Deletes a task by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param deleteTask - The deleteTask object.
      * @param deleteTask.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -543,6 +563,11 @@ function createIngestionClient({
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
      *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     *
      * @deprecated
      * @param deleteTaskV1 - The deleteTaskV1 object.
      * @param deleteTaskV1.taskID - Unique identifier of a task.
@@ -565,6 +590,11 @@ function createIngestionClient({
     },
     /**
      * Deletes a transformation by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param deleteTransformation - The deleteTransformation object.
      * @param deleteTransformation.transformationID - Unique identifier of a transformation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1460,6 +1490,11 @@ function createIngestionClient({
     },
     /**
      * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param replaceTask - The replaceTask object.
      * @param replaceTask.taskID - Unique identifier of a task.
      * @param replaceTask.taskReplace - The taskReplace object.
@@ -1959,6 +1994,11 @@ function createIngestionClient({
     },
     /**
      * Partially updates a task by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param updateTask - The updateTask object.
      * @param updateTask.taskID - Unique identifier of a task.
      * @param updateTask.taskUpdate - The taskUpdate object.
@@ -1986,6 +2026,11 @@ function createIngestionClient({
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
      *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     *
      * @deprecated
      * @param updateTaskV1 - The updateTaskV1 object.
      * @param updateTaskV1.taskID - Unique identifier of a task.
@@ -2013,6 +2058,11 @@ function createIngestionClient({
     },
     /**
      * Updates a transformation by its ID.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
      * @param updateTransformation - The updateTransformation object.
      * @param updateTransformation.transformationID - Unique identifier of a transformation.
      * @param updateTransformation.transformationCreate - The transformationCreate object.