@algolia/ingestion 1.47.0 → 1.48.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.
- package/README.md +4 -4
- package/dist/browser.d.ts +64 -57
- package/dist/builds/browser.js +13 -13
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +1 -1
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +1 -1
- package/dist/builds/fetch.js +12 -12
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +13 -13
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +13 -13
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +12 -12
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +64 -57
- package/dist/node.d.cts +64 -57
- package/dist/node.d.ts +64 -57
- package/dist/src/ingestionClient.cjs +12 -12
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +12 -12
- package/dist/src/ingestionClient.js.map +1 -1
- package/dist/worker.d.ts +64 -57
- package/package.json +9 -9
package/README.md
CHANGED
|
@@ -40,11 +40,11 @@ All of our clients comes with type definition, and are available for both browse
|
|
|
40
40
|
### With a package manager
|
|
41
41
|
|
|
42
42
|
```bash
|
|
43
|
-
yarn add @algolia/ingestion@1.
|
|
43
|
+
yarn add @algolia/ingestion@1.48.1
|
|
44
44
|
# or
|
|
45
|
-
npm install @algolia/ingestion@1.
|
|
45
|
+
npm install @algolia/ingestion@1.48.1
|
|
46
46
|
# or
|
|
47
|
-
pnpm add @algolia/ingestion@1.
|
|
47
|
+
pnpm add @algolia/ingestion@1.48.1
|
|
48
48
|
```
|
|
49
49
|
|
|
50
50
|
### Without a package manager
|
|
@@ -52,7 +52,7 @@ pnpm add @algolia/ingestion@1.47.0
|
|
|
52
52
|
Add the following JavaScript snippet to the <head> of your website:
|
|
53
53
|
|
|
54
54
|
```html
|
|
55
|
-
<script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.
|
|
55
|
+
<script src="https://cdn.jsdelivr.net/npm/@algolia/ingestion@1.48.1/dist/builds/browser.umd.js"></script>
|
|
56
56
|
```
|
|
57
57
|
|
|
58
58
|
### Usage
|
package/dist/browser.d.ts
CHANGED
|
@@ -83,6 +83,10 @@ type AuthOAuthPartial = {
|
|
|
83
83
|
* Client secret. This field is `null` in the API response.
|
|
84
84
|
*/
|
|
85
85
|
client_secret?: string | undefined;
|
|
86
|
+
/**
|
|
87
|
+
* Authorization code. Used during an `authorization_code` grant type flow, to request an access_token when creating/updating the authentication. This field is not returned in the API response.
|
|
88
|
+
*/
|
|
89
|
+
code?: string | undefined;
|
|
86
90
|
/**
|
|
87
91
|
* OAuth scope.
|
|
88
92
|
*/
|
|
@@ -123,11 +127,11 @@ type Authentication = {
|
|
|
123
127
|
owner?: string | null | undefined;
|
|
124
128
|
input: AuthInputPartial;
|
|
125
129
|
/**
|
|
126
|
-
* Date
|
|
130
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
127
131
|
*/
|
|
128
132
|
createdAt: string;
|
|
129
133
|
/**
|
|
130
|
-
* Date
|
|
134
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
131
135
|
*/
|
|
132
136
|
updatedAt: string;
|
|
133
137
|
};
|
|
@@ -209,11 +213,15 @@ type AuthOAuth = {
|
|
|
209
213
|
/**
|
|
210
214
|
* Client ID.
|
|
211
215
|
*/
|
|
212
|
-
client_id
|
|
216
|
+
client_id?: string | undefined;
|
|
213
217
|
/**
|
|
214
218
|
* Client secret. This field is `null` in the API response.
|
|
215
219
|
*/
|
|
216
|
-
client_secret
|
|
220
|
+
client_secret?: string | undefined;
|
|
221
|
+
/**
|
|
222
|
+
* Authorization code. Used during an `authorization_code` grant type flow, to request an access_token when creating/updating the authentication. This field is not returned in the API response.
|
|
223
|
+
*/
|
|
224
|
+
code?: string | undefined;
|
|
217
225
|
/**
|
|
218
226
|
* OAuth scope.
|
|
219
227
|
*/
|
|
@@ -250,7 +258,7 @@ type AuthenticationCreateResponse = {
|
|
|
250
258
|
*/
|
|
251
259
|
name: string;
|
|
252
260
|
/**
|
|
253
|
-
* Date
|
|
261
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
254
262
|
*/
|
|
255
263
|
createdAt: string;
|
|
256
264
|
};
|
|
@@ -275,14 +283,14 @@ type AuthenticationUpdateResponse = {
|
|
|
275
283
|
*/
|
|
276
284
|
name: string;
|
|
277
285
|
/**
|
|
278
|
-
* Date
|
|
286
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
279
287
|
*/
|
|
280
288
|
updatedAt: string;
|
|
281
289
|
};
|
|
282
290
|
|
|
283
291
|
type DeleteResponse = {
|
|
284
292
|
/**
|
|
285
|
-
* Date
|
|
293
|
+
* Date and time when the resource was deleted, in RFC 3339 format.
|
|
286
294
|
*/
|
|
287
295
|
deletedAt: string;
|
|
288
296
|
};
|
|
@@ -328,11 +336,11 @@ type Destination = {
|
|
|
328
336
|
owner?: string | null | undefined;
|
|
329
337
|
input: DestinationInput;
|
|
330
338
|
/**
|
|
331
|
-
* Date
|
|
339
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
332
340
|
*/
|
|
333
341
|
createdAt: string;
|
|
334
342
|
/**
|
|
335
|
-
* Date
|
|
343
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
336
344
|
*/
|
|
337
345
|
updatedAt: string;
|
|
338
346
|
/**
|
|
@@ -372,7 +380,7 @@ type DestinationCreateResponse = {
|
|
|
372
380
|
*/
|
|
373
381
|
name: string;
|
|
374
382
|
/**
|
|
375
|
-
* Date
|
|
383
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
376
384
|
*/
|
|
377
385
|
createdAt: string;
|
|
378
386
|
};
|
|
@@ -397,7 +405,7 @@ type DestinationUpdateResponse = {
|
|
|
397
405
|
*/
|
|
398
406
|
name: string;
|
|
399
407
|
/**
|
|
400
|
-
* Date
|
|
408
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
401
409
|
*/
|
|
402
410
|
updatedAt: string;
|
|
403
411
|
};
|
|
@@ -428,7 +436,7 @@ type Event = {
|
|
|
428
436
|
[key: string]: any;
|
|
429
437
|
} | null | undefined;
|
|
430
438
|
/**
|
|
431
|
-
* Date
|
|
439
|
+
* Date and time when the resource was published, in RFC 3339 format.
|
|
432
440
|
*/
|
|
433
441
|
publishedAt: string;
|
|
434
442
|
};
|
|
@@ -470,11 +478,11 @@ type ListDestinationsResponse = {
|
|
|
470
478
|
*/
|
|
471
479
|
type Window = {
|
|
472
480
|
/**
|
|
473
|
-
* Date
|
|
481
|
+
* Date and time representing the oldest data in the time window, in RFC 3339 format.
|
|
474
482
|
*/
|
|
475
483
|
startDate: string;
|
|
476
484
|
/**
|
|
477
|
-
* Date
|
|
485
|
+
* Date and time representing the newest data in the time window, in RFC 3339 format.
|
|
478
486
|
*/
|
|
479
487
|
endDate: string;
|
|
480
488
|
};
|
|
@@ -719,11 +727,11 @@ type Source = {
|
|
|
719
727
|
*/
|
|
720
728
|
authenticationID?: string | undefined;
|
|
721
729
|
/**
|
|
722
|
-
* Date
|
|
730
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
723
731
|
*/
|
|
724
732
|
createdAt: string;
|
|
725
733
|
/**
|
|
726
|
-
* Date
|
|
734
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
727
735
|
*/
|
|
728
736
|
updatedAt: string;
|
|
729
737
|
};
|
|
@@ -913,17 +921,17 @@ type Task = {
|
|
|
913
921
|
action?: ActionType | undefined;
|
|
914
922
|
subscriptionAction?: ActionType | undefined;
|
|
915
923
|
/**
|
|
916
|
-
* Date
|
|
924
|
+
* Date and time when the last cursor was created, in RFC 3339 format.
|
|
917
925
|
*/
|
|
918
926
|
cursor?: string | undefined;
|
|
919
927
|
notifications?: Notifications | undefined;
|
|
920
928
|
policies?: Policies | undefined;
|
|
921
929
|
/**
|
|
922
|
-
* Date
|
|
930
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
923
931
|
*/
|
|
924
932
|
createdAt: string;
|
|
925
933
|
/**
|
|
926
|
-
* Date
|
|
934
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
927
935
|
*/
|
|
928
936
|
updatedAt: string;
|
|
929
937
|
};
|
|
@@ -1006,7 +1014,7 @@ type SubscriptionTrigger = {
|
|
|
1006
1014
|
type Trigger = OnDemandTrigger | ScheduleTrigger | SubscriptionTrigger | StreamingTrigger;
|
|
1007
1015
|
|
|
1008
1016
|
/**
|
|
1009
|
-
* The V1 task object
|
|
1017
|
+
* The V1 task object. Use methods and types that don\'t contain the V1 suffix.
|
|
1010
1018
|
*/
|
|
1011
1019
|
type TaskV1 = {
|
|
1012
1020
|
/**
|
|
@@ -1033,17 +1041,17 @@ type TaskV1 = {
|
|
|
1033
1041
|
failureThreshold?: number | undefined;
|
|
1034
1042
|
action?: ActionType | undefined;
|
|
1035
1043
|
/**
|
|
1036
|
-
* Date
|
|
1044
|
+
* Date and time when the last cursor was created, in RFC 3339 format.
|
|
1037
1045
|
*/
|
|
1038
1046
|
cursor?: string | undefined;
|
|
1039
1047
|
notifications?: Notifications | undefined;
|
|
1040
1048
|
policies?: Policies | undefined;
|
|
1041
1049
|
/**
|
|
1042
|
-
* Date
|
|
1050
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1043
1051
|
*/
|
|
1044
1052
|
createdAt: string;
|
|
1045
1053
|
/**
|
|
1046
|
-
* Date
|
|
1054
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
1047
1055
|
*/
|
|
1048
1056
|
updatedAt: string;
|
|
1049
1057
|
};
|
|
@@ -1111,11 +1119,11 @@ type Transformation = {
|
|
|
1111
1119
|
*/
|
|
1112
1120
|
owner?: string | null | undefined;
|
|
1113
1121
|
/**
|
|
1114
|
-
* Date
|
|
1122
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1115
1123
|
*/
|
|
1116
1124
|
createdAt: string;
|
|
1117
1125
|
/**
|
|
1118
|
-
* Date
|
|
1126
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
1119
1127
|
*/
|
|
1120
1128
|
updatedAt: string;
|
|
1121
1129
|
};
|
|
@@ -1177,15 +1185,15 @@ type Run = {
|
|
|
1177
1185
|
reasonCode?: RunReasonCode | undefined;
|
|
1178
1186
|
type: RunType;
|
|
1179
1187
|
/**
|
|
1180
|
-
* Date
|
|
1188
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1181
1189
|
*/
|
|
1182
1190
|
createdAt: string;
|
|
1183
1191
|
/**
|
|
1184
|
-
* Date
|
|
1192
|
+
* Date and time when the task started, in RFC 3339 format.
|
|
1185
1193
|
*/
|
|
1186
1194
|
startedAt?: string | undefined;
|
|
1187
1195
|
/**
|
|
1188
|
-
* Date
|
|
1196
|
+
* Date and time when the task finished, in RFC 3339 format.
|
|
1189
1197
|
*/
|
|
1190
1198
|
finishedAt?: string | undefined;
|
|
1191
1199
|
};
|
|
@@ -1205,7 +1213,7 @@ type RunResponse = {
|
|
|
1205
1213
|
*/
|
|
1206
1214
|
runID: string;
|
|
1207
1215
|
/**
|
|
1208
|
-
* Date
|
|
1216
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1209
1217
|
*/
|
|
1210
1218
|
createdAt: string;
|
|
1211
1219
|
};
|
|
@@ -1218,7 +1226,7 @@ type RunSourceResponse = {
|
|
|
1218
1226
|
[key: string]: string;
|
|
1219
1227
|
};
|
|
1220
1228
|
/**
|
|
1221
|
-
* Date
|
|
1229
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1222
1230
|
*/
|
|
1223
1231
|
createdAt: string;
|
|
1224
1232
|
};
|
|
@@ -1246,7 +1254,7 @@ type SourceCreateResponse = {
|
|
|
1246
1254
|
*/
|
|
1247
1255
|
name: string;
|
|
1248
1256
|
/**
|
|
1249
|
-
* Date
|
|
1257
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1250
1258
|
*/
|
|
1251
1259
|
createdAt: string;
|
|
1252
1260
|
};
|
|
@@ -1265,7 +1273,7 @@ type SourceUpdateResponse = {
|
|
|
1265
1273
|
*/
|
|
1266
1274
|
name: string;
|
|
1267
1275
|
/**
|
|
1268
|
-
* Date
|
|
1276
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
1269
1277
|
*/
|
|
1270
1278
|
updatedAt: string;
|
|
1271
1279
|
};
|
|
@@ -1298,7 +1306,7 @@ type TaskCreate = {
|
|
|
1298
1306
|
failureThreshold?: number | undefined;
|
|
1299
1307
|
input?: TaskInput | undefined;
|
|
1300
1308
|
/**
|
|
1301
|
-
* Date
|
|
1309
|
+
* Date and time when the last cursor was created, in RFC 3339 format.
|
|
1302
1310
|
*/
|
|
1303
1311
|
cursor?: string | undefined;
|
|
1304
1312
|
notifications?: Notifications | undefined;
|
|
@@ -1314,7 +1322,7 @@ type TaskCreateResponse = {
|
|
|
1314
1322
|
*/
|
|
1315
1323
|
taskID: string;
|
|
1316
1324
|
/**
|
|
1317
|
-
* Date
|
|
1325
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1318
1326
|
*/
|
|
1319
1327
|
createdAt: string;
|
|
1320
1328
|
};
|
|
@@ -1340,7 +1348,7 @@ type ScheduleTriggerInput = {
|
|
|
1340
1348
|
type TaskCreateTrigger = OnDemandTriggerInput | ScheduleTriggerInput | SubscriptionTrigger | StreamingTrigger;
|
|
1341
1349
|
|
|
1342
1350
|
/**
|
|
1343
|
-
* API request body for creating a task using the V1 shape
|
|
1351
|
+
* API request body for creating a task using the V1 shape. Use methods and types that don\'t contain the V1 suffix.
|
|
1344
1352
|
*/
|
|
1345
1353
|
type TaskCreateV1 = {
|
|
1346
1354
|
/**
|
|
@@ -1363,7 +1371,7 @@ type TaskCreateV1 = {
|
|
|
1363
1371
|
failureThreshold?: number | undefined;
|
|
1364
1372
|
input?: TaskInput | undefined;
|
|
1365
1373
|
/**
|
|
1366
|
-
* Date
|
|
1374
|
+
* Date and time when the last cursor was created, in RFC 3339 format.
|
|
1367
1375
|
*/
|
|
1368
1376
|
cursor?: string | undefined;
|
|
1369
1377
|
};
|
|
@@ -1381,7 +1389,7 @@ type TaskUpdateResponse = {
|
|
|
1381
1389
|
*/
|
|
1382
1390
|
taskID: string;
|
|
1383
1391
|
/**
|
|
1384
|
-
* Date
|
|
1392
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
1385
1393
|
*/
|
|
1386
1394
|
updatedAt: string;
|
|
1387
1395
|
};
|
|
@@ -1419,7 +1427,7 @@ type TransformationCreateResponse = {
|
|
|
1419
1427
|
*/
|
|
1420
1428
|
transformationID: string;
|
|
1421
1429
|
/**
|
|
1422
|
-
* Date
|
|
1430
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1423
1431
|
*/
|
|
1424
1432
|
createdAt: string;
|
|
1425
1433
|
};
|
|
@@ -1473,7 +1481,7 @@ type TransformationUpdateResponse = {
|
|
|
1473
1481
|
*/
|
|
1474
1482
|
transformationID: string;
|
|
1475
1483
|
/**
|
|
1476
|
-
* Date
|
|
1484
|
+
* Date and time when the resource was last updated, in RFC 3339 format.
|
|
1477
1485
|
*/
|
|
1478
1486
|
updatedAt: string;
|
|
1479
1487
|
};
|
|
@@ -1500,7 +1508,7 @@ type WatchResponse = {
|
|
|
1500
1508
|
*/
|
|
1501
1509
|
message?: string | undefined;
|
|
1502
1510
|
/**
|
|
1503
|
-
* Date
|
|
1511
|
+
* Date and time when the resource was created, in RFC 3339 format.
|
|
1504
1512
|
*/
|
|
1505
1513
|
createdAt?: string | undefined;
|
|
1506
1514
|
};
|
|
@@ -1519,7 +1527,6 @@ type AuthenticationSortKeys = 'name' | 'type' | 'platform' | 'updatedAt' | 'crea
|
|
|
1519
1527
|
* Request body for updating an authentication resource.
|
|
1520
1528
|
*/
|
|
1521
1529
|
type AuthenticationUpdate = {
|
|
1522
|
-
type?: AuthenticationType | undefined;
|
|
1523
1530
|
/**
|
|
1524
1531
|
* Descriptive name for the resource.
|
|
1525
1532
|
*/
|
|
@@ -1697,7 +1704,7 @@ type TaskReplace = {
|
|
|
1697
1704
|
failureThreshold?: number | undefined;
|
|
1698
1705
|
input?: TaskInput | undefined;
|
|
1699
1706
|
/**
|
|
1700
|
-
* Date
|
|
1707
|
+
* Date and time when the last cursor was created, in RFC 3339 format.
|
|
1701
1708
|
*/
|
|
1702
1709
|
cursor?: string | undefined;
|
|
1703
1710
|
notifications?: Notifications | undefined;
|
|
@@ -1746,7 +1753,7 @@ type TriggerUpdateInput = {
|
|
|
1746
1753
|
};
|
|
1747
1754
|
|
|
1748
1755
|
/**
|
|
1749
|
-
* API request body for updating a task using the V1 shape
|
|
1756
|
+
* API request body for updating a task using the V1 shape. Use methods and types that don\'t contain the V1 suffix.
|
|
1750
1757
|
*/
|
|
1751
1758
|
type TaskUpdateV1 = {
|
|
1752
1759
|
/**
|
|
@@ -2145,11 +2152,11 @@ type ListRunsProps = {
|
|
|
2145
2152
|
*/
|
|
2146
2153
|
order?: OrderKeys | undefined;
|
|
2147
2154
|
/**
|
|
2148
|
-
* Date
|
|
2155
|
+
* Date and time for the earliest run to retrieve, in RFC 3339 format. By default, the current day minus seven days is used.
|
|
2149
2156
|
*/
|
|
2150
2157
|
startDate?: string | undefined;
|
|
2151
2158
|
/**
|
|
2152
|
-
* Date
|
|
2159
|
+
* Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
|
|
2153
2160
|
*/
|
|
2154
2161
|
endDate?: string | undefined;
|
|
2155
2162
|
};
|
|
@@ -2494,7 +2501,7 @@ type ChunkedPushOptions = {
|
|
|
2494
2501
|
objects: Array<Record<string, unknown>>;
|
|
2495
2502
|
};
|
|
2496
2503
|
|
|
2497
|
-
declare const apiClientVersion = "1.
|
|
2504
|
+
declare const apiClientVersion = "1.48.1";
|
|
2498
2505
|
declare const REGIONS: readonly ["eu", "us"];
|
|
2499
2506
|
type Region = (typeof REGIONS)[number];
|
|
2500
2507
|
type RegionOptions = {
|
|
@@ -2614,7 +2621,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2614
2621
|
*/
|
|
2615
2622
|
createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
|
|
2616
2623
|
/**
|
|
2617
|
-
* Creates a new task using the v1 endpoint
|
|
2624
|
+
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
2618
2625
|
*
|
|
2619
2626
|
* Required API Key ACLs:
|
|
2620
2627
|
* - addObject
|
|
@@ -2720,7 +2727,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2720
2727
|
*/
|
|
2721
2728
|
deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
2722
2729
|
/**
|
|
2723
|
-
* Deletes a task by its ID using the v1 endpoint
|
|
2730
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
2724
2731
|
*
|
|
2725
2732
|
* Required API Key ACLs:
|
|
2726
2733
|
* - addObject
|
|
@@ -2758,7 +2765,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2758
2765
|
*/
|
|
2759
2766
|
disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2760
2767
|
/**
|
|
2761
|
-
* Disables a task using the v1 endpoint
|
|
2768
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
2762
2769
|
*
|
|
2763
2770
|
* Required API Key ACLs:
|
|
2764
2771
|
* - addObject
|
|
@@ -2784,7 +2791,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2784
2791
|
*/
|
|
2785
2792
|
enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2786
2793
|
/**
|
|
2787
|
-
* Enables a task using the v1 endpoint
|
|
2794
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
2788
2795
|
*
|
|
2789
2796
|
* Required API Key ACLs:
|
|
2790
2797
|
* - addObject
|
|
@@ -2871,7 +2878,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2871
2878
|
*/
|
|
2872
2879
|
getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
|
|
2873
2880
|
/**
|
|
2874
|
-
* Retrieves a task by its ID using the v1 endpoint
|
|
2881
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
2875
2882
|
*
|
|
2876
2883
|
* Required API Key ACLs:
|
|
2877
2884
|
* - addObject
|
|
@@ -2966,8 +2973,8 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
2966
2973
|
* @param listRuns.taskID - Task ID for filtering the list of task runs.
|
|
2967
2974
|
* @param listRuns.sort - Property by which to sort the list of task runs.
|
|
2968
2975
|
* @param listRuns.order - Sort order of the response, ascending or descending.
|
|
2969
|
-
* @param listRuns.startDate - Date
|
|
2970
|
-
* @param listRuns.endDate - Date
|
|
2976
|
+
* @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.
|
|
2977
|
+
* @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
|
|
2971
2978
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2972
2979
|
*/
|
|
2973
2980
|
listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
|
|
@@ -3011,7 +3018,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
3011
3018
|
*/
|
|
3012
3019
|
listTasks({ itemsPerPage, page, action, enabled, sourceID, sourceType, destinationID, triggerType, withEmailNotifications, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
|
|
3013
3020
|
/**
|
|
3014
|
-
* Retrieves a list of tasks using the v1 endpoint
|
|
3021
|
+
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
3015
3022
|
*
|
|
3016
3023
|
* Required API Key ACLs:
|
|
3017
3024
|
* - addObject
|
|
@@ -3117,7 +3124,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
3117
3124
|
*/
|
|
3118
3125
|
runTask({ taskID, runTaskPayload }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
|
|
3119
3126
|
/**
|
|
3120
|
-
* Runs a task using the v1 endpoint
|
|
3127
|
+
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
3121
3128
|
*
|
|
3122
3129
|
* Required API Key ACLs:
|
|
3123
3130
|
* - addObject
|
|
@@ -3176,7 +3183,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
3176
3183
|
*/
|
|
3177
3184
|
searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Array<Task>>;
|
|
3178
3185
|
/**
|
|
3179
|
-
* Searches for tasks using the v1 endpoint
|
|
3186
|
+
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
3180
3187
|
*
|
|
3181
3188
|
* Required API Key ACLs:
|
|
3182
3189
|
* - addObject
|
|
@@ -3288,7 +3295,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
|
|
|
3288
3295
|
*/
|
|
3289
3296
|
updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
3290
3297
|
/**
|
|
3291
|
-
* Updates a task by its ID using the v1 endpoint
|
|
3298
|
+
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
3292
3299
|
*
|
|
3293
3300
|
* Required API Key ACLs:
|
|
3294
3301
|
* - addObject
|
package/dist/builds/browser.js
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
// builds/browser.ts
|
|
2
|
-
import { createXhrRequester } from "@algolia/requester-browser-xhr";
|
|
3
2
|
import {
|
|
4
3
|
createBrowserLocalStorageCache,
|
|
5
4
|
createFallbackableCache,
|
|
6
5
|
createMemoryCache,
|
|
7
6
|
createNullLogger
|
|
8
7
|
} from "@algolia/client-common";
|
|
8
|
+
import { createXhrRequester } from "@algolia/requester-browser-xhr";
|
|
9
9
|
|
|
10
10
|
// src/ingestionClient.ts
|
|
11
11
|
import { createAuth, createIterablePromise, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
|
|
12
|
-
var apiClientVersion = "1.
|
|
12
|
+
var apiClientVersion = "1.48.1";
|
|
13
13
|
var REGIONS = ["eu", "us"];
|
|
14
14
|
function getDefaultHosts(region) {
|
|
15
15
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -299,7 +299,7 @@ function createIngestionClient({
|
|
|
299
299
|
return transporter.request(request, requestOptions);
|
|
300
300
|
},
|
|
301
301
|
/**
|
|
302
|
-
* Creates a new task using the v1 endpoint
|
|
302
|
+
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
303
303
|
*
|
|
304
304
|
* Required API Key ACLs:
|
|
305
305
|
* - addObject
|
|
@@ -570,7 +570,7 @@ function createIngestionClient({
|
|
|
570
570
|
return transporter.request(request, requestOptions);
|
|
571
571
|
},
|
|
572
572
|
/**
|
|
573
|
-
* Deletes a task by its ID using the v1 endpoint
|
|
573
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
574
574
|
*
|
|
575
575
|
* Required API Key ACLs:
|
|
576
576
|
* - addObject
|
|
@@ -653,7 +653,7 @@ function createIngestionClient({
|
|
|
653
653
|
return transporter.request(request, requestOptions);
|
|
654
654
|
},
|
|
655
655
|
/**
|
|
656
|
-
* Disables a task using the v1 endpoint
|
|
656
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
657
657
|
*
|
|
658
658
|
* Required API Key ACLs:
|
|
659
659
|
* - addObject
|
|
@@ -707,7 +707,7 @@ function createIngestionClient({
|
|
|
707
707
|
return transporter.request(request, requestOptions);
|
|
708
708
|
},
|
|
709
709
|
/**
|
|
710
|
-
* Enables a task using the v1 endpoint
|
|
710
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
711
711
|
*
|
|
712
712
|
* Required API Key ACLs:
|
|
713
713
|
* - addObject
|
|
@@ -901,7 +901,7 @@ function createIngestionClient({
|
|
|
901
901
|
return transporter.request(request, requestOptions);
|
|
902
902
|
},
|
|
903
903
|
/**
|
|
904
|
-
* Retrieves a task by its ID using the v1 endpoint
|
|
904
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
905
905
|
*
|
|
906
906
|
* Required API Key ACLs:
|
|
907
907
|
* - addObject
|
|
@@ -1126,8 +1126,8 @@ function createIngestionClient({
|
|
|
1126
1126
|
* @param listRuns.taskID - Task ID for filtering the list of task runs.
|
|
1127
1127
|
* @param listRuns.sort - Property by which to sort the list of task runs.
|
|
1128
1128
|
* @param listRuns.order - Sort order of the response, ascending or descending.
|
|
1129
|
-
* @param listRuns.startDate - Date
|
|
1130
|
-
* @param listRuns.endDate - Date
|
|
1129
|
+
* @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.
|
|
1130
|
+
* @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
|
|
1131
1131
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1132
1132
|
*/
|
|
1133
1133
|
listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate } = {}, requestOptions = void 0) {
|
|
@@ -1294,7 +1294,7 @@ function createIngestionClient({
|
|
|
1294
1294
|
return transporter.request(request, requestOptions);
|
|
1295
1295
|
},
|
|
1296
1296
|
/**
|
|
1297
|
-
* Retrieves a list of tasks using the v1 endpoint
|
|
1297
|
+
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
1298
1298
|
*
|
|
1299
1299
|
* Required API Key ACLs:
|
|
1300
1300
|
* - addObject
|
|
@@ -1591,7 +1591,7 @@ function createIngestionClient({
|
|
|
1591
1591
|
return transporter.request(request, requestOptions);
|
|
1592
1592
|
},
|
|
1593
1593
|
/**
|
|
1594
|
-
* Runs a task using the v1 endpoint
|
|
1594
|
+
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1595
1595
|
*
|
|
1596
1596
|
* Required API Key ACLs:
|
|
1597
1597
|
* - addObject
|
|
@@ -1739,7 +1739,7 @@ function createIngestionClient({
|
|
|
1739
1739
|
return transporter.request(request, requestOptions);
|
|
1740
1740
|
},
|
|
1741
1741
|
/**
|
|
1742
|
-
* Searches for tasks using the v1 endpoint
|
|
1742
|
+
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
1743
1743
|
*
|
|
1744
1744
|
* Required API Key ACLs:
|
|
1745
1745
|
* - addObject
|
|
@@ -2033,7 +2033,7 @@ function createIngestionClient({
|
|
|
2033
2033
|
return transporter.request(request, requestOptions);
|
|
2034
2034
|
},
|
|
2035
2035
|
/**
|
|
2036
|
-
* Updates a task by its ID using the v1 endpoint
|
|
2036
|
+
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
2037
2037
|
*
|
|
2038
2038
|
* Required API Key ACLs:
|
|
2039
2039
|
* - addObject
|