@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
package/dist/builds/node.cjs
CHANGED
|
@@ -27,12 +27,12 @@ __export(node_exports, {
|
|
|
27
27
|
isSubscriptionTrigger: () => isSubscriptionTrigger
|
|
28
28
|
});
|
|
29
29
|
module.exports = __toCommonJS(node_exports);
|
|
30
|
-
var import_client_common2 = require("@algolia/client-common");
|
|
31
30
|
var import_requester_node_http = require("@algolia/requester-node-http");
|
|
31
|
+
var import_client_common2 = require("@algolia/client-common");
|
|
32
32
|
|
|
33
33
|
// src/ingestionClient.ts
|
|
34
34
|
var import_client_common = require("@algolia/client-common");
|
|
35
|
-
var apiClientVersion = "1.
|
|
35
|
+
var apiClientVersion = "1.8.1";
|
|
36
36
|
var REGIONS = ["eu", "us"];
|
|
37
37
|
function getDefaultHosts(region) {
|
|
38
38
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -118,11 +118,10 @@ function createIngestionClient({
|
|
|
118
118
|
* Creates a new authentication resource.
|
|
119
119
|
*
|
|
120
120
|
* Required API Key ACLs:
|
|
121
|
-
*
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
* @param authenticationCreate -.
|
|
121
|
+
* - addObject
|
|
122
|
+
* - deleteIndex
|
|
123
|
+
* - editSettings
|
|
124
|
+
* @param authenticationCreate -
|
|
126
125
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
127
126
|
*/
|
|
128
127
|
createAuthentication(authenticationCreate, requestOptions) {
|
|
@@ -154,11 +153,10 @@ function createIngestionClient({
|
|
|
154
153
|
* Creates a new destination.
|
|
155
154
|
*
|
|
156
155
|
* Required API Key ACLs:
|
|
157
|
-
*
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
* @param destinationCreate -.
|
|
156
|
+
* - addObject
|
|
157
|
+
* - deleteIndex
|
|
158
|
+
* - editSettings
|
|
159
|
+
* @param destinationCreate -
|
|
162
160
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
163
161
|
*/
|
|
164
162
|
createDestination(destinationCreate, requestOptions) {
|
|
@@ -190,11 +188,10 @@ function createIngestionClient({
|
|
|
190
188
|
* Creates a new source.
|
|
191
189
|
*
|
|
192
190
|
* Required API Key ACLs:
|
|
193
|
-
*
|
|
194
|
-
*
|
|
195
|
-
*
|
|
196
|
-
*
|
|
197
|
-
* @param sourceCreate -.
|
|
191
|
+
* - addObject
|
|
192
|
+
* - deleteIndex
|
|
193
|
+
* - editSettings
|
|
194
|
+
* @param sourceCreate -
|
|
198
195
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
199
196
|
*/
|
|
200
197
|
createSource(sourceCreate, requestOptions) {
|
|
@@ -221,7 +218,6 @@ function createIngestionClient({
|
|
|
221
218
|
},
|
|
222
219
|
/**
|
|
223
220
|
* Creates a new task.
|
|
224
|
-
*
|
|
225
221
|
* @param taskCreate - Request body for creating a task.
|
|
226
222
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
227
223
|
*/
|
|
@@ -252,7 +248,6 @@ function createIngestionClient({
|
|
|
252
248
|
},
|
|
253
249
|
/**
|
|
254
250
|
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
255
|
-
*
|
|
256
251
|
* @param taskCreate - Request body for creating a task.
|
|
257
252
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
258
253
|
*/
|
|
@@ -286,7 +281,6 @@ function createIngestionClient({
|
|
|
286
281
|
},
|
|
287
282
|
/**
|
|
288
283
|
* Creates a new transformation.
|
|
289
|
-
*
|
|
290
284
|
* @param transformationCreate - Request body for creating a transformation.
|
|
291
285
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
292
286
|
*/
|
|
@@ -314,7 +308,6 @@ function createIngestionClient({
|
|
|
314
308
|
},
|
|
315
309
|
/**
|
|
316
310
|
* This method allow you to send requests to the Algolia REST API.
|
|
317
|
-
*
|
|
318
311
|
* @param customDelete - The customDelete object.
|
|
319
312
|
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
320
313
|
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
@@ -337,7 +330,6 @@ function createIngestionClient({
|
|
|
337
330
|
},
|
|
338
331
|
/**
|
|
339
332
|
* This method allow you to send requests to the Algolia REST API.
|
|
340
|
-
*
|
|
341
333
|
* @param customGet - The customGet object.
|
|
342
334
|
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
343
335
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -360,7 +352,6 @@ function createIngestionClient({
|
|
|
360
352
|
},
|
|
361
353
|
/**
|
|
362
354
|
* This method allow you to send requests to the Algolia REST API.
|
|
363
|
-
*
|
|
364
355
|
* @param customPost - The customPost object.
|
|
365
356
|
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
366
357
|
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
@@ -385,7 +376,6 @@ function createIngestionClient({
|
|
|
385
376
|
},
|
|
386
377
|
/**
|
|
387
378
|
* This method allow you to send requests to the Algolia REST API.
|
|
388
|
-
*
|
|
389
379
|
* @param customPut - The customPut object.
|
|
390
380
|
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
391
381
|
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
@@ -412,10 +402,9 @@ function createIngestionClient({
|
|
|
412
402
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
413
403
|
*
|
|
414
404
|
* Required API Key ACLs:
|
|
415
|
-
*
|
|
416
|
-
*
|
|
417
|
-
*
|
|
418
|
-
*
|
|
405
|
+
* - addObject
|
|
406
|
+
* - deleteIndex
|
|
407
|
+
* - editSettings
|
|
419
408
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
420
409
|
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
421
410
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -442,10 +431,9 @@ function createIngestionClient({
|
|
|
442
431
|
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
443
432
|
*
|
|
444
433
|
* Required API Key ACLs:
|
|
445
|
-
*
|
|
446
|
-
*
|
|
447
|
-
*
|
|
448
|
-
*
|
|
434
|
+
* - addObject
|
|
435
|
+
* - deleteIndex
|
|
436
|
+
* - editSettings
|
|
449
437
|
* @param deleteDestination - The deleteDestination object.
|
|
450
438
|
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
451
439
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -472,10 +460,9 @@ function createIngestionClient({
|
|
|
472
460
|
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
473
461
|
*
|
|
474
462
|
* Required API Key ACLs:
|
|
475
|
-
*
|
|
476
|
-
*
|
|
477
|
-
*
|
|
478
|
-
*
|
|
463
|
+
* - addObject
|
|
464
|
+
* - deleteIndex
|
|
465
|
+
* - editSettings
|
|
479
466
|
* @param deleteSource - The deleteSource object.
|
|
480
467
|
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
481
468
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -497,7 +484,6 @@ function createIngestionClient({
|
|
|
497
484
|
},
|
|
498
485
|
/**
|
|
499
486
|
* Deletes a task by its ID.
|
|
500
|
-
*
|
|
501
487
|
* @param deleteTask - The deleteTask object.
|
|
502
488
|
* @param deleteTask.taskID - Unique identifier of a task.
|
|
503
489
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -519,7 +505,6 @@ function createIngestionClient({
|
|
|
519
505
|
},
|
|
520
506
|
/**
|
|
521
507
|
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
522
|
-
*
|
|
523
508
|
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
524
509
|
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
525
510
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -541,7 +526,6 @@ function createIngestionClient({
|
|
|
541
526
|
},
|
|
542
527
|
/**
|
|
543
528
|
* Deletes a transformation by its ID.
|
|
544
|
-
*
|
|
545
529
|
* @param deleteTransformation - The deleteTransformation object.
|
|
546
530
|
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
547
531
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -568,10 +552,9 @@ function createIngestionClient({
|
|
|
568
552
|
* Disables a task.
|
|
569
553
|
*
|
|
570
554
|
* Required API Key ACLs:
|
|
571
|
-
*
|
|
572
|
-
*
|
|
573
|
-
*
|
|
574
|
-
*
|
|
555
|
+
* - addObject
|
|
556
|
+
* - deleteIndex
|
|
557
|
+
* - editSettings
|
|
575
558
|
* @param disableTask - The disableTask object.
|
|
576
559
|
* @param disableTask.taskID - Unique identifier of a task.
|
|
577
560
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -595,10 +578,9 @@ function createIngestionClient({
|
|
|
595
578
|
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
596
579
|
*
|
|
597
580
|
* Required API Key ACLs:
|
|
598
|
-
*
|
|
599
|
-
*
|
|
600
|
-
*
|
|
601
|
-
*
|
|
581
|
+
* - addObject
|
|
582
|
+
* - deleteIndex
|
|
583
|
+
* - editSettings
|
|
602
584
|
* @param disableTaskV1 - The disableTaskV1 object.
|
|
603
585
|
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
604
586
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -622,10 +604,9 @@ function createIngestionClient({
|
|
|
622
604
|
* Enables a task.
|
|
623
605
|
*
|
|
624
606
|
* Required API Key ACLs:
|
|
625
|
-
*
|
|
626
|
-
*
|
|
627
|
-
*
|
|
628
|
-
*
|
|
607
|
+
* - addObject
|
|
608
|
+
* - deleteIndex
|
|
609
|
+
* - editSettings
|
|
629
610
|
* @param enableTask - The enableTask object.
|
|
630
611
|
* @param enableTask.taskID - Unique identifier of a task.
|
|
631
612
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -649,10 +630,9 @@ function createIngestionClient({
|
|
|
649
630
|
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
650
631
|
*
|
|
651
632
|
* Required API Key ACLs:
|
|
652
|
-
*
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
633
|
+
* - addObject
|
|
634
|
+
* - deleteIndex
|
|
635
|
+
* - editSettings
|
|
656
636
|
* @param enableTaskV1 - The enableTaskV1 object.
|
|
657
637
|
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
658
638
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -676,10 +656,9 @@ function createIngestionClient({
|
|
|
676
656
|
* Retrieves an authentication resource by its ID.
|
|
677
657
|
*
|
|
678
658
|
* Required API Key ACLs:
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
*
|
|
659
|
+
* - addObject
|
|
660
|
+
* - deleteIndex
|
|
661
|
+
* - editSettings
|
|
683
662
|
* @param getAuthentication - The getAuthentication object.
|
|
684
663
|
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
685
664
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -706,10 +685,9 @@ function createIngestionClient({
|
|
|
706
685
|
* Retrieves a destination by its ID.
|
|
707
686
|
*
|
|
708
687
|
* Required API Key ACLs:
|
|
709
|
-
*
|
|
710
|
-
*
|
|
711
|
-
*
|
|
712
|
-
*
|
|
688
|
+
* - addObject
|
|
689
|
+
* - deleteIndex
|
|
690
|
+
* - editSettings
|
|
713
691
|
* @param getDestination - The getDestination object.
|
|
714
692
|
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
715
693
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -736,10 +714,9 @@ function createIngestionClient({
|
|
|
736
714
|
* Retrieves a single task run event by its ID.
|
|
737
715
|
*
|
|
738
716
|
* Required API Key ACLs:
|
|
739
|
-
*
|
|
740
|
-
*
|
|
741
|
-
*
|
|
742
|
-
*
|
|
717
|
+
* - addObject
|
|
718
|
+
* - deleteIndex
|
|
719
|
+
* - editSettings
|
|
743
720
|
* @param getEvent - The getEvent object.
|
|
744
721
|
* @param getEvent.runID - Unique identifier of a task run.
|
|
745
722
|
* @param getEvent.eventID - Unique identifier of an event.
|
|
@@ -767,10 +744,9 @@ function createIngestionClient({
|
|
|
767
744
|
* Retrieve a single task run by its ID.
|
|
768
745
|
*
|
|
769
746
|
* Required API Key ACLs:
|
|
770
|
-
*
|
|
771
|
-
*
|
|
772
|
-
*
|
|
773
|
-
*
|
|
747
|
+
* - addObject
|
|
748
|
+
* - deleteIndex
|
|
749
|
+
* - editSettings
|
|
774
750
|
* @param getRun - The getRun object.
|
|
775
751
|
* @param getRun.runID - Unique identifier of a task run.
|
|
776
752
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -794,10 +770,9 @@ function createIngestionClient({
|
|
|
794
770
|
* Retrieve a source by its ID.
|
|
795
771
|
*
|
|
796
772
|
* Required API Key ACLs:
|
|
797
|
-
*
|
|
798
|
-
*
|
|
799
|
-
*
|
|
800
|
-
*
|
|
773
|
+
* - addObject
|
|
774
|
+
* - deleteIndex
|
|
775
|
+
* - editSettings
|
|
801
776
|
* @param getSource - The getSource object.
|
|
802
777
|
* @param getSource.sourceID - Unique identifier of a source.
|
|
803
778
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -821,10 +796,9 @@ function createIngestionClient({
|
|
|
821
796
|
* Retrieves a task by its ID.
|
|
822
797
|
*
|
|
823
798
|
* Required API Key ACLs:
|
|
824
|
-
*
|
|
825
|
-
*
|
|
826
|
-
*
|
|
827
|
-
*
|
|
799
|
+
* - addObject
|
|
800
|
+
* - deleteIndex
|
|
801
|
+
* - editSettings
|
|
828
802
|
* @param getTask - The getTask object.
|
|
829
803
|
* @param getTask.taskID - Unique identifier of a task.
|
|
830
804
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -848,10 +822,9 @@ function createIngestionClient({
|
|
|
848
822
|
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
849
823
|
*
|
|
850
824
|
* Required API Key ACLs:
|
|
851
|
-
*
|
|
852
|
-
*
|
|
853
|
-
*
|
|
854
|
-
*
|
|
825
|
+
* - addObject
|
|
826
|
+
* - deleteIndex
|
|
827
|
+
* - editSettings
|
|
855
828
|
* @param getTaskV1 - The getTaskV1 object.
|
|
856
829
|
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
857
830
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -875,10 +848,9 @@ function createIngestionClient({
|
|
|
875
848
|
* Retrieves a transformation by its ID.
|
|
876
849
|
*
|
|
877
850
|
* Required API Key ACLs:
|
|
878
|
-
*
|
|
879
|
-
*
|
|
880
|
-
*
|
|
881
|
-
*
|
|
851
|
+
* - addObject
|
|
852
|
+
* - deleteIndex
|
|
853
|
+
* - editSettings
|
|
882
854
|
* @param getTransformation - The getTransformation object.
|
|
883
855
|
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
884
856
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -905,10 +877,9 @@ function createIngestionClient({
|
|
|
905
877
|
* Retrieves a list of all authentication resources.
|
|
906
878
|
*
|
|
907
879
|
* Required API Key ACLs:
|
|
908
|
-
*
|
|
909
|
-
*
|
|
910
|
-
*
|
|
911
|
-
*
|
|
880
|
+
* - addObject
|
|
881
|
+
* - deleteIndex
|
|
882
|
+
* - editSettings
|
|
912
883
|
* @param listAuthentications - The listAuthentications object.
|
|
913
884
|
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
914
885
|
* @param listAuthentications.page - Page number of the paginated API response.
|
|
@@ -923,22 +894,22 @@ function createIngestionClient({
|
|
|
923
894
|
const headers = {};
|
|
924
895
|
const queryParameters = {};
|
|
925
896
|
if (itemsPerPage !== void 0) {
|
|
926
|
-
queryParameters
|
|
897
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
927
898
|
}
|
|
928
899
|
if (page !== void 0) {
|
|
929
|
-
queryParameters
|
|
900
|
+
queryParameters["page"] = page.toString();
|
|
930
901
|
}
|
|
931
902
|
if (type !== void 0) {
|
|
932
|
-
queryParameters
|
|
903
|
+
queryParameters["type"] = type.toString();
|
|
933
904
|
}
|
|
934
905
|
if (platform !== void 0) {
|
|
935
|
-
queryParameters
|
|
906
|
+
queryParameters["platform"] = platform.toString();
|
|
936
907
|
}
|
|
937
908
|
if (sort !== void 0) {
|
|
938
|
-
queryParameters
|
|
909
|
+
queryParameters["sort"] = sort.toString();
|
|
939
910
|
}
|
|
940
911
|
if (order !== void 0) {
|
|
941
|
-
queryParameters
|
|
912
|
+
queryParameters["order"] = order.toString();
|
|
942
913
|
}
|
|
943
914
|
const request = {
|
|
944
915
|
method: "GET",
|
|
@@ -952,10 +923,9 @@ function createIngestionClient({
|
|
|
952
923
|
* Retrieves a list of destinations.
|
|
953
924
|
*
|
|
954
925
|
* Required API Key ACLs:
|
|
955
|
-
*
|
|
956
|
-
*
|
|
957
|
-
*
|
|
958
|
-
*
|
|
926
|
+
* - addObject
|
|
927
|
+
* - deleteIndex
|
|
928
|
+
* - editSettings
|
|
959
929
|
* @param listDestinations - The listDestinations object.
|
|
960
930
|
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
961
931
|
* @param listDestinations.page - Page number of the paginated API response.
|
|
@@ -971,25 +941,25 @@ function createIngestionClient({
|
|
|
971
941
|
const headers = {};
|
|
972
942
|
const queryParameters = {};
|
|
973
943
|
if (itemsPerPage !== void 0) {
|
|
974
|
-
queryParameters
|
|
944
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
975
945
|
}
|
|
976
946
|
if (page !== void 0) {
|
|
977
|
-
queryParameters
|
|
947
|
+
queryParameters["page"] = page.toString();
|
|
978
948
|
}
|
|
979
949
|
if (type !== void 0) {
|
|
980
|
-
queryParameters
|
|
950
|
+
queryParameters["type"] = type.toString();
|
|
981
951
|
}
|
|
982
952
|
if (authenticationID !== void 0) {
|
|
983
|
-
queryParameters
|
|
953
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
984
954
|
}
|
|
985
955
|
if (transformationID !== void 0) {
|
|
986
|
-
queryParameters
|
|
956
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
987
957
|
}
|
|
988
958
|
if (sort !== void 0) {
|
|
989
|
-
queryParameters
|
|
959
|
+
queryParameters["sort"] = sort.toString();
|
|
990
960
|
}
|
|
991
961
|
if (order !== void 0) {
|
|
992
|
-
queryParameters
|
|
962
|
+
queryParameters["order"] = order.toString();
|
|
993
963
|
}
|
|
994
964
|
const request = {
|
|
995
965
|
method: "GET",
|
|
@@ -1000,13 +970,12 @@ function createIngestionClient({
|
|
|
1000
970
|
return transporter.request(request, requestOptions);
|
|
1001
971
|
},
|
|
1002
972
|
/**
|
|
1003
|
-
* Retrieves a list of events for a task run, identified by
|
|
973
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1004
974
|
*
|
|
1005
975
|
* Required API Key ACLs:
|
|
1006
|
-
*
|
|
1007
|
-
*
|
|
1008
|
-
*
|
|
1009
|
-
*
|
|
976
|
+
* - addObject
|
|
977
|
+
* - deleteIndex
|
|
978
|
+
* - editSettings
|
|
1010
979
|
* @param listEvents - The listEvents object.
|
|
1011
980
|
* @param listEvents.runID - Unique identifier of a task run.
|
|
1012
981
|
* @param listEvents.itemsPerPage - Number of items per page.
|
|
@@ -1027,28 +996,28 @@ function createIngestionClient({
|
|
|
1027
996
|
const headers = {};
|
|
1028
997
|
const queryParameters = {};
|
|
1029
998
|
if (itemsPerPage !== void 0) {
|
|
1030
|
-
queryParameters
|
|
999
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1031
1000
|
}
|
|
1032
1001
|
if (page !== void 0) {
|
|
1033
|
-
queryParameters
|
|
1002
|
+
queryParameters["page"] = page.toString();
|
|
1034
1003
|
}
|
|
1035
1004
|
if (status !== void 0) {
|
|
1036
|
-
queryParameters
|
|
1005
|
+
queryParameters["status"] = status.toString();
|
|
1037
1006
|
}
|
|
1038
1007
|
if (type !== void 0) {
|
|
1039
|
-
queryParameters
|
|
1008
|
+
queryParameters["type"] = type.toString();
|
|
1040
1009
|
}
|
|
1041
1010
|
if (sort !== void 0) {
|
|
1042
|
-
queryParameters
|
|
1011
|
+
queryParameters["sort"] = sort.toString();
|
|
1043
1012
|
}
|
|
1044
1013
|
if (order !== void 0) {
|
|
1045
|
-
queryParameters
|
|
1014
|
+
queryParameters["order"] = order.toString();
|
|
1046
1015
|
}
|
|
1047
1016
|
if (startDate !== void 0) {
|
|
1048
|
-
queryParameters
|
|
1017
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1049
1018
|
}
|
|
1050
1019
|
if (endDate !== void 0) {
|
|
1051
|
-
queryParameters
|
|
1020
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1052
1021
|
}
|
|
1053
1022
|
const request = {
|
|
1054
1023
|
method: "GET",
|
|
@@ -1062,10 +1031,9 @@ function createIngestionClient({
|
|
|
1062
1031
|
* Retrieve a list of task runs.
|
|
1063
1032
|
*
|
|
1064
1033
|
* Required API Key ACLs:
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1034
|
+
* - addObject
|
|
1035
|
+
* - deleteIndex
|
|
1036
|
+
* - editSettings
|
|
1069
1037
|
* @param listRuns - The listRuns object.
|
|
1070
1038
|
* @param listRuns.itemsPerPage - Number of items per page.
|
|
1071
1039
|
* @param listRuns.page - Page number of the paginated API response.
|
|
@@ -1083,31 +1051,31 @@ function createIngestionClient({
|
|
|
1083
1051
|
const headers = {};
|
|
1084
1052
|
const queryParameters = {};
|
|
1085
1053
|
if (itemsPerPage !== void 0) {
|
|
1086
|
-
queryParameters
|
|
1054
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1087
1055
|
}
|
|
1088
1056
|
if (page !== void 0) {
|
|
1089
|
-
queryParameters
|
|
1057
|
+
queryParameters["page"] = page.toString();
|
|
1090
1058
|
}
|
|
1091
1059
|
if (status !== void 0) {
|
|
1092
|
-
queryParameters
|
|
1060
|
+
queryParameters["status"] = status.toString();
|
|
1093
1061
|
}
|
|
1094
1062
|
if (type !== void 0) {
|
|
1095
|
-
queryParameters
|
|
1063
|
+
queryParameters["type"] = type.toString();
|
|
1096
1064
|
}
|
|
1097
1065
|
if (taskID !== void 0) {
|
|
1098
|
-
queryParameters
|
|
1066
|
+
queryParameters["taskID"] = taskID.toString();
|
|
1099
1067
|
}
|
|
1100
1068
|
if (sort !== void 0) {
|
|
1101
|
-
queryParameters
|
|
1069
|
+
queryParameters["sort"] = sort.toString();
|
|
1102
1070
|
}
|
|
1103
1071
|
if (order !== void 0) {
|
|
1104
|
-
queryParameters
|
|
1072
|
+
queryParameters["order"] = order.toString();
|
|
1105
1073
|
}
|
|
1106
1074
|
if (startDate !== void 0) {
|
|
1107
|
-
queryParameters
|
|
1075
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1108
1076
|
}
|
|
1109
1077
|
if (endDate !== void 0) {
|
|
1110
|
-
queryParameters
|
|
1078
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1111
1079
|
}
|
|
1112
1080
|
const request = {
|
|
1113
1081
|
method: "GET",
|
|
@@ -1121,10 +1089,9 @@ function createIngestionClient({
|
|
|
1121
1089
|
* Retrieves a list of sources.
|
|
1122
1090
|
*
|
|
1123
1091
|
* Required API Key ACLs:
|
|
1124
|
-
*
|
|
1125
|
-
*
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1092
|
+
* - addObject
|
|
1093
|
+
* - deleteIndex
|
|
1094
|
+
* - editSettings
|
|
1128
1095
|
* @param listSources - The listSources object.
|
|
1129
1096
|
* @param listSources.itemsPerPage - Number of items per page.
|
|
1130
1097
|
* @param listSources.page - Page number of the paginated API response.
|
|
@@ -1139,22 +1106,22 @@ function createIngestionClient({
|
|
|
1139
1106
|
const headers = {};
|
|
1140
1107
|
const queryParameters = {};
|
|
1141
1108
|
if (itemsPerPage !== void 0) {
|
|
1142
|
-
queryParameters
|
|
1109
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1143
1110
|
}
|
|
1144
1111
|
if (page !== void 0) {
|
|
1145
|
-
queryParameters
|
|
1112
|
+
queryParameters["page"] = page.toString();
|
|
1146
1113
|
}
|
|
1147
1114
|
if (type !== void 0) {
|
|
1148
|
-
queryParameters
|
|
1115
|
+
queryParameters["type"] = type.toString();
|
|
1149
1116
|
}
|
|
1150
1117
|
if (authenticationID !== void 0) {
|
|
1151
|
-
queryParameters
|
|
1118
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1152
1119
|
}
|
|
1153
1120
|
if (sort !== void 0) {
|
|
1154
|
-
queryParameters
|
|
1121
|
+
queryParameters["sort"] = sort.toString();
|
|
1155
1122
|
}
|
|
1156
1123
|
if (order !== void 0) {
|
|
1157
|
-
queryParameters
|
|
1124
|
+
queryParameters["order"] = order.toString();
|
|
1158
1125
|
}
|
|
1159
1126
|
const request = {
|
|
1160
1127
|
method: "GET",
|
|
@@ -1168,10 +1135,9 @@ function createIngestionClient({
|
|
|
1168
1135
|
* Retrieves a list of tasks.
|
|
1169
1136
|
*
|
|
1170
1137
|
* Required API Key ACLs:
|
|
1171
|
-
*
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1174
|
-
*
|
|
1138
|
+
* - addObject
|
|
1139
|
+
* - deleteIndex
|
|
1140
|
+
* - editSettings
|
|
1175
1141
|
* @param listTasks - The listTasks object.
|
|
1176
1142
|
* @param listTasks.itemsPerPage - Number of items per page.
|
|
1177
1143
|
* @param listTasks.page - Page number of the paginated API response.
|
|
@@ -1189,31 +1155,31 @@ function createIngestionClient({
|
|
|
1189
1155
|
const headers = {};
|
|
1190
1156
|
const queryParameters = {};
|
|
1191
1157
|
if (itemsPerPage !== void 0) {
|
|
1192
|
-
queryParameters
|
|
1158
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1193
1159
|
}
|
|
1194
1160
|
if (page !== void 0) {
|
|
1195
|
-
queryParameters
|
|
1161
|
+
queryParameters["page"] = page.toString();
|
|
1196
1162
|
}
|
|
1197
1163
|
if (action !== void 0) {
|
|
1198
|
-
queryParameters
|
|
1164
|
+
queryParameters["action"] = action.toString();
|
|
1199
1165
|
}
|
|
1200
1166
|
if (enabled !== void 0) {
|
|
1201
|
-
queryParameters
|
|
1167
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1202
1168
|
}
|
|
1203
1169
|
if (sourceID !== void 0) {
|
|
1204
|
-
queryParameters
|
|
1170
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1205
1171
|
}
|
|
1206
1172
|
if (destinationID !== void 0) {
|
|
1207
|
-
queryParameters
|
|
1173
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1208
1174
|
}
|
|
1209
1175
|
if (triggerType !== void 0) {
|
|
1210
|
-
queryParameters
|
|
1176
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1211
1177
|
}
|
|
1212
1178
|
if (sort !== void 0) {
|
|
1213
|
-
queryParameters
|
|
1179
|
+
queryParameters["sort"] = sort.toString();
|
|
1214
1180
|
}
|
|
1215
1181
|
if (order !== void 0) {
|
|
1216
|
-
queryParameters
|
|
1182
|
+
queryParameters["order"] = order.toString();
|
|
1217
1183
|
}
|
|
1218
1184
|
const request = {
|
|
1219
1185
|
method: "GET",
|
|
@@ -1227,10 +1193,9 @@ function createIngestionClient({
|
|
|
1227
1193
|
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
1228
1194
|
*
|
|
1229
1195
|
* Required API Key ACLs:
|
|
1230
|
-
*
|
|
1231
|
-
*
|
|
1232
|
-
*
|
|
1233
|
-
*
|
|
1196
|
+
* - addObject
|
|
1197
|
+
* - deleteIndex
|
|
1198
|
+
* - editSettings
|
|
1234
1199
|
* @param listTasksV1 - The listTasksV1 object.
|
|
1235
1200
|
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
1236
1201
|
* @param listTasksV1.page - Page number of the paginated API response.
|
|
@@ -1248,31 +1213,31 @@ function createIngestionClient({
|
|
|
1248
1213
|
const headers = {};
|
|
1249
1214
|
const queryParameters = {};
|
|
1250
1215
|
if (itemsPerPage !== void 0) {
|
|
1251
|
-
queryParameters
|
|
1216
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1252
1217
|
}
|
|
1253
1218
|
if (page !== void 0) {
|
|
1254
|
-
queryParameters
|
|
1219
|
+
queryParameters["page"] = page.toString();
|
|
1255
1220
|
}
|
|
1256
1221
|
if (action !== void 0) {
|
|
1257
|
-
queryParameters
|
|
1222
|
+
queryParameters["action"] = action.toString();
|
|
1258
1223
|
}
|
|
1259
1224
|
if (enabled !== void 0) {
|
|
1260
|
-
queryParameters
|
|
1225
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1261
1226
|
}
|
|
1262
1227
|
if (sourceID !== void 0) {
|
|
1263
|
-
queryParameters
|
|
1228
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1264
1229
|
}
|
|
1265
1230
|
if (destinationID !== void 0) {
|
|
1266
|
-
queryParameters
|
|
1231
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1267
1232
|
}
|
|
1268
1233
|
if (triggerType !== void 0) {
|
|
1269
|
-
queryParameters
|
|
1234
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1270
1235
|
}
|
|
1271
1236
|
if (sort !== void 0) {
|
|
1272
|
-
queryParameters
|
|
1237
|
+
queryParameters["sort"] = sort.toString();
|
|
1273
1238
|
}
|
|
1274
1239
|
if (order !== void 0) {
|
|
1275
|
-
queryParameters
|
|
1240
|
+
queryParameters["order"] = order.toString();
|
|
1276
1241
|
}
|
|
1277
1242
|
const request = {
|
|
1278
1243
|
method: "GET",
|
|
@@ -1286,10 +1251,9 @@ function createIngestionClient({
|
|
|
1286
1251
|
* Retrieves a list of transformations.
|
|
1287
1252
|
*
|
|
1288
1253
|
* Required API Key ACLs:
|
|
1289
|
-
*
|
|
1290
|
-
*
|
|
1291
|
-
*
|
|
1292
|
-
*
|
|
1254
|
+
* - addObject
|
|
1255
|
+
* - deleteIndex
|
|
1256
|
+
* - editSettings
|
|
1293
1257
|
* @param listTransformations - The listTransformations object.
|
|
1294
1258
|
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
1295
1259
|
* @param listTransformations.page - Page number of the paginated API response.
|
|
@@ -1302,16 +1266,16 @@ function createIngestionClient({
|
|
|
1302
1266
|
const headers = {};
|
|
1303
1267
|
const queryParameters = {};
|
|
1304
1268
|
if (itemsPerPage !== void 0) {
|
|
1305
|
-
queryParameters
|
|
1269
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1306
1270
|
}
|
|
1307
1271
|
if (page !== void 0) {
|
|
1308
|
-
queryParameters
|
|
1272
|
+
queryParameters["page"] = page.toString();
|
|
1309
1273
|
}
|
|
1310
1274
|
if (sort !== void 0) {
|
|
1311
|
-
queryParameters
|
|
1275
|
+
queryParameters["sort"] = sort.toString();
|
|
1312
1276
|
}
|
|
1313
1277
|
if (order !== void 0) {
|
|
1314
|
-
queryParameters
|
|
1278
|
+
queryParameters["order"] = order.toString();
|
|
1315
1279
|
}
|
|
1316
1280
|
const request = {
|
|
1317
1281
|
method: "GET",
|
|
@@ -1325,10 +1289,9 @@ function createIngestionClient({
|
|
|
1325
1289
|
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
1326
1290
|
*
|
|
1327
1291
|
* Required API Key ACLs:
|
|
1328
|
-
*
|
|
1329
|
-
*
|
|
1330
|
-
*
|
|
1331
|
-
*
|
|
1292
|
+
* - addObject
|
|
1293
|
+
* - deleteIndex
|
|
1294
|
+
* - editSettings
|
|
1332
1295
|
* @param pushTask - The pushTask object.
|
|
1333
1296
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1334
1297
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
@@ -1363,13 +1326,12 @@ function createIngestionClient({
|
|
|
1363
1326
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
1364
1327
|
*
|
|
1365
1328
|
* Required API Key ACLs:
|
|
1366
|
-
*
|
|
1367
|
-
*
|
|
1368
|
-
*
|
|
1369
|
-
*
|
|
1329
|
+
* - addObject
|
|
1330
|
+
* - deleteIndex
|
|
1331
|
+
* - editSettings
|
|
1370
1332
|
* @param runSource - The runSource object.
|
|
1371
1333
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1372
|
-
* @param runSource.runSourcePayload
|
|
1334
|
+
* @param runSource.runSourcePayload -
|
|
1373
1335
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1374
1336
|
*/
|
|
1375
1337
|
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
@@ -1392,10 +1354,9 @@ function createIngestionClient({
|
|
|
1392
1354
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
1393
1355
|
*
|
|
1394
1356
|
* Required API Key ACLs:
|
|
1395
|
-
*
|
|
1396
|
-
*
|
|
1397
|
-
*
|
|
1398
|
-
*
|
|
1357
|
+
* - addObject
|
|
1358
|
+
* - deleteIndex
|
|
1359
|
+
* - editSettings
|
|
1399
1360
|
* @param runTask - The runTask object.
|
|
1400
1361
|
* @param runTask.taskID - Unique identifier of a task.
|
|
1401
1362
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1419,10 +1380,9 @@ function createIngestionClient({
|
|
|
1419
1380
|
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1420
1381
|
*
|
|
1421
1382
|
* Required API Key ACLs:
|
|
1422
|
-
*
|
|
1423
|
-
*
|
|
1424
|
-
*
|
|
1425
|
-
*
|
|
1383
|
+
* - addObject
|
|
1384
|
+
* - deleteIndex
|
|
1385
|
+
* - editSettings
|
|
1426
1386
|
* @param runTaskV1 - The runTaskV1 object.
|
|
1427
1387
|
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
1428
1388
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1446,10 +1406,9 @@ function createIngestionClient({
|
|
|
1446
1406
|
* Searches for authentication resources.
|
|
1447
1407
|
*
|
|
1448
1408
|
* Required API Key ACLs:
|
|
1449
|
-
*
|
|
1450
|
-
*
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1409
|
+
* - addObject
|
|
1410
|
+
* - deleteIndex
|
|
1411
|
+
* - editSettings
|
|
1453
1412
|
* @param authenticationSearch - The authenticationSearch object.
|
|
1454
1413
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1455
1414
|
*/
|
|
@@ -1478,10 +1437,9 @@ function createIngestionClient({
|
|
|
1478
1437
|
* Searches for destinations.
|
|
1479
1438
|
*
|
|
1480
1439
|
* Required API Key ACLs:
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1483
|
-
*
|
|
1484
|
-
*
|
|
1440
|
+
* - addObject
|
|
1441
|
+
* - deleteIndex
|
|
1442
|
+
* - editSettings
|
|
1485
1443
|
* @param destinationSearch - The destinationSearch object.
|
|
1486
1444
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1487
1445
|
*/
|
|
@@ -1508,10 +1466,9 @@ function createIngestionClient({
|
|
|
1508
1466
|
* Searches for sources.
|
|
1509
1467
|
*
|
|
1510
1468
|
* Required API Key ACLs:
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
1513
|
-
*
|
|
1514
|
-
*
|
|
1469
|
+
* - addObject
|
|
1470
|
+
* - deleteIndex
|
|
1471
|
+
* - editSettings
|
|
1515
1472
|
* @param sourceSearch - The sourceSearch object.
|
|
1516
1473
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1517
1474
|
*/
|
|
@@ -1538,10 +1495,9 @@ function createIngestionClient({
|
|
|
1538
1495
|
* Searches for tasks.
|
|
1539
1496
|
*
|
|
1540
1497
|
* Required API Key ACLs:
|
|
1541
|
-
*
|
|
1542
|
-
*
|
|
1543
|
-
*
|
|
1544
|
-
*
|
|
1498
|
+
* - addObject
|
|
1499
|
+
* - deleteIndex
|
|
1500
|
+
* - editSettings
|
|
1545
1501
|
* @param taskSearch - The taskSearch object.
|
|
1546
1502
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1547
1503
|
*/
|
|
@@ -1568,10 +1524,9 @@ function createIngestionClient({
|
|
|
1568
1524
|
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
1569
1525
|
*
|
|
1570
1526
|
* Required API Key ACLs:
|
|
1571
|
-
*
|
|
1572
|
-
*
|
|
1573
|
-
*
|
|
1574
|
-
*
|
|
1527
|
+
* - addObject
|
|
1528
|
+
* - deleteIndex
|
|
1529
|
+
* - editSettings
|
|
1575
1530
|
* @param taskSearch - The taskSearch object.
|
|
1576
1531
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1577
1532
|
*/
|
|
@@ -1598,10 +1553,9 @@ function createIngestionClient({
|
|
|
1598
1553
|
* Searches for transformations.
|
|
1599
1554
|
*
|
|
1600
1555
|
* Required API Key ACLs:
|
|
1601
|
-
*
|
|
1602
|
-
*
|
|
1603
|
-
*
|
|
1604
|
-
*
|
|
1556
|
+
* - addObject
|
|
1557
|
+
* - deleteIndex
|
|
1558
|
+
* - editSettings
|
|
1605
1559
|
* @param transformationSearch - The transformationSearch object.
|
|
1606
1560
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1607
1561
|
*/
|
|
@@ -1630,10 +1584,9 @@ function createIngestionClient({
|
|
|
1630
1584
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1631
1585
|
*
|
|
1632
1586
|
* Required API Key ACLs:
|
|
1633
|
-
*
|
|
1634
|
-
*
|
|
1635
|
-
*
|
|
1636
|
-
*
|
|
1587
|
+
* - addObject
|
|
1588
|
+
* - deleteIndex
|
|
1589
|
+
* - editSettings
|
|
1637
1590
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1638
1591
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1639
1592
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1657,10 +1610,9 @@ function createIngestionClient({
|
|
|
1657
1610
|
* Try a transformation before creating it.
|
|
1658
1611
|
*
|
|
1659
1612
|
* Required API Key ACLs:
|
|
1660
|
-
*
|
|
1661
|
-
*
|
|
1662
|
-
*
|
|
1663
|
-
*
|
|
1613
|
+
* - addObject
|
|
1614
|
+
* - deleteIndex
|
|
1615
|
+
* - editSettings
|
|
1664
1616
|
* @param transformationTry - The transformationTry object.
|
|
1665
1617
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1666
1618
|
*/
|
|
@@ -1690,10 +1642,9 @@ function createIngestionClient({
|
|
|
1690
1642
|
* Try a transformation before updating it.
|
|
1691
1643
|
*
|
|
1692
1644
|
* Required API Key ACLs:
|
|
1693
|
-
*
|
|
1694
|
-
*
|
|
1695
|
-
*
|
|
1696
|
-
*
|
|
1645
|
+
* - addObject
|
|
1646
|
+
* - deleteIndex
|
|
1647
|
+
* - editSettings
|
|
1697
1648
|
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
1698
1649
|
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
1699
1650
|
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
@@ -1733,10 +1684,9 @@ function createIngestionClient({
|
|
|
1733
1684
|
* Updates an authentication resource.
|
|
1734
1685
|
*
|
|
1735
1686
|
* Required API Key ACLs:
|
|
1736
|
-
*
|
|
1737
|
-
*
|
|
1738
|
-
*
|
|
1739
|
-
*
|
|
1687
|
+
* - addObject
|
|
1688
|
+
* - deleteIndex
|
|
1689
|
+
* - editSettings
|
|
1740
1690
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1741
1691
|
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1742
1692
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
@@ -1768,10 +1718,9 @@ function createIngestionClient({
|
|
|
1768
1718
|
* Updates the destination by its ID.
|
|
1769
1719
|
*
|
|
1770
1720
|
* Required API Key ACLs:
|
|
1771
|
-
*
|
|
1772
|
-
*
|
|
1773
|
-
*
|
|
1774
|
-
*
|
|
1721
|
+
* - addObject
|
|
1722
|
+
* - deleteIndex
|
|
1723
|
+
* - editSettings
|
|
1775
1724
|
* @param updateDestination - The updateDestination object.
|
|
1776
1725
|
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1777
1726
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
@@ -1803,10 +1752,9 @@ function createIngestionClient({
|
|
|
1803
1752
|
* Updates a source by its ID.
|
|
1804
1753
|
*
|
|
1805
1754
|
* Required API Key ACLs:
|
|
1806
|
-
*
|
|
1807
|
-
*
|
|
1808
|
-
*
|
|
1809
|
-
*
|
|
1755
|
+
* - addObject
|
|
1756
|
+
* - deleteIndex
|
|
1757
|
+
* - editSettings
|
|
1810
1758
|
* @param updateSource - The updateSource object.
|
|
1811
1759
|
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1812
1760
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
@@ -1833,7 +1781,6 @@ function createIngestionClient({
|
|
|
1833
1781
|
},
|
|
1834
1782
|
/**
|
|
1835
1783
|
* Updates a task by its ID.
|
|
1836
|
-
*
|
|
1837
1784
|
* @param updateTask - The updateTask object.
|
|
1838
1785
|
* @param updateTask.taskID - Unique identifier of a task.
|
|
1839
1786
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
@@ -1860,7 +1807,6 @@ function createIngestionClient({
|
|
|
1860
1807
|
},
|
|
1861
1808
|
/**
|
|
1862
1809
|
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
1863
|
-
*
|
|
1864
1810
|
* @param updateTaskV1 - The updateTaskV1 object.
|
|
1865
1811
|
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
1866
1812
|
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
@@ -1887,7 +1833,6 @@ function createIngestionClient({
|
|
|
1887
1833
|
},
|
|
1888
1834
|
/**
|
|
1889
1835
|
* Updates a transformation by its ID.
|
|
1890
|
-
*
|
|
1891
1836
|
* @param updateTransformation - The updateTransformation object.
|
|
1892
1837
|
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1893
1838
|
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
@@ -1925,11 +1870,10 @@ function createIngestionClient({
|
|
|
1925
1870
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1926
1871
|
*
|
|
1927
1872
|
* Required API Key ACLs:
|
|
1928
|
-
*
|
|
1929
|
-
*
|
|
1930
|
-
*
|
|
1931
|
-
*
|
|
1932
|
-
* @param sourceCreate -.
|
|
1873
|
+
* - addObject
|
|
1874
|
+
* - deleteIndex
|
|
1875
|
+
* - editSettings
|
|
1876
|
+
* @param sourceCreate -
|
|
1933
1877
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1934
1878
|
*/
|
|
1935
1879
|
validateSource(sourceCreate, requestOptions = void 0) {
|
|
@@ -1949,10 +1893,9 @@ function createIngestionClient({
|
|
|
1949
1893
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1950
1894
|
*
|
|
1951
1895
|
* Required API Key ACLs:
|
|
1952
|
-
*
|
|
1953
|
-
*
|
|
1954
|
-
*
|
|
1955
|
-
*
|
|
1896
|
+
* - addObject
|
|
1897
|
+
* - deleteIndex
|
|
1898
|
+
* - editSettings
|
|
1956
1899
|
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
1957
1900
|
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
1958
1901
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|