@algolia/ingestion 1.15.0 → 1.17.0

package/dist/fetch.d.ts

@@ -678,7 +678,7 @@ type SourceShopify = SourceUpdateShopify & SourceShopifyBase;
 
 type SourceInput = SourceCommercetools | SourceBigCommerce | SourceJSON | SourceCSV | SourceBigQuery | SourceGA4BigQueryExport | SourceDocker | SourceShopify;
 
-type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'shopify' | 'sfcc' | 'push';
+type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'shopify' | 'push';
 
 type Source = {
     /**
@@ -2046,6 +2046,10 @@ type ListTasksProps = {
      * Source IDs for filtering the list of tasks.
      */
     sourceID?: Array<string>;
+    /**
+     * Filters the tasks with the specified source type.
+     */
+    sourceType?: Array<SourceType>;
     /**
      * Destination IDs for filtering the list of tasks.
      */
@@ -2137,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.
@@ -2259,7 +2267,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.15.0";
+declare const apiClientVersion = "1.17.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2708,13 +2716,14 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param listTasks.action - Actions for filtering the list of tasks.
      * @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
      * @param listTasks.sourceID - Source IDs for filtering the list of tasks.
+     * @param listTasks.sourceType - Filters the tasks with the specified source type.
      * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
      * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
      * @param listTasks.sort - Property by which to sort the list of tasks.
      * @param listTasks.order - Sort order of the response, ascending or descending.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
+    listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
      *
@@ -2760,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

@@ -678,7 +678,7 @@ type SourceShopify = SourceUpdateShopify & SourceShopifyBase;
 
 type SourceInput = SourceCommercetools | SourceBigCommerce | SourceJSON | SourceCSV | SourceBigQuery | SourceGA4BigQueryExport | SourceDocker | SourceShopify;
 
-type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'shopify' | 'sfcc' | 'push';
+type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'shopify' | 'push';
 
 type Source = {
     /**
@@ -2046,6 +2046,10 @@ type ListTasksProps = {
      * Source IDs for filtering the list of tasks.
      */
     sourceID?: Array<string>;
+    /**
+     * Filters the tasks with the specified source type.
+     */
+    sourceType?: Array<SourceType>;
     /**
      * Destination IDs for filtering the list of tasks.
      */
@@ -2137,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.
@@ -2259,7 +2267,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.15.0";
+declare const apiClientVersion = "1.17.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2708,13 +2716,14 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param listTasks.action - Actions for filtering the list of tasks.
      * @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
      * @param listTasks.sourceID - Source IDs for filtering the list of tasks.
+     * @param listTasks.sourceType - Filters the tasks with the specified source type.
      * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
      * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
      * @param listTasks.sort - Property by which to sort the list of tasks.
      * @param listTasks.order - Sort order of the response, ascending or descending.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
+    listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
      *
@@ -2760,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

@@ -678,7 +678,7 @@ type SourceShopify = SourceUpdateShopify & SourceShopifyBase;
 
 type SourceInput = SourceCommercetools | SourceBigCommerce | SourceJSON | SourceCSV | SourceBigQuery | SourceGA4BigQueryExport | SourceDocker | SourceShopify;
 
-type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'shopify' | 'sfcc' | 'push';
+type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'shopify' | 'push';
 
 type Source = {
     /**
@@ -2046,6 +2046,10 @@ type ListTasksProps = {
      * Source IDs for filtering the list of tasks.
      */
     sourceID?: Array<string>;
+    /**
+     * Filters the tasks with the specified source type.
+     */
+    sourceType?: Array<SourceType>;
     /**
      * Destination IDs for filtering the list of tasks.
      */
@@ -2137,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.
@@ -2259,7 +2267,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.15.0";
+declare const apiClientVersion = "1.17.0";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2708,13 +2716,14 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
      * @param listTasks.action - Actions for filtering the list of tasks.
      * @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
      * @param listTasks.sourceID - Source IDs for filtering the list of tasks.
+     * @param listTasks.sourceType - Filters the tasks with the specified source type.
      * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
      * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
      * @param listTasks.sort - Property by which to sort the list of tasks.
      * @param listTasks.order - Sort order of the response, ascending or descending.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
+    listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
     /**
      * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
      *
@@ -2760,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.15.0";
+var apiClientVersion = "1.17.0";
 var REGIONS = ["eu", "us"];
 function getDefaultHosts(region) {
   const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -1141,13 +1141,25 @@ function createIngestionClient({
      * @param listTasks.action - Actions for filtering the list of tasks.
      * @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
      * @param listTasks.sourceID - Source IDs for filtering the list of tasks.
+     * @param listTasks.sourceType - Filters the tasks with the specified source type.
      * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
      * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
      * @param listTasks.sort - Property by which to sort the list of tasks.
      * @param listTasks.order - Sort order of the response, ascending or descending.
      * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
      */
-    listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order } = {}, requestOptions = void 0) {
+    listTasks({
+      itemsPerPage,
+      page,
+      action,
+      enabled,
+      sourceID,
+      sourceType,
+      destinationID,
+      triggerType,
+      sort,
+      order
+    } = {}, requestOptions = void 0) {
       const requestPath = "/2/tasks";
       const headers = {};
       const queryParameters = {};
@@ -1166,6 +1178,9 @@ function createIngestionClient({
       if (sourceID !== void 0) {
         queryParameters["sourceID"] = sourceID.toString();
       }
+      if (sourceType !== void 0) {
+        queryParameters["sourceType"] = sourceType.toString();
+      }
       if (destinationID !== void 0) {
         queryParameters["destinationID"] = destinationID.toString();
       }
@@ -1292,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`.");
       }
@@ -1310,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,