@algolia/ingestion 1.7.0 → 1.8.1
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 +5 -7
- package/dist/browser.d.ts +1295 -1335
- package/dist/builds/browser.js +201 -258
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +1 -1
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +2 -2
- package/dist/builds/fetch.js +198 -255
- package/dist/builds/fetch.js.map +1 -1
- package/dist/builds/node.cjs +198 -255
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +199 -256
- package/dist/builds/node.js.map +1 -1
- package/dist/fetch.d.ts +1294 -1333
- package/dist/node.d.cts +1294 -1333
- package/dist/node.d.ts +1294 -1333
- package/dist/src/ingestionClient.cjs +197 -254
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +197 -254
- package/dist/src/ingestionClient.js.map +1 -1
- package/index.d.ts +0 -1
- package/index.js +1 -2
- package/model/action.ts +4 -4
- package/model/actionType.ts +1 -1
- package/model/authInput.ts +5 -5
- package/model/authInputPartial.ts +5 -5
- package/model/authenticationSearch.ts +1 -1
- package/model/authenticationSortKeys.ts +1 -1
- package/model/authenticationType.ts +1 -1
- package/model/bigCommerceChannel.ts +1 -1
- package/model/clientMethodProps.ts +61 -49
- package/model/commercetoolsCustomFields.ts +3 -3
- package/model/destination.ts +1 -1
- package/model/destinationCreate.ts +1 -1
- package/model/destinationIndexName.ts +1 -1
- package/model/destinationSearch.ts +1 -1
- package/model/destinationSortKeys.ts +1 -1
- package/model/destinationType.ts +1 -1
- package/model/destinationUpdate.ts +1 -1
- package/model/dockerImageType.ts +1 -1
- package/model/dockerStreams.ts +3 -3
- package/model/dockerStreamsInput.ts +1 -1
- package/model/dockerStreamsSyncMode.ts +1 -1
- package/model/entityType.ts +1 -1
- package/model/event.ts +1 -1
- package/model/eventSortKeys.ts +1 -1
- package/model/eventStatus.ts +1 -1
- package/model/eventType.ts +1 -1
- package/model/index.ts +10 -10
- package/model/listAuthenticationsResponse.ts +1 -1
- package/model/listDestinationsResponse.ts +1 -1
- package/model/listEventsResponse.ts +1 -1
- package/model/listSourcesResponse.ts +1 -1
- package/model/listTasksResponse.ts +1 -1
- package/model/listTasksResponseV1.ts +1 -1
- package/model/listTransformationsResponse.ts +1 -1
- package/model/mappingFieldDirective.ts +1 -1
- package/model/mappingInput.ts +1 -1
- package/model/mappingKitAction.ts +1 -1
- package/model/mappingTypeCSV.ts +1 -1
- package/model/pushTaskPayload.ts +1 -1
- package/model/runListResponse.ts +1 -1
- package/model/runOutcome.ts +1 -1
- package/model/runReasonCode.ts +1 -1
- package/model/runSortKeys.ts +1 -1
- package/model/runSourcePayload.ts +3 -3
- package/model/runSourceResponse.ts +1 -1
- package/model/runStatus.ts +1 -1
- package/model/runType.ts +1 -1
- package/model/shopifyInput.ts +1 -1
- package/model/shopifyMarket.ts +3 -3
- package/model/sourceBigCommerce.ts +3 -3
- package/model/sourceCSV.ts +1 -1
- package/model/sourceCommercetools.ts +2 -2
- package/model/sourceInput.ts +4 -4
- package/model/sourceSearch.ts +1 -1
- package/model/sourceShopify.ts +1 -1
- package/model/sourceSortKeys.ts +1 -1
- package/model/sourceType.ts +2 -2
- package/model/sourceUpdateCommercetools.ts +2 -2
- package/model/sourceUpdateInput.ts +3 -3
- package/model/sourceUpdateShopify.ts +1 -1
- package/model/sourceWatchResponse.ts +4 -4
- package/model/taskCreateTrigger.ts +2 -1
- package/model/taskInput.ts +3 -1
- package/model/taskSearch.ts +1 -1
- package/model/taskSortKeys.ts +1 -1
- package/model/transformation.ts +2 -2
- package/model/transformationCreate.ts +2 -2
- package/model/transformationSearch.ts +1 -1
- package/model/transformationSortKeys.ts +1 -1
- package/model/transformationTry.ts +1 -1
- package/model/trigger.ts +2 -1
- package/model/triggerType.ts +1 -1
- package/package.json +6 -6
|
@@ -29,7 +29,7 @@ __export(ingestionClient_exports, {
|
|
|
29
29
|
});
|
|
30
30
|
module.exports = __toCommonJS(ingestionClient_exports);
|
|
31
31
|
var import_client_common = require("@algolia/client-common");
|
|
32
|
-
var apiClientVersion = "1.
|
|
32
|
+
var apiClientVersion = "1.8.1";
|
|
33
33
|
var REGIONS = ["eu", "us"];
|
|
34
34
|
function getDefaultHosts(region) {
|
|
35
35
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -115,11 +115,10 @@ function createIngestionClient({
|
|
|
115
115
|
* Creates a new authentication resource.
|
|
116
116
|
*
|
|
117
117
|
* Required API Key ACLs:
|
|
118
|
-
*
|
|
119
|
-
*
|
|
120
|
-
*
|
|
121
|
-
*
|
|
122
|
-
* @param authenticationCreate -.
|
|
118
|
+
* - addObject
|
|
119
|
+
* - deleteIndex
|
|
120
|
+
* - editSettings
|
|
121
|
+
* @param authenticationCreate -
|
|
123
122
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
124
123
|
*/
|
|
125
124
|
createAuthentication(authenticationCreate, requestOptions) {
|
|
@@ -151,11 +150,10 @@ function createIngestionClient({
|
|
|
151
150
|
* Creates a new destination.
|
|
152
151
|
*
|
|
153
152
|
* Required API Key ACLs:
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
*
|
|
158
|
-
* @param destinationCreate -.
|
|
153
|
+
* - addObject
|
|
154
|
+
* - deleteIndex
|
|
155
|
+
* - editSettings
|
|
156
|
+
* @param destinationCreate -
|
|
159
157
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
160
158
|
*/
|
|
161
159
|
createDestination(destinationCreate, requestOptions) {
|
|
@@ -187,11 +185,10 @@ function createIngestionClient({
|
|
|
187
185
|
* Creates a new source.
|
|
188
186
|
*
|
|
189
187
|
* Required API Key ACLs:
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
*
|
|
194
|
-
* @param sourceCreate -.
|
|
188
|
+
* - addObject
|
|
189
|
+
* - deleteIndex
|
|
190
|
+
* - editSettings
|
|
191
|
+
* @param sourceCreate -
|
|
195
192
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
196
193
|
*/
|
|
197
194
|
createSource(sourceCreate, requestOptions) {
|
|
@@ -218,7 +215,6 @@ function createIngestionClient({
|
|
|
218
215
|
},
|
|
219
216
|
/**
|
|
220
217
|
* Creates a new task.
|
|
221
|
-
*
|
|
222
218
|
* @param taskCreate - Request body for creating a task.
|
|
223
219
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
224
220
|
*/
|
|
@@ -249,7 +245,6 @@ function createIngestionClient({
|
|
|
249
245
|
},
|
|
250
246
|
/**
|
|
251
247
|
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
252
|
-
*
|
|
253
248
|
* @param taskCreate - Request body for creating a task.
|
|
254
249
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
255
250
|
*/
|
|
@@ -283,7 +278,6 @@ function createIngestionClient({
|
|
|
283
278
|
},
|
|
284
279
|
/**
|
|
285
280
|
* Creates a new transformation.
|
|
286
|
-
*
|
|
287
281
|
* @param transformationCreate - Request body for creating a transformation.
|
|
288
282
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
289
283
|
*/
|
|
@@ -311,7 +305,6 @@ function createIngestionClient({
|
|
|
311
305
|
},
|
|
312
306
|
/**
|
|
313
307
|
* This method allow you to send requests to the Algolia REST API.
|
|
314
|
-
*
|
|
315
308
|
* @param customDelete - The customDelete object.
|
|
316
309
|
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
317
310
|
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
@@ -334,7 +327,6 @@ function createIngestionClient({
|
|
|
334
327
|
},
|
|
335
328
|
/**
|
|
336
329
|
* This method allow you to send requests to the Algolia REST API.
|
|
337
|
-
*
|
|
338
330
|
* @param customGet - The customGet object.
|
|
339
331
|
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
340
332
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -357,7 +349,6 @@ function createIngestionClient({
|
|
|
357
349
|
},
|
|
358
350
|
/**
|
|
359
351
|
* This method allow you to send requests to the Algolia REST API.
|
|
360
|
-
*
|
|
361
352
|
* @param customPost - The customPost object.
|
|
362
353
|
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
363
354
|
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
@@ -382,7 +373,6 @@ function createIngestionClient({
|
|
|
382
373
|
},
|
|
383
374
|
/**
|
|
384
375
|
* This method allow you to send requests to the Algolia REST API.
|
|
385
|
-
*
|
|
386
376
|
* @param customPut - The customPut object.
|
|
387
377
|
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
388
378
|
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
@@ -409,10 +399,9 @@ function createIngestionClient({
|
|
|
409
399
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
410
400
|
*
|
|
411
401
|
* Required API Key ACLs:
|
|
412
|
-
*
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
402
|
+
* - addObject
|
|
403
|
+
* - deleteIndex
|
|
404
|
+
* - editSettings
|
|
416
405
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
417
406
|
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
418
407
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -439,10 +428,9 @@ function createIngestionClient({
|
|
|
439
428
|
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
440
429
|
*
|
|
441
430
|
* Required API Key ACLs:
|
|
442
|
-
*
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
431
|
+
* - addObject
|
|
432
|
+
* - deleteIndex
|
|
433
|
+
* - editSettings
|
|
446
434
|
* @param deleteDestination - The deleteDestination object.
|
|
447
435
|
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
448
436
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -469,10 +457,9 @@ function createIngestionClient({
|
|
|
469
457
|
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
470
458
|
*
|
|
471
459
|
* Required API Key ACLs:
|
|
472
|
-
*
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
*
|
|
460
|
+
* - addObject
|
|
461
|
+
* - deleteIndex
|
|
462
|
+
* - editSettings
|
|
476
463
|
* @param deleteSource - The deleteSource object.
|
|
477
464
|
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
478
465
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -494,7 +481,6 @@ function createIngestionClient({
|
|
|
494
481
|
},
|
|
495
482
|
/**
|
|
496
483
|
* Deletes a task by its ID.
|
|
497
|
-
*
|
|
498
484
|
* @param deleteTask - The deleteTask object.
|
|
499
485
|
* @param deleteTask.taskID - Unique identifier of a task.
|
|
500
486
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -516,7 +502,6 @@ function createIngestionClient({
|
|
|
516
502
|
},
|
|
517
503
|
/**
|
|
518
504
|
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
519
|
-
*
|
|
520
505
|
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
521
506
|
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
522
507
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -538,7 +523,6 @@ function createIngestionClient({
|
|
|
538
523
|
},
|
|
539
524
|
/**
|
|
540
525
|
* Deletes a transformation by its ID.
|
|
541
|
-
*
|
|
542
526
|
* @param deleteTransformation - The deleteTransformation object.
|
|
543
527
|
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
544
528
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -565,10 +549,9 @@ function createIngestionClient({
|
|
|
565
549
|
* Disables a task.
|
|
566
550
|
*
|
|
567
551
|
* Required API Key ACLs:
|
|
568
|
-
*
|
|
569
|
-
*
|
|
570
|
-
*
|
|
571
|
-
*
|
|
552
|
+
* - addObject
|
|
553
|
+
* - deleteIndex
|
|
554
|
+
* - editSettings
|
|
572
555
|
* @param disableTask - The disableTask object.
|
|
573
556
|
* @param disableTask.taskID - Unique identifier of a task.
|
|
574
557
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -592,10 +575,9 @@ function createIngestionClient({
|
|
|
592
575
|
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
593
576
|
*
|
|
594
577
|
* Required API Key ACLs:
|
|
595
|
-
*
|
|
596
|
-
*
|
|
597
|
-
*
|
|
598
|
-
*
|
|
578
|
+
* - addObject
|
|
579
|
+
* - deleteIndex
|
|
580
|
+
* - editSettings
|
|
599
581
|
* @param disableTaskV1 - The disableTaskV1 object.
|
|
600
582
|
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
601
583
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -619,10 +601,9 @@ function createIngestionClient({
|
|
|
619
601
|
* Enables a task.
|
|
620
602
|
*
|
|
621
603
|
* Required API Key ACLs:
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
*
|
|
604
|
+
* - addObject
|
|
605
|
+
* - deleteIndex
|
|
606
|
+
* - editSettings
|
|
626
607
|
* @param enableTask - The enableTask object.
|
|
627
608
|
* @param enableTask.taskID - Unique identifier of a task.
|
|
628
609
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -646,10 +627,9 @@ function createIngestionClient({
|
|
|
646
627
|
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
647
628
|
*
|
|
648
629
|
* Required API Key ACLs:
|
|
649
|
-
*
|
|
650
|
-
*
|
|
651
|
-
*
|
|
652
|
-
*
|
|
630
|
+
* - addObject
|
|
631
|
+
* - deleteIndex
|
|
632
|
+
* - editSettings
|
|
653
633
|
* @param enableTaskV1 - The enableTaskV1 object.
|
|
654
634
|
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
655
635
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -673,10 +653,9 @@ function createIngestionClient({
|
|
|
673
653
|
* Retrieves an authentication resource by its ID.
|
|
674
654
|
*
|
|
675
655
|
* Required API Key ACLs:
|
|
676
|
-
*
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
656
|
+
* - addObject
|
|
657
|
+
* - deleteIndex
|
|
658
|
+
* - editSettings
|
|
680
659
|
* @param getAuthentication - The getAuthentication object.
|
|
681
660
|
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
682
661
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -703,10 +682,9 @@ function createIngestionClient({
|
|
|
703
682
|
* Retrieves a destination by its ID.
|
|
704
683
|
*
|
|
705
684
|
* Required API Key ACLs:
|
|
706
|
-
*
|
|
707
|
-
*
|
|
708
|
-
*
|
|
709
|
-
*
|
|
685
|
+
* - addObject
|
|
686
|
+
* - deleteIndex
|
|
687
|
+
* - editSettings
|
|
710
688
|
* @param getDestination - The getDestination object.
|
|
711
689
|
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
712
690
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -733,10 +711,9 @@ function createIngestionClient({
|
|
|
733
711
|
* Retrieves a single task run event by its ID.
|
|
734
712
|
*
|
|
735
713
|
* Required API Key ACLs:
|
|
736
|
-
*
|
|
737
|
-
*
|
|
738
|
-
*
|
|
739
|
-
*
|
|
714
|
+
* - addObject
|
|
715
|
+
* - deleteIndex
|
|
716
|
+
* - editSettings
|
|
740
717
|
* @param getEvent - The getEvent object.
|
|
741
718
|
* @param getEvent.runID - Unique identifier of a task run.
|
|
742
719
|
* @param getEvent.eventID - Unique identifier of an event.
|
|
@@ -764,10 +741,9 @@ function createIngestionClient({
|
|
|
764
741
|
* Retrieve a single task run by its ID.
|
|
765
742
|
*
|
|
766
743
|
* Required API Key ACLs:
|
|
767
|
-
*
|
|
768
|
-
*
|
|
769
|
-
*
|
|
770
|
-
*
|
|
744
|
+
* - addObject
|
|
745
|
+
* - deleteIndex
|
|
746
|
+
* - editSettings
|
|
771
747
|
* @param getRun - The getRun object.
|
|
772
748
|
* @param getRun.runID - Unique identifier of a task run.
|
|
773
749
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -791,10 +767,9 @@ function createIngestionClient({
|
|
|
791
767
|
* Retrieve a source by its ID.
|
|
792
768
|
*
|
|
793
769
|
* Required API Key ACLs:
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
*
|
|
797
|
-
*
|
|
770
|
+
* - addObject
|
|
771
|
+
* - deleteIndex
|
|
772
|
+
* - editSettings
|
|
798
773
|
* @param getSource - The getSource object.
|
|
799
774
|
* @param getSource.sourceID - Unique identifier of a source.
|
|
800
775
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -818,10 +793,9 @@ function createIngestionClient({
|
|
|
818
793
|
* Retrieves a task by its ID.
|
|
819
794
|
*
|
|
820
795
|
* Required API Key ACLs:
|
|
821
|
-
*
|
|
822
|
-
*
|
|
823
|
-
*
|
|
824
|
-
*
|
|
796
|
+
* - addObject
|
|
797
|
+
* - deleteIndex
|
|
798
|
+
* - editSettings
|
|
825
799
|
* @param getTask - The getTask object.
|
|
826
800
|
* @param getTask.taskID - Unique identifier of a task.
|
|
827
801
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -845,10 +819,9 @@ function createIngestionClient({
|
|
|
845
819
|
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
846
820
|
*
|
|
847
821
|
* Required API Key ACLs:
|
|
848
|
-
*
|
|
849
|
-
*
|
|
850
|
-
*
|
|
851
|
-
*
|
|
822
|
+
* - addObject
|
|
823
|
+
* - deleteIndex
|
|
824
|
+
* - editSettings
|
|
852
825
|
* @param getTaskV1 - The getTaskV1 object.
|
|
853
826
|
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
854
827
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -872,10 +845,9 @@ function createIngestionClient({
|
|
|
872
845
|
* Retrieves a transformation by its ID.
|
|
873
846
|
*
|
|
874
847
|
* Required API Key ACLs:
|
|
875
|
-
*
|
|
876
|
-
*
|
|
877
|
-
*
|
|
878
|
-
*
|
|
848
|
+
* - addObject
|
|
849
|
+
* - deleteIndex
|
|
850
|
+
* - editSettings
|
|
879
851
|
* @param getTransformation - The getTransformation object.
|
|
880
852
|
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
881
853
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -902,10 +874,9 @@ function createIngestionClient({
|
|
|
902
874
|
* Retrieves a list of all authentication resources.
|
|
903
875
|
*
|
|
904
876
|
* Required API Key ACLs:
|
|
905
|
-
*
|
|
906
|
-
*
|
|
907
|
-
*
|
|
908
|
-
*
|
|
877
|
+
* - addObject
|
|
878
|
+
* - deleteIndex
|
|
879
|
+
* - editSettings
|
|
909
880
|
* @param listAuthentications - The listAuthentications object.
|
|
910
881
|
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
911
882
|
* @param listAuthentications.page - Page number of the paginated API response.
|
|
@@ -920,22 +891,22 @@ function createIngestionClient({
|
|
|
920
891
|
const headers = {};
|
|
921
892
|
const queryParameters = {};
|
|
922
893
|
if (itemsPerPage !== void 0) {
|
|
923
|
-
queryParameters
|
|
894
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
924
895
|
}
|
|
925
896
|
if (page !== void 0) {
|
|
926
|
-
queryParameters
|
|
897
|
+
queryParameters["page"] = page.toString();
|
|
927
898
|
}
|
|
928
899
|
if (type !== void 0) {
|
|
929
|
-
queryParameters
|
|
900
|
+
queryParameters["type"] = type.toString();
|
|
930
901
|
}
|
|
931
902
|
if (platform !== void 0) {
|
|
932
|
-
queryParameters
|
|
903
|
+
queryParameters["platform"] = platform.toString();
|
|
933
904
|
}
|
|
934
905
|
if (sort !== void 0) {
|
|
935
|
-
queryParameters
|
|
906
|
+
queryParameters["sort"] = sort.toString();
|
|
936
907
|
}
|
|
937
908
|
if (order !== void 0) {
|
|
938
|
-
queryParameters
|
|
909
|
+
queryParameters["order"] = order.toString();
|
|
939
910
|
}
|
|
940
911
|
const request = {
|
|
941
912
|
method: "GET",
|
|
@@ -949,10 +920,9 @@ function createIngestionClient({
|
|
|
949
920
|
* Retrieves a list of destinations.
|
|
950
921
|
*
|
|
951
922
|
* Required API Key ACLs:
|
|
952
|
-
*
|
|
953
|
-
*
|
|
954
|
-
*
|
|
955
|
-
*
|
|
923
|
+
* - addObject
|
|
924
|
+
* - deleteIndex
|
|
925
|
+
* - editSettings
|
|
956
926
|
* @param listDestinations - The listDestinations object.
|
|
957
927
|
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
958
928
|
* @param listDestinations.page - Page number of the paginated API response.
|
|
@@ -968,25 +938,25 @@ function createIngestionClient({
|
|
|
968
938
|
const headers = {};
|
|
969
939
|
const queryParameters = {};
|
|
970
940
|
if (itemsPerPage !== void 0) {
|
|
971
|
-
queryParameters
|
|
941
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
972
942
|
}
|
|
973
943
|
if (page !== void 0) {
|
|
974
|
-
queryParameters
|
|
944
|
+
queryParameters["page"] = page.toString();
|
|
975
945
|
}
|
|
976
946
|
if (type !== void 0) {
|
|
977
|
-
queryParameters
|
|
947
|
+
queryParameters["type"] = type.toString();
|
|
978
948
|
}
|
|
979
949
|
if (authenticationID !== void 0) {
|
|
980
|
-
queryParameters
|
|
950
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
981
951
|
}
|
|
982
952
|
if (transformationID !== void 0) {
|
|
983
|
-
queryParameters
|
|
953
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
984
954
|
}
|
|
985
955
|
if (sort !== void 0) {
|
|
986
|
-
queryParameters
|
|
956
|
+
queryParameters["sort"] = sort.toString();
|
|
987
957
|
}
|
|
988
958
|
if (order !== void 0) {
|
|
989
|
-
queryParameters
|
|
959
|
+
queryParameters["order"] = order.toString();
|
|
990
960
|
}
|
|
991
961
|
const request = {
|
|
992
962
|
method: "GET",
|
|
@@ -997,13 +967,12 @@ function createIngestionClient({
|
|
|
997
967
|
return transporter.request(request, requestOptions);
|
|
998
968
|
},
|
|
999
969
|
/**
|
|
1000
|
-
* Retrieves a list of events for a task run, identified by
|
|
970
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1001
971
|
*
|
|
1002
972
|
* Required API Key ACLs:
|
|
1003
|
-
*
|
|
1004
|
-
*
|
|
1005
|
-
*
|
|
1006
|
-
*
|
|
973
|
+
* - addObject
|
|
974
|
+
* - deleteIndex
|
|
975
|
+
* - editSettings
|
|
1007
976
|
* @param listEvents - The listEvents object.
|
|
1008
977
|
* @param listEvents.runID - Unique identifier of a task run.
|
|
1009
978
|
* @param listEvents.itemsPerPage - Number of items per page.
|
|
@@ -1024,28 +993,28 @@ function createIngestionClient({
|
|
|
1024
993
|
const headers = {};
|
|
1025
994
|
const queryParameters = {};
|
|
1026
995
|
if (itemsPerPage !== void 0) {
|
|
1027
|
-
queryParameters
|
|
996
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1028
997
|
}
|
|
1029
998
|
if (page !== void 0) {
|
|
1030
|
-
queryParameters
|
|
999
|
+
queryParameters["page"] = page.toString();
|
|
1031
1000
|
}
|
|
1032
1001
|
if (status !== void 0) {
|
|
1033
|
-
queryParameters
|
|
1002
|
+
queryParameters["status"] = status.toString();
|
|
1034
1003
|
}
|
|
1035
1004
|
if (type !== void 0) {
|
|
1036
|
-
queryParameters
|
|
1005
|
+
queryParameters["type"] = type.toString();
|
|
1037
1006
|
}
|
|
1038
1007
|
if (sort !== void 0) {
|
|
1039
|
-
queryParameters
|
|
1008
|
+
queryParameters["sort"] = sort.toString();
|
|
1040
1009
|
}
|
|
1041
1010
|
if (order !== void 0) {
|
|
1042
|
-
queryParameters
|
|
1011
|
+
queryParameters["order"] = order.toString();
|
|
1043
1012
|
}
|
|
1044
1013
|
if (startDate !== void 0) {
|
|
1045
|
-
queryParameters
|
|
1014
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1046
1015
|
}
|
|
1047
1016
|
if (endDate !== void 0) {
|
|
1048
|
-
queryParameters
|
|
1017
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1049
1018
|
}
|
|
1050
1019
|
const request = {
|
|
1051
1020
|
method: "GET",
|
|
@@ -1059,10 +1028,9 @@ function createIngestionClient({
|
|
|
1059
1028
|
* Retrieve a list of task runs.
|
|
1060
1029
|
*
|
|
1061
1030
|
* Required API Key ACLs:
|
|
1062
|
-
*
|
|
1063
|
-
*
|
|
1064
|
-
*
|
|
1065
|
-
*
|
|
1031
|
+
* - addObject
|
|
1032
|
+
* - deleteIndex
|
|
1033
|
+
* - editSettings
|
|
1066
1034
|
* @param listRuns - The listRuns object.
|
|
1067
1035
|
* @param listRuns.itemsPerPage - Number of items per page.
|
|
1068
1036
|
* @param listRuns.page - Page number of the paginated API response.
|
|
@@ -1080,31 +1048,31 @@ function createIngestionClient({
|
|
|
1080
1048
|
const headers = {};
|
|
1081
1049
|
const queryParameters = {};
|
|
1082
1050
|
if (itemsPerPage !== void 0) {
|
|
1083
|
-
queryParameters
|
|
1051
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1084
1052
|
}
|
|
1085
1053
|
if (page !== void 0) {
|
|
1086
|
-
queryParameters
|
|
1054
|
+
queryParameters["page"] = page.toString();
|
|
1087
1055
|
}
|
|
1088
1056
|
if (status !== void 0) {
|
|
1089
|
-
queryParameters
|
|
1057
|
+
queryParameters["status"] = status.toString();
|
|
1090
1058
|
}
|
|
1091
1059
|
if (type !== void 0) {
|
|
1092
|
-
queryParameters
|
|
1060
|
+
queryParameters["type"] = type.toString();
|
|
1093
1061
|
}
|
|
1094
1062
|
if (taskID !== void 0) {
|
|
1095
|
-
queryParameters
|
|
1063
|
+
queryParameters["taskID"] = taskID.toString();
|
|
1096
1064
|
}
|
|
1097
1065
|
if (sort !== void 0) {
|
|
1098
|
-
queryParameters
|
|
1066
|
+
queryParameters["sort"] = sort.toString();
|
|
1099
1067
|
}
|
|
1100
1068
|
if (order !== void 0) {
|
|
1101
|
-
queryParameters
|
|
1069
|
+
queryParameters["order"] = order.toString();
|
|
1102
1070
|
}
|
|
1103
1071
|
if (startDate !== void 0) {
|
|
1104
|
-
queryParameters
|
|
1072
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1105
1073
|
}
|
|
1106
1074
|
if (endDate !== void 0) {
|
|
1107
|
-
queryParameters
|
|
1075
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1108
1076
|
}
|
|
1109
1077
|
const request = {
|
|
1110
1078
|
method: "GET",
|
|
@@ -1118,10 +1086,9 @@ function createIngestionClient({
|
|
|
1118
1086
|
* Retrieves a list of sources.
|
|
1119
1087
|
*
|
|
1120
1088
|
* Required API Key ACLs:
|
|
1121
|
-
*
|
|
1122
|
-
*
|
|
1123
|
-
*
|
|
1124
|
-
*
|
|
1089
|
+
* - addObject
|
|
1090
|
+
* - deleteIndex
|
|
1091
|
+
* - editSettings
|
|
1125
1092
|
* @param listSources - The listSources object.
|
|
1126
1093
|
* @param listSources.itemsPerPage - Number of items per page.
|
|
1127
1094
|
* @param listSources.page - Page number of the paginated API response.
|
|
@@ -1136,22 +1103,22 @@ function createIngestionClient({
|
|
|
1136
1103
|
const headers = {};
|
|
1137
1104
|
const queryParameters = {};
|
|
1138
1105
|
if (itemsPerPage !== void 0) {
|
|
1139
|
-
queryParameters
|
|
1106
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1140
1107
|
}
|
|
1141
1108
|
if (page !== void 0) {
|
|
1142
|
-
queryParameters
|
|
1109
|
+
queryParameters["page"] = page.toString();
|
|
1143
1110
|
}
|
|
1144
1111
|
if (type !== void 0) {
|
|
1145
|
-
queryParameters
|
|
1112
|
+
queryParameters["type"] = type.toString();
|
|
1146
1113
|
}
|
|
1147
1114
|
if (authenticationID !== void 0) {
|
|
1148
|
-
queryParameters
|
|
1115
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1149
1116
|
}
|
|
1150
1117
|
if (sort !== void 0) {
|
|
1151
|
-
queryParameters
|
|
1118
|
+
queryParameters["sort"] = sort.toString();
|
|
1152
1119
|
}
|
|
1153
1120
|
if (order !== void 0) {
|
|
1154
|
-
queryParameters
|
|
1121
|
+
queryParameters["order"] = order.toString();
|
|
1155
1122
|
}
|
|
1156
1123
|
const request = {
|
|
1157
1124
|
method: "GET",
|
|
@@ -1165,10 +1132,9 @@ function createIngestionClient({
|
|
|
1165
1132
|
* Retrieves a list of tasks.
|
|
1166
1133
|
*
|
|
1167
1134
|
* Required API Key ACLs:
|
|
1168
|
-
*
|
|
1169
|
-
*
|
|
1170
|
-
*
|
|
1171
|
-
*
|
|
1135
|
+
* - addObject
|
|
1136
|
+
* - deleteIndex
|
|
1137
|
+
* - editSettings
|
|
1172
1138
|
* @param listTasks - The listTasks object.
|
|
1173
1139
|
* @param listTasks.itemsPerPage - Number of items per page.
|
|
1174
1140
|
* @param listTasks.page - Page number of the paginated API response.
|
|
@@ -1186,31 +1152,31 @@ function createIngestionClient({
|
|
|
1186
1152
|
const headers = {};
|
|
1187
1153
|
const queryParameters = {};
|
|
1188
1154
|
if (itemsPerPage !== void 0) {
|
|
1189
|
-
queryParameters
|
|
1155
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1190
1156
|
}
|
|
1191
1157
|
if (page !== void 0) {
|
|
1192
|
-
queryParameters
|
|
1158
|
+
queryParameters["page"] = page.toString();
|
|
1193
1159
|
}
|
|
1194
1160
|
if (action !== void 0) {
|
|
1195
|
-
queryParameters
|
|
1161
|
+
queryParameters["action"] = action.toString();
|
|
1196
1162
|
}
|
|
1197
1163
|
if (enabled !== void 0) {
|
|
1198
|
-
queryParameters
|
|
1164
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1199
1165
|
}
|
|
1200
1166
|
if (sourceID !== void 0) {
|
|
1201
|
-
queryParameters
|
|
1167
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1202
1168
|
}
|
|
1203
1169
|
if (destinationID !== void 0) {
|
|
1204
|
-
queryParameters
|
|
1170
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1205
1171
|
}
|
|
1206
1172
|
if (triggerType !== void 0) {
|
|
1207
|
-
queryParameters
|
|
1173
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1208
1174
|
}
|
|
1209
1175
|
if (sort !== void 0) {
|
|
1210
|
-
queryParameters
|
|
1176
|
+
queryParameters["sort"] = sort.toString();
|
|
1211
1177
|
}
|
|
1212
1178
|
if (order !== void 0) {
|
|
1213
|
-
queryParameters
|
|
1179
|
+
queryParameters["order"] = order.toString();
|
|
1214
1180
|
}
|
|
1215
1181
|
const request = {
|
|
1216
1182
|
method: "GET",
|
|
@@ -1224,10 +1190,9 @@ function createIngestionClient({
|
|
|
1224
1190
|
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
1225
1191
|
*
|
|
1226
1192
|
* Required API Key ACLs:
|
|
1227
|
-
*
|
|
1228
|
-
*
|
|
1229
|
-
*
|
|
1230
|
-
*
|
|
1193
|
+
* - addObject
|
|
1194
|
+
* - deleteIndex
|
|
1195
|
+
* - editSettings
|
|
1231
1196
|
* @param listTasksV1 - The listTasksV1 object.
|
|
1232
1197
|
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
1233
1198
|
* @param listTasksV1.page - Page number of the paginated API response.
|
|
@@ -1245,31 +1210,31 @@ function createIngestionClient({
|
|
|
1245
1210
|
const headers = {};
|
|
1246
1211
|
const queryParameters = {};
|
|
1247
1212
|
if (itemsPerPage !== void 0) {
|
|
1248
|
-
queryParameters
|
|
1213
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1249
1214
|
}
|
|
1250
1215
|
if (page !== void 0) {
|
|
1251
|
-
queryParameters
|
|
1216
|
+
queryParameters["page"] = page.toString();
|
|
1252
1217
|
}
|
|
1253
1218
|
if (action !== void 0) {
|
|
1254
|
-
queryParameters
|
|
1219
|
+
queryParameters["action"] = action.toString();
|
|
1255
1220
|
}
|
|
1256
1221
|
if (enabled !== void 0) {
|
|
1257
|
-
queryParameters
|
|
1222
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1258
1223
|
}
|
|
1259
1224
|
if (sourceID !== void 0) {
|
|
1260
|
-
queryParameters
|
|
1225
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1261
1226
|
}
|
|
1262
1227
|
if (destinationID !== void 0) {
|
|
1263
|
-
queryParameters
|
|
1228
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1264
1229
|
}
|
|
1265
1230
|
if (triggerType !== void 0) {
|
|
1266
|
-
queryParameters
|
|
1231
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1267
1232
|
}
|
|
1268
1233
|
if (sort !== void 0) {
|
|
1269
|
-
queryParameters
|
|
1234
|
+
queryParameters["sort"] = sort.toString();
|
|
1270
1235
|
}
|
|
1271
1236
|
if (order !== void 0) {
|
|
1272
|
-
queryParameters
|
|
1237
|
+
queryParameters["order"] = order.toString();
|
|
1273
1238
|
}
|
|
1274
1239
|
const request = {
|
|
1275
1240
|
method: "GET",
|
|
@@ -1283,10 +1248,9 @@ function createIngestionClient({
|
|
|
1283
1248
|
* Retrieves a list of transformations.
|
|
1284
1249
|
*
|
|
1285
1250
|
* Required API Key ACLs:
|
|
1286
|
-
*
|
|
1287
|
-
*
|
|
1288
|
-
*
|
|
1289
|
-
*
|
|
1251
|
+
* - addObject
|
|
1252
|
+
* - deleteIndex
|
|
1253
|
+
* - editSettings
|
|
1290
1254
|
* @param listTransformations - The listTransformations object.
|
|
1291
1255
|
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
1292
1256
|
* @param listTransformations.page - Page number of the paginated API response.
|
|
@@ -1299,16 +1263,16 @@ function createIngestionClient({
|
|
|
1299
1263
|
const headers = {};
|
|
1300
1264
|
const queryParameters = {};
|
|
1301
1265
|
if (itemsPerPage !== void 0) {
|
|
1302
|
-
queryParameters
|
|
1266
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1303
1267
|
}
|
|
1304
1268
|
if (page !== void 0) {
|
|
1305
|
-
queryParameters
|
|
1269
|
+
queryParameters["page"] = page.toString();
|
|
1306
1270
|
}
|
|
1307
1271
|
if (sort !== void 0) {
|
|
1308
|
-
queryParameters
|
|
1272
|
+
queryParameters["sort"] = sort.toString();
|
|
1309
1273
|
}
|
|
1310
1274
|
if (order !== void 0) {
|
|
1311
|
-
queryParameters
|
|
1275
|
+
queryParameters["order"] = order.toString();
|
|
1312
1276
|
}
|
|
1313
1277
|
const request = {
|
|
1314
1278
|
method: "GET",
|
|
@@ -1322,10 +1286,9 @@ function createIngestionClient({
|
|
|
1322
1286
|
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
1323
1287
|
*
|
|
1324
1288
|
* Required API Key ACLs:
|
|
1325
|
-
*
|
|
1326
|
-
*
|
|
1327
|
-
*
|
|
1328
|
-
*
|
|
1289
|
+
* - addObject
|
|
1290
|
+
* - deleteIndex
|
|
1291
|
+
* - editSettings
|
|
1329
1292
|
* @param pushTask - The pushTask object.
|
|
1330
1293
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1331
1294
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
@@ -1360,13 +1323,12 @@ function createIngestionClient({
|
|
|
1360
1323
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
1361
1324
|
*
|
|
1362
1325
|
* Required API Key ACLs:
|
|
1363
|
-
*
|
|
1364
|
-
*
|
|
1365
|
-
*
|
|
1366
|
-
*
|
|
1326
|
+
* - addObject
|
|
1327
|
+
* - deleteIndex
|
|
1328
|
+
* - editSettings
|
|
1367
1329
|
* @param runSource - The runSource object.
|
|
1368
1330
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1369
|
-
* @param runSource.runSourcePayload
|
|
1331
|
+
* @param runSource.runSourcePayload -
|
|
1370
1332
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1371
1333
|
*/
|
|
1372
1334
|
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
@@ -1389,10 +1351,9 @@ function createIngestionClient({
|
|
|
1389
1351
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
1390
1352
|
*
|
|
1391
1353
|
* Required API Key ACLs:
|
|
1392
|
-
*
|
|
1393
|
-
*
|
|
1394
|
-
*
|
|
1395
|
-
*
|
|
1354
|
+
* - addObject
|
|
1355
|
+
* - deleteIndex
|
|
1356
|
+
* - editSettings
|
|
1396
1357
|
* @param runTask - The runTask object.
|
|
1397
1358
|
* @param runTask.taskID - Unique identifier of a task.
|
|
1398
1359
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1416,10 +1377,9 @@ function createIngestionClient({
|
|
|
1416
1377
|
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1417
1378
|
*
|
|
1418
1379
|
* Required API Key ACLs:
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1421
|
-
*
|
|
1422
|
-
*
|
|
1380
|
+
* - addObject
|
|
1381
|
+
* - deleteIndex
|
|
1382
|
+
* - editSettings
|
|
1423
1383
|
* @param runTaskV1 - The runTaskV1 object.
|
|
1424
1384
|
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
1425
1385
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1443,10 +1403,9 @@ function createIngestionClient({
|
|
|
1443
1403
|
* Searches for authentication resources.
|
|
1444
1404
|
*
|
|
1445
1405
|
* Required API Key ACLs:
|
|
1446
|
-
*
|
|
1447
|
-
*
|
|
1448
|
-
*
|
|
1449
|
-
*
|
|
1406
|
+
* - addObject
|
|
1407
|
+
* - deleteIndex
|
|
1408
|
+
* - editSettings
|
|
1450
1409
|
* @param authenticationSearch - The authenticationSearch object.
|
|
1451
1410
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1452
1411
|
*/
|
|
@@ -1475,10 +1434,9 @@ function createIngestionClient({
|
|
|
1475
1434
|
* Searches for destinations.
|
|
1476
1435
|
*
|
|
1477
1436
|
* Required API Key ACLs:
|
|
1478
|
-
*
|
|
1479
|
-
*
|
|
1480
|
-
*
|
|
1481
|
-
*
|
|
1437
|
+
* - addObject
|
|
1438
|
+
* - deleteIndex
|
|
1439
|
+
* - editSettings
|
|
1482
1440
|
* @param destinationSearch - The destinationSearch object.
|
|
1483
1441
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1484
1442
|
*/
|
|
@@ -1505,10 +1463,9 @@ function createIngestionClient({
|
|
|
1505
1463
|
* Searches for sources.
|
|
1506
1464
|
*
|
|
1507
1465
|
* Required API Key ACLs:
|
|
1508
|
-
*
|
|
1509
|
-
*
|
|
1510
|
-
*
|
|
1511
|
-
*
|
|
1466
|
+
* - addObject
|
|
1467
|
+
* - deleteIndex
|
|
1468
|
+
* - editSettings
|
|
1512
1469
|
* @param sourceSearch - The sourceSearch object.
|
|
1513
1470
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1514
1471
|
*/
|
|
@@ -1535,10 +1492,9 @@ function createIngestionClient({
|
|
|
1535
1492
|
* Searches for tasks.
|
|
1536
1493
|
*
|
|
1537
1494
|
* Required API Key ACLs:
|
|
1538
|
-
*
|
|
1539
|
-
*
|
|
1540
|
-
*
|
|
1541
|
-
*
|
|
1495
|
+
* - addObject
|
|
1496
|
+
* - deleteIndex
|
|
1497
|
+
* - editSettings
|
|
1542
1498
|
* @param taskSearch - The taskSearch object.
|
|
1543
1499
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1544
1500
|
*/
|
|
@@ -1565,10 +1521,9 @@ function createIngestionClient({
|
|
|
1565
1521
|
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
1566
1522
|
*
|
|
1567
1523
|
* Required API Key ACLs:
|
|
1568
|
-
*
|
|
1569
|
-
*
|
|
1570
|
-
*
|
|
1571
|
-
*
|
|
1524
|
+
* - addObject
|
|
1525
|
+
* - deleteIndex
|
|
1526
|
+
* - editSettings
|
|
1572
1527
|
* @param taskSearch - The taskSearch object.
|
|
1573
1528
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1574
1529
|
*/
|
|
@@ -1595,10 +1550,9 @@ function createIngestionClient({
|
|
|
1595
1550
|
* Searches for transformations.
|
|
1596
1551
|
*
|
|
1597
1552
|
* Required API Key ACLs:
|
|
1598
|
-
*
|
|
1599
|
-
*
|
|
1600
|
-
*
|
|
1601
|
-
*
|
|
1553
|
+
* - addObject
|
|
1554
|
+
* - deleteIndex
|
|
1555
|
+
* - editSettings
|
|
1602
1556
|
* @param transformationSearch - The transformationSearch object.
|
|
1603
1557
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1604
1558
|
*/
|
|
@@ -1627,10 +1581,9 @@ function createIngestionClient({
|
|
|
1627
1581
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1628
1582
|
*
|
|
1629
1583
|
* Required API Key ACLs:
|
|
1630
|
-
*
|
|
1631
|
-
*
|
|
1632
|
-
*
|
|
1633
|
-
*
|
|
1584
|
+
* - addObject
|
|
1585
|
+
* - deleteIndex
|
|
1586
|
+
* - editSettings
|
|
1634
1587
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1635
1588
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1636
1589
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1654,10 +1607,9 @@ function createIngestionClient({
|
|
|
1654
1607
|
* Try a transformation before creating it.
|
|
1655
1608
|
*
|
|
1656
1609
|
* Required API Key ACLs:
|
|
1657
|
-
*
|
|
1658
|
-
*
|
|
1659
|
-
*
|
|
1660
|
-
*
|
|
1610
|
+
* - addObject
|
|
1611
|
+
* - deleteIndex
|
|
1612
|
+
* - editSettings
|
|
1661
1613
|
* @param transformationTry - The transformationTry object.
|
|
1662
1614
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1663
1615
|
*/
|
|
@@ -1687,10 +1639,9 @@ function createIngestionClient({
|
|
|
1687
1639
|
* Try a transformation before updating it.
|
|
1688
1640
|
*
|
|
1689
1641
|
* Required API Key ACLs:
|
|
1690
|
-
*
|
|
1691
|
-
*
|
|
1692
|
-
*
|
|
1693
|
-
*
|
|
1642
|
+
* - addObject
|
|
1643
|
+
* - deleteIndex
|
|
1644
|
+
* - editSettings
|
|
1694
1645
|
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
1695
1646
|
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
1696
1647
|
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
@@ -1730,10 +1681,9 @@ function createIngestionClient({
|
|
|
1730
1681
|
* Updates an authentication resource.
|
|
1731
1682
|
*
|
|
1732
1683
|
* Required API Key ACLs:
|
|
1733
|
-
*
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1736
|
-
*
|
|
1684
|
+
* - addObject
|
|
1685
|
+
* - deleteIndex
|
|
1686
|
+
* - editSettings
|
|
1737
1687
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1738
1688
|
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1739
1689
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
@@ -1765,10 +1715,9 @@ function createIngestionClient({
|
|
|
1765
1715
|
* Updates the destination by its ID.
|
|
1766
1716
|
*
|
|
1767
1717
|
* Required API Key ACLs:
|
|
1768
|
-
*
|
|
1769
|
-
*
|
|
1770
|
-
*
|
|
1771
|
-
*
|
|
1718
|
+
* - addObject
|
|
1719
|
+
* - deleteIndex
|
|
1720
|
+
* - editSettings
|
|
1772
1721
|
* @param updateDestination - The updateDestination object.
|
|
1773
1722
|
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1774
1723
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
@@ -1800,10 +1749,9 @@ function createIngestionClient({
|
|
|
1800
1749
|
* Updates a source by its ID.
|
|
1801
1750
|
*
|
|
1802
1751
|
* Required API Key ACLs:
|
|
1803
|
-
*
|
|
1804
|
-
*
|
|
1805
|
-
*
|
|
1806
|
-
*
|
|
1752
|
+
* - addObject
|
|
1753
|
+
* - deleteIndex
|
|
1754
|
+
* - editSettings
|
|
1807
1755
|
* @param updateSource - The updateSource object.
|
|
1808
1756
|
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1809
1757
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
@@ -1830,7 +1778,6 @@ function createIngestionClient({
|
|
|
1830
1778
|
},
|
|
1831
1779
|
/**
|
|
1832
1780
|
* Updates a task by its ID.
|
|
1833
|
-
*
|
|
1834
1781
|
* @param updateTask - The updateTask object.
|
|
1835
1782
|
* @param updateTask.taskID - Unique identifier of a task.
|
|
1836
1783
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
@@ -1857,7 +1804,6 @@ function createIngestionClient({
|
|
|
1857
1804
|
},
|
|
1858
1805
|
/**
|
|
1859
1806
|
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
1860
|
-
*
|
|
1861
1807
|
* @param updateTaskV1 - The updateTaskV1 object.
|
|
1862
1808
|
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
1863
1809
|
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
@@ -1884,7 +1830,6 @@ function createIngestionClient({
|
|
|
1884
1830
|
},
|
|
1885
1831
|
/**
|
|
1886
1832
|
* Updates a transformation by its ID.
|
|
1887
|
-
*
|
|
1888
1833
|
* @param updateTransformation - The updateTransformation object.
|
|
1889
1834
|
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1890
1835
|
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
@@ -1922,11 +1867,10 @@ function createIngestionClient({
|
|
|
1922
1867
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1923
1868
|
*
|
|
1924
1869
|
* Required API Key ACLs:
|
|
1925
|
-
*
|
|
1926
|
-
*
|
|
1927
|
-
*
|
|
1928
|
-
*
|
|
1929
|
-
* @param sourceCreate -.
|
|
1870
|
+
* - addObject
|
|
1871
|
+
* - deleteIndex
|
|
1872
|
+
* - editSettings
|
|
1873
|
+
* @param sourceCreate -
|
|
1930
1874
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1931
1875
|
*/
|
|
1932
1876
|
validateSource(sourceCreate, requestOptions = void 0) {
|
|
@@ -1946,10 +1890,9 @@ function createIngestionClient({
|
|
|
1946
1890
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1947
1891
|
*
|
|
1948
1892
|
* Required API Key ACLs:
|
|
1949
|
-
*
|
|
1950
|
-
*
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
1893
|
+
* - addObject
|
|
1894
|
+
* - deleteIndex
|
|
1895
|
+
* - editSettings
|
|
1953
1896
|
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
1954
1897
|
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
1955
1898
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|