@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/browser.js
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
// builds/browser.ts
|
|
2
|
+
import { createXhrRequester } from "@algolia/requester-browser-xhr";
|
|
2
3
|
import {
|
|
3
|
-
createNullLogger,
|
|
4
|
-
createMemoryCache,
|
|
5
|
-
createFallbackableCache,
|
|
6
4
|
createBrowserLocalStorageCache,
|
|
5
|
+
createFallbackableCache,
|
|
6
|
+
createMemoryCache,
|
|
7
|
+
createNullLogger,
|
|
7
8
|
DEFAULT_CONNECT_TIMEOUT_BROWSER,
|
|
8
9
|
DEFAULT_READ_TIMEOUT_BROWSER,
|
|
9
10
|
DEFAULT_WRITE_TIMEOUT_BROWSER
|
|
10
11
|
} from "@algolia/client-common";
|
|
11
|
-
import { createXhrRequester } from "@algolia/requester-browser-xhr";
|
|
12
12
|
|
|
13
13
|
// src/ingestionClient.ts
|
|
14
14
|
import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
|
|
15
|
-
var apiClientVersion = "1.
|
|
15
|
+
var apiClientVersion = "1.8.1";
|
|
16
16
|
var REGIONS = ["eu", "us"];
|
|
17
17
|
function getDefaultHosts(region) {
|
|
18
18
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -98,11 +98,10 @@ function createIngestionClient({
|
|
|
98
98
|
* Creates a new authentication resource.
|
|
99
99
|
*
|
|
100
100
|
* Required API Key ACLs:
|
|
101
|
-
*
|
|
102
|
-
*
|
|
103
|
-
*
|
|
104
|
-
*
|
|
105
|
-
* @param authenticationCreate -.
|
|
101
|
+
* - addObject
|
|
102
|
+
* - deleteIndex
|
|
103
|
+
* - editSettings
|
|
104
|
+
* @param authenticationCreate -
|
|
106
105
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
107
106
|
*/
|
|
108
107
|
createAuthentication(authenticationCreate, requestOptions) {
|
|
@@ -134,11 +133,10 @@ function createIngestionClient({
|
|
|
134
133
|
* Creates a new destination.
|
|
135
134
|
*
|
|
136
135
|
* Required API Key ACLs:
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
*
|
|
140
|
-
*
|
|
141
|
-
* @param destinationCreate -.
|
|
136
|
+
* - addObject
|
|
137
|
+
* - deleteIndex
|
|
138
|
+
* - editSettings
|
|
139
|
+
* @param destinationCreate -
|
|
142
140
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
143
141
|
*/
|
|
144
142
|
createDestination(destinationCreate, requestOptions) {
|
|
@@ -170,11 +168,10 @@ function createIngestionClient({
|
|
|
170
168
|
* Creates a new source.
|
|
171
169
|
*
|
|
172
170
|
* Required API Key ACLs:
|
|
173
|
-
*
|
|
174
|
-
*
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
* @param sourceCreate -.
|
|
171
|
+
* - addObject
|
|
172
|
+
* - deleteIndex
|
|
173
|
+
* - editSettings
|
|
174
|
+
* @param sourceCreate -
|
|
178
175
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
179
176
|
*/
|
|
180
177
|
createSource(sourceCreate, requestOptions) {
|
|
@@ -201,7 +198,6 @@ function createIngestionClient({
|
|
|
201
198
|
},
|
|
202
199
|
/**
|
|
203
200
|
* Creates a new task.
|
|
204
|
-
*
|
|
205
201
|
* @param taskCreate - Request body for creating a task.
|
|
206
202
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
207
203
|
*/
|
|
@@ -232,7 +228,6 @@ function createIngestionClient({
|
|
|
232
228
|
},
|
|
233
229
|
/**
|
|
234
230
|
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
235
|
-
*
|
|
236
231
|
* @param taskCreate - Request body for creating a task.
|
|
237
232
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
238
233
|
*/
|
|
@@ -266,7 +261,6 @@ function createIngestionClient({
|
|
|
266
261
|
},
|
|
267
262
|
/**
|
|
268
263
|
* Creates a new transformation.
|
|
269
|
-
*
|
|
270
264
|
* @param transformationCreate - Request body for creating a transformation.
|
|
271
265
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
272
266
|
*/
|
|
@@ -294,7 +288,6 @@ function createIngestionClient({
|
|
|
294
288
|
},
|
|
295
289
|
/**
|
|
296
290
|
* This method allow you to send requests to the Algolia REST API.
|
|
297
|
-
*
|
|
298
291
|
* @param customDelete - The customDelete object.
|
|
299
292
|
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
300
293
|
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
@@ -317,7 +310,6 @@ function createIngestionClient({
|
|
|
317
310
|
},
|
|
318
311
|
/**
|
|
319
312
|
* This method allow you to send requests to the Algolia REST API.
|
|
320
|
-
*
|
|
321
313
|
* @param customGet - The customGet object.
|
|
322
314
|
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
323
315
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -340,7 +332,6 @@ function createIngestionClient({
|
|
|
340
332
|
},
|
|
341
333
|
/**
|
|
342
334
|
* This method allow you to send requests to the Algolia REST API.
|
|
343
|
-
*
|
|
344
335
|
* @param customPost - The customPost object.
|
|
345
336
|
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
346
337
|
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
@@ -365,7 +356,6 @@ function createIngestionClient({
|
|
|
365
356
|
},
|
|
366
357
|
/**
|
|
367
358
|
* This method allow you to send requests to the Algolia REST API.
|
|
368
|
-
*
|
|
369
359
|
* @param customPut - The customPut object.
|
|
370
360
|
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
371
361
|
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
@@ -392,10 +382,9 @@ function createIngestionClient({
|
|
|
392
382
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
393
383
|
*
|
|
394
384
|
* Required API Key ACLs:
|
|
395
|
-
*
|
|
396
|
-
*
|
|
397
|
-
*
|
|
398
|
-
*
|
|
385
|
+
* - addObject
|
|
386
|
+
* - deleteIndex
|
|
387
|
+
* - editSettings
|
|
399
388
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
400
389
|
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
401
390
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -422,10 +411,9 @@ function createIngestionClient({
|
|
|
422
411
|
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
423
412
|
*
|
|
424
413
|
* Required API Key ACLs:
|
|
425
|
-
*
|
|
426
|
-
*
|
|
427
|
-
*
|
|
428
|
-
*
|
|
414
|
+
* - addObject
|
|
415
|
+
* - deleteIndex
|
|
416
|
+
* - editSettings
|
|
429
417
|
* @param deleteDestination - The deleteDestination object.
|
|
430
418
|
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
431
419
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -452,10 +440,9 @@ function createIngestionClient({
|
|
|
452
440
|
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
453
441
|
*
|
|
454
442
|
* Required API Key ACLs:
|
|
455
|
-
*
|
|
456
|
-
*
|
|
457
|
-
*
|
|
458
|
-
*
|
|
443
|
+
* - addObject
|
|
444
|
+
* - deleteIndex
|
|
445
|
+
* - editSettings
|
|
459
446
|
* @param deleteSource - The deleteSource object.
|
|
460
447
|
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
461
448
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -477,7 +464,6 @@ function createIngestionClient({
|
|
|
477
464
|
},
|
|
478
465
|
/**
|
|
479
466
|
* Deletes a task by its ID.
|
|
480
|
-
*
|
|
481
467
|
* @param deleteTask - The deleteTask object.
|
|
482
468
|
* @param deleteTask.taskID - Unique identifier of a task.
|
|
483
469
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -499,7 +485,6 @@ function createIngestionClient({
|
|
|
499
485
|
},
|
|
500
486
|
/**
|
|
501
487
|
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
502
|
-
*
|
|
503
488
|
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
504
489
|
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
505
490
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -521,7 +506,6 @@ function createIngestionClient({
|
|
|
521
506
|
},
|
|
522
507
|
/**
|
|
523
508
|
* Deletes a transformation by its ID.
|
|
524
|
-
*
|
|
525
509
|
* @param deleteTransformation - The deleteTransformation object.
|
|
526
510
|
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
527
511
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -548,10 +532,9 @@ function createIngestionClient({
|
|
|
548
532
|
* Disables a task.
|
|
549
533
|
*
|
|
550
534
|
* Required API Key ACLs:
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
535
|
+
* - addObject
|
|
536
|
+
* - deleteIndex
|
|
537
|
+
* - editSettings
|
|
555
538
|
* @param disableTask - The disableTask object.
|
|
556
539
|
* @param disableTask.taskID - Unique identifier of a task.
|
|
557
540
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -575,10 +558,9 @@ function createIngestionClient({
|
|
|
575
558
|
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
576
559
|
*
|
|
577
560
|
* Required API Key ACLs:
|
|
578
|
-
*
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
*
|
|
561
|
+
* - addObject
|
|
562
|
+
* - deleteIndex
|
|
563
|
+
* - editSettings
|
|
582
564
|
* @param disableTaskV1 - The disableTaskV1 object.
|
|
583
565
|
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
584
566
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -602,10 +584,9 @@ function createIngestionClient({
|
|
|
602
584
|
* Enables a task.
|
|
603
585
|
*
|
|
604
586
|
* Required API Key ACLs:
|
|
605
|
-
*
|
|
606
|
-
*
|
|
607
|
-
*
|
|
608
|
-
*
|
|
587
|
+
* - addObject
|
|
588
|
+
* - deleteIndex
|
|
589
|
+
* - editSettings
|
|
609
590
|
* @param enableTask - The enableTask object.
|
|
610
591
|
* @param enableTask.taskID - Unique identifier of a task.
|
|
611
592
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -629,10 +610,9 @@ function createIngestionClient({
|
|
|
629
610
|
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
630
611
|
*
|
|
631
612
|
* Required API Key ACLs:
|
|
632
|
-
*
|
|
633
|
-
*
|
|
634
|
-
*
|
|
635
|
-
*
|
|
613
|
+
* - addObject
|
|
614
|
+
* - deleteIndex
|
|
615
|
+
* - editSettings
|
|
636
616
|
* @param enableTaskV1 - The enableTaskV1 object.
|
|
637
617
|
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
638
618
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -656,10 +636,9 @@ function createIngestionClient({
|
|
|
656
636
|
* Retrieves an authentication resource by its ID.
|
|
657
637
|
*
|
|
658
638
|
* Required API Key ACLs:
|
|
659
|
-
*
|
|
660
|
-
*
|
|
661
|
-
*
|
|
662
|
-
*
|
|
639
|
+
* - addObject
|
|
640
|
+
* - deleteIndex
|
|
641
|
+
* - editSettings
|
|
663
642
|
* @param getAuthentication - The getAuthentication object.
|
|
664
643
|
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
665
644
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -686,10 +665,9 @@ function createIngestionClient({
|
|
|
686
665
|
* Retrieves a destination by its ID.
|
|
687
666
|
*
|
|
688
667
|
* Required API Key ACLs:
|
|
689
|
-
*
|
|
690
|
-
*
|
|
691
|
-
*
|
|
692
|
-
*
|
|
668
|
+
* - addObject
|
|
669
|
+
* - deleteIndex
|
|
670
|
+
* - editSettings
|
|
693
671
|
* @param getDestination - The getDestination object.
|
|
694
672
|
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
695
673
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -716,10 +694,9 @@ function createIngestionClient({
|
|
|
716
694
|
* Retrieves a single task run event by its ID.
|
|
717
695
|
*
|
|
718
696
|
* Required API Key ACLs:
|
|
719
|
-
*
|
|
720
|
-
*
|
|
721
|
-
*
|
|
722
|
-
*
|
|
697
|
+
* - addObject
|
|
698
|
+
* - deleteIndex
|
|
699
|
+
* - editSettings
|
|
723
700
|
* @param getEvent - The getEvent object.
|
|
724
701
|
* @param getEvent.runID - Unique identifier of a task run.
|
|
725
702
|
* @param getEvent.eventID - Unique identifier of an event.
|
|
@@ -747,10 +724,9 @@ function createIngestionClient({
|
|
|
747
724
|
* Retrieve a single task run by its ID.
|
|
748
725
|
*
|
|
749
726
|
* Required API Key ACLs:
|
|
750
|
-
*
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
*
|
|
727
|
+
* - addObject
|
|
728
|
+
* - deleteIndex
|
|
729
|
+
* - editSettings
|
|
754
730
|
* @param getRun - The getRun object.
|
|
755
731
|
* @param getRun.runID - Unique identifier of a task run.
|
|
756
732
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -774,10 +750,9 @@ function createIngestionClient({
|
|
|
774
750
|
* Retrieve a source by its ID.
|
|
775
751
|
*
|
|
776
752
|
* Required API Key ACLs:
|
|
777
|
-
*
|
|
778
|
-
*
|
|
779
|
-
*
|
|
780
|
-
*
|
|
753
|
+
* - addObject
|
|
754
|
+
* - deleteIndex
|
|
755
|
+
* - editSettings
|
|
781
756
|
* @param getSource - The getSource object.
|
|
782
757
|
* @param getSource.sourceID - Unique identifier of a source.
|
|
783
758
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -801,10 +776,9 @@ function createIngestionClient({
|
|
|
801
776
|
* Retrieves a task by its ID.
|
|
802
777
|
*
|
|
803
778
|
* Required API Key ACLs:
|
|
804
|
-
*
|
|
805
|
-
*
|
|
806
|
-
*
|
|
807
|
-
*
|
|
779
|
+
* - addObject
|
|
780
|
+
* - deleteIndex
|
|
781
|
+
* - editSettings
|
|
808
782
|
* @param getTask - The getTask object.
|
|
809
783
|
* @param getTask.taskID - Unique identifier of a task.
|
|
810
784
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -828,10 +802,9 @@ function createIngestionClient({
|
|
|
828
802
|
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
829
803
|
*
|
|
830
804
|
* Required API Key ACLs:
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
*
|
|
805
|
+
* - addObject
|
|
806
|
+
* - deleteIndex
|
|
807
|
+
* - editSettings
|
|
835
808
|
* @param getTaskV1 - The getTaskV1 object.
|
|
836
809
|
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
837
810
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -855,10 +828,9 @@ function createIngestionClient({
|
|
|
855
828
|
* Retrieves a transformation by its ID.
|
|
856
829
|
*
|
|
857
830
|
* Required API Key ACLs:
|
|
858
|
-
*
|
|
859
|
-
*
|
|
860
|
-
*
|
|
861
|
-
*
|
|
831
|
+
* - addObject
|
|
832
|
+
* - deleteIndex
|
|
833
|
+
* - editSettings
|
|
862
834
|
* @param getTransformation - The getTransformation object.
|
|
863
835
|
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
864
836
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -885,10 +857,9 @@ function createIngestionClient({
|
|
|
885
857
|
* Retrieves a list of all authentication resources.
|
|
886
858
|
*
|
|
887
859
|
* Required API Key ACLs:
|
|
888
|
-
*
|
|
889
|
-
*
|
|
890
|
-
*
|
|
891
|
-
*
|
|
860
|
+
* - addObject
|
|
861
|
+
* - deleteIndex
|
|
862
|
+
* - editSettings
|
|
892
863
|
* @param listAuthentications - The listAuthentications object.
|
|
893
864
|
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
894
865
|
* @param listAuthentications.page - Page number of the paginated API response.
|
|
@@ -903,22 +874,22 @@ function createIngestionClient({
|
|
|
903
874
|
const headers = {};
|
|
904
875
|
const queryParameters = {};
|
|
905
876
|
if (itemsPerPage !== void 0) {
|
|
906
|
-
queryParameters
|
|
877
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
907
878
|
}
|
|
908
879
|
if (page !== void 0) {
|
|
909
|
-
queryParameters
|
|
880
|
+
queryParameters["page"] = page.toString();
|
|
910
881
|
}
|
|
911
882
|
if (type !== void 0) {
|
|
912
|
-
queryParameters
|
|
883
|
+
queryParameters["type"] = type.toString();
|
|
913
884
|
}
|
|
914
885
|
if (platform !== void 0) {
|
|
915
|
-
queryParameters
|
|
886
|
+
queryParameters["platform"] = platform.toString();
|
|
916
887
|
}
|
|
917
888
|
if (sort !== void 0) {
|
|
918
|
-
queryParameters
|
|
889
|
+
queryParameters["sort"] = sort.toString();
|
|
919
890
|
}
|
|
920
891
|
if (order !== void 0) {
|
|
921
|
-
queryParameters
|
|
892
|
+
queryParameters["order"] = order.toString();
|
|
922
893
|
}
|
|
923
894
|
const request = {
|
|
924
895
|
method: "GET",
|
|
@@ -932,10 +903,9 @@ function createIngestionClient({
|
|
|
932
903
|
* Retrieves a list of destinations.
|
|
933
904
|
*
|
|
934
905
|
* Required API Key ACLs:
|
|
935
|
-
*
|
|
936
|
-
*
|
|
937
|
-
*
|
|
938
|
-
*
|
|
906
|
+
* - addObject
|
|
907
|
+
* - deleteIndex
|
|
908
|
+
* - editSettings
|
|
939
909
|
* @param listDestinations - The listDestinations object.
|
|
940
910
|
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
941
911
|
* @param listDestinations.page - Page number of the paginated API response.
|
|
@@ -951,25 +921,25 @@ function createIngestionClient({
|
|
|
951
921
|
const headers = {};
|
|
952
922
|
const queryParameters = {};
|
|
953
923
|
if (itemsPerPage !== void 0) {
|
|
954
|
-
queryParameters
|
|
924
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
955
925
|
}
|
|
956
926
|
if (page !== void 0) {
|
|
957
|
-
queryParameters
|
|
927
|
+
queryParameters["page"] = page.toString();
|
|
958
928
|
}
|
|
959
929
|
if (type !== void 0) {
|
|
960
|
-
queryParameters
|
|
930
|
+
queryParameters["type"] = type.toString();
|
|
961
931
|
}
|
|
962
932
|
if (authenticationID !== void 0) {
|
|
963
|
-
queryParameters
|
|
933
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
964
934
|
}
|
|
965
935
|
if (transformationID !== void 0) {
|
|
966
|
-
queryParameters
|
|
936
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
967
937
|
}
|
|
968
938
|
if (sort !== void 0) {
|
|
969
|
-
queryParameters
|
|
939
|
+
queryParameters["sort"] = sort.toString();
|
|
970
940
|
}
|
|
971
941
|
if (order !== void 0) {
|
|
972
|
-
queryParameters
|
|
942
|
+
queryParameters["order"] = order.toString();
|
|
973
943
|
}
|
|
974
944
|
const request = {
|
|
975
945
|
method: "GET",
|
|
@@ -980,13 +950,12 @@ function createIngestionClient({
|
|
|
980
950
|
return transporter.request(request, requestOptions);
|
|
981
951
|
},
|
|
982
952
|
/**
|
|
983
|
-
* Retrieves a list of events for a task run, identified by
|
|
953
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
984
954
|
*
|
|
985
955
|
* Required API Key ACLs:
|
|
986
|
-
*
|
|
987
|
-
*
|
|
988
|
-
*
|
|
989
|
-
*
|
|
956
|
+
* - addObject
|
|
957
|
+
* - deleteIndex
|
|
958
|
+
* - editSettings
|
|
990
959
|
* @param listEvents - The listEvents object.
|
|
991
960
|
* @param listEvents.runID - Unique identifier of a task run.
|
|
992
961
|
* @param listEvents.itemsPerPage - Number of items per page.
|
|
@@ -1007,28 +976,28 @@ function createIngestionClient({
|
|
|
1007
976
|
const headers = {};
|
|
1008
977
|
const queryParameters = {};
|
|
1009
978
|
if (itemsPerPage !== void 0) {
|
|
1010
|
-
queryParameters
|
|
979
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1011
980
|
}
|
|
1012
981
|
if (page !== void 0) {
|
|
1013
|
-
queryParameters
|
|
982
|
+
queryParameters["page"] = page.toString();
|
|
1014
983
|
}
|
|
1015
984
|
if (status !== void 0) {
|
|
1016
|
-
queryParameters
|
|
985
|
+
queryParameters["status"] = status.toString();
|
|
1017
986
|
}
|
|
1018
987
|
if (type !== void 0) {
|
|
1019
|
-
queryParameters
|
|
988
|
+
queryParameters["type"] = type.toString();
|
|
1020
989
|
}
|
|
1021
990
|
if (sort !== void 0) {
|
|
1022
|
-
queryParameters
|
|
991
|
+
queryParameters["sort"] = sort.toString();
|
|
1023
992
|
}
|
|
1024
993
|
if (order !== void 0) {
|
|
1025
|
-
queryParameters
|
|
994
|
+
queryParameters["order"] = order.toString();
|
|
1026
995
|
}
|
|
1027
996
|
if (startDate !== void 0) {
|
|
1028
|
-
queryParameters
|
|
997
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1029
998
|
}
|
|
1030
999
|
if (endDate !== void 0) {
|
|
1031
|
-
queryParameters
|
|
1000
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1032
1001
|
}
|
|
1033
1002
|
const request = {
|
|
1034
1003
|
method: "GET",
|
|
@@ -1042,10 +1011,9 @@ function createIngestionClient({
|
|
|
1042
1011
|
* Retrieve a list of task runs.
|
|
1043
1012
|
*
|
|
1044
1013
|
* Required API Key ACLs:
|
|
1045
|
-
*
|
|
1046
|
-
*
|
|
1047
|
-
*
|
|
1048
|
-
*
|
|
1014
|
+
* - addObject
|
|
1015
|
+
* - deleteIndex
|
|
1016
|
+
* - editSettings
|
|
1049
1017
|
* @param listRuns - The listRuns object.
|
|
1050
1018
|
* @param listRuns.itemsPerPage - Number of items per page.
|
|
1051
1019
|
* @param listRuns.page - Page number of the paginated API response.
|
|
@@ -1063,31 +1031,31 @@ function createIngestionClient({
|
|
|
1063
1031
|
const headers = {};
|
|
1064
1032
|
const queryParameters = {};
|
|
1065
1033
|
if (itemsPerPage !== void 0) {
|
|
1066
|
-
queryParameters
|
|
1034
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1067
1035
|
}
|
|
1068
1036
|
if (page !== void 0) {
|
|
1069
|
-
queryParameters
|
|
1037
|
+
queryParameters["page"] = page.toString();
|
|
1070
1038
|
}
|
|
1071
1039
|
if (status !== void 0) {
|
|
1072
|
-
queryParameters
|
|
1040
|
+
queryParameters["status"] = status.toString();
|
|
1073
1041
|
}
|
|
1074
1042
|
if (type !== void 0) {
|
|
1075
|
-
queryParameters
|
|
1043
|
+
queryParameters["type"] = type.toString();
|
|
1076
1044
|
}
|
|
1077
1045
|
if (taskID !== void 0) {
|
|
1078
|
-
queryParameters
|
|
1046
|
+
queryParameters["taskID"] = taskID.toString();
|
|
1079
1047
|
}
|
|
1080
1048
|
if (sort !== void 0) {
|
|
1081
|
-
queryParameters
|
|
1049
|
+
queryParameters["sort"] = sort.toString();
|
|
1082
1050
|
}
|
|
1083
1051
|
if (order !== void 0) {
|
|
1084
|
-
queryParameters
|
|
1052
|
+
queryParameters["order"] = order.toString();
|
|
1085
1053
|
}
|
|
1086
1054
|
if (startDate !== void 0) {
|
|
1087
|
-
queryParameters
|
|
1055
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1088
1056
|
}
|
|
1089
1057
|
if (endDate !== void 0) {
|
|
1090
|
-
queryParameters
|
|
1058
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1091
1059
|
}
|
|
1092
1060
|
const request = {
|
|
1093
1061
|
method: "GET",
|
|
@@ -1101,10 +1069,9 @@ function createIngestionClient({
|
|
|
1101
1069
|
* Retrieves a list of sources.
|
|
1102
1070
|
*
|
|
1103
1071
|
* Required API Key ACLs:
|
|
1104
|
-
*
|
|
1105
|
-
*
|
|
1106
|
-
*
|
|
1107
|
-
*
|
|
1072
|
+
* - addObject
|
|
1073
|
+
* - deleteIndex
|
|
1074
|
+
* - editSettings
|
|
1108
1075
|
* @param listSources - The listSources object.
|
|
1109
1076
|
* @param listSources.itemsPerPage - Number of items per page.
|
|
1110
1077
|
* @param listSources.page - Page number of the paginated API response.
|
|
@@ -1119,22 +1086,22 @@ function createIngestionClient({
|
|
|
1119
1086
|
const headers = {};
|
|
1120
1087
|
const queryParameters = {};
|
|
1121
1088
|
if (itemsPerPage !== void 0) {
|
|
1122
|
-
queryParameters
|
|
1089
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1123
1090
|
}
|
|
1124
1091
|
if (page !== void 0) {
|
|
1125
|
-
queryParameters
|
|
1092
|
+
queryParameters["page"] = page.toString();
|
|
1126
1093
|
}
|
|
1127
1094
|
if (type !== void 0) {
|
|
1128
|
-
queryParameters
|
|
1095
|
+
queryParameters["type"] = type.toString();
|
|
1129
1096
|
}
|
|
1130
1097
|
if (authenticationID !== void 0) {
|
|
1131
|
-
queryParameters
|
|
1098
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1132
1099
|
}
|
|
1133
1100
|
if (sort !== void 0) {
|
|
1134
|
-
queryParameters
|
|
1101
|
+
queryParameters["sort"] = sort.toString();
|
|
1135
1102
|
}
|
|
1136
1103
|
if (order !== void 0) {
|
|
1137
|
-
queryParameters
|
|
1104
|
+
queryParameters["order"] = order.toString();
|
|
1138
1105
|
}
|
|
1139
1106
|
const request = {
|
|
1140
1107
|
method: "GET",
|
|
@@ -1148,10 +1115,9 @@ function createIngestionClient({
|
|
|
1148
1115
|
* Retrieves a list of tasks.
|
|
1149
1116
|
*
|
|
1150
1117
|
* Required API Key ACLs:
|
|
1151
|
-
*
|
|
1152
|
-
*
|
|
1153
|
-
*
|
|
1154
|
-
*
|
|
1118
|
+
* - addObject
|
|
1119
|
+
* - deleteIndex
|
|
1120
|
+
* - editSettings
|
|
1155
1121
|
* @param listTasks - The listTasks object.
|
|
1156
1122
|
* @param listTasks.itemsPerPage - Number of items per page.
|
|
1157
1123
|
* @param listTasks.page - Page number of the paginated API response.
|
|
@@ -1169,31 +1135,31 @@ function createIngestionClient({
|
|
|
1169
1135
|
const headers = {};
|
|
1170
1136
|
const queryParameters = {};
|
|
1171
1137
|
if (itemsPerPage !== void 0) {
|
|
1172
|
-
queryParameters
|
|
1138
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1173
1139
|
}
|
|
1174
1140
|
if (page !== void 0) {
|
|
1175
|
-
queryParameters
|
|
1141
|
+
queryParameters["page"] = page.toString();
|
|
1176
1142
|
}
|
|
1177
1143
|
if (action !== void 0) {
|
|
1178
|
-
queryParameters
|
|
1144
|
+
queryParameters["action"] = action.toString();
|
|
1179
1145
|
}
|
|
1180
1146
|
if (enabled !== void 0) {
|
|
1181
|
-
queryParameters
|
|
1147
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1182
1148
|
}
|
|
1183
1149
|
if (sourceID !== void 0) {
|
|
1184
|
-
queryParameters
|
|
1150
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1185
1151
|
}
|
|
1186
1152
|
if (destinationID !== void 0) {
|
|
1187
|
-
queryParameters
|
|
1153
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1188
1154
|
}
|
|
1189
1155
|
if (triggerType !== void 0) {
|
|
1190
|
-
queryParameters
|
|
1156
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1191
1157
|
}
|
|
1192
1158
|
if (sort !== void 0) {
|
|
1193
|
-
queryParameters
|
|
1159
|
+
queryParameters["sort"] = sort.toString();
|
|
1194
1160
|
}
|
|
1195
1161
|
if (order !== void 0) {
|
|
1196
|
-
queryParameters
|
|
1162
|
+
queryParameters["order"] = order.toString();
|
|
1197
1163
|
}
|
|
1198
1164
|
const request = {
|
|
1199
1165
|
method: "GET",
|
|
@@ -1207,10 +1173,9 @@ function createIngestionClient({
|
|
|
1207
1173
|
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
1208
1174
|
*
|
|
1209
1175
|
* Required API Key ACLs:
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1212
|
-
*
|
|
1213
|
-
*
|
|
1176
|
+
* - addObject
|
|
1177
|
+
* - deleteIndex
|
|
1178
|
+
* - editSettings
|
|
1214
1179
|
* @param listTasksV1 - The listTasksV1 object.
|
|
1215
1180
|
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
1216
1181
|
* @param listTasksV1.page - Page number of the paginated API response.
|
|
@@ -1228,31 +1193,31 @@ function createIngestionClient({
|
|
|
1228
1193
|
const headers = {};
|
|
1229
1194
|
const queryParameters = {};
|
|
1230
1195
|
if (itemsPerPage !== void 0) {
|
|
1231
|
-
queryParameters
|
|
1196
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1232
1197
|
}
|
|
1233
1198
|
if (page !== void 0) {
|
|
1234
|
-
queryParameters
|
|
1199
|
+
queryParameters["page"] = page.toString();
|
|
1235
1200
|
}
|
|
1236
1201
|
if (action !== void 0) {
|
|
1237
|
-
queryParameters
|
|
1202
|
+
queryParameters["action"] = action.toString();
|
|
1238
1203
|
}
|
|
1239
1204
|
if (enabled !== void 0) {
|
|
1240
|
-
queryParameters
|
|
1205
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1241
1206
|
}
|
|
1242
1207
|
if (sourceID !== void 0) {
|
|
1243
|
-
queryParameters
|
|
1208
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1244
1209
|
}
|
|
1245
1210
|
if (destinationID !== void 0) {
|
|
1246
|
-
queryParameters
|
|
1211
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1247
1212
|
}
|
|
1248
1213
|
if (triggerType !== void 0) {
|
|
1249
|
-
queryParameters
|
|
1214
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1250
1215
|
}
|
|
1251
1216
|
if (sort !== void 0) {
|
|
1252
|
-
queryParameters
|
|
1217
|
+
queryParameters["sort"] = sort.toString();
|
|
1253
1218
|
}
|
|
1254
1219
|
if (order !== void 0) {
|
|
1255
|
-
queryParameters
|
|
1220
|
+
queryParameters["order"] = order.toString();
|
|
1256
1221
|
}
|
|
1257
1222
|
const request = {
|
|
1258
1223
|
method: "GET",
|
|
@@ -1266,10 +1231,9 @@ function createIngestionClient({
|
|
|
1266
1231
|
* Retrieves a list of transformations.
|
|
1267
1232
|
*
|
|
1268
1233
|
* Required API Key ACLs:
|
|
1269
|
-
*
|
|
1270
|
-
*
|
|
1271
|
-
*
|
|
1272
|
-
*
|
|
1234
|
+
* - addObject
|
|
1235
|
+
* - deleteIndex
|
|
1236
|
+
* - editSettings
|
|
1273
1237
|
* @param listTransformations - The listTransformations object.
|
|
1274
1238
|
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
1275
1239
|
* @param listTransformations.page - Page number of the paginated API response.
|
|
@@ -1282,16 +1246,16 @@ function createIngestionClient({
|
|
|
1282
1246
|
const headers = {};
|
|
1283
1247
|
const queryParameters = {};
|
|
1284
1248
|
if (itemsPerPage !== void 0) {
|
|
1285
|
-
queryParameters
|
|
1249
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1286
1250
|
}
|
|
1287
1251
|
if (page !== void 0) {
|
|
1288
|
-
queryParameters
|
|
1252
|
+
queryParameters["page"] = page.toString();
|
|
1289
1253
|
}
|
|
1290
1254
|
if (sort !== void 0) {
|
|
1291
|
-
queryParameters
|
|
1255
|
+
queryParameters["sort"] = sort.toString();
|
|
1292
1256
|
}
|
|
1293
1257
|
if (order !== void 0) {
|
|
1294
|
-
queryParameters
|
|
1258
|
+
queryParameters["order"] = order.toString();
|
|
1295
1259
|
}
|
|
1296
1260
|
const request = {
|
|
1297
1261
|
method: "GET",
|
|
@@ -1305,10 +1269,9 @@ function createIngestionClient({
|
|
|
1305
1269
|
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
1306
1270
|
*
|
|
1307
1271
|
* Required API Key ACLs:
|
|
1308
|
-
*
|
|
1309
|
-
*
|
|
1310
|
-
*
|
|
1311
|
-
*
|
|
1272
|
+
* - addObject
|
|
1273
|
+
* - deleteIndex
|
|
1274
|
+
* - editSettings
|
|
1312
1275
|
* @param pushTask - The pushTask object.
|
|
1313
1276
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1314
1277
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
@@ -1343,13 +1306,12 @@ function createIngestionClient({
|
|
|
1343
1306
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
1344
1307
|
*
|
|
1345
1308
|
* Required API Key ACLs:
|
|
1346
|
-
*
|
|
1347
|
-
*
|
|
1348
|
-
*
|
|
1349
|
-
*
|
|
1309
|
+
* - addObject
|
|
1310
|
+
* - deleteIndex
|
|
1311
|
+
* - editSettings
|
|
1350
1312
|
* @param runSource - The runSource object.
|
|
1351
1313
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1352
|
-
* @param runSource.runSourcePayload
|
|
1314
|
+
* @param runSource.runSourcePayload -
|
|
1353
1315
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1354
1316
|
*/
|
|
1355
1317
|
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
@@ -1372,10 +1334,9 @@ function createIngestionClient({
|
|
|
1372
1334
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
1373
1335
|
*
|
|
1374
1336
|
* Required API Key ACLs:
|
|
1375
|
-
*
|
|
1376
|
-
*
|
|
1377
|
-
*
|
|
1378
|
-
*
|
|
1337
|
+
* - addObject
|
|
1338
|
+
* - deleteIndex
|
|
1339
|
+
* - editSettings
|
|
1379
1340
|
* @param runTask - The runTask object.
|
|
1380
1341
|
* @param runTask.taskID - Unique identifier of a task.
|
|
1381
1342
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1399,10 +1360,9 @@ function createIngestionClient({
|
|
|
1399
1360
|
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1400
1361
|
*
|
|
1401
1362
|
* Required API Key ACLs:
|
|
1402
|
-
*
|
|
1403
|
-
*
|
|
1404
|
-
*
|
|
1405
|
-
*
|
|
1363
|
+
* - addObject
|
|
1364
|
+
* - deleteIndex
|
|
1365
|
+
* - editSettings
|
|
1406
1366
|
* @param runTaskV1 - The runTaskV1 object.
|
|
1407
1367
|
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
1408
1368
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1426,10 +1386,9 @@ function createIngestionClient({
|
|
|
1426
1386
|
* Searches for authentication resources.
|
|
1427
1387
|
*
|
|
1428
1388
|
* Required API Key ACLs:
|
|
1429
|
-
*
|
|
1430
|
-
*
|
|
1431
|
-
*
|
|
1432
|
-
*
|
|
1389
|
+
* - addObject
|
|
1390
|
+
* - deleteIndex
|
|
1391
|
+
* - editSettings
|
|
1433
1392
|
* @param authenticationSearch - The authenticationSearch object.
|
|
1434
1393
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1435
1394
|
*/
|
|
@@ -1458,10 +1417,9 @@ function createIngestionClient({
|
|
|
1458
1417
|
* Searches for destinations.
|
|
1459
1418
|
*
|
|
1460
1419
|
* Required API Key ACLs:
|
|
1461
|
-
*
|
|
1462
|
-
*
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1420
|
+
* - addObject
|
|
1421
|
+
* - deleteIndex
|
|
1422
|
+
* - editSettings
|
|
1465
1423
|
* @param destinationSearch - The destinationSearch object.
|
|
1466
1424
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1467
1425
|
*/
|
|
@@ -1488,10 +1446,9 @@ function createIngestionClient({
|
|
|
1488
1446
|
* Searches for sources.
|
|
1489
1447
|
*
|
|
1490
1448
|
* Required API Key ACLs:
|
|
1491
|
-
*
|
|
1492
|
-
*
|
|
1493
|
-
*
|
|
1494
|
-
*
|
|
1449
|
+
* - addObject
|
|
1450
|
+
* - deleteIndex
|
|
1451
|
+
* - editSettings
|
|
1495
1452
|
* @param sourceSearch - The sourceSearch object.
|
|
1496
1453
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1497
1454
|
*/
|
|
@@ -1518,10 +1475,9 @@ function createIngestionClient({
|
|
|
1518
1475
|
* Searches for tasks.
|
|
1519
1476
|
*
|
|
1520
1477
|
* Required API Key ACLs:
|
|
1521
|
-
*
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
*
|
|
1478
|
+
* - addObject
|
|
1479
|
+
* - deleteIndex
|
|
1480
|
+
* - editSettings
|
|
1525
1481
|
* @param taskSearch - The taskSearch object.
|
|
1526
1482
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1527
1483
|
*/
|
|
@@ -1548,10 +1504,9 @@ function createIngestionClient({
|
|
|
1548
1504
|
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
1549
1505
|
*
|
|
1550
1506
|
* Required API Key ACLs:
|
|
1551
|
-
*
|
|
1552
|
-
*
|
|
1553
|
-
*
|
|
1554
|
-
*
|
|
1507
|
+
* - addObject
|
|
1508
|
+
* - deleteIndex
|
|
1509
|
+
* - editSettings
|
|
1555
1510
|
* @param taskSearch - The taskSearch object.
|
|
1556
1511
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1557
1512
|
*/
|
|
@@ -1578,10 +1533,9 @@ function createIngestionClient({
|
|
|
1578
1533
|
* Searches for transformations.
|
|
1579
1534
|
*
|
|
1580
1535
|
* Required API Key ACLs:
|
|
1581
|
-
*
|
|
1582
|
-
*
|
|
1583
|
-
*
|
|
1584
|
-
*
|
|
1536
|
+
* - addObject
|
|
1537
|
+
* - deleteIndex
|
|
1538
|
+
* - editSettings
|
|
1585
1539
|
* @param transformationSearch - The transformationSearch object.
|
|
1586
1540
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1587
1541
|
*/
|
|
@@ -1610,10 +1564,9 @@ function createIngestionClient({
|
|
|
1610
1564
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1611
1565
|
*
|
|
1612
1566
|
* Required API Key ACLs:
|
|
1613
|
-
*
|
|
1614
|
-
*
|
|
1615
|
-
*
|
|
1616
|
-
*
|
|
1567
|
+
* - addObject
|
|
1568
|
+
* - deleteIndex
|
|
1569
|
+
* - editSettings
|
|
1617
1570
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1618
1571
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1619
1572
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1637,10 +1590,9 @@ function createIngestionClient({
|
|
|
1637
1590
|
* Try a transformation before creating it.
|
|
1638
1591
|
*
|
|
1639
1592
|
* Required API Key ACLs:
|
|
1640
|
-
*
|
|
1641
|
-
*
|
|
1642
|
-
*
|
|
1643
|
-
*
|
|
1593
|
+
* - addObject
|
|
1594
|
+
* - deleteIndex
|
|
1595
|
+
* - editSettings
|
|
1644
1596
|
* @param transformationTry - The transformationTry object.
|
|
1645
1597
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1646
1598
|
*/
|
|
@@ -1670,10 +1622,9 @@ function createIngestionClient({
|
|
|
1670
1622
|
* Try a transformation before updating it.
|
|
1671
1623
|
*
|
|
1672
1624
|
* Required API Key ACLs:
|
|
1673
|
-
*
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1625
|
+
* - addObject
|
|
1626
|
+
* - deleteIndex
|
|
1627
|
+
* - editSettings
|
|
1677
1628
|
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
1678
1629
|
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
1679
1630
|
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
@@ -1713,10 +1664,9 @@ function createIngestionClient({
|
|
|
1713
1664
|
* Updates an authentication resource.
|
|
1714
1665
|
*
|
|
1715
1666
|
* Required API Key ACLs:
|
|
1716
|
-
*
|
|
1717
|
-
*
|
|
1718
|
-
*
|
|
1719
|
-
*
|
|
1667
|
+
* - addObject
|
|
1668
|
+
* - deleteIndex
|
|
1669
|
+
* - editSettings
|
|
1720
1670
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1721
1671
|
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1722
1672
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
@@ -1748,10 +1698,9 @@ function createIngestionClient({
|
|
|
1748
1698
|
* Updates the destination by its ID.
|
|
1749
1699
|
*
|
|
1750
1700
|
* Required API Key ACLs:
|
|
1751
|
-
*
|
|
1752
|
-
*
|
|
1753
|
-
*
|
|
1754
|
-
*
|
|
1701
|
+
* - addObject
|
|
1702
|
+
* - deleteIndex
|
|
1703
|
+
* - editSettings
|
|
1755
1704
|
* @param updateDestination - The updateDestination object.
|
|
1756
1705
|
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1757
1706
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
@@ -1783,10 +1732,9 @@ function createIngestionClient({
|
|
|
1783
1732
|
* Updates a source by its ID.
|
|
1784
1733
|
*
|
|
1785
1734
|
* Required API Key ACLs:
|
|
1786
|
-
*
|
|
1787
|
-
*
|
|
1788
|
-
*
|
|
1789
|
-
*
|
|
1735
|
+
* - addObject
|
|
1736
|
+
* - deleteIndex
|
|
1737
|
+
* - editSettings
|
|
1790
1738
|
* @param updateSource - The updateSource object.
|
|
1791
1739
|
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1792
1740
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
@@ -1813,7 +1761,6 @@ function createIngestionClient({
|
|
|
1813
1761
|
},
|
|
1814
1762
|
/**
|
|
1815
1763
|
* Updates a task by its ID.
|
|
1816
|
-
*
|
|
1817
1764
|
* @param updateTask - The updateTask object.
|
|
1818
1765
|
* @param updateTask.taskID - Unique identifier of a task.
|
|
1819
1766
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
@@ -1840,7 +1787,6 @@ function createIngestionClient({
|
|
|
1840
1787
|
},
|
|
1841
1788
|
/**
|
|
1842
1789
|
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
1843
|
-
*
|
|
1844
1790
|
* @param updateTaskV1 - The updateTaskV1 object.
|
|
1845
1791
|
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
1846
1792
|
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
@@ -1867,7 +1813,6 @@ function createIngestionClient({
|
|
|
1867
1813
|
},
|
|
1868
1814
|
/**
|
|
1869
1815
|
* Updates a transformation by its ID.
|
|
1870
|
-
*
|
|
1871
1816
|
* @param updateTransformation - The updateTransformation object.
|
|
1872
1817
|
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1873
1818
|
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
@@ -1905,11 +1850,10 @@ function createIngestionClient({
|
|
|
1905
1850
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1906
1851
|
*
|
|
1907
1852
|
* Required API Key ACLs:
|
|
1908
|
-
*
|
|
1909
|
-
*
|
|
1910
|
-
*
|
|
1911
|
-
*
|
|
1912
|
-
* @param sourceCreate -.
|
|
1853
|
+
* - addObject
|
|
1854
|
+
* - deleteIndex
|
|
1855
|
+
* - editSettings
|
|
1856
|
+
* @param sourceCreate -
|
|
1913
1857
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1914
1858
|
*/
|
|
1915
1859
|
validateSource(sourceCreate, requestOptions = void 0) {
|
|
@@ -1929,10 +1873,9 @@ function createIngestionClient({
|
|
|
1929
1873
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1930
1874
|
*
|
|
1931
1875
|
* Required API Key ACLs:
|
|
1932
|
-
*
|
|
1933
|
-
*
|
|
1934
|
-
*
|
|
1935
|
-
*
|
|
1876
|
+
* - addObject
|
|
1877
|
+
* - deleteIndex
|
|
1878
|
+
* - editSettings
|
|
1936
1879
|
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
1937
1880
|
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
1938
1881
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|