@algolia/ingestion 1.25.0 → 1.26.0

package/dist/src/ingestionClient.js

@@ -1,6 +1,6 @@
 // src/ingestionClient.ts
 import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
-var apiClientVersion = "1.25.0";
+var apiClientVersion = "1.26.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -262,12 +262,15 @@ function createIngestionClient({
       if (!transformationCreate) {
         throw new Error("Parameter `transformationCreate` is required when calling `createTransformation`.");
       }
-      if (!transformationCreate.code) {
-        throw new Error("Parameter `transformationCreate.code` is required when calling `createTransformation`.");
-      }
       if (!transformationCreate.name) {
         throw new Error("Parameter `transformationCreate.name` is required when calling `createTransformation`.");
       }
+      if (!transformationCreate.type) {
+        throw new Error("Parameter `transformationCreate.type` is required when calling `createTransformation`.");
+      }
+      if (!transformationCreate.input) {
+        throw new Error("Parameter `transformationCreate.input` is required when calling `createTransformation`.");
+      }
       const requestPath = "/1/transformations";
       const headers = {};
       const queryParameters = {};
@@ -1290,7 +1293,56 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
+     * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
+     *
+     * Required API Key ACLs:
+     *  - addObject
+     *  - deleteIndex
+     *  - editSettings
+     * @param push - The push object.
+     * @param push.indexName - Name of the index on which to perform the operation.
+     * @param push.pushTaskPayload - The pushTaskPayload object.
+     * @param push.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    push({ indexName, pushTaskPayload, watch }, requestOptions) {
+      if (!indexName) {
+        throw new Error("Parameter `indexName` is required when calling `push`.");
+      }
+      if (!pushTaskPayload) {
+        throw new Error("Parameter `pushTaskPayload` is required when calling `push`.");
+      }
+      if (!pushTaskPayload.action) {
+        throw new Error("Parameter `pushTaskPayload.action` is required when calling `push`.");
+      }
+      if (!pushTaskPayload.records) {
+        throw new Error("Parameter `pushTaskPayload.records` is required when calling `push`.");
+      }
+      const requestPath = "/1/push/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
+      const headers = {};
+      const queryParameters = {};
+      if (watch !== void 0) {
+        queryParameters["watch"] = watch.toString();
+      }
+      const request = {
+        method: "POST",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: pushTaskPayload
+      };
+      requestOptions = {
+        timeouts: {
+          connect: 18e4,
+          read: 18e4,
+          write: 18e4,
+          ...requestOptions?.timeouts
+        }
+      };
+      return transporter.request(request, requestOptions);
+    },
+    /**
+     * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
      *
      * Required API Key ACLs:
      *  - addObject
@@ -1298,7 +1350,7 @@ function createIngestionClient({
      *  - editSettings
      * @param pushTask - The pushTask object.
      * @param pushTask.taskID - Unique identifier of a task.
-     * @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
+     * @param pushTask.pushTaskPayload - The pushTaskPayload object.
      * @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
@@ -1333,7 +1385,7 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions == null ? void 0 : requestOptions.timeouts
+          ...requestOptions?.timeouts
         }
       };
       return transporter.request(request, requestOptions);
@@ -1629,7 +1681,7 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions == null ? void 0 : requestOptions.timeouts
+          ...requestOptions?.timeouts
         }
       };
       return transporter.request(request, requestOptions);
@@ -1875,12 +1927,15 @@ function createIngestionClient({
       if (!transformationCreate) {
         throw new Error("Parameter `transformationCreate` is required when calling `updateTransformation`.");
       }
-      if (!transformationCreate.code) {
-        throw new Error("Parameter `transformationCreate.code` is required when calling `updateTransformation`.");
-      }
       if (!transformationCreate.name) {
         throw new Error("Parameter `transformationCreate.name` is required when calling `updateTransformation`.");
       }
+      if (!transformationCreate.type) {
+        throw new Error("Parameter `transformationCreate.type` is required when calling `updateTransformation`.");
+      }
+      if (!transformationCreate.input) {
+        throw new Error("Parameter `transformationCreate.input` is required when calling `updateTransformation`.");
+      }
       const requestPath = "/1/transformations/{transformationID}".replace(
         "{transformationID}",
         encodeURIComponent(transformationID)
@@ -1922,7 +1977,7 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions == null ? void 0 : requestOptions.timeouts
+          ...requestOptions?.timeouts
         }
       };
       return transporter.request(request, requestOptions);
@@ -1961,7 +2016,7 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions == null ? void 0 : requestOptions.timeouts
+          ...requestOptions?.timeouts
         }
       };
       return transporter.request(request, requestOptions);