@algolia/ingestion 1.22.0 → 1.23.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  // src/ingestionClient.ts
2
2
  import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
3
- var apiClientVersion = "1.22.0";
3
+ var apiClientVersion = "1.23.1";
4
4
  var REGIONS = ["eu", "us"];
5
5
  function getDefaultHosts(region) {
6
6
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -220,6 +220,8 @@ function createIngestionClient({
220
220
  },
221
221
  /**
222
222
  * Creates a new task using the v1 endpoint, please use `createTask` instead.
223
+ *
224
+ * @deprecated
223
225
  * @param taskCreate - Request body for creating a task.
224
226
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
225
227
  */
@@ -477,6 +479,8 @@ function createIngestionClient({
477
479
  },
478
480
  /**
479
481
  * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
482
+ *
483
+ * @deprecated
480
484
  * @param deleteTaskV1 - The deleteTaskV1 object.
481
485
  * @param deleteTaskV1.taskID - Unique identifier of a task.
482
486
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -553,6 +557,8 @@ function createIngestionClient({
553
557
  * - addObject
554
558
  * - deleteIndex
555
559
  * - editSettings
560
+ *
561
+ * @deprecated
556
562
  * @param disableTaskV1 - The disableTaskV1 object.
557
563
  * @param disableTaskV1.taskID - Unique identifier of a task.
558
564
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -605,6 +611,8 @@ function createIngestionClient({
605
611
  * - addObject
606
612
  * - deleteIndex
607
613
  * - editSettings
614
+ *
615
+ * @deprecated
608
616
  * @param enableTaskV1 - The enableTaskV1 object.
609
617
  * @param enableTaskV1.taskID - Unique identifier of a task.
610
618
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -797,6 +805,8 @@ function createIngestionClient({
797
805
  * - addObject
798
806
  * - deleteIndex
799
807
  * - editSettings
808
+ *
809
+ * @deprecated
800
810
  * @param getTaskV1 - The getTaskV1 object.
801
811
  * @param getTaskV1.taskID - Unique identifier of a task.
802
812
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1188,6 +1198,8 @@ function createIngestionClient({
1188
1198
  * - addObject
1189
1199
  * - deleteIndex
1190
1200
  * - editSettings
1201
+ *
1202
+ * @deprecated
1191
1203
  * @param listTasksV1 - The listTasksV1 object.
1192
1204
  * @param listTasksV1.itemsPerPage - Number of items per page.
1193
1205
  * @param listTasksV1.page - Page number of the paginated API response.
@@ -1387,6 +1399,8 @@ function createIngestionClient({
1387
1399
  * - addObject
1388
1400
  * - deleteIndex
1389
1401
  * - editSettings
1402
+ *
1403
+ * @deprecated
1390
1404
  * @param runTaskV1 - The runTaskV1 object.
1391
1405
  * @param runTaskV1.taskID - Unique identifier of a task.
1392
1406
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -1531,6 +1545,8 @@ function createIngestionClient({
1531
1545
  * - addObject
1532
1546
  * - deleteIndex
1533
1547
  * - editSettings
1548
+ *
1549
+ * @deprecated
1534
1550
  * @param taskSearch - The taskSearch object.
1535
1551
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1536
1552
  */
@@ -1819,6 +1835,8 @@ function createIngestionClient({
1819
1835
  },
1820
1836
  /**
1821
1837
  * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
1838
+ *
1839
+ * @deprecated
1822
1840
  * @param updateTaskV1 - The updateTaskV1 object.
1823
1841
  * @param updateTaskV1.taskID - Unique identifier of a task.
1824
1842
  * @param updateTaskV1.taskUpdate - The taskUpdate object.