@algolia/ingestion 1.36.0 → 1.38.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.36.0";
+var apiClientVersion = "1.38.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -1326,9 +1326,10 @@ function createIngestionClient({
      * @param listTransformations.page - Page number of the paginated API response.
      * @param listTransformations.sort - Property by which to sort the list of transformations.
      * @param listTransformations.order - Sort order of the response, ascending or descending.
+     * @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTransformations({ itemsPerPage, page, sort, order } = {}, requestOptions = void 0) {
+    listTransformations({ itemsPerPage, page, sort, order, type } = {}, requestOptions = void 0) {
       const requestPath = "/1/transformations";
       const headers = {};
       const queryParameters = {};
@@ -1344,6 +1345,9 @@ function createIngestionClient({
       if (order !== void 0) {
         queryParameters["order"] = order.toString();
       }
+      if (type !== void 0) {
+        queryParameters["type"] = type.toString();
+      }
       const request = {
         method: "GET",
         path: requestPath,
@@ -1400,13 +1404,13 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions?.timeouts
+          ...requestOptions == null ? void 0 : 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`.
+     * 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 or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, 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
@@ -1449,11 +1453,43 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions?.timeouts
+          ...requestOptions == null ? void 0 : requestOptions.timeouts
         }
       };
       return transporter.request(request, requestOptions);
     },
+    /**
+     * Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
+     * @param replaceTask - The replaceTask object.
+     * @param replaceTask.taskID - Unique identifier of a task.
+     * @param replaceTask.taskReplace - The taskReplace object.
+     * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
+     */
+    replaceTask({ taskID, taskReplace }, requestOptions) {
+      if (!taskID) {
+        throw new Error("Parameter `taskID` is required when calling `replaceTask`.");
+      }
+      if (!taskReplace) {
+        throw new Error("Parameter `taskReplace` is required when calling `replaceTask`.");
+      }
+      if (!taskReplace.destinationID) {
+        throw new Error("Parameter `taskReplace.destinationID` is required when calling `replaceTask`.");
+      }
+      if (!taskReplace.action) {
+        throw new Error("Parameter `taskReplace.action` is required when calling `replaceTask`.");
+      }
+      const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
+      const headers = {};
+      const queryParameters = {};
+      const request = {
+        method: "PUT",
+        path: requestPath,
+        queryParameters,
+        headers,
+        data: taskReplace
+      };
+      return transporter.request(request, requestOptions);
+    },
     /**
      * Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
      *
@@ -1749,7 +1785,7 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions?.timeouts
+          ...requestOptions == null ? void 0 : requestOptions.timeouts
         }
       };
       return transporter.request(request, requestOptions);
@@ -1922,7 +1958,7 @@ function createIngestionClient({
       return transporter.request(request, requestOptions);
     },
     /**
-     * Updates a task by its ID.
+     * Partially updates a task by its ID.
      * @param updateTask - The updateTask object.
      * @param updateTask.taskID - Unique identifier of a task.
      * @param updateTask.taskUpdate - The taskUpdate object.
@@ -2033,7 +2069,7 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions?.timeouts
+          ...requestOptions == null ? void 0 : requestOptions.timeouts
         }
       };
       return transporter.request(request, requestOptions);
@@ -2072,7 +2108,7 @@ function createIngestionClient({
           connect: 18e4,
           read: 18e4,
           write: 18e4,
-          ...requestOptions?.timeouts
+          ...requestOptions == null ? void 0 : requestOptions.timeouts
         }
       };
       return transporter.request(request, requestOptions);
@@ -2087,11 +2123,4 @@ export {
   isScheduleTrigger,
   isSubscriptionTrigger
 };
-//# sourceMappingURL=ingestionClient.js.mapEGIONS,
-  apiClientVersion,
-  createIngestionClient,
-  isOnDemandTrigger,
-  isScheduleTrigger,
-  isSubscriptionTrigger
-};
 //# sourceMappingURL=ingestionClient.js.map