@algolia/ingestion 1.23.0 → 1.23.2

package/dist/fetch.d.ts

@@ -129,7 +129,7 @@ type Authentication = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -336,7 +336,7 @@ type Destination = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
     /**
      * Universally unique identifier (UUID) of an authentication resource.
      */
@@ -699,7 +699,7 @@ type Source = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 type ListSourcesResponse = {
@@ -899,7 +899,7 @@ type Task = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1019,7 +1019,7 @@ type TaskV1 = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1062,7 +1062,7 @@ type Transformation = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1399,9 +1399,9 @@ type TransformationError = {
 
 type TransformationTryResponse = {
     /**
-     * The array of records returned by the transformation service.
+     * The array of stringified records returned by the transformation service.
      */
-    payloads: Array<Record<string, unknown>>;
+    payloads: Array<string>;
     error?: TransformationError;
 };
 
@@ -2309,7 +2309,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.23.0";
+declare const apiClientVersion = "1.23.2";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2411,6 +2411,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
+     *
+     * @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.
      */
@@ -2500,6 +2502,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
+     *
+     * @deprecated
      * @param deleteTaskV1 - The deleteTaskV1 object.
      * @param deleteTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2531,6 +2535,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param disableTaskV1 - The disableTaskV1 object.
      * @param disableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2555,6 +2561,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param enableTaskV1 - The enableTaskV1 object.
      * @param enableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2640,6 +2648,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param getTaskV1 - The getTaskV1 object.
      * @param getTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2778,6 +2788,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param listTasksV1 - The listTasksV1 object.
      * @param listTasksV1.itemsPerPage - Number of items per page.
      * @param listTasksV1.page - Page number of the paginated API response.
@@ -2852,6 +2864,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param runTaskV1 - The runTaskV1 object.
      * @param runTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2908,6 +2922,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param taskSearch - The taskSearch object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3008,6 +3024,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
+     *
+     * @deprecated
      * @param updateTaskV1 - The updateTaskV1 object.
      * @param updateTaskV1.taskID - Unique identifier of a task.
      * @param updateTaskV1.taskUpdate - The taskUpdate object.

package/dist/node.d.cts

@@ -129,7 +129,7 @@ type Authentication = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -336,7 +336,7 @@ type Destination = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
     /**
      * Universally unique identifier (UUID) of an authentication resource.
      */
@@ -699,7 +699,7 @@ type Source = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 type ListSourcesResponse = {
@@ -899,7 +899,7 @@ type Task = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1019,7 +1019,7 @@ type TaskV1 = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1062,7 +1062,7 @@ type Transformation = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1399,9 +1399,9 @@ type TransformationError = {
 
 type TransformationTryResponse = {
     /**
-     * The array of records returned by the transformation service.
+     * The array of stringified records returned by the transformation service.
      */
-    payloads: Array<Record<string, unknown>>;
+    payloads: Array<string>;
     error?: TransformationError;
 };
 
@@ -2309,7 +2309,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.23.0";
+declare const apiClientVersion = "1.23.2";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2411,6 +2411,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
+     *
+     * @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.
      */
@@ -2500,6 +2502,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
+     *
+     * @deprecated
      * @param deleteTaskV1 - The deleteTaskV1 object.
      * @param deleteTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2531,6 +2535,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param disableTaskV1 - The disableTaskV1 object.
      * @param disableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2555,6 +2561,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param enableTaskV1 - The enableTaskV1 object.
      * @param enableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2640,6 +2648,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param getTaskV1 - The getTaskV1 object.
      * @param getTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2778,6 +2788,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param listTasksV1 - The listTasksV1 object.
      * @param listTasksV1.itemsPerPage - Number of items per page.
      * @param listTasksV1.page - Page number of the paginated API response.
@@ -2852,6 +2864,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param runTaskV1 - The runTaskV1 object.
      * @param runTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2908,6 +2922,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param taskSearch - The taskSearch object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3008,6 +3024,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
+     *
+     * @deprecated
      * @param updateTaskV1 - The updateTaskV1 object.
      * @param updateTaskV1.taskID - Unique identifier of a task.
      * @param updateTaskV1.taskUpdate - The taskUpdate object.

package/dist/node.d.ts

@@ -129,7 +129,7 @@ type Authentication = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -336,7 +336,7 @@ type Destination = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
     /**
      * Universally unique identifier (UUID) of an authentication resource.
      */
@@ -699,7 +699,7 @@ type Source = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 type ListSourcesResponse = {
@@ -899,7 +899,7 @@ type Task = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1019,7 +1019,7 @@ type TaskV1 = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1062,7 +1062,7 @@ type Transformation = {
     /**
      * Date of last update in RFC 3339 format.
      */
-    updatedAt?: string;
+    updatedAt: string;
 };
 
 /**
@@ -1399,9 +1399,9 @@ type TransformationError = {
 
 type TransformationTryResponse = {
     /**
-     * The array of records returned by the transformation service.
+     * The array of stringified records returned by the transformation service.
      */
-    payloads: Array<Record<string, unknown>>;
+    payloads: Array<string>;
     error?: TransformationError;
 };
 
@@ -2309,7 +2309,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.23.0";
+declare const apiClientVersion = "1.23.2";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2411,6 +2411,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
+     *
+     * @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.
      */
@@ -2500,6 +2502,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
+     *
+     * @deprecated
      * @param deleteTaskV1 - The deleteTaskV1 object.
      * @param deleteTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2531,6 +2535,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param disableTaskV1 - The disableTaskV1 object.
      * @param disableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2555,6 +2561,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param enableTaskV1 - The enableTaskV1 object.
      * @param enableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2640,6 +2648,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param getTaskV1 - The getTaskV1 object.
      * @param getTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2778,6 +2788,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param listTasksV1 - The listTasksV1 object.
      * @param listTasksV1.itemsPerPage - Number of items per page.
      * @param listTasksV1.page - Page number of the paginated API response.
@@ -2852,6 +2864,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param runTaskV1 - The runTaskV1 object.
      * @param runTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2908,6 +2922,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param taskSearch - The taskSearch object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -3008,6 +3024,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
     updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
+     *
+     * @deprecated
      * @param updateTaskV1 - The updateTaskV1 object.
      * @param updateTaskV1.taskID - Unique identifier of a task.
      * @param updateTaskV1.taskUpdate - The taskUpdate 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.23.0";
+var apiClientVersion = "1.23.2";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -249,6 +249,8 @@ function createIngestionClient({
     },
     /**
      * Creates a new task using the v1 endpoint, please use `createTask` instead.
+     *
+     * @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.
      */
@@ -506,6 +508,8 @@ function createIngestionClient({
     },
     /**
      * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
+     *
+     * @deprecated
      * @param deleteTaskV1 - The deleteTaskV1 object.
      * @param deleteTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -582,6 +586,8 @@ function createIngestionClient({
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param disableTaskV1 - The disableTaskV1 object.
      * @param disableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -634,6 +640,8 @@ function createIngestionClient({
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param enableTaskV1 - The enableTaskV1 object.
      * @param enableTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -826,6 +834,8 @@ function createIngestionClient({
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param getTaskV1 - The getTaskV1 object.
      * @param getTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1217,6 +1227,8 @@ function createIngestionClient({
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param listTasksV1 - The listTasksV1 object.
      * @param listTasksV1.itemsPerPage - Number of items per page.
      * @param listTasksV1.page - Page number of the paginated API response.
@@ -1416,6 +1428,8 @@ function createIngestionClient({
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param runTaskV1 - The runTaskV1 object.
      * @param runTaskV1.taskID - Unique identifier of a task.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1560,6 +1574,8 @@ function createIngestionClient({
      *  - addObject
      *  - deleteIndex
      *  - editSettings
+     *
+     * @deprecated
      * @param taskSearch - The taskSearch object.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -1848,6 +1864,8 @@ function createIngestionClient({
     },
     /**
      * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
+     *
+     * @deprecated
      * @param updateTaskV1 - The updateTaskV1 object.
      * @param updateTaskV1.taskID - Unique identifier of a task.
      * @param updateTaskV1.taskUpdate - The taskUpdate object.