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