@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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
// src/ingestionClient.ts
|
|
2
2
|
import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
|
|
3
|
-
var apiClientVersion = "1.
|
|
3
|
+
var apiClientVersion = "1.8.1";
|
|
4
4
|
var REGIONS = ["eu", "us"];
|
|
5
5
|
function getDefaultHosts(region) {
|
|
6
6
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -86,11 +86,10 @@ function createIngestionClient({
|
|
|
86
86
|
* Creates a new authentication resource.
|
|
87
87
|
*
|
|
88
88
|
* Required API Key ACLs:
|
|
89
|
-
*
|
|
90
|
-
*
|
|
91
|
-
*
|
|
92
|
-
*
|
|
93
|
-
* @param authenticationCreate -.
|
|
89
|
+
* - addObject
|
|
90
|
+
* - deleteIndex
|
|
91
|
+
* - editSettings
|
|
92
|
+
* @param authenticationCreate -
|
|
94
93
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
95
94
|
*/
|
|
96
95
|
createAuthentication(authenticationCreate, requestOptions) {
|
|
@@ -122,11 +121,10 @@ function createIngestionClient({
|
|
|
122
121
|
* Creates a new destination.
|
|
123
122
|
*
|
|
124
123
|
* Required API Key ACLs:
|
|
125
|
-
*
|
|
126
|
-
*
|
|
127
|
-
*
|
|
128
|
-
*
|
|
129
|
-
* @param destinationCreate -.
|
|
124
|
+
* - addObject
|
|
125
|
+
* - deleteIndex
|
|
126
|
+
* - editSettings
|
|
127
|
+
* @param destinationCreate -
|
|
130
128
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
131
129
|
*/
|
|
132
130
|
createDestination(destinationCreate, requestOptions) {
|
|
@@ -158,11 +156,10 @@ function createIngestionClient({
|
|
|
158
156
|
* Creates a new source.
|
|
159
157
|
*
|
|
160
158
|
* Required API Key ACLs:
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
*
|
|
164
|
-
*
|
|
165
|
-
* @param sourceCreate -.
|
|
159
|
+
* - addObject
|
|
160
|
+
* - deleteIndex
|
|
161
|
+
* - editSettings
|
|
162
|
+
* @param sourceCreate -
|
|
166
163
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
167
164
|
*/
|
|
168
165
|
createSource(sourceCreate, requestOptions) {
|
|
@@ -189,7 +186,6 @@ function createIngestionClient({
|
|
|
189
186
|
},
|
|
190
187
|
/**
|
|
191
188
|
* Creates a new task.
|
|
192
|
-
*
|
|
193
189
|
* @param taskCreate - Request body for creating a task.
|
|
194
190
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
195
191
|
*/
|
|
@@ -220,7 +216,6 @@ function createIngestionClient({
|
|
|
220
216
|
},
|
|
221
217
|
/**
|
|
222
218
|
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
223
|
-
*
|
|
224
219
|
* @param taskCreate - Request body for creating a task.
|
|
225
220
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
226
221
|
*/
|
|
@@ -254,7 +249,6 @@ function createIngestionClient({
|
|
|
254
249
|
},
|
|
255
250
|
/**
|
|
256
251
|
* Creates a new transformation.
|
|
257
|
-
*
|
|
258
252
|
* @param transformationCreate - Request body for creating a transformation.
|
|
259
253
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
260
254
|
*/
|
|
@@ -282,7 +276,6 @@ function createIngestionClient({
|
|
|
282
276
|
},
|
|
283
277
|
/**
|
|
284
278
|
* This method allow you to send requests to the Algolia REST API.
|
|
285
|
-
*
|
|
286
279
|
* @param customDelete - The customDelete object.
|
|
287
280
|
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
288
281
|
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
@@ -305,7 +298,6 @@ function createIngestionClient({
|
|
|
305
298
|
},
|
|
306
299
|
/**
|
|
307
300
|
* This method allow you to send requests to the Algolia REST API.
|
|
308
|
-
*
|
|
309
301
|
* @param customGet - The customGet object.
|
|
310
302
|
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
311
303
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -328,7 +320,6 @@ function createIngestionClient({
|
|
|
328
320
|
},
|
|
329
321
|
/**
|
|
330
322
|
* This method allow you to send requests to the Algolia REST API.
|
|
331
|
-
*
|
|
332
323
|
* @param customPost - The customPost object.
|
|
333
324
|
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
334
325
|
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
@@ -353,7 +344,6 @@ function createIngestionClient({
|
|
|
353
344
|
},
|
|
354
345
|
/**
|
|
355
346
|
* This method allow you to send requests to the Algolia REST API.
|
|
356
|
-
*
|
|
357
347
|
* @param customPut - The customPut object.
|
|
358
348
|
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
359
349
|
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
@@ -380,10 +370,9 @@ function createIngestionClient({
|
|
|
380
370
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
381
371
|
*
|
|
382
372
|
* Required API Key ACLs:
|
|
383
|
-
*
|
|
384
|
-
*
|
|
385
|
-
*
|
|
386
|
-
*
|
|
373
|
+
* - addObject
|
|
374
|
+
* - deleteIndex
|
|
375
|
+
* - editSettings
|
|
387
376
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
388
377
|
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
389
378
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -410,10 +399,9 @@ function createIngestionClient({
|
|
|
410
399
|
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
411
400
|
*
|
|
412
401
|
* Required API Key ACLs:
|
|
413
|
-
*
|
|
414
|
-
*
|
|
415
|
-
*
|
|
416
|
-
*
|
|
402
|
+
* - addObject
|
|
403
|
+
* - deleteIndex
|
|
404
|
+
* - editSettings
|
|
417
405
|
* @param deleteDestination - The deleteDestination object.
|
|
418
406
|
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
419
407
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -440,10 +428,9 @@ function createIngestionClient({
|
|
|
440
428
|
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
441
429
|
*
|
|
442
430
|
* Required API Key ACLs:
|
|
443
|
-
*
|
|
444
|
-
*
|
|
445
|
-
*
|
|
446
|
-
*
|
|
431
|
+
* - addObject
|
|
432
|
+
* - deleteIndex
|
|
433
|
+
* - editSettings
|
|
447
434
|
* @param deleteSource - The deleteSource object.
|
|
448
435
|
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
449
436
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -465,7 +452,6 @@ function createIngestionClient({
|
|
|
465
452
|
},
|
|
466
453
|
/**
|
|
467
454
|
* Deletes a task by its ID.
|
|
468
|
-
*
|
|
469
455
|
* @param deleteTask - The deleteTask object.
|
|
470
456
|
* @param deleteTask.taskID - Unique identifier of a task.
|
|
471
457
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -487,7 +473,6 @@ function createIngestionClient({
|
|
|
487
473
|
},
|
|
488
474
|
/**
|
|
489
475
|
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
490
|
-
*
|
|
491
476
|
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
492
477
|
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
493
478
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -509,7 +494,6 @@ function createIngestionClient({
|
|
|
509
494
|
},
|
|
510
495
|
/**
|
|
511
496
|
* Deletes a transformation by its ID.
|
|
512
|
-
*
|
|
513
497
|
* @param deleteTransformation - The deleteTransformation object.
|
|
514
498
|
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
515
499
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -536,10 +520,9 @@ function createIngestionClient({
|
|
|
536
520
|
* Disables a task.
|
|
537
521
|
*
|
|
538
522
|
* Required API Key ACLs:
|
|
539
|
-
*
|
|
540
|
-
*
|
|
541
|
-
*
|
|
542
|
-
*
|
|
523
|
+
* - addObject
|
|
524
|
+
* - deleteIndex
|
|
525
|
+
* - editSettings
|
|
543
526
|
* @param disableTask - The disableTask object.
|
|
544
527
|
* @param disableTask.taskID - Unique identifier of a task.
|
|
545
528
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -563,10 +546,9 @@ function createIngestionClient({
|
|
|
563
546
|
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
564
547
|
*
|
|
565
548
|
* Required API Key ACLs:
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
569
|
-
*
|
|
549
|
+
* - addObject
|
|
550
|
+
* - deleteIndex
|
|
551
|
+
* - editSettings
|
|
570
552
|
* @param disableTaskV1 - The disableTaskV1 object.
|
|
571
553
|
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
572
554
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -590,10 +572,9 @@ function createIngestionClient({
|
|
|
590
572
|
* Enables a task.
|
|
591
573
|
*
|
|
592
574
|
* Required API Key ACLs:
|
|
593
|
-
*
|
|
594
|
-
*
|
|
595
|
-
*
|
|
596
|
-
*
|
|
575
|
+
* - addObject
|
|
576
|
+
* - deleteIndex
|
|
577
|
+
* - editSettings
|
|
597
578
|
* @param enableTask - The enableTask object.
|
|
598
579
|
* @param enableTask.taskID - Unique identifier of a task.
|
|
599
580
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -617,10 +598,9 @@ function createIngestionClient({
|
|
|
617
598
|
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
618
599
|
*
|
|
619
600
|
* Required API Key ACLs:
|
|
620
|
-
*
|
|
621
|
-
*
|
|
622
|
-
*
|
|
623
|
-
*
|
|
601
|
+
* - addObject
|
|
602
|
+
* - deleteIndex
|
|
603
|
+
* - editSettings
|
|
624
604
|
* @param enableTaskV1 - The enableTaskV1 object.
|
|
625
605
|
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
626
606
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -644,10 +624,9 @@ function createIngestionClient({
|
|
|
644
624
|
* Retrieves an authentication resource by its ID.
|
|
645
625
|
*
|
|
646
626
|
* Required API Key ACLs:
|
|
647
|
-
*
|
|
648
|
-
*
|
|
649
|
-
*
|
|
650
|
-
*
|
|
627
|
+
* - addObject
|
|
628
|
+
* - deleteIndex
|
|
629
|
+
* - editSettings
|
|
651
630
|
* @param getAuthentication - The getAuthentication object.
|
|
652
631
|
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
653
632
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -674,10 +653,9 @@ function createIngestionClient({
|
|
|
674
653
|
* Retrieves a destination by its ID.
|
|
675
654
|
*
|
|
676
655
|
* Required API Key ACLs:
|
|
677
|
-
*
|
|
678
|
-
*
|
|
679
|
-
*
|
|
680
|
-
*
|
|
656
|
+
* - addObject
|
|
657
|
+
* - deleteIndex
|
|
658
|
+
* - editSettings
|
|
681
659
|
* @param getDestination - The getDestination object.
|
|
682
660
|
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
683
661
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -704,10 +682,9 @@ function createIngestionClient({
|
|
|
704
682
|
* Retrieves a single task run event by its ID.
|
|
705
683
|
*
|
|
706
684
|
* Required API Key ACLs:
|
|
707
|
-
*
|
|
708
|
-
*
|
|
709
|
-
*
|
|
710
|
-
*
|
|
685
|
+
* - addObject
|
|
686
|
+
* - deleteIndex
|
|
687
|
+
* - editSettings
|
|
711
688
|
* @param getEvent - The getEvent object.
|
|
712
689
|
* @param getEvent.runID - Unique identifier of a task run.
|
|
713
690
|
* @param getEvent.eventID - Unique identifier of an event.
|
|
@@ -735,10 +712,9 @@ function createIngestionClient({
|
|
|
735
712
|
* Retrieve a single task run by its ID.
|
|
736
713
|
*
|
|
737
714
|
* Required API Key ACLs:
|
|
738
|
-
*
|
|
739
|
-
*
|
|
740
|
-
*
|
|
741
|
-
*
|
|
715
|
+
* - addObject
|
|
716
|
+
* - deleteIndex
|
|
717
|
+
* - editSettings
|
|
742
718
|
* @param getRun - The getRun object.
|
|
743
719
|
* @param getRun.runID - Unique identifier of a task run.
|
|
744
720
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -762,10 +738,9 @@ function createIngestionClient({
|
|
|
762
738
|
* Retrieve a source by its ID.
|
|
763
739
|
*
|
|
764
740
|
* Required API Key ACLs:
|
|
765
|
-
*
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
741
|
+
* - addObject
|
|
742
|
+
* - deleteIndex
|
|
743
|
+
* - editSettings
|
|
769
744
|
* @param getSource - The getSource object.
|
|
770
745
|
* @param getSource.sourceID - Unique identifier of a source.
|
|
771
746
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -789,10 +764,9 @@ function createIngestionClient({
|
|
|
789
764
|
* Retrieves a task by its ID.
|
|
790
765
|
*
|
|
791
766
|
* Required API Key ACLs:
|
|
792
|
-
*
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
767
|
+
* - addObject
|
|
768
|
+
* - deleteIndex
|
|
769
|
+
* - editSettings
|
|
796
770
|
* @param getTask - The getTask object.
|
|
797
771
|
* @param getTask.taskID - Unique identifier of a task.
|
|
798
772
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -816,10 +790,9 @@ function createIngestionClient({
|
|
|
816
790
|
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
817
791
|
*
|
|
818
792
|
* Required API Key ACLs:
|
|
819
|
-
*
|
|
820
|
-
*
|
|
821
|
-
*
|
|
822
|
-
*
|
|
793
|
+
* - addObject
|
|
794
|
+
* - deleteIndex
|
|
795
|
+
* - editSettings
|
|
823
796
|
* @param getTaskV1 - The getTaskV1 object.
|
|
824
797
|
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
825
798
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -843,10 +816,9 @@ function createIngestionClient({
|
|
|
843
816
|
* Retrieves a transformation by its ID.
|
|
844
817
|
*
|
|
845
818
|
* Required API Key ACLs:
|
|
846
|
-
*
|
|
847
|
-
*
|
|
848
|
-
*
|
|
849
|
-
*
|
|
819
|
+
* - addObject
|
|
820
|
+
* - deleteIndex
|
|
821
|
+
* - editSettings
|
|
850
822
|
* @param getTransformation - The getTransformation object.
|
|
851
823
|
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
852
824
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -873,10 +845,9 @@ function createIngestionClient({
|
|
|
873
845
|
* Retrieves a list of all authentication resources.
|
|
874
846
|
*
|
|
875
847
|
* Required API Key ACLs:
|
|
876
|
-
*
|
|
877
|
-
*
|
|
878
|
-
*
|
|
879
|
-
*
|
|
848
|
+
* - addObject
|
|
849
|
+
* - deleteIndex
|
|
850
|
+
* - editSettings
|
|
880
851
|
* @param listAuthentications - The listAuthentications object.
|
|
881
852
|
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
882
853
|
* @param listAuthentications.page - Page number of the paginated API response.
|
|
@@ -891,22 +862,22 @@ function createIngestionClient({
|
|
|
891
862
|
const headers = {};
|
|
892
863
|
const queryParameters = {};
|
|
893
864
|
if (itemsPerPage !== void 0) {
|
|
894
|
-
queryParameters
|
|
865
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
895
866
|
}
|
|
896
867
|
if (page !== void 0) {
|
|
897
|
-
queryParameters
|
|
868
|
+
queryParameters["page"] = page.toString();
|
|
898
869
|
}
|
|
899
870
|
if (type !== void 0) {
|
|
900
|
-
queryParameters
|
|
871
|
+
queryParameters["type"] = type.toString();
|
|
901
872
|
}
|
|
902
873
|
if (platform !== void 0) {
|
|
903
|
-
queryParameters
|
|
874
|
+
queryParameters["platform"] = platform.toString();
|
|
904
875
|
}
|
|
905
876
|
if (sort !== void 0) {
|
|
906
|
-
queryParameters
|
|
877
|
+
queryParameters["sort"] = sort.toString();
|
|
907
878
|
}
|
|
908
879
|
if (order !== void 0) {
|
|
909
|
-
queryParameters
|
|
880
|
+
queryParameters["order"] = order.toString();
|
|
910
881
|
}
|
|
911
882
|
const request = {
|
|
912
883
|
method: "GET",
|
|
@@ -920,10 +891,9 @@ function createIngestionClient({
|
|
|
920
891
|
* Retrieves a list of destinations.
|
|
921
892
|
*
|
|
922
893
|
* Required API Key ACLs:
|
|
923
|
-
*
|
|
924
|
-
*
|
|
925
|
-
*
|
|
926
|
-
*
|
|
894
|
+
* - addObject
|
|
895
|
+
* - deleteIndex
|
|
896
|
+
* - editSettings
|
|
927
897
|
* @param listDestinations - The listDestinations object.
|
|
928
898
|
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
929
899
|
* @param listDestinations.page - Page number of the paginated API response.
|
|
@@ -939,25 +909,25 @@ function createIngestionClient({
|
|
|
939
909
|
const headers = {};
|
|
940
910
|
const queryParameters = {};
|
|
941
911
|
if (itemsPerPage !== void 0) {
|
|
942
|
-
queryParameters
|
|
912
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
943
913
|
}
|
|
944
914
|
if (page !== void 0) {
|
|
945
|
-
queryParameters
|
|
915
|
+
queryParameters["page"] = page.toString();
|
|
946
916
|
}
|
|
947
917
|
if (type !== void 0) {
|
|
948
|
-
queryParameters
|
|
918
|
+
queryParameters["type"] = type.toString();
|
|
949
919
|
}
|
|
950
920
|
if (authenticationID !== void 0) {
|
|
951
|
-
queryParameters
|
|
921
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
952
922
|
}
|
|
953
923
|
if (transformationID !== void 0) {
|
|
954
|
-
queryParameters
|
|
924
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
955
925
|
}
|
|
956
926
|
if (sort !== void 0) {
|
|
957
|
-
queryParameters
|
|
927
|
+
queryParameters["sort"] = sort.toString();
|
|
958
928
|
}
|
|
959
929
|
if (order !== void 0) {
|
|
960
|
-
queryParameters
|
|
930
|
+
queryParameters["order"] = order.toString();
|
|
961
931
|
}
|
|
962
932
|
const request = {
|
|
963
933
|
method: "GET",
|
|
@@ -968,13 +938,12 @@ function createIngestionClient({
|
|
|
968
938
|
return transporter.request(request, requestOptions);
|
|
969
939
|
},
|
|
970
940
|
/**
|
|
971
|
-
* Retrieves a list of events for a task run, identified by
|
|
941
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
972
942
|
*
|
|
973
943
|
* Required API Key ACLs:
|
|
974
|
-
*
|
|
975
|
-
*
|
|
976
|
-
*
|
|
977
|
-
*
|
|
944
|
+
* - addObject
|
|
945
|
+
* - deleteIndex
|
|
946
|
+
* - editSettings
|
|
978
947
|
* @param listEvents - The listEvents object.
|
|
979
948
|
* @param listEvents.runID - Unique identifier of a task run.
|
|
980
949
|
* @param listEvents.itemsPerPage - Number of items per page.
|
|
@@ -995,28 +964,28 @@ function createIngestionClient({
|
|
|
995
964
|
const headers = {};
|
|
996
965
|
const queryParameters = {};
|
|
997
966
|
if (itemsPerPage !== void 0) {
|
|
998
|
-
queryParameters
|
|
967
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
999
968
|
}
|
|
1000
969
|
if (page !== void 0) {
|
|
1001
|
-
queryParameters
|
|
970
|
+
queryParameters["page"] = page.toString();
|
|
1002
971
|
}
|
|
1003
972
|
if (status !== void 0) {
|
|
1004
|
-
queryParameters
|
|
973
|
+
queryParameters["status"] = status.toString();
|
|
1005
974
|
}
|
|
1006
975
|
if (type !== void 0) {
|
|
1007
|
-
queryParameters
|
|
976
|
+
queryParameters["type"] = type.toString();
|
|
1008
977
|
}
|
|
1009
978
|
if (sort !== void 0) {
|
|
1010
|
-
queryParameters
|
|
979
|
+
queryParameters["sort"] = sort.toString();
|
|
1011
980
|
}
|
|
1012
981
|
if (order !== void 0) {
|
|
1013
|
-
queryParameters
|
|
982
|
+
queryParameters["order"] = order.toString();
|
|
1014
983
|
}
|
|
1015
984
|
if (startDate !== void 0) {
|
|
1016
|
-
queryParameters
|
|
985
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1017
986
|
}
|
|
1018
987
|
if (endDate !== void 0) {
|
|
1019
|
-
queryParameters
|
|
988
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1020
989
|
}
|
|
1021
990
|
const request = {
|
|
1022
991
|
method: "GET",
|
|
@@ -1030,10 +999,9 @@ function createIngestionClient({
|
|
|
1030
999
|
* Retrieve a list of task runs.
|
|
1031
1000
|
*
|
|
1032
1001
|
* Required API Key ACLs:
|
|
1033
|
-
*
|
|
1034
|
-
*
|
|
1035
|
-
*
|
|
1036
|
-
*
|
|
1002
|
+
* - addObject
|
|
1003
|
+
* - deleteIndex
|
|
1004
|
+
* - editSettings
|
|
1037
1005
|
* @param listRuns - The listRuns object.
|
|
1038
1006
|
* @param listRuns.itemsPerPage - Number of items per page.
|
|
1039
1007
|
* @param listRuns.page - Page number of the paginated API response.
|
|
@@ -1051,31 +1019,31 @@ function createIngestionClient({
|
|
|
1051
1019
|
const headers = {};
|
|
1052
1020
|
const queryParameters = {};
|
|
1053
1021
|
if (itemsPerPage !== void 0) {
|
|
1054
|
-
queryParameters
|
|
1022
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1055
1023
|
}
|
|
1056
1024
|
if (page !== void 0) {
|
|
1057
|
-
queryParameters
|
|
1025
|
+
queryParameters["page"] = page.toString();
|
|
1058
1026
|
}
|
|
1059
1027
|
if (status !== void 0) {
|
|
1060
|
-
queryParameters
|
|
1028
|
+
queryParameters["status"] = status.toString();
|
|
1061
1029
|
}
|
|
1062
1030
|
if (type !== void 0) {
|
|
1063
|
-
queryParameters
|
|
1031
|
+
queryParameters["type"] = type.toString();
|
|
1064
1032
|
}
|
|
1065
1033
|
if (taskID !== void 0) {
|
|
1066
|
-
queryParameters
|
|
1034
|
+
queryParameters["taskID"] = taskID.toString();
|
|
1067
1035
|
}
|
|
1068
1036
|
if (sort !== void 0) {
|
|
1069
|
-
queryParameters
|
|
1037
|
+
queryParameters["sort"] = sort.toString();
|
|
1070
1038
|
}
|
|
1071
1039
|
if (order !== void 0) {
|
|
1072
|
-
queryParameters
|
|
1040
|
+
queryParameters["order"] = order.toString();
|
|
1073
1041
|
}
|
|
1074
1042
|
if (startDate !== void 0) {
|
|
1075
|
-
queryParameters
|
|
1043
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1076
1044
|
}
|
|
1077
1045
|
if (endDate !== void 0) {
|
|
1078
|
-
queryParameters
|
|
1046
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1079
1047
|
}
|
|
1080
1048
|
const request = {
|
|
1081
1049
|
method: "GET",
|
|
@@ -1089,10 +1057,9 @@ function createIngestionClient({
|
|
|
1089
1057
|
* Retrieves a list of sources.
|
|
1090
1058
|
*
|
|
1091
1059
|
* Required API Key ACLs:
|
|
1092
|
-
*
|
|
1093
|
-
*
|
|
1094
|
-
*
|
|
1095
|
-
*
|
|
1060
|
+
* - addObject
|
|
1061
|
+
* - deleteIndex
|
|
1062
|
+
* - editSettings
|
|
1096
1063
|
* @param listSources - The listSources object.
|
|
1097
1064
|
* @param listSources.itemsPerPage - Number of items per page.
|
|
1098
1065
|
* @param listSources.page - Page number of the paginated API response.
|
|
@@ -1107,22 +1074,22 @@ function createIngestionClient({
|
|
|
1107
1074
|
const headers = {};
|
|
1108
1075
|
const queryParameters = {};
|
|
1109
1076
|
if (itemsPerPage !== void 0) {
|
|
1110
|
-
queryParameters
|
|
1077
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1111
1078
|
}
|
|
1112
1079
|
if (page !== void 0) {
|
|
1113
|
-
queryParameters
|
|
1080
|
+
queryParameters["page"] = page.toString();
|
|
1114
1081
|
}
|
|
1115
1082
|
if (type !== void 0) {
|
|
1116
|
-
queryParameters
|
|
1083
|
+
queryParameters["type"] = type.toString();
|
|
1117
1084
|
}
|
|
1118
1085
|
if (authenticationID !== void 0) {
|
|
1119
|
-
queryParameters
|
|
1086
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1120
1087
|
}
|
|
1121
1088
|
if (sort !== void 0) {
|
|
1122
|
-
queryParameters
|
|
1089
|
+
queryParameters["sort"] = sort.toString();
|
|
1123
1090
|
}
|
|
1124
1091
|
if (order !== void 0) {
|
|
1125
|
-
queryParameters
|
|
1092
|
+
queryParameters["order"] = order.toString();
|
|
1126
1093
|
}
|
|
1127
1094
|
const request = {
|
|
1128
1095
|
method: "GET",
|
|
@@ -1136,10 +1103,9 @@ function createIngestionClient({
|
|
|
1136
1103
|
* Retrieves a list of tasks.
|
|
1137
1104
|
*
|
|
1138
1105
|
* Required API Key ACLs:
|
|
1139
|
-
*
|
|
1140
|
-
*
|
|
1141
|
-
*
|
|
1142
|
-
*
|
|
1106
|
+
* - addObject
|
|
1107
|
+
* - deleteIndex
|
|
1108
|
+
* - editSettings
|
|
1143
1109
|
* @param listTasks - The listTasks object.
|
|
1144
1110
|
* @param listTasks.itemsPerPage - Number of items per page.
|
|
1145
1111
|
* @param listTasks.page - Page number of the paginated API response.
|
|
@@ -1157,31 +1123,31 @@ function createIngestionClient({
|
|
|
1157
1123
|
const headers = {};
|
|
1158
1124
|
const queryParameters = {};
|
|
1159
1125
|
if (itemsPerPage !== void 0) {
|
|
1160
|
-
queryParameters
|
|
1126
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1161
1127
|
}
|
|
1162
1128
|
if (page !== void 0) {
|
|
1163
|
-
queryParameters
|
|
1129
|
+
queryParameters["page"] = page.toString();
|
|
1164
1130
|
}
|
|
1165
1131
|
if (action !== void 0) {
|
|
1166
|
-
queryParameters
|
|
1132
|
+
queryParameters["action"] = action.toString();
|
|
1167
1133
|
}
|
|
1168
1134
|
if (enabled !== void 0) {
|
|
1169
|
-
queryParameters
|
|
1135
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1170
1136
|
}
|
|
1171
1137
|
if (sourceID !== void 0) {
|
|
1172
|
-
queryParameters
|
|
1138
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1173
1139
|
}
|
|
1174
1140
|
if (destinationID !== void 0) {
|
|
1175
|
-
queryParameters
|
|
1141
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1176
1142
|
}
|
|
1177
1143
|
if (triggerType !== void 0) {
|
|
1178
|
-
queryParameters
|
|
1144
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1179
1145
|
}
|
|
1180
1146
|
if (sort !== void 0) {
|
|
1181
|
-
queryParameters
|
|
1147
|
+
queryParameters["sort"] = sort.toString();
|
|
1182
1148
|
}
|
|
1183
1149
|
if (order !== void 0) {
|
|
1184
|
-
queryParameters
|
|
1150
|
+
queryParameters["order"] = order.toString();
|
|
1185
1151
|
}
|
|
1186
1152
|
const request = {
|
|
1187
1153
|
method: "GET",
|
|
@@ -1195,10 +1161,9 @@ function createIngestionClient({
|
|
|
1195
1161
|
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
1196
1162
|
*
|
|
1197
1163
|
* Required API Key ACLs:
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1200
|
-
*
|
|
1201
|
-
*
|
|
1164
|
+
* - addObject
|
|
1165
|
+
* - deleteIndex
|
|
1166
|
+
* - editSettings
|
|
1202
1167
|
* @param listTasksV1 - The listTasksV1 object.
|
|
1203
1168
|
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
1204
1169
|
* @param listTasksV1.page - Page number of the paginated API response.
|
|
@@ -1216,31 +1181,31 @@ function createIngestionClient({
|
|
|
1216
1181
|
const headers = {};
|
|
1217
1182
|
const queryParameters = {};
|
|
1218
1183
|
if (itemsPerPage !== void 0) {
|
|
1219
|
-
queryParameters
|
|
1184
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1220
1185
|
}
|
|
1221
1186
|
if (page !== void 0) {
|
|
1222
|
-
queryParameters
|
|
1187
|
+
queryParameters["page"] = page.toString();
|
|
1223
1188
|
}
|
|
1224
1189
|
if (action !== void 0) {
|
|
1225
|
-
queryParameters
|
|
1190
|
+
queryParameters["action"] = action.toString();
|
|
1226
1191
|
}
|
|
1227
1192
|
if (enabled !== void 0) {
|
|
1228
|
-
queryParameters
|
|
1193
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1229
1194
|
}
|
|
1230
1195
|
if (sourceID !== void 0) {
|
|
1231
|
-
queryParameters
|
|
1196
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1232
1197
|
}
|
|
1233
1198
|
if (destinationID !== void 0) {
|
|
1234
|
-
queryParameters
|
|
1199
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1235
1200
|
}
|
|
1236
1201
|
if (triggerType !== void 0) {
|
|
1237
|
-
queryParameters
|
|
1202
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1238
1203
|
}
|
|
1239
1204
|
if (sort !== void 0) {
|
|
1240
|
-
queryParameters
|
|
1205
|
+
queryParameters["sort"] = sort.toString();
|
|
1241
1206
|
}
|
|
1242
1207
|
if (order !== void 0) {
|
|
1243
|
-
queryParameters
|
|
1208
|
+
queryParameters["order"] = order.toString();
|
|
1244
1209
|
}
|
|
1245
1210
|
const request = {
|
|
1246
1211
|
method: "GET",
|
|
@@ -1254,10 +1219,9 @@ function createIngestionClient({
|
|
|
1254
1219
|
* Retrieves a list of transformations.
|
|
1255
1220
|
*
|
|
1256
1221
|
* Required API Key ACLs:
|
|
1257
|
-
*
|
|
1258
|
-
*
|
|
1259
|
-
*
|
|
1260
|
-
*
|
|
1222
|
+
* - addObject
|
|
1223
|
+
* - deleteIndex
|
|
1224
|
+
* - editSettings
|
|
1261
1225
|
* @param listTransformations - The listTransformations object.
|
|
1262
1226
|
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
1263
1227
|
* @param listTransformations.page - Page number of the paginated API response.
|
|
@@ -1270,16 +1234,16 @@ function createIngestionClient({
|
|
|
1270
1234
|
const headers = {};
|
|
1271
1235
|
const queryParameters = {};
|
|
1272
1236
|
if (itemsPerPage !== void 0) {
|
|
1273
|
-
queryParameters
|
|
1237
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1274
1238
|
}
|
|
1275
1239
|
if (page !== void 0) {
|
|
1276
|
-
queryParameters
|
|
1240
|
+
queryParameters["page"] = page.toString();
|
|
1277
1241
|
}
|
|
1278
1242
|
if (sort !== void 0) {
|
|
1279
|
-
queryParameters
|
|
1243
|
+
queryParameters["sort"] = sort.toString();
|
|
1280
1244
|
}
|
|
1281
1245
|
if (order !== void 0) {
|
|
1282
|
-
queryParameters
|
|
1246
|
+
queryParameters["order"] = order.toString();
|
|
1283
1247
|
}
|
|
1284
1248
|
const request = {
|
|
1285
1249
|
method: "GET",
|
|
@@ -1293,10 +1257,9 @@ function createIngestionClient({
|
|
|
1293
1257
|
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
1294
1258
|
*
|
|
1295
1259
|
* Required API Key ACLs:
|
|
1296
|
-
*
|
|
1297
|
-
*
|
|
1298
|
-
*
|
|
1299
|
-
*
|
|
1260
|
+
* - addObject
|
|
1261
|
+
* - deleteIndex
|
|
1262
|
+
* - editSettings
|
|
1300
1263
|
* @param pushTask - The pushTask object.
|
|
1301
1264
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1302
1265
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
@@ -1331,13 +1294,12 @@ function createIngestionClient({
|
|
|
1331
1294
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
1332
1295
|
*
|
|
1333
1296
|
* Required API Key ACLs:
|
|
1334
|
-
*
|
|
1335
|
-
*
|
|
1336
|
-
*
|
|
1337
|
-
*
|
|
1297
|
+
* - addObject
|
|
1298
|
+
* - deleteIndex
|
|
1299
|
+
* - editSettings
|
|
1338
1300
|
* @param runSource - The runSource object.
|
|
1339
1301
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1340
|
-
* @param runSource.runSourcePayload
|
|
1302
|
+
* @param runSource.runSourcePayload -
|
|
1341
1303
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1342
1304
|
*/
|
|
1343
1305
|
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
@@ -1360,10 +1322,9 @@ function createIngestionClient({
|
|
|
1360
1322
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
1361
1323
|
*
|
|
1362
1324
|
* Required API Key ACLs:
|
|
1363
|
-
*
|
|
1364
|
-
*
|
|
1365
|
-
*
|
|
1366
|
-
*
|
|
1325
|
+
* - addObject
|
|
1326
|
+
* - deleteIndex
|
|
1327
|
+
* - editSettings
|
|
1367
1328
|
* @param runTask - The runTask object.
|
|
1368
1329
|
* @param runTask.taskID - Unique identifier of a task.
|
|
1369
1330
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1387,10 +1348,9 @@ function createIngestionClient({
|
|
|
1387
1348
|
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1388
1349
|
*
|
|
1389
1350
|
* Required API Key ACLs:
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1392
|
-
*
|
|
1393
|
-
*
|
|
1351
|
+
* - addObject
|
|
1352
|
+
* - deleteIndex
|
|
1353
|
+
* - editSettings
|
|
1394
1354
|
* @param runTaskV1 - The runTaskV1 object.
|
|
1395
1355
|
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
1396
1356
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1414,10 +1374,9 @@ function createIngestionClient({
|
|
|
1414
1374
|
* Searches for authentication resources.
|
|
1415
1375
|
*
|
|
1416
1376
|
* Required API Key ACLs:
|
|
1417
|
-
*
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1377
|
+
* - addObject
|
|
1378
|
+
* - deleteIndex
|
|
1379
|
+
* - editSettings
|
|
1421
1380
|
* @param authenticationSearch - The authenticationSearch object.
|
|
1422
1381
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1423
1382
|
*/
|
|
@@ -1446,10 +1405,9 @@ function createIngestionClient({
|
|
|
1446
1405
|
* Searches for destinations.
|
|
1447
1406
|
*
|
|
1448
1407
|
* Required API Key ACLs:
|
|
1449
|
-
*
|
|
1450
|
-
*
|
|
1451
|
-
*
|
|
1452
|
-
*
|
|
1408
|
+
* - addObject
|
|
1409
|
+
* - deleteIndex
|
|
1410
|
+
* - editSettings
|
|
1453
1411
|
* @param destinationSearch - The destinationSearch object.
|
|
1454
1412
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1455
1413
|
*/
|
|
@@ -1476,10 +1434,9 @@ function createIngestionClient({
|
|
|
1476
1434
|
* Searches for sources.
|
|
1477
1435
|
*
|
|
1478
1436
|
* Required API Key ACLs:
|
|
1479
|
-
*
|
|
1480
|
-
*
|
|
1481
|
-
*
|
|
1482
|
-
*
|
|
1437
|
+
* - addObject
|
|
1438
|
+
* - deleteIndex
|
|
1439
|
+
* - editSettings
|
|
1483
1440
|
* @param sourceSearch - The sourceSearch object.
|
|
1484
1441
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1485
1442
|
*/
|
|
@@ -1506,10 +1463,9 @@ function createIngestionClient({
|
|
|
1506
1463
|
* Searches for tasks.
|
|
1507
1464
|
*
|
|
1508
1465
|
* Required API Key ACLs:
|
|
1509
|
-
*
|
|
1510
|
-
*
|
|
1511
|
-
*
|
|
1512
|
-
*
|
|
1466
|
+
* - addObject
|
|
1467
|
+
* - deleteIndex
|
|
1468
|
+
* - editSettings
|
|
1513
1469
|
* @param taskSearch - The taskSearch object.
|
|
1514
1470
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1515
1471
|
*/
|
|
@@ -1536,10 +1492,9 @@ function createIngestionClient({
|
|
|
1536
1492
|
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
1537
1493
|
*
|
|
1538
1494
|
* Required API Key ACLs:
|
|
1539
|
-
*
|
|
1540
|
-
*
|
|
1541
|
-
*
|
|
1542
|
-
*
|
|
1495
|
+
* - addObject
|
|
1496
|
+
* - deleteIndex
|
|
1497
|
+
* - editSettings
|
|
1543
1498
|
* @param taskSearch - The taskSearch object.
|
|
1544
1499
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1545
1500
|
*/
|
|
@@ -1566,10 +1521,9 @@ function createIngestionClient({
|
|
|
1566
1521
|
* Searches for transformations.
|
|
1567
1522
|
*
|
|
1568
1523
|
* Required API Key ACLs:
|
|
1569
|
-
*
|
|
1570
|
-
*
|
|
1571
|
-
*
|
|
1572
|
-
*
|
|
1524
|
+
* - addObject
|
|
1525
|
+
* - deleteIndex
|
|
1526
|
+
* - editSettings
|
|
1573
1527
|
* @param transformationSearch - The transformationSearch object.
|
|
1574
1528
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1575
1529
|
*/
|
|
@@ -1598,10 +1552,9 @@ function createIngestionClient({
|
|
|
1598
1552
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1599
1553
|
*
|
|
1600
1554
|
* Required API Key ACLs:
|
|
1601
|
-
*
|
|
1602
|
-
*
|
|
1603
|
-
*
|
|
1604
|
-
*
|
|
1555
|
+
* - addObject
|
|
1556
|
+
* - deleteIndex
|
|
1557
|
+
* - editSettings
|
|
1605
1558
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1606
1559
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1607
1560
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1625,10 +1578,9 @@ function createIngestionClient({
|
|
|
1625
1578
|
* Try a transformation before creating it.
|
|
1626
1579
|
*
|
|
1627
1580
|
* Required API Key ACLs:
|
|
1628
|
-
*
|
|
1629
|
-
*
|
|
1630
|
-
*
|
|
1631
|
-
*
|
|
1581
|
+
* - addObject
|
|
1582
|
+
* - deleteIndex
|
|
1583
|
+
* - editSettings
|
|
1632
1584
|
* @param transformationTry - The transformationTry object.
|
|
1633
1585
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1634
1586
|
*/
|
|
@@ -1658,10 +1610,9 @@ function createIngestionClient({
|
|
|
1658
1610
|
* Try a transformation before updating it.
|
|
1659
1611
|
*
|
|
1660
1612
|
* Required API Key ACLs:
|
|
1661
|
-
*
|
|
1662
|
-
*
|
|
1663
|
-
*
|
|
1664
|
-
*
|
|
1613
|
+
* - addObject
|
|
1614
|
+
* - deleteIndex
|
|
1615
|
+
* - editSettings
|
|
1665
1616
|
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
1666
1617
|
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
1667
1618
|
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
@@ -1701,10 +1652,9 @@ function createIngestionClient({
|
|
|
1701
1652
|
* Updates an authentication resource.
|
|
1702
1653
|
*
|
|
1703
1654
|
* Required API Key ACLs:
|
|
1704
|
-
*
|
|
1705
|
-
*
|
|
1706
|
-
*
|
|
1707
|
-
*
|
|
1655
|
+
* - addObject
|
|
1656
|
+
* - deleteIndex
|
|
1657
|
+
* - editSettings
|
|
1708
1658
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1709
1659
|
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1710
1660
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
@@ -1736,10 +1686,9 @@ function createIngestionClient({
|
|
|
1736
1686
|
* Updates the destination by its ID.
|
|
1737
1687
|
*
|
|
1738
1688
|
* Required API Key ACLs:
|
|
1739
|
-
*
|
|
1740
|
-
*
|
|
1741
|
-
*
|
|
1742
|
-
*
|
|
1689
|
+
* - addObject
|
|
1690
|
+
* - deleteIndex
|
|
1691
|
+
* - editSettings
|
|
1743
1692
|
* @param updateDestination - The updateDestination object.
|
|
1744
1693
|
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1745
1694
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
@@ -1771,10 +1720,9 @@ function createIngestionClient({
|
|
|
1771
1720
|
* Updates a source by its ID.
|
|
1772
1721
|
*
|
|
1773
1722
|
* Required API Key ACLs:
|
|
1774
|
-
*
|
|
1775
|
-
*
|
|
1776
|
-
*
|
|
1777
|
-
*
|
|
1723
|
+
* - addObject
|
|
1724
|
+
* - deleteIndex
|
|
1725
|
+
* - editSettings
|
|
1778
1726
|
* @param updateSource - The updateSource object.
|
|
1779
1727
|
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1780
1728
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
@@ -1801,7 +1749,6 @@ function createIngestionClient({
|
|
|
1801
1749
|
},
|
|
1802
1750
|
/**
|
|
1803
1751
|
* Updates a task by its ID.
|
|
1804
|
-
*
|
|
1805
1752
|
* @param updateTask - The updateTask object.
|
|
1806
1753
|
* @param updateTask.taskID - Unique identifier of a task.
|
|
1807
1754
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
@@ -1828,7 +1775,6 @@ function createIngestionClient({
|
|
|
1828
1775
|
},
|
|
1829
1776
|
/**
|
|
1830
1777
|
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
1831
|
-
*
|
|
1832
1778
|
* @param updateTaskV1 - The updateTaskV1 object.
|
|
1833
1779
|
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
1834
1780
|
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
@@ -1855,7 +1801,6 @@ function createIngestionClient({
|
|
|
1855
1801
|
},
|
|
1856
1802
|
/**
|
|
1857
1803
|
* Updates a transformation by its ID.
|
|
1858
|
-
*
|
|
1859
1804
|
* @param updateTransformation - The updateTransformation object.
|
|
1860
1805
|
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1861
1806
|
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
@@ -1893,11 +1838,10 @@ function createIngestionClient({
|
|
|
1893
1838
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1894
1839
|
*
|
|
1895
1840
|
* Required API Key ACLs:
|
|
1896
|
-
*
|
|
1897
|
-
*
|
|
1898
|
-
*
|
|
1899
|
-
*
|
|
1900
|
-
* @param sourceCreate -.
|
|
1841
|
+
* - addObject
|
|
1842
|
+
* - deleteIndex
|
|
1843
|
+
* - editSettings
|
|
1844
|
+
* @param sourceCreate -
|
|
1901
1845
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1902
1846
|
*/
|
|
1903
1847
|
validateSource(sourceCreate, requestOptions = void 0) {
|
|
@@ -1917,10 +1861,9 @@ function createIngestionClient({
|
|
|
1917
1861
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1918
1862
|
*
|
|
1919
1863
|
* Required API Key ACLs:
|
|
1920
|
-
*
|
|
1921
|
-
*
|
|
1922
|
-
*
|
|
1923
|
-
*
|
|
1864
|
+
* - addObject
|
|
1865
|
+
* - deleteIndex
|
|
1866
|
+
* - editSettings
|
|
1924
1867
|
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
1925
1868
|
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
1926
1869
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|