@algolia/ingestion 1.22.0 → 1.23.1

package/dist/fetch.d.ts

@@ -609,6 +609,10 @@ type SourceCommercetools = {
      * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
      */
     fallbackIsInStockValue?: boolean;
+    /**
+     * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
+     */
+    productQueryPredicate?: string;
     customFields?: CommercetoolsCustomFields;
 };
 
@@ -1550,6 +1554,10 @@ type SourceUpdateCommercetools = {
      * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
      */
     fallbackIsInStockValue?: boolean;
+    /**
+     * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
+     */
+    productQueryPredicate?: string;
     customFields?: CommercetoolsCustomFields;
 };
 
@@ -2301,7 +2309,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.22.0";
+declare const apiClientVersion = "1.23.1";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2403,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.
      */
@@ -2492,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.
@@ -2523,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.
@@ -2547,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.
@@ -2632,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.
@@ -2770,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.
@@ -2844,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.
@@ -2900,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.
      */
@@ -3000,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

@@ -609,6 +609,10 @@ type SourceCommercetools = {
      * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
      */
     fallbackIsInStockValue?: boolean;
+    /**
+     * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
+     */
+    productQueryPredicate?: string;
     customFields?: CommercetoolsCustomFields;
 };
 
@@ -1550,6 +1554,10 @@ type SourceUpdateCommercetools = {
      * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
      */
     fallbackIsInStockValue?: boolean;
+    /**
+     * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
+     */
+    productQueryPredicate?: string;
     customFields?: CommercetoolsCustomFields;
 };
 
@@ -2301,7 +2309,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.22.0";
+declare const apiClientVersion = "1.23.1";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2403,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.
      */
@@ -2492,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.
@@ -2523,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.
@@ -2547,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.
@@ -2632,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.
@@ -2770,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.
@@ -2844,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.
@@ -2900,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.
      */
@@ -3000,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

@@ -609,6 +609,10 @@ type SourceCommercetools = {
      * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
      */
     fallbackIsInStockValue?: boolean;
+    /**
+     * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
+     */
+    productQueryPredicate?: string;
     customFields?: CommercetoolsCustomFields;
 };
 
@@ -1550,6 +1554,10 @@ type SourceUpdateCommercetools = {
      * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
      */
     fallbackIsInStockValue?: boolean;
+    /**
+     * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
+     */
+    productQueryPredicate?: string;
     customFields?: CommercetoolsCustomFields;
 };
 
@@ -2301,7 +2309,7 @@ type ValidateSourceBeforeUpdateProps = {
     sourceUpdate: SourceUpdate;
 };
 
-declare const apiClientVersion = "1.22.0";
+declare const apiClientVersion = "1.23.1";
 declare const REGIONS: readonly ["eu", "us"];
 type Region = (typeof REGIONS)[number];
 type RegionOptions = {
@@ -2403,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.
      */
@@ -2492,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.
@@ -2523,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.
@@ -2547,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.
@@ -2632,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.
@@ -2770,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.
@@ -2844,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.
@@ -2900,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.
      */
@@ -3000,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.22.0";
+var apiClientVersion = "1.23.1";
 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.