@algolia/ingestion 1.55.2 → 1.56.0
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 +954 -7
- package/dist/builds/browser.js +2213 -189
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +5 -5
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +9 -9
- package/dist/builds/fetch.js +2213 -189
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +2213 -189
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +2213 -189
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +2213 -189
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +954 -7
- package/dist/node.d.cts +954 -7
- package/dist/node.d.ts +954 -7
- package/dist/src/ingestionClient.cjs +2213 -189
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +2213 -189
- package/dist/src/ingestionClient.js.map +1 -1
- package/dist/worker.d.ts +954 -7
- package/package.json +8 -8
|
@@ -29,7 +29,7 @@ __export(ingestionClient_exports, {
|
|
|
29
29
|
});
|
|
30
30
|
module.exports = __toCommonJS(ingestionClient_exports);
|
|
31
31
|
var import_client_common = require("@algolia/client-common");
|
|
32
|
-
var apiClientVersion = "1.
|
|
32
|
+
var apiClientVersion = "1.56.0";
|
|
33
33
|
var REGIONS = ["eu", "us"];
|
|
34
34
|
function getDefaultHosts(region) {
|
|
35
35
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -219,6 +219,36 @@ function createIngestionClient({
|
|
|
219
219
|
};
|
|
220
220
|
return transporter.request(request, requestOptions);
|
|
221
221
|
},
|
|
222
|
+
/**
|
|
223
|
+
* Creates a new authentication resource.
|
|
224
|
+
*
|
|
225
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
226
|
+
*
|
|
227
|
+
* Required API Key ACLs:
|
|
228
|
+
* - addObject
|
|
229
|
+
* - deleteIndex
|
|
230
|
+
* - editSettings
|
|
231
|
+
* @param authenticationCreate -
|
|
232
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
233
|
+
* @see createAuthentication for the plain version.
|
|
234
|
+
*/
|
|
235
|
+
createAuthenticationWithHTTPInfo(authenticationCreate, requestOptions) {
|
|
236
|
+
(0, import_client_common.validateRequired)("authenticationCreate", "createAuthenticationWithHTTPInfo", authenticationCreate);
|
|
237
|
+
(0, import_client_common.validateRequired)("authenticationCreate.type", "createAuthenticationWithHTTPInfo", authenticationCreate.type);
|
|
238
|
+
(0, import_client_common.validateRequired)("authenticationCreate.name", "createAuthenticationWithHTTPInfo", authenticationCreate.name);
|
|
239
|
+
(0, import_client_common.validateRequired)("authenticationCreate.input", "createAuthenticationWithHTTPInfo", authenticationCreate.input);
|
|
240
|
+
const requestPath = "/1/authentications";
|
|
241
|
+
const headers = {};
|
|
242
|
+
const queryParameters = {};
|
|
243
|
+
const request = {
|
|
244
|
+
method: "POST",
|
|
245
|
+
path: requestPath,
|
|
246
|
+
queryParameters,
|
|
247
|
+
headers,
|
|
248
|
+
data: authenticationCreate
|
|
249
|
+
};
|
|
250
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
251
|
+
},
|
|
222
252
|
/**
|
|
223
253
|
* Creates a new destination.
|
|
224
254
|
*
|
|
@@ -246,6 +276,36 @@ function createIngestionClient({
|
|
|
246
276
|
};
|
|
247
277
|
return transporter.request(request, requestOptions);
|
|
248
278
|
},
|
|
279
|
+
/**
|
|
280
|
+
* Creates a new destination.
|
|
281
|
+
*
|
|
282
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
283
|
+
*
|
|
284
|
+
* Required API Key ACLs:
|
|
285
|
+
* - addObject
|
|
286
|
+
* - deleteIndex
|
|
287
|
+
* - editSettings
|
|
288
|
+
* @param destinationCreate -
|
|
289
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
290
|
+
* @see createDestination for the plain version.
|
|
291
|
+
*/
|
|
292
|
+
createDestinationWithHTTPInfo(destinationCreate, requestOptions) {
|
|
293
|
+
(0, import_client_common.validateRequired)("destinationCreate", "createDestinationWithHTTPInfo", destinationCreate);
|
|
294
|
+
(0, import_client_common.validateRequired)("destinationCreate.type", "createDestinationWithHTTPInfo", destinationCreate.type);
|
|
295
|
+
(0, import_client_common.validateRequired)("destinationCreate.name", "createDestinationWithHTTPInfo", destinationCreate.name);
|
|
296
|
+
(0, import_client_common.validateRequired)("destinationCreate.input", "createDestinationWithHTTPInfo", destinationCreate.input);
|
|
297
|
+
const requestPath = "/1/destinations";
|
|
298
|
+
const headers = {};
|
|
299
|
+
const queryParameters = {};
|
|
300
|
+
const request = {
|
|
301
|
+
method: "POST",
|
|
302
|
+
path: requestPath,
|
|
303
|
+
queryParameters,
|
|
304
|
+
headers,
|
|
305
|
+
data: destinationCreate
|
|
306
|
+
};
|
|
307
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
308
|
+
},
|
|
249
309
|
/**
|
|
250
310
|
* Creates a new source.
|
|
251
311
|
*
|
|
@@ -272,6 +332,35 @@ function createIngestionClient({
|
|
|
272
332
|
};
|
|
273
333
|
return transporter.request(request, requestOptions);
|
|
274
334
|
},
|
|
335
|
+
/**
|
|
336
|
+
* Creates a new source.
|
|
337
|
+
*
|
|
338
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
339
|
+
*
|
|
340
|
+
* Required API Key ACLs:
|
|
341
|
+
* - addObject
|
|
342
|
+
* - deleteIndex
|
|
343
|
+
* - editSettings
|
|
344
|
+
* @param sourceCreate -
|
|
345
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
346
|
+
* @see createSource for the plain version.
|
|
347
|
+
*/
|
|
348
|
+
createSourceWithHTTPInfo(sourceCreate, requestOptions) {
|
|
349
|
+
(0, import_client_common.validateRequired)("sourceCreate", "createSourceWithHTTPInfo", sourceCreate);
|
|
350
|
+
(0, import_client_common.validateRequired)("sourceCreate.type", "createSourceWithHTTPInfo", sourceCreate.type);
|
|
351
|
+
(0, import_client_common.validateRequired)("sourceCreate.name", "createSourceWithHTTPInfo", sourceCreate.name);
|
|
352
|
+
const requestPath = "/1/sources";
|
|
353
|
+
const headers = {};
|
|
354
|
+
const queryParameters = {};
|
|
355
|
+
const request = {
|
|
356
|
+
method: "POST",
|
|
357
|
+
path: requestPath,
|
|
358
|
+
queryParameters,
|
|
359
|
+
headers,
|
|
360
|
+
data: sourceCreate
|
|
361
|
+
};
|
|
362
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
363
|
+
},
|
|
275
364
|
/**
|
|
276
365
|
* Creates a new task.
|
|
277
366
|
*
|
|
@@ -299,6 +388,36 @@ function createIngestionClient({
|
|
|
299
388
|
};
|
|
300
389
|
return transporter.request(request, requestOptions);
|
|
301
390
|
},
|
|
391
|
+
/**
|
|
392
|
+
* Creates a new task.
|
|
393
|
+
*
|
|
394
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
395
|
+
*
|
|
396
|
+
* Required API Key ACLs:
|
|
397
|
+
* - addObject
|
|
398
|
+
* - deleteIndex
|
|
399
|
+
* - editSettings
|
|
400
|
+
* @param taskCreate - Request body for creating a task.
|
|
401
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
402
|
+
* @see createTask for the plain version.
|
|
403
|
+
*/
|
|
404
|
+
createTaskWithHTTPInfo(taskCreate, requestOptions) {
|
|
405
|
+
(0, import_client_common.validateRequired)("taskCreate", "createTaskWithHTTPInfo", taskCreate);
|
|
406
|
+
(0, import_client_common.validateRequired)("taskCreate.sourceID", "createTaskWithHTTPInfo", taskCreate.sourceID);
|
|
407
|
+
(0, import_client_common.validateRequired)("taskCreate.destinationID", "createTaskWithHTTPInfo", taskCreate.destinationID);
|
|
408
|
+
(0, import_client_common.validateRequired)("taskCreate.action", "createTaskWithHTTPInfo", taskCreate.action);
|
|
409
|
+
const requestPath = "/2/tasks";
|
|
410
|
+
const headers = {};
|
|
411
|
+
const queryParameters = {};
|
|
412
|
+
const request = {
|
|
413
|
+
method: "POST",
|
|
414
|
+
path: requestPath,
|
|
415
|
+
queryParameters,
|
|
416
|
+
headers,
|
|
417
|
+
data: taskCreate
|
|
418
|
+
};
|
|
419
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
420
|
+
},
|
|
302
421
|
/**
|
|
303
422
|
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
304
423
|
*
|
|
@@ -329,6 +448,39 @@ function createIngestionClient({
|
|
|
329
448
|
};
|
|
330
449
|
return transporter.request(request, requestOptions);
|
|
331
450
|
},
|
|
451
|
+
/**
|
|
452
|
+
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
453
|
+
*
|
|
454
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
455
|
+
*
|
|
456
|
+
* Required API Key ACLs:
|
|
457
|
+
* - addObject
|
|
458
|
+
* - deleteIndex
|
|
459
|
+
* - editSettings
|
|
460
|
+
*
|
|
461
|
+
* @deprecated
|
|
462
|
+
* @param taskCreate - Request body for creating a task.
|
|
463
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
464
|
+
* @see createTaskV1 for the plain version.
|
|
465
|
+
*/
|
|
466
|
+
createTaskV1WithHTTPInfo(taskCreate, requestOptions) {
|
|
467
|
+
(0, import_client_common.validateRequired)("taskCreate", "createTaskV1WithHTTPInfo", taskCreate);
|
|
468
|
+
(0, import_client_common.validateRequired)("taskCreate.sourceID", "createTaskV1WithHTTPInfo", taskCreate.sourceID);
|
|
469
|
+
(0, import_client_common.validateRequired)("taskCreate.destinationID", "createTaskV1WithHTTPInfo", taskCreate.destinationID);
|
|
470
|
+
(0, import_client_common.validateRequired)("taskCreate.trigger", "createTaskV1WithHTTPInfo", taskCreate.trigger);
|
|
471
|
+
(0, import_client_common.validateRequired)("taskCreate.action", "createTaskV1WithHTTPInfo", taskCreate.action);
|
|
472
|
+
const requestPath = "/1/tasks";
|
|
473
|
+
const headers = {};
|
|
474
|
+
const queryParameters = {};
|
|
475
|
+
const request = {
|
|
476
|
+
method: "POST",
|
|
477
|
+
path: requestPath,
|
|
478
|
+
queryParameters,
|
|
479
|
+
headers,
|
|
480
|
+
data: taskCreate
|
|
481
|
+
};
|
|
482
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
483
|
+
},
|
|
332
484
|
/**
|
|
333
485
|
* Creates a new transformation.
|
|
334
486
|
*
|
|
@@ -354,6 +506,34 @@ function createIngestionClient({
|
|
|
354
506
|
};
|
|
355
507
|
return transporter.request(request, requestOptions);
|
|
356
508
|
},
|
|
509
|
+
/**
|
|
510
|
+
* Creates a new transformation.
|
|
511
|
+
*
|
|
512
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
513
|
+
*
|
|
514
|
+
* Required API Key ACLs:
|
|
515
|
+
* - addObject
|
|
516
|
+
* - deleteIndex
|
|
517
|
+
* - editSettings
|
|
518
|
+
* @param transformationCreate - Request body for creating a transformation.
|
|
519
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
520
|
+
* @see createTransformation for the plain version.
|
|
521
|
+
*/
|
|
522
|
+
createTransformationWithHTTPInfo(transformationCreate, requestOptions) {
|
|
523
|
+
(0, import_client_common.validateRequired)("transformationCreate", "createTransformationWithHTTPInfo", transformationCreate);
|
|
524
|
+
(0, import_client_common.validateRequired)("transformationCreate.name", "createTransformationWithHTTPInfo", transformationCreate.name);
|
|
525
|
+
const requestPath = "/1/transformations";
|
|
526
|
+
const headers = {};
|
|
527
|
+
const queryParameters = {};
|
|
528
|
+
const request = {
|
|
529
|
+
method: "POST",
|
|
530
|
+
path: requestPath,
|
|
531
|
+
queryParameters,
|
|
532
|
+
headers,
|
|
533
|
+
data: transformationCreate
|
|
534
|
+
};
|
|
535
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
536
|
+
},
|
|
357
537
|
/**
|
|
358
538
|
* This method lets you send requests to the Algolia REST API.
|
|
359
539
|
* @param customDelete - The customDelete object.
|
|
@@ -374,6 +554,29 @@ function createIngestionClient({
|
|
|
374
554
|
};
|
|
375
555
|
return transporter.request(request, requestOptions);
|
|
376
556
|
},
|
|
557
|
+
/**
|
|
558
|
+
* This method lets you send requests to the Algolia REST API.
|
|
559
|
+
*
|
|
560
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
561
|
+
* @param customDelete - The customDelete object.
|
|
562
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
563
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
564
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
565
|
+
* @see customDelete for the plain version.
|
|
566
|
+
*/
|
|
567
|
+
customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
568
|
+
(0, import_client_common.validateRequired)("path", "customDeleteWithHTTPInfo", path);
|
|
569
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
570
|
+
const headers = {};
|
|
571
|
+
const queryParameters = parameters ? parameters : {};
|
|
572
|
+
const request = {
|
|
573
|
+
method: "DELETE",
|
|
574
|
+
path: requestPath,
|
|
575
|
+
queryParameters,
|
|
576
|
+
headers
|
|
577
|
+
};
|
|
578
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
579
|
+
},
|
|
377
580
|
/**
|
|
378
581
|
* This method lets you send requests to the Algolia REST API.
|
|
379
582
|
* @param customGet - The customGet object.
|
|
@@ -394,6 +597,29 @@ function createIngestionClient({
|
|
|
394
597
|
};
|
|
395
598
|
return transporter.request(request, requestOptions);
|
|
396
599
|
},
|
|
600
|
+
/**
|
|
601
|
+
* This method lets you send requests to the Algolia REST API.
|
|
602
|
+
*
|
|
603
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
604
|
+
* @param customGet - The customGet object.
|
|
605
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
606
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
607
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
608
|
+
* @see customGet for the plain version.
|
|
609
|
+
*/
|
|
610
|
+
customGetWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
611
|
+
(0, import_client_common.validateRequired)("path", "customGetWithHTTPInfo", path);
|
|
612
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
613
|
+
const headers = {};
|
|
614
|
+
const queryParameters = parameters ? parameters : {};
|
|
615
|
+
const request = {
|
|
616
|
+
method: "GET",
|
|
617
|
+
path: requestPath,
|
|
618
|
+
queryParameters,
|
|
619
|
+
headers
|
|
620
|
+
};
|
|
621
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
622
|
+
},
|
|
397
623
|
/**
|
|
398
624
|
* This method lets you send requests to the Algolia REST API.
|
|
399
625
|
* @param customPost - The customPost object.
|
|
@@ -416,6 +642,31 @@ function createIngestionClient({
|
|
|
416
642
|
};
|
|
417
643
|
return transporter.request(request, requestOptions);
|
|
418
644
|
},
|
|
645
|
+
/**
|
|
646
|
+
* This method lets you send requests to the Algolia REST API.
|
|
647
|
+
*
|
|
648
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
649
|
+
* @param customPost - The customPost object.
|
|
650
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
651
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
652
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
653
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
654
|
+
* @see customPost for the plain version.
|
|
655
|
+
*/
|
|
656
|
+
customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
657
|
+
(0, import_client_common.validateRequired)("path", "customPostWithHTTPInfo", path);
|
|
658
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
659
|
+
const headers = {};
|
|
660
|
+
const queryParameters = parameters ? parameters : {};
|
|
661
|
+
const request = {
|
|
662
|
+
method: "POST",
|
|
663
|
+
path: requestPath,
|
|
664
|
+
queryParameters,
|
|
665
|
+
headers,
|
|
666
|
+
data: body ? body : {}
|
|
667
|
+
};
|
|
668
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
669
|
+
},
|
|
419
670
|
/**
|
|
420
671
|
* This method lets you send requests to the Algolia REST API.
|
|
421
672
|
* @param customPut - The customPut object.
|
|
@@ -438,6 +689,31 @@ function createIngestionClient({
|
|
|
438
689
|
};
|
|
439
690
|
return transporter.request(request, requestOptions);
|
|
440
691
|
},
|
|
692
|
+
/**
|
|
693
|
+
* This method lets you send requests to the Algolia REST API.
|
|
694
|
+
*
|
|
695
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
696
|
+
* @param customPut - The customPut object.
|
|
697
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
698
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
699
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
700
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
701
|
+
* @see customPut for the plain version.
|
|
702
|
+
*/
|
|
703
|
+
customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
704
|
+
(0, import_client_common.validateRequired)("path", "customPutWithHTTPInfo", path);
|
|
705
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
706
|
+
const headers = {};
|
|
707
|
+
const queryParameters = parameters ? parameters : {};
|
|
708
|
+
const request = {
|
|
709
|
+
method: "PUT",
|
|
710
|
+
path: requestPath,
|
|
711
|
+
queryParameters,
|
|
712
|
+
headers,
|
|
713
|
+
data: body ? body : {}
|
|
714
|
+
};
|
|
715
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
716
|
+
},
|
|
441
717
|
/**
|
|
442
718
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
443
719
|
*
|
|
@@ -466,21 +742,24 @@ function createIngestionClient({
|
|
|
466
742
|
return transporter.request(request, requestOptions);
|
|
467
743
|
},
|
|
468
744
|
/**
|
|
469
|
-
* Deletes
|
|
745
|
+
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
746
|
+
*
|
|
747
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
470
748
|
*
|
|
471
749
|
* Required API Key ACLs:
|
|
472
750
|
* - addObject
|
|
473
751
|
* - deleteIndex
|
|
474
752
|
* - editSettings
|
|
475
|
-
* @param
|
|
476
|
-
* @param
|
|
753
|
+
* @param deleteAuthentication - The deleteAuthentication object.
|
|
754
|
+
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
477
755
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
756
|
+
* @see deleteAuthentication for the plain version.
|
|
478
757
|
*/
|
|
479
|
-
|
|
480
|
-
(0, import_client_common.validateRequired)("
|
|
481
|
-
const requestPath = "/1/
|
|
482
|
-
"{
|
|
483
|
-
encodeURIComponent(
|
|
758
|
+
deleteAuthenticationWithHTTPInfo({ authenticationID }, requestOptions) {
|
|
759
|
+
(0, import_client_common.validateRequired)("authenticationID", "deleteAuthenticationWithHTTPInfo", authenticationID);
|
|
760
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
761
|
+
"{authenticationID}",
|
|
762
|
+
encodeURIComponent(authenticationID)
|
|
484
763
|
);
|
|
485
764
|
const headers = {};
|
|
486
765
|
const queryParameters = {};
|
|
@@ -490,22 +769,25 @@ function createIngestionClient({
|
|
|
490
769
|
queryParameters,
|
|
491
770
|
headers
|
|
492
771
|
};
|
|
493
|
-
return transporter.
|
|
772
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
494
773
|
},
|
|
495
774
|
/**
|
|
496
|
-
* Deletes a
|
|
775
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
497
776
|
*
|
|
498
777
|
* Required API Key ACLs:
|
|
499
778
|
* - addObject
|
|
500
779
|
* - deleteIndex
|
|
501
780
|
* - editSettings
|
|
502
|
-
* @param
|
|
503
|
-
* @param
|
|
781
|
+
* @param deleteDestination - The deleteDestination object.
|
|
782
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
504
783
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
505
784
|
*/
|
|
506
|
-
|
|
507
|
-
(0, import_client_common.validateRequired)("
|
|
508
|
-
const requestPath = "/1/
|
|
785
|
+
deleteDestination({ destinationID }, requestOptions) {
|
|
786
|
+
(0, import_client_common.validateRequired)("destinationID", "deleteDestination", destinationID);
|
|
787
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
788
|
+
"{destinationID}",
|
|
789
|
+
encodeURIComponent(destinationID)
|
|
790
|
+
);
|
|
509
791
|
const headers = {};
|
|
510
792
|
const queryParameters = {};
|
|
511
793
|
const request = {
|
|
@@ -517,19 +799,25 @@ function createIngestionClient({
|
|
|
517
799
|
return transporter.request(request, requestOptions);
|
|
518
800
|
},
|
|
519
801
|
/**
|
|
520
|
-
* Deletes a
|
|
802
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
803
|
+
*
|
|
804
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
521
805
|
*
|
|
522
806
|
* Required API Key ACLs:
|
|
523
807
|
* - addObject
|
|
524
808
|
* - deleteIndex
|
|
525
809
|
* - editSettings
|
|
526
|
-
* @param
|
|
527
|
-
* @param
|
|
810
|
+
* @param deleteDestination - The deleteDestination object.
|
|
811
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
528
812
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
813
|
+
* @see deleteDestination for the plain version.
|
|
529
814
|
*/
|
|
530
|
-
|
|
531
|
-
(0, import_client_common.validateRequired)("
|
|
532
|
-
const requestPath = "/
|
|
815
|
+
deleteDestinationWithHTTPInfo({ destinationID }, requestOptions) {
|
|
816
|
+
(0, import_client_common.validateRequired)("destinationID", "deleteDestinationWithHTTPInfo", destinationID);
|
|
817
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
818
|
+
"{destinationID}",
|
|
819
|
+
encodeURIComponent(destinationID)
|
|
820
|
+
);
|
|
533
821
|
const headers = {};
|
|
534
822
|
const queryParameters = {};
|
|
535
823
|
const request = {
|
|
@@ -538,24 +826,22 @@ function createIngestionClient({
|
|
|
538
826
|
queryParameters,
|
|
539
827
|
headers
|
|
540
828
|
};
|
|
541
|
-
return transporter.
|
|
829
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
542
830
|
},
|
|
543
831
|
/**
|
|
544
|
-
* Deletes a
|
|
832
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
545
833
|
*
|
|
546
834
|
* Required API Key ACLs:
|
|
547
835
|
* - addObject
|
|
548
836
|
* - deleteIndex
|
|
549
837
|
* - editSettings
|
|
550
|
-
*
|
|
551
|
-
* @
|
|
552
|
-
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
553
|
-
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
838
|
+
* @param deleteSource - The deleteSource object.
|
|
839
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
554
840
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
555
841
|
*/
|
|
556
|
-
|
|
557
|
-
(0, import_client_common.validateRequired)("
|
|
558
|
-
const requestPath = "/1/
|
|
842
|
+
deleteSource({ sourceID }, requestOptions) {
|
|
843
|
+
(0, import_client_common.validateRequired)("sourceID", "deleteSource", sourceID);
|
|
844
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
559
845
|
const headers = {};
|
|
560
846
|
const queryParameters = {};
|
|
561
847
|
const request = {
|
|
@@ -567,22 +853,22 @@ function createIngestionClient({
|
|
|
567
853
|
return transporter.request(request, requestOptions);
|
|
568
854
|
},
|
|
569
855
|
/**
|
|
570
|
-
* Deletes a
|
|
856
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
857
|
+
*
|
|
858
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
571
859
|
*
|
|
572
860
|
* Required API Key ACLs:
|
|
573
861
|
* - addObject
|
|
574
862
|
* - deleteIndex
|
|
575
863
|
* - editSettings
|
|
576
|
-
* @param
|
|
577
|
-
* @param
|
|
864
|
+
* @param deleteSource - The deleteSource object.
|
|
865
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
578
866
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
867
|
+
* @see deleteSource for the plain version.
|
|
579
868
|
*/
|
|
580
|
-
|
|
581
|
-
(0, import_client_common.validateRequired)("
|
|
582
|
-
const requestPath = "/1/
|
|
583
|
-
"{transformationID}",
|
|
584
|
-
encodeURIComponent(transformationID)
|
|
585
|
-
);
|
|
869
|
+
deleteSourceWithHTTPInfo({ sourceID }, requestOptions) {
|
|
870
|
+
(0, import_client_common.validateRequired)("sourceID", "deleteSourceWithHTTPInfo", sourceID);
|
|
871
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
586
872
|
const headers = {};
|
|
587
873
|
const queryParameters = {};
|
|
588
874
|
const request = {
|
|
@@ -591,26 +877,26 @@ function createIngestionClient({
|
|
|
591
877
|
queryParameters,
|
|
592
878
|
headers
|
|
593
879
|
};
|
|
594
|
-
return transporter.
|
|
880
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
595
881
|
},
|
|
596
882
|
/**
|
|
597
|
-
*
|
|
883
|
+
* Deletes a task by its ID.
|
|
598
884
|
*
|
|
599
885
|
* Required API Key ACLs:
|
|
600
886
|
* - addObject
|
|
601
887
|
* - deleteIndex
|
|
602
888
|
* - editSettings
|
|
603
|
-
* @param
|
|
604
|
-
* @param
|
|
889
|
+
* @param deleteTask - The deleteTask object.
|
|
890
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
605
891
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
606
892
|
*/
|
|
607
|
-
|
|
608
|
-
(0, import_client_common.validateRequired)("taskID", "
|
|
609
|
-
const requestPath = "/2/tasks/{taskID}
|
|
893
|
+
deleteTask({ taskID }, requestOptions) {
|
|
894
|
+
(0, import_client_common.validateRequired)("taskID", "deleteTask", taskID);
|
|
895
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
610
896
|
const headers = {};
|
|
611
897
|
const queryParameters = {};
|
|
612
898
|
const request = {
|
|
613
|
-
method: "
|
|
899
|
+
method: "DELETE",
|
|
614
900
|
path: requestPath,
|
|
615
901
|
queryParameters,
|
|
616
902
|
headers
|
|
@@ -618,49 +904,52 @@ function createIngestionClient({
|
|
|
618
904
|
return transporter.request(request, requestOptions);
|
|
619
905
|
},
|
|
620
906
|
/**
|
|
621
|
-
*
|
|
907
|
+
* Deletes a task by its ID.
|
|
908
|
+
*
|
|
909
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
622
910
|
*
|
|
623
911
|
* Required API Key ACLs:
|
|
624
912
|
* - addObject
|
|
625
913
|
* - deleteIndex
|
|
626
914
|
* - editSettings
|
|
627
|
-
*
|
|
628
|
-
* @
|
|
629
|
-
* @param disableTaskV1 - The disableTaskV1 object.
|
|
630
|
-
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
915
|
+
* @param deleteTask - The deleteTask object.
|
|
916
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
631
917
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
918
|
+
* @see deleteTask for the plain version.
|
|
632
919
|
*/
|
|
633
|
-
|
|
634
|
-
(0, import_client_common.validateRequired)("taskID", "
|
|
635
|
-
const requestPath = "/
|
|
920
|
+
deleteTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
921
|
+
(0, import_client_common.validateRequired)("taskID", "deleteTaskWithHTTPInfo", taskID);
|
|
922
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
636
923
|
const headers = {};
|
|
637
924
|
const queryParameters = {};
|
|
638
925
|
const request = {
|
|
639
|
-
method: "
|
|
926
|
+
method: "DELETE",
|
|
640
927
|
path: requestPath,
|
|
641
928
|
queryParameters,
|
|
642
929
|
headers
|
|
643
930
|
};
|
|
644
|
-
return transporter.
|
|
931
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
645
932
|
},
|
|
646
933
|
/**
|
|
647
|
-
*
|
|
934
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
648
935
|
*
|
|
649
936
|
* Required API Key ACLs:
|
|
650
937
|
* - addObject
|
|
651
938
|
* - deleteIndex
|
|
652
939
|
* - editSettings
|
|
653
|
-
*
|
|
654
|
-
* @
|
|
940
|
+
*
|
|
941
|
+
* @deprecated
|
|
942
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
943
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
655
944
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
656
945
|
*/
|
|
657
|
-
|
|
658
|
-
(0, import_client_common.validateRequired)("taskID", "
|
|
659
|
-
const requestPath = "/
|
|
946
|
+
deleteTaskV1({ taskID }, requestOptions) {
|
|
947
|
+
(0, import_client_common.validateRequired)("taskID", "deleteTaskV1", taskID);
|
|
948
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
660
949
|
const headers = {};
|
|
661
950
|
const queryParameters = {};
|
|
662
951
|
const request = {
|
|
663
|
-
method: "
|
|
952
|
+
method: "DELETE",
|
|
664
953
|
path: requestPath,
|
|
665
954
|
queryParameters,
|
|
666
955
|
headers
|
|
@@ -668,7 +957,9 @@ function createIngestionClient({
|
|
|
668
957
|
return transporter.request(request, requestOptions);
|
|
669
958
|
},
|
|
670
959
|
/**
|
|
671
|
-
*
|
|
960
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
961
|
+
*
|
|
962
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
672
963
|
*
|
|
673
964
|
* Required API Key ACLs:
|
|
674
965
|
* - addObject
|
|
@@ -676,44 +967,45 @@ function createIngestionClient({
|
|
|
676
967
|
* - editSettings
|
|
677
968
|
*
|
|
678
969
|
* @deprecated
|
|
679
|
-
* @param
|
|
680
|
-
* @param
|
|
970
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
971
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
681
972
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
973
|
+
* @see deleteTaskV1 for the plain version.
|
|
682
974
|
*/
|
|
683
|
-
|
|
684
|
-
(0, import_client_common.validateRequired)("taskID", "
|
|
685
|
-
const requestPath = "/1/tasks/{taskID}
|
|
975
|
+
deleteTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
976
|
+
(0, import_client_common.validateRequired)("taskID", "deleteTaskV1WithHTTPInfo", taskID);
|
|
977
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
686
978
|
const headers = {};
|
|
687
979
|
const queryParameters = {};
|
|
688
980
|
const request = {
|
|
689
|
-
method: "
|
|
981
|
+
method: "DELETE",
|
|
690
982
|
path: requestPath,
|
|
691
983
|
queryParameters,
|
|
692
984
|
headers
|
|
693
985
|
};
|
|
694
|
-
return transporter.
|
|
986
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
695
987
|
},
|
|
696
988
|
/**
|
|
697
|
-
*
|
|
989
|
+
* Deletes a transformation by its ID.
|
|
698
990
|
*
|
|
699
991
|
* Required API Key ACLs:
|
|
700
992
|
* - addObject
|
|
701
993
|
* - deleteIndex
|
|
702
994
|
* - editSettings
|
|
703
|
-
* @param
|
|
704
|
-
* @param
|
|
995
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
996
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
705
997
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
706
998
|
*/
|
|
707
|
-
|
|
708
|
-
(0, import_client_common.validateRequired)("
|
|
709
|
-
const requestPath = "/1/
|
|
710
|
-
"{
|
|
711
|
-
encodeURIComponent(
|
|
999
|
+
deleteTransformation({ transformationID }, requestOptions) {
|
|
1000
|
+
(0, import_client_common.validateRequired)("transformationID", "deleteTransformation", transformationID);
|
|
1001
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1002
|
+
"{transformationID}",
|
|
1003
|
+
encodeURIComponent(transformationID)
|
|
712
1004
|
);
|
|
713
1005
|
const headers = {};
|
|
714
1006
|
const queryParameters = {};
|
|
715
1007
|
const request = {
|
|
716
|
-
method: "
|
|
1008
|
+
method: "DELETE",
|
|
717
1009
|
path: requestPath,
|
|
718
1010
|
queryParameters,
|
|
719
1011
|
headers
|
|
@@ -721,52 +1013,53 @@ function createIngestionClient({
|
|
|
721
1013
|
return transporter.request(request, requestOptions);
|
|
722
1014
|
},
|
|
723
1015
|
/**
|
|
724
|
-
*
|
|
1016
|
+
* Deletes a transformation by its ID.
|
|
1017
|
+
*
|
|
1018
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
725
1019
|
*
|
|
726
1020
|
* Required API Key ACLs:
|
|
727
1021
|
* - addObject
|
|
728
1022
|
* - deleteIndex
|
|
729
1023
|
* - editSettings
|
|
730
|
-
* @param
|
|
731
|
-
* @param
|
|
1024
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
1025
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
732
1026
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1027
|
+
* @see deleteTransformation for the plain version.
|
|
733
1028
|
*/
|
|
734
|
-
|
|
735
|
-
(0, import_client_common.validateRequired)("
|
|
736
|
-
const requestPath = "/1/
|
|
737
|
-
"{
|
|
738
|
-
encodeURIComponent(
|
|
1029
|
+
deleteTransformationWithHTTPInfo({ transformationID }, requestOptions) {
|
|
1030
|
+
(0, import_client_common.validateRequired)("transformationID", "deleteTransformationWithHTTPInfo", transformationID);
|
|
1031
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1032
|
+
"{transformationID}",
|
|
1033
|
+
encodeURIComponent(transformationID)
|
|
739
1034
|
);
|
|
740
1035
|
const headers = {};
|
|
741
1036
|
const queryParameters = {};
|
|
742
1037
|
const request = {
|
|
743
|
-
method: "
|
|
1038
|
+
method: "DELETE",
|
|
744
1039
|
path: requestPath,
|
|
745
1040
|
queryParameters,
|
|
746
1041
|
headers
|
|
747
1042
|
};
|
|
748
|
-
return transporter.
|
|
1043
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
749
1044
|
},
|
|
750
1045
|
/**
|
|
751
|
-
*
|
|
1046
|
+
* Disables a task.
|
|
752
1047
|
*
|
|
753
1048
|
* Required API Key ACLs:
|
|
754
1049
|
* - addObject
|
|
755
1050
|
* - deleteIndex
|
|
756
1051
|
* - editSettings
|
|
757
|
-
* @param
|
|
758
|
-
* @param
|
|
759
|
-
* @param getEvent.eventID - Unique identifier of an event.
|
|
1052
|
+
* @param disableTask - The disableTask object.
|
|
1053
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
760
1054
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
761
1055
|
*/
|
|
762
|
-
|
|
763
|
-
(0, import_client_common.validateRequired)("
|
|
764
|
-
|
|
765
|
-
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1056
|
+
disableTask({ taskID }, requestOptions) {
|
|
1057
|
+
(0, import_client_common.validateRequired)("taskID", "disableTask", taskID);
|
|
1058
|
+
const requestPath = "/2/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
766
1059
|
const headers = {};
|
|
767
1060
|
const queryParameters = {};
|
|
768
1061
|
const request = {
|
|
769
|
-
method: "
|
|
1062
|
+
method: "PUT",
|
|
770
1063
|
path: requestPath,
|
|
771
1064
|
queryParameters,
|
|
772
1065
|
headers
|
|
@@ -774,47 +1067,52 @@ function createIngestionClient({
|
|
|
774
1067
|
return transporter.request(request, requestOptions);
|
|
775
1068
|
},
|
|
776
1069
|
/**
|
|
777
|
-
*
|
|
1070
|
+
* Disables a task.
|
|
1071
|
+
*
|
|
1072
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
778
1073
|
*
|
|
779
1074
|
* Required API Key ACLs:
|
|
780
1075
|
* - addObject
|
|
781
1076
|
* - deleteIndex
|
|
782
1077
|
* - editSettings
|
|
783
|
-
* @param
|
|
784
|
-
* @param
|
|
1078
|
+
* @param disableTask - The disableTask object.
|
|
1079
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
785
1080
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1081
|
+
* @see disableTask for the plain version.
|
|
786
1082
|
*/
|
|
787
|
-
|
|
788
|
-
(0, import_client_common.validateRequired)("
|
|
789
|
-
const requestPath = "/
|
|
1083
|
+
disableTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1084
|
+
(0, import_client_common.validateRequired)("taskID", "disableTaskWithHTTPInfo", taskID);
|
|
1085
|
+
const requestPath = "/2/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
790
1086
|
const headers = {};
|
|
791
1087
|
const queryParameters = {};
|
|
792
1088
|
const request = {
|
|
793
|
-
method: "
|
|
1089
|
+
method: "PUT",
|
|
794
1090
|
path: requestPath,
|
|
795
1091
|
queryParameters,
|
|
796
1092
|
headers
|
|
797
1093
|
};
|
|
798
|
-
return transporter.
|
|
1094
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
799
1095
|
},
|
|
800
1096
|
/**
|
|
801
|
-
*
|
|
1097
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
802
1098
|
*
|
|
803
1099
|
* Required API Key ACLs:
|
|
804
1100
|
* - addObject
|
|
805
1101
|
* - deleteIndex
|
|
806
1102
|
* - editSettings
|
|
807
|
-
*
|
|
808
|
-
* @
|
|
1103
|
+
*
|
|
1104
|
+
* @deprecated
|
|
1105
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
1106
|
+
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
809
1107
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
810
1108
|
*/
|
|
811
|
-
|
|
812
|
-
(0, import_client_common.validateRequired)("
|
|
813
|
-
const requestPath = "/1/
|
|
1109
|
+
disableTaskV1({ taskID }, requestOptions) {
|
|
1110
|
+
(0, import_client_common.validateRequired)("taskID", "disableTaskV1", taskID);
|
|
1111
|
+
const requestPath = "/1/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
814
1112
|
const headers = {};
|
|
815
1113
|
const queryParameters = {};
|
|
816
1114
|
const request = {
|
|
817
|
-
method: "
|
|
1115
|
+
method: "PUT",
|
|
818
1116
|
path: requestPath,
|
|
819
1117
|
queryParameters,
|
|
820
1118
|
headers
|
|
@@ -822,49 +1120,52 @@ function createIngestionClient({
|
|
|
822
1120
|
return transporter.request(request, requestOptions);
|
|
823
1121
|
},
|
|
824
1122
|
/**
|
|
825
|
-
*
|
|
1123
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
1124
|
+
*
|
|
1125
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
826
1126
|
*
|
|
827
1127
|
* Required API Key ACLs:
|
|
828
1128
|
* - addObject
|
|
829
1129
|
* - deleteIndex
|
|
830
1130
|
* - editSettings
|
|
831
|
-
*
|
|
832
|
-
* @
|
|
1131
|
+
*
|
|
1132
|
+
* @deprecated
|
|
1133
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
1134
|
+
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
833
1135
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1136
|
+
* @see disableTaskV1 for the plain version.
|
|
834
1137
|
*/
|
|
835
|
-
|
|
836
|
-
(0, import_client_common.validateRequired)("taskID", "
|
|
837
|
-
const requestPath = "/
|
|
1138
|
+
disableTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1139
|
+
(0, import_client_common.validateRequired)("taskID", "disableTaskV1WithHTTPInfo", taskID);
|
|
1140
|
+
const requestPath = "/1/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
838
1141
|
const headers = {};
|
|
839
1142
|
const queryParameters = {};
|
|
840
1143
|
const request = {
|
|
841
|
-
method: "
|
|
1144
|
+
method: "PUT",
|
|
842
1145
|
path: requestPath,
|
|
843
1146
|
queryParameters,
|
|
844
1147
|
headers
|
|
845
1148
|
};
|
|
846
|
-
return transporter.
|
|
1149
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
847
1150
|
},
|
|
848
1151
|
/**
|
|
849
|
-
*
|
|
1152
|
+
* Enables a task.
|
|
850
1153
|
*
|
|
851
1154
|
* Required API Key ACLs:
|
|
852
1155
|
* - addObject
|
|
853
1156
|
* - deleteIndex
|
|
854
1157
|
* - editSettings
|
|
855
|
-
*
|
|
856
|
-
* @
|
|
857
|
-
* @param getTaskV1 - The getTaskV1 object.
|
|
858
|
-
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1158
|
+
* @param enableTask - The enableTask object.
|
|
1159
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
859
1160
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
860
1161
|
*/
|
|
861
|
-
|
|
862
|
-
(0, import_client_common.validateRequired)("taskID", "
|
|
863
|
-
const requestPath = "/
|
|
1162
|
+
enableTask({ taskID }, requestOptions) {
|
|
1163
|
+
(0, import_client_common.validateRequired)("taskID", "enableTask", taskID);
|
|
1164
|
+
const requestPath = "/2/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
864
1165
|
const headers = {};
|
|
865
1166
|
const queryParameters = {};
|
|
866
1167
|
const request = {
|
|
867
|
-
method: "
|
|
1168
|
+
method: "PUT",
|
|
868
1169
|
path: requestPath,
|
|
869
1170
|
queryParameters,
|
|
870
1171
|
headers
|
|
@@ -872,72 +1173,660 @@ function createIngestionClient({
|
|
|
872
1173
|
return transporter.request(request, requestOptions);
|
|
873
1174
|
},
|
|
874
1175
|
/**
|
|
875
|
-
*
|
|
1176
|
+
* Enables a task.
|
|
1177
|
+
*
|
|
1178
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
876
1179
|
*
|
|
877
1180
|
* Required API Key ACLs:
|
|
878
1181
|
* - addObject
|
|
879
1182
|
* - deleteIndex
|
|
880
1183
|
* - editSettings
|
|
881
|
-
* @param
|
|
882
|
-
* @param
|
|
1184
|
+
* @param enableTask - The enableTask object.
|
|
1185
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
883
1186
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1187
|
+
* @see enableTask for the plain version.
|
|
884
1188
|
*/
|
|
885
|
-
|
|
886
|
-
(0, import_client_common.validateRequired)("
|
|
887
|
-
const requestPath = "/
|
|
888
|
-
"{transformationID}",
|
|
889
|
-
encodeURIComponent(transformationID)
|
|
890
|
-
);
|
|
1189
|
+
enableTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1190
|
+
(0, import_client_common.validateRequired)("taskID", "enableTaskWithHTTPInfo", taskID);
|
|
1191
|
+
const requestPath = "/2/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
891
1192
|
const headers = {};
|
|
892
1193
|
const queryParameters = {};
|
|
893
1194
|
const request = {
|
|
894
|
-
method: "
|
|
1195
|
+
method: "PUT",
|
|
895
1196
|
path: requestPath,
|
|
896
1197
|
queryParameters,
|
|
897
1198
|
headers
|
|
898
1199
|
};
|
|
899
|
-
return transporter.
|
|
1200
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
900
1201
|
},
|
|
901
1202
|
/**
|
|
902
|
-
*
|
|
1203
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
903
1204
|
*
|
|
904
1205
|
* Required API Key ACLs:
|
|
905
1206
|
* - addObject
|
|
906
1207
|
* - deleteIndex
|
|
907
1208
|
* - editSettings
|
|
908
|
-
*
|
|
909
|
-
* @
|
|
910
|
-
* @param
|
|
911
|
-
* @param
|
|
912
|
-
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
913
|
-
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
914
|
-
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1209
|
+
*
|
|
1210
|
+
* @deprecated
|
|
1211
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
1212
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
915
1213
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
916
1214
|
*/
|
|
917
|
-
|
|
918
|
-
|
|
1215
|
+
enableTaskV1({ taskID }, requestOptions) {
|
|
1216
|
+
(0, import_client_common.validateRequired)("taskID", "enableTaskV1", taskID);
|
|
1217
|
+
const requestPath = "/1/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
919
1218
|
const headers = {};
|
|
920
1219
|
const queryParameters = {};
|
|
921
|
-
if (itemsPerPage !== void 0) {
|
|
922
|
-
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
923
|
-
}
|
|
924
|
-
if (page !== void 0) {
|
|
925
|
-
queryParameters["page"] = page.toString();
|
|
926
|
-
}
|
|
927
|
-
if (type !== void 0) {
|
|
928
|
-
queryParameters["type"] = type.toString();
|
|
929
|
-
}
|
|
930
|
-
if (platform !== void 0) {
|
|
931
|
-
queryParameters["platform"] = platform.toString();
|
|
932
|
-
}
|
|
933
|
-
if (sort !== void 0) {
|
|
934
|
-
queryParameters["sort"] = sort.toString();
|
|
935
|
-
}
|
|
936
|
-
if (order !== void 0) {
|
|
937
|
-
queryParameters["order"] = order.toString();
|
|
938
|
-
}
|
|
939
1220
|
const request = {
|
|
940
|
-
method: "
|
|
1221
|
+
method: "PUT",
|
|
1222
|
+
path: requestPath,
|
|
1223
|
+
queryParameters,
|
|
1224
|
+
headers
|
|
1225
|
+
};
|
|
1226
|
+
return transporter.request(request, requestOptions);
|
|
1227
|
+
},
|
|
1228
|
+
/**
|
|
1229
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
1230
|
+
*
|
|
1231
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1232
|
+
*
|
|
1233
|
+
* Required API Key ACLs:
|
|
1234
|
+
* - addObject
|
|
1235
|
+
* - deleteIndex
|
|
1236
|
+
* - editSettings
|
|
1237
|
+
*
|
|
1238
|
+
* @deprecated
|
|
1239
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
1240
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
1241
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1242
|
+
* @see enableTaskV1 for the plain version.
|
|
1243
|
+
*/
|
|
1244
|
+
enableTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1245
|
+
(0, import_client_common.validateRequired)("taskID", "enableTaskV1WithHTTPInfo", taskID);
|
|
1246
|
+
const requestPath = "/1/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
1247
|
+
const headers = {};
|
|
1248
|
+
const queryParameters = {};
|
|
1249
|
+
const request = {
|
|
1250
|
+
method: "PUT",
|
|
1251
|
+
path: requestPath,
|
|
1252
|
+
queryParameters,
|
|
1253
|
+
headers
|
|
1254
|
+
};
|
|
1255
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1256
|
+
},
|
|
1257
|
+
/**
|
|
1258
|
+
* Retrieves an authentication resource by its ID.
|
|
1259
|
+
*
|
|
1260
|
+
* Required API Key ACLs:
|
|
1261
|
+
* - addObject
|
|
1262
|
+
* - deleteIndex
|
|
1263
|
+
* - editSettings
|
|
1264
|
+
* @param getAuthentication - The getAuthentication object.
|
|
1265
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1266
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1267
|
+
*/
|
|
1268
|
+
getAuthentication({ authenticationID }, requestOptions) {
|
|
1269
|
+
(0, import_client_common.validateRequired)("authenticationID", "getAuthentication", authenticationID);
|
|
1270
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
1271
|
+
"{authenticationID}",
|
|
1272
|
+
encodeURIComponent(authenticationID)
|
|
1273
|
+
);
|
|
1274
|
+
const headers = {};
|
|
1275
|
+
const queryParameters = {};
|
|
1276
|
+
const request = {
|
|
1277
|
+
method: "GET",
|
|
1278
|
+
path: requestPath,
|
|
1279
|
+
queryParameters,
|
|
1280
|
+
headers
|
|
1281
|
+
};
|
|
1282
|
+
return transporter.request(request, requestOptions);
|
|
1283
|
+
},
|
|
1284
|
+
/**
|
|
1285
|
+
* Retrieves an authentication resource by its ID.
|
|
1286
|
+
*
|
|
1287
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1288
|
+
*
|
|
1289
|
+
* Required API Key ACLs:
|
|
1290
|
+
* - addObject
|
|
1291
|
+
* - deleteIndex
|
|
1292
|
+
* - editSettings
|
|
1293
|
+
* @param getAuthentication - The getAuthentication object.
|
|
1294
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1295
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1296
|
+
* @see getAuthentication for the plain version.
|
|
1297
|
+
*/
|
|
1298
|
+
getAuthenticationWithHTTPInfo({ authenticationID }, requestOptions) {
|
|
1299
|
+
(0, import_client_common.validateRequired)("authenticationID", "getAuthenticationWithHTTPInfo", authenticationID);
|
|
1300
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
1301
|
+
"{authenticationID}",
|
|
1302
|
+
encodeURIComponent(authenticationID)
|
|
1303
|
+
);
|
|
1304
|
+
const headers = {};
|
|
1305
|
+
const queryParameters = {};
|
|
1306
|
+
const request = {
|
|
1307
|
+
method: "GET",
|
|
1308
|
+
path: requestPath,
|
|
1309
|
+
queryParameters,
|
|
1310
|
+
headers
|
|
1311
|
+
};
|
|
1312
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1313
|
+
},
|
|
1314
|
+
/**
|
|
1315
|
+
* Retrieves a destination by its ID.
|
|
1316
|
+
*
|
|
1317
|
+
* Required API Key ACLs:
|
|
1318
|
+
* - addObject
|
|
1319
|
+
* - deleteIndex
|
|
1320
|
+
* - editSettings
|
|
1321
|
+
* @param getDestination - The getDestination object.
|
|
1322
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
1323
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1324
|
+
*/
|
|
1325
|
+
getDestination({ destinationID }, requestOptions) {
|
|
1326
|
+
(0, import_client_common.validateRequired)("destinationID", "getDestination", destinationID);
|
|
1327
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
1328
|
+
"{destinationID}",
|
|
1329
|
+
encodeURIComponent(destinationID)
|
|
1330
|
+
);
|
|
1331
|
+
const headers = {};
|
|
1332
|
+
const queryParameters = {};
|
|
1333
|
+
const request = {
|
|
1334
|
+
method: "GET",
|
|
1335
|
+
path: requestPath,
|
|
1336
|
+
queryParameters,
|
|
1337
|
+
headers
|
|
1338
|
+
};
|
|
1339
|
+
return transporter.request(request, requestOptions);
|
|
1340
|
+
},
|
|
1341
|
+
/**
|
|
1342
|
+
* Retrieves a destination by its ID.
|
|
1343
|
+
*
|
|
1344
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1345
|
+
*
|
|
1346
|
+
* Required API Key ACLs:
|
|
1347
|
+
* - addObject
|
|
1348
|
+
* - deleteIndex
|
|
1349
|
+
* - editSettings
|
|
1350
|
+
* @param getDestination - The getDestination object.
|
|
1351
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
1352
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1353
|
+
* @see getDestination for the plain version.
|
|
1354
|
+
*/
|
|
1355
|
+
getDestinationWithHTTPInfo({ destinationID }, requestOptions) {
|
|
1356
|
+
(0, import_client_common.validateRequired)("destinationID", "getDestinationWithHTTPInfo", destinationID);
|
|
1357
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
1358
|
+
"{destinationID}",
|
|
1359
|
+
encodeURIComponent(destinationID)
|
|
1360
|
+
);
|
|
1361
|
+
const headers = {};
|
|
1362
|
+
const queryParameters = {};
|
|
1363
|
+
const request = {
|
|
1364
|
+
method: "GET",
|
|
1365
|
+
path: requestPath,
|
|
1366
|
+
queryParameters,
|
|
1367
|
+
headers
|
|
1368
|
+
};
|
|
1369
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1370
|
+
},
|
|
1371
|
+
/**
|
|
1372
|
+
* Retrieves a single task run event by its ID.
|
|
1373
|
+
*
|
|
1374
|
+
* Required API Key ACLs:
|
|
1375
|
+
* - addObject
|
|
1376
|
+
* - deleteIndex
|
|
1377
|
+
* - editSettings
|
|
1378
|
+
* @param getEvent - The getEvent object.
|
|
1379
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
1380
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
1381
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1382
|
+
*/
|
|
1383
|
+
getEvent({ runID, eventID }, requestOptions) {
|
|
1384
|
+
(0, import_client_common.validateRequired)("runID", "getEvent", runID);
|
|
1385
|
+
(0, import_client_common.validateRequired)("eventID", "getEvent", eventID);
|
|
1386
|
+
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1387
|
+
const headers = {};
|
|
1388
|
+
const queryParameters = {};
|
|
1389
|
+
const request = {
|
|
1390
|
+
method: "GET",
|
|
1391
|
+
path: requestPath,
|
|
1392
|
+
queryParameters,
|
|
1393
|
+
headers
|
|
1394
|
+
};
|
|
1395
|
+
return transporter.request(request, requestOptions);
|
|
1396
|
+
},
|
|
1397
|
+
/**
|
|
1398
|
+
* Retrieves a single task run event by its ID.
|
|
1399
|
+
*
|
|
1400
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1401
|
+
*
|
|
1402
|
+
* Required API Key ACLs:
|
|
1403
|
+
* - addObject
|
|
1404
|
+
* - deleteIndex
|
|
1405
|
+
* - editSettings
|
|
1406
|
+
* @param getEvent - The getEvent object.
|
|
1407
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
1408
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
1409
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1410
|
+
* @see getEvent for the plain version.
|
|
1411
|
+
*/
|
|
1412
|
+
getEventWithHTTPInfo({ runID, eventID }, requestOptions) {
|
|
1413
|
+
(0, import_client_common.validateRequired)("runID", "getEventWithHTTPInfo", runID);
|
|
1414
|
+
(0, import_client_common.validateRequired)("eventID", "getEventWithHTTPInfo", eventID);
|
|
1415
|
+
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1416
|
+
const headers = {};
|
|
1417
|
+
const queryParameters = {};
|
|
1418
|
+
const request = {
|
|
1419
|
+
method: "GET",
|
|
1420
|
+
path: requestPath,
|
|
1421
|
+
queryParameters,
|
|
1422
|
+
headers
|
|
1423
|
+
};
|
|
1424
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1425
|
+
},
|
|
1426
|
+
/**
|
|
1427
|
+
* Retrieve a single task run by its ID.
|
|
1428
|
+
*
|
|
1429
|
+
* Required API Key ACLs:
|
|
1430
|
+
* - addObject
|
|
1431
|
+
* - deleteIndex
|
|
1432
|
+
* - editSettings
|
|
1433
|
+
* @param getRun - The getRun object.
|
|
1434
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
1435
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1436
|
+
*/
|
|
1437
|
+
getRun({ runID }, requestOptions) {
|
|
1438
|
+
(0, import_client_common.validateRequired)("runID", "getRun", runID);
|
|
1439
|
+
const requestPath = "/1/runs/{runID}".replace("{runID}", encodeURIComponent(runID));
|
|
1440
|
+
const headers = {};
|
|
1441
|
+
const queryParameters = {};
|
|
1442
|
+
const request = {
|
|
1443
|
+
method: "GET",
|
|
1444
|
+
path: requestPath,
|
|
1445
|
+
queryParameters,
|
|
1446
|
+
headers
|
|
1447
|
+
};
|
|
1448
|
+
return transporter.request(request, requestOptions);
|
|
1449
|
+
},
|
|
1450
|
+
/**
|
|
1451
|
+
* Retrieve a single task run by its ID.
|
|
1452
|
+
*
|
|
1453
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1454
|
+
*
|
|
1455
|
+
* Required API Key ACLs:
|
|
1456
|
+
* - addObject
|
|
1457
|
+
* - deleteIndex
|
|
1458
|
+
* - editSettings
|
|
1459
|
+
* @param getRun - The getRun object.
|
|
1460
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
1461
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1462
|
+
* @see getRun for the plain version.
|
|
1463
|
+
*/
|
|
1464
|
+
getRunWithHTTPInfo({ runID }, requestOptions) {
|
|
1465
|
+
(0, import_client_common.validateRequired)("runID", "getRunWithHTTPInfo", runID);
|
|
1466
|
+
const requestPath = "/1/runs/{runID}".replace("{runID}", encodeURIComponent(runID));
|
|
1467
|
+
const headers = {};
|
|
1468
|
+
const queryParameters = {};
|
|
1469
|
+
const request = {
|
|
1470
|
+
method: "GET",
|
|
1471
|
+
path: requestPath,
|
|
1472
|
+
queryParameters,
|
|
1473
|
+
headers
|
|
1474
|
+
};
|
|
1475
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1476
|
+
},
|
|
1477
|
+
/**
|
|
1478
|
+
* Retrieve a source by its ID.
|
|
1479
|
+
*
|
|
1480
|
+
* Required API Key ACLs:
|
|
1481
|
+
* - addObject
|
|
1482
|
+
* - deleteIndex
|
|
1483
|
+
* - editSettings
|
|
1484
|
+
* @param getSource - The getSource object.
|
|
1485
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
1486
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1487
|
+
*/
|
|
1488
|
+
getSource({ sourceID }, requestOptions) {
|
|
1489
|
+
(0, import_client_common.validateRequired)("sourceID", "getSource", sourceID);
|
|
1490
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1491
|
+
const headers = {};
|
|
1492
|
+
const queryParameters = {};
|
|
1493
|
+
const request = {
|
|
1494
|
+
method: "GET",
|
|
1495
|
+
path: requestPath,
|
|
1496
|
+
queryParameters,
|
|
1497
|
+
headers
|
|
1498
|
+
};
|
|
1499
|
+
return transporter.request(request, requestOptions);
|
|
1500
|
+
},
|
|
1501
|
+
/**
|
|
1502
|
+
* Retrieve a source by its ID.
|
|
1503
|
+
*
|
|
1504
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1505
|
+
*
|
|
1506
|
+
* Required API Key ACLs:
|
|
1507
|
+
* - addObject
|
|
1508
|
+
* - deleteIndex
|
|
1509
|
+
* - editSettings
|
|
1510
|
+
* @param getSource - The getSource object.
|
|
1511
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
1512
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1513
|
+
* @see getSource for the plain version.
|
|
1514
|
+
*/
|
|
1515
|
+
getSourceWithHTTPInfo({ sourceID }, requestOptions) {
|
|
1516
|
+
(0, import_client_common.validateRequired)("sourceID", "getSourceWithHTTPInfo", sourceID);
|
|
1517
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1518
|
+
const headers = {};
|
|
1519
|
+
const queryParameters = {};
|
|
1520
|
+
const request = {
|
|
1521
|
+
method: "GET",
|
|
1522
|
+
path: requestPath,
|
|
1523
|
+
queryParameters,
|
|
1524
|
+
headers
|
|
1525
|
+
};
|
|
1526
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1527
|
+
},
|
|
1528
|
+
/**
|
|
1529
|
+
* Retrieves a task by its ID.
|
|
1530
|
+
*
|
|
1531
|
+
* Required API Key ACLs:
|
|
1532
|
+
* - addObject
|
|
1533
|
+
* - deleteIndex
|
|
1534
|
+
* - editSettings
|
|
1535
|
+
* @param getTask - The getTask object.
|
|
1536
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
1537
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1538
|
+
*/
|
|
1539
|
+
getTask({ taskID }, requestOptions) {
|
|
1540
|
+
(0, import_client_common.validateRequired)("taskID", "getTask", taskID);
|
|
1541
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1542
|
+
const headers = {};
|
|
1543
|
+
const queryParameters = {};
|
|
1544
|
+
const request = {
|
|
1545
|
+
method: "GET",
|
|
1546
|
+
path: requestPath,
|
|
1547
|
+
queryParameters,
|
|
1548
|
+
headers
|
|
1549
|
+
};
|
|
1550
|
+
return transporter.request(request, requestOptions);
|
|
1551
|
+
},
|
|
1552
|
+
/**
|
|
1553
|
+
* Retrieves a task by its ID.
|
|
1554
|
+
*
|
|
1555
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1556
|
+
*
|
|
1557
|
+
* Required API Key ACLs:
|
|
1558
|
+
* - addObject
|
|
1559
|
+
* - deleteIndex
|
|
1560
|
+
* - editSettings
|
|
1561
|
+
* @param getTask - The getTask object.
|
|
1562
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
1563
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1564
|
+
* @see getTask for the plain version.
|
|
1565
|
+
*/
|
|
1566
|
+
getTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1567
|
+
(0, import_client_common.validateRequired)("taskID", "getTaskWithHTTPInfo", taskID);
|
|
1568
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1569
|
+
const headers = {};
|
|
1570
|
+
const queryParameters = {};
|
|
1571
|
+
const request = {
|
|
1572
|
+
method: "GET",
|
|
1573
|
+
path: requestPath,
|
|
1574
|
+
queryParameters,
|
|
1575
|
+
headers
|
|
1576
|
+
};
|
|
1577
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1578
|
+
},
|
|
1579
|
+
/**
|
|
1580
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
1581
|
+
*
|
|
1582
|
+
* Required API Key ACLs:
|
|
1583
|
+
* - addObject
|
|
1584
|
+
* - deleteIndex
|
|
1585
|
+
* - editSettings
|
|
1586
|
+
*
|
|
1587
|
+
* @deprecated
|
|
1588
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
1589
|
+
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1590
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1591
|
+
*/
|
|
1592
|
+
getTaskV1({ taskID }, requestOptions) {
|
|
1593
|
+
(0, import_client_common.validateRequired)("taskID", "getTaskV1", taskID);
|
|
1594
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1595
|
+
const headers = {};
|
|
1596
|
+
const queryParameters = {};
|
|
1597
|
+
const request = {
|
|
1598
|
+
method: "GET",
|
|
1599
|
+
path: requestPath,
|
|
1600
|
+
queryParameters,
|
|
1601
|
+
headers
|
|
1602
|
+
};
|
|
1603
|
+
return transporter.request(request, requestOptions);
|
|
1604
|
+
},
|
|
1605
|
+
/**
|
|
1606
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
1607
|
+
*
|
|
1608
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1609
|
+
*
|
|
1610
|
+
* Required API Key ACLs:
|
|
1611
|
+
* - addObject
|
|
1612
|
+
* - deleteIndex
|
|
1613
|
+
* - editSettings
|
|
1614
|
+
*
|
|
1615
|
+
* @deprecated
|
|
1616
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
1617
|
+
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1618
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1619
|
+
* @see getTaskV1 for the plain version.
|
|
1620
|
+
*/
|
|
1621
|
+
getTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1622
|
+
(0, import_client_common.validateRequired)("taskID", "getTaskV1WithHTTPInfo", taskID);
|
|
1623
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1624
|
+
const headers = {};
|
|
1625
|
+
const queryParameters = {};
|
|
1626
|
+
const request = {
|
|
1627
|
+
method: "GET",
|
|
1628
|
+
path: requestPath,
|
|
1629
|
+
queryParameters,
|
|
1630
|
+
headers
|
|
1631
|
+
};
|
|
1632
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1633
|
+
},
|
|
1634
|
+
/**
|
|
1635
|
+
* Retrieves a transformation by its ID.
|
|
1636
|
+
*
|
|
1637
|
+
* Required API Key ACLs:
|
|
1638
|
+
* - addObject
|
|
1639
|
+
* - deleteIndex
|
|
1640
|
+
* - editSettings
|
|
1641
|
+
* @param getTransformation - The getTransformation object.
|
|
1642
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
1643
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1644
|
+
*/
|
|
1645
|
+
getTransformation({ transformationID }, requestOptions) {
|
|
1646
|
+
(0, import_client_common.validateRequired)("transformationID", "getTransformation", transformationID);
|
|
1647
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1648
|
+
"{transformationID}",
|
|
1649
|
+
encodeURIComponent(transformationID)
|
|
1650
|
+
);
|
|
1651
|
+
const headers = {};
|
|
1652
|
+
const queryParameters = {};
|
|
1653
|
+
const request = {
|
|
1654
|
+
method: "GET",
|
|
1655
|
+
path: requestPath,
|
|
1656
|
+
queryParameters,
|
|
1657
|
+
headers
|
|
1658
|
+
};
|
|
1659
|
+
return transporter.request(request, requestOptions);
|
|
1660
|
+
},
|
|
1661
|
+
/**
|
|
1662
|
+
* Retrieves a transformation by its ID.
|
|
1663
|
+
*
|
|
1664
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1665
|
+
*
|
|
1666
|
+
* Required API Key ACLs:
|
|
1667
|
+
* - addObject
|
|
1668
|
+
* - deleteIndex
|
|
1669
|
+
* - editSettings
|
|
1670
|
+
* @param getTransformation - The getTransformation object.
|
|
1671
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
1672
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1673
|
+
* @see getTransformation for the plain version.
|
|
1674
|
+
*/
|
|
1675
|
+
getTransformationWithHTTPInfo({ transformationID }, requestOptions) {
|
|
1676
|
+
(0, import_client_common.validateRequired)("transformationID", "getTransformationWithHTTPInfo", transformationID);
|
|
1677
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1678
|
+
"{transformationID}",
|
|
1679
|
+
encodeURIComponent(transformationID)
|
|
1680
|
+
);
|
|
1681
|
+
const headers = {};
|
|
1682
|
+
const queryParameters = {};
|
|
1683
|
+
const request = {
|
|
1684
|
+
method: "GET",
|
|
1685
|
+
path: requestPath,
|
|
1686
|
+
queryParameters,
|
|
1687
|
+
headers
|
|
1688
|
+
};
|
|
1689
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1690
|
+
},
|
|
1691
|
+
/**
|
|
1692
|
+
* Retrieves a list of all authentication resources.
|
|
1693
|
+
*
|
|
1694
|
+
* Required API Key ACLs:
|
|
1695
|
+
* - addObject
|
|
1696
|
+
* - deleteIndex
|
|
1697
|
+
* - editSettings
|
|
1698
|
+
* @param listAuthentications - The listAuthentications object.
|
|
1699
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
1700
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
1701
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
1702
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
1703
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
1704
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1705
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1706
|
+
*/
|
|
1707
|
+
listAuthentications({ itemsPerPage, page, type, platform, sort, order } = {}, requestOptions = void 0) {
|
|
1708
|
+
const requestPath = "/1/authentications";
|
|
1709
|
+
const headers = {};
|
|
1710
|
+
const queryParameters = {};
|
|
1711
|
+
if (itemsPerPage !== void 0) {
|
|
1712
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1713
|
+
}
|
|
1714
|
+
if (page !== void 0) {
|
|
1715
|
+
queryParameters["page"] = page.toString();
|
|
1716
|
+
}
|
|
1717
|
+
if (type !== void 0) {
|
|
1718
|
+
queryParameters["type"] = type.toString();
|
|
1719
|
+
}
|
|
1720
|
+
if (platform !== void 0) {
|
|
1721
|
+
queryParameters["platform"] = platform.toString();
|
|
1722
|
+
}
|
|
1723
|
+
if (sort !== void 0) {
|
|
1724
|
+
queryParameters["sort"] = sort.toString();
|
|
1725
|
+
}
|
|
1726
|
+
if (order !== void 0) {
|
|
1727
|
+
queryParameters["order"] = order.toString();
|
|
1728
|
+
}
|
|
1729
|
+
const request = {
|
|
1730
|
+
method: "GET",
|
|
1731
|
+
path: requestPath,
|
|
1732
|
+
queryParameters,
|
|
1733
|
+
headers
|
|
1734
|
+
};
|
|
1735
|
+
return transporter.request(request, requestOptions);
|
|
1736
|
+
},
|
|
1737
|
+
/**
|
|
1738
|
+
* Retrieves a list of all authentication resources.
|
|
1739
|
+
*
|
|
1740
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1741
|
+
*
|
|
1742
|
+
* Required API Key ACLs:
|
|
1743
|
+
* - addObject
|
|
1744
|
+
* - deleteIndex
|
|
1745
|
+
* - editSettings
|
|
1746
|
+
* @param listAuthentications - The listAuthentications object.
|
|
1747
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
1748
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
1749
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
1750
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
1751
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
1752
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1753
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1754
|
+
* @see listAuthentications for the plain version.
|
|
1755
|
+
*/
|
|
1756
|
+
listAuthenticationsWithHTTPInfo({ itemsPerPage, page, type, platform, sort, order } = {}, requestOptions = void 0) {
|
|
1757
|
+
const requestPath = "/1/authentications";
|
|
1758
|
+
const headers = {};
|
|
1759
|
+
const queryParameters = {};
|
|
1760
|
+
if (itemsPerPage !== void 0) {
|
|
1761
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1762
|
+
}
|
|
1763
|
+
if (page !== void 0) {
|
|
1764
|
+
queryParameters["page"] = page.toString();
|
|
1765
|
+
}
|
|
1766
|
+
if (type !== void 0) {
|
|
1767
|
+
queryParameters["type"] = type.toString();
|
|
1768
|
+
}
|
|
1769
|
+
if (platform !== void 0) {
|
|
1770
|
+
queryParameters["platform"] = platform.toString();
|
|
1771
|
+
}
|
|
1772
|
+
if (sort !== void 0) {
|
|
1773
|
+
queryParameters["sort"] = sort.toString();
|
|
1774
|
+
}
|
|
1775
|
+
if (order !== void 0) {
|
|
1776
|
+
queryParameters["order"] = order.toString();
|
|
1777
|
+
}
|
|
1778
|
+
const request = {
|
|
1779
|
+
method: "GET",
|
|
1780
|
+
path: requestPath,
|
|
1781
|
+
queryParameters,
|
|
1782
|
+
headers
|
|
1783
|
+
};
|
|
1784
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1785
|
+
},
|
|
1786
|
+
/**
|
|
1787
|
+
* Retrieves a list of destinations.
|
|
1788
|
+
*
|
|
1789
|
+
* Required API Key ACLs:
|
|
1790
|
+
* - addObject
|
|
1791
|
+
* - deleteIndex
|
|
1792
|
+
* - editSettings
|
|
1793
|
+
* @param listDestinations - The listDestinations object.
|
|
1794
|
+
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
1795
|
+
* @param listDestinations.page - Page number of the paginated API response.
|
|
1796
|
+
* @param listDestinations.type - Destination type.
|
|
1797
|
+
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
1798
|
+
* @param listDestinations.transformationID - Get the list of destinations used by a transformation.
|
|
1799
|
+
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
1800
|
+
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
1801
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1802
|
+
*/
|
|
1803
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
1804
|
+
const requestPath = "/1/destinations";
|
|
1805
|
+
const headers = {};
|
|
1806
|
+
const queryParameters = {};
|
|
1807
|
+
if (itemsPerPage !== void 0) {
|
|
1808
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1809
|
+
}
|
|
1810
|
+
if (page !== void 0) {
|
|
1811
|
+
queryParameters["page"] = page.toString();
|
|
1812
|
+
}
|
|
1813
|
+
if (type !== void 0) {
|
|
1814
|
+
queryParameters["type"] = type.toString();
|
|
1815
|
+
}
|
|
1816
|
+
if (authenticationID !== void 0) {
|
|
1817
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1818
|
+
}
|
|
1819
|
+
if (transformationID !== void 0) {
|
|
1820
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
1821
|
+
}
|
|
1822
|
+
if (sort !== void 0) {
|
|
1823
|
+
queryParameters["sort"] = sort.toString();
|
|
1824
|
+
}
|
|
1825
|
+
if (order !== void 0) {
|
|
1826
|
+
queryParameters["order"] = order.toString();
|
|
1827
|
+
}
|
|
1828
|
+
const request = {
|
|
1829
|
+
method: "GET",
|
|
941
1830
|
path: requestPath,
|
|
942
1831
|
queryParameters,
|
|
943
1832
|
headers
|
|
@@ -947,6 +1836,8 @@ function createIngestionClient({
|
|
|
947
1836
|
/**
|
|
948
1837
|
* Retrieves a list of destinations.
|
|
949
1838
|
*
|
|
1839
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1840
|
+
*
|
|
950
1841
|
* Required API Key ACLs:
|
|
951
1842
|
* - addObject
|
|
952
1843
|
* - deleteIndex
|
|
@@ -960,8 +1851,9 @@ function createIngestionClient({
|
|
|
960
1851
|
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
961
1852
|
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
962
1853
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1854
|
+
* @see listDestinations for the plain version.
|
|
963
1855
|
*/
|
|
964
|
-
|
|
1856
|
+
listDestinationsWithHTTPInfo({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
965
1857
|
const requestPath = "/1/destinations";
|
|
966
1858
|
const headers = {};
|
|
967
1859
|
const queryParameters = {};
|
|
@@ -992,7 +1884,7 @@ function createIngestionClient({
|
|
|
992
1884
|
queryParameters,
|
|
993
1885
|
headers
|
|
994
1886
|
};
|
|
995
|
-
return transporter.
|
|
1887
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
996
1888
|
},
|
|
997
1889
|
/**
|
|
998
1890
|
* Retrieves a list of events for a task run, identified by its ID.
|
|
@@ -1050,6 +1942,65 @@ function createIngestionClient({
|
|
|
1050
1942
|
};
|
|
1051
1943
|
return transporter.request(request, requestOptions);
|
|
1052
1944
|
},
|
|
1945
|
+
/**
|
|
1946
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1947
|
+
*
|
|
1948
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
1949
|
+
*
|
|
1950
|
+
* Required API Key ACLs:
|
|
1951
|
+
* - addObject
|
|
1952
|
+
* - deleteIndex
|
|
1953
|
+
* - editSettings
|
|
1954
|
+
* @param listEvents - The listEvents object.
|
|
1955
|
+
* @param listEvents.runID - Unique identifier of a task run.
|
|
1956
|
+
* @param listEvents.itemsPerPage - Number of items per page.
|
|
1957
|
+
* @param listEvents.page - Page number of the paginated API response.
|
|
1958
|
+
* @param listEvents.status - Event status for filtering the list of task runs.
|
|
1959
|
+
* @param listEvents.type - Event type for filtering the list of task runs.
|
|
1960
|
+
* @param listEvents.sort - Property by which to sort the list of task run events.
|
|
1961
|
+
* @param listEvents.order - Sort order of the response, ascending or descending.
|
|
1962
|
+
* @param listEvents.startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
|
|
1963
|
+
* @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
1964
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1965
|
+
* @see listEvents for the plain version.
|
|
1966
|
+
*/
|
|
1967
|
+
listEventsWithHTTPInfo({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }, requestOptions) {
|
|
1968
|
+
(0, import_client_common.validateRequired)("runID", "listEventsWithHTTPInfo", runID);
|
|
1969
|
+
const requestPath = "/1/runs/{runID}/events".replace("{runID}", encodeURIComponent(runID));
|
|
1970
|
+
const headers = {};
|
|
1971
|
+
const queryParameters = {};
|
|
1972
|
+
if (itemsPerPage !== void 0) {
|
|
1973
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1974
|
+
}
|
|
1975
|
+
if (page !== void 0) {
|
|
1976
|
+
queryParameters["page"] = page.toString();
|
|
1977
|
+
}
|
|
1978
|
+
if (status !== void 0) {
|
|
1979
|
+
queryParameters["status"] = status.toString();
|
|
1980
|
+
}
|
|
1981
|
+
if (type !== void 0) {
|
|
1982
|
+
queryParameters["type"] = type.toString();
|
|
1983
|
+
}
|
|
1984
|
+
if (sort !== void 0) {
|
|
1985
|
+
queryParameters["sort"] = sort.toString();
|
|
1986
|
+
}
|
|
1987
|
+
if (order !== void 0) {
|
|
1988
|
+
queryParameters["order"] = order.toString();
|
|
1989
|
+
}
|
|
1990
|
+
if (startDate !== void 0) {
|
|
1991
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1992
|
+
}
|
|
1993
|
+
if (endDate !== void 0) {
|
|
1994
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1995
|
+
}
|
|
1996
|
+
const request = {
|
|
1997
|
+
method: "GET",
|
|
1998
|
+
path: requestPath,
|
|
1999
|
+
queryParameters,
|
|
2000
|
+
headers
|
|
2001
|
+
};
|
|
2002
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2003
|
+
},
|
|
1053
2004
|
/**
|
|
1054
2005
|
* Retrieve a list of task runs.
|
|
1055
2006
|
*
|
|
@@ -1108,6 +2059,67 @@ function createIngestionClient({
|
|
|
1108
2059
|
};
|
|
1109
2060
|
return transporter.request(request, requestOptions);
|
|
1110
2061
|
},
|
|
2062
|
+
/**
|
|
2063
|
+
* Retrieve a list of task runs.
|
|
2064
|
+
*
|
|
2065
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2066
|
+
*
|
|
2067
|
+
* Required API Key ACLs:
|
|
2068
|
+
* - addObject
|
|
2069
|
+
* - deleteIndex
|
|
2070
|
+
* - editSettings
|
|
2071
|
+
* @param listRuns - The listRuns object.
|
|
2072
|
+
* @param listRuns.itemsPerPage - Number of items per page.
|
|
2073
|
+
* @param listRuns.page - Page number of the paginated API response.
|
|
2074
|
+
* @param listRuns.status - Run status for filtering the list of task runs.
|
|
2075
|
+
* @param listRuns.type - Run type for filtering the list of task runs.
|
|
2076
|
+
* @param listRuns.taskID - Task ID for filtering the list of task runs.
|
|
2077
|
+
* @param listRuns.sort - Property by which to sort the list of task runs.
|
|
2078
|
+
* @param listRuns.order - Sort order of the response, ascending or descending.
|
|
2079
|
+
* @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.
|
|
2080
|
+
* @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
|
|
2081
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2082
|
+
* @see listRuns for the plain version.
|
|
2083
|
+
*/
|
|
2084
|
+
listRunsWithHTTPInfo({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate } = {}, requestOptions = void 0) {
|
|
2085
|
+
const requestPath = "/1/runs";
|
|
2086
|
+
const headers = {};
|
|
2087
|
+
const queryParameters = {};
|
|
2088
|
+
if (itemsPerPage !== void 0) {
|
|
2089
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2090
|
+
}
|
|
2091
|
+
if (page !== void 0) {
|
|
2092
|
+
queryParameters["page"] = page.toString();
|
|
2093
|
+
}
|
|
2094
|
+
if (status !== void 0) {
|
|
2095
|
+
queryParameters["status"] = status.toString();
|
|
2096
|
+
}
|
|
2097
|
+
if (type !== void 0) {
|
|
2098
|
+
queryParameters["type"] = type.toString();
|
|
2099
|
+
}
|
|
2100
|
+
if (taskID !== void 0) {
|
|
2101
|
+
queryParameters["taskID"] = taskID.toString();
|
|
2102
|
+
}
|
|
2103
|
+
if (sort !== void 0) {
|
|
2104
|
+
queryParameters["sort"] = sort.toString();
|
|
2105
|
+
}
|
|
2106
|
+
if (order !== void 0) {
|
|
2107
|
+
queryParameters["order"] = order.toString();
|
|
2108
|
+
}
|
|
2109
|
+
if (startDate !== void 0) {
|
|
2110
|
+
queryParameters["startDate"] = startDate.toString();
|
|
2111
|
+
}
|
|
2112
|
+
if (endDate !== void 0) {
|
|
2113
|
+
queryParameters["endDate"] = endDate.toString();
|
|
2114
|
+
}
|
|
2115
|
+
const request = {
|
|
2116
|
+
method: "GET",
|
|
2117
|
+
path: requestPath,
|
|
2118
|
+
queryParameters,
|
|
2119
|
+
headers
|
|
2120
|
+
};
|
|
2121
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2122
|
+
},
|
|
1111
2123
|
/**
|
|
1112
2124
|
* Retrieves a list of sources.
|
|
1113
2125
|
*
|
|
@@ -1134,11 +2146,138 @@ function createIngestionClient({
|
|
|
1134
2146
|
if (page !== void 0) {
|
|
1135
2147
|
queryParameters["page"] = page.toString();
|
|
1136
2148
|
}
|
|
1137
|
-
if (type !== void 0) {
|
|
1138
|
-
queryParameters["type"] = type.toString();
|
|
2149
|
+
if (type !== void 0) {
|
|
2150
|
+
queryParameters["type"] = type.toString();
|
|
2151
|
+
}
|
|
2152
|
+
if (authenticationID !== void 0) {
|
|
2153
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
2154
|
+
}
|
|
2155
|
+
if (sort !== void 0) {
|
|
2156
|
+
queryParameters["sort"] = sort.toString();
|
|
2157
|
+
}
|
|
2158
|
+
if (order !== void 0) {
|
|
2159
|
+
queryParameters["order"] = order.toString();
|
|
2160
|
+
}
|
|
2161
|
+
const request = {
|
|
2162
|
+
method: "GET",
|
|
2163
|
+
path: requestPath,
|
|
2164
|
+
queryParameters,
|
|
2165
|
+
headers
|
|
2166
|
+
};
|
|
2167
|
+
return transporter.request(request, requestOptions);
|
|
2168
|
+
},
|
|
2169
|
+
/**
|
|
2170
|
+
* Retrieves a list of sources.
|
|
2171
|
+
*
|
|
2172
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2173
|
+
*
|
|
2174
|
+
* Required API Key ACLs:
|
|
2175
|
+
* - addObject
|
|
2176
|
+
* - deleteIndex
|
|
2177
|
+
* - editSettings
|
|
2178
|
+
* @param listSources - The listSources object.
|
|
2179
|
+
* @param listSources.itemsPerPage - Number of items per page.
|
|
2180
|
+
* @param listSources.page - Page number of the paginated API response.
|
|
2181
|
+
* @param listSources.type - Source type. Some sources require authentication.
|
|
2182
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
|
|
2183
|
+
* @param listSources.sort - Property by which to sort the list of sources.
|
|
2184
|
+
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
2185
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2186
|
+
* @see listSources for the plain version.
|
|
2187
|
+
*/
|
|
2188
|
+
listSourcesWithHTTPInfo({ itemsPerPage, page, type, authenticationID, sort, order } = {}, requestOptions = void 0) {
|
|
2189
|
+
const requestPath = "/1/sources";
|
|
2190
|
+
const headers = {};
|
|
2191
|
+
const queryParameters = {};
|
|
2192
|
+
if (itemsPerPage !== void 0) {
|
|
2193
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2194
|
+
}
|
|
2195
|
+
if (page !== void 0) {
|
|
2196
|
+
queryParameters["page"] = page.toString();
|
|
2197
|
+
}
|
|
2198
|
+
if (type !== void 0) {
|
|
2199
|
+
queryParameters["type"] = type.toString();
|
|
2200
|
+
}
|
|
2201
|
+
if (authenticationID !== void 0) {
|
|
2202
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
2203
|
+
}
|
|
2204
|
+
if (sort !== void 0) {
|
|
2205
|
+
queryParameters["sort"] = sort.toString();
|
|
2206
|
+
}
|
|
2207
|
+
if (order !== void 0) {
|
|
2208
|
+
queryParameters["order"] = order.toString();
|
|
2209
|
+
}
|
|
2210
|
+
const request = {
|
|
2211
|
+
method: "GET",
|
|
2212
|
+
path: requestPath,
|
|
2213
|
+
queryParameters,
|
|
2214
|
+
headers
|
|
2215
|
+
};
|
|
2216
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2217
|
+
},
|
|
2218
|
+
/**
|
|
2219
|
+
* Retrieves a list of tasks.
|
|
2220
|
+
*
|
|
2221
|
+
* Required API Key ACLs:
|
|
2222
|
+
* - addObject
|
|
2223
|
+
* - deleteIndex
|
|
2224
|
+
* - editSettings
|
|
2225
|
+
* @param listTasks - The listTasks object.
|
|
2226
|
+
* @param listTasks.itemsPerPage - Number of items per page.
|
|
2227
|
+
* @param listTasks.page - Page number of the paginated API response.
|
|
2228
|
+
* @param listTasks.action - Actions for filtering the list of tasks.
|
|
2229
|
+
* @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2230
|
+
* @param listTasks.sourceID - Source IDs for filtering the list of tasks.
|
|
2231
|
+
* @param listTasks.sourceType - Filters the tasks with the specified source type.
|
|
2232
|
+
* @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
|
|
2233
|
+
* @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2234
|
+
* @param listTasks.withEmailNotifications - If specified, the response only includes tasks with notifications.email.enabled set to this value.
|
|
2235
|
+
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
2236
|
+
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
2237
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2238
|
+
*/
|
|
2239
|
+
listTasks({
|
|
2240
|
+
itemsPerPage,
|
|
2241
|
+
page,
|
|
2242
|
+
action,
|
|
2243
|
+
enabled,
|
|
2244
|
+
sourceID,
|
|
2245
|
+
sourceType,
|
|
2246
|
+
destinationID,
|
|
2247
|
+
triggerType,
|
|
2248
|
+
withEmailNotifications,
|
|
2249
|
+
sort,
|
|
2250
|
+
order
|
|
2251
|
+
} = {}, requestOptions = void 0) {
|
|
2252
|
+
const requestPath = "/2/tasks";
|
|
2253
|
+
const headers = {};
|
|
2254
|
+
const queryParameters = {};
|
|
2255
|
+
if (itemsPerPage !== void 0) {
|
|
2256
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2257
|
+
}
|
|
2258
|
+
if (page !== void 0) {
|
|
2259
|
+
queryParameters["page"] = page.toString();
|
|
2260
|
+
}
|
|
2261
|
+
if (action !== void 0) {
|
|
2262
|
+
queryParameters["action"] = action.toString();
|
|
1139
2263
|
}
|
|
1140
|
-
if (
|
|
1141
|
-
queryParameters["
|
|
2264
|
+
if (enabled !== void 0) {
|
|
2265
|
+
queryParameters["enabled"] = enabled.toString();
|
|
2266
|
+
}
|
|
2267
|
+
if (sourceID !== void 0) {
|
|
2268
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
2269
|
+
}
|
|
2270
|
+
if (sourceType !== void 0) {
|
|
2271
|
+
queryParameters["sourceType"] = sourceType.toString();
|
|
2272
|
+
}
|
|
2273
|
+
if (destinationID !== void 0) {
|
|
2274
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
2275
|
+
}
|
|
2276
|
+
if (triggerType !== void 0) {
|
|
2277
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
2278
|
+
}
|
|
2279
|
+
if (withEmailNotifications !== void 0) {
|
|
2280
|
+
queryParameters["withEmailNotifications"] = withEmailNotifications.toString();
|
|
1142
2281
|
}
|
|
1143
2282
|
if (sort !== void 0) {
|
|
1144
2283
|
queryParameters["sort"] = sort.toString();
|
|
@@ -1157,6 +2296,8 @@ function createIngestionClient({
|
|
|
1157
2296
|
/**
|
|
1158
2297
|
* Retrieves a list of tasks.
|
|
1159
2298
|
*
|
|
2299
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2300
|
+
*
|
|
1160
2301
|
* Required API Key ACLs:
|
|
1161
2302
|
* - addObject
|
|
1162
2303
|
* - deleteIndex
|
|
@@ -1174,8 +2315,9 @@ function createIngestionClient({
|
|
|
1174
2315
|
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
1175
2316
|
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
1176
2317
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2318
|
+
* @see listTasks for the plain version.
|
|
1177
2319
|
*/
|
|
1178
|
-
|
|
2320
|
+
listTasksWithHTTPInfo({
|
|
1179
2321
|
itemsPerPage,
|
|
1180
2322
|
page,
|
|
1181
2323
|
action,
|
|
@@ -1230,7 +2372,7 @@ function createIngestionClient({
|
|
|
1230
2372
|
queryParameters,
|
|
1231
2373
|
headers
|
|
1232
2374
|
};
|
|
1233
|
-
return transporter.
|
|
2375
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1234
2376
|
},
|
|
1235
2377
|
/**
|
|
1236
2378
|
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
@@ -1292,6 +2434,69 @@ function createIngestionClient({
|
|
|
1292
2434
|
};
|
|
1293
2435
|
return transporter.request(request, requestOptions);
|
|
1294
2436
|
},
|
|
2437
|
+
/**
|
|
2438
|
+
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
2439
|
+
*
|
|
2440
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2441
|
+
*
|
|
2442
|
+
* Required API Key ACLs:
|
|
2443
|
+
* - addObject
|
|
2444
|
+
* - deleteIndex
|
|
2445
|
+
* - editSettings
|
|
2446
|
+
*
|
|
2447
|
+
* @deprecated
|
|
2448
|
+
* @param listTasksV1 - The listTasksV1 object.
|
|
2449
|
+
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
2450
|
+
* @param listTasksV1.page - Page number of the paginated API response.
|
|
2451
|
+
* @param listTasksV1.action - Actions for filtering the list of tasks.
|
|
2452
|
+
* @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2453
|
+
* @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
|
|
2454
|
+
* @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
|
|
2455
|
+
* @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2456
|
+
* @param listTasksV1.sort - Property by which to sort the list of tasks.
|
|
2457
|
+
* @param listTasksV1.order - Sort order of the response, ascending or descending.
|
|
2458
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2459
|
+
* @see listTasksV1 for the plain version.
|
|
2460
|
+
*/
|
|
2461
|
+
listTasksV1WithHTTPInfo({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order } = {}, requestOptions = void 0) {
|
|
2462
|
+
const requestPath = "/1/tasks";
|
|
2463
|
+
const headers = {};
|
|
2464
|
+
const queryParameters = {};
|
|
2465
|
+
if (itemsPerPage !== void 0) {
|
|
2466
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2467
|
+
}
|
|
2468
|
+
if (page !== void 0) {
|
|
2469
|
+
queryParameters["page"] = page.toString();
|
|
2470
|
+
}
|
|
2471
|
+
if (action !== void 0) {
|
|
2472
|
+
queryParameters["action"] = action.toString();
|
|
2473
|
+
}
|
|
2474
|
+
if (enabled !== void 0) {
|
|
2475
|
+
queryParameters["enabled"] = enabled.toString();
|
|
2476
|
+
}
|
|
2477
|
+
if (sourceID !== void 0) {
|
|
2478
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
2479
|
+
}
|
|
2480
|
+
if (destinationID !== void 0) {
|
|
2481
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
2482
|
+
}
|
|
2483
|
+
if (triggerType !== void 0) {
|
|
2484
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
2485
|
+
}
|
|
2486
|
+
if (sort !== void 0) {
|
|
2487
|
+
queryParameters["sort"] = sort.toString();
|
|
2488
|
+
}
|
|
2489
|
+
if (order !== void 0) {
|
|
2490
|
+
queryParameters["order"] = order.toString();
|
|
2491
|
+
}
|
|
2492
|
+
const request = {
|
|
2493
|
+
method: "GET",
|
|
2494
|
+
path: requestPath,
|
|
2495
|
+
queryParameters,
|
|
2496
|
+
headers
|
|
2497
|
+
};
|
|
2498
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2499
|
+
},
|
|
1295
2500
|
/**
|
|
1296
2501
|
* Retrieves a list of transformations.
|
|
1297
2502
|
*
|
|
@@ -1334,6 +2539,51 @@ function createIngestionClient({
|
|
|
1334
2539
|
};
|
|
1335
2540
|
return transporter.request(request, requestOptions);
|
|
1336
2541
|
},
|
|
2542
|
+
/**
|
|
2543
|
+
* Retrieves a list of transformations.
|
|
2544
|
+
*
|
|
2545
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2546
|
+
*
|
|
2547
|
+
* Required API Key ACLs:
|
|
2548
|
+
* - addObject
|
|
2549
|
+
* - deleteIndex
|
|
2550
|
+
* - editSettings
|
|
2551
|
+
* @param listTransformations - The listTransformations object.
|
|
2552
|
+
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
2553
|
+
* @param listTransformations.page - Page number of the paginated API response.
|
|
2554
|
+
* @param listTransformations.sort - Property by which to sort the list of transformations.
|
|
2555
|
+
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
2556
|
+
* @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
|
|
2557
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2558
|
+
* @see listTransformations for the plain version.
|
|
2559
|
+
*/
|
|
2560
|
+
listTransformationsWithHTTPInfo({ itemsPerPage, page, sort, order, type } = {}, requestOptions = void 0) {
|
|
2561
|
+
const requestPath = "/1/transformations";
|
|
2562
|
+
const headers = {};
|
|
2563
|
+
const queryParameters = {};
|
|
2564
|
+
if (itemsPerPage !== void 0) {
|
|
2565
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2566
|
+
}
|
|
2567
|
+
if (page !== void 0) {
|
|
2568
|
+
queryParameters["page"] = page.toString();
|
|
2569
|
+
}
|
|
2570
|
+
if (sort !== void 0) {
|
|
2571
|
+
queryParameters["sort"] = sort.toString();
|
|
2572
|
+
}
|
|
2573
|
+
if (order !== void 0) {
|
|
2574
|
+
queryParameters["order"] = order.toString();
|
|
2575
|
+
}
|
|
2576
|
+
if (type !== void 0) {
|
|
2577
|
+
queryParameters["type"] = type.toString();
|
|
2578
|
+
}
|
|
2579
|
+
const request = {
|
|
2580
|
+
method: "GET",
|
|
2581
|
+
path: requestPath,
|
|
2582
|
+
queryParameters,
|
|
2583
|
+
headers
|
|
2584
|
+
};
|
|
2585
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2586
|
+
},
|
|
1337
2587
|
/**
|
|
1338
2588
|
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
|
|
1339
2589
|
*
|
|
@@ -1370,6 +2620,7 @@ function createIngestionClient({
|
|
|
1370
2620
|
data: pushTaskPayload
|
|
1371
2621
|
};
|
|
1372
2622
|
requestOptions = {
|
|
2623
|
+
...requestOptions,
|
|
1373
2624
|
timeouts: {
|
|
1374
2625
|
connect: 18e4,
|
|
1375
2626
|
read: 18e4,
|
|
@@ -1379,6 +2630,55 @@ function createIngestionClient({
|
|
|
1379
2630
|
};
|
|
1380
2631
|
return transporter.request(request, requestOptions);
|
|
1381
2632
|
},
|
|
2633
|
+
/**
|
|
2634
|
+
* Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data), this is the recommended way of ingesting your records. This method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.
|
|
2635
|
+
*
|
|
2636
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2637
|
+
*
|
|
2638
|
+
* Required API Key ACLs:
|
|
2639
|
+
* - addObject
|
|
2640
|
+
* - deleteIndex
|
|
2641
|
+
* - editSettings
|
|
2642
|
+
* @param push - The push object.
|
|
2643
|
+
* @param push.indexName - Name of the index on which to perform the operation.
|
|
2644
|
+
* @param push.pushTaskPayload - The pushTaskPayload object.
|
|
2645
|
+
* @param push.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2646
|
+
* @param push.referenceIndexName - This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index\'s transformation to it (e.g. the source index name).
|
|
2647
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2648
|
+
* @see push for the plain version.
|
|
2649
|
+
*/
|
|
2650
|
+
pushWithHTTPInfo({ indexName, pushTaskPayload, watch, referenceIndexName }, requestOptions) {
|
|
2651
|
+
(0, import_client_common.validateRequired)("indexName", "pushWithHTTPInfo", indexName);
|
|
2652
|
+
(0, import_client_common.validateRequired)("pushTaskPayload", "pushWithHTTPInfo", pushTaskPayload);
|
|
2653
|
+
(0, import_client_common.validateRequired)("pushTaskPayload.action", "pushWithHTTPInfo", pushTaskPayload.action);
|
|
2654
|
+
(0, import_client_common.validateRequired)("pushTaskPayload.records", "pushWithHTTPInfo", pushTaskPayload.records);
|
|
2655
|
+
const requestPath = "/1/push/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
|
|
2656
|
+
const headers = {};
|
|
2657
|
+
const queryParameters = {};
|
|
2658
|
+
if (watch !== void 0) {
|
|
2659
|
+
queryParameters["watch"] = watch.toString();
|
|
2660
|
+
}
|
|
2661
|
+
if (referenceIndexName !== void 0) {
|
|
2662
|
+
queryParameters["referenceIndexName"] = referenceIndexName.toString();
|
|
2663
|
+
}
|
|
2664
|
+
const request = {
|
|
2665
|
+
method: "POST",
|
|
2666
|
+
path: requestPath,
|
|
2667
|
+
queryParameters,
|
|
2668
|
+
headers,
|
|
2669
|
+
data: pushTaskPayload
|
|
2670
|
+
};
|
|
2671
|
+
requestOptions = {
|
|
2672
|
+
...requestOptions,
|
|
2673
|
+
timeouts: {
|
|
2674
|
+
connect: 18e4,
|
|
2675
|
+
read: 18e4,
|
|
2676
|
+
write: 18e4,
|
|
2677
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
2678
|
+
}
|
|
2679
|
+
};
|
|
2680
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2681
|
+
},
|
|
1382
2682
|
/**
|
|
1383
2683
|
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
|
|
1384
2684
|
*
|
|
@@ -1411,6 +2711,7 @@ function createIngestionClient({
|
|
|
1411
2711
|
data: pushTaskPayload
|
|
1412
2712
|
};
|
|
1413
2713
|
requestOptions = {
|
|
2714
|
+
...requestOptions,
|
|
1414
2715
|
timeouts: {
|
|
1415
2716
|
connect: 18e4,
|
|
1416
2717
|
read: 18e4,
|
|
@@ -1420,6 +2721,51 @@ function createIngestionClient({
|
|
|
1420
2721
|
};
|
|
1421
2722
|
return transporter.request(request, requestOptions);
|
|
1422
2723
|
},
|
|
2724
|
+
/**
|
|
2725
|
+
* Pushes records through the pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints or the debugger dashboard to see the status of your task. If you want to transform your data before indexing, this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
|
|
2726
|
+
*
|
|
2727
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2728
|
+
*
|
|
2729
|
+
* Required API Key ACLs:
|
|
2730
|
+
* - addObject
|
|
2731
|
+
* - deleteIndex
|
|
2732
|
+
* - editSettings
|
|
2733
|
+
* @param pushTask - The pushTask object.
|
|
2734
|
+
* @param pushTask.taskID - Unique identifier of a task.
|
|
2735
|
+
* @param pushTask.pushTaskPayload - The pushTaskPayload object.
|
|
2736
|
+
* @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2737
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2738
|
+
* @see pushTask for the plain version.
|
|
2739
|
+
*/
|
|
2740
|
+
pushTaskWithHTTPInfo({ taskID, pushTaskPayload, watch }, requestOptions) {
|
|
2741
|
+
(0, import_client_common.validateRequired)("taskID", "pushTaskWithHTTPInfo", taskID);
|
|
2742
|
+
(0, import_client_common.validateRequired)("pushTaskPayload", "pushTaskWithHTTPInfo", pushTaskPayload);
|
|
2743
|
+
(0, import_client_common.validateRequired)("pushTaskPayload.action", "pushTaskWithHTTPInfo", pushTaskPayload.action);
|
|
2744
|
+
(0, import_client_common.validateRequired)("pushTaskPayload.records", "pushTaskWithHTTPInfo", pushTaskPayload.records);
|
|
2745
|
+
const requestPath = "/2/tasks/{taskID}/push".replace("{taskID}", encodeURIComponent(taskID));
|
|
2746
|
+
const headers = {};
|
|
2747
|
+
const queryParameters = {};
|
|
2748
|
+
if (watch !== void 0) {
|
|
2749
|
+
queryParameters["watch"] = watch.toString();
|
|
2750
|
+
}
|
|
2751
|
+
const request = {
|
|
2752
|
+
method: "POST",
|
|
2753
|
+
path: requestPath,
|
|
2754
|
+
queryParameters,
|
|
2755
|
+
headers,
|
|
2756
|
+
data: pushTaskPayload
|
|
2757
|
+
};
|
|
2758
|
+
requestOptions = {
|
|
2759
|
+
...requestOptions,
|
|
2760
|
+
timeouts: {
|
|
2761
|
+
connect: 18e4,
|
|
2762
|
+
read: 18e4,
|
|
2763
|
+
write: 18e4,
|
|
2764
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
2765
|
+
}
|
|
2766
|
+
};
|
|
2767
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2768
|
+
},
|
|
1423
2769
|
/**
|
|
1424
2770
|
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
|
|
1425
2771
|
*
|
|
@@ -1445,13 +2791,73 @@ function createIngestionClient({
|
|
|
1445
2791
|
path: requestPath,
|
|
1446
2792
|
queryParameters,
|
|
1447
2793
|
headers,
|
|
1448
|
-
data: taskReplace
|
|
2794
|
+
data: taskReplace
|
|
2795
|
+
};
|
|
2796
|
+
return transporter.request(request, requestOptions);
|
|
2797
|
+
},
|
|
2798
|
+
/**
|
|
2799
|
+
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
|
|
2800
|
+
*
|
|
2801
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2802
|
+
*
|
|
2803
|
+
* Required API Key ACLs:
|
|
2804
|
+
* - addObject
|
|
2805
|
+
* - deleteIndex
|
|
2806
|
+
* - editSettings
|
|
2807
|
+
* @param replaceTask - The replaceTask object.
|
|
2808
|
+
* @param replaceTask.taskID - Unique identifier of a task.
|
|
2809
|
+
* @param replaceTask.taskReplace - The taskReplace object.
|
|
2810
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2811
|
+
* @see replaceTask for the plain version.
|
|
2812
|
+
*/
|
|
2813
|
+
replaceTaskWithHTTPInfo({ taskID, taskReplace }, requestOptions) {
|
|
2814
|
+
(0, import_client_common.validateRequired)("taskID", "replaceTaskWithHTTPInfo", taskID);
|
|
2815
|
+
(0, import_client_common.validateRequired)("taskReplace", "replaceTaskWithHTTPInfo", taskReplace);
|
|
2816
|
+
(0, import_client_common.validateRequired)("taskReplace.destinationID", "replaceTaskWithHTTPInfo", taskReplace.destinationID);
|
|
2817
|
+
(0, import_client_common.validateRequired)("taskReplace.action", "replaceTaskWithHTTPInfo", taskReplace.action);
|
|
2818
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
2819
|
+
const headers = {};
|
|
2820
|
+
const queryParameters = {};
|
|
2821
|
+
const request = {
|
|
2822
|
+
method: "PUT",
|
|
2823
|
+
path: requestPath,
|
|
2824
|
+
queryParameters,
|
|
2825
|
+
headers,
|
|
2826
|
+
data: taskReplace
|
|
2827
|
+
};
|
|
2828
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2829
|
+
},
|
|
2830
|
+
/**
|
|
2831
|
+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
|
|
2832
|
+
*
|
|
2833
|
+
* Required API Key ACLs:
|
|
2834
|
+
* - addObject
|
|
2835
|
+
* - deleteIndex
|
|
2836
|
+
* - editSettings
|
|
2837
|
+
* @param runSource - The runSource object.
|
|
2838
|
+
* @param runSource.sourceID - Unique identifier of a source.
|
|
2839
|
+
* @param runSource.runSourcePayload -
|
|
2840
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2841
|
+
*/
|
|
2842
|
+
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
2843
|
+
(0, import_client_common.validateRequired)("sourceID", "runSource", sourceID);
|
|
2844
|
+
const requestPath = "/1/sources/{sourceID}/run".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
2845
|
+
const headers = {};
|
|
2846
|
+
const queryParameters = {};
|
|
2847
|
+
const request = {
|
|
2848
|
+
method: "POST",
|
|
2849
|
+
path: requestPath,
|
|
2850
|
+
queryParameters,
|
|
2851
|
+
headers,
|
|
2852
|
+
data: runSourcePayload ? runSourcePayload : {}
|
|
1449
2853
|
};
|
|
1450
2854
|
return transporter.request(request, requestOptions);
|
|
1451
2855
|
},
|
|
1452
2856
|
/**
|
|
1453
2857
|
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
|
|
1454
2858
|
*
|
|
2859
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2860
|
+
*
|
|
1455
2861
|
* Required API Key ACLs:
|
|
1456
2862
|
* - addObject
|
|
1457
2863
|
* - deleteIndex
|
|
@@ -1460,9 +2866,10 @@ function createIngestionClient({
|
|
|
1460
2866
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1461
2867
|
* @param runSource.runSourcePayload -
|
|
1462
2868
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2869
|
+
* @see runSource for the plain version.
|
|
1463
2870
|
*/
|
|
1464
|
-
|
|
1465
|
-
(0, import_client_common.validateRequired)("sourceID", "
|
|
2871
|
+
runSourceWithHTTPInfo({ sourceID, runSourcePayload }, requestOptions) {
|
|
2872
|
+
(0, import_client_common.validateRequired)("sourceID", "runSourceWithHTTPInfo", sourceID);
|
|
1466
2873
|
const requestPath = "/1/sources/{sourceID}/run".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1467
2874
|
const headers = {};
|
|
1468
2875
|
const queryParameters = {};
|
|
@@ -1473,7 +2880,7 @@ function createIngestionClient({
|
|
|
1473
2880
|
headers,
|
|
1474
2881
|
data: runSourcePayload ? runSourcePayload : {}
|
|
1475
2882
|
};
|
|
1476
|
-
return transporter.
|
|
2883
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1477
2884
|
},
|
|
1478
2885
|
/**
|
|
1479
2886
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
@@ -1501,6 +2908,35 @@ function createIngestionClient({
|
|
|
1501
2908
|
};
|
|
1502
2909
|
return transporter.request(request, requestOptions);
|
|
1503
2910
|
},
|
|
2911
|
+
/**
|
|
2912
|
+
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
2913
|
+
*
|
|
2914
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2915
|
+
*
|
|
2916
|
+
* Required API Key ACLs:
|
|
2917
|
+
* - addObject
|
|
2918
|
+
* - deleteIndex
|
|
2919
|
+
* - editSettings
|
|
2920
|
+
* @param runTask - The runTask object.
|
|
2921
|
+
* @param runTask.taskID - Unique identifier of a task.
|
|
2922
|
+
* @param runTask.runTaskPayload -
|
|
2923
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2924
|
+
* @see runTask for the plain version.
|
|
2925
|
+
*/
|
|
2926
|
+
runTaskWithHTTPInfo({ taskID, runTaskPayload }, requestOptions) {
|
|
2927
|
+
(0, import_client_common.validateRequired)("taskID", "runTaskWithHTTPInfo", taskID);
|
|
2928
|
+
const requestPath = "/2/tasks/{taskID}/run".replace("{taskID}", encodeURIComponent(taskID));
|
|
2929
|
+
const headers = {};
|
|
2930
|
+
const queryParameters = {};
|
|
2931
|
+
const request = {
|
|
2932
|
+
method: "POST",
|
|
2933
|
+
path: requestPath,
|
|
2934
|
+
queryParameters,
|
|
2935
|
+
headers,
|
|
2936
|
+
data: runTaskPayload ? runTaskPayload : {}
|
|
2937
|
+
};
|
|
2938
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2939
|
+
},
|
|
1504
2940
|
/**
|
|
1505
2941
|
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1506
2942
|
*
|
|
@@ -1529,6 +2965,37 @@ function createIngestionClient({
|
|
|
1529
2965
|
};
|
|
1530
2966
|
return transporter.request(request, requestOptions);
|
|
1531
2967
|
},
|
|
2968
|
+
/**
|
|
2969
|
+
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
2970
|
+
*
|
|
2971
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
2972
|
+
*
|
|
2973
|
+
* Required API Key ACLs:
|
|
2974
|
+
* - addObject
|
|
2975
|
+
* - deleteIndex
|
|
2976
|
+
* - editSettings
|
|
2977
|
+
*
|
|
2978
|
+
* @deprecated
|
|
2979
|
+
* @param runTaskV1 - The runTaskV1 object.
|
|
2980
|
+
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
2981
|
+
* @param runTaskV1.runTaskPayload -
|
|
2982
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2983
|
+
* @see runTaskV1 for the plain version.
|
|
2984
|
+
*/
|
|
2985
|
+
runTaskV1WithHTTPInfo({ taskID, runTaskPayload }, requestOptions) {
|
|
2986
|
+
(0, import_client_common.validateRequired)("taskID", "runTaskV1WithHTTPInfo", taskID);
|
|
2987
|
+
const requestPath = "/1/tasks/{taskID}/run".replace("{taskID}", encodeURIComponent(taskID));
|
|
2988
|
+
const headers = {};
|
|
2989
|
+
const queryParameters = {};
|
|
2990
|
+
const request = {
|
|
2991
|
+
method: "POST",
|
|
2992
|
+
path: requestPath,
|
|
2993
|
+
queryParameters,
|
|
2994
|
+
headers,
|
|
2995
|
+
data: runTaskPayload ? runTaskPayload : {}
|
|
2996
|
+
};
|
|
2997
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2998
|
+
},
|
|
1532
2999
|
/**
|
|
1533
3000
|
* Searches for authentication resources.
|
|
1534
3001
|
*
|
|
@@ -1558,6 +3025,38 @@ function createIngestionClient({
|
|
|
1558
3025
|
};
|
|
1559
3026
|
return transporter.request(request, requestOptions);
|
|
1560
3027
|
},
|
|
3028
|
+
/**
|
|
3029
|
+
* Searches for authentication resources.
|
|
3030
|
+
*
|
|
3031
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3032
|
+
*
|
|
3033
|
+
* Required API Key ACLs:
|
|
3034
|
+
* - addObject
|
|
3035
|
+
* - deleteIndex
|
|
3036
|
+
* - editSettings
|
|
3037
|
+
* @param authenticationSearch - The authenticationSearch object.
|
|
3038
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3039
|
+
* @see searchAuthentications for the plain version.
|
|
3040
|
+
*/
|
|
3041
|
+
searchAuthenticationsWithHTTPInfo(authenticationSearch, requestOptions) {
|
|
3042
|
+
(0, import_client_common.validateRequired)("authenticationSearch", "searchAuthenticationsWithHTTPInfo", authenticationSearch);
|
|
3043
|
+
(0, import_client_common.validateRequired)(
|
|
3044
|
+
"authenticationSearch.authenticationIDs",
|
|
3045
|
+
"searchAuthenticationsWithHTTPInfo",
|
|
3046
|
+
authenticationSearch.authenticationIDs
|
|
3047
|
+
);
|
|
3048
|
+
const requestPath = "/1/authentications/search";
|
|
3049
|
+
const headers = {};
|
|
3050
|
+
const queryParameters = {};
|
|
3051
|
+
const request = {
|
|
3052
|
+
method: "POST",
|
|
3053
|
+
path: requestPath,
|
|
3054
|
+
queryParameters,
|
|
3055
|
+
headers,
|
|
3056
|
+
data: authenticationSearch
|
|
3057
|
+
};
|
|
3058
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3059
|
+
},
|
|
1561
3060
|
/**
|
|
1562
3061
|
* Searches for destinations.
|
|
1563
3062
|
*
|
|
@@ -1583,6 +3082,38 @@ function createIngestionClient({
|
|
|
1583
3082
|
};
|
|
1584
3083
|
return transporter.request(request, requestOptions);
|
|
1585
3084
|
},
|
|
3085
|
+
/**
|
|
3086
|
+
* Searches for destinations.
|
|
3087
|
+
*
|
|
3088
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3089
|
+
*
|
|
3090
|
+
* Required API Key ACLs:
|
|
3091
|
+
* - addObject
|
|
3092
|
+
* - deleteIndex
|
|
3093
|
+
* - editSettings
|
|
3094
|
+
* @param destinationSearch - The destinationSearch object.
|
|
3095
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3096
|
+
* @see searchDestinations for the plain version.
|
|
3097
|
+
*/
|
|
3098
|
+
searchDestinationsWithHTTPInfo(destinationSearch, requestOptions) {
|
|
3099
|
+
(0, import_client_common.validateRequired)("destinationSearch", "searchDestinationsWithHTTPInfo", destinationSearch);
|
|
3100
|
+
(0, import_client_common.validateRequired)(
|
|
3101
|
+
"destinationSearch.destinationIDs",
|
|
3102
|
+
"searchDestinationsWithHTTPInfo",
|
|
3103
|
+
destinationSearch.destinationIDs
|
|
3104
|
+
);
|
|
3105
|
+
const requestPath = "/1/destinations/search";
|
|
3106
|
+
const headers = {};
|
|
3107
|
+
const queryParameters = {};
|
|
3108
|
+
const request = {
|
|
3109
|
+
method: "POST",
|
|
3110
|
+
path: requestPath,
|
|
3111
|
+
queryParameters,
|
|
3112
|
+
headers,
|
|
3113
|
+
data: destinationSearch
|
|
3114
|
+
};
|
|
3115
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3116
|
+
},
|
|
1586
3117
|
/**
|
|
1587
3118
|
* Searches for sources.
|
|
1588
3119
|
*
|
|
@@ -1608,6 +3139,34 @@ function createIngestionClient({
|
|
|
1608
3139
|
};
|
|
1609
3140
|
return transporter.request(request, requestOptions);
|
|
1610
3141
|
},
|
|
3142
|
+
/**
|
|
3143
|
+
* Searches for sources.
|
|
3144
|
+
*
|
|
3145
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3146
|
+
*
|
|
3147
|
+
* Required API Key ACLs:
|
|
3148
|
+
* - addObject
|
|
3149
|
+
* - deleteIndex
|
|
3150
|
+
* - editSettings
|
|
3151
|
+
* @param sourceSearch - The sourceSearch object.
|
|
3152
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3153
|
+
* @see searchSources for the plain version.
|
|
3154
|
+
*/
|
|
3155
|
+
searchSourcesWithHTTPInfo(sourceSearch, requestOptions) {
|
|
3156
|
+
(0, import_client_common.validateRequired)("sourceSearch", "searchSourcesWithHTTPInfo", sourceSearch);
|
|
3157
|
+
(0, import_client_common.validateRequired)("sourceSearch.sourceIDs", "searchSourcesWithHTTPInfo", sourceSearch.sourceIDs);
|
|
3158
|
+
const requestPath = "/1/sources/search";
|
|
3159
|
+
const headers = {};
|
|
3160
|
+
const queryParameters = {};
|
|
3161
|
+
const request = {
|
|
3162
|
+
method: "POST",
|
|
3163
|
+
path: requestPath,
|
|
3164
|
+
queryParameters,
|
|
3165
|
+
headers,
|
|
3166
|
+
data: sourceSearch
|
|
3167
|
+
};
|
|
3168
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3169
|
+
},
|
|
1611
3170
|
/**
|
|
1612
3171
|
* Searches for tasks.
|
|
1613
3172
|
*
|
|
@@ -1633,6 +3192,34 @@ function createIngestionClient({
|
|
|
1633
3192
|
};
|
|
1634
3193
|
return transporter.request(request, requestOptions);
|
|
1635
3194
|
},
|
|
3195
|
+
/**
|
|
3196
|
+
* Searches for tasks.
|
|
3197
|
+
*
|
|
3198
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3199
|
+
*
|
|
3200
|
+
* Required API Key ACLs:
|
|
3201
|
+
* - addObject
|
|
3202
|
+
* - deleteIndex
|
|
3203
|
+
* - editSettings
|
|
3204
|
+
* @param taskSearch - The taskSearch object.
|
|
3205
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3206
|
+
* @see searchTasks for the plain version.
|
|
3207
|
+
*/
|
|
3208
|
+
searchTasksWithHTTPInfo(taskSearch, requestOptions) {
|
|
3209
|
+
(0, import_client_common.validateRequired)("taskSearch", "searchTasksWithHTTPInfo", taskSearch);
|
|
3210
|
+
(0, import_client_common.validateRequired)("taskSearch.taskIDs", "searchTasksWithHTTPInfo", taskSearch.taskIDs);
|
|
3211
|
+
const requestPath = "/2/tasks/search";
|
|
3212
|
+
const headers = {};
|
|
3213
|
+
const queryParameters = {};
|
|
3214
|
+
const request = {
|
|
3215
|
+
method: "POST",
|
|
3216
|
+
path: requestPath,
|
|
3217
|
+
queryParameters,
|
|
3218
|
+
headers,
|
|
3219
|
+
data: taskSearch
|
|
3220
|
+
};
|
|
3221
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3222
|
+
},
|
|
1636
3223
|
/**
|
|
1637
3224
|
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
1638
3225
|
*
|
|
@@ -1660,6 +3247,36 @@ function createIngestionClient({
|
|
|
1660
3247
|
};
|
|
1661
3248
|
return transporter.request(request, requestOptions);
|
|
1662
3249
|
},
|
|
3250
|
+
/**
|
|
3251
|
+
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
3252
|
+
*
|
|
3253
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3254
|
+
*
|
|
3255
|
+
* Required API Key ACLs:
|
|
3256
|
+
* - addObject
|
|
3257
|
+
* - deleteIndex
|
|
3258
|
+
* - editSettings
|
|
3259
|
+
*
|
|
3260
|
+
* @deprecated
|
|
3261
|
+
* @param taskSearch - The taskSearch object.
|
|
3262
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3263
|
+
* @see searchTasksV1 for the plain version.
|
|
3264
|
+
*/
|
|
3265
|
+
searchTasksV1WithHTTPInfo(taskSearch, requestOptions) {
|
|
3266
|
+
(0, import_client_common.validateRequired)("taskSearch", "searchTasksV1WithHTTPInfo", taskSearch);
|
|
3267
|
+
(0, import_client_common.validateRequired)("taskSearch.taskIDs", "searchTasksV1WithHTTPInfo", taskSearch.taskIDs);
|
|
3268
|
+
const requestPath = "/1/tasks/search";
|
|
3269
|
+
const headers = {};
|
|
3270
|
+
const queryParameters = {};
|
|
3271
|
+
const request = {
|
|
3272
|
+
method: "POST",
|
|
3273
|
+
path: requestPath,
|
|
3274
|
+
queryParameters,
|
|
3275
|
+
headers,
|
|
3276
|
+
data: taskSearch
|
|
3277
|
+
};
|
|
3278
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3279
|
+
},
|
|
1663
3280
|
/**
|
|
1664
3281
|
* Searches for transformations.
|
|
1665
3282
|
*
|
|
@@ -1689,6 +3306,38 @@ function createIngestionClient({
|
|
|
1689
3306
|
};
|
|
1690
3307
|
return transporter.request(request, requestOptions);
|
|
1691
3308
|
},
|
|
3309
|
+
/**
|
|
3310
|
+
* Searches for transformations.
|
|
3311
|
+
*
|
|
3312
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3313
|
+
*
|
|
3314
|
+
* Required API Key ACLs:
|
|
3315
|
+
* - addObject
|
|
3316
|
+
* - deleteIndex
|
|
3317
|
+
* - editSettings
|
|
3318
|
+
* @param transformationSearch - The transformationSearch object.
|
|
3319
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3320
|
+
* @see searchTransformations for the plain version.
|
|
3321
|
+
*/
|
|
3322
|
+
searchTransformationsWithHTTPInfo(transformationSearch, requestOptions) {
|
|
3323
|
+
(0, import_client_common.validateRequired)("transformationSearch", "searchTransformationsWithHTTPInfo", transformationSearch);
|
|
3324
|
+
(0, import_client_common.validateRequired)(
|
|
3325
|
+
"transformationSearch.transformationIDs",
|
|
3326
|
+
"searchTransformationsWithHTTPInfo",
|
|
3327
|
+
transformationSearch.transformationIDs
|
|
3328
|
+
);
|
|
3329
|
+
const requestPath = "/1/transformations/search";
|
|
3330
|
+
const headers = {};
|
|
3331
|
+
const queryParameters = {};
|
|
3332
|
+
const request = {
|
|
3333
|
+
method: "POST",
|
|
3334
|
+
path: requestPath,
|
|
3335
|
+
queryParameters,
|
|
3336
|
+
headers,
|
|
3337
|
+
data: transformationSearch
|
|
3338
|
+
};
|
|
3339
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3340
|
+
},
|
|
1692
3341
|
/**
|
|
1693
3342
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
|
|
1694
3343
|
*
|
|
@@ -1712,6 +3361,43 @@ function createIngestionClient({
|
|
|
1712
3361
|
headers
|
|
1713
3362
|
};
|
|
1714
3363
|
requestOptions = {
|
|
3364
|
+
...requestOptions,
|
|
3365
|
+
timeouts: {
|
|
3366
|
+
connect: 18e4,
|
|
3367
|
+
read: 18e4,
|
|
3368
|
+
write: 18e4,
|
|
3369
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
3370
|
+
}
|
|
3371
|
+
};
|
|
3372
|
+
return transporter.request(request, requestOptions);
|
|
3373
|
+
},
|
|
3374
|
+
/**
|
|
3375
|
+
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
|
|
3376
|
+
*
|
|
3377
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3378
|
+
*
|
|
3379
|
+
* Required API Key ACLs:
|
|
3380
|
+
* - addObject
|
|
3381
|
+
* - deleteIndex
|
|
3382
|
+
* - editSettings
|
|
3383
|
+
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
3384
|
+
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
3385
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3386
|
+
* @see triggerDockerSourceDiscover for the plain version.
|
|
3387
|
+
*/
|
|
3388
|
+
triggerDockerSourceDiscoverWithHTTPInfo({ sourceID }, requestOptions) {
|
|
3389
|
+
(0, import_client_common.validateRequired)("sourceID", "triggerDockerSourceDiscoverWithHTTPInfo", sourceID);
|
|
3390
|
+
const requestPath = "/1/sources/{sourceID}/discover".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
3391
|
+
const headers = {};
|
|
3392
|
+
const queryParameters = {};
|
|
3393
|
+
const request = {
|
|
3394
|
+
method: "POST",
|
|
3395
|
+
path: requestPath,
|
|
3396
|
+
queryParameters,
|
|
3397
|
+
headers
|
|
3398
|
+
};
|
|
3399
|
+
requestOptions = {
|
|
3400
|
+
...requestOptions,
|
|
1715
3401
|
timeouts: {
|
|
1716
3402
|
connect: 18e4,
|
|
1717
3403
|
read: 18e4,
|
|
@@ -1719,21 +3405,53 @@ function createIngestionClient({
|
|
|
1719
3405
|
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
1720
3406
|
}
|
|
1721
3407
|
};
|
|
3408
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3409
|
+
},
|
|
3410
|
+
/**
|
|
3411
|
+
* Try a transformation before creating it.
|
|
3412
|
+
*
|
|
3413
|
+
* Required API Key ACLs:
|
|
3414
|
+
* - addObject
|
|
3415
|
+
* - deleteIndex
|
|
3416
|
+
* - editSettings
|
|
3417
|
+
* @param transformationTry - The transformationTry object.
|
|
3418
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3419
|
+
*/
|
|
3420
|
+
tryTransformation(transformationTry, requestOptions) {
|
|
3421
|
+
(0, import_client_common.validateRequired)("transformationTry", "tryTransformation", transformationTry);
|
|
3422
|
+
(0, import_client_common.validateRequired)("transformationTry.sampleRecord", "tryTransformation", transformationTry.sampleRecord);
|
|
3423
|
+
const requestPath = "/1/transformations/try";
|
|
3424
|
+
const headers = {};
|
|
3425
|
+
const queryParameters = {};
|
|
3426
|
+
const request = {
|
|
3427
|
+
method: "POST",
|
|
3428
|
+
path: requestPath,
|
|
3429
|
+
queryParameters,
|
|
3430
|
+
headers,
|
|
3431
|
+
data: transformationTry
|
|
3432
|
+
};
|
|
1722
3433
|
return transporter.request(request, requestOptions);
|
|
1723
3434
|
},
|
|
1724
3435
|
/**
|
|
1725
3436
|
* Try a transformation before creating it.
|
|
1726
3437
|
*
|
|
3438
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3439
|
+
*
|
|
1727
3440
|
* Required API Key ACLs:
|
|
1728
3441
|
* - addObject
|
|
1729
3442
|
* - deleteIndex
|
|
1730
3443
|
* - editSettings
|
|
1731
3444
|
* @param transformationTry - The transformationTry object.
|
|
1732
3445
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3446
|
+
* @see tryTransformation for the plain version.
|
|
1733
3447
|
*/
|
|
1734
|
-
|
|
1735
|
-
(0, import_client_common.validateRequired)("transformationTry", "
|
|
1736
|
-
(0, import_client_common.validateRequired)(
|
|
3448
|
+
tryTransformationWithHTTPInfo(transformationTry, requestOptions) {
|
|
3449
|
+
(0, import_client_common.validateRequired)("transformationTry", "tryTransformationWithHTTPInfo", transformationTry);
|
|
3450
|
+
(0, import_client_common.validateRequired)(
|
|
3451
|
+
"transformationTry.sampleRecord",
|
|
3452
|
+
"tryTransformationWithHTTPInfo",
|
|
3453
|
+
transformationTry.sampleRecord
|
|
3454
|
+
);
|
|
1737
3455
|
const requestPath = "/1/transformations/try";
|
|
1738
3456
|
const headers = {};
|
|
1739
3457
|
const queryParameters = {};
|
|
@@ -1744,7 +3462,7 @@ function createIngestionClient({
|
|
|
1744
3462
|
headers,
|
|
1745
3463
|
data: transformationTry
|
|
1746
3464
|
};
|
|
1747
|
-
return transporter.
|
|
3465
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1748
3466
|
},
|
|
1749
3467
|
/**
|
|
1750
3468
|
* Try a transformation before updating it.
|
|
@@ -1781,6 +3499,44 @@ function createIngestionClient({
|
|
|
1781
3499
|
};
|
|
1782
3500
|
return transporter.request(request, requestOptions);
|
|
1783
3501
|
},
|
|
3502
|
+
/**
|
|
3503
|
+
* Try a transformation before updating it.
|
|
3504
|
+
*
|
|
3505
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3506
|
+
*
|
|
3507
|
+
* Required API Key ACLs:
|
|
3508
|
+
* - addObject
|
|
3509
|
+
* - deleteIndex
|
|
3510
|
+
* - editSettings
|
|
3511
|
+
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
3512
|
+
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
3513
|
+
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
3514
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3515
|
+
* @see tryTransformationBeforeUpdate for the plain version.
|
|
3516
|
+
*/
|
|
3517
|
+
tryTransformationBeforeUpdateWithHTTPInfo({ transformationID, transformationTry }, requestOptions) {
|
|
3518
|
+
(0, import_client_common.validateRequired)("transformationID", "tryTransformationBeforeUpdateWithHTTPInfo", transformationID);
|
|
3519
|
+
(0, import_client_common.validateRequired)("transformationTry", "tryTransformationBeforeUpdateWithHTTPInfo", transformationTry);
|
|
3520
|
+
(0, import_client_common.validateRequired)(
|
|
3521
|
+
"transformationTry.sampleRecord",
|
|
3522
|
+
"tryTransformationBeforeUpdateWithHTTPInfo",
|
|
3523
|
+
transformationTry.sampleRecord
|
|
3524
|
+
);
|
|
3525
|
+
const requestPath = "/1/transformations/{transformationID}/try".replace(
|
|
3526
|
+
"{transformationID}",
|
|
3527
|
+
encodeURIComponent(transformationID)
|
|
3528
|
+
);
|
|
3529
|
+
const headers = {};
|
|
3530
|
+
const queryParameters = {};
|
|
3531
|
+
const request = {
|
|
3532
|
+
method: "POST",
|
|
3533
|
+
path: requestPath,
|
|
3534
|
+
queryParameters,
|
|
3535
|
+
headers,
|
|
3536
|
+
data: transformationTry
|
|
3537
|
+
};
|
|
3538
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3539
|
+
},
|
|
1784
3540
|
/**
|
|
1785
3541
|
* Updates an authentication resource.
|
|
1786
3542
|
*
|
|
@@ -1811,6 +3567,39 @@ function createIngestionClient({
|
|
|
1811
3567
|
};
|
|
1812
3568
|
return transporter.request(request, requestOptions);
|
|
1813
3569
|
},
|
|
3570
|
+
/**
|
|
3571
|
+
* Updates an authentication resource.
|
|
3572
|
+
*
|
|
3573
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3574
|
+
*
|
|
3575
|
+
* Required API Key ACLs:
|
|
3576
|
+
* - addObject
|
|
3577
|
+
* - deleteIndex
|
|
3578
|
+
* - editSettings
|
|
3579
|
+
* @param updateAuthentication - The updateAuthentication object.
|
|
3580
|
+
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
3581
|
+
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
3582
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3583
|
+
* @see updateAuthentication for the plain version.
|
|
3584
|
+
*/
|
|
3585
|
+
updateAuthenticationWithHTTPInfo({ authenticationID, authenticationUpdate }, requestOptions) {
|
|
3586
|
+
(0, import_client_common.validateRequired)("authenticationID", "updateAuthenticationWithHTTPInfo", authenticationID);
|
|
3587
|
+
(0, import_client_common.validateRequired)("authenticationUpdate", "updateAuthenticationWithHTTPInfo", authenticationUpdate);
|
|
3588
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
3589
|
+
"{authenticationID}",
|
|
3590
|
+
encodeURIComponent(authenticationID)
|
|
3591
|
+
);
|
|
3592
|
+
const headers = {};
|
|
3593
|
+
const queryParameters = {};
|
|
3594
|
+
const request = {
|
|
3595
|
+
method: "PATCH",
|
|
3596
|
+
path: requestPath,
|
|
3597
|
+
queryParameters,
|
|
3598
|
+
headers,
|
|
3599
|
+
data: authenticationUpdate
|
|
3600
|
+
};
|
|
3601
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3602
|
+
},
|
|
1814
3603
|
/**
|
|
1815
3604
|
* Updates the destination by its ID.
|
|
1816
3605
|
*
|
|
@@ -1841,6 +3630,39 @@ function createIngestionClient({
|
|
|
1841
3630
|
};
|
|
1842
3631
|
return transporter.request(request, requestOptions);
|
|
1843
3632
|
},
|
|
3633
|
+
/**
|
|
3634
|
+
* Updates the destination by its ID.
|
|
3635
|
+
*
|
|
3636
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3637
|
+
*
|
|
3638
|
+
* Required API Key ACLs:
|
|
3639
|
+
* - addObject
|
|
3640
|
+
* - deleteIndex
|
|
3641
|
+
* - editSettings
|
|
3642
|
+
* @param updateDestination - The updateDestination object.
|
|
3643
|
+
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
3644
|
+
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
3645
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3646
|
+
* @see updateDestination for the plain version.
|
|
3647
|
+
*/
|
|
3648
|
+
updateDestinationWithHTTPInfo({ destinationID, destinationUpdate }, requestOptions) {
|
|
3649
|
+
(0, import_client_common.validateRequired)("destinationID", "updateDestinationWithHTTPInfo", destinationID);
|
|
3650
|
+
(0, import_client_common.validateRequired)("destinationUpdate", "updateDestinationWithHTTPInfo", destinationUpdate);
|
|
3651
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
3652
|
+
"{destinationID}",
|
|
3653
|
+
encodeURIComponent(destinationID)
|
|
3654
|
+
);
|
|
3655
|
+
const headers = {};
|
|
3656
|
+
const queryParameters = {};
|
|
3657
|
+
const request = {
|
|
3658
|
+
method: "PATCH",
|
|
3659
|
+
path: requestPath,
|
|
3660
|
+
queryParameters,
|
|
3661
|
+
headers,
|
|
3662
|
+
data: destinationUpdate
|
|
3663
|
+
};
|
|
3664
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3665
|
+
},
|
|
1844
3666
|
/**
|
|
1845
3667
|
* Updates a source by its ID.
|
|
1846
3668
|
*
|
|
@@ -1868,6 +3690,36 @@ function createIngestionClient({
|
|
|
1868
3690
|
};
|
|
1869
3691
|
return transporter.request(request, requestOptions);
|
|
1870
3692
|
},
|
|
3693
|
+
/**
|
|
3694
|
+
* Updates a source by its ID.
|
|
3695
|
+
*
|
|
3696
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3697
|
+
*
|
|
3698
|
+
* Required API Key ACLs:
|
|
3699
|
+
* - addObject
|
|
3700
|
+
* - deleteIndex
|
|
3701
|
+
* - editSettings
|
|
3702
|
+
* @param updateSource - The updateSource object.
|
|
3703
|
+
* @param updateSource.sourceID - Unique identifier of a source.
|
|
3704
|
+
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
3705
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3706
|
+
* @see updateSource for the plain version.
|
|
3707
|
+
*/
|
|
3708
|
+
updateSourceWithHTTPInfo({ sourceID, sourceUpdate }, requestOptions) {
|
|
3709
|
+
(0, import_client_common.validateRequired)("sourceID", "updateSourceWithHTTPInfo", sourceID);
|
|
3710
|
+
(0, import_client_common.validateRequired)("sourceUpdate", "updateSourceWithHTTPInfo", sourceUpdate);
|
|
3711
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
3712
|
+
const headers = {};
|
|
3713
|
+
const queryParameters = {};
|
|
3714
|
+
const request = {
|
|
3715
|
+
method: "PATCH",
|
|
3716
|
+
path: requestPath,
|
|
3717
|
+
queryParameters,
|
|
3718
|
+
headers,
|
|
3719
|
+
data: sourceUpdate
|
|
3720
|
+
};
|
|
3721
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3722
|
+
},
|
|
1871
3723
|
/**
|
|
1872
3724
|
* Partially updates a task by its ID.
|
|
1873
3725
|
*
|
|
@@ -1895,6 +3747,36 @@ function createIngestionClient({
|
|
|
1895
3747
|
};
|
|
1896
3748
|
return transporter.request(request, requestOptions);
|
|
1897
3749
|
},
|
|
3750
|
+
/**
|
|
3751
|
+
* Partially updates a task by its ID.
|
|
3752
|
+
*
|
|
3753
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3754
|
+
*
|
|
3755
|
+
* Required API Key ACLs:
|
|
3756
|
+
* - addObject
|
|
3757
|
+
* - deleteIndex
|
|
3758
|
+
* - editSettings
|
|
3759
|
+
* @param updateTask - The updateTask object.
|
|
3760
|
+
* @param updateTask.taskID - Unique identifier of a task.
|
|
3761
|
+
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
3762
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3763
|
+
* @see updateTask for the plain version.
|
|
3764
|
+
*/
|
|
3765
|
+
updateTaskWithHTTPInfo({ taskID, taskUpdate }, requestOptions) {
|
|
3766
|
+
(0, import_client_common.validateRequired)("taskID", "updateTaskWithHTTPInfo", taskID);
|
|
3767
|
+
(0, import_client_common.validateRequired)("taskUpdate", "updateTaskWithHTTPInfo", taskUpdate);
|
|
3768
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
3769
|
+
const headers = {};
|
|
3770
|
+
const queryParameters = {};
|
|
3771
|
+
const request = {
|
|
3772
|
+
method: "PATCH",
|
|
3773
|
+
path: requestPath,
|
|
3774
|
+
queryParameters,
|
|
3775
|
+
headers,
|
|
3776
|
+
data: taskUpdate
|
|
3777
|
+
};
|
|
3778
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3779
|
+
},
|
|
1898
3780
|
/**
|
|
1899
3781
|
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
1900
3782
|
*
|
|
@@ -1924,6 +3806,38 @@ function createIngestionClient({
|
|
|
1924
3806
|
};
|
|
1925
3807
|
return transporter.request(request, requestOptions);
|
|
1926
3808
|
},
|
|
3809
|
+
/**
|
|
3810
|
+
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
3811
|
+
*
|
|
3812
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3813
|
+
*
|
|
3814
|
+
* Required API Key ACLs:
|
|
3815
|
+
* - addObject
|
|
3816
|
+
* - deleteIndex
|
|
3817
|
+
* - editSettings
|
|
3818
|
+
*
|
|
3819
|
+
* @deprecated
|
|
3820
|
+
* @param updateTaskV1 - The updateTaskV1 object.
|
|
3821
|
+
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
3822
|
+
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
3823
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3824
|
+
* @see updateTaskV1 for the plain version.
|
|
3825
|
+
*/
|
|
3826
|
+
updateTaskV1WithHTTPInfo({ taskID, taskUpdate }, requestOptions) {
|
|
3827
|
+
(0, import_client_common.validateRequired)("taskID", "updateTaskV1WithHTTPInfo", taskID);
|
|
3828
|
+
(0, import_client_common.validateRequired)("taskUpdate", "updateTaskV1WithHTTPInfo", taskUpdate);
|
|
3829
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
3830
|
+
const headers = {};
|
|
3831
|
+
const queryParameters = {};
|
|
3832
|
+
const request = {
|
|
3833
|
+
method: "PATCH",
|
|
3834
|
+
path: requestPath,
|
|
3835
|
+
queryParameters,
|
|
3836
|
+
headers,
|
|
3837
|
+
data: taskUpdate
|
|
3838
|
+
};
|
|
3839
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3840
|
+
},
|
|
1927
3841
|
/**
|
|
1928
3842
|
* Updates a transformation by its ID.
|
|
1929
3843
|
*
|
|
@@ -1955,6 +3869,40 @@ function createIngestionClient({
|
|
|
1955
3869
|
};
|
|
1956
3870
|
return transporter.request(request, requestOptions);
|
|
1957
3871
|
},
|
|
3872
|
+
/**
|
|
3873
|
+
* Updates a transformation by its ID.
|
|
3874
|
+
*
|
|
3875
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3876
|
+
*
|
|
3877
|
+
* Required API Key ACLs:
|
|
3878
|
+
* - addObject
|
|
3879
|
+
* - deleteIndex
|
|
3880
|
+
* - editSettings
|
|
3881
|
+
* @param updateTransformation - The updateTransformation object.
|
|
3882
|
+
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
3883
|
+
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
3884
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3885
|
+
* @see updateTransformation for the plain version.
|
|
3886
|
+
*/
|
|
3887
|
+
updateTransformationWithHTTPInfo({ transformationID, transformationCreate }, requestOptions) {
|
|
3888
|
+
(0, import_client_common.validateRequired)("transformationID", "updateTransformationWithHTTPInfo", transformationID);
|
|
3889
|
+
(0, import_client_common.validateRequired)("transformationCreate", "updateTransformationWithHTTPInfo", transformationCreate);
|
|
3890
|
+
(0, import_client_common.validateRequired)("transformationCreate.name", "updateTransformationWithHTTPInfo", transformationCreate.name);
|
|
3891
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
3892
|
+
"{transformationID}",
|
|
3893
|
+
encodeURIComponent(transformationID)
|
|
3894
|
+
);
|
|
3895
|
+
const headers = {};
|
|
3896
|
+
const queryParameters = {};
|
|
3897
|
+
const request = {
|
|
3898
|
+
method: "PUT",
|
|
3899
|
+
path: requestPath,
|
|
3900
|
+
queryParameters,
|
|
3901
|
+
headers,
|
|
3902
|
+
data: transformationCreate
|
|
3903
|
+
};
|
|
3904
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3905
|
+
},
|
|
1958
3906
|
/**
|
|
1959
3907
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1960
3908
|
*
|
|
@@ -1977,6 +3925,7 @@ function createIngestionClient({
|
|
|
1977
3925
|
data: sourceCreate ? sourceCreate : {}
|
|
1978
3926
|
};
|
|
1979
3927
|
requestOptions = {
|
|
3928
|
+
...requestOptions,
|
|
1980
3929
|
timeouts: {
|
|
1981
3930
|
connect: 18e4,
|
|
1982
3931
|
read: 18e4,
|
|
@@ -1986,6 +3935,41 @@ function createIngestionClient({
|
|
|
1986
3935
|
};
|
|
1987
3936
|
return transporter.request(request, requestOptions);
|
|
1988
3937
|
},
|
|
3938
|
+
/**
|
|
3939
|
+
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
3940
|
+
*
|
|
3941
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
3942
|
+
*
|
|
3943
|
+
* Required API Key ACLs:
|
|
3944
|
+
* - addObject
|
|
3945
|
+
* - deleteIndex
|
|
3946
|
+
* - editSettings
|
|
3947
|
+
* @param sourceCreate -
|
|
3948
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3949
|
+
* @see validateSource for the plain version.
|
|
3950
|
+
*/
|
|
3951
|
+
validateSourceWithHTTPInfo(sourceCreate, requestOptions = void 0) {
|
|
3952
|
+
const requestPath = "/1/sources/validate";
|
|
3953
|
+
const headers = {};
|
|
3954
|
+
const queryParameters = {};
|
|
3955
|
+
const request = {
|
|
3956
|
+
method: "POST",
|
|
3957
|
+
path: requestPath,
|
|
3958
|
+
queryParameters,
|
|
3959
|
+
headers,
|
|
3960
|
+
data: sourceCreate ? sourceCreate : {}
|
|
3961
|
+
};
|
|
3962
|
+
requestOptions = {
|
|
3963
|
+
...requestOptions,
|
|
3964
|
+
timeouts: {
|
|
3965
|
+
connect: 18e4,
|
|
3966
|
+
read: 18e4,
|
|
3967
|
+
write: 18e4,
|
|
3968
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
3969
|
+
}
|
|
3970
|
+
};
|
|
3971
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3972
|
+
},
|
|
1989
3973
|
/**
|
|
1990
3974
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1991
3975
|
*
|
|
@@ -2012,6 +3996,7 @@ function createIngestionClient({
|
|
|
2012
3996
|
data: sourceUpdate
|
|
2013
3997
|
};
|
|
2014
3998
|
requestOptions = {
|
|
3999
|
+
...requestOptions,
|
|
2015
4000
|
timeouts: {
|
|
2016
4001
|
connect: 18e4,
|
|
2017
4002
|
read: 18e4,
|
|
@@ -2020,6 +4005,45 @@ function createIngestionClient({
|
|
|
2020
4005
|
}
|
|
2021
4006
|
};
|
|
2022
4007
|
return transporter.request(request, requestOptions);
|
|
4008
|
+
},
|
|
4009
|
+
/**
|
|
4010
|
+
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
4011
|
+
*
|
|
4012
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
4013
|
+
*
|
|
4014
|
+
* Required API Key ACLs:
|
|
4015
|
+
* - addObject
|
|
4016
|
+
* - deleteIndex
|
|
4017
|
+
* - editSettings
|
|
4018
|
+
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
4019
|
+
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
4020
|
+
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
4021
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
4022
|
+
* @see validateSourceBeforeUpdate for the plain version.
|
|
4023
|
+
*/
|
|
4024
|
+
validateSourceBeforeUpdateWithHTTPInfo({ sourceID, sourceUpdate }, requestOptions) {
|
|
4025
|
+
(0, import_client_common.validateRequired)("sourceID", "validateSourceBeforeUpdateWithHTTPInfo", sourceID);
|
|
4026
|
+
(0, import_client_common.validateRequired)("sourceUpdate", "validateSourceBeforeUpdateWithHTTPInfo", sourceUpdate);
|
|
4027
|
+
const requestPath = "/1/sources/{sourceID}/validate".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
4028
|
+
const headers = {};
|
|
4029
|
+
const queryParameters = {};
|
|
4030
|
+
const request = {
|
|
4031
|
+
method: "POST",
|
|
4032
|
+
path: requestPath,
|
|
4033
|
+
queryParameters,
|
|
4034
|
+
headers,
|
|
4035
|
+
data: sourceUpdate
|
|
4036
|
+
};
|
|
4037
|
+
requestOptions = {
|
|
4038
|
+
...requestOptions,
|
|
4039
|
+
timeouts: {
|
|
4040
|
+
connect: 18e4,
|
|
4041
|
+
read: 18e4,
|
|
4042
|
+
write: 18e4,
|
|
4043
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
4044
|
+
}
|
|
4045
|
+
};
|
|
4046
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2023
4047
|
}
|
|
2024
4048
|
};
|
|
2025
4049
|
}
|