@algolia/ingestion 1.41.0 → 1.42.0

package/dist/fetch.d.ts

@@ -2486,7 +2486,7 @@ type ChunkedPushOptions = {
     objects: Array<Record<string, unknown>>;
 };
 
-declare const apiClientVersion = "1.41.0";
+declare const apiClientVersion = "1.42.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2596,6 +2596,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
     /**
      * 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.
      */
@@ -2603,6 +2608,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -2610,6 +2620,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
      * 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.
      */
@@ -2686,6 +2701,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * 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.
@@ -2694,6 +2714,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -2702,6 +2727,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * 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.
@@ -3041,6 +3071,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
     /**
      * 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.
@@ -3233,6 +3268,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
     /**
      * 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.
@@ -3242,6 +3282,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -3251,6 +3296,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * 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.

package/dist/node.d.cts

@@ -2486,7 +2486,7 @@ type ChunkedPushOptions = {
     objects: Array<Record<string, unknown>>;
 };
 
-declare const apiClientVersion = "1.41.0";
+declare const apiClientVersion = "1.42.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2596,6 +2596,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
     /**
      * 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.
      */
@@ -2603,6 +2608,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -2610,6 +2620,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
      * 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.
      */
@@ -2686,6 +2701,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * 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.
@@ -2694,6 +2714,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -2702,6 +2727,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * 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.
@@ -3041,6 +3071,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
     /**
      * 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.
@@ -3233,6 +3268,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
     /**
      * 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.
@@ -3242,6 +3282,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -3251,6 +3296,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * 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.

package/dist/node.d.ts

@@ -2486,7 +2486,7 @@ type ChunkedPushOptions = {
     objects: Array<Record<string, unknown>>;
 };
 
-declare const apiClientVersion = "1.41.0";
+declare const apiClientVersion = "1.42.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2596,6 +2596,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
     /**
      * 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.
      */
@@ -2603,6 +2608,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -2610,6 +2620,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
      * 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.
      */
@@ -2686,6 +2701,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * 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.
@@ -2694,6 +2714,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -2702,6 +2727,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * 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.
@@ -3041,6 +3071,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
     /**
      * 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.
@@ -3233,6 +3268,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
     /**
      * 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.
@@ -3242,6 +3282,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     /**
      * 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.
@@ -3251,6 +3296,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * 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.

package/dist/src/ingestionClient.cjs

@@ -29,7 +29,7 @@ __export(ingestionClient_exports, {
 });
 module.exports = __toCommonJS(ingestionClient_exports);
 var import_client_common = require("@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);
@@ -285,6 +285,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.
      */
@@ -316,6 +321,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.
@@ -350,6 +360,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.
      */
@@ -550,6 +565,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.
@@ -572,6 +592,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.
@@ -594,6 +619,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.
@@ -1489,6 +1519,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.
@@ -1988,6 +2023,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.
@@ -2015,6 +2055,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.
@@ -2042,6 +2087,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.