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