@algolia/ingestion 1.55.2 → 1.56.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/browser.d.ts +954 -7
- package/dist/builds/browser.js +2213 -189
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +5 -5
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +9 -9
- package/dist/builds/fetch.js +2213 -189
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +2213 -189
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +2213 -189
- package/dist/builds/node.js.map +1 -1
- package/dist/builds/worker.js +2213 -189
- package/dist/builds/worker.js.map +1 -1
- package/dist/fetch.d.ts +954 -7
- package/dist/node.d.cts +954 -7
- package/dist/node.d.ts +954 -7
- package/dist/src/ingestionClient.cjs +2213 -189
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +2213 -189
- package/dist/src/ingestionClient.js.map +1 -1
- package/dist/worker.d.ts +954 -7
- package/package.json +8 -8
|
@@ -6,7 +6,7 @@ import {
|
|
|
6
6
|
getAlgoliaAgent,
|
|
7
7
|
validateRequired
|
|
8
8
|
} from "@algolia/client-common";
|
|
9
|
-
var apiClientVersion = "1.
|
|
9
|
+
var apiClientVersion = "1.56.0";
|
|
10
10
|
var REGIONS = ["eu", "us"];
|
|
11
11
|
function getDefaultHosts(region) {
|
|
12
12
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -196,6 +196,36 @@ function createIngestionClient({
|
|
|
196
196
|
};
|
|
197
197
|
return transporter.request(request, requestOptions);
|
|
198
198
|
},
|
|
199
|
+
/**
|
|
200
|
+
* Creates a new authentication resource.
|
|
201
|
+
*
|
|
202
|
+
* 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.
|
|
203
|
+
*
|
|
204
|
+
* Required API Key ACLs:
|
|
205
|
+
* - addObject
|
|
206
|
+
* - deleteIndex
|
|
207
|
+
* - editSettings
|
|
208
|
+
* @param authenticationCreate -
|
|
209
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
210
|
+
* @see createAuthentication for the plain version.
|
|
211
|
+
*/
|
|
212
|
+
createAuthenticationWithHTTPInfo(authenticationCreate, requestOptions) {
|
|
213
|
+
validateRequired("authenticationCreate", "createAuthenticationWithHTTPInfo", authenticationCreate);
|
|
214
|
+
validateRequired("authenticationCreate.type", "createAuthenticationWithHTTPInfo", authenticationCreate.type);
|
|
215
|
+
validateRequired("authenticationCreate.name", "createAuthenticationWithHTTPInfo", authenticationCreate.name);
|
|
216
|
+
validateRequired("authenticationCreate.input", "createAuthenticationWithHTTPInfo", authenticationCreate.input);
|
|
217
|
+
const requestPath = "/1/authentications";
|
|
218
|
+
const headers = {};
|
|
219
|
+
const queryParameters = {};
|
|
220
|
+
const request = {
|
|
221
|
+
method: "POST",
|
|
222
|
+
path: requestPath,
|
|
223
|
+
queryParameters,
|
|
224
|
+
headers,
|
|
225
|
+
data: authenticationCreate
|
|
226
|
+
};
|
|
227
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
228
|
+
},
|
|
199
229
|
/**
|
|
200
230
|
* Creates a new destination.
|
|
201
231
|
*
|
|
@@ -223,6 +253,36 @@ function createIngestionClient({
|
|
|
223
253
|
};
|
|
224
254
|
return transporter.request(request, requestOptions);
|
|
225
255
|
},
|
|
256
|
+
/**
|
|
257
|
+
* Creates a new destination.
|
|
258
|
+
*
|
|
259
|
+
* 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.
|
|
260
|
+
*
|
|
261
|
+
* Required API Key ACLs:
|
|
262
|
+
* - addObject
|
|
263
|
+
* - deleteIndex
|
|
264
|
+
* - editSettings
|
|
265
|
+
* @param destinationCreate -
|
|
266
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
267
|
+
* @see createDestination for the plain version.
|
|
268
|
+
*/
|
|
269
|
+
createDestinationWithHTTPInfo(destinationCreate, requestOptions) {
|
|
270
|
+
validateRequired("destinationCreate", "createDestinationWithHTTPInfo", destinationCreate);
|
|
271
|
+
validateRequired("destinationCreate.type", "createDestinationWithHTTPInfo", destinationCreate.type);
|
|
272
|
+
validateRequired("destinationCreate.name", "createDestinationWithHTTPInfo", destinationCreate.name);
|
|
273
|
+
validateRequired("destinationCreate.input", "createDestinationWithHTTPInfo", destinationCreate.input);
|
|
274
|
+
const requestPath = "/1/destinations";
|
|
275
|
+
const headers = {};
|
|
276
|
+
const queryParameters = {};
|
|
277
|
+
const request = {
|
|
278
|
+
method: "POST",
|
|
279
|
+
path: requestPath,
|
|
280
|
+
queryParameters,
|
|
281
|
+
headers,
|
|
282
|
+
data: destinationCreate
|
|
283
|
+
};
|
|
284
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
285
|
+
},
|
|
226
286
|
/**
|
|
227
287
|
* Creates a new source.
|
|
228
288
|
*
|
|
@@ -249,6 +309,35 @@ function createIngestionClient({
|
|
|
249
309
|
};
|
|
250
310
|
return transporter.request(request, requestOptions);
|
|
251
311
|
},
|
|
312
|
+
/**
|
|
313
|
+
* Creates a new source.
|
|
314
|
+
*
|
|
315
|
+
* 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.
|
|
316
|
+
*
|
|
317
|
+
* Required API Key ACLs:
|
|
318
|
+
* - addObject
|
|
319
|
+
* - deleteIndex
|
|
320
|
+
* - editSettings
|
|
321
|
+
* @param sourceCreate -
|
|
322
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
323
|
+
* @see createSource for the plain version.
|
|
324
|
+
*/
|
|
325
|
+
createSourceWithHTTPInfo(sourceCreate, requestOptions) {
|
|
326
|
+
validateRequired("sourceCreate", "createSourceWithHTTPInfo", sourceCreate);
|
|
327
|
+
validateRequired("sourceCreate.type", "createSourceWithHTTPInfo", sourceCreate.type);
|
|
328
|
+
validateRequired("sourceCreate.name", "createSourceWithHTTPInfo", sourceCreate.name);
|
|
329
|
+
const requestPath = "/1/sources";
|
|
330
|
+
const headers = {};
|
|
331
|
+
const queryParameters = {};
|
|
332
|
+
const request = {
|
|
333
|
+
method: "POST",
|
|
334
|
+
path: requestPath,
|
|
335
|
+
queryParameters,
|
|
336
|
+
headers,
|
|
337
|
+
data: sourceCreate
|
|
338
|
+
};
|
|
339
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
340
|
+
},
|
|
252
341
|
/**
|
|
253
342
|
* Creates a new task.
|
|
254
343
|
*
|
|
@@ -276,6 +365,36 @@ function createIngestionClient({
|
|
|
276
365
|
};
|
|
277
366
|
return transporter.request(request, requestOptions);
|
|
278
367
|
},
|
|
368
|
+
/**
|
|
369
|
+
* Creates a new task.
|
|
370
|
+
*
|
|
371
|
+
* 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.
|
|
372
|
+
*
|
|
373
|
+
* Required API Key ACLs:
|
|
374
|
+
* - addObject
|
|
375
|
+
* - deleteIndex
|
|
376
|
+
* - editSettings
|
|
377
|
+
* @param taskCreate - Request body for creating a task.
|
|
378
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
379
|
+
* @see createTask for the plain version.
|
|
380
|
+
*/
|
|
381
|
+
createTaskWithHTTPInfo(taskCreate, requestOptions) {
|
|
382
|
+
validateRequired("taskCreate", "createTaskWithHTTPInfo", taskCreate);
|
|
383
|
+
validateRequired("taskCreate.sourceID", "createTaskWithHTTPInfo", taskCreate.sourceID);
|
|
384
|
+
validateRequired("taskCreate.destinationID", "createTaskWithHTTPInfo", taskCreate.destinationID);
|
|
385
|
+
validateRequired("taskCreate.action", "createTaskWithHTTPInfo", taskCreate.action);
|
|
386
|
+
const requestPath = "/2/tasks";
|
|
387
|
+
const headers = {};
|
|
388
|
+
const queryParameters = {};
|
|
389
|
+
const request = {
|
|
390
|
+
method: "POST",
|
|
391
|
+
path: requestPath,
|
|
392
|
+
queryParameters,
|
|
393
|
+
headers,
|
|
394
|
+
data: taskCreate
|
|
395
|
+
};
|
|
396
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
397
|
+
},
|
|
279
398
|
/**
|
|
280
399
|
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
281
400
|
*
|
|
@@ -306,6 +425,39 @@ function createIngestionClient({
|
|
|
306
425
|
};
|
|
307
426
|
return transporter.request(request, requestOptions);
|
|
308
427
|
},
|
|
428
|
+
/**
|
|
429
|
+
* Creates a new task using the v1 endpoint. Use `createTask` instead.
|
|
430
|
+
*
|
|
431
|
+
* 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.
|
|
432
|
+
*
|
|
433
|
+
* Required API Key ACLs:
|
|
434
|
+
* - addObject
|
|
435
|
+
* - deleteIndex
|
|
436
|
+
* - editSettings
|
|
437
|
+
*
|
|
438
|
+
* @deprecated
|
|
439
|
+
* @param taskCreate - Request body for creating a task.
|
|
440
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
441
|
+
* @see createTaskV1 for the plain version.
|
|
442
|
+
*/
|
|
443
|
+
createTaskV1WithHTTPInfo(taskCreate, requestOptions) {
|
|
444
|
+
validateRequired("taskCreate", "createTaskV1WithHTTPInfo", taskCreate);
|
|
445
|
+
validateRequired("taskCreate.sourceID", "createTaskV1WithHTTPInfo", taskCreate.sourceID);
|
|
446
|
+
validateRequired("taskCreate.destinationID", "createTaskV1WithHTTPInfo", taskCreate.destinationID);
|
|
447
|
+
validateRequired("taskCreate.trigger", "createTaskV1WithHTTPInfo", taskCreate.trigger);
|
|
448
|
+
validateRequired("taskCreate.action", "createTaskV1WithHTTPInfo", taskCreate.action);
|
|
449
|
+
const requestPath = "/1/tasks";
|
|
450
|
+
const headers = {};
|
|
451
|
+
const queryParameters = {};
|
|
452
|
+
const request = {
|
|
453
|
+
method: "POST",
|
|
454
|
+
path: requestPath,
|
|
455
|
+
queryParameters,
|
|
456
|
+
headers,
|
|
457
|
+
data: taskCreate
|
|
458
|
+
};
|
|
459
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
460
|
+
},
|
|
309
461
|
/**
|
|
310
462
|
* Creates a new transformation.
|
|
311
463
|
*
|
|
@@ -331,6 +483,34 @@ function createIngestionClient({
|
|
|
331
483
|
};
|
|
332
484
|
return transporter.request(request, requestOptions);
|
|
333
485
|
},
|
|
486
|
+
/**
|
|
487
|
+
* Creates a new transformation.
|
|
488
|
+
*
|
|
489
|
+
* 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.
|
|
490
|
+
*
|
|
491
|
+
* Required API Key ACLs:
|
|
492
|
+
* - addObject
|
|
493
|
+
* - deleteIndex
|
|
494
|
+
* - editSettings
|
|
495
|
+
* @param transformationCreate - Request body for creating a transformation.
|
|
496
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
497
|
+
* @see createTransformation for the plain version.
|
|
498
|
+
*/
|
|
499
|
+
createTransformationWithHTTPInfo(transformationCreate, requestOptions) {
|
|
500
|
+
validateRequired("transformationCreate", "createTransformationWithHTTPInfo", transformationCreate);
|
|
501
|
+
validateRequired("transformationCreate.name", "createTransformationWithHTTPInfo", transformationCreate.name);
|
|
502
|
+
const requestPath = "/1/transformations";
|
|
503
|
+
const headers = {};
|
|
504
|
+
const queryParameters = {};
|
|
505
|
+
const request = {
|
|
506
|
+
method: "POST",
|
|
507
|
+
path: requestPath,
|
|
508
|
+
queryParameters,
|
|
509
|
+
headers,
|
|
510
|
+
data: transformationCreate
|
|
511
|
+
};
|
|
512
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
513
|
+
},
|
|
334
514
|
/**
|
|
335
515
|
* This method lets you send requests to the Algolia REST API.
|
|
336
516
|
* @param customDelete - The customDelete object.
|
|
@@ -351,6 +531,29 @@ function createIngestionClient({
|
|
|
351
531
|
};
|
|
352
532
|
return transporter.request(request, requestOptions);
|
|
353
533
|
},
|
|
534
|
+
/**
|
|
535
|
+
* This method lets you send requests to the Algolia REST API.
|
|
536
|
+
*
|
|
537
|
+
* 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.
|
|
538
|
+
* @param customDelete - The customDelete object.
|
|
539
|
+
* @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
|
|
540
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
541
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
542
|
+
* @see customDelete for the plain version.
|
|
543
|
+
*/
|
|
544
|
+
customDeleteWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
545
|
+
validateRequired("path", "customDeleteWithHTTPInfo", path);
|
|
546
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
547
|
+
const headers = {};
|
|
548
|
+
const queryParameters = parameters ? parameters : {};
|
|
549
|
+
const request = {
|
|
550
|
+
method: "DELETE",
|
|
551
|
+
path: requestPath,
|
|
552
|
+
queryParameters,
|
|
553
|
+
headers
|
|
554
|
+
};
|
|
555
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
556
|
+
},
|
|
354
557
|
/**
|
|
355
558
|
* This method lets you send requests to the Algolia REST API.
|
|
356
559
|
* @param customGet - The customGet object.
|
|
@@ -371,6 +574,29 @@ function createIngestionClient({
|
|
|
371
574
|
};
|
|
372
575
|
return transporter.request(request, requestOptions);
|
|
373
576
|
},
|
|
577
|
+
/**
|
|
578
|
+
* This method lets you send requests to the Algolia REST API.
|
|
579
|
+
*
|
|
580
|
+
* 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.
|
|
581
|
+
* @param customGet - The customGet object.
|
|
582
|
+
* @param customGet.path - Path of the endpoint, for example `1/newFeature`.
|
|
583
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
584
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
585
|
+
* @see customGet for the plain version.
|
|
586
|
+
*/
|
|
587
|
+
customGetWithHTTPInfo({ path, parameters }, requestOptions) {
|
|
588
|
+
validateRequired("path", "customGetWithHTTPInfo", path);
|
|
589
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
590
|
+
const headers = {};
|
|
591
|
+
const queryParameters = parameters ? parameters : {};
|
|
592
|
+
const request = {
|
|
593
|
+
method: "GET",
|
|
594
|
+
path: requestPath,
|
|
595
|
+
queryParameters,
|
|
596
|
+
headers
|
|
597
|
+
};
|
|
598
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
599
|
+
},
|
|
374
600
|
/**
|
|
375
601
|
* This method lets you send requests to the Algolia REST API.
|
|
376
602
|
* @param customPost - The customPost object.
|
|
@@ -393,6 +619,31 @@ function createIngestionClient({
|
|
|
393
619
|
};
|
|
394
620
|
return transporter.request(request, requestOptions);
|
|
395
621
|
},
|
|
622
|
+
/**
|
|
623
|
+
* This method lets you send requests to the Algolia REST API.
|
|
624
|
+
*
|
|
625
|
+
* 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
|
+
* @param customPost - The customPost object.
|
|
627
|
+
* @param customPost.path - Path of the endpoint, for example `1/newFeature`.
|
|
628
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
629
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
630
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
631
|
+
* @see customPost for the plain version.
|
|
632
|
+
*/
|
|
633
|
+
customPostWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
634
|
+
validateRequired("path", "customPostWithHTTPInfo", path);
|
|
635
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
636
|
+
const headers = {};
|
|
637
|
+
const queryParameters = parameters ? parameters : {};
|
|
638
|
+
const request = {
|
|
639
|
+
method: "POST",
|
|
640
|
+
path: requestPath,
|
|
641
|
+
queryParameters,
|
|
642
|
+
headers,
|
|
643
|
+
data: body ? body : {}
|
|
644
|
+
};
|
|
645
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
646
|
+
},
|
|
396
647
|
/**
|
|
397
648
|
* This method lets you send requests to the Algolia REST API.
|
|
398
649
|
* @param customPut - The customPut object.
|
|
@@ -415,6 +666,31 @@ function createIngestionClient({
|
|
|
415
666
|
};
|
|
416
667
|
return transporter.request(request, requestOptions);
|
|
417
668
|
},
|
|
669
|
+
/**
|
|
670
|
+
* This method lets you send requests to the Algolia REST API.
|
|
671
|
+
*
|
|
672
|
+
* 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.
|
|
673
|
+
* @param customPut - The customPut object.
|
|
674
|
+
* @param customPut.path - Path of the endpoint, for example `1/newFeature`.
|
|
675
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
676
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
677
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
678
|
+
* @see customPut for the plain version.
|
|
679
|
+
*/
|
|
680
|
+
customPutWithHTTPInfo({ path, parameters, body }, requestOptions) {
|
|
681
|
+
validateRequired("path", "customPutWithHTTPInfo", path);
|
|
682
|
+
const requestPath = "/{path}".replace("{path}", path);
|
|
683
|
+
const headers = {};
|
|
684
|
+
const queryParameters = parameters ? parameters : {};
|
|
685
|
+
const request = {
|
|
686
|
+
method: "PUT",
|
|
687
|
+
path: requestPath,
|
|
688
|
+
queryParameters,
|
|
689
|
+
headers,
|
|
690
|
+
data: body ? body : {}
|
|
691
|
+
};
|
|
692
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
693
|
+
},
|
|
418
694
|
/**
|
|
419
695
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
420
696
|
*
|
|
@@ -443,21 +719,24 @@ function createIngestionClient({
|
|
|
443
719
|
return transporter.request(request, requestOptions);
|
|
444
720
|
},
|
|
445
721
|
/**
|
|
446
|
-
* Deletes
|
|
722
|
+
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
723
|
+
*
|
|
724
|
+
* 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.
|
|
447
725
|
*
|
|
448
726
|
* Required API Key ACLs:
|
|
449
727
|
* - addObject
|
|
450
728
|
* - deleteIndex
|
|
451
729
|
* - editSettings
|
|
452
|
-
* @param
|
|
453
|
-
* @param
|
|
730
|
+
* @param deleteAuthentication - The deleteAuthentication object.
|
|
731
|
+
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
454
732
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
733
|
+
* @see deleteAuthentication for the plain version.
|
|
455
734
|
*/
|
|
456
|
-
|
|
457
|
-
validateRequired("
|
|
458
|
-
const requestPath = "/1/
|
|
459
|
-
"{
|
|
460
|
-
encodeURIComponent(
|
|
735
|
+
deleteAuthenticationWithHTTPInfo({ authenticationID }, requestOptions) {
|
|
736
|
+
validateRequired("authenticationID", "deleteAuthenticationWithHTTPInfo", authenticationID);
|
|
737
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
738
|
+
"{authenticationID}",
|
|
739
|
+
encodeURIComponent(authenticationID)
|
|
461
740
|
);
|
|
462
741
|
const headers = {};
|
|
463
742
|
const queryParameters = {};
|
|
@@ -467,22 +746,25 @@ function createIngestionClient({
|
|
|
467
746
|
queryParameters,
|
|
468
747
|
headers
|
|
469
748
|
};
|
|
470
|
-
return transporter.
|
|
749
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
471
750
|
},
|
|
472
751
|
/**
|
|
473
|
-
* Deletes a
|
|
752
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
474
753
|
*
|
|
475
754
|
* Required API Key ACLs:
|
|
476
755
|
* - addObject
|
|
477
756
|
* - deleteIndex
|
|
478
757
|
* - editSettings
|
|
479
|
-
* @param
|
|
480
|
-
* @param
|
|
758
|
+
* @param deleteDestination - The deleteDestination object.
|
|
759
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
481
760
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
482
761
|
*/
|
|
483
|
-
|
|
484
|
-
validateRequired("
|
|
485
|
-
const requestPath = "/1/
|
|
762
|
+
deleteDestination({ destinationID }, requestOptions) {
|
|
763
|
+
validateRequired("destinationID", "deleteDestination", destinationID);
|
|
764
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
765
|
+
"{destinationID}",
|
|
766
|
+
encodeURIComponent(destinationID)
|
|
767
|
+
);
|
|
486
768
|
const headers = {};
|
|
487
769
|
const queryParameters = {};
|
|
488
770
|
const request = {
|
|
@@ -494,19 +776,25 @@ function createIngestionClient({
|
|
|
494
776
|
return transporter.request(request, requestOptions);
|
|
495
777
|
},
|
|
496
778
|
/**
|
|
497
|
-
* Deletes a
|
|
779
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
780
|
+
*
|
|
781
|
+
* 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.
|
|
498
782
|
*
|
|
499
783
|
* Required API Key ACLs:
|
|
500
784
|
* - addObject
|
|
501
785
|
* - deleteIndex
|
|
502
786
|
* - editSettings
|
|
503
|
-
* @param
|
|
504
|
-
* @param
|
|
787
|
+
* @param deleteDestination - The deleteDestination object.
|
|
788
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
505
789
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
790
|
+
* @see deleteDestination for the plain version.
|
|
506
791
|
*/
|
|
507
|
-
|
|
508
|
-
validateRequired("
|
|
509
|
-
const requestPath = "/
|
|
792
|
+
deleteDestinationWithHTTPInfo({ destinationID }, requestOptions) {
|
|
793
|
+
validateRequired("destinationID", "deleteDestinationWithHTTPInfo", destinationID);
|
|
794
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
795
|
+
"{destinationID}",
|
|
796
|
+
encodeURIComponent(destinationID)
|
|
797
|
+
);
|
|
510
798
|
const headers = {};
|
|
511
799
|
const queryParameters = {};
|
|
512
800
|
const request = {
|
|
@@ -515,24 +803,22 @@ function createIngestionClient({
|
|
|
515
803
|
queryParameters,
|
|
516
804
|
headers
|
|
517
805
|
};
|
|
518
|
-
return transporter.
|
|
806
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
519
807
|
},
|
|
520
808
|
/**
|
|
521
|
-
* Deletes a
|
|
809
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
522
810
|
*
|
|
523
811
|
* Required API Key ACLs:
|
|
524
812
|
* - addObject
|
|
525
813
|
* - deleteIndex
|
|
526
814
|
* - editSettings
|
|
527
|
-
*
|
|
528
|
-
* @
|
|
529
|
-
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
530
|
-
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
815
|
+
* @param deleteSource - The deleteSource object.
|
|
816
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
531
817
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
532
818
|
*/
|
|
533
|
-
|
|
534
|
-
validateRequired("
|
|
535
|
-
const requestPath = "/1/
|
|
819
|
+
deleteSource({ sourceID }, requestOptions) {
|
|
820
|
+
validateRequired("sourceID", "deleteSource", sourceID);
|
|
821
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
536
822
|
const headers = {};
|
|
537
823
|
const queryParameters = {};
|
|
538
824
|
const request = {
|
|
@@ -544,22 +830,22 @@ function createIngestionClient({
|
|
|
544
830
|
return transporter.request(request, requestOptions);
|
|
545
831
|
},
|
|
546
832
|
/**
|
|
547
|
-
* Deletes a
|
|
833
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
834
|
+
*
|
|
835
|
+
* 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.
|
|
548
836
|
*
|
|
549
837
|
* Required API Key ACLs:
|
|
550
838
|
* - addObject
|
|
551
839
|
* - deleteIndex
|
|
552
840
|
* - editSettings
|
|
553
|
-
* @param
|
|
554
|
-
* @param
|
|
841
|
+
* @param deleteSource - The deleteSource object.
|
|
842
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
555
843
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
844
|
+
* @see deleteSource for the plain version.
|
|
556
845
|
*/
|
|
557
|
-
|
|
558
|
-
validateRequired("
|
|
559
|
-
const requestPath = "/1/
|
|
560
|
-
"{transformationID}",
|
|
561
|
-
encodeURIComponent(transformationID)
|
|
562
|
-
);
|
|
846
|
+
deleteSourceWithHTTPInfo({ sourceID }, requestOptions) {
|
|
847
|
+
validateRequired("sourceID", "deleteSourceWithHTTPInfo", sourceID);
|
|
848
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
563
849
|
const headers = {};
|
|
564
850
|
const queryParameters = {};
|
|
565
851
|
const request = {
|
|
@@ -568,26 +854,26 @@ function createIngestionClient({
|
|
|
568
854
|
queryParameters,
|
|
569
855
|
headers
|
|
570
856
|
};
|
|
571
|
-
return transporter.
|
|
857
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
572
858
|
},
|
|
573
859
|
/**
|
|
574
|
-
*
|
|
860
|
+
* Deletes a task by its ID.
|
|
575
861
|
*
|
|
576
862
|
* Required API Key ACLs:
|
|
577
863
|
* - addObject
|
|
578
864
|
* - deleteIndex
|
|
579
865
|
* - editSettings
|
|
580
|
-
* @param
|
|
581
|
-
* @param
|
|
866
|
+
* @param deleteTask - The deleteTask object.
|
|
867
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
582
868
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
583
869
|
*/
|
|
584
|
-
|
|
585
|
-
validateRequired("taskID", "
|
|
586
|
-
const requestPath = "/2/tasks/{taskID}
|
|
870
|
+
deleteTask({ taskID }, requestOptions) {
|
|
871
|
+
validateRequired("taskID", "deleteTask", taskID);
|
|
872
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
587
873
|
const headers = {};
|
|
588
874
|
const queryParameters = {};
|
|
589
875
|
const request = {
|
|
590
|
-
method: "
|
|
876
|
+
method: "DELETE",
|
|
591
877
|
path: requestPath,
|
|
592
878
|
queryParameters,
|
|
593
879
|
headers
|
|
@@ -595,49 +881,52 @@ function createIngestionClient({
|
|
|
595
881
|
return transporter.request(request, requestOptions);
|
|
596
882
|
},
|
|
597
883
|
/**
|
|
598
|
-
*
|
|
884
|
+
* Deletes a task by its ID.
|
|
885
|
+
*
|
|
886
|
+
* 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.
|
|
599
887
|
*
|
|
600
888
|
* Required API Key ACLs:
|
|
601
889
|
* - addObject
|
|
602
890
|
* - deleteIndex
|
|
603
891
|
* - editSettings
|
|
604
|
-
*
|
|
605
|
-
* @
|
|
606
|
-
* @param disableTaskV1 - The disableTaskV1 object.
|
|
607
|
-
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
892
|
+
* @param deleteTask - The deleteTask object.
|
|
893
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
608
894
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
895
|
+
* @see deleteTask for the plain version.
|
|
609
896
|
*/
|
|
610
|
-
|
|
611
|
-
validateRequired("taskID", "
|
|
612
|
-
const requestPath = "/
|
|
897
|
+
deleteTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
898
|
+
validateRequired("taskID", "deleteTaskWithHTTPInfo", taskID);
|
|
899
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
613
900
|
const headers = {};
|
|
614
901
|
const queryParameters = {};
|
|
615
902
|
const request = {
|
|
616
|
-
method: "
|
|
903
|
+
method: "DELETE",
|
|
617
904
|
path: requestPath,
|
|
618
905
|
queryParameters,
|
|
619
906
|
headers
|
|
620
907
|
};
|
|
621
|
-
return transporter.
|
|
908
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
622
909
|
},
|
|
623
910
|
/**
|
|
624
|
-
*
|
|
911
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
625
912
|
*
|
|
626
913
|
* Required API Key ACLs:
|
|
627
914
|
* - addObject
|
|
628
915
|
* - deleteIndex
|
|
629
916
|
* - editSettings
|
|
630
|
-
*
|
|
631
|
-
* @
|
|
917
|
+
*
|
|
918
|
+
* @deprecated
|
|
919
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
920
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
632
921
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
633
922
|
*/
|
|
634
|
-
|
|
635
|
-
validateRequired("taskID", "
|
|
636
|
-
const requestPath = "/
|
|
923
|
+
deleteTaskV1({ taskID }, requestOptions) {
|
|
924
|
+
validateRequired("taskID", "deleteTaskV1", taskID);
|
|
925
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
637
926
|
const headers = {};
|
|
638
927
|
const queryParameters = {};
|
|
639
928
|
const request = {
|
|
640
|
-
method: "
|
|
929
|
+
method: "DELETE",
|
|
641
930
|
path: requestPath,
|
|
642
931
|
queryParameters,
|
|
643
932
|
headers
|
|
@@ -645,7 +934,9 @@ function createIngestionClient({
|
|
|
645
934
|
return transporter.request(request, requestOptions);
|
|
646
935
|
},
|
|
647
936
|
/**
|
|
648
|
-
*
|
|
937
|
+
* Deletes a task by its ID using the v1 endpoint. Use `deleteTask` instead.
|
|
938
|
+
*
|
|
939
|
+
* Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and deserialized data. Bypasses the requests and responses caches: always performs the API call.
|
|
649
940
|
*
|
|
650
941
|
* Required API Key ACLs:
|
|
651
942
|
* - addObject
|
|
@@ -653,44 +944,45 @@ function createIngestionClient({
|
|
|
653
944
|
* - editSettings
|
|
654
945
|
*
|
|
655
946
|
* @deprecated
|
|
656
|
-
* @param
|
|
657
|
-
* @param
|
|
947
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
948
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
658
949
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
950
|
+
* @see deleteTaskV1 for the plain version.
|
|
659
951
|
*/
|
|
660
|
-
|
|
661
|
-
validateRequired("taskID", "
|
|
662
|
-
const requestPath = "/1/tasks/{taskID}
|
|
952
|
+
deleteTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
953
|
+
validateRequired("taskID", "deleteTaskV1WithHTTPInfo", taskID);
|
|
954
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
663
955
|
const headers = {};
|
|
664
956
|
const queryParameters = {};
|
|
665
957
|
const request = {
|
|
666
|
-
method: "
|
|
958
|
+
method: "DELETE",
|
|
667
959
|
path: requestPath,
|
|
668
960
|
queryParameters,
|
|
669
961
|
headers
|
|
670
962
|
};
|
|
671
|
-
return transporter.
|
|
963
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
672
964
|
},
|
|
673
965
|
/**
|
|
674
|
-
*
|
|
966
|
+
* Deletes a transformation by its ID.
|
|
675
967
|
*
|
|
676
968
|
* Required API Key ACLs:
|
|
677
969
|
* - addObject
|
|
678
970
|
* - deleteIndex
|
|
679
971
|
* - editSettings
|
|
680
|
-
* @param
|
|
681
|
-
* @param
|
|
972
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
973
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
682
974
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
683
975
|
*/
|
|
684
|
-
|
|
685
|
-
validateRequired("
|
|
686
|
-
const requestPath = "/1/
|
|
687
|
-
"{
|
|
688
|
-
encodeURIComponent(
|
|
976
|
+
deleteTransformation({ transformationID }, requestOptions) {
|
|
977
|
+
validateRequired("transformationID", "deleteTransformation", transformationID);
|
|
978
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
979
|
+
"{transformationID}",
|
|
980
|
+
encodeURIComponent(transformationID)
|
|
689
981
|
);
|
|
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
|
|
@@ -698,52 +990,53 @@ function createIngestionClient({
|
|
|
698
990
|
return transporter.request(request, requestOptions);
|
|
699
991
|
},
|
|
700
992
|
/**
|
|
701
|
-
*
|
|
993
|
+
* Deletes a transformation by its ID.
|
|
994
|
+
*
|
|
995
|
+
* 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.
|
|
702
996
|
*
|
|
703
997
|
* Required API Key ACLs:
|
|
704
998
|
* - addObject
|
|
705
999
|
* - deleteIndex
|
|
706
1000
|
* - editSettings
|
|
707
|
-
* @param
|
|
708
|
-
* @param
|
|
1001
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
1002
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
709
1003
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1004
|
+
* @see deleteTransformation for the plain version.
|
|
710
1005
|
*/
|
|
711
|
-
|
|
712
|
-
validateRequired("
|
|
713
|
-
const requestPath = "/1/
|
|
714
|
-
"{
|
|
715
|
-
encodeURIComponent(
|
|
1006
|
+
deleteTransformationWithHTTPInfo({ transformationID }, requestOptions) {
|
|
1007
|
+
validateRequired("transformationID", "deleteTransformationWithHTTPInfo", transformationID);
|
|
1008
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1009
|
+
"{transformationID}",
|
|
1010
|
+
encodeURIComponent(transformationID)
|
|
716
1011
|
);
|
|
717
1012
|
const headers = {};
|
|
718
1013
|
const queryParameters = {};
|
|
719
1014
|
const request = {
|
|
720
|
-
method: "
|
|
1015
|
+
method: "DELETE",
|
|
721
1016
|
path: requestPath,
|
|
722
1017
|
queryParameters,
|
|
723
1018
|
headers
|
|
724
1019
|
};
|
|
725
|
-
return transporter.
|
|
1020
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
726
1021
|
},
|
|
727
1022
|
/**
|
|
728
|
-
*
|
|
1023
|
+
* Disables a task.
|
|
729
1024
|
*
|
|
730
1025
|
* Required API Key ACLs:
|
|
731
1026
|
* - addObject
|
|
732
1027
|
* - deleteIndex
|
|
733
1028
|
* - editSettings
|
|
734
|
-
* @param
|
|
735
|
-
* @param
|
|
736
|
-
* @param getEvent.eventID - Unique identifier of an event.
|
|
1029
|
+
* @param disableTask - The disableTask object.
|
|
1030
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
737
1031
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
738
1032
|
*/
|
|
739
|
-
|
|
740
|
-
validateRequired("
|
|
741
|
-
|
|
742
|
-
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1033
|
+
disableTask({ taskID }, requestOptions) {
|
|
1034
|
+
validateRequired("taskID", "disableTask", taskID);
|
|
1035
|
+
const requestPath = "/2/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
743
1036
|
const headers = {};
|
|
744
1037
|
const queryParameters = {};
|
|
745
1038
|
const request = {
|
|
746
|
-
method: "
|
|
1039
|
+
method: "PUT",
|
|
747
1040
|
path: requestPath,
|
|
748
1041
|
queryParameters,
|
|
749
1042
|
headers
|
|
@@ -751,47 +1044,52 @@ function createIngestionClient({
|
|
|
751
1044
|
return transporter.request(request, requestOptions);
|
|
752
1045
|
},
|
|
753
1046
|
/**
|
|
754
|
-
*
|
|
1047
|
+
* Disables a task.
|
|
1048
|
+
*
|
|
1049
|
+
* 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.
|
|
755
1050
|
*
|
|
756
1051
|
* Required API Key ACLs:
|
|
757
1052
|
* - addObject
|
|
758
1053
|
* - deleteIndex
|
|
759
1054
|
* - editSettings
|
|
760
|
-
* @param
|
|
761
|
-
* @param
|
|
1055
|
+
* @param disableTask - The disableTask object.
|
|
1056
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
762
1057
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1058
|
+
* @see disableTask for the plain version.
|
|
763
1059
|
*/
|
|
764
|
-
|
|
765
|
-
validateRequired("
|
|
766
|
-
const requestPath = "/
|
|
1060
|
+
disableTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1061
|
+
validateRequired("taskID", "disableTaskWithHTTPInfo", taskID);
|
|
1062
|
+
const requestPath = "/2/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
767
1063
|
const headers = {};
|
|
768
1064
|
const queryParameters = {};
|
|
769
1065
|
const request = {
|
|
770
|
-
method: "
|
|
1066
|
+
method: "PUT",
|
|
771
1067
|
path: requestPath,
|
|
772
1068
|
queryParameters,
|
|
773
1069
|
headers
|
|
774
1070
|
};
|
|
775
|
-
return transporter.
|
|
1071
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
776
1072
|
},
|
|
777
1073
|
/**
|
|
778
|
-
*
|
|
1074
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
779
1075
|
*
|
|
780
1076
|
* Required API Key ACLs:
|
|
781
1077
|
* - addObject
|
|
782
1078
|
* - deleteIndex
|
|
783
1079
|
* - editSettings
|
|
784
|
-
*
|
|
785
|
-
* @
|
|
1080
|
+
*
|
|
1081
|
+
* @deprecated
|
|
1082
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
1083
|
+
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
786
1084
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
787
1085
|
*/
|
|
788
|
-
|
|
789
|
-
validateRequired("
|
|
790
|
-
const requestPath = "/1/
|
|
1086
|
+
disableTaskV1({ taskID }, requestOptions) {
|
|
1087
|
+
validateRequired("taskID", "disableTaskV1", taskID);
|
|
1088
|
+
const requestPath = "/1/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
791
1089
|
const headers = {};
|
|
792
1090
|
const queryParameters = {};
|
|
793
1091
|
const request = {
|
|
794
|
-
method: "
|
|
1092
|
+
method: "PUT",
|
|
795
1093
|
path: requestPath,
|
|
796
1094
|
queryParameters,
|
|
797
1095
|
headers
|
|
@@ -799,49 +1097,52 @@ function createIngestionClient({
|
|
|
799
1097
|
return transporter.request(request, requestOptions);
|
|
800
1098
|
},
|
|
801
1099
|
/**
|
|
802
|
-
*
|
|
1100
|
+
* Disables a task using the v1 endpoint. Use `disableTask` instead.
|
|
1101
|
+
*
|
|
1102
|
+
* 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.
|
|
803
1103
|
*
|
|
804
1104
|
* Required API Key ACLs:
|
|
805
1105
|
* - addObject
|
|
806
1106
|
* - deleteIndex
|
|
807
1107
|
* - editSettings
|
|
808
|
-
*
|
|
809
|
-
* @
|
|
1108
|
+
*
|
|
1109
|
+
* @deprecated
|
|
1110
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
1111
|
+
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
810
1112
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1113
|
+
* @see disableTaskV1 for the plain version.
|
|
811
1114
|
*/
|
|
812
|
-
|
|
813
|
-
validateRequired("taskID", "
|
|
814
|
-
const requestPath = "/
|
|
1115
|
+
disableTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1116
|
+
validateRequired("taskID", "disableTaskV1WithHTTPInfo", taskID);
|
|
1117
|
+
const requestPath = "/1/tasks/{taskID}/disable".replace("{taskID}", encodeURIComponent(taskID));
|
|
815
1118
|
const headers = {};
|
|
816
1119
|
const queryParameters = {};
|
|
817
1120
|
const request = {
|
|
818
|
-
method: "
|
|
1121
|
+
method: "PUT",
|
|
819
1122
|
path: requestPath,
|
|
820
1123
|
queryParameters,
|
|
821
1124
|
headers
|
|
822
1125
|
};
|
|
823
|
-
return transporter.
|
|
1126
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
824
1127
|
},
|
|
825
1128
|
/**
|
|
826
|
-
*
|
|
1129
|
+
* Enables a task.
|
|
827
1130
|
*
|
|
828
1131
|
* Required API Key ACLs:
|
|
829
1132
|
* - addObject
|
|
830
1133
|
* - deleteIndex
|
|
831
1134
|
* - editSettings
|
|
832
|
-
*
|
|
833
|
-
* @
|
|
834
|
-
* @param getTaskV1 - The getTaskV1 object.
|
|
835
|
-
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1135
|
+
* @param enableTask - The enableTask object.
|
|
1136
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
836
1137
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
837
1138
|
*/
|
|
838
|
-
|
|
839
|
-
validateRequired("taskID", "
|
|
840
|
-
const requestPath = "/
|
|
1139
|
+
enableTask({ taskID }, requestOptions) {
|
|
1140
|
+
validateRequired("taskID", "enableTask", taskID);
|
|
1141
|
+
const requestPath = "/2/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
841
1142
|
const headers = {};
|
|
842
1143
|
const queryParameters = {};
|
|
843
1144
|
const request = {
|
|
844
|
-
method: "
|
|
1145
|
+
method: "PUT",
|
|
845
1146
|
path: requestPath,
|
|
846
1147
|
queryParameters,
|
|
847
1148
|
headers
|
|
@@ -849,72 +1150,660 @@ function createIngestionClient({
|
|
|
849
1150
|
return transporter.request(request, requestOptions);
|
|
850
1151
|
},
|
|
851
1152
|
/**
|
|
852
|
-
*
|
|
1153
|
+
* Enables a task.
|
|
1154
|
+
*
|
|
1155
|
+
* 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.
|
|
853
1156
|
*
|
|
854
1157
|
* Required API Key ACLs:
|
|
855
1158
|
* - addObject
|
|
856
1159
|
* - deleteIndex
|
|
857
1160
|
* - editSettings
|
|
858
|
-
* @param
|
|
859
|
-
* @param
|
|
1161
|
+
* @param enableTask - The enableTask object.
|
|
1162
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
860
1163
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1164
|
+
* @see enableTask for the plain version.
|
|
861
1165
|
*/
|
|
862
|
-
|
|
863
|
-
validateRequired("
|
|
864
|
-
const requestPath = "/
|
|
865
|
-
"{transformationID}",
|
|
866
|
-
encodeURIComponent(transformationID)
|
|
867
|
-
);
|
|
1166
|
+
enableTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1167
|
+
validateRequired("taskID", "enableTaskWithHTTPInfo", 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
|
|
875
1176
|
};
|
|
876
|
-
return transporter.
|
|
1177
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
877
1178
|
},
|
|
878
1179
|
/**
|
|
879
|
-
*
|
|
1180
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
880
1181
|
*
|
|
881
1182
|
* Required API Key ACLs:
|
|
882
1183
|
* - addObject
|
|
883
1184
|
* - deleteIndex
|
|
884
1185
|
* - editSettings
|
|
885
|
-
*
|
|
886
|
-
* @
|
|
887
|
-
* @param
|
|
888
|
-
* @param
|
|
889
|
-
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
890
|
-
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
891
|
-
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1186
|
+
*
|
|
1187
|
+
* @deprecated
|
|
1188
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
1189
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
892
1190
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
893
1191
|
*/
|
|
894
|
-
|
|
895
|
-
|
|
1192
|
+
enableTaskV1({ taskID }, requestOptions) {
|
|
1193
|
+
validateRequired("taskID", "enableTaskV1", taskID);
|
|
1194
|
+
const requestPath = "/1/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
896
1195
|
const headers = {};
|
|
897
1196
|
const queryParameters = {};
|
|
898
|
-
if (itemsPerPage !== void 0) {
|
|
899
|
-
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
900
|
-
}
|
|
901
|
-
if (page !== void 0) {
|
|
902
|
-
queryParameters["page"] = page.toString();
|
|
903
|
-
}
|
|
904
|
-
if (type !== void 0) {
|
|
905
|
-
queryParameters["type"] = type.toString();
|
|
906
|
-
}
|
|
907
|
-
if (platform !== void 0) {
|
|
908
|
-
queryParameters["platform"] = platform.toString();
|
|
909
|
-
}
|
|
910
|
-
if (sort !== void 0) {
|
|
911
|
-
queryParameters["sort"] = sort.toString();
|
|
912
|
-
}
|
|
913
|
-
if (order !== void 0) {
|
|
914
|
-
queryParameters["order"] = order.toString();
|
|
915
|
-
}
|
|
916
1197
|
const request = {
|
|
917
|
-
method: "
|
|
1198
|
+
method: "PUT",
|
|
1199
|
+
path: requestPath,
|
|
1200
|
+
queryParameters,
|
|
1201
|
+
headers
|
|
1202
|
+
};
|
|
1203
|
+
return transporter.request(request, requestOptions);
|
|
1204
|
+
},
|
|
1205
|
+
/**
|
|
1206
|
+
* Enables a task using the v1 endpoint. Use `enableTask` instead.
|
|
1207
|
+
*
|
|
1208
|
+
* 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.
|
|
1209
|
+
*
|
|
1210
|
+
* Required API Key ACLs:
|
|
1211
|
+
* - addObject
|
|
1212
|
+
* - deleteIndex
|
|
1213
|
+
* - editSettings
|
|
1214
|
+
*
|
|
1215
|
+
* @deprecated
|
|
1216
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
1217
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
1218
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1219
|
+
* @see enableTaskV1 for the plain version.
|
|
1220
|
+
*/
|
|
1221
|
+
enableTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1222
|
+
validateRequired("taskID", "enableTaskV1WithHTTPInfo", taskID);
|
|
1223
|
+
const requestPath = "/1/tasks/{taskID}/enable".replace("{taskID}", encodeURIComponent(taskID));
|
|
1224
|
+
const headers = {};
|
|
1225
|
+
const queryParameters = {};
|
|
1226
|
+
const request = {
|
|
1227
|
+
method: "PUT",
|
|
1228
|
+
path: requestPath,
|
|
1229
|
+
queryParameters,
|
|
1230
|
+
headers
|
|
1231
|
+
};
|
|
1232
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1233
|
+
},
|
|
1234
|
+
/**
|
|
1235
|
+
* Retrieves an authentication resource by its ID.
|
|
1236
|
+
*
|
|
1237
|
+
* Required API Key ACLs:
|
|
1238
|
+
* - addObject
|
|
1239
|
+
* - deleteIndex
|
|
1240
|
+
* - editSettings
|
|
1241
|
+
* @param getAuthentication - The getAuthentication object.
|
|
1242
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1243
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1244
|
+
*/
|
|
1245
|
+
getAuthentication({ authenticationID }, requestOptions) {
|
|
1246
|
+
validateRequired("authenticationID", "getAuthentication", authenticationID);
|
|
1247
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
1248
|
+
"{authenticationID}",
|
|
1249
|
+
encodeURIComponent(authenticationID)
|
|
1250
|
+
);
|
|
1251
|
+
const headers = {};
|
|
1252
|
+
const queryParameters = {};
|
|
1253
|
+
const request = {
|
|
1254
|
+
method: "GET",
|
|
1255
|
+
path: requestPath,
|
|
1256
|
+
queryParameters,
|
|
1257
|
+
headers
|
|
1258
|
+
};
|
|
1259
|
+
return transporter.request(request, requestOptions);
|
|
1260
|
+
},
|
|
1261
|
+
/**
|
|
1262
|
+
* Retrieves an authentication resource by its ID.
|
|
1263
|
+
*
|
|
1264
|
+
* 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.
|
|
1265
|
+
*
|
|
1266
|
+
* Required API Key ACLs:
|
|
1267
|
+
* - addObject
|
|
1268
|
+
* - deleteIndex
|
|
1269
|
+
* - editSettings
|
|
1270
|
+
* @param getAuthentication - The getAuthentication object.
|
|
1271
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1272
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1273
|
+
* @see getAuthentication for the plain version.
|
|
1274
|
+
*/
|
|
1275
|
+
getAuthenticationWithHTTPInfo({ authenticationID }, requestOptions) {
|
|
1276
|
+
validateRequired("authenticationID", "getAuthenticationWithHTTPInfo", authenticationID);
|
|
1277
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
1278
|
+
"{authenticationID}",
|
|
1279
|
+
encodeURIComponent(authenticationID)
|
|
1280
|
+
);
|
|
1281
|
+
const headers = {};
|
|
1282
|
+
const queryParameters = {};
|
|
1283
|
+
const request = {
|
|
1284
|
+
method: "GET",
|
|
1285
|
+
path: requestPath,
|
|
1286
|
+
queryParameters,
|
|
1287
|
+
headers
|
|
1288
|
+
};
|
|
1289
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1290
|
+
},
|
|
1291
|
+
/**
|
|
1292
|
+
* Retrieves a destination by its ID.
|
|
1293
|
+
*
|
|
1294
|
+
* Required API Key ACLs:
|
|
1295
|
+
* - addObject
|
|
1296
|
+
* - deleteIndex
|
|
1297
|
+
* - editSettings
|
|
1298
|
+
* @param getDestination - The getDestination object.
|
|
1299
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
1300
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1301
|
+
*/
|
|
1302
|
+
getDestination({ destinationID }, requestOptions) {
|
|
1303
|
+
validateRequired("destinationID", "getDestination", destinationID);
|
|
1304
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
1305
|
+
"{destinationID}",
|
|
1306
|
+
encodeURIComponent(destinationID)
|
|
1307
|
+
);
|
|
1308
|
+
const headers = {};
|
|
1309
|
+
const queryParameters = {};
|
|
1310
|
+
const request = {
|
|
1311
|
+
method: "GET",
|
|
1312
|
+
path: requestPath,
|
|
1313
|
+
queryParameters,
|
|
1314
|
+
headers
|
|
1315
|
+
};
|
|
1316
|
+
return transporter.request(request, requestOptions);
|
|
1317
|
+
},
|
|
1318
|
+
/**
|
|
1319
|
+
* Retrieves a destination by its ID.
|
|
1320
|
+
*
|
|
1321
|
+
* 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.
|
|
1322
|
+
*
|
|
1323
|
+
* Required API Key ACLs:
|
|
1324
|
+
* - addObject
|
|
1325
|
+
* - deleteIndex
|
|
1326
|
+
* - editSettings
|
|
1327
|
+
* @param getDestination - The getDestination object.
|
|
1328
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
1329
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1330
|
+
* @see getDestination for the plain version.
|
|
1331
|
+
*/
|
|
1332
|
+
getDestinationWithHTTPInfo({ destinationID }, requestOptions) {
|
|
1333
|
+
validateRequired("destinationID", "getDestinationWithHTTPInfo", destinationID);
|
|
1334
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
1335
|
+
"{destinationID}",
|
|
1336
|
+
encodeURIComponent(destinationID)
|
|
1337
|
+
);
|
|
1338
|
+
const headers = {};
|
|
1339
|
+
const queryParameters = {};
|
|
1340
|
+
const request = {
|
|
1341
|
+
method: "GET",
|
|
1342
|
+
path: requestPath,
|
|
1343
|
+
queryParameters,
|
|
1344
|
+
headers
|
|
1345
|
+
};
|
|
1346
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1347
|
+
},
|
|
1348
|
+
/**
|
|
1349
|
+
* Retrieves a single task run event by its ID.
|
|
1350
|
+
*
|
|
1351
|
+
* Required API Key ACLs:
|
|
1352
|
+
* - addObject
|
|
1353
|
+
* - deleteIndex
|
|
1354
|
+
* - editSettings
|
|
1355
|
+
* @param getEvent - The getEvent object.
|
|
1356
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
1357
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
1358
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1359
|
+
*/
|
|
1360
|
+
getEvent({ runID, eventID }, requestOptions) {
|
|
1361
|
+
validateRequired("runID", "getEvent", runID);
|
|
1362
|
+
validateRequired("eventID", "getEvent", eventID);
|
|
1363
|
+
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1364
|
+
const headers = {};
|
|
1365
|
+
const queryParameters = {};
|
|
1366
|
+
const request = {
|
|
1367
|
+
method: "GET",
|
|
1368
|
+
path: requestPath,
|
|
1369
|
+
queryParameters,
|
|
1370
|
+
headers
|
|
1371
|
+
};
|
|
1372
|
+
return transporter.request(request, requestOptions);
|
|
1373
|
+
},
|
|
1374
|
+
/**
|
|
1375
|
+
* Retrieves a single task run event by its ID.
|
|
1376
|
+
*
|
|
1377
|
+
* 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.
|
|
1378
|
+
*
|
|
1379
|
+
* Required API Key ACLs:
|
|
1380
|
+
* - addObject
|
|
1381
|
+
* - deleteIndex
|
|
1382
|
+
* - editSettings
|
|
1383
|
+
* @param getEvent - The getEvent object.
|
|
1384
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
1385
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
1386
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1387
|
+
* @see getEvent for the plain version.
|
|
1388
|
+
*/
|
|
1389
|
+
getEventWithHTTPInfo({ runID, eventID }, requestOptions) {
|
|
1390
|
+
validateRequired("runID", "getEventWithHTTPInfo", runID);
|
|
1391
|
+
validateRequired("eventID", "getEventWithHTTPInfo", eventID);
|
|
1392
|
+
const requestPath = "/1/runs/{runID}/events/{eventID}".replace("{runID}", encodeURIComponent(runID)).replace("{eventID}", encodeURIComponent(eventID));
|
|
1393
|
+
const headers = {};
|
|
1394
|
+
const queryParameters = {};
|
|
1395
|
+
const request = {
|
|
1396
|
+
method: "GET",
|
|
1397
|
+
path: requestPath,
|
|
1398
|
+
queryParameters,
|
|
1399
|
+
headers
|
|
1400
|
+
};
|
|
1401
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1402
|
+
},
|
|
1403
|
+
/**
|
|
1404
|
+
* Retrieve a single task run by its ID.
|
|
1405
|
+
*
|
|
1406
|
+
* Required API Key ACLs:
|
|
1407
|
+
* - addObject
|
|
1408
|
+
* - deleteIndex
|
|
1409
|
+
* - editSettings
|
|
1410
|
+
* @param getRun - The getRun object.
|
|
1411
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
1412
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1413
|
+
*/
|
|
1414
|
+
getRun({ runID }, requestOptions) {
|
|
1415
|
+
validateRequired("runID", "getRun", runID);
|
|
1416
|
+
const requestPath = "/1/runs/{runID}".replace("{runID}", encodeURIComponent(runID));
|
|
1417
|
+
const headers = {};
|
|
1418
|
+
const queryParameters = {};
|
|
1419
|
+
const request = {
|
|
1420
|
+
method: "GET",
|
|
1421
|
+
path: requestPath,
|
|
1422
|
+
queryParameters,
|
|
1423
|
+
headers
|
|
1424
|
+
};
|
|
1425
|
+
return transporter.request(request, requestOptions);
|
|
1426
|
+
},
|
|
1427
|
+
/**
|
|
1428
|
+
* Retrieve a single task run by its ID.
|
|
1429
|
+
*
|
|
1430
|
+
* 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.
|
|
1431
|
+
*
|
|
1432
|
+
* Required API Key ACLs:
|
|
1433
|
+
* - addObject
|
|
1434
|
+
* - deleteIndex
|
|
1435
|
+
* - editSettings
|
|
1436
|
+
* @param getRun - The getRun object.
|
|
1437
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
1438
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1439
|
+
* @see getRun for the plain version.
|
|
1440
|
+
*/
|
|
1441
|
+
getRunWithHTTPInfo({ runID }, requestOptions) {
|
|
1442
|
+
validateRequired("runID", "getRunWithHTTPInfo", 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.requestWithHttpInfo(request, requestOptions);
|
|
1453
|
+
},
|
|
1454
|
+
/**
|
|
1455
|
+
* Retrieve a source by its ID.
|
|
1456
|
+
*
|
|
1457
|
+
* Required API Key ACLs:
|
|
1458
|
+
* - addObject
|
|
1459
|
+
* - deleteIndex
|
|
1460
|
+
* - editSettings
|
|
1461
|
+
* @param getSource - The getSource object.
|
|
1462
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
1463
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1464
|
+
*/
|
|
1465
|
+
getSource({ sourceID }, requestOptions) {
|
|
1466
|
+
validateRequired("sourceID", "getSource", sourceID);
|
|
1467
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1468
|
+
const headers = {};
|
|
1469
|
+
const queryParameters = {};
|
|
1470
|
+
const request = {
|
|
1471
|
+
method: "GET",
|
|
1472
|
+
path: requestPath,
|
|
1473
|
+
queryParameters,
|
|
1474
|
+
headers
|
|
1475
|
+
};
|
|
1476
|
+
return transporter.request(request, requestOptions);
|
|
1477
|
+
},
|
|
1478
|
+
/**
|
|
1479
|
+
* Retrieve a source by its ID.
|
|
1480
|
+
*
|
|
1481
|
+
* 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.
|
|
1482
|
+
*
|
|
1483
|
+
* Required API Key ACLs:
|
|
1484
|
+
* - addObject
|
|
1485
|
+
* - deleteIndex
|
|
1486
|
+
* - editSettings
|
|
1487
|
+
* @param getSource - The getSource object.
|
|
1488
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
1489
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1490
|
+
* @see getSource for the plain version.
|
|
1491
|
+
*/
|
|
1492
|
+
getSourceWithHTTPInfo({ sourceID }, requestOptions) {
|
|
1493
|
+
validateRequired("sourceID", "getSourceWithHTTPInfo", 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.requestWithHttpInfo(request, requestOptions);
|
|
1504
|
+
},
|
|
1505
|
+
/**
|
|
1506
|
+
* Retrieves a task by its ID.
|
|
1507
|
+
*
|
|
1508
|
+
* Required API Key ACLs:
|
|
1509
|
+
* - addObject
|
|
1510
|
+
* - deleteIndex
|
|
1511
|
+
* - editSettings
|
|
1512
|
+
* @param getTask - The getTask object.
|
|
1513
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
1514
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1515
|
+
*/
|
|
1516
|
+
getTask({ taskID }, requestOptions) {
|
|
1517
|
+
validateRequired("taskID", "getTask", taskID);
|
|
1518
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1519
|
+
const headers = {};
|
|
1520
|
+
const queryParameters = {};
|
|
1521
|
+
const request = {
|
|
1522
|
+
method: "GET",
|
|
1523
|
+
path: requestPath,
|
|
1524
|
+
queryParameters,
|
|
1525
|
+
headers
|
|
1526
|
+
};
|
|
1527
|
+
return transporter.request(request, requestOptions);
|
|
1528
|
+
},
|
|
1529
|
+
/**
|
|
1530
|
+
* Retrieves a task by its ID.
|
|
1531
|
+
*
|
|
1532
|
+
* 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.
|
|
1533
|
+
*
|
|
1534
|
+
* Required API Key ACLs:
|
|
1535
|
+
* - addObject
|
|
1536
|
+
* - deleteIndex
|
|
1537
|
+
* - editSettings
|
|
1538
|
+
* @param getTask - The getTask object.
|
|
1539
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
1540
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1541
|
+
* @see getTask for the plain version.
|
|
1542
|
+
*/
|
|
1543
|
+
getTaskWithHTTPInfo({ taskID }, requestOptions) {
|
|
1544
|
+
validateRequired("taskID", "getTaskWithHTTPInfo", 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.requestWithHttpInfo(request, requestOptions);
|
|
1555
|
+
},
|
|
1556
|
+
/**
|
|
1557
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
1558
|
+
*
|
|
1559
|
+
* Required API Key ACLs:
|
|
1560
|
+
* - addObject
|
|
1561
|
+
* - deleteIndex
|
|
1562
|
+
* - editSettings
|
|
1563
|
+
*
|
|
1564
|
+
* @deprecated
|
|
1565
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
1566
|
+
* @param getTaskV1.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
|
+
*/
|
|
1569
|
+
getTaskV1({ taskID }, requestOptions) {
|
|
1570
|
+
validateRequired("taskID", "getTaskV1", taskID);
|
|
1571
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1572
|
+
const headers = {};
|
|
1573
|
+
const queryParameters = {};
|
|
1574
|
+
const request = {
|
|
1575
|
+
method: "GET",
|
|
1576
|
+
path: requestPath,
|
|
1577
|
+
queryParameters,
|
|
1578
|
+
headers
|
|
1579
|
+
};
|
|
1580
|
+
return transporter.request(request, requestOptions);
|
|
1581
|
+
},
|
|
1582
|
+
/**
|
|
1583
|
+
* Retrieves a task by its ID using the v1 endpoint. Use `getTask` instead.
|
|
1584
|
+
*
|
|
1585
|
+
* 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.
|
|
1586
|
+
*
|
|
1587
|
+
* Required API Key ACLs:
|
|
1588
|
+
* - addObject
|
|
1589
|
+
* - deleteIndex
|
|
1590
|
+
* - editSettings
|
|
1591
|
+
*
|
|
1592
|
+
* @deprecated
|
|
1593
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
1594
|
+
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
1595
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1596
|
+
* @see getTaskV1 for the plain version.
|
|
1597
|
+
*/
|
|
1598
|
+
getTaskV1WithHTTPInfo({ taskID }, requestOptions) {
|
|
1599
|
+
validateRequired("taskID", "getTaskV1WithHTTPInfo", taskID);
|
|
1600
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
1601
|
+
const headers = {};
|
|
1602
|
+
const queryParameters = {};
|
|
1603
|
+
const request = {
|
|
1604
|
+
method: "GET",
|
|
1605
|
+
path: requestPath,
|
|
1606
|
+
queryParameters,
|
|
1607
|
+
headers
|
|
1608
|
+
};
|
|
1609
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1610
|
+
},
|
|
1611
|
+
/**
|
|
1612
|
+
* Retrieves a transformation by its ID.
|
|
1613
|
+
*
|
|
1614
|
+
* Required API Key ACLs:
|
|
1615
|
+
* - addObject
|
|
1616
|
+
* - deleteIndex
|
|
1617
|
+
* - editSettings
|
|
1618
|
+
* @param getTransformation - The getTransformation object.
|
|
1619
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
1620
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1621
|
+
*/
|
|
1622
|
+
getTransformation({ transformationID }, requestOptions) {
|
|
1623
|
+
validateRequired("transformationID", "getTransformation", transformationID);
|
|
1624
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1625
|
+
"{transformationID}",
|
|
1626
|
+
encodeURIComponent(transformationID)
|
|
1627
|
+
);
|
|
1628
|
+
const headers = {};
|
|
1629
|
+
const queryParameters = {};
|
|
1630
|
+
const request = {
|
|
1631
|
+
method: "GET",
|
|
1632
|
+
path: requestPath,
|
|
1633
|
+
queryParameters,
|
|
1634
|
+
headers
|
|
1635
|
+
};
|
|
1636
|
+
return transporter.request(request, requestOptions);
|
|
1637
|
+
},
|
|
1638
|
+
/**
|
|
1639
|
+
* Retrieves a transformation by its ID.
|
|
1640
|
+
*
|
|
1641
|
+
* 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.
|
|
1642
|
+
*
|
|
1643
|
+
* Required API Key ACLs:
|
|
1644
|
+
* - addObject
|
|
1645
|
+
* - deleteIndex
|
|
1646
|
+
* - editSettings
|
|
1647
|
+
* @param getTransformation - The getTransformation object.
|
|
1648
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
1649
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1650
|
+
* @see getTransformation for the plain version.
|
|
1651
|
+
*/
|
|
1652
|
+
getTransformationWithHTTPInfo({ transformationID }, requestOptions) {
|
|
1653
|
+
validateRequired("transformationID", "getTransformationWithHTTPInfo", transformationID);
|
|
1654
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
1655
|
+
"{transformationID}",
|
|
1656
|
+
encodeURIComponent(transformationID)
|
|
1657
|
+
);
|
|
1658
|
+
const headers = {};
|
|
1659
|
+
const queryParameters = {};
|
|
1660
|
+
const request = {
|
|
1661
|
+
method: "GET",
|
|
1662
|
+
path: requestPath,
|
|
1663
|
+
queryParameters,
|
|
1664
|
+
headers
|
|
1665
|
+
};
|
|
1666
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1667
|
+
},
|
|
1668
|
+
/**
|
|
1669
|
+
* Retrieves a list of all authentication resources.
|
|
1670
|
+
*
|
|
1671
|
+
* Required API Key ACLs:
|
|
1672
|
+
* - addObject
|
|
1673
|
+
* - deleteIndex
|
|
1674
|
+
* - editSettings
|
|
1675
|
+
* @param listAuthentications - The listAuthentications object.
|
|
1676
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
1677
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
1678
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
1679
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
1680
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
1681
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1682
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1683
|
+
*/
|
|
1684
|
+
listAuthentications({ itemsPerPage, page, type, platform, sort, order } = {}, requestOptions = void 0) {
|
|
1685
|
+
const requestPath = "/1/authentications";
|
|
1686
|
+
const headers = {};
|
|
1687
|
+
const queryParameters = {};
|
|
1688
|
+
if (itemsPerPage !== void 0) {
|
|
1689
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1690
|
+
}
|
|
1691
|
+
if (page !== void 0) {
|
|
1692
|
+
queryParameters["page"] = page.toString();
|
|
1693
|
+
}
|
|
1694
|
+
if (type !== void 0) {
|
|
1695
|
+
queryParameters["type"] = type.toString();
|
|
1696
|
+
}
|
|
1697
|
+
if (platform !== void 0) {
|
|
1698
|
+
queryParameters["platform"] = platform.toString();
|
|
1699
|
+
}
|
|
1700
|
+
if (sort !== void 0) {
|
|
1701
|
+
queryParameters["sort"] = sort.toString();
|
|
1702
|
+
}
|
|
1703
|
+
if (order !== void 0) {
|
|
1704
|
+
queryParameters["order"] = order.toString();
|
|
1705
|
+
}
|
|
1706
|
+
const request = {
|
|
1707
|
+
method: "GET",
|
|
1708
|
+
path: requestPath,
|
|
1709
|
+
queryParameters,
|
|
1710
|
+
headers
|
|
1711
|
+
};
|
|
1712
|
+
return transporter.request(request, requestOptions);
|
|
1713
|
+
},
|
|
1714
|
+
/**
|
|
1715
|
+
* Retrieves a list of all authentication resources.
|
|
1716
|
+
*
|
|
1717
|
+
* 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.
|
|
1718
|
+
*
|
|
1719
|
+
* Required API Key ACLs:
|
|
1720
|
+
* - addObject
|
|
1721
|
+
* - deleteIndex
|
|
1722
|
+
* - editSettings
|
|
1723
|
+
* @param listAuthentications - The listAuthentications object.
|
|
1724
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
1725
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
1726
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
1727
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
1728
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
1729
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
1730
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1731
|
+
* @see listAuthentications for the plain version.
|
|
1732
|
+
*/
|
|
1733
|
+
listAuthenticationsWithHTTPInfo({ itemsPerPage, page, type, platform, sort, order } = {}, requestOptions = void 0) {
|
|
1734
|
+
const requestPath = "/1/authentications";
|
|
1735
|
+
const headers = {};
|
|
1736
|
+
const queryParameters = {};
|
|
1737
|
+
if (itemsPerPage !== void 0) {
|
|
1738
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1739
|
+
}
|
|
1740
|
+
if (page !== void 0) {
|
|
1741
|
+
queryParameters["page"] = page.toString();
|
|
1742
|
+
}
|
|
1743
|
+
if (type !== void 0) {
|
|
1744
|
+
queryParameters["type"] = type.toString();
|
|
1745
|
+
}
|
|
1746
|
+
if (platform !== void 0) {
|
|
1747
|
+
queryParameters["platform"] = platform.toString();
|
|
1748
|
+
}
|
|
1749
|
+
if (sort !== void 0) {
|
|
1750
|
+
queryParameters["sort"] = sort.toString();
|
|
1751
|
+
}
|
|
1752
|
+
if (order !== void 0) {
|
|
1753
|
+
queryParameters["order"] = order.toString();
|
|
1754
|
+
}
|
|
1755
|
+
const request = {
|
|
1756
|
+
method: "GET",
|
|
1757
|
+
path: requestPath,
|
|
1758
|
+
queryParameters,
|
|
1759
|
+
headers
|
|
1760
|
+
};
|
|
1761
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1762
|
+
},
|
|
1763
|
+
/**
|
|
1764
|
+
* Retrieves a list of destinations.
|
|
1765
|
+
*
|
|
1766
|
+
* Required API Key ACLs:
|
|
1767
|
+
* - addObject
|
|
1768
|
+
* - deleteIndex
|
|
1769
|
+
* - editSettings
|
|
1770
|
+
* @param listDestinations - The listDestinations object.
|
|
1771
|
+
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
1772
|
+
* @param listDestinations.page - Page number of the paginated API response.
|
|
1773
|
+
* @param listDestinations.type - Destination type.
|
|
1774
|
+
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
1775
|
+
* @param listDestinations.transformationID - Get the list of destinations used by a transformation.
|
|
1776
|
+
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
1777
|
+
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
1778
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1779
|
+
*/
|
|
1780
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
1781
|
+
const requestPath = "/1/destinations";
|
|
1782
|
+
const headers = {};
|
|
1783
|
+
const queryParameters = {};
|
|
1784
|
+
if (itemsPerPage !== void 0) {
|
|
1785
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1786
|
+
}
|
|
1787
|
+
if (page !== void 0) {
|
|
1788
|
+
queryParameters["page"] = page.toString();
|
|
1789
|
+
}
|
|
1790
|
+
if (type !== void 0) {
|
|
1791
|
+
queryParameters["type"] = type.toString();
|
|
1792
|
+
}
|
|
1793
|
+
if (authenticationID !== void 0) {
|
|
1794
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1795
|
+
}
|
|
1796
|
+
if (transformationID !== void 0) {
|
|
1797
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
1798
|
+
}
|
|
1799
|
+
if (sort !== void 0) {
|
|
1800
|
+
queryParameters["sort"] = sort.toString();
|
|
1801
|
+
}
|
|
1802
|
+
if (order !== void 0) {
|
|
1803
|
+
queryParameters["order"] = order.toString();
|
|
1804
|
+
}
|
|
1805
|
+
const request = {
|
|
1806
|
+
method: "GET",
|
|
918
1807
|
path: requestPath,
|
|
919
1808
|
queryParameters,
|
|
920
1809
|
headers
|
|
@@ -924,6 +1813,8 @@ function createIngestionClient({
|
|
|
924
1813
|
/**
|
|
925
1814
|
* Retrieves a list of destinations.
|
|
926
1815
|
*
|
|
1816
|
+
* 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.
|
|
1817
|
+
*
|
|
927
1818
|
* Required API Key ACLs:
|
|
928
1819
|
* - addObject
|
|
929
1820
|
* - deleteIndex
|
|
@@ -937,8 +1828,9 @@ function createIngestionClient({
|
|
|
937
1828
|
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
938
1829
|
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
939
1830
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1831
|
+
* @see listDestinations for the plain version.
|
|
940
1832
|
*/
|
|
941
|
-
|
|
1833
|
+
listDestinationsWithHTTPInfo({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
942
1834
|
const requestPath = "/1/destinations";
|
|
943
1835
|
const headers = {};
|
|
944
1836
|
const queryParameters = {};
|
|
@@ -969,7 +1861,7 @@ function createIngestionClient({
|
|
|
969
1861
|
queryParameters,
|
|
970
1862
|
headers
|
|
971
1863
|
};
|
|
972
|
-
return transporter.
|
|
1864
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
973
1865
|
},
|
|
974
1866
|
/**
|
|
975
1867
|
* Retrieves a list of events for a task run, identified by its ID.
|
|
@@ -1027,6 +1919,65 @@ function createIngestionClient({
|
|
|
1027
1919
|
};
|
|
1028
1920
|
return transporter.request(request, requestOptions);
|
|
1029
1921
|
},
|
|
1922
|
+
/**
|
|
1923
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1924
|
+
*
|
|
1925
|
+
* 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.
|
|
1926
|
+
*
|
|
1927
|
+
* Required API Key ACLs:
|
|
1928
|
+
* - addObject
|
|
1929
|
+
* - deleteIndex
|
|
1930
|
+
* - editSettings
|
|
1931
|
+
* @param listEvents - The listEvents object.
|
|
1932
|
+
* @param listEvents.runID - Unique identifier of a task run.
|
|
1933
|
+
* @param listEvents.itemsPerPage - Number of items per page.
|
|
1934
|
+
* @param listEvents.page - Page number of the paginated API response.
|
|
1935
|
+
* @param listEvents.status - Event status for filtering the list of task runs.
|
|
1936
|
+
* @param listEvents.type - Event type for filtering the list of task runs.
|
|
1937
|
+
* @param listEvents.sort - Property by which to sort the list of task run events.
|
|
1938
|
+
* @param listEvents.order - Sort order of the response, ascending or descending.
|
|
1939
|
+
* @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.
|
|
1940
|
+
* @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
1941
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1942
|
+
* @see listEvents for the plain version.
|
|
1943
|
+
*/
|
|
1944
|
+
listEventsWithHTTPInfo({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }, requestOptions) {
|
|
1945
|
+
validateRequired("runID", "listEventsWithHTTPInfo", runID);
|
|
1946
|
+
const requestPath = "/1/runs/{runID}/events".replace("{runID}", encodeURIComponent(runID));
|
|
1947
|
+
const headers = {};
|
|
1948
|
+
const queryParameters = {};
|
|
1949
|
+
if (itemsPerPage !== void 0) {
|
|
1950
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1951
|
+
}
|
|
1952
|
+
if (page !== void 0) {
|
|
1953
|
+
queryParameters["page"] = page.toString();
|
|
1954
|
+
}
|
|
1955
|
+
if (status !== void 0) {
|
|
1956
|
+
queryParameters["status"] = status.toString();
|
|
1957
|
+
}
|
|
1958
|
+
if (type !== void 0) {
|
|
1959
|
+
queryParameters["type"] = type.toString();
|
|
1960
|
+
}
|
|
1961
|
+
if (sort !== void 0) {
|
|
1962
|
+
queryParameters["sort"] = sort.toString();
|
|
1963
|
+
}
|
|
1964
|
+
if (order !== void 0) {
|
|
1965
|
+
queryParameters["order"] = order.toString();
|
|
1966
|
+
}
|
|
1967
|
+
if (startDate !== void 0) {
|
|
1968
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1969
|
+
}
|
|
1970
|
+
if (endDate !== void 0) {
|
|
1971
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1972
|
+
}
|
|
1973
|
+
const request = {
|
|
1974
|
+
method: "GET",
|
|
1975
|
+
path: requestPath,
|
|
1976
|
+
queryParameters,
|
|
1977
|
+
headers
|
|
1978
|
+
};
|
|
1979
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1980
|
+
},
|
|
1030
1981
|
/**
|
|
1031
1982
|
* Retrieve a list of task runs.
|
|
1032
1983
|
*
|
|
@@ -1085,6 +2036,67 @@ function createIngestionClient({
|
|
|
1085
2036
|
};
|
|
1086
2037
|
return transporter.request(request, requestOptions);
|
|
1087
2038
|
},
|
|
2039
|
+
/**
|
|
2040
|
+
* Retrieve a list of task runs.
|
|
2041
|
+
*
|
|
2042
|
+
* 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.
|
|
2043
|
+
*
|
|
2044
|
+
* Required API Key ACLs:
|
|
2045
|
+
* - addObject
|
|
2046
|
+
* - deleteIndex
|
|
2047
|
+
* - editSettings
|
|
2048
|
+
* @param listRuns - The listRuns object.
|
|
2049
|
+
* @param listRuns.itemsPerPage - Number of items per page.
|
|
2050
|
+
* @param listRuns.page - Page number of the paginated API response.
|
|
2051
|
+
* @param listRuns.status - Run status for filtering the list of task runs.
|
|
2052
|
+
* @param listRuns.type - Run type for filtering the list of task runs.
|
|
2053
|
+
* @param listRuns.taskID - Task ID for filtering the list of task runs.
|
|
2054
|
+
* @param listRuns.sort - Property by which to sort the list of task runs.
|
|
2055
|
+
* @param listRuns.order - Sort order of the response, ascending or descending.
|
|
2056
|
+
* @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.
|
|
2057
|
+
* @param listRuns.endDate - Date and time for the latest run to retrieve, in RFC 3339 format. By default, the current day is used.
|
|
2058
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2059
|
+
* @see listRuns for the plain version.
|
|
2060
|
+
*/
|
|
2061
|
+
listRunsWithHTTPInfo({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate } = {}, requestOptions = void 0) {
|
|
2062
|
+
const requestPath = "/1/runs";
|
|
2063
|
+
const headers = {};
|
|
2064
|
+
const queryParameters = {};
|
|
2065
|
+
if (itemsPerPage !== void 0) {
|
|
2066
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2067
|
+
}
|
|
2068
|
+
if (page !== void 0) {
|
|
2069
|
+
queryParameters["page"] = page.toString();
|
|
2070
|
+
}
|
|
2071
|
+
if (status !== void 0) {
|
|
2072
|
+
queryParameters["status"] = status.toString();
|
|
2073
|
+
}
|
|
2074
|
+
if (type !== void 0) {
|
|
2075
|
+
queryParameters["type"] = type.toString();
|
|
2076
|
+
}
|
|
2077
|
+
if (taskID !== void 0) {
|
|
2078
|
+
queryParameters["taskID"] = taskID.toString();
|
|
2079
|
+
}
|
|
2080
|
+
if (sort !== void 0) {
|
|
2081
|
+
queryParameters["sort"] = sort.toString();
|
|
2082
|
+
}
|
|
2083
|
+
if (order !== void 0) {
|
|
2084
|
+
queryParameters["order"] = order.toString();
|
|
2085
|
+
}
|
|
2086
|
+
if (startDate !== void 0) {
|
|
2087
|
+
queryParameters["startDate"] = startDate.toString();
|
|
2088
|
+
}
|
|
2089
|
+
if (endDate !== void 0) {
|
|
2090
|
+
queryParameters["endDate"] = endDate.toString();
|
|
2091
|
+
}
|
|
2092
|
+
const request = {
|
|
2093
|
+
method: "GET",
|
|
2094
|
+
path: requestPath,
|
|
2095
|
+
queryParameters,
|
|
2096
|
+
headers
|
|
2097
|
+
};
|
|
2098
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2099
|
+
},
|
|
1088
2100
|
/**
|
|
1089
2101
|
* Retrieves a list of sources.
|
|
1090
2102
|
*
|
|
@@ -1111,11 +2123,138 @@ function createIngestionClient({
|
|
|
1111
2123
|
if (page !== void 0) {
|
|
1112
2124
|
queryParameters["page"] = page.toString();
|
|
1113
2125
|
}
|
|
1114
|
-
if (type !== void 0) {
|
|
1115
|
-
queryParameters["type"] = type.toString();
|
|
2126
|
+
if (type !== void 0) {
|
|
2127
|
+
queryParameters["type"] = type.toString();
|
|
2128
|
+
}
|
|
2129
|
+
if (authenticationID !== void 0) {
|
|
2130
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
2131
|
+
}
|
|
2132
|
+
if (sort !== void 0) {
|
|
2133
|
+
queryParameters["sort"] = sort.toString();
|
|
2134
|
+
}
|
|
2135
|
+
if (order !== void 0) {
|
|
2136
|
+
queryParameters["order"] = order.toString();
|
|
2137
|
+
}
|
|
2138
|
+
const request = {
|
|
2139
|
+
method: "GET",
|
|
2140
|
+
path: requestPath,
|
|
2141
|
+
queryParameters,
|
|
2142
|
+
headers
|
|
2143
|
+
};
|
|
2144
|
+
return transporter.request(request, requestOptions);
|
|
2145
|
+
},
|
|
2146
|
+
/**
|
|
2147
|
+
* Retrieves a list of sources.
|
|
2148
|
+
*
|
|
2149
|
+
* 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.
|
|
2150
|
+
*
|
|
2151
|
+
* Required API Key ACLs:
|
|
2152
|
+
* - addObject
|
|
2153
|
+
* - deleteIndex
|
|
2154
|
+
* - editSettings
|
|
2155
|
+
* @param listSources - The listSources object.
|
|
2156
|
+
* @param listSources.itemsPerPage - Number of items per page.
|
|
2157
|
+
* @param listSources.page - Page number of the paginated API response.
|
|
2158
|
+
* @param listSources.type - Source type. Some sources require authentication.
|
|
2159
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
|
|
2160
|
+
* @param listSources.sort - Property by which to sort the list of sources.
|
|
2161
|
+
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
2162
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2163
|
+
* @see listSources for the plain version.
|
|
2164
|
+
*/
|
|
2165
|
+
listSourcesWithHTTPInfo({ itemsPerPage, page, type, authenticationID, sort, order } = {}, requestOptions = void 0) {
|
|
2166
|
+
const requestPath = "/1/sources";
|
|
2167
|
+
const headers = {};
|
|
2168
|
+
const queryParameters = {};
|
|
2169
|
+
if (itemsPerPage !== void 0) {
|
|
2170
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2171
|
+
}
|
|
2172
|
+
if (page !== void 0) {
|
|
2173
|
+
queryParameters["page"] = page.toString();
|
|
2174
|
+
}
|
|
2175
|
+
if (type !== void 0) {
|
|
2176
|
+
queryParameters["type"] = type.toString();
|
|
2177
|
+
}
|
|
2178
|
+
if (authenticationID !== void 0) {
|
|
2179
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
2180
|
+
}
|
|
2181
|
+
if (sort !== void 0) {
|
|
2182
|
+
queryParameters["sort"] = sort.toString();
|
|
2183
|
+
}
|
|
2184
|
+
if (order !== void 0) {
|
|
2185
|
+
queryParameters["order"] = order.toString();
|
|
2186
|
+
}
|
|
2187
|
+
const request = {
|
|
2188
|
+
method: "GET",
|
|
2189
|
+
path: requestPath,
|
|
2190
|
+
queryParameters,
|
|
2191
|
+
headers
|
|
2192
|
+
};
|
|
2193
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2194
|
+
},
|
|
2195
|
+
/**
|
|
2196
|
+
* Retrieves a list of tasks.
|
|
2197
|
+
*
|
|
2198
|
+
* Required API Key ACLs:
|
|
2199
|
+
* - addObject
|
|
2200
|
+
* - deleteIndex
|
|
2201
|
+
* - editSettings
|
|
2202
|
+
* @param listTasks - The listTasks object.
|
|
2203
|
+
* @param listTasks.itemsPerPage - Number of items per page.
|
|
2204
|
+
* @param listTasks.page - Page number of the paginated API response.
|
|
2205
|
+
* @param listTasks.action - Actions for filtering the list of tasks.
|
|
2206
|
+
* @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2207
|
+
* @param listTasks.sourceID - Source IDs for filtering the list of tasks.
|
|
2208
|
+
* @param listTasks.sourceType - Filters the tasks with the specified source type.
|
|
2209
|
+
* @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
|
|
2210
|
+
* @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2211
|
+
* @param listTasks.withEmailNotifications - If specified, the response only includes tasks with notifications.email.enabled set to this value.
|
|
2212
|
+
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
2213
|
+
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
2214
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2215
|
+
*/
|
|
2216
|
+
listTasks({
|
|
2217
|
+
itemsPerPage,
|
|
2218
|
+
page,
|
|
2219
|
+
action,
|
|
2220
|
+
enabled,
|
|
2221
|
+
sourceID,
|
|
2222
|
+
sourceType,
|
|
2223
|
+
destinationID,
|
|
2224
|
+
triggerType,
|
|
2225
|
+
withEmailNotifications,
|
|
2226
|
+
sort,
|
|
2227
|
+
order
|
|
2228
|
+
} = {}, requestOptions = void 0) {
|
|
2229
|
+
const requestPath = "/2/tasks";
|
|
2230
|
+
const headers = {};
|
|
2231
|
+
const queryParameters = {};
|
|
2232
|
+
if (itemsPerPage !== void 0) {
|
|
2233
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2234
|
+
}
|
|
2235
|
+
if (page !== void 0) {
|
|
2236
|
+
queryParameters["page"] = page.toString();
|
|
2237
|
+
}
|
|
2238
|
+
if (action !== void 0) {
|
|
2239
|
+
queryParameters["action"] = action.toString();
|
|
1116
2240
|
}
|
|
1117
|
-
if (
|
|
1118
|
-
queryParameters["
|
|
2241
|
+
if (enabled !== void 0) {
|
|
2242
|
+
queryParameters["enabled"] = enabled.toString();
|
|
2243
|
+
}
|
|
2244
|
+
if (sourceID !== void 0) {
|
|
2245
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
2246
|
+
}
|
|
2247
|
+
if (sourceType !== void 0) {
|
|
2248
|
+
queryParameters["sourceType"] = sourceType.toString();
|
|
2249
|
+
}
|
|
2250
|
+
if (destinationID !== void 0) {
|
|
2251
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
2252
|
+
}
|
|
2253
|
+
if (triggerType !== void 0) {
|
|
2254
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
2255
|
+
}
|
|
2256
|
+
if (withEmailNotifications !== void 0) {
|
|
2257
|
+
queryParameters["withEmailNotifications"] = withEmailNotifications.toString();
|
|
1119
2258
|
}
|
|
1120
2259
|
if (sort !== void 0) {
|
|
1121
2260
|
queryParameters["sort"] = sort.toString();
|
|
@@ -1134,6 +2273,8 @@ function createIngestionClient({
|
|
|
1134
2273
|
/**
|
|
1135
2274
|
* Retrieves a list of tasks.
|
|
1136
2275
|
*
|
|
2276
|
+
* 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.
|
|
2277
|
+
*
|
|
1137
2278
|
* Required API Key ACLs:
|
|
1138
2279
|
* - addObject
|
|
1139
2280
|
* - deleteIndex
|
|
@@ -1151,8 +2292,9 @@ function createIngestionClient({
|
|
|
1151
2292
|
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
1152
2293
|
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
1153
2294
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2295
|
+
* @see listTasks for the plain version.
|
|
1154
2296
|
*/
|
|
1155
|
-
|
|
2297
|
+
listTasksWithHTTPInfo({
|
|
1156
2298
|
itemsPerPage,
|
|
1157
2299
|
page,
|
|
1158
2300
|
action,
|
|
@@ -1207,7 +2349,7 @@ function createIngestionClient({
|
|
|
1207
2349
|
queryParameters,
|
|
1208
2350
|
headers
|
|
1209
2351
|
};
|
|
1210
|
-
return transporter.
|
|
2352
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1211
2353
|
},
|
|
1212
2354
|
/**
|
|
1213
2355
|
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
@@ -1269,6 +2411,69 @@ function createIngestionClient({
|
|
|
1269
2411
|
};
|
|
1270
2412
|
return transporter.request(request, requestOptions);
|
|
1271
2413
|
},
|
|
2414
|
+
/**
|
|
2415
|
+
* Retrieves a list of tasks using the v1 endpoint. Use `getTasks` instead.
|
|
2416
|
+
*
|
|
2417
|
+
* 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.
|
|
2418
|
+
*
|
|
2419
|
+
* Required API Key ACLs:
|
|
2420
|
+
* - addObject
|
|
2421
|
+
* - deleteIndex
|
|
2422
|
+
* - editSettings
|
|
2423
|
+
*
|
|
2424
|
+
* @deprecated
|
|
2425
|
+
* @param listTasksV1 - The listTasksV1 object.
|
|
2426
|
+
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
2427
|
+
* @param listTasksV1.page - Page number of the paginated API response.
|
|
2428
|
+
* @param listTasksV1.action - Actions for filtering the list of tasks.
|
|
2429
|
+
* @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2430
|
+
* @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
|
|
2431
|
+
* @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
|
|
2432
|
+
* @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2433
|
+
* @param listTasksV1.sort - Property by which to sort the list of tasks.
|
|
2434
|
+
* @param listTasksV1.order - Sort order of the response, ascending or descending.
|
|
2435
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2436
|
+
* @see listTasksV1 for the plain version.
|
|
2437
|
+
*/
|
|
2438
|
+
listTasksV1WithHTTPInfo({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order } = {}, requestOptions = void 0) {
|
|
2439
|
+
const requestPath = "/1/tasks";
|
|
2440
|
+
const headers = {};
|
|
2441
|
+
const queryParameters = {};
|
|
2442
|
+
if (itemsPerPage !== void 0) {
|
|
2443
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2444
|
+
}
|
|
2445
|
+
if (page !== void 0) {
|
|
2446
|
+
queryParameters["page"] = page.toString();
|
|
2447
|
+
}
|
|
2448
|
+
if (action !== void 0) {
|
|
2449
|
+
queryParameters["action"] = action.toString();
|
|
2450
|
+
}
|
|
2451
|
+
if (enabled !== void 0) {
|
|
2452
|
+
queryParameters["enabled"] = enabled.toString();
|
|
2453
|
+
}
|
|
2454
|
+
if (sourceID !== void 0) {
|
|
2455
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
2456
|
+
}
|
|
2457
|
+
if (destinationID !== void 0) {
|
|
2458
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
2459
|
+
}
|
|
2460
|
+
if (triggerType !== void 0) {
|
|
2461
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
2462
|
+
}
|
|
2463
|
+
if (sort !== void 0) {
|
|
2464
|
+
queryParameters["sort"] = sort.toString();
|
|
2465
|
+
}
|
|
2466
|
+
if (order !== void 0) {
|
|
2467
|
+
queryParameters["order"] = order.toString();
|
|
2468
|
+
}
|
|
2469
|
+
const request = {
|
|
2470
|
+
method: "GET",
|
|
2471
|
+
path: requestPath,
|
|
2472
|
+
queryParameters,
|
|
2473
|
+
headers
|
|
2474
|
+
};
|
|
2475
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2476
|
+
},
|
|
1272
2477
|
/**
|
|
1273
2478
|
* Retrieves a list of transformations.
|
|
1274
2479
|
*
|
|
@@ -1311,6 +2516,51 @@ function createIngestionClient({
|
|
|
1311
2516
|
};
|
|
1312
2517
|
return transporter.request(request, requestOptions);
|
|
1313
2518
|
},
|
|
2519
|
+
/**
|
|
2520
|
+
* Retrieves a list of transformations.
|
|
2521
|
+
*
|
|
2522
|
+
* 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.
|
|
2523
|
+
*
|
|
2524
|
+
* Required API Key ACLs:
|
|
2525
|
+
* - addObject
|
|
2526
|
+
* - deleteIndex
|
|
2527
|
+
* - editSettings
|
|
2528
|
+
* @param listTransformations - The listTransformations object.
|
|
2529
|
+
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
2530
|
+
* @param listTransformations.page - Page number of the paginated API response.
|
|
2531
|
+
* @param listTransformations.sort - Property by which to sort the list of transformations.
|
|
2532
|
+
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
2533
|
+
* @param listTransformations.type - Whether to filter the list of transformations by the type of transformation.
|
|
2534
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2535
|
+
* @see listTransformations for the plain version.
|
|
2536
|
+
*/
|
|
2537
|
+
listTransformationsWithHTTPInfo({ itemsPerPage, page, sort, order, type } = {}, requestOptions = void 0) {
|
|
2538
|
+
const requestPath = "/1/transformations";
|
|
2539
|
+
const headers = {};
|
|
2540
|
+
const queryParameters = {};
|
|
2541
|
+
if (itemsPerPage !== void 0) {
|
|
2542
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
2543
|
+
}
|
|
2544
|
+
if (page !== void 0) {
|
|
2545
|
+
queryParameters["page"] = page.toString();
|
|
2546
|
+
}
|
|
2547
|
+
if (sort !== void 0) {
|
|
2548
|
+
queryParameters["sort"] = sort.toString();
|
|
2549
|
+
}
|
|
2550
|
+
if (order !== void 0) {
|
|
2551
|
+
queryParameters["order"] = order.toString();
|
|
2552
|
+
}
|
|
2553
|
+
if (type !== void 0) {
|
|
2554
|
+
queryParameters["type"] = type.toString();
|
|
2555
|
+
}
|
|
2556
|
+
const request = {
|
|
2557
|
+
method: "GET",
|
|
2558
|
+
path: requestPath,
|
|
2559
|
+
queryParameters,
|
|
2560
|
+
headers
|
|
2561
|
+
};
|
|
2562
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2563
|
+
},
|
|
1314
2564
|
/**
|
|
1315
2565
|
* 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.
|
|
1316
2566
|
*
|
|
@@ -1347,6 +2597,7 @@ function createIngestionClient({
|
|
|
1347
2597
|
data: pushTaskPayload
|
|
1348
2598
|
};
|
|
1349
2599
|
requestOptions = {
|
|
2600
|
+
...requestOptions,
|
|
1350
2601
|
timeouts: {
|
|
1351
2602
|
connect: 18e4,
|
|
1352
2603
|
read: 18e4,
|
|
@@ -1356,6 +2607,55 @@ function createIngestionClient({
|
|
|
1356
2607
|
};
|
|
1357
2608
|
return transporter.request(request, requestOptions);
|
|
1358
2609
|
},
|
|
2610
|
+
/**
|
|
2611
|
+
* 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.
|
|
2612
|
+
*
|
|
2613
|
+
* 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.
|
|
2614
|
+
*
|
|
2615
|
+
* Required API Key ACLs:
|
|
2616
|
+
* - addObject
|
|
2617
|
+
* - deleteIndex
|
|
2618
|
+
* - editSettings
|
|
2619
|
+
* @param push - The push object.
|
|
2620
|
+
* @param push.indexName - Name of the index on which to perform the operation.
|
|
2621
|
+
* @param push.pushTaskPayload - The pushTaskPayload object.
|
|
2622
|
+
* @param push.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2623
|
+
* @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).
|
|
2624
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2625
|
+
* @see push for the plain version.
|
|
2626
|
+
*/
|
|
2627
|
+
pushWithHTTPInfo({ indexName, pushTaskPayload, watch, referenceIndexName }, requestOptions) {
|
|
2628
|
+
validateRequired("indexName", "pushWithHTTPInfo", indexName);
|
|
2629
|
+
validateRequired("pushTaskPayload", "pushWithHTTPInfo", pushTaskPayload);
|
|
2630
|
+
validateRequired("pushTaskPayload.action", "pushWithHTTPInfo", pushTaskPayload.action);
|
|
2631
|
+
validateRequired("pushTaskPayload.records", "pushWithHTTPInfo", pushTaskPayload.records);
|
|
2632
|
+
const requestPath = "/1/push/{indexName}".replace("{indexName}", encodeURIComponent(indexName));
|
|
2633
|
+
const headers = {};
|
|
2634
|
+
const queryParameters = {};
|
|
2635
|
+
if (watch !== void 0) {
|
|
2636
|
+
queryParameters["watch"] = watch.toString();
|
|
2637
|
+
}
|
|
2638
|
+
if (referenceIndexName !== void 0) {
|
|
2639
|
+
queryParameters["referenceIndexName"] = referenceIndexName.toString();
|
|
2640
|
+
}
|
|
2641
|
+
const request = {
|
|
2642
|
+
method: "POST",
|
|
2643
|
+
path: requestPath,
|
|
2644
|
+
queryParameters,
|
|
2645
|
+
headers,
|
|
2646
|
+
data: pushTaskPayload
|
|
2647
|
+
};
|
|
2648
|
+
requestOptions = {
|
|
2649
|
+
...requestOptions,
|
|
2650
|
+
timeouts: {
|
|
2651
|
+
connect: 18e4,
|
|
2652
|
+
read: 18e4,
|
|
2653
|
+
write: 18e4,
|
|
2654
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
2655
|
+
}
|
|
2656
|
+
};
|
|
2657
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2658
|
+
},
|
|
1359
2659
|
/**
|
|
1360
2660
|
* 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`.
|
|
1361
2661
|
*
|
|
@@ -1388,6 +2688,7 @@ function createIngestionClient({
|
|
|
1388
2688
|
data: pushTaskPayload
|
|
1389
2689
|
};
|
|
1390
2690
|
requestOptions = {
|
|
2691
|
+
...requestOptions,
|
|
1391
2692
|
timeouts: {
|
|
1392
2693
|
connect: 18e4,
|
|
1393
2694
|
read: 18e4,
|
|
@@ -1397,6 +2698,51 @@ function createIngestionClient({
|
|
|
1397
2698
|
};
|
|
1398
2699
|
return transporter.request(request, requestOptions);
|
|
1399
2700
|
},
|
|
2701
|
+
/**
|
|
2702
|
+
* 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`.
|
|
2703
|
+
*
|
|
2704
|
+
* 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.
|
|
2705
|
+
*
|
|
2706
|
+
* Required API Key ACLs:
|
|
2707
|
+
* - addObject
|
|
2708
|
+
* - deleteIndex
|
|
2709
|
+
* - editSettings
|
|
2710
|
+
* @param pushTask - The pushTask object.
|
|
2711
|
+
* @param pushTask.taskID - Unique identifier of a task.
|
|
2712
|
+
* @param pushTask.pushTaskPayload - The pushTaskPayload object.
|
|
2713
|
+
* @param pushTask.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
|
|
2714
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2715
|
+
* @see pushTask for the plain version.
|
|
2716
|
+
*/
|
|
2717
|
+
pushTaskWithHTTPInfo({ taskID, pushTaskPayload, watch }, requestOptions) {
|
|
2718
|
+
validateRequired("taskID", "pushTaskWithHTTPInfo", taskID);
|
|
2719
|
+
validateRequired("pushTaskPayload", "pushTaskWithHTTPInfo", pushTaskPayload);
|
|
2720
|
+
validateRequired("pushTaskPayload.action", "pushTaskWithHTTPInfo", pushTaskPayload.action);
|
|
2721
|
+
validateRequired("pushTaskPayload.records", "pushTaskWithHTTPInfo", pushTaskPayload.records);
|
|
2722
|
+
const requestPath = "/2/tasks/{taskID}/push".replace("{taskID}", encodeURIComponent(taskID));
|
|
2723
|
+
const headers = {};
|
|
2724
|
+
const queryParameters = {};
|
|
2725
|
+
if (watch !== void 0) {
|
|
2726
|
+
queryParameters["watch"] = watch.toString();
|
|
2727
|
+
}
|
|
2728
|
+
const request = {
|
|
2729
|
+
method: "POST",
|
|
2730
|
+
path: requestPath,
|
|
2731
|
+
queryParameters,
|
|
2732
|
+
headers,
|
|
2733
|
+
data: pushTaskPayload
|
|
2734
|
+
};
|
|
2735
|
+
requestOptions = {
|
|
2736
|
+
...requestOptions,
|
|
2737
|
+
timeouts: {
|
|
2738
|
+
connect: 18e4,
|
|
2739
|
+
read: 18e4,
|
|
2740
|
+
write: 18e4,
|
|
2741
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
2742
|
+
}
|
|
2743
|
+
};
|
|
2744
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2745
|
+
},
|
|
1400
2746
|
/**
|
|
1401
2747
|
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
|
|
1402
2748
|
*
|
|
@@ -1422,13 +2768,73 @@ function createIngestionClient({
|
|
|
1422
2768
|
path: requestPath,
|
|
1423
2769
|
queryParameters,
|
|
1424
2770
|
headers,
|
|
1425
|
-
data: taskReplace
|
|
2771
|
+
data: taskReplace
|
|
2772
|
+
};
|
|
2773
|
+
return transporter.request(request, requestOptions);
|
|
2774
|
+
},
|
|
2775
|
+
/**
|
|
2776
|
+
* Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.
|
|
2777
|
+
*
|
|
2778
|
+
* 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.
|
|
2779
|
+
*
|
|
2780
|
+
* Required API Key ACLs:
|
|
2781
|
+
* - addObject
|
|
2782
|
+
* - deleteIndex
|
|
2783
|
+
* - editSettings
|
|
2784
|
+
* @param replaceTask - The replaceTask object.
|
|
2785
|
+
* @param replaceTask.taskID - Unique identifier of a task.
|
|
2786
|
+
* @param replaceTask.taskReplace - The taskReplace object.
|
|
2787
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2788
|
+
* @see replaceTask for the plain version.
|
|
2789
|
+
*/
|
|
2790
|
+
replaceTaskWithHTTPInfo({ taskID, taskReplace }, requestOptions) {
|
|
2791
|
+
validateRequired("taskID", "replaceTaskWithHTTPInfo", taskID);
|
|
2792
|
+
validateRequired("taskReplace", "replaceTaskWithHTTPInfo", taskReplace);
|
|
2793
|
+
validateRequired("taskReplace.destinationID", "replaceTaskWithHTTPInfo", taskReplace.destinationID);
|
|
2794
|
+
validateRequired("taskReplace.action", "replaceTaskWithHTTPInfo", taskReplace.action);
|
|
2795
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
2796
|
+
const headers = {};
|
|
2797
|
+
const queryParameters = {};
|
|
2798
|
+
const request = {
|
|
2799
|
+
method: "PUT",
|
|
2800
|
+
path: requestPath,
|
|
2801
|
+
queryParameters,
|
|
2802
|
+
headers,
|
|
2803
|
+
data: taskReplace
|
|
2804
|
+
};
|
|
2805
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2806
|
+
},
|
|
2807
|
+
/**
|
|
2808
|
+
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
|
|
2809
|
+
*
|
|
2810
|
+
* Required API Key ACLs:
|
|
2811
|
+
* - addObject
|
|
2812
|
+
* - deleteIndex
|
|
2813
|
+
* - editSettings
|
|
2814
|
+
* @param runSource - The runSource object.
|
|
2815
|
+
* @param runSource.sourceID - Unique identifier of a source.
|
|
2816
|
+
* @param runSource.runSourcePayload -
|
|
2817
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2818
|
+
*/
|
|
2819
|
+
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
2820
|
+
validateRequired("sourceID", "runSource", sourceID);
|
|
2821
|
+
const requestPath = "/1/sources/{sourceID}/run".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
2822
|
+
const headers = {};
|
|
2823
|
+
const queryParameters = {};
|
|
2824
|
+
const request = {
|
|
2825
|
+
method: "POST",
|
|
2826
|
+
path: requestPath,
|
|
2827
|
+
queryParameters,
|
|
2828
|
+
headers,
|
|
2829
|
+
data: runSourcePayload ? runSourcePayload : {}
|
|
1426
2830
|
};
|
|
1427
2831
|
return transporter.request(request, requestOptions);
|
|
1428
2832
|
},
|
|
1429
2833
|
/**
|
|
1430
2834
|
* Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.
|
|
1431
2835
|
*
|
|
2836
|
+
* 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.
|
|
2837
|
+
*
|
|
1432
2838
|
* Required API Key ACLs:
|
|
1433
2839
|
* - addObject
|
|
1434
2840
|
* - deleteIndex
|
|
@@ -1437,9 +2843,10 @@ function createIngestionClient({
|
|
|
1437
2843
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1438
2844
|
* @param runSource.runSourcePayload -
|
|
1439
2845
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2846
|
+
* @see runSource for the plain version.
|
|
1440
2847
|
*/
|
|
1441
|
-
|
|
1442
|
-
validateRequired("sourceID", "
|
|
2848
|
+
runSourceWithHTTPInfo({ sourceID, runSourcePayload }, requestOptions) {
|
|
2849
|
+
validateRequired("sourceID", "runSourceWithHTTPInfo", sourceID);
|
|
1443
2850
|
const requestPath = "/1/sources/{sourceID}/run".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
1444
2851
|
const headers = {};
|
|
1445
2852
|
const queryParameters = {};
|
|
@@ -1450,7 +2857,7 @@ function createIngestionClient({
|
|
|
1450
2857
|
headers,
|
|
1451
2858
|
data: runSourcePayload ? runSourcePayload : {}
|
|
1452
2859
|
};
|
|
1453
|
-
return transporter.
|
|
2860
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1454
2861
|
},
|
|
1455
2862
|
/**
|
|
1456
2863
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
@@ -1478,6 +2885,35 @@ function createIngestionClient({
|
|
|
1478
2885
|
};
|
|
1479
2886
|
return transporter.request(request, requestOptions);
|
|
1480
2887
|
},
|
|
2888
|
+
/**
|
|
2889
|
+
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
2890
|
+
*
|
|
2891
|
+
* 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.
|
|
2892
|
+
*
|
|
2893
|
+
* Required API Key ACLs:
|
|
2894
|
+
* - addObject
|
|
2895
|
+
* - deleteIndex
|
|
2896
|
+
* - editSettings
|
|
2897
|
+
* @param runTask - The runTask object.
|
|
2898
|
+
* @param runTask.taskID - Unique identifier of a task.
|
|
2899
|
+
* @param runTask.runTaskPayload -
|
|
2900
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2901
|
+
* @see runTask for the plain version.
|
|
2902
|
+
*/
|
|
2903
|
+
runTaskWithHTTPInfo({ taskID, runTaskPayload }, requestOptions) {
|
|
2904
|
+
validateRequired("taskID", "runTaskWithHTTPInfo", taskID);
|
|
2905
|
+
const requestPath = "/2/tasks/{taskID}/run".replace("{taskID}", encodeURIComponent(taskID));
|
|
2906
|
+
const headers = {};
|
|
2907
|
+
const queryParameters = {};
|
|
2908
|
+
const request = {
|
|
2909
|
+
method: "POST",
|
|
2910
|
+
path: requestPath,
|
|
2911
|
+
queryParameters,
|
|
2912
|
+
headers,
|
|
2913
|
+
data: runTaskPayload ? runTaskPayload : {}
|
|
2914
|
+
};
|
|
2915
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2916
|
+
},
|
|
1481
2917
|
/**
|
|
1482
2918
|
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1483
2919
|
*
|
|
@@ -1506,6 +2942,37 @@ function createIngestionClient({
|
|
|
1506
2942
|
};
|
|
1507
2943
|
return transporter.request(request, requestOptions);
|
|
1508
2944
|
},
|
|
2945
|
+
/**
|
|
2946
|
+
* Runs a task using the v1 endpoint. Use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
2947
|
+
*
|
|
2948
|
+
* 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.
|
|
2949
|
+
*
|
|
2950
|
+
* Required API Key ACLs:
|
|
2951
|
+
* - addObject
|
|
2952
|
+
* - deleteIndex
|
|
2953
|
+
* - editSettings
|
|
2954
|
+
*
|
|
2955
|
+
* @deprecated
|
|
2956
|
+
* @param runTaskV1 - The runTaskV1 object.
|
|
2957
|
+
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
2958
|
+
* @param runTaskV1.runTaskPayload -
|
|
2959
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2960
|
+
* @see runTaskV1 for the plain version.
|
|
2961
|
+
*/
|
|
2962
|
+
runTaskV1WithHTTPInfo({ taskID, runTaskPayload }, requestOptions) {
|
|
2963
|
+
validateRequired("taskID", "runTaskV1WithHTTPInfo", taskID);
|
|
2964
|
+
const requestPath = "/1/tasks/{taskID}/run".replace("{taskID}", encodeURIComponent(taskID));
|
|
2965
|
+
const headers = {};
|
|
2966
|
+
const queryParameters = {};
|
|
2967
|
+
const request = {
|
|
2968
|
+
method: "POST",
|
|
2969
|
+
path: requestPath,
|
|
2970
|
+
queryParameters,
|
|
2971
|
+
headers,
|
|
2972
|
+
data: runTaskPayload ? runTaskPayload : {}
|
|
2973
|
+
};
|
|
2974
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2975
|
+
},
|
|
1509
2976
|
/**
|
|
1510
2977
|
* Searches for authentication resources.
|
|
1511
2978
|
*
|
|
@@ -1535,6 +3002,38 @@ function createIngestionClient({
|
|
|
1535
3002
|
};
|
|
1536
3003
|
return transporter.request(request, requestOptions);
|
|
1537
3004
|
},
|
|
3005
|
+
/**
|
|
3006
|
+
* Searches for authentication resources.
|
|
3007
|
+
*
|
|
3008
|
+
* 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.
|
|
3009
|
+
*
|
|
3010
|
+
* Required API Key ACLs:
|
|
3011
|
+
* - addObject
|
|
3012
|
+
* - deleteIndex
|
|
3013
|
+
* - editSettings
|
|
3014
|
+
* @param authenticationSearch - The authenticationSearch object.
|
|
3015
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3016
|
+
* @see searchAuthentications for the plain version.
|
|
3017
|
+
*/
|
|
3018
|
+
searchAuthenticationsWithHTTPInfo(authenticationSearch, requestOptions) {
|
|
3019
|
+
validateRequired("authenticationSearch", "searchAuthenticationsWithHTTPInfo", authenticationSearch);
|
|
3020
|
+
validateRequired(
|
|
3021
|
+
"authenticationSearch.authenticationIDs",
|
|
3022
|
+
"searchAuthenticationsWithHTTPInfo",
|
|
3023
|
+
authenticationSearch.authenticationIDs
|
|
3024
|
+
);
|
|
3025
|
+
const requestPath = "/1/authentications/search";
|
|
3026
|
+
const headers = {};
|
|
3027
|
+
const queryParameters = {};
|
|
3028
|
+
const request = {
|
|
3029
|
+
method: "POST",
|
|
3030
|
+
path: requestPath,
|
|
3031
|
+
queryParameters,
|
|
3032
|
+
headers,
|
|
3033
|
+
data: authenticationSearch
|
|
3034
|
+
};
|
|
3035
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3036
|
+
},
|
|
1538
3037
|
/**
|
|
1539
3038
|
* Searches for destinations.
|
|
1540
3039
|
*
|
|
@@ -1560,6 +3059,38 @@ function createIngestionClient({
|
|
|
1560
3059
|
};
|
|
1561
3060
|
return transporter.request(request, requestOptions);
|
|
1562
3061
|
},
|
|
3062
|
+
/**
|
|
3063
|
+
* Searches for destinations.
|
|
3064
|
+
*
|
|
3065
|
+
* 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.
|
|
3066
|
+
*
|
|
3067
|
+
* Required API Key ACLs:
|
|
3068
|
+
* - addObject
|
|
3069
|
+
* - deleteIndex
|
|
3070
|
+
* - editSettings
|
|
3071
|
+
* @param destinationSearch - The destinationSearch object.
|
|
3072
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3073
|
+
* @see searchDestinations for the plain version.
|
|
3074
|
+
*/
|
|
3075
|
+
searchDestinationsWithHTTPInfo(destinationSearch, requestOptions) {
|
|
3076
|
+
validateRequired("destinationSearch", "searchDestinationsWithHTTPInfo", destinationSearch);
|
|
3077
|
+
validateRequired(
|
|
3078
|
+
"destinationSearch.destinationIDs",
|
|
3079
|
+
"searchDestinationsWithHTTPInfo",
|
|
3080
|
+
destinationSearch.destinationIDs
|
|
3081
|
+
);
|
|
3082
|
+
const requestPath = "/1/destinations/search";
|
|
3083
|
+
const headers = {};
|
|
3084
|
+
const queryParameters = {};
|
|
3085
|
+
const request = {
|
|
3086
|
+
method: "POST",
|
|
3087
|
+
path: requestPath,
|
|
3088
|
+
queryParameters,
|
|
3089
|
+
headers,
|
|
3090
|
+
data: destinationSearch
|
|
3091
|
+
};
|
|
3092
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3093
|
+
},
|
|
1563
3094
|
/**
|
|
1564
3095
|
* Searches for sources.
|
|
1565
3096
|
*
|
|
@@ -1585,6 +3116,34 @@ function createIngestionClient({
|
|
|
1585
3116
|
};
|
|
1586
3117
|
return transporter.request(request, requestOptions);
|
|
1587
3118
|
},
|
|
3119
|
+
/**
|
|
3120
|
+
* Searches for sources.
|
|
3121
|
+
*
|
|
3122
|
+
* 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.
|
|
3123
|
+
*
|
|
3124
|
+
* Required API Key ACLs:
|
|
3125
|
+
* - addObject
|
|
3126
|
+
* - deleteIndex
|
|
3127
|
+
* - editSettings
|
|
3128
|
+
* @param sourceSearch - The sourceSearch object.
|
|
3129
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3130
|
+
* @see searchSources for the plain version.
|
|
3131
|
+
*/
|
|
3132
|
+
searchSourcesWithHTTPInfo(sourceSearch, requestOptions) {
|
|
3133
|
+
validateRequired("sourceSearch", "searchSourcesWithHTTPInfo", sourceSearch);
|
|
3134
|
+
validateRequired("sourceSearch.sourceIDs", "searchSourcesWithHTTPInfo", sourceSearch.sourceIDs);
|
|
3135
|
+
const requestPath = "/1/sources/search";
|
|
3136
|
+
const headers = {};
|
|
3137
|
+
const queryParameters = {};
|
|
3138
|
+
const request = {
|
|
3139
|
+
method: "POST",
|
|
3140
|
+
path: requestPath,
|
|
3141
|
+
queryParameters,
|
|
3142
|
+
headers,
|
|
3143
|
+
data: sourceSearch
|
|
3144
|
+
};
|
|
3145
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3146
|
+
},
|
|
1588
3147
|
/**
|
|
1589
3148
|
* Searches for tasks.
|
|
1590
3149
|
*
|
|
@@ -1610,6 +3169,34 @@ function createIngestionClient({
|
|
|
1610
3169
|
};
|
|
1611
3170
|
return transporter.request(request, requestOptions);
|
|
1612
3171
|
},
|
|
3172
|
+
/**
|
|
3173
|
+
* Searches for tasks.
|
|
3174
|
+
*
|
|
3175
|
+
* 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.
|
|
3176
|
+
*
|
|
3177
|
+
* Required API Key ACLs:
|
|
3178
|
+
* - addObject
|
|
3179
|
+
* - deleteIndex
|
|
3180
|
+
* - editSettings
|
|
3181
|
+
* @param taskSearch - The taskSearch object.
|
|
3182
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3183
|
+
* @see searchTasks for the plain version.
|
|
3184
|
+
*/
|
|
3185
|
+
searchTasksWithHTTPInfo(taskSearch, requestOptions) {
|
|
3186
|
+
validateRequired("taskSearch", "searchTasksWithHTTPInfo", taskSearch);
|
|
3187
|
+
validateRequired("taskSearch.taskIDs", "searchTasksWithHTTPInfo", taskSearch.taskIDs);
|
|
3188
|
+
const requestPath = "/2/tasks/search";
|
|
3189
|
+
const headers = {};
|
|
3190
|
+
const queryParameters = {};
|
|
3191
|
+
const request = {
|
|
3192
|
+
method: "POST",
|
|
3193
|
+
path: requestPath,
|
|
3194
|
+
queryParameters,
|
|
3195
|
+
headers,
|
|
3196
|
+
data: taskSearch
|
|
3197
|
+
};
|
|
3198
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3199
|
+
},
|
|
1613
3200
|
/**
|
|
1614
3201
|
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
1615
3202
|
*
|
|
@@ -1637,6 +3224,36 @@ function createIngestionClient({
|
|
|
1637
3224
|
};
|
|
1638
3225
|
return transporter.request(request, requestOptions);
|
|
1639
3226
|
},
|
|
3227
|
+
/**
|
|
3228
|
+
* Searches for tasks using the v1 endpoint. Use `searchTasks` instead.
|
|
3229
|
+
*
|
|
3230
|
+
* 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.
|
|
3231
|
+
*
|
|
3232
|
+
* Required API Key ACLs:
|
|
3233
|
+
* - addObject
|
|
3234
|
+
* - deleteIndex
|
|
3235
|
+
* - editSettings
|
|
3236
|
+
*
|
|
3237
|
+
* @deprecated
|
|
3238
|
+
* @param taskSearch - The taskSearch object.
|
|
3239
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3240
|
+
* @see searchTasksV1 for the plain version.
|
|
3241
|
+
*/
|
|
3242
|
+
searchTasksV1WithHTTPInfo(taskSearch, requestOptions) {
|
|
3243
|
+
validateRequired("taskSearch", "searchTasksV1WithHTTPInfo", taskSearch);
|
|
3244
|
+
validateRequired("taskSearch.taskIDs", "searchTasksV1WithHTTPInfo", taskSearch.taskIDs);
|
|
3245
|
+
const requestPath = "/1/tasks/search";
|
|
3246
|
+
const headers = {};
|
|
3247
|
+
const queryParameters = {};
|
|
3248
|
+
const request = {
|
|
3249
|
+
method: "POST",
|
|
3250
|
+
path: requestPath,
|
|
3251
|
+
queryParameters,
|
|
3252
|
+
headers,
|
|
3253
|
+
data: taskSearch
|
|
3254
|
+
};
|
|
3255
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3256
|
+
},
|
|
1640
3257
|
/**
|
|
1641
3258
|
* Searches for transformations.
|
|
1642
3259
|
*
|
|
@@ -1666,6 +3283,38 @@ function createIngestionClient({
|
|
|
1666
3283
|
};
|
|
1667
3284
|
return transporter.request(request, requestOptions);
|
|
1668
3285
|
},
|
|
3286
|
+
/**
|
|
3287
|
+
* Searches for transformations.
|
|
3288
|
+
*
|
|
3289
|
+
* 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.
|
|
3290
|
+
*
|
|
3291
|
+
* Required API Key ACLs:
|
|
3292
|
+
* - addObject
|
|
3293
|
+
* - deleteIndex
|
|
3294
|
+
* - editSettings
|
|
3295
|
+
* @param transformationSearch - The transformationSearch object.
|
|
3296
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3297
|
+
* @see searchTransformations for the plain version.
|
|
3298
|
+
*/
|
|
3299
|
+
searchTransformationsWithHTTPInfo(transformationSearch, requestOptions) {
|
|
3300
|
+
validateRequired("transformationSearch", "searchTransformationsWithHTTPInfo", transformationSearch);
|
|
3301
|
+
validateRequired(
|
|
3302
|
+
"transformationSearch.transformationIDs",
|
|
3303
|
+
"searchTransformationsWithHTTPInfo",
|
|
3304
|
+
transformationSearch.transformationIDs
|
|
3305
|
+
);
|
|
3306
|
+
const requestPath = "/1/transformations/search";
|
|
3307
|
+
const headers = {};
|
|
3308
|
+
const queryParameters = {};
|
|
3309
|
+
const request = {
|
|
3310
|
+
method: "POST",
|
|
3311
|
+
path: requestPath,
|
|
3312
|
+
queryParameters,
|
|
3313
|
+
headers,
|
|
3314
|
+
data: transformationSearch
|
|
3315
|
+
};
|
|
3316
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3317
|
+
},
|
|
1669
3318
|
/**
|
|
1670
3319
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
|
|
1671
3320
|
*
|
|
@@ -1689,6 +3338,43 @@ function createIngestionClient({
|
|
|
1689
3338
|
headers
|
|
1690
3339
|
};
|
|
1691
3340
|
requestOptions = {
|
|
3341
|
+
...requestOptions,
|
|
3342
|
+
timeouts: {
|
|
3343
|
+
connect: 18e4,
|
|
3344
|
+
read: 18e4,
|
|
3345
|
+
write: 18e4,
|
|
3346
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
3347
|
+
}
|
|
3348
|
+
};
|
|
3349
|
+
return transporter.request(request, requestOptions);
|
|
3350
|
+
},
|
|
3351
|
+
/**
|
|
3352
|
+
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.
|
|
3353
|
+
*
|
|
3354
|
+
* 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.
|
|
3355
|
+
*
|
|
3356
|
+
* Required API Key ACLs:
|
|
3357
|
+
* - addObject
|
|
3358
|
+
* - deleteIndex
|
|
3359
|
+
* - editSettings
|
|
3360
|
+
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
3361
|
+
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
3362
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3363
|
+
* @see triggerDockerSourceDiscover for the plain version.
|
|
3364
|
+
*/
|
|
3365
|
+
triggerDockerSourceDiscoverWithHTTPInfo({ sourceID }, requestOptions) {
|
|
3366
|
+
validateRequired("sourceID", "triggerDockerSourceDiscoverWithHTTPInfo", sourceID);
|
|
3367
|
+
const requestPath = "/1/sources/{sourceID}/discover".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
3368
|
+
const headers = {};
|
|
3369
|
+
const queryParameters = {};
|
|
3370
|
+
const request = {
|
|
3371
|
+
method: "POST",
|
|
3372
|
+
path: requestPath,
|
|
3373
|
+
queryParameters,
|
|
3374
|
+
headers
|
|
3375
|
+
};
|
|
3376
|
+
requestOptions = {
|
|
3377
|
+
...requestOptions,
|
|
1692
3378
|
timeouts: {
|
|
1693
3379
|
connect: 18e4,
|
|
1694
3380
|
read: 18e4,
|
|
@@ -1696,21 +3382,53 @@ function createIngestionClient({
|
|
|
1696
3382
|
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
1697
3383
|
}
|
|
1698
3384
|
};
|
|
3385
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3386
|
+
},
|
|
3387
|
+
/**
|
|
3388
|
+
* Try a transformation before creating it.
|
|
3389
|
+
*
|
|
3390
|
+
* Required API Key ACLs:
|
|
3391
|
+
* - addObject
|
|
3392
|
+
* - deleteIndex
|
|
3393
|
+
* - editSettings
|
|
3394
|
+
* @param transformationTry - The transformationTry object.
|
|
3395
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3396
|
+
*/
|
|
3397
|
+
tryTransformation(transformationTry, requestOptions) {
|
|
3398
|
+
validateRequired("transformationTry", "tryTransformation", transformationTry);
|
|
3399
|
+
validateRequired("transformationTry.sampleRecord", "tryTransformation", transformationTry.sampleRecord);
|
|
3400
|
+
const requestPath = "/1/transformations/try";
|
|
3401
|
+
const headers = {};
|
|
3402
|
+
const queryParameters = {};
|
|
3403
|
+
const request = {
|
|
3404
|
+
method: "POST",
|
|
3405
|
+
path: requestPath,
|
|
3406
|
+
queryParameters,
|
|
3407
|
+
headers,
|
|
3408
|
+
data: transformationTry
|
|
3409
|
+
};
|
|
1699
3410
|
return transporter.request(request, requestOptions);
|
|
1700
3411
|
},
|
|
1701
3412
|
/**
|
|
1702
3413
|
* Try a transformation before creating it.
|
|
1703
3414
|
*
|
|
3415
|
+
* 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.
|
|
3416
|
+
*
|
|
1704
3417
|
* Required API Key ACLs:
|
|
1705
3418
|
* - addObject
|
|
1706
3419
|
* - deleteIndex
|
|
1707
3420
|
* - editSettings
|
|
1708
3421
|
* @param transformationTry - The transformationTry object.
|
|
1709
3422
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3423
|
+
* @see tryTransformation for the plain version.
|
|
1710
3424
|
*/
|
|
1711
|
-
|
|
1712
|
-
validateRequired("transformationTry", "
|
|
1713
|
-
validateRequired(
|
|
3425
|
+
tryTransformationWithHTTPInfo(transformationTry, requestOptions) {
|
|
3426
|
+
validateRequired("transformationTry", "tryTransformationWithHTTPInfo", transformationTry);
|
|
3427
|
+
validateRequired(
|
|
3428
|
+
"transformationTry.sampleRecord",
|
|
3429
|
+
"tryTransformationWithHTTPInfo",
|
|
3430
|
+
transformationTry.sampleRecord
|
|
3431
|
+
);
|
|
1714
3432
|
const requestPath = "/1/transformations/try";
|
|
1715
3433
|
const headers = {};
|
|
1716
3434
|
const queryParameters = {};
|
|
@@ -1721,7 +3439,7 @@ function createIngestionClient({
|
|
|
1721
3439
|
headers,
|
|
1722
3440
|
data: transformationTry
|
|
1723
3441
|
};
|
|
1724
|
-
return transporter.
|
|
3442
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
1725
3443
|
},
|
|
1726
3444
|
/**
|
|
1727
3445
|
* Try a transformation before updating it.
|
|
@@ -1758,6 +3476,44 @@ function createIngestionClient({
|
|
|
1758
3476
|
};
|
|
1759
3477
|
return transporter.request(request, requestOptions);
|
|
1760
3478
|
},
|
|
3479
|
+
/**
|
|
3480
|
+
* Try a transformation before updating it.
|
|
3481
|
+
*
|
|
3482
|
+
* 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.
|
|
3483
|
+
*
|
|
3484
|
+
* Required API Key ACLs:
|
|
3485
|
+
* - addObject
|
|
3486
|
+
* - deleteIndex
|
|
3487
|
+
* - editSettings
|
|
3488
|
+
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
3489
|
+
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
3490
|
+
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
3491
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3492
|
+
* @see tryTransformationBeforeUpdate for the plain version.
|
|
3493
|
+
*/
|
|
3494
|
+
tryTransformationBeforeUpdateWithHTTPInfo({ transformationID, transformationTry }, requestOptions) {
|
|
3495
|
+
validateRequired("transformationID", "tryTransformationBeforeUpdateWithHTTPInfo", transformationID);
|
|
3496
|
+
validateRequired("transformationTry", "tryTransformationBeforeUpdateWithHTTPInfo", transformationTry);
|
|
3497
|
+
validateRequired(
|
|
3498
|
+
"transformationTry.sampleRecord",
|
|
3499
|
+
"tryTransformationBeforeUpdateWithHTTPInfo",
|
|
3500
|
+
transformationTry.sampleRecord
|
|
3501
|
+
);
|
|
3502
|
+
const requestPath = "/1/transformations/{transformationID}/try".replace(
|
|
3503
|
+
"{transformationID}",
|
|
3504
|
+
encodeURIComponent(transformationID)
|
|
3505
|
+
);
|
|
3506
|
+
const headers = {};
|
|
3507
|
+
const queryParameters = {};
|
|
3508
|
+
const request = {
|
|
3509
|
+
method: "POST",
|
|
3510
|
+
path: requestPath,
|
|
3511
|
+
queryParameters,
|
|
3512
|
+
headers,
|
|
3513
|
+
data: transformationTry
|
|
3514
|
+
};
|
|
3515
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3516
|
+
},
|
|
1761
3517
|
/**
|
|
1762
3518
|
* Updates an authentication resource.
|
|
1763
3519
|
*
|
|
@@ -1788,6 +3544,39 @@ function createIngestionClient({
|
|
|
1788
3544
|
};
|
|
1789
3545
|
return transporter.request(request, requestOptions);
|
|
1790
3546
|
},
|
|
3547
|
+
/**
|
|
3548
|
+
* Updates an authentication resource.
|
|
3549
|
+
*
|
|
3550
|
+
* 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.
|
|
3551
|
+
*
|
|
3552
|
+
* Required API Key ACLs:
|
|
3553
|
+
* - addObject
|
|
3554
|
+
* - deleteIndex
|
|
3555
|
+
* - editSettings
|
|
3556
|
+
* @param updateAuthentication - The updateAuthentication object.
|
|
3557
|
+
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
3558
|
+
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
3559
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3560
|
+
* @see updateAuthentication for the plain version.
|
|
3561
|
+
*/
|
|
3562
|
+
updateAuthenticationWithHTTPInfo({ authenticationID, authenticationUpdate }, requestOptions) {
|
|
3563
|
+
validateRequired("authenticationID", "updateAuthenticationWithHTTPInfo", authenticationID);
|
|
3564
|
+
validateRequired("authenticationUpdate", "updateAuthenticationWithHTTPInfo", authenticationUpdate);
|
|
3565
|
+
const requestPath = "/1/authentications/{authenticationID}".replace(
|
|
3566
|
+
"{authenticationID}",
|
|
3567
|
+
encodeURIComponent(authenticationID)
|
|
3568
|
+
);
|
|
3569
|
+
const headers = {};
|
|
3570
|
+
const queryParameters = {};
|
|
3571
|
+
const request = {
|
|
3572
|
+
method: "PATCH",
|
|
3573
|
+
path: requestPath,
|
|
3574
|
+
queryParameters,
|
|
3575
|
+
headers,
|
|
3576
|
+
data: authenticationUpdate
|
|
3577
|
+
};
|
|
3578
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3579
|
+
},
|
|
1791
3580
|
/**
|
|
1792
3581
|
* Updates the destination by its ID.
|
|
1793
3582
|
*
|
|
@@ -1818,6 +3607,39 @@ function createIngestionClient({
|
|
|
1818
3607
|
};
|
|
1819
3608
|
return transporter.request(request, requestOptions);
|
|
1820
3609
|
},
|
|
3610
|
+
/**
|
|
3611
|
+
* Updates the destination by its ID.
|
|
3612
|
+
*
|
|
3613
|
+
* 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.
|
|
3614
|
+
*
|
|
3615
|
+
* Required API Key ACLs:
|
|
3616
|
+
* - addObject
|
|
3617
|
+
* - deleteIndex
|
|
3618
|
+
* - editSettings
|
|
3619
|
+
* @param updateDestination - The updateDestination object.
|
|
3620
|
+
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
3621
|
+
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
3622
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3623
|
+
* @see updateDestination for the plain version.
|
|
3624
|
+
*/
|
|
3625
|
+
updateDestinationWithHTTPInfo({ destinationID, destinationUpdate }, requestOptions) {
|
|
3626
|
+
validateRequired("destinationID", "updateDestinationWithHTTPInfo", destinationID);
|
|
3627
|
+
validateRequired("destinationUpdate", "updateDestinationWithHTTPInfo", destinationUpdate);
|
|
3628
|
+
const requestPath = "/1/destinations/{destinationID}".replace(
|
|
3629
|
+
"{destinationID}",
|
|
3630
|
+
encodeURIComponent(destinationID)
|
|
3631
|
+
);
|
|
3632
|
+
const headers = {};
|
|
3633
|
+
const queryParameters = {};
|
|
3634
|
+
const request = {
|
|
3635
|
+
method: "PATCH",
|
|
3636
|
+
path: requestPath,
|
|
3637
|
+
queryParameters,
|
|
3638
|
+
headers,
|
|
3639
|
+
data: destinationUpdate
|
|
3640
|
+
};
|
|
3641
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3642
|
+
},
|
|
1821
3643
|
/**
|
|
1822
3644
|
* Updates a source by its ID.
|
|
1823
3645
|
*
|
|
@@ -1845,6 +3667,36 @@ function createIngestionClient({
|
|
|
1845
3667
|
};
|
|
1846
3668
|
return transporter.request(request, requestOptions);
|
|
1847
3669
|
},
|
|
3670
|
+
/**
|
|
3671
|
+
* Updates a source by its ID.
|
|
3672
|
+
*
|
|
3673
|
+
* 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.
|
|
3674
|
+
*
|
|
3675
|
+
* Required API Key ACLs:
|
|
3676
|
+
* - addObject
|
|
3677
|
+
* - deleteIndex
|
|
3678
|
+
* - editSettings
|
|
3679
|
+
* @param updateSource - The updateSource object.
|
|
3680
|
+
* @param updateSource.sourceID - Unique identifier of a source.
|
|
3681
|
+
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
3682
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3683
|
+
* @see updateSource for the plain version.
|
|
3684
|
+
*/
|
|
3685
|
+
updateSourceWithHTTPInfo({ sourceID, sourceUpdate }, requestOptions) {
|
|
3686
|
+
validateRequired("sourceID", "updateSourceWithHTTPInfo", sourceID);
|
|
3687
|
+
validateRequired("sourceUpdate", "updateSourceWithHTTPInfo", sourceUpdate);
|
|
3688
|
+
const requestPath = "/1/sources/{sourceID}".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
3689
|
+
const headers = {};
|
|
3690
|
+
const queryParameters = {};
|
|
3691
|
+
const request = {
|
|
3692
|
+
method: "PATCH",
|
|
3693
|
+
path: requestPath,
|
|
3694
|
+
queryParameters,
|
|
3695
|
+
headers,
|
|
3696
|
+
data: sourceUpdate
|
|
3697
|
+
};
|
|
3698
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3699
|
+
},
|
|
1848
3700
|
/**
|
|
1849
3701
|
* Partially updates a task by its ID.
|
|
1850
3702
|
*
|
|
@@ -1872,6 +3724,36 @@ function createIngestionClient({
|
|
|
1872
3724
|
};
|
|
1873
3725
|
return transporter.request(request, requestOptions);
|
|
1874
3726
|
},
|
|
3727
|
+
/**
|
|
3728
|
+
* Partially updates a task by its ID.
|
|
3729
|
+
*
|
|
3730
|
+
* 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.
|
|
3731
|
+
*
|
|
3732
|
+
* Required API Key ACLs:
|
|
3733
|
+
* - addObject
|
|
3734
|
+
* - deleteIndex
|
|
3735
|
+
* - editSettings
|
|
3736
|
+
* @param updateTask - The updateTask object.
|
|
3737
|
+
* @param updateTask.taskID - Unique identifier of a task.
|
|
3738
|
+
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
3739
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3740
|
+
* @see updateTask for the plain version.
|
|
3741
|
+
*/
|
|
3742
|
+
updateTaskWithHTTPInfo({ taskID, taskUpdate }, requestOptions) {
|
|
3743
|
+
validateRequired("taskID", "updateTaskWithHTTPInfo", taskID);
|
|
3744
|
+
validateRequired("taskUpdate", "updateTaskWithHTTPInfo", taskUpdate);
|
|
3745
|
+
const requestPath = "/2/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
3746
|
+
const headers = {};
|
|
3747
|
+
const queryParameters = {};
|
|
3748
|
+
const request = {
|
|
3749
|
+
method: "PATCH",
|
|
3750
|
+
path: requestPath,
|
|
3751
|
+
queryParameters,
|
|
3752
|
+
headers,
|
|
3753
|
+
data: taskUpdate
|
|
3754
|
+
};
|
|
3755
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3756
|
+
},
|
|
1875
3757
|
/**
|
|
1876
3758
|
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
1877
3759
|
*
|
|
@@ -1901,6 +3783,38 @@ function createIngestionClient({
|
|
|
1901
3783
|
};
|
|
1902
3784
|
return transporter.request(request, requestOptions);
|
|
1903
3785
|
},
|
|
3786
|
+
/**
|
|
3787
|
+
* Updates a task by its ID using the v1 endpoint. Use `updateTask` instead.
|
|
3788
|
+
*
|
|
3789
|
+
* 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.
|
|
3790
|
+
*
|
|
3791
|
+
* Required API Key ACLs:
|
|
3792
|
+
* - addObject
|
|
3793
|
+
* - deleteIndex
|
|
3794
|
+
* - editSettings
|
|
3795
|
+
*
|
|
3796
|
+
* @deprecated
|
|
3797
|
+
* @param updateTaskV1 - The updateTaskV1 object.
|
|
3798
|
+
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
3799
|
+
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
3800
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3801
|
+
* @see updateTaskV1 for the plain version.
|
|
3802
|
+
*/
|
|
3803
|
+
updateTaskV1WithHTTPInfo({ taskID, taskUpdate }, requestOptions) {
|
|
3804
|
+
validateRequired("taskID", "updateTaskV1WithHTTPInfo", taskID);
|
|
3805
|
+
validateRequired("taskUpdate", "updateTaskV1WithHTTPInfo", taskUpdate);
|
|
3806
|
+
const requestPath = "/1/tasks/{taskID}".replace("{taskID}", encodeURIComponent(taskID));
|
|
3807
|
+
const headers = {};
|
|
3808
|
+
const queryParameters = {};
|
|
3809
|
+
const request = {
|
|
3810
|
+
method: "PATCH",
|
|
3811
|
+
path: requestPath,
|
|
3812
|
+
queryParameters,
|
|
3813
|
+
headers,
|
|
3814
|
+
data: taskUpdate
|
|
3815
|
+
};
|
|
3816
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3817
|
+
},
|
|
1904
3818
|
/**
|
|
1905
3819
|
* Updates a transformation by its ID.
|
|
1906
3820
|
*
|
|
@@ -1932,6 +3846,40 @@ function createIngestionClient({
|
|
|
1932
3846
|
};
|
|
1933
3847
|
return transporter.request(request, requestOptions);
|
|
1934
3848
|
},
|
|
3849
|
+
/**
|
|
3850
|
+
* Updates a transformation by its ID.
|
|
3851
|
+
*
|
|
3852
|
+
* 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.
|
|
3853
|
+
*
|
|
3854
|
+
* Required API Key ACLs:
|
|
3855
|
+
* - addObject
|
|
3856
|
+
* - deleteIndex
|
|
3857
|
+
* - editSettings
|
|
3858
|
+
* @param updateTransformation - The updateTransformation object.
|
|
3859
|
+
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
3860
|
+
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
3861
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3862
|
+
* @see updateTransformation for the plain version.
|
|
3863
|
+
*/
|
|
3864
|
+
updateTransformationWithHTTPInfo({ transformationID, transformationCreate }, requestOptions) {
|
|
3865
|
+
validateRequired("transformationID", "updateTransformationWithHTTPInfo", transformationID);
|
|
3866
|
+
validateRequired("transformationCreate", "updateTransformationWithHTTPInfo", transformationCreate);
|
|
3867
|
+
validateRequired("transformationCreate.name", "updateTransformationWithHTTPInfo", transformationCreate.name);
|
|
3868
|
+
const requestPath = "/1/transformations/{transformationID}".replace(
|
|
3869
|
+
"{transformationID}",
|
|
3870
|
+
encodeURIComponent(transformationID)
|
|
3871
|
+
);
|
|
3872
|
+
const headers = {};
|
|
3873
|
+
const queryParameters = {};
|
|
3874
|
+
const request = {
|
|
3875
|
+
method: "PUT",
|
|
3876
|
+
path: requestPath,
|
|
3877
|
+
queryParameters,
|
|
3878
|
+
headers,
|
|
3879
|
+
data: transformationCreate
|
|
3880
|
+
};
|
|
3881
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3882
|
+
},
|
|
1935
3883
|
/**
|
|
1936
3884
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1937
3885
|
*
|
|
@@ -1954,6 +3902,7 @@ function createIngestionClient({
|
|
|
1954
3902
|
data: sourceCreate ? sourceCreate : {}
|
|
1955
3903
|
};
|
|
1956
3904
|
requestOptions = {
|
|
3905
|
+
...requestOptions,
|
|
1957
3906
|
timeouts: {
|
|
1958
3907
|
connect: 18e4,
|
|
1959
3908
|
read: 18e4,
|
|
@@ -1963,6 +3912,41 @@ function createIngestionClient({
|
|
|
1963
3912
|
};
|
|
1964
3913
|
return transporter.request(request, requestOptions);
|
|
1965
3914
|
},
|
|
3915
|
+
/**
|
|
3916
|
+
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
3917
|
+
*
|
|
3918
|
+
* 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.
|
|
3919
|
+
*
|
|
3920
|
+
* Required API Key ACLs:
|
|
3921
|
+
* - addObject
|
|
3922
|
+
* - deleteIndex
|
|
3923
|
+
* - editSettings
|
|
3924
|
+
* @param sourceCreate -
|
|
3925
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3926
|
+
* @see validateSource for the plain version.
|
|
3927
|
+
*/
|
|
3928
|
+
validateSourceWithHTTPInfo(sourceCreate, requestOptions = void 0) {
|
|
3929
|
+
const requestPath = "/1/sources/validate";
|
|
3930
|
+
const headers = {};
|
|
3931
|
+
const queryParameters = {};
|
|
3932
|
+
const request = {
|
|
3933
|
+
method: "POST",
|
|
3934
|
+
path: requestPath,
|
|
3935
|
+
queryParameters,
|
|
3936
|
+
headers,
|
|
3937
|
+
data: sourceCreate ? sourceCreate : {}
|
|
3938
|
+
};
|
|
3939
|
+
requestOptions = {
|
|
3940
|
+
...requestOptions,
|
|
3941
|
+
timeouts: {
|
|
3942
|
+
connect: 18e4,
|
|
3943
|
+
read: 18e4,
|
|
3944
|
+
write: 18e4,
|
|
3945
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
3946
|
+
}
|
|
3947
|
+
};
|
|
3948
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
3949
|
+
},
|
|
1966
3950
|
/**
|
|
1967
3951
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1968
3952
|
*
|
|
@@ -1989,6 +3973,7 @@ function createIngestionClient({
|
|
|
1989
3973
|
data: sourceUpdate
|
|
1990
3974
|
};
|
|
1991
3975
|
requestOptions = {
|
|
3976
|
+
...requestOptions,
|
|
1992
3977
|
timeouts: {
|
|
1993
3978
|
connect: 18e4,
|
|
1994
3979
|
read: 18e4,
|
|
@@ -1997,6 +3982,45 @@ function createIngestionClient({
|
|
|
1997
3982
|
}
|
|
1998
3983
|
};
|
|
1999
3984
|
return transporter.request(request, requestOptions);
|
|
3985
|
+
},
|
|
3986
|
+
/**
|
|
3987
|
+
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
3988
|
+
*
|
|
3989
|
+
* 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.
|
|
3990
|
+
*
|
|
3991
|
+
* Required API Key ACLs:
|
|
3992
|
+
* - addObject
|
|
3993
|
+
* - deleteIndex
|
|
3994
|
+
* - editSettings
|
|
3995
|
+
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
3996
|
+
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
3997
|
+
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
3998
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
3999
|
+
* @see validateSourceBeforeUpdate for the plain version.
|
|
4000
|
+
*/
|
|
4001
|
+
validateSourceBeforeUpdateWithHTTPInfo({ sourceID, sourceUpdate }, requestOptions) {
|
|
4002
|
+
validateRequired("sourceID", "validateSourceBeforeUpdateWithHTTPInfo", sourceID);
|
|
4003
|
+
validateRequired("sourceUpdate", "validateSourceBeforeUpdateWithHTTPInfo", sourceUpdate);
|
|
4004
|
+
const requestPath = "/1/sources/{sourceID}/validate".replace("{sourceID}", encodeURIComponent(sourceID));
|
|
4005
|
+
const headers = {};
|
|
4006
|
+
const queryParameters = {};
|
|
4007
|
+
const request = {
|
|
4008
|
+
method: "POST",
|
|
4009
|
+
path: requestPath,
|
|
4010
|
+
queryParameters,
|
|
4011
|
+
headers,
|
|
4012
|
+
data: sourceUpdate
|
|
4013
|
+
};
|
|
4014
|
+
requestOptions = {
|
|
4015
|
+
...requestOptions,
|
|
4016
|
+
timeouts: {
|
|
4017
|
+
connect: 18e4,
|
|
4018
|
+
read: 18e4,
|
|
4019
|
+
write: 18e4,
|
|
4020
|
+
...requestOptions == null ? void 0 : requestOptions.timeouts
|
|
4021
|
+
}
|
|
4022
|
+
};
|
|
4023
|
+
return transporter.requestWithHttpInfo(request, requestOptions);
|
|
2000
4024
|
}
|
|
2001
4025
|
};
|
|
2002
4026
|
}
|