@algolia/ingestion 1.48.0 → 1.48.2

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.
@@ -4,7 +4,7 @@ import { createHttpRequester } from "@algolia/requester-node-http";
4
4
 
5
5
  // src/ingestionClient.ts
6
6
  import { createAuth, createIterablePromise, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
7
- var apiClientVersion = "1.48.0";
7
+ var apiClientVersion = "1.48.2";
8
8
  var REGIONS = ["eu", "us"];
9
9
  function getDefaultHosts(region) {
10
10
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -294,7 +294,7 @@ function createIngestionClient({
294
294
  return transporter.request(request, requestOptions);
295
295
  },
296
296
  /**
297
- * Creates a new task using the v1 endpoint, please use `createTask` instead.
297
+ * Creates a new task using the v1 endpoint. Use `createTask` instead.
298
298
  *
299
299
  * Required API Key ACLs:
300
300
  * - addObject
@@ -565,7 +565,7 @@ function createIngestionClient({
565
565
  return transporter.request(request, requestOptions);
566
566
  },
567
567
  /**
568
- * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
568
+ * Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
569
569
  *
570
570
  * Required API Key ACLs:
571
571
  * - addObject
@@ -648,7 +648,7 @@ function createIngestionClient({
648
648
  return transporter.request(request, requestOptions);
649
649
  },
650
650
  /**
651
- * Disables a task using the v1 endpoint, please use `disableTask` instead.
651
+ * Disables a task using the v1 endpoint. Use `disableTask` instead.
652
652
  *
653
653
  * Required API Key ACLs:
654
654
  * - addObject
@@ -702,7 +702,7 @@ function createIngestionClient({
702
702
  return transporter.request(request, requestOptions);
703
703
  },
704
704
  /**
705
- * Enables a task using the v1 endpoint, please use `enableTask` instead.
705
+ * Enables a task using the v1 endpoint. Use `enableTask` instead.
706
706
  *
707
707
  * Required API Key ACLs:
708
708
  * - addObject
@@ -896,7 +896,7 @@ function createIngestionClient({
896
896
  return transporter.request(request, requestOptions);
897
897
  },
898
898
  /**
899
- * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
899
+ * Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
900
900
  *
901
901
  * Required API Key ACLs:
902
902
  * - addObject
@@ -1121,8 +1121,8 @@ function createIngestionClient({
1121
1121
  * @param listRuns.taskID - Task ID for filtering the list of task runs.
1122
1122
  * @param listRuns.sort - Property by which to sort the list of task runs.
1123
1123
  * @param listRuns.order - Sort order of the response, ascending or descending.
1124
- * @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
1125
- * @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
1124
+ * @param listRuns.startDate - Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
1125
+ * @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
1126
1126
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1127
1127
  */
1128
1128
  listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate } = {}, requestOptions = void 0) {
@@ -1289,7 +1289,7 @@ function createIngestionClient({
1289
1289
  return transporter.request(request, requestOptions);
1290
1290
  },
1291
1291
  /**
1292
- * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
1292
+ * Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
1293
1293
  *
1294
1294
  * Required API Key ACLs:
1295
1295
  * - addObject
@@ -1586,7 +1586,7 @@ function createIngestionClient({
1586
1586
  return transporter.request(request, requestOptions);
1587
1587
  },
1588
1588
  /**
1589
- * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
1589
+ * Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
1590
1590
  *
1591
1591
  * Required API Key ACLs:
1592
1592
  * - addObject
@@ -1734,7 +1734,7 @@ function createIngestionClient({
1734
1734
  return transporter.request(request, requestOptions);
1735
1735
  },
1736
1736
  /**
1737
- * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
1737
+ * Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
1738
1738
  *
1739
1739
  * Required API Key ACLs:
1740
1740
  * - addObject
@@ -2028,7 +2028,7 @@ function createIngestionClient({
2028
2028
  return transporter.request(request, requestOptions);
2029
2029
  },
2030
2030
  /**
2031
- * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
2031
+ * Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
2032
2032
  *
2033
2033
  * Required API Key ACLs:
2034
2034
  * - addObject