@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.
@@ -1,6 +1,6 @@
1
1
  // src/ingestionClient.ts
2
2
  import { createAuth, createIterablePromise, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
3
- var apiClientVersion = "1.48.0";
3
+ var apiClientVersion = "1.48.2";
4
4
  var REGIONS = ["eu", "us"];
5
5
  function getDefaultHosts(region) {
6
6
  const url = "data.{region}.algolia.com".replace("{region}", region);
@@ -290,7 +290,7 @@ function createIngestionClient({
290
290
  return transporter.request(request, requestOptions);
291
291
  },
292
292
  /**
293
- * Creates a new task using the v1 endpoint, please use `createTask` instead.
293
+ * Creates a new task using the v1 endpoint. Use `createTask` instead.
294
294
  *
295
295
  * Required API Key ACLs:
296
296
  * - addObject
@@ -561,7 +561,7 @@ function createIngestionClient({
561
561
  return transporter.request(request, requestOptions);
562
562
  },
563
563
  /**
564
- * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
564
+ * Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
565
565
  *
566
566
  * Required API Key ACLs:
567
567
  * - addObject
@@ -644,7 +644,7 @@ function createIngestionClient({
644
644
  return transporter.request(request, requestOptions);
645
645
  },
646
646
  /**
647
- * Disables a task using the v1 endpoint, please use `disableTask` instead.
647
+ * Disables a task using the v1 endpoint. Use `disableTask` instead.
648
648
  *
649
649
  * Required API Key ACLs:
650
650
  * - addObject
@@ -698,7 +698,7 @@ function createIngestionClient({
698
698
  return transporter.request(request, requestOptions);
699
699
  },
700
700
  /**
701
- * Enables a task using the v1 endpoint, please use `enableTask` instead.
701
+ * Enables a task using the v1 endpoint. Use `enableTask` instead.
702
702
  *
703
703
  * Required API Key ACLs:
704
704
  * - addObject
@@ -892,7 +892,7 @@ function createIngestionClient({
892
892
  return transporter.request(request, requestOptions);
893
893
  },
894
894
  /**
895
- * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
895
+ * Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
896
896
  *
897
897
  * Required API Key ACLs:
898
898
  * - addObject
@@ -1117,8 +1117,8 @@ function createIngestionClient({
1117
1117
  * @param listRuns.taskID - Task ID for filtering the list of task runs.
1118
1118
  * @param listRuns.sort - Property by which to sort the list of task runs.
1119
1119
  * @param listRuns.order - Sort order of the response, ascending or descending.
1120
- * @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
1121
- * @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
1120
+ * @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.
1121
+ * @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
1122
1122
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1123
1123
  */
1124
1124
  listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate } = {}, requestOptions = void 0) {
@@ -1285,7 +1285,7 @@ function createIngestionClient({
1285
1285
  return transporter.request(request, requestOptions);
1286
1286
  },
1287
1287
  /**
1288
- * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
1288
+ * Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
1289
1289
  *
1290
1290
  * Required API Key ACLs:
1291
1291
  * - addObject
@@ -1582,7 +1582,7 @@ function createIngestionClient({
1582
1582
  return transporter.request(request, requestOptions);
1583
1583
  },
1584
1584
  /**
1585
- * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
1585
+ * Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
1586
1586
  *
1587
1587
  * Required API Key ACLs:
1588
1588
  * - addObject
@@ -1730,7 +1730,7 @@ function createIngestionClient({
1730
1730
  return transporter.request(request, requestOptions);
1731
1731
  },
1732
1732
  /**
1733
- * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
1733
+ * Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
1734
1734
  *
1735
1735
  * Required API Key ACLs:
1736
1736
  * - addObject
@@ -2024,7 +2024,7 @@ function createIngestionClient({
2024
2024
  return transporter.request(request, requestOptions);
2025
2025
  },
2026
2026
  /**
2027
- * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
2027
+ * Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
2028
2028
  *
2029
2029
  * Required API Key ACLs:
2030
2030
  * - addObject