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