@algolia/ingestion 1.16.0 → 1.17.0

package/dist/fetch.d.ts

@@ -2141,6 +2141,10 @@ type PushTaskProps = {
      * Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
      */
     pushTaskPayload: PushTaskPayload;
+    /**
+     * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+     */
+    watch?: boolean;
 };
 /**
  * Properties for the `runSource` method.
@@ -2263,7 +2267,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.16.0";
+declare const apiClientVersion = "1.17.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2765,9 +2769,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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.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.
      */
-    pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
+    pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
     /**
      * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
      *

package/dist/node.d.cts

@@ -2141,6 +2141,10 @@ type PushTaskProps = {
      * Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
      */
     pushTaskPayload: PushTaskPayload;
+    /**
+     * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+     */
+    watch?: boolean;
 };
 /**
  * Properties for the `runSource` method.
@@ -2263,7 +2267,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.16.0";
+declare const apiClientVersion = "1.17.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2765,9 +2769,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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.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.
      */
-    pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
+    pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
     /**
      * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
      *

package/dist/node.d.ts

@@ -2141,6 +2141,10 @@ type PushTaskProps = {
      * Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
      */
     pushTaskPayload: PushTaskPayload;
+    /**
+     * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
+     */
+    watch?: boolean;
 };
 /**
  * Properties for the `runSource` method.
@@ -2263,7 +2267,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.16.0";
+declare const apiClientVersion = "1.17.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2765,9 +2769,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @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.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.
      */
-    pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
+    pushTask({ taskID, pushTaskPayload, watch }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
     /**
      * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
      *

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.16.0";
+var apiClientVersion = "1.17.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -1307,9 +1307,10 @@ function createIngestionClient({
      * @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.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.
      */
-    pushTask({ taskID, pushTaskPayload }, requestOptions) {
+    pushTask({ taskID, pushTaskPayload, watch }, requestOptions) {
       if (!taskID) {
         throw new Error("Parameter `taskID` is required when calling `pushTask`.");
       }
@@ -1325,6 +1326,9 @@ function createIngestionClient({
       const requestPath = "/2/tasks/{taskID}/push".replace("{taskID}", encodeURIComponent(taskID));
       const headers = {};
       const queryParameters = {};
+      if (watch !== void 0) {
+        queryParameters["watch"] = watch.toString();
+      }
       const request = {
         method: "POST",
         path: requestPath,