@algolia/ingestion 5.2.4-beta.5 → 5.10.0-beta.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 +15 -7
- package/dist/browser.d.ts +1266 -634
- package/dist/builds/browser.js +223 -322
- 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 +6 -6
- package/dist/builds/fetch.js +1943 -0
- package/dist/builds/fetch.js.map +1 -0
- package/dist/builds/node.cjs +220 -320
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +221 -320
- package/dist/builds/node.js.map +1 -1
- package/dist/fetch.d.ts +3001 -0
- package/dist/node.d.cts +1267 -634
- package/dist/node.d.ts +1267 -634
- package/dist/src/ingestionClient.cjs +218 -319
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +218 -319
- package/dist/src/ingestionClient.js.map +1 -1
- package/index.d.ts +0 -1
- package/index.js +1 -2
- package/package.json +16 -11
- package/model/action.ts +0 -13
- package/model/actionType.ts +0 -6
- package/model/authAPIKey.ts +0 -11
- package/model/authAPIKeyPartial.ts +0 -11
- package/model/authAlgolia.ts +0 -16
- package/model/authAlgoliaInsights.ts +0 -16
- package/model/authAlgoliaInsightsPartial.ts +0 -16
- package/model/authAlgoliaPartial.ts +0 -16
- package/model/authBasic.ts +0 -16
- package/model/authBasicPartial.ts +0 -16
- package/model/authGoogleServiceAccount.ts +0 -16
- package/model/authGoogleServiceAccountPartial.ts +0 -16
- package/model/authInput.ts +0 -16
- package/model/authInputPartial.ts +0 -16
- package/model/authOAuth.ts +0 -26
- package/model/authOAuthPartial.ts +0 -26
- package/model/authentication.ts +0 -36
- package/model/authenticationCreate.ts +0 -21
- package/model/authenticationCreateResponse.ts +0 -21
- package/model/authenticationSearch.ts +0 -8
- package/model/authenticationSortKeys.ts +0 -6
- package/model/authenticationType.ts +0 -6
- package/model/authenticationUpdate.ts +0 -21
- package/model/authenticationUpdateResponse.ts +0 -21
- package/model/bigCommerceChannel.ts +0 -13
- package/model/bigCommerceMetafield.ts +0 -13
- package/model/bigQueryDataType.ts +0 -3
- package/model/clientMethodProps.ts +0 -703
- package/model/commercetoolsCustomFields.ts +0 -21
- package/model/deleteResponse.ts +0 -8
- package/model/destination.ts +0 -40
- package/model/destinationCreate.ts +0 -25
- package/model/destinationCreateResponse.ts +0 -21
- package/model/destinationIndexName.ts +0 -17
- package/model/destinationInput.ts +0 -5
- package/model/destinationSearch.ts +0 -8
- package/model/destinationSortKeys.ts +0 -6
- package/model/destinationType.ts +0 -6
- package/model/destinationUpdate.ts +0 -25
- package/model/destinationUpdateResponse.ts +0 -21
- package/model/dockerImageType.ts +0 -6
- package/model/dockerRegistry.ts +0 -6
- package/model/dockerStreams.ts +0 -17
- package/model/dockerStreamsInput.ts +0 -10
- package/model/dockerStreamsSyncMode.ts +0 -6
- package/model/entityType.ts +0 -6
- package/model/errorBase.ts +0 -8
- package/model/event.ts +0 -40
- package/model/eventSortKeys.ts +0 -6
- package/model/eventStatus.ts +0 -3
- package/model/eventType.ts +0 -3
- package/model/generateTransformationCodePayload.ts +0 -9
- package/model/generateTransformationCodeResponse.ts +0 -5
- package/model/index.ts +0 -151
- package/model/listAuthenticationsResponse.ts +0 -10
- package/model/listDestinationsResponse.ts +0 -10
- package/model/listEventsResponse.ts +0 -13
- package/model/listSourcesResponse.ts +0 -10
- package/model/listTasksResponse.ts +0 -13
- package/model/listTasksResponseV1.ts +0 -13
- package/model/listTransformationsResponse.ts +0 -13
- package/model/mappingFieldDirective.ts +0 -16
- package/model/mappingFormatSchema.ts +0 -6
- package/model/mappingInput.ts +0 -13
- package/model/mappingKitAction.ts +0 -25
- package/model/mappingTypeCSV.ts +0 -3
- package/model/methodType.ts +0 -6
- package/model/model.ts +0 -13
- package/model/onDemandTrigger.ts +0 -15
- package/model/onDemandTriggerInput.ts +0 -10
- package/model/onDemandTriggerType.ts +0 -6
- package/model/orderKeys.ts +0 -6
- package/model/pagination.ts +0 -26
- package/model/platform.ts +0 -6
- package/model/platformNone.ts +0 -6
- package/model/platformWithNone.ts +0 -6
- package/model/pushTaskPayload.ts +0 -10
- package/model/pushTaskRecords.ts +0 -8
- package/model/recordType.ts +0 -6
- package/model/run.ts +0 -56
- package/model/runListResponse.ts +0 -13
- package/model/runOutcome.ts +0 -6
- package/model/runProgress.ts +0 -7
- package/model/runReasonCode.ts +0 -6
- package/model/runResponse.ts +0 -16
- package/model/runSortKeys.ts +0 -6
- package/model/runSourcePayload.ts +0 -22
- package/model/runSourceResponse.ts +0 -13
- package/model/runStatus.ts +0 -6
- package/model/runType.ts +0 -6
- package/model/scheduleTrigger.ts +0 -25
- package/model/scheduleTriggerInput.ts +0 -15
- package/model/scheduleTriggerType.ts +0 -6
- package/model/shopifyInput.ts +0 -13
- package/model/shopifyMarket.ts +0 -12
- package/model/shopifyMetafield.ts +0 -12
- package/model/sortKeys.ts +0 -6
- package/model/source.ts +0 -32
- package/model/sourceBigCommerce.ts +0 -19
- package/model/sourceBigQuery.ts +0 -37
- package/model/sourceCSV.ts +0 -28
- package/model/sourceCommercetools.ts +0 -23
- package/model/sourceCreate.ts +0 -20
- package/model/sourceCreateResponse.ts +0 -18
- package/model/sourceDocker.ts +0 -25
- package/model/sourceGA4BigQueryExport.ts +0 -18
- package/model/sourceInput.ts +0 -20
- package/model/sourceJSON.ts +0 -17
- package/model/sourceSearch.ts +0 -5
- package/model/sourceShopify.ts +0 -6
- package/model/sourceShopifyBase.ts +0 -8
- package/model/sourceSortKeys.ts +0 -6
- package/model/sourceType.ts +0 -13
- package/model/sourceUpdate.ts +0 -17
- package/model/sourceUpdateCommercetools.ts +0 -21
- package/model/sourceUpdateDocker.ts +0 -22
- package/model/sourceUpdateInput.ts +0 -18
- package/model/sourceUpdateResponse.ts +0 -18
- package/model/sourceUpdateShopify.ts +0 -8
- package/model/sourceWatchResponse.ts +0 -25
- package/model/streamingInput.ts +0 -10
- package/model/streamingTrigger.ts +0 -10
- package/model/streamingTriggerType.ts +0 -6
- package/model/subscriptionTrigger.ts +0 -10
- package/model/subscriptionTriggerType.ts +0 -6
- package/model/task.ts +0 -65
- package/model/taskCreate.ts +0 -43
- package/model/taskCreateResponse.ts +0 -16
- package/model/taskCreateTrigger.ts +0 -8
- package/model/taskCreateV1.ts +0 -41
- package/model/taskInput.ts +0 -10
- package/model/taskSearch.ts +0 -5
- package/model/taskSortKeys.ts +0 -6
- package/model/taskUpdate.ts +0 -30
- package/model/taskUpdateResponse.ts +0 -16
- package/model/taskUpdateV1.ts +0 -28
- package/model/taskV1.ts +0 -56
- package/model/transformation.ts +0 -38
- package/model/transformationCreate.ts +0 -26
- package/model/transformationCreateResponse.ts +0 -16
- package/model/transformationError.ts +0 -16
- package/model/transformationModels.ts +0 -10
- package/model/transformationSearch.ts +0 -5
- package/model/transformationTry.ts +0 -17
- package/model/transformationTryResponse.ts +0 -12
- package/model/transformationUpdateResponse.ts +0 -16
- package/model/trigger.ts +0 -11
- package/model/triggerType.ts +0 -6
- package/model/triggerUpdateInput.ts +0 -11
- package/model/window.ts +0 -16
|
@@ -29,7 +29,7 @@ __export(ingestionClient_exports, {
|
|
|
29
29
|
});
|
|
30
30
|
module.exports = __toCommonJS(ingestionClient_exports);
|
|
31
31
|
var import_client_common = require("@algolia/client-common");
|
|
32
|
-
var apiClientVersion = "1.
|
|
32
|
+
var apiClientVersion = "1.10.0";
|
|
33
33
|
var REGIONS = ["eu", "us"];
|
|
34
34
|
function getDefaultHosts(region) {
|
|
35
35
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -98,15 +98,27 @@ function createIngestionClient({
|
|
|
98
98
|
addAlgoliaAgent(segment, version) {
|
|
99
99
|
transporter.algoliaAgent.add({ segment, version });
|
|
100
100
|
},
|
|
101
|
+
/**
|
|
102
|
+
* Helper method to switch the API key used to authenticate the requests.
|
|
103
|
+
*
|
|
104
|
+
* @param params - Method params.
|
|
105
|
+
* @param params.apiKey - The new API Key to use.
|
|
106
|
+
*/
|
|
107
|
+
setClientApiKey({ apiKey }) {
|
|
108
|
+
if (!authMode || authMode === "WithinHeaders") {
|
|
109
|
+
transporter.baseHeaders["x-algolia-api-key"] = apiKey;
|
|
110
|
+
} else {
|
|
111
|
+
transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
|
|
112
|
+
}
|
|
113
|
+
},
|
|
101
114
|
/**
|
|
102
115
|
* Creates a new authentication resource.
|
|
103
116
|
*
|
|
104
117
|
* Required API Key ACLs:
|
|
105
|
-
*
|
|
106
|
-
*
|
|
107
|
-
*
|
|
108
|
-
*
|
|
109
|
-
* @param authenticationCreate -.
|
|
118
|
+
* - addObject
|
|
119
|
+
* - deleteIndex
|
|
120
|
+
* - editSettings
|
|
121
|
+
* @param authenticationCreate -
|
|
110
122
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
111
123
|
*/
|
|
112
124
|
createAuthentication(authenticationCreate, requestOptions) {
|
|
@@ -138,11 +150,10 @@ function createIngestionClient({
|
|
|
138
150
|
* Creates a new destination.
|
|
139
151
|
*
|
|
140
152
|
* Required API Key ACLs:
|
|
141
|
-
*
|
|
142
|
-
*
|
|
143
|
-
*
|
|
144
|
-
*
|
|
145
|
-
* @param destinationCreate -.
|
|
153
|
+
* - addObject
|
|
154
|
+
* - deleteIndex
|
|
155
|
+
* - editSettings
|
|
156
|
+
* @param destinationCreate -
|
|
146
157
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
147
158
|
*/
|
|
148
159
|
createDestination(destinationCreate, requestOptions) {
|
|
@@ -174,11 +185,10 @@ function createIngestionClient({
|
|
|
174
185
|
* Creates a new source.
|
|
175
186
|
*
|
|
176
187
|
* Required API Key ACLs:
|
|
177
|
-
*
|
|
178
|
-
*
|
|
179
|
-
*
|
|
180
|
-
*
|
|
181
|
-
* @param sourceCreate -.
|
|
188
|
+
* - addObject
|
|
189
|
+
* - deleteIndex
|
|
190
|
+
* - editSettings
|
|
191
|
+
* @param sourceCreate -
|
|
182
192
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
183
193
|
*/
|
|
184
194
|
createSource(sourceCreate, requestOptions) {
|
|
@@ -205,7 +215,6 @@ function createIngestionClient({
|
|
|
205
215
|
},
|
|
206
216
|
/**
|
|
207
217
|
* Creates a new task.
|
|
208
|
-
*
|
|
209
218
|
* @param taskCreate - Request body for creating a task.
|
|
210
219
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
211
220
|
*/
|
|
@@ -236,7 +245,6 @@ function createIngestionClient({
|
|
|
236
245
|
},
|
|
237
246
|
/**
|
|
238
247
|
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
239
|
-
*
|
|
240
248
|
* @param taskCreate - Request body for creating a task.
|
|
241
249
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
242
250
|
*/
|
|
@@ -270,7 +278,6 @@ function createIngestionClient({
|
|
|
270
278
|
},
|
|
271
279
|
/**
|
|
272
280
|
* Creates a new transformation.
|
|
273
|
-
*
|
|
274
281
|
* @param transformationCreate - Request body for creating a transformation.
|
|
275
282
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
276
283
|
*/
|
|
@@ -298,7 +305,6 @@ function createIngestionClient({
|
|
|
298
305
|
},
|
|
299
306
|
/**
|
|
300
307
|
* This method allow you to send requests to the Algolia REST API.
|
|
301
|
-
*
|
|
302
308
|
* @param customDelete - The customDelete object.
|
|
303
309
|
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
304
310
|
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
@@ -321,7 +327,6 @@ function createIngestionClient({
|
|
|
321
327
|
},
|
|
322
328
|
/**
|
|
323
329
|
* This method allow you to send requests to the Algolia REST API.
|
|
324
|
-
*
|
|
325
330
|
* @param customGet - The customGet object.
|
|
326
331
|
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
327
332
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -344,7 +349,6 @@ function createIngestionClient({
|
|
|
344
349
|
},
|
|
345
350
|
/**
|
|
346
351
|
* This method allow you to send requests to the Algolia REST API.
|
|
347
|
-
*
|
|
348
352
|
* @param customPost - The customPost object.
|
|
349
353
|
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
350
354
|
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
@@ -369,7 +373,6 @@ function createIngestionClient({
|
|
|
369
373
|
},
|
|
370
374
|
/**
|
|
371
375
|
* This method allow you to send requests to the Algolia REST API.
|
|
372
|
-
*
|
|
373
376
|
* @param customPut - The customPut object.
|
|
374
377
|
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
375
378
|
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
@@ -396,10 +399,9 @@ function createIngestionClient({
|
|
|
396
399
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
397
400
|
*
|
|
398
401
|
* Required API Key ACLs:
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
*
|
|
402
|
-
*
|
|
402
|
+
* - addObject
|
|
403
|
+
* - deleteIndex
|
|
404
|
+
* - editSettings
|
|
403
405
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
404
406
|
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
405
407
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -426,10 +428,9 @@ function createIngestionClient({
|
|
|
426
428
|
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
427
429
|
*
|
|
428
430
|
* Required API Key ACLs:
|
|
429
|
-
*
|
|
430
|
-
*
|
|
431
|
-
*
|
|
432
|
-
*
|
|
431
|
+
* - addObject
|
|
432
|
+
* - deleteIndex
|
|
433
|
+
* - editSettings
|
|
433
434
|
* @param deleteDestination - The deleteDestination object.
|
|
434
435
|
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
435
436
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -456,10 +457,9 @@ function createIngestionClient({
|
|
|
456
457
|
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
457
458
|
*
|
|
458
459
|
* Required API Key ACLs:
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
*
|
|
460
|
+
* - addObject
|
|
461
|
+
* - deleteIndex
|
|
462
|
+
* - editSettings
|
|
463
463
|
* @param deleteSource - The deleteSource object.
|
|
464
464
|
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
465
465
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -481,7 +481,6 @@ function createIngestionClient({
|
|
|
481
481
|
},
|
|
482
482
|
/**
|
|
483
483
|
* Deletes a task by its ID.
|
|
484
|
-
*
|
|
485
484
|
* @param deleteTask - The deleteTask object.
|
|
486
485
|
* @param deleteTask.taskID - Unique identifier of a task.
|
|
487
486
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -503,7 +502,6 @@ function createIngestionClient({
|
|
|
503
502
|
},
|
|
504
503
|
/**
|
|
505
504
|
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
506
|
-
*
|
|
507
505
|
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
508
506
|
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
509
507
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -525,7 +523,6 @@ function createIngestionClient({
|
|
|
525
523
|
},
|
|
526
524
|
/**
|
|
527
525
|
* Deletes a transformation by its ID.
|
|
528
|
-
*
|
|
529
526
|
* @param deleteTransformation - The deleteTransformation object.
|
|
530
527
|
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
531
528
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -552,10 +549,9 @@ function createIngestionClient({
|
|
|
552
549
|
* Disables a task.
|
|
553
550
|
*
|
|
554
551
|
* Required API Key ACLs:
|
|
555
|
-
*
|
|
556
|
-
*
|
|
557
|
-
*
|
|
558
|
-
*
|
|
552
|
+
* - addObject
|
|
553
|
+
* - deleteIndex
|
|
554
|
+
* - editSettings
|
|
559
555
|
* @param disableTask - The disableTask object.
|
|
560
556
|
* @param disableTask.taskID - Unique identifier of a task.
|
|
561
557
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -579,10 +575,9 @@ function createIngestionClient({
|
|
|
579
575
|
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
580
576
|
*
|
|
581
577
|
* Required API Key ACLs:
|
|
582
|
-
*
|
|
583
|
-
*
|
|
584
|
-
*
|
|
585
|
-
*
|
|
578
|
+
* - addObject
|
|
579
|
+
* - deleteIndex
|
|
580
|
+
* - editSettings
|
|
586
581
|
* @param disableTaskV1 - The disableTaskV1 object.
|
|
587
582
|
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
588
583
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -606,10 +601,9 @@ function createIngestionClient({
|
|
|
606
601
|
* Enables a task.
|
|
607
602
|
*
|
|
608
603
|
* Required API Key ACLs:
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
*
|
|
604
|
+
* - addObject
|
|
605
|
+
* - deleteIndex
|
|
606
|
+
* - editSettings
|
|
613
607
|
* @param enableTask - The enableTask object.
|
|
614
608
|
* @param enableTask.taskID - Unique identifier of a task.
|
|
615
609
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -633,10 +627,9 @@ function createIngestionClient({
|
|
|
633
627
|
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
634
628
|
*
|
|
635
629
|
* Required API Key ACLs:
|
|
636
|
-
*
|
|
637
|
-
*
|
|
638
|
-
*
|
|
639
|
-
*
|
|
630
|
+
* - addObject
|
|
631
|
+
* - deleteIndex
|
|
632
|
+
* - editSettings
|
|
640
633
|
* @param enableTaskV1 - The enableTaskV1 object.
|
|
641
634
|
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
642
635
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -656,53 +649,13 @@ function createIngestionClient({
|
|
|
656
649
|
};
|
|
657
650
|
return transporter.request(request, requestOptions);
|
|
658
651
|
},
|
|
659
|
-
/**
|
|
660
|
-
* Generates code for the selected model based on the given prompt.
|
|
661
|
-
*
|
|
662
|
-
* Required API Key ACLs:
|
|
663
|
-
* - addObject
|
|
664
|
-
* - deleteIndex
|
|
665
|
-
* - editSettings.
|
|
666
|
-
*
|
|
667
|
-
* @param generateTransformationCodePayload - The generateTransformationCodePayload object.
|
|
668
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
669
|
-
*/
|
|
670
|
-
generateTransformationCode(generateTransformationCodePayload, requestOptions) {
|
|
671
|
-
if (!generateTransformationCodePayload) {
|
|
672
|
-
throw new Error(
|
|
673
|
-
"Parameter `generateTransformationCodePayload` is required when calling `generateTransformationCode`."
|
|
674
|
-
);
|
|
675
|
-
}
|
|
676
|
-
if (!generateTransformationCodePayload.id) {
|
|
677
|
-
throw new Error(
|
|
678
|
-
"Parameter `generateTransformationCodePayload.id` is required when calling `generateTransformationCode`."
|
|
679
|
-
);
|
|
680
|
-
}
|
|
681
|
-
if (!generateTransformationCodePayload.userPrompt) {
|
|
682
|
-
throw new Error(
|
|
683
|
-
"Parameter `generateTransformationCodePayload.userPrompt` is required when calling `generateTransformationCode`."
|
|
684
|
-
);
|
|
685
|
-
}
|
|
686
|
-
const requestPath = "/1/transformations/models";
|
|
687
|
-
const headers = {};
|
|
688
|
-
const queryParameters = {};
|
|
689
|
-
const request = {
|
|
690
|
-
method: "POST",
|
|
691
|
-
path: requestPath,
|
|
692
|
-
queryParameters,
|
|
693
|
-
headers,
|
|
694
|
-
data: generateTransformationCodePayload
|
|
695
|
-
};
|
|
696
|
-
return transporter.request(request, requestOptions);
|
|
697
|
-
},
|
|
698
652
|
/**
|
|
699
653
|
* Retrieves an authentication resource by its ID.
|
|
700
654
|
*
|
|
701
655
|
* Required API Key ACLs:
|
|
702
|
-
*
|
|
703
|
-
*
|
|
704
|
-
*
|
|
705
|
-
*
|
|
656
|
+
* - addObject
|
|
657
|
+
* - deleteIndex
|
|
658
|
+
* - editSettings
|
|
706
659
|
* @param getAuthentication - The getAuthentication object.
|
|
707
660
|
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
708
661
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -729,10 +682,9 @@ function createIngestionClient({
|
|
|
729
682
|
* Retrieves a destination by its ID.
|
|
730
683
|
*
|
|
731
684
|
* Required API Key ACLs:
|
|
732
|
-
*
|
|
733
|
-
*
|
|
734
|
-
*
|
|
735
|
-
*
|
|
685
|
+
* - addObject
|
|
686
|
+
* - deleteIndex
|
|
687
|
+
* - editSettings
|
|
736
688
|
* @param getDestination - The getDestination object.
|
|
737
689
|
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
738
690
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -759,10 +711,9 @@ function createIngestionClient({
|
|
|
759
711
|
* Retrieves a single task run event by its ID.
|
|
760
712
|
*
|
|
761
713
|
* Required API Key ACLs:
|
|
762
|
-
*
|
|
763
|
-
*
|
|
764
|
-
*
|
|
765
|
-
*
|
|
714
|
+
* - addObject
|
|
715
|
+
* - deleteIndex
|
|
716
|
+
* - editSettings
|
|
766
717
|
* @param getEvent - The getEvent object.
|
|
767
718
|
* @param getEvent.runID - Unique identifier of a task run.
|
|
768
719
|
* @param getEvent.eventID - Unique identifier of an event.
|
|
@@ -790,10 +741,9 @@ function createIngestionClient({
|
|
|
790
741
|
* Retrieve a single task run by its ID.
|
|
791
742
|
*
|
|
792
743
|
* Required API Key ACLs:
|
|
793
|
-
*
|
|
794
|
-
*
|
|
795
|
-
*
|
|
796
|
-
*
|
|
744
|
+
* - addObject
|
|
745
|
+
* - deleteIndex
|
|
746
|
+
* - editSettings
|
|
797
747
|
* @param getRun - The getRun object.
|
|
798
748
|
* @param getRun.runID - Unique identifier of a task run.
|
|
799
749
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -817,10 +767,9 @@ function createIngestionClient({
|
|
|
817
767
|
* Retrieve a source by its ID.
|
|
818
768
|
*
|
|
819
769
|
* Required API Key ACLs:
|
|
820
|
-
*
|
|
821
|
-
*
|
|
822
|
-
*
|
|
823
|
-
*
|
|
770
|
+
* - addObject
|
|
771
|
+
* - deleteIndex
|
|
772
|
+
* - editSettings
|
|
824
773
|
* @param getSource - The getSource object.
|
|
825
774
|
* @param getSource.sourceID - Unique identifier of a source.
|
|
826
775
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -844,10 +793,9 @@ function createIngestionClient({
|
|
|
844
793
|
* Retrieves a task by its ID.
|
|
845
794
|
*
|
|
846
795
|
* Required API Key ACLs:
|
|
847
|
-
*
|
|
848
|
-
*
|
|
849
|
-
*
|
|
850
|
-
*
|
|
796
|
+
* - addObject
|
|
797
|
+
* - deleteIndex
|
|
798
|
+
* - editSettings
|
|
851
799
|
* @param getTask - The getTask object.
|
|
852
800
|
* @param getTask.taskID - Unique identifier of a task.
|
|
853
801
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -871,10 +819,9 @@ function createIngestionClient({
|
|
|
871
819
|
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
872
820
|
*
|
|
873
821
|
* Required API Key ACLs:
|
|
874
|
-
*
|
|
875
|
-
*
|
|
876
|
-
*
|
|
877
|
-
*
|
|
822
|
+
* - addObject
|
|
823
|
+
* - deleteIndex
|
|
824
|
+
* - editSettings
|
|
878
825
|
* @param getTaskV1 - The getTaskV1 object.
|
|
879
826
|
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
880
827
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -898,10 +845,9 @@ function createIngestionClient({
|
|
|
898
845
|
* Retrieves a transformation by its ID.
|
|
899
846
|
*
|
|
900
847
|
* Required API Key ACLs:
|
|
901
|
-
*
|
|
902
|
-
*
|
|
903
|
-
*
|
|
904
|
-
*
|
|
848
|
+
* - addObject
|
|
849
|
+
* - deleteIndex
|
|
850
|
+
* - editSettings
|
|
905
851
|
* @param getTransformation - The getTransformation object.
|
|
906
852
|
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
907
853
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -928,16 +874,15 @@ function createIngestionClient({
|
|
|
928
874
|
* Retrieves a list of all authentication resources.
|
|
929
875
|
*
|
|
930
876
|
* Required API Key ACLs:
|
|
931
|
-
*
|
|
932
|
-
*
|
|
933
|
-
*
|
|
934
|
-
*
|
|
877
|
+
* - addObject
|
|
878
|
+
* - deleteIndex
|
|
879
|
+
* - editSettings
|
|
935
880
|
* @param listAuthentications - The listAuthentications object.
|
|
936
881
|
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
937
882
|
* @param listAuthentications.page - Page number of the paginated API response.
|
|
938
883
|
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
939
|
-
* @param listAuthentications.platform - Ecommerce platform for which to retrieve
|
|
940
|
-
* @param listAuthentications.sort - Property by which to sort the list of
|
|
884
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
885
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
941
886
|
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
942
887
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
943
888
|
*/
|
|
@@ -946,22 +891,22 @@ function createIngestionClient({
|
|
|
946
891
|
const headers = {};
|
|
947
892
|
const queryParameters = {};
|
|
948
893
|
if (itemsPerPage !== void 0) {
|
|
949
|
-
queryParameters
|
|
894
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
950
895
|
}
|
|
951
896
|
if (page !== void 0) {
|
|
952
|
-
queryParameters
|
|
897
|
+
queryParameters["page"] = page.toString();
|
|
953
898
|
}
|
|
954
899
|
if (type !== void 0) {
|
|
955
|
-
queryParameters
|
|
900
|
+
queryParameters["type"] = type.toString();
|
|
956
901
|
}
|
|
957
902
|
if (platform !== void 0) {
|
|
958
|
-
queryParameters
|
|
903
|
+
queryParameters["platform"] = platform.toString();
|
|
959
904
|
}
|
|
960
905
|
if (sort !== void 0) {
|
|
961
|
-
queryParameters
|
|
906
|
+
queryParameters["sort"] = sort.toString();
|
|
962
907
|
}
|
|
963
908
|
if (order !== void 0) {
|
|
964
|
-
queryParameters
|
|
909
|
+
queryParameters["order"] = order.toString();
|
|
965
910
|
}
|
|
966
911
|
const request = {
|
|
967
912
|
method: "GET",
|
|
@@ -975,40 +920,43 @@ function createIngestionClient({
|
|
|
975
920
|
* Retrieves a list of destinations.
|
|
976
921
|
*
|
|
977
922
|
* Required API Key ACLs:
|
|
978
|
-
*
|
|
979
|
-
*
|
|
980
|
-
*
|
|
981
|
-
*
|
|
923
|
+
* - addObject
|
|
924
|
+
* - deleteIndex
|
|
925
|
+
* - editSettings
|
|
982
926
|
* @param listDestinations - The listDestinations object.
|
|
983
927
|
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
984
928
|
* @param listDestinations.page - Page number of the paginated API response.
|
|
985
929
|
* @param listDestinations.type - Destination type.
|
|
986
930
|
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
931
|
+
* @param listDestinations.transformationID - Get the list of destinations used by a transformation.
|
|
987
932
|
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
988
933
|
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
989
934
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
990
935
|
*/
|
|
991
|
-
listDestinations({ itemsPerPage, page, type, authenticationID, sort, order } = {}, requestOptions = void 0) {
|
|
936
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
992
937
|
const requestPath = "/1/destinations";
|
|
993
938
|
const headers = {};
|
|
994
939
|
const queryParameters = {};
|
|
995
940
|
if (itemsPerPage !== void 0) {
|
|
996
|
-
queryParameters
|
|
941
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
997
942
|
}
|
|
998
943
|
if (page !== void 0) {
|
|
999
|
-
queryParameters
|
|
944
|
+
queryParameters["page"] = page.toString();
|
|
1000
945
|
}
|
|
1001
946
|
if (type !== void 0) {
|
|
1002
|
-
queryParameters
|
|
947
|
+
queryParameters["type"] = type.toString();
|
|
1003
948
|
}
|
|
1004
949
|
if (authenticationID !== void 0) {
|
|
1005
|
-
queryParameters
|
|
950
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
951
|
+
}
|
|
952
|
+
if (transformationID !== void 0) {
|
|
953
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
1006
954
|
}
|
|
1007
955
|
if (sort !== void 0) {
|
|
1008
|
-
queryParameters
|
|
956
|
+
queryParameters["sort"] = sort.toString();
|
|
1009
957
|
}
|
|
1010
958
|
if (order !== void 0) {
|
|
1011
|
-
queryParameters
|
|
959
|
+
queryParameters["order"] = order.toString();
|
|
1012
960
|
}
|
|
1013
961
|
const request = {
|
|
1014
962
|
method: "GET",
|
|
@@ -1019,13 +967,12 @@ function createIngestionClient({
|
|
|
1019
967
|
return transporter.request(request, requestOptions);
|
|
1020
968
|
},
|
|
1021
969
|
/**
|
|
1022
|
-
* Retrieves a list of events for a task run, identified by
|
|
970
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1023
971
|
*
|
|
1024
972
|
* Required API Key ACLs:
|
|
1025
|
-
*
|
|
1026
|
-
*
|
|
1027
|
-
*
|
|
1028
|
-
*
|
|
973
|
+
* - addObject
|
|
974
|
+
* - deleteIndex
|
|
975
|
+
* - editSettings
|
|
1029
976
|
* @param listEvents - The listEvents object.
|
|
1030
977
|
* @param listEvents.runID - Unique identifier of a task run.
|
|
1031
978
|
* @param listEvents.itemsPerPage - Number of items per page.
|
|
@@ -1046,28 +993,28 @@ function createIngestionClient({
|
|
|
1046
993
|
const headers = {};
|
|
1047
994
|
const queryParameters = {};
|
|
1048
995
|
if (itemsPerPage !== void 0) {
|
|
1049
|
-
queryParameters
|
|
996
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1050
997
|
}
|
|
1051
998
|
if (page !== void 0) {
|
|
1052
|
-
queryParameters
|
|
999
|
+
queryParameters["page"] = page.toString();
|
|
1053
1000
|
}
|
|
1054
1001
|
if (status !== void 0) {
|
|
1055
|
-
queryParameters
|
|
1002
|
+
queryParameters["status"] = status.toString();
|
|
1056
1003
|
}
|
|
1057
1004
|
if (type !== void 0) {
|
|
1058
|
-
queryParameters
|
|
1005
|
+
queryParameters["type"] = type.toString();
|
|
1059
1006
|
}
|
|
1060
1007
|
if (sort !== void 0) {
|
|
1061
|
-
queryParameters
|
|
1008
|
+
queryParameters["sort"] = sort.toString();
|
|
1062
1009
|
}
|
|
1063
1010
|
if (order !== void 0) {
|
|
1064
|
-
queryParameters
|
|
1011
|
+
queryParameters["order"] = order.toString();
|
|
1065
1012
|
}
|
|
1066
1013
|
if (startDate !== void 0) {
|
|
1067
|
-
queryParameters
|
|
1014
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1068
1015
|
}
|
|
1069
1016
|
if (endDate !== void 0) {
|
|
1070
|
-
queryParameters
|
|
1017
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1071
1018
|
}
|
|
1072
1019
|
const request = {
|
|
1073
1020
|
method: "GET",
|
|
@@ -1081,10 +1028,9 @@ function createIngestionClient({
|
|
|
1081
1028
|
* Retrieve a list of task runs.
|
|
1082
1029
|
*
|
|
1083
1030
|
* Required API Key ACLs:
|
|
1084
|
-
*
|
|
1085
|
-
*
|
|
1086
|
-
*
|
|
1087
|
-
*
|
|
1031
|
+
* - addObject
|
|
1032
|
+
* - deleteIndex
|
|
1033
|
+
* - editSettings
|
|
1088
1034
|
* @param listRuns - The listRuns object.
|
|
1089
1035
|
* @param listRuns.itemsPerPage - Number of items per page.
|
|
1090
1036
|
* @param listRuns.page - Page number of the paginated API response.
|
|
@@ -1102,31 +1048,31 @@ function createIngestionClient({
|
|
|
1102
1048
|
const headers = {};
|
|
1103
1049
|
const queryParameters = {};
|
|
1104
1050
|
if (itemsPerPage !== void 0) {
|
|
1105
|
-
queryParameters
|
|
1051
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1106
1052
|
}
|
|
1107
1053
|
if (page !== void 0) {
|
|
1108
|
-
queryParameters
|
|
1054
|
+
queryParameters["page"] = page.toString();
|
|
1109
1055
|
}
|
|
1110
1056
|
if (status !== void 0) {
|
|
1111
|
-
queryParameters
|
|
1057
|
+
queryParameters["status"] = status.toString();
|
|
1112
1058
|
}
|
|
1113
1059
|
if (type !== void 0) {
|
|
1114
|
-
queryParameters
|
|
1060
|
+
queryParameters["type"] = type.toString();
|
|
1115
1061
|
}
|
|
1116
1062
|
if (taskID !== void 0) {
|
|
1117
|
-
queryParameters
|
|
1063
|
+
queryParameters["taskID"] = taskID.toString();
|
|
1118
1064
|
}
|
|
1119
1065
|
if (sort !== void 0) {
|
|
1120
|
-
queryParameters
|
|
1066
|
+
queryParameters["sort"] = sort.toString();
|
|
1121
1067
|
}
|
|
1122
1068
|
if (order !== void 0) {
|
|
1123
|
-
queryParameters
|
|
1069
|
+
queryParameters["order"] = order.toString();
|
|
1124
1070
|
}
|
|
1125
1071
|
if (startDate !== void 0) {
|
|
1126
|
-
queryParameters
|
|
1072
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1127
1073
|
}
|
|
1128
1074
|
if (endDate !== void 0) {
|
|
1129
|
-
queryParameters
|
|
1075
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1130
1076
|
}
|
|
1131
1077
|
const request = {
|
|
1132
1078
|
method: "GET",
|
|
@@ -1140,15 +1086,14 @@ function createIngestionClient({
|
|
|
1140
1086
|
* Retrieves a list of sources.
|
|
1141
1087
|
*
|
|
1142
1088
|
* Required API Key ACLs:
|
|
1143
|
-
*
|
|
1144
|
-
*
|
|
1145
|
-
*
|
|
1146
|
-
*
|
|
1089
|
+
* - addObject
|
|
1090
|
+
* - deleteIndex
|
|
1091
|
+
* - editSettings
|
|
1147
1092
|
* @param listSources - The listSources object.
|
|
1148
1093
|
* @param listSources.itemsPerPage - Number of items per page.
|
|
1149
1094
|
* @param listSources.page - Page number of the paginated API response.
|
|
1150
1095
|
* @param listSources.type - Source type. Some sources require authentication.
|
|
1151
|
-
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication
|
|
1096
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
|
|
1152
1097
|
* @param listSources.sort - Property by which to sort the list of sources.
|
|
1153
1098
|
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
1154
1099
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1158,22 +1103,22 @@ function createIngestionClient({
|
|
|
1158
1103
|
const headers = {};
|
|
1159
1104
|
const queryParameters = {};
|
|
1160
1105
|
if (itemsPerPage !== void 0) {
|
|
1161
|
-
queryParameters
|
|
1106
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1162
1107
|
}
|
|
1163
1108
|
if (page !== void 0) {
|
|
1164
|
-
queryParameters
|
|
1109
|
+
queryParameters["page"] = page.toString();
|
|
1165
1110
|
}
|
|
1166
1111
|
if (type !== void 0) {
|
|
1167
|
-
queryParameters
|
|
1112
|
+
queryParameters["type"] = type.toString();
|
|
1168
1113
|
}
|
|
1169
1114
|
if (authenticationID !== void 0) {
|
|
1170
|
-
queryParameters
|
|
1115
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1171
1116
|
}
|
|
1172
1117
|
if (sort !== void 0) {
|
|
1173
|
-
queryParameters
|
|
1118
|
+
queryParameters["sort"] = sort.toString();
|
|
1174
1119
|
}
|
|
1175
1120
|
if (order !== void 0) {
|
|
1176
|
-
queryParameters
|
|
1121
|
+
queryParameters["order"] = order.toString();
|
|
1177
1122
|
}
|
|
1178
1123
|
const request = {
|
|
1179
1124
|
method: "GET",
|
|
@@ -1187,10 +1132,9 @@ function createIngestionClient({
|
|
|
1187
1132
|
* Retrieves a list of tasks.
|
|
1188
1133
|
*
|
|
1189
1134
|
* Required API Key ACLs:
|
|
1190
|
-
*
|
|
1191
|
-
*
|
|
1192
|
-
*
|
|
1193
|
-
*
|
|
1135
|
+
* - addObject
|
|
1136
|
+
* - deleteIndex
|
|
1137
|
+
* - editSettings
|
|
1194
1138
|
* @param listTasks - The listTasks object.
|
|
1195
1139
|
* @param listTasks.itemsPerPage - Number of items per page.
|
|
1196
1140
|
* @param listTasks.page - Page number of the paginated API response.
|
|
@@ -1208,31 +1152,31 @@ function createIngestionClient({
|
|
|
1208
1152
|
const headers = {};
|
|
1209
1153
|
const queryParameters = {};
|
|
1210
1154
|
if (itemsPerPage !== void 0) {
|
|
1211
|
-
queryParameters
|
|
1155
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1212
1156
|
}
|
|
1213
1157
|
if (page !== void 0) {
|
|
1214
|
-
queryParameters
|
|
1158
|
+
queryParameters["page"] = page.toString();
|
|
1215
1159
|
}
|
|
1216
1160
|
if (action !== void 0) {
|
|
1217
|
-
queryParameters
|
|
1161
|
+
queryParameters["action"] = action.toString();
|
|
1218
1162
|
}
|
|
1219
1163
|
if (enabled !== void 0) {
|
|
1220
|
-
queryParameters
|
|
1164
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1221
1165
|
}
|
|
1222
1166
|
if (sourceID !== void 0) {
|
|
1223
|
-
queryParameters
|
|
1167
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1224
1168
|
}
|
|
1225
1169
|
if (destinationID !== void 0) {
|
|
1226
|
-
queryParameters
|
|
1170
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1227
1171
|
}
|
|
1228
1172
|
if (triggerType !== void 0) {
|
|
1229
|
-
queryParameters
|
|
1173
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1230
1174
|
}
|
|
1231
1175
|
if (sort !== void 0) {
|
|
1232
|
-
queryParameters
|
|
1176
|
+
queryParameters["sort"] = sort.toString();
|
|
1233
1177
|
}
|
|
1234
1178
|
if (order !== void 0) {
|
|
1235
|
-
queryParameters
|
|
1179
|
+
queryParameters["order"] = order.toString();
|
|
1236
1180
|
}
|
|
1237
1181
|
const request = {
|
|
1238
1182
|
method: "GET",
|
|
@@ -1246,10 +1190,9 @@ function createIngestionClient({
|
|
|
1246
1190
|
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
1247
1191
|
*
|
|
1248
1192
|
* Required API Key ACLs:
|
|
1249
|
-
*
|
|
1250
|
-
*
|
|
1251
|
-
*
|
|
1252
|
-
*
|
|
1193
|
+
* - addObject
|
|
1194
|
+
* - deleteIndex
|
|
1195
|
+
* - editSettings
|
|
1253
1196
|
* @param listTasksV1 - The listTasksV1 object.
|
|
1254
1197
|
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
1255
1198
|
* @param listTasksV1.page - Page number of the paginated API response.
|
|
@@ -1267,31 +1210,31 @@ function createIngestionClient({
|
|
|
1267
1210
|
const headers = {};
|
|
1268
1211
|
const queryParameters = {};
|
|
1269
1212
|
if (itemsPerPage !== void 0) {
|
|
1270
|
-
queryParameters
|
|
1213
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1271
1214
|
}
|
|
1272
1215
|
if (page !== void 0) {
|
|
1273
|
-
queryParameters
|
|
1216
|
+
queryParameters["page"] = page.toString();
|
|
1274
1217
|
}
|
|
1275
1218
|
if (action !== void 0) {
|
|
1276
|
-
queryParameters
|
|
1219
|
+
queryParameters["action"] = action.toString();
|
|
1277
1220
|
}
|
|
1278
1221
|
if (enabled !== void 0) {
|
|
1279
|
-
queryParameters
|
|
1222
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1280
1223
|
}
|
|
1281
1224
|
if (sourceID !== void 0) {
|
|
1282
|
-
queryParameters
|
|
1225
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1283
1226
|
}
|
|
1284
1227
|
if (destinationID !== void 0) {
|
|
1285
|
-
queryParameters
|
|
1228
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1286
1229
|
}
|
|
1287
1230
|
if (triggerType !== void 0) {
|
|
1288
|
-
queryParameters
|
|
1231
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1289
1232
|
}
|
|
1290
1233
|
if (sort !== void 0) {
|
|
1291
|
-
queryParameters
|
|
1234
|
+
queryParameters["sort"] = sort.toString();
|
|
1292
1235
|
}
|
|
1293
1236
|
if (order !== void 0) {
|
|
1294
|
-
queryParameters
|
|
1237
|
+
queryParameters["order"] = order.toString();
|
|
1295
1238
|
}
|
|
1296
1239
|
const request = {
|
|
1297
1240
|
method: "GET",
|
|
@@ -1301,40 +1244,17 @@ function createIngestionClient({
|
|
|
1301
1244
|
};
|
|
1302
1245
|
return transporter.request(request, requestOptions);
|
|
1303
1246
|
},
|
|
1304
|
-
/**
|
|
1305
|
-
* Retrieves a list of existing LLM transformation helpers.
|
|
1306
|
-
*
|
|
1307
|
-
* Required API Key ACLs:
|
|
1308
|
-
* - addObject
|
|
1309
|
-
* - deleteIndex
|
|
1310
|
-
* - editSettings.
|
|
1311
|
-
*
|
|
1312
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1313
|
-
*/
|
|
1314
|
-
listTransformationModels(requestOptions) {
|
|
1315
|
-
const requestPath = "/1/transformations/models";
|
|
1316
|
-
const headers = {};
|
|
1317
|
-
const queryParameters = {};
|
|
1318
|
-
const request = {
|
|
1319
|
-
method: "GET",
|
|
1320
|
-
path: requestPath,
|
|
1321
|
-
queryParameters,
|
|
1322
|
-
headers
|
|
1323
|
-
};
|
|
1324
|
-
return transporter.request(request, requestOptions);
|
|
1325
|
-
},
|
|
1326
1247
|
/**
|
|
1327
1248
|
* Retrieves a list of transformations.
|
|
1328
1249
|
*
|
|
1329
1250
|
* Required API Key ACLs:
|
|
1330
|
-
*
|
|
1331
|
-
*
|
|
1332
|
-
*
|
|
1333
|
-
*
|
|
1251
|
+
* - addObject
|
|
1252
|
+
* - deleteIndex
|
|
1253
|
+
* - editSettings
|
|
1334
1254
|
* @param listTransformations - The listTransformations object.
|
|
1335
1255
|
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
1336
1256
|
* @param listTransformations.page - Page number of the paginated API response.
|
|
1337
|
-
* @param listTransformations.sort - Property by which to sort the list.
|
|
1257
|
+
* @param listTransformations.sort - Property by which to sort the list of transformations.
|
|
1338
1258
|
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
1339
1259
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1340
1260
|
*/
|
|
@@ -1343,16 +1263,16 @@ function createIngestionClient({
|
|
|
1343
1263
|
const headers = {};
|
|
1344
1264
|
const queryParameters = {};
|
|
1345
1265
|
if (itemsPerPage !== void 0) {
|
|
1346
|
-
queryParameters
|
|
1266
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1347
1267
|
}
|
|
1348
1268
|
if (page !== void 0) {
|
|
1349
|
-
queryParameters
|
|
1269
|
+
queryParameters["page"] = page.toString();
|
|
1350
1270
|
}
|
|
1351
1271
|
if (sort !== void 0) {
|
|
1352
|
-
queryParameters
|
|
1272
|
+
queryParameters["sort"] = sort.toString();
|
|
1353
1273
|
}
|
|
1354
1274
|
if (order !== void 0) {
|
|
1355
|
-
queryParameters
|
|
1275
|
+
queryParameters["order"] = order.toString();
|
|
1356
1276
|
}
|
|
1357
1277
|
const request = {
|
|
1358
1278
|
method: "GET",
|
|
@@ -1366,10 +1286,9 @@ function createIngestionClient({
|
|
|
1366
1286
|
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
1367
1287
|
*
|
|
1368
1288
|
* Required API Key ACLs:
|
|
1369
|
-
*
|
|
1370
|
-
*
|
|
1371
|
-
*
|
|
1372
|
-
*
|
|
1289
|
+
* - addObject
|
|
1290
|
+
* - deleteIndex
|
|
1291
|
+
* - editSettings
|
|
1373
1292
|
* @param pushTask - The pushTask object.
|
|
1374
1293
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1375
1294
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
@@ -1404,13 +1323,12 @@ function createIngestionClient({
|
|
|
1404
1323
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
1405
1324
|
*
|
|
1406
1325
|
* Required API Key ACLs:
|
|
1407
|
-
*
|
|
1408
|
-
*
|
|
1409
|
-
*
|
|
1410
|
-
*
|
|
1326
|
+
* - addObject
|
|
1327
|
+
* - deleteIndex
|
|
1328
|
+
* - editSettings
|
|
1411
1329
|
* @param runSource - The runSource object.
|
|
1412
1330
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1413
|
-
* @param runSource.runSourcePayload
|
|
1331
|
+
* @param runSource.runSourcePayload -
|
|
1414
1332
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1415
1333
|
*/
|
|
1416
1334
|
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
@@ -1433,10 +1351,9 @@ function createIngestionClient({
|
|
|
1433
1351
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
1434
1352
|
*
|
|
1435
1353
|
* Required API Key ACLs:
|
|
1436
|
-
*
|
|
1437
|
-
*
|
|
1438
|
-
*
|
|
1439
|
-
*
|
|
1354
|
+
* - addObject
|
|
1355
|
+
* - deleteIndex
|
|
1356
|
+
* - editSettings
|
|
1440
1357
|
* @param runTask - The runTask object.
|
|
1441
1358
|
* @param runTask.taskID - Unique identifier of a task.
|
|
1442
1359
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1460,10 +1377,9 @@ function createIngestionClient({
|
|
|
1460
1377
|
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1461
1378
|
*
|
|
1462
1379
|
* Required API Key ACLs:
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1465
|
-
*
|
|
1466
|
-
*
|
|
1380
|
+
* - addObject
|
|
1381
|
+
* - deleteIndex
|
|
1382
|
+
* - editSettings
|
|
1467
1383
|
* @param runTaskV1 - The runTaskV1 object.
|
|
1468
1384
|
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
1469
1385
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1487,10 +1403,9 @@ function createIngestionClient({
|
|
|
1487
1403
|
* Searches for authentication resources.
|
|
1488
1404
|
*
|
|
1489
1405
|
* Required API Key ACLs:
|
|
1490
|
-
*
|
|
1491
|
-
*
|
|
1492
|
-
*
|
|
1493
|
-
*
|
|
1406
|
+
* - addObject
|
|
1407
|
+
* - deleteIndex
|
|
1408
|
+
* - editSettings
|
|
1494
1409
|
* @param authenticationSearch - The authenticationSearch object.
|
|
1495
1410
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1496
1411
|
*/
|
|
@@ -1519,10 +1434,9 @@ function createIngestionClient({
|
|
|
1519
1434
|
* Searches for destinations.
|
|
1520
1435
|
*
|
|
1521
1436
|
* Required API Key ACLs:
|
|
1522
|
-
*
|
|
1523
|
-
*
|
|
1524
|
-
*
|
|
1525
|
-
*
|
|
1437
|
+
* - addObject
|
|
1438
|
+
* - deleteIndex
|
|
1439
|
+
* - editSettings
|
|
1526
1440
|
* @param destinationSearch - The destinationSearch object.
|
|
1527
1441
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1528
1442
|
*/
|
|
@@ -1549,10 +1463,9 @@ function createIngestionClient({
|
|
|
1549
1463
|
* Searches for sources.
|
|
1550
1464
|
*
|
|
1551
1465
|
* Required API Key ACLs:
|
|
1552
|
-
*
|
|
1553
|
-
*
|
|
1554
|
-
*
|
|
1555
|
-
*
|
|
1466
|
+
* - addObject
|
|
1467
|
+
* - deleteIndex
|
|
1468
|
+
* - editSettings
|
|
1556
1469
|
* @param sourceSearch - The sourceSearch object.
|
|
1557
1470
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1558
1471
|
*/
|
|
@@ -1579,10 +1492,9 @@ function createIngestionClient({
|
|
|
1579
1492
|
* Searches for tasks.
|
|
1580
1493
|
*
|
|
1581
1494
|
* Required API Key ACLs:
|
|
1582
|
-
*
|
|
1583
|
-
*
|
|
1584
|
-
*
|
|
1585
|
-
*
|
|
1495
|
+
* - addObject
|
|
1496
|
+
* - deleteIndex
|
|
1497
|
+
* - editSettings
|
|
1586
1498
|
* @param taskSearch - The taskSearch object.
|
|
1587
1499
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1588
1500
|
*/
|
|
@@ -1609,10 +1521,9 @@ function createIngestionClient({
|
|
|
1609
1521
|
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
1610
1522
|
*
|
|
1611
1523
|
* Required API Key ACLs:
|
|
1612
|
-
*
|
|
1613
|
-
*
|
|
1614
|
-
*
|
|
1615
|
-
*
|
|
1524
|
+
* - addObject
|
|
1525
|
+
* - deleteIndex
|
|
1526
|
+
* - editSettings
|
|
1616
1527
|
* @param taskSearch - The taskSearch object.
|
|
1617
1528
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1618
1529
|
*/
|
|
@@ -1639,10 +1550,9 @@ function createIngestionClient({
|
|
|
1639
1550
|
* Searches for transformations.
|
|
1640
1551
|
*
|
|
1641
1552
|
* Required API Key ACLs:
|
|
1642
|
-
*
|
|
1643
|
-
*
|
|
1644
|
-
*
|
|
1645
|
-
*
|
|
1553
|
+
* - addObject
|
|
1554
|
+
* - deleteIndex
|
|
1555
|
+
* - editSettings
|
|
1646
1556
|
* @param transformationSearch - The transformationSearch object.
|
|
1647
1557
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1648
1558
|
*/
|
|
@@ -1671,10 +1581,9 @@ function createIngestionClient({
|
|
|
1671
1581
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1672
1582
|
*
|
|
1673
1583
|
* Required API Key ACLs:
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1676
|
-
*
|
|
1677
|
-
*
|
|
1584
|
+
* - addObject
|
|
1585
|
+
* - deleteIndex
|
|
1586
|
+
* - editSettings
|
|
1678
1587
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1679
1588
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1680
1589
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1698,10 +1607,9 @@ function createIngestionClient({
|
|
|
1698
1607
|
* Try a transformation before creating it.
|
|
1699
1608
|
*
|
|
1700
1609
|
* Required API Key ACLs:
|
|
1701
|
-
*
|
|
1702
|
-
*
|
|
1703
|
-
*
|
|
1704
|
-
*
|
|
1610
|
+
* - addObject
|
|
1611
|
+
* - deleteIndex
|
|
1612
|
+
* - editSettings
|
|
1705
1613
|
* @param transformationTry - The transformationTry object.
|
|
1706
1614
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1707
1615
|
*/
|
|
@@ -1731,10 +1639,9 @@ function createIngestionClient({
|
|
|
1731
1639
|
* Try a transformation before updating it.
|
|
1732
1640
|
*
|
|
1733
1641
|
* Required API Key ACLs:
|
|
1734
|
-
*
|
|
1735
|
-
*
|
|
1736
|
-
*
|
|
1737
|
-
*
|
|
1642
|
+
* - addObject
|
|
1643
|
+
* - deleteIndex
|
|
1644
|
+
* - editSettings
|
|
1738
1645
|
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
1739
1646
|
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
1740
1647
|
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
@@ -1774,10 +1681,9 @@ function createIngestionClient({
|
|
|
1774
1681
|
* Updates an authentication resource.
|
|
1775
1682
|
*
|
|
1776
1683
|
* Required API Key ACLs:
|
|
1777
|
-
*
|
|
1778
|
-
*
|
|
1779
|
-
*
|
|
1780
|
-
*
|
|
1684
|
+
* - addObject
|
|
1685
|
+
* - deleteIndex
|
|
1686
|
+
* - editSettings
|
|
1781
1687
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1782
1688
|
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1783
1689
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
@@ -1809,10 +1715,9 @@ function createIngestionClient({
|
|
|
1809
1715
|
* Updates the destination by its ID.
|
|
1810
1716
|
*
|
|
1811
1717
|
* Required API Key ACLs:
|
|
1812
|
-
*
|
|
1813
|
-
*
|
|
1814
|
-
*
|
|
1815
|
-
*
|
|
1718
|
+
* - addObject
|
|
1719
|
+
* - deleteIndex
|
|
1720
|
+
* - editSettings
|
|
1816
1721
|
* @param updateDestination - The updateDestination object.
|
|
1817
1722
|
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1818
1723
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
@@ -1844,10 +1749,9 @@ function createIngestionClient({
|
|
|
1844
1749
|
* Updates a source by its ID.
|
|
1845
1750
|
*
|
|
1846
1751
|
* Required API Key ACLs:
|
|
1847
|
-
*
|
|
1848
|
-
*
|
|
1849
|
-
*
|
|
1850
|
-
*
|
|
1752
|
+
* - addObject
|
|
1753
|
+
* - deleteIndex
|
|
1754
|
+
* - editSettings
|
|
1851
1755
|
* @param updateSource - The updateSource object.
|
|
1852
1756
|
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1853
1757
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
@@ -1874,7 +1778,6 @@ function createIngestionClient({
|
|
|
1874
1778
|
},
|
|
1875
1779
|
/**
|
|
1876
1780
|
* Updates a task by its ID.
|
|
1877
|
-
*
|
|
1878
1781
|
* @param updateTask - The updateTask object.
|
|
1879
1782
|
* @param updateTask.taskID - Unique identifier of a task.
|
|
1880
1783
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
@@ -1901,7 +1804,6 @@ function createIngestionClient({
|
|
|
1901
1804
|
},
|
|
1902
1805
|
/**
|
|
1903
1806
|
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
1904
|
-
*
|
|
1905
1807
|
* @param updateTaskV1 - The updateTaskV1 object.
|
|
1906
1808
|
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
1907
1809
|
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
@@ -1928,7 +1830,6 @@ function createIngestionClient({
|
|
|
1928
1830
|
},
|
|
1929
1831
|
/**
|
|
1930
1832
|
* Updates a transformation by its ID.
|
|
1931
|
-
*
|
|
1932
1833
|
* @param updateTransformation - The updateTransformation object.
|
|
1933
1834
|
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1934
1835
|
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
@@ -1966,11 +1867,10 @@ function createIngestionClient({
|
|
|
1966
1867
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1967
1868
|
*
|
|
1968
1869
|
* Required API Key ACLs:
|
|
1969
|
-
*
|
|
1970
|
-
*
|
|
1971
|
-
*
|
|
1972
|
-
*
|
|
1973
|
-
* @param sourceCreate -.
|
|
1870
|
+
* - addObject
|
|
1871
|
+
* - deleteIndex
|
|
1872
|
+
* - editSettings
|
|
1873
|
+
* @param sourceCreate -
|
|
1974
1874
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1975
1875
|
*/
|
|
1976
1876
|
validateSource(sourceCreate, requestOptions = void 0) {
|
|
@@ -1990,10 +1890,9 @@ function createIngestionClient({
|
|
|
1990
1890
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1991
1891
|
*
|
|
1992
1892
|
* Required API Key ACLs:
|
|
1993
|
-
*
|
|
1994
|
-
*
|
|
1995
|
-
*
|
|
1996
|
-
*
|
|
1893
|
+
* - addObject
|
|
1894
|
+
* - deleteIndex
|
|
1895
|
+
* - editSettings
|
|
1997
1896
|
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
1998
1897
|
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
1999
1898
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|