@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
package/dist/builds/node.cjs
CHANGED
|
@@ -27,12 +27,12 @@ __export(node_exports, {
|
|
|
27
27
|
isSubscriptionTrigger: () => isSubscriptionTrigger
|
|
28
28
|
});
|
|
29
29
|
module.exports = __toCommonJS(node_exports);
|
|
30
|
-
var import_client_common2 = require("@algolia/client-common");
|
|
31
30
|
var import_requester_node_http = require("@algolia/requester-node-http");
|
|
31
|
+
var import_client_common2 = require("@algolia/client-common");
|
|
32
32
|
|
|
33
33
|
// src/ingestionClient.ts
|
|
34
34
|
var import_client_common = require("@algolia/client-common");
|
|
35
|
-
var apiClientVersion = "1.
|
|
35
|
+
var apiClientVersion = "1.10.0";
|
|
36
36
|
var REGIONS = ["eu", "us"];
|
|
37
37
|
function getDefaultHosts(region) {
|
|
38
38
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -101,15 +101,27 @@ function createIngestionClient({
|
|
|
101
101
|
addAlgoliaAgent(segment, version) {
|
|
102
102
|
transporter.algoliaAgent.add({ segment, version });
|
|
103
103
|
},
|
|
104
|
+
/**
|
|
105
|
+
* Helper method to switch the API key used to authenticate the requests.
|
|
106
|
+
*
|
|
107
|
+
* @param params - Method params.
|
|
108
|
+
* @param params.apiKey - The new API Key to use.
|
|
109
|
+
*/
|
|
110
|
+
setClientApiKey({ apiKey }) {
|
|
111
|
+
if (!authMode || authMode === "WithinHeaders") {
|
|
112
|
+
transporter.baseHeaders["x-algolia-api-key"] = apiKey;
|
|
113
|
+
} else {
|
|
114
|
+
transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
|
|
115
|
+
}
|
|
116
|
+
},
|
|
104
117
|
/**
|
|
105
118
|
* Creates a new authentication resource.
|
|
106
119
|
*
|
|
107
120
|
* Required API Key ACLs:
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
111
|
-
*
|
|
112
|
-
* @param authenticationCreate -.
|
|
121
|
+
* - addObject
|
|
122
|
+
* - deleteIndex
|
|
123
|
+
* - editSettings
|
|
124
|
+
* @param authenticationCreate -
|
|
113
125
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
114
126
|
*/
|
|
115
127
|
createAuthentication(authenticationCreate, requestOptions) {
|
|
@@ -141,11 +153,10 @@ function createIngestionClient({
|
|
|
141
153
|
* Creates a new destination.
|
|
142
154
|
*
|
|
143
155
|
* Required API Key ACLs:
|
|
144
|
-
*
|
|
145
|
-
*
|
|
146
|
-
*
|
|
147
|
-
*
|
|
148
|
-
* @param destinationCreate -.
|
|
156
|
+
* - addObject
|
|
157
|
+
* - deleteIndex
|
|
158
|
+
* - editSettings
|
|
159
|
+
* @param destinationCreate -
|
|
149
160
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
150
161
|
*/
|
|
151
162
|
createDestination(destinationCreate, requestOptions) {
|
|
@@ -177,11 +188,10 @@ function createIngestionClient({
|
|
|
177
188
|
* Creates a new source.
|
|
178
189
|
*
|
|
179
190
|
* Required API Key ACLs:
|
|
180
|
-
*
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
*
|
|
184
|
-
* @param sourceCreate -.
|
|
191
|
+
* - addObject
|
|
192
|
+
* - deleteIndex
|
|
193
|
+
* - editSettings
|
|
194
|
+
* @param sourceCreate -
|
|
185
195
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
186
196
|
*/
|
|
187
197
|
createSource(sourceCreate, requestOptions) {
|
|
@@ -208,7 +218,6 @@ function createIngestionClient({
|
|
|
208
218
|
},
|
|
209
219
|
/**
|
|
210
220
|
* Creates a new task.
|
|
211
|
-
*
|
|
212
221
|
* @param taskCreate - Request body for creating a task.
|
|
213
222
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
214
223
|
*/
|
|
@@ -239,7 +248,6 @@ function createIngestionClient({
|
|
|
239
248
|
},
|
|
240
249
|
/**
|
|
241
250
|
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
242
|
-
*
|
|
243
251
|
* @param taskCreate - Request body for creating a task.
|
|
244
252
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
245
253
|
*/
|
|
@@ -273,7 +281,6 @@ function createIngestionClient({
|
|
|
273
281
|
},
|
|
274
282
|
/**
|
|
275
283
|
* Creates a new transformation.
|
|
276
|
-
*
|
|
277
284
|
* @param transformationCreate - Request body for creating a transformation.
|
|
278
285
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
279
286
|
*/
|
|
@@ -301,7 +308,6 @@ function createIngestionClient({
|
|
|
301
308
|
},
|
|
302
309
|
/**
|
|
303
310
|
* This method allow you to send requests to the Algolia REST API.
|
|
304
|
-
*
|
|
305
311
|
* @param customDelete - The customDelete object.
|
|
306
312
|
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
307
313
|
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
@@ -324,7 +330,6 @@ function createIngestionClient({
|
|
|
324
330
|
},
|
|
325
331
|
/**
|
|
326
332
|
* This method allow you to send requests to the Algolia REST API.
|
|
327
|
-
*
|
|
328
333
|
* @param customGet - The customGet object.
|
|
329
334
|
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
330
335
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -347,7 +352,6 @@ function createIngestionClient({
|
|
|
347
352
|
},
|
|
348
353
|
/**
|
|
349
354
|
* This method allow you to send requests to the Algolia REST API.
|
|
350
|
-
*
|
|
351
355
|
* @param customPost - The customPost object.
|
|
352
356
|
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
353
357
|
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
@@ -372,7 +376,6 @@ function createIngestionClient({
|
|
|
372
376
|
},
|
|
373
377
|
/**
|
|
374
378
|
* This method allow you to send requests to the Algolia REST API.
|
|
375
|
-
*
|
|
376
379
|
* @param customPut - The customPut object.
|
|
377
380
|
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
378
381
|
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
@@ -399,10 +402,9 @@ function createIngestionClient({
|
|
|
399
402
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
400
403
|
*
|
|
401
404
|
* Required API Key ACLs:
|
|
402
|
-
*
|
|
403
|
-
*
|
|
404
|
-
*
|
|
405
|
-
*
|
|
405
|
+
* - addObject
|
|
406
|
+
* - deleteIndex
|
|
407
|
+
* - editSettings
|
|
406
408
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
407
409
|
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
408
410
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -429,10 +431,9 @@ function createIngestionClient({
|
|
|
429
431
|
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
430
432
|
*
|
|
431
433
|
* Required API Key ACLs:
|
|
432
|
-
*
|
|
433
|
-
*
|
|
434
|
-
*
|
|
435
|
-
*
|
|
434
|
+
* - addObject
|
|
435
|
+
* - deleteIndex
|
|
436
|
+
* - editSettings
|
|
436
437
|
* @param deleteDestination - The deleteDestination object.
|
|
437
438
|
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
438
439
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -459,10 +460,9 @@ function createIngestionClient({
|
|
|
459
460
|
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
460
461
|
*
|
|
461
462
|
* Required API Key ACLs:
|
|
462
|
-
*
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
*
|
|
463
|
+
* - addObject
|
|
464
|
+
* - deleteIndex
|
|
465
|
+
* - editSettings
|
|
466
466
|
* @param deleteSource - The deleteSource object.
|
|
467
467
|
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
468
468
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -484,7 +484,6 @@ function createIngestionClient({
|
|
|
484
484
|
},
|
|
485
485
|
/**
|
|
486
486
|
* Deletes a task by its ID.
|
|
487
|
-
*
|
|
488
487
|
* @param deleteTask - The deleteTask object.
|
|
489
488
|
* @param deleteTask.taskID - Unique identifier of a task.
|
|
490
489
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -506,7 +505,6 @@ function createIngestionClient({
|
|
|
506
505
|
},
|
|
507
506
|
/**
|
|
508
507
|
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
509
|
-
*
|
|
510
508
|
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
511
509
|
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
512
510
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -528,7 +526,6 @@ function createIngestionClient({
|
|
|
528
526
|
},
|
|
529
527
|
/**
|
|
530
528
|
* Deletes a transformation by its ID.
|
|
531
|
-
*
|
|
532
529
|
* @param deleteTransformation - The deleteTransformation object.
|
|
533
530
|
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
534
531
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -555,10 +552,9 @@ function createIngestionClient({
|
|
|
555
552
|
* Disables a task.
|
|
556
553
|
*
|
|
557
554
|
* Required API Key ACLs:
|
|
558
|
-
*
|
|
559
|
-
*
|
|
560
|
-
*
|
|
561
|
-
*
|
|
555
|
+
* - addObject
|
|
556
|
+
* - deleteIndex
|
|
557
|
+
* - editSettings
|
|
562
558
|
* @param disableTask - The disableTask object.
|
|
563
559
|
* @param disableTask.taskID - Unique identifier of a task.
|
|
564
560
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -582,10 +578,9 @@ function createIngestionClient({
|
|
|
582
578
|
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
583
579
|
*
|
|
584
580
|
* Required API Key ACLs:
|
|
585
|
-
*
|
|
586
|
-
*
|
|
587
|
-
*
|
|
588
|
-
*
|
|
581
|
+
* - addObject
|
|
582
|
+
* - deleteIndex
|
|
583
|
+
* - editSettings
|
|
589
584
|
* @param disableTaskV1 - The disableTaskV1 object.
|
|
590
585
|
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
591
586
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -609,10 +604,9 @@ function createIngestionClient({
|
|
|
609
604
|
* Enables a task.
|
|
610
605
|
*
|
|
611
606
|
* Required API Key ACLs:
|
|
612
|
-
*
|
|
613
|
-
*
|
|
614
|
-
*
|
|
615
|
-
*
|
|
607
|
+
* - addObject
|
|
608
|
+
* - deleteIndex
|
|
609
|
+
* - editSettings
|
|
616
610
|
* @param enableTask - The enableTask object.
|
|
617
611
|
* @param enableTask.taskID - Unique identifier of a task.
|
|
618
612
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -636,10 +630,9 @@ function createIngestionClient({
|
|
|
636
630
|
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
637
631
|
*
|
|
638
632
|
* Required API Key ACLs:
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
*
|
|
642
|
-
*
|
|
633
|
+
* - addObject
|
|
634
|
+
* - deleteIndex
|
|
635
|
+
* - editSettings
|
|
643
636
|
* @param enableTaskV1 - The enableTaskV1 object.
|
|
644
637
|
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
645
638
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -659,53 +652,13 @@ function createIngestionClient({
|
|
|
659
652
|
};
|
|
660
653
|
return transporter.request(request, requestOptions);
|
|
661
654
|
},
|
|
662
|
-
/**
|
|
663
|
-
* Generates code for the selected model based on the given prompt.
|
|
664
|
-
*
|
|
665
|
-
* Required API Key ACLs:
|
|
666
|
-
* - addObject
|
|
667
|
-
* - deleteIndex
|
|
668
|
-
* - editSettings.
|
|
669
|
-
*
|
|
670
|
-
* @param generateTransformationCodePayload - The generateTransformationCodePayload object.
|
|
671
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
672
|
-
*/
|
|
673
|
-
generateTransformationCode(generateTransformationCodePayload, requestOptions) {
|
|
674
|
-
if (!generateTransformationCodePayload) {
|
|
675
|
-
throw new Error(
|
|
676
|
-
"Parameter `generateTransformationCodePayload` is required when calling `generateTransformationCode`."
|
|
677
|
-
);
|
|
678
|
-
}
|
|
679
|
-
if (!generateTransformationCodePayload.id) {
|
|
680
|
-
throw new Error(
|
|
681
|
-
"Parameter `generateTransformationCodePayload.id` is required when calling `generateTransformationCode`."
|
|
682
|
-
);
|
|
683
|
-
}
|
|
684
|
-
if (!generateTransformationCodePayload.userPrompt) {
|
|
685
|
-
throw new Error(
|
|
686
|
-
"Parameter `generateTransformationCodePayload.userPrompt` is required when calling `generateTransformationCode`."
|
|
687
|
-
);
|
|
688
|
-
}
|
|
689
|
-
const requestPath = "/1/transformations/models";
|
|
690
|
-
const headers = {};
|
|
691
|
-
const queryParameters = {};
|
|
692
|
-
const request = {
|
|
693
|
-
method: "POST",
|
|
694
|
-
path: requestPath,
|
|
695
|
-
queryParameters,
|
|
696
|
-
headers,
|
|
697
|
-
data: generateTransformationCodePayload
|
|
698
|
-
};
|
|
699
|
-
return transporter.request(request, requestOptions);
|
|
700
|
-
},
|
|
701
655
|
/**
|
|
702
656
|
* Retrieves an authentication resource by its ID.
|
|
703
657
|
*
|
|
704
658
|
* Required API Key ACLs:
|
|
705
|
-
*
|
|
706
|
-
*
|
|
707
|
-
*
|
|
708
|
-
*
|
|
659
|
+
* - addObject
|
|
660
|
+
* - deleteIndex
|
|
661
|
+
* - editSettings
|
|
709
662
|
* @param getAuthentication - The getAuthentication object.
|
|
710
663
|
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
711
664
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -732,10 +685,9 @@ function createIngestionClient({
|
|
|
732
685
|
* Retrieves a destination by its ID.
|
|
733
686
|
*
|
|
734
687
|
* Required API Key ACLs:
|
|
735
|
-
*
|
|
736
|
-
*
|
|
737
|
-
*
|
|
738
|
-
*
|
|
688
|
+
* - addObject
|
|
689
|
+
* - deleteIndex
|
|
690
|
+
* - editSettings
|
|
739
691
|
* @param getDestination - The getDestination object.
|
|
740
692
|
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
741
693
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -762,10 +714,9 @@ function createIngestionClient({
|
|
|
762
714
|
* Retrieves a single task run event by its ID.
|
|
763
715
|
*
|
|
764
716
|
* Required API Key ACLs:
|
|
765
|
-
*
|
|
766
|
-
*
|
|
767
|
-
*
|
|
768
|
-
*
|
|
717
|
+
* - addObject
|
|
718
|
+
* - deleteIndex
|
|
719
|
+
* - editSettings
|
|
769
720
|
* @param getEvent - The getEvent object.
|
|
770
721
|
* @param getEvent.runID - Unique identifier of a task run.
|
|
771
722
|
* @param getEvent.eventID - Unique identifier of an event.
|
|
@@ -793,10 +744,9 @@ function createIngestionClient({
|
|
|
793
744
|
* Retrieve a single task run by its ID.
|
|
794
745
|
*
|
|
795
746
|
* Required API Key ACLs:
|
|
796
|
-
*
|
|
797
|
-
*
|
|
798
|
-
*
|
|
799
|
-
*
|
|
747
|
+
* - addObject
|
|
748
|
+
* - deleteIndex
|
|
749
|
+
* - editSettings
|
|
800
750
|
* @param getRun - The getRun object.
|
|
801
751
|
* @param getRun.runID - Unique identifier of a task run.
|
|
802
752
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -820,10 +770,9 @@ function createIngestionClient({
|
|
|
820
770
|
* Retrieve a source by its ID.
|
|
821
771
|
*
|
|
822
772
|
* Required API Key ACLs:
|
|
823
|
-
*
|
|
824
|
-
*
|
|
825
|
-
*
|
|
826
|
-
*
|
|
773
|
+
* - addObject
|
|
774
|
+
* - deleteIndex
|
|
775
|
+
* - editSettings
|
|
827
776
|
* @param getSource - The getSource object.
|
|
828
777
|
* @param getSource.sourceID - Unique identifier of a source.
|
|
829
778
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -847,10 +796,9 @@ function createIngestionClient({
|
|
|
847
796
|
* Retrieves a task by its ID.
|
|
848
797
|
*
|
|
849
798
|
* Required API Key ACLs:
|
|
850
|
-
*
|
|
851
|
-
*
|
|
852
|
-
*
|
|
853
|
-
*
|
|
799
|
+
* - addObject
|
|
800
|
+
* - deleteIndex
|
|
801
|
+
* - editSettings
|
|
854
802
|
* @param getTask - The getTask object.
|
|
855
803
|
* @param getTask.taskID - Unique identifier of a task.
|
|
856
804
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -874,10 +822,9 @@ function createIngestionClient({
|
|
|
874
822
|
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
875
823
|
*
|
|
876
824
|
* Required API Key ACLs:
|
|
877
|
-
*
|
|
878
|
-
*
|
|
879
|
-
*
|
|
880
|
-
*
|
|
825
|
+
* - addObject
|
|
826
|
+
* - deleteIndex
|
|
827
|
+
* - editSettings
|
|
881
828
|
* @param getTaskV1 - The getTaskV1 object.
|
|
882
829
|
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
883
830
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -901,10 +848,9 @@ function createIngestionClient({
|
|
|
901
848
|
* Retrieves a transformation by its ID.
|
|
902
849
|
*
|
|
903
850
|
* Required API Key ACLs:
|
|
904
|
-
*
|
|
905
|
-
*
|
|
906
|
-
*
|
|
907
|
-
*
|
|
851
|
+
* - addObject
|
|
852
|
+
* - deleteIndex
|
|
853
|
+
* - editSettings
|
|
908
854
|
* @param getTransformation - The getTransformation object.
|
|
909
855
|
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
910
856
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -931,16 +877,15 @@ function createIngestionClient({
|
|
|
931
877
|
* Retrieves a list of all authentication resources.
|
|
932
878
|
*
|
|
933
879
|
* Required API Key ACLs:
|
|
934
|
-
*
|
|
935
|
-
*
|
|
936
|
-
*
|
|
937
|
-
*
|
|
880
|
+
* - addObject
|
|
881
|
+
* - deleteIndex
|
|
882
|
+
* - editSettings
|
|
938
883
|
* @param listAuthentications - The listAuthentications object.
|
|
939
884
|
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
940
885
|
* @param listAuthentications.page - Page number of the paginated API response.
|
|
941
886
|
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
942
|
-
* @param listAuthentications.platform - Ecommerce platform for which to retrieve
|
|
943
|
-
* @param listAuthentications.sort - Property by which to sort the list of
|
|
887
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
888
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
944
889
|
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
945
890
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
946
891
|
*/
|
|
@@ -949,22 +894,22 @@ function createIngestionClient({
|
|
|
949
894
|
const headers = {};
|
|
950
895
|
const queryParameters = {};
|
|
951
896
|
if (itemsPerPage !== void 0) {
|
|
952
|
-
queryParameters
|
|
897
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
953
898
|
}
|
|
954
899
|
if (page !== void 0) {
|
|
955
|
-
queryParameters
|
|
900
|
+
queryParameters["page"] = page.toString();
|
|
956
901
|
}
|
|
957
902
|
if (type !== void 0) {
|
|
958
|
-
queryParameters
|
|
903
|
+
queryParameters["type"] = type.toString();
|
|
959
904
|
}
|
|
960
905
|
if (platform !== void 0) {
|
|
961
|
-
queryParameters
|
|
906
|
+
queryParameters["platform"] = platform.toString();
|
|
962
907
|
}
|
|
963
908
|
if (sort !== void 0) {
|
|
964
|
-
queryParameters
|
|
909
|
+
queryParameters["sort"] = sort.toString();
|
|
965
910
|
}
|
|
966
911
|
if (order !== void 0) {
|
|
967
|
-
queryParameters
|
|
912
|
+
queryParameters["order"] = order.toString();
|
|
968
913
|
}
|
|
969
914
|
const request = {
|
|
970
915
|
method: "GET",
|
|
@@ -978,40 +923,43 @@ function createIngestionClient({
|
|
|
978
923
|
* Retrieves a list of destinations.
|
|
979
924
|
*
|
|
980
925
|
* Required API Key ACLs:
|
|
981
|
-
*
|
|
982
|
-
*
|
|
983
|
-
*
|
|
984
|
-
*
|
|
926
|
+
* - addObject
|
|
927
|
+
* - deleteIndex
|
|
928
|
+
* - editSettings
|
|
985
929
|
* @param listDestinations - The listDestinations object.
|
|
986
930
|
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
987
931
|
* @param listDestinations.page - Page number of the paginated API response.
|
|
988
932
|
* @param listDestinations.type - Destination type.
|
|
989
933
|
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
934
|
+
* @param listDestinations.transformationID - Get the list of destinations used by a transformation.
|
|
990
935
|
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
991
936
|
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
992
937
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
993
938
|
*/
|
|
994
|
-
listDestinations({ itemsPerPage, page, type, authenticationID, sort, order } = {}, requestOptions = void 0) {
|
|
939
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
995
940
|
const requestPath = "/1/destinations";
|
|
996
941
|
const headers = {};
|
|
997
942
|
const queryParameters = {};
|
|
998
943
|
if (itemsPerPage !== void 0) {
|
|
999
|
-
queryParameters
|
|
944
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1000
945
|
}
|
|
1001
946
|
if (page !== void 0) {
|
|
1002
|
-
queryParameters
|
|
947
|
+
queryParameters["page"] = page.toString();
|
|
1003
948
|
}
|
|
1004
949
|
if (type !== void 0) {
|
|
1005
|
-
queryParameters
|
|
950
|
+
queryParameters["type"] = type.toString();
|
|
1006
951
|
}
|
|
1007
952
|
if (authenticationID !== void 0) {
|
|
1008
|
-
queryParameters
|
|
953
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
954
|
+
}
|
|
955
|
+
if (transformationID !== void 0) {
|
|
956
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
1009
957
|
}
|
|
1010
958
|
if (sort !== void 0) {
|
|
1011
|
-
queryParameters
|
|
959
|
+
queryParameters["sort"] = sort.toString();
|
|
1012
960
|
}
|
|
1013
961
|
if (order !== void 0) {
|
|
1014
|
-
queryParameters
|
|
962
|
+
queryParameters["order"] = order.toString();
|
|
1015
963
|
}
|
|
1016
964
|
const request = {
|
|
1017
965
|
method: "GET",
|
|
@@ -1022,13 +970,12 @@ function createIngestionClient({
|
|
|
1022
970
|
return transporter.request(request, requestOptions);
|
|
1023
971
|
},
|
|
1024
972
|
/**
|
|
1025
|
-
* Retrieves a list of events for a task run, identified by
|
|
973
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1026
974
|
*
|
|
1027
975
|
* Required API Key ACLs:
|
|
1028
|
-
*
|
|
1029
|
-
*
|
|
1030
|
-
*
|
|
1031
|
-
*
|
|
976
|
+
* - addObject
|
|
977
|
+
* - deleteIndex
|
|
978
|
+
* - editSettings
|
|
1032
979
|
* @param listEvents - The listEvents object.
|
|
1033
980
|
* @param listEvents.runID - Unique identifier of a task run.
|
|
1034
981
|
* @param listEvents.itemsPerPage - Number of items per page.
|
|
@@ -1049,28 +996,28 @@ function createIngestionClient({
|
|
|
1049
996
|
const headers = {};
|
|
1050
997
|
const queryParameters = {};
|
|
1051
998
|
if (itemsPerPage !== void 0) {
|
|
1052
|
-
queryParameters
|
|
999
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1053
1000
|
}
|
|
1054
1001
|
if (page !== void 0) {
|
|
1055
|
-
queryParameters
|
|
1002
|
+
queryParameters["page"] = page.toString();
|
|
1056
1003
|
}
|
|
1057
1004
|
if (status !== void 0) {
|
|
1058
|
-
queryParameters
|
|
1005
|
+
queryParameters["status"] = status.toString();
|
|
1059
1006
|
}
|
|
1060
1007
|
if (type !== void 0) {
|
|
1061
|
-
queryParameters
|
|
1008
|
+
queryParameters["type"] = type.toString();
|
|
1062
1009
|
}
|
|
1063
1010
|
if (sort !== void 0) {
|
|
1064
|
-
queryParameters
|
|
1011
|
+
queryParameters["sort"] = sort.toString();
|
|
1065
1012
|
}
|
|
1066
1013
|
if (order !== void 0) {
|
|
1067
|
-
queryParameters
|
|
1014
|
+
queryParameters["order"] = order.toString();
|
|
1068
1015
|
}
|
|
1069
1016
|
if (startDate !== void 0) {
|
|
1070
|
-
queryParameters
|
|
1017
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1071
1018
|
}
|
|
1072
1019
|
if (endDate !== void 0) {
|
|
1073
|
-
queryParameters
|
|
1020
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1074
1021
|
}
|
|
1075
1022
|
const request = {
|
|
1076
1023
|
method: "GET",
|
|
@@ -1084,10 +1031,9 @@ function createIngestionClient({
|
|
|
1084
1031
|
* Retrieve a list of task runs.
|
|
1085
1032
|
*
|
|
1086
1033
|
* Required API Key ACLs:
|
|
1087
|
-
*
|
|
1088
|
-
*
|
|
1089
|
-
*
|
|
1090
|
-
*
|
|
1034
|
+
* - addObject
|
|
1035
|
+
* - deleteIndex
|
|
1036
|
+
* - editSettings
|
|
1091
1037
|
* @param listRuns - The listRuns object.
|
|
1092
1038
|
* @param listRuns.itemsPerPage - Number of items per page.
|
|
1093
1039
|
* @param listRuns.page - Page number of the paginated API response.
|
|
@@ -1105,31 +1051,31 @@ function createIngestionClient({
|
|
|
1105
1051
|
const headers = {};
|
|
1106
1052
|
const queryParameters = {};
|
|
1107
1053
|
if (itemsPerPage !== void 0) {
|
|
1108
|
-
queryParameters
|
|
1054
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1109
1055
|
}
|
|
1110
1056
|
if (page !== void 0) {
|
|
1111
|
-
queryParameters
|
|
1057
|
+
queryParameters["page"] = page.toString();
|
|
1112
1058
|
}
|
|
1113
1059
|
if (status !== void 0) {
|
|
1114
|
-
queryParameters
|
|
1060
|
+
queryParameters["status"] = status.toString();
|
|
1115
1061
|
}
|
|
1116
1062
|
if (type !== void 0) {
|
|
1117
|
-
queryParameters
|
|
1063
|
+
queryParameters["type"] = type.toString();
|
|
1118
1064
|
}
|
|
1119
1065
|
if (taskID !== void 0) {
|
|
1120
|
-
queryParameters
|
|
1066
|
+
queryParameters["taskID"] = taskID.toString();
|
|
1121
1067
|
}
|
|
1122
1068
|
if (sort !== void 0) {
|
|
1123
|
-
queryParameters
|
|
1069
|
+
queryParameters["sort"] = sort.toString();
|
|
1124
1070
|
}
|
|
1125
1071
|
if (order !== void 0) {
|
|
1126
|
-
queryParameters
|
|
1072
|
+
queryParameters["order"] = order.toString();
|
|
1127
1073
|
}
|
|
1128
1074
|
if (startDate !== void 0) {
|
|
1129
|
-
queryParameters
|
|
1075
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1130
1076
|
}
|
|
1131
1077
|
if (endDate !== void 0) {
|
|
1132
|
-
queryParameters
|
|
1078
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1133
1079
|
}
|
|
1134
1080
|
const request = {
|
|
1135
1081
|
method: "GET",
|
|
@@ -1143,15 +1089,14 @@ function createIngestionClient({
|
|
|
1143
1089
|
* Retrieves a list of sources.
|
|
1144
1090
|
*
|
|
1145
1091
|
* Required API Key ACLs:
|
|
1146
|
-
*
|
|
1147
|
-
*
|
|
1148
|
-
*
|
|
1149
|
-
*
|
|
1092
|
+
* - addObject
|
|
1093
|
+
* - deleteIndex
|
|
1094
|
+
* - editSettings
|
|
1150
1095
|
* @param listSources - The listSources object.
|
|
1151
1096
|
* @param listSources.itemsPerPage - Number of items per page.
|
|
1152
1097
|
* @param listSources.page - Page number of the paginated API response.
|
|
1153
1098
|
* @param listSources.type - Source type. Some sources require authentication.
|
|
1154
|
-
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication
|
|
1099
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
|
|
1155
1100
|
* @param listSources.sort - Property by which to sort the list of sources.
|
|
1156
1101
|
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
1157
1102
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1161,22 +1106,22 @@ function createIngestionClient({
|
|
|
1161
1106
|
const headers = {};
|
|
1162
1107
|
const queryParameters = {};
|
|
1163
1108
|
if (itemsPerPage !== void 0) {
|
|
1164
|
-
queryParameters
|
|
1109
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1165
1110
|
}
|
|
1166
1111
|
if (page !== void 0) {
|
|
1167
|
-
queryParameters
|
|
1112
|
+
queryParameters["page"] = page.toString();
|
|
1168
1113
|
}
|
|
1169
1114
|
if (type !== void 0) {
|
|
1170
|
-
queryParameters
|
|
1115
|
+
queryParameters["type"] = type.toString();
|
|
1171
1116
|
}
|
|
1172
1117
|
if (authenticationID !== void 0) {
|
|
1173
|
-
queryParameters
|
|
1118
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1174
1119
|
}
|
|
1175
1120
|
if (sort !== void 0) {
|
|
1176
|
-
queryParameters
|
|
1121
|
+
queryParameters["sort"] = sort.toString();
|
|
1177
1122
|
}
|
|
1178
1123
|
if (order !== void 0) {
|
|
1179
|
-
queryParameters
|
|
1124
|
+
queryParameters["order"] = order.toString();
|
|
1180
1125
|
}
|
|
1181
1126
|
const request = {
|
|
1182
1127
|
method: "GET",
|
|
@@ -1190,10 +1135,9 @@ function createIngestionClient({
|
|
|
1190
1135
|
* Retrieves a list of tasks.
|
|
1191
1136
|
*
|
|
1192
1137
|
* Required API Key ACLs:
|
|
1193
|
-
*
|
|
1194
|
-
*
|
|
1195
|
-
*
|
|
1196
|
-
*
|
|
1138
|
+
* - addObject
|
|
1139
|
+
* - deleteIndex
|
|
1140
|
+
* - editSettings
|
|
1197
1141
|
* @param listTasks - The listTasks object.
|
|
1198
1142
|
* @param listTasks.itemsPerPage - Number of items per page.
|
|
1199
1143
|
* @param listTasks.page - Page number of the paginated API response.
|
|
@@ -1211,31 +1155,31 @@ function createIngestionClient({
|
|
|
1211
1155
|
const headers = {};
|
|
1212
1156
|
const queryParameters = {};
|
|
1213
1157
|
if (itemsPerPage !== void 0) {
|
|
1214
|
-
queryParameters
|
|
1158
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1215
1159
|
}
|
|
1216
1160
|
if (page !== void 0) {
|
|
1217
|
-
queryParameters
|
|
1161
|
+
queryParameters["page"] = page.toString();
|
|
1218
1162
|
}
|
|
1219
1163
|
if (action !== void 0) {
|
|
1220
|
-
queryParameters
|
|
1164
|
+
queryParameters["action"] = action.toString();
|
|
1221
1165
|
}
|
|
1222
1166
|
if (enabled !== void 0) {
|
|
1223
|
-
queryParameters
|
|
1167
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1224
1168
|
}
|
|
1225
1169
|
if (sourceID !== void 0) {
|
|
1226
|
-
queryParameters
|
|
1170
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1227
1171
|
}
|
|
1228
1172
|
if (destinationID !== void 0) {
|
|
1229
|
-
queryParameters
|
|
1173
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1230
1174
|
}
|
|
1231
1175
|
if (triggerType !== void 0) {
|
|
1232
|
-
queryParameters
|
|
1176
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1233
1177
|
}
|
|
1234
1178
|
if (sort !== void 0) {
|
|
1235
|
-
queryParameters
|
|
1179
|
+
queryParameters["sort"] = sort.toString();
|
|
1236
1180
|
}
|
|
1237
1181
|
if (order !== void 0) {
|
|
1238
|
-
queryParameters
|
|
1182
|
+
queryParameters["order"] = order.toString();
|
|
1239
1183
|
}
|
|
1240
1184
|
const request = {
|
|
1241
1185
|
method: "GET",
|
|
@@ -1249,10 +1193,9 @@ function createIngestionClient({
|
|
|
1249
1193
|
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
1250
1194
|
*
|
|
1251
1195
|
* Required API Key ACLs:
|
|
1252
|
-
*
|
|
1253
|
-
*
|
|
1254
|
-
*
|
|
1255
|
-
*
|
|
1196
|
+
* - addObject
|
|
1197
|
+
* - deleteIndex
|
|
1198
|
+
* - editSettings
|
|
1256
1199
|
* @param listTasksV1 - The listTasksV1 object.
|
|
1257
1200
|
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
1258
1201
|
* @param listTasksV1.page - Page number of the paginated API response.
|
|
@@ -1270,31 +1213,31 @@ function createIngestionClient({
|
|
|
1270
1213
|
const headers = {};
|
|
1271
1214
|
const queryParameters = {};
|
|
1272
1215
|
if (itemsPerPage !== void 0) {
|
|
1273
|
-
queryParameters
|
|
1216
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1274
1217
|
}
|
|
1275
1218
|
if (page !== void 0) {
|
|
1276
|
-
queryParameters
|
|
1219
|
+
queryParameters["page"] = page.toString();
|
|
1277
1220
|
}
|
|
1278
1221
|
if (action !== void 0) {
|
|
1279
|
-
queryParameters
|
|
1222
|
+
queryParameters["action"] = action.toString();
|
|
1280
1223
|
}
|
|
1281
1224
|
if (enabled !== void 0) {
|
|
1282
|
-
queryParameters
|
|
1225
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1283
1226
|
}
|
|
1284
1227
|
if (sourceID !== void 0) {
|
|
1285
|
-
queryParameters
|
|
1228
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1286
1229
|
}
|
|
1287
1230
|
if (destinationID !== void 0) {
|
|
1288
|
-
queryParameters
|
|
1231
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1289
1232
|
}
|
|
1290
1233
|
if (triggerType !== void 0) {
|
|
1291
|
-
queryParameters
|
|
1234
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1292
1235
|
}
|
|
1293
1236
|
if (sort !== void 0) {
|
|
1294
|
-
queryParameters
|
|
1237
|
+
queryParameters["sort"] = sort.toString();
|
|
1295
1238
|
}
|
|
1296
1239
|
if (order !== void 0) {
|
|
1297
|
-
queryParameters
|
|
1240
|
+
queryParameters["order"] = order.toString();
|
|
1298
1241
|
}
|
|
1299
1242
|
const request = {
|
|
1300
1243
|
method: "GET",
|
|
@@ -1304,40 +1247,17 @@ function createIngestionClient({
|
|
|
1304
1247
|
};
|
|
1305
1248
|
return transporter.request(request, requestOptions);
|
|
1306
1249
|
},
|
|
1307
|
-
/**
|
|
1308
|
-
* Retrieves a list of existing LLM transformation helpers.
|
|
1309
|
-
*
|
|
1310
|
-
* Required API Key ACLs:
|
|
1311
|
-
* - addObject
|
|
1312
|
-
* - deleteIndex
|
|
1313
|
-
* - editSettings.
|
|
1314
|
-
*
|
|
1315
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1316
|
-
*/
|
|
1317
|
-
listTransformationModels(requestOptions) {
|
|
1318
|
-
const requestPath = "/1/transformations/models";
|
|
1319
|
-
const headers = {};
|
|
1320
|
-
const queryParameters = {};
|
|
1321
|
-
const request = {
|
|
1322
|
-
method: "GET",
|
|
1323
|
-
path: requestPath,
|
|
1324
|
-
queryParameters,
|
|
1325
|
-
headers
|
|
1326
|
-
};
|
|
1327
|
-
return transporter.request(request, requestOptions);
|
|
1328
|
-
},
|
|
1329
1250
|
/**
|
|
1330
1251
|
* Retrieves a list of transformations.
|
|
1331
1252
|
*
|
|
1332
1253
|
* Required API Key ACLs:
|
|
1333
|
-
*
|
|
1334
|
-
*
|
|
1335
|
-
*
|
|
1336
|
-
*
|
|
1254
|
+
* - addObject
|
|
1255
|
+
* - deleteIndex
|
|
1256
|
+
* - editSettings
|
|
1337
1257
|
* @param listTransformations - The listTransformations object.
|
|
1338
1258
|
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
1339
1259
|
* @param listTransformations.page - Page number of the paginated API response.
|
|
1340
|
-
* @param listTransformations.sort - Property by which to sort the list.
|
|
1260
|
+
* @param listTransformations.sort - Property by which to sort the list of transformations.
|
|
1341
1261
|
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
1342
1262
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1343
1263
|
*/
|
|
@@ -1346,16 +1266,16 @@ function createIngestionClient({
|
|
|
1346
1266
|
const headers = {};
|
|
1347
1267
|
const queryParameters = {};
|
|
1348
1268
|
if (itemsPerPage !== void 0) {
|
|
1349
|
-
queryParameters
|
|
1269
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1350
1270
|
}
|
|
1351
1271
|
if (page !== void 0) {
|
|
1352
|
-
queryParameters
|
|
1272
|
+
queryParameters["page"] = page.toString();
|
|
1353
1273
|
}
|
|
1354
1274
|
if (sort !== void 0) {
|
|
1355
|
-
queryParameters
|
|
1275
|
+
queryParameters["sort"] = sort.toString();
|
|
1356
1276
|
}
|
|
1357
1277
|
if (order !== void 0) {
|
|
1358
|
-
queryParameters
|
|
1278
|
+
queryParameters["order"] = order.toString();
|
|
1359
1279
|
}
|
|
1360
1280
|
const request = {
|
|
1361
1281
|
method: "GET",
|
|
@@ -1369,10 +1289,9 @@ function createIngestionClient({
|
|
|
1369
1289
|
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
1370
1290
|
*
|
|
1371
1291
|
* Required API Key ACLs:
|
|
1372
|
-
*
|
|
1373
|
-
*
|
|
1374
|
-
*
|
|
1375
|
-
*
|
|
1292
|
+
* - addObject
|
|
1293
|
+
* - deleteIndex
|
|
1294
|
+
* - editSettings
|
|
1376
1295
|
* @param pushTask - The pushTask object.
|
|
1377
1296
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1378
1297
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
@@ -1407,13 +1326,12 @@ function createIngestionClient({
|
|
|
1407
1326
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
1408
1327
|
*
|
|
1409
1328
|
* Required API Key ACLs:
|
|
1410
|
-
*
|
|
1411
|
-
*
|
|
1412
|
-
*
|
|
1413
|
-
*
|
|
1329
|
+
* - addObject
|
|
1330
|
+
* - deleteIndex
|
|
1331
|
+
* - editSettings
|
|
1414
1332
|
* @param runSource - The runSource object.
|
|
1415
1333
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1416
|
-
* @param runSource.runSourcePayload
|
|
1334
|
+
* @param runSource.runSourcePayload -
|
|
1417
1335
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1418
1336
|
*/
|
|
1419
1337
|
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
@@ -1436,10 +1354,9 @@ function createIngestionClient({
|
|
|
1436
1354
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
1437
1355
|
*
|
|
1438
1356
|
* Required API Key ACLs:
|
|
1439
|
-
*
|
|
1440
|
-
*
|
|
1441
|
-
*
|
|
1442
|
-
*
|
|
1357
|
+
* - addObject
|
|
1358
|
+
* - deleteIndex
|
|
1359
|
+
* - editSettings
|
|
1443
1360
|
* @param runTask - The runTask object.
|
|
1444
1361
|
* @param runTask.taskID - Unique identifier of a task.
|
|
1445
1362
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1463,10 +1380,9 @@ function createIngestionClient({
|
|
|
1463
1380
|
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1464
1381
|
*
|
|
1465
1382
|
* Required API Key ACLs:
|
|
1466
|
-
*
|
|
1467
|
-
*
|
|
1468
|
-
*
|
|
1469
|
-
*
|
|
1383
|
+
* - addObject
|
|
1384
|
+
* - deleteIndex
|
|
1385
|
+
* - editSettings
|
|
1470
1386
|
* @param runTaskV1 - The runTaskV1 object.
|
|
1471
1387
|
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
1472
1388
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1490,10 +1406,9 @@ function createIngestionClient({
|
|
|
1490
1406
|
* Searches for authentication resources.
|
|
1491
1407
|
*
|
|
1492
1408
|
* Required API Key ACLs:
|
|
1493
|
-
*
|
|
1494
|
-
*
|
|
1495
|
-
*
|
|
1496
|
-
*
|
|
1409
|
+
* - addObject
|
|
1410
|
+
* - deleteIndex
|
|
1411
|
+
* - editSettings
|
|
1497
1412
|
* @param authenticationSearch - The authenticationSearch object.
|
|
1498
1413
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1499
1414
|
*/
|
|
@@ -1522,10 +1437,9 @@ function createIngestionClient({
|
|
|
1522
1437
|
* Searches for destinations.
|
|
1523
1438
|
*
|
|
1524
1439
|
* Required API Key ACLs:
|
|
1525
|
-
*
|
|
1526
|
-
*
|
|
1527
|
-
*
|
|
1528
|
-
*
|
|
1440
|
+
* - addObject
|
|
1441
|
+
* - deleteIndex
|
|
1442
|
+
* - editSettings
|
|
1529
1443
|
* @param destinationSearch - The destinationSearch object.
|
|
1530
1444
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1531
1445
|
*/
|
|
@@ -1552,10 +1466,9 @@ function createIngestionClient({
|
|
|
1552
1466
|
* Searches for sources.
|
|
1553
1467
|
*
|
|
1554
1468
|
* Required API Key ACLs:
|
|
1555
|
-
*
|
|
1556
|
-
*
|
|
1557
|
-
*
|
|
1558
|
-
*
|
|
1469
|
+
* - addObject
|
|
1470
|
+
* - deleteIndex
|
|
1471
|
+
* - editSettings
|
|
1559
1472
|
* @param sourceSearch - The sourceSearch object.
|
|
1560
1473
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1561
1474
|
*/
|
|
@@ -1582,10 +1495,9 @@ function createIngestionClient({
|
|
|
1582
1495
|
* Searches for tasks.
|
|
1583
1496
|
*
|
|
1584
1497
|
* Required API Key ACLs:
|
|
1585
|
-
*
|
|
1586
|
-
*
|
|
1587
|
-
*
|
|
1588
|
-
*
|
|
1498
|
+
* - addObject
|
|
1499
|
+
* - deleteIndex
|
|
1500
|
+
* - editSettings
|
|
1589
1501
|
* @param taskSearch - The taskSearch object.
|
|
1590
1502
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1591
1503
|
*/
|
|
@@ -1612,10 +1524,9 @@ function createIngestionClient({
|
|
|
1612
1524
|
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
1613
1525
|
*
|
|
1614
1526
|
* Required API Key ACLs:
|
|
1615
|
-
*
|
|
1616
|
-
*
|
|
1617
|
-
*
|
|
1618
|
-
*
|
|
1527
|
+
* - addObject
|
|
1528
|
+
* - deleteIndex
|
|
1529
|
+
* - editSettings
|
|
1619
1530
|
* @param taskSearch - The taskSearch object.
|
|
1620
1531
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1621
1532
|
*/
|
|
@@ -1642,10 +1553,9 @@ function createIngestionClient({
|
|
|
1642
1553
|
* Searches for transformations.
|
|
1643
1554
|
*
|
|
1644
1555
|
* Required API Key ACLs:
|
|
1645
|
-
*
|
|
1646
|
-
*
|
|
1647
|
-
*
|
|
1648
|
-
*
|
|
1556
|
+
* - addObject
|
|
1557
|
+
* - deleteIndex
|
|
1558
|
+
* - editSettings
|
|
1649
1559
|
* @param transformationSearch - The transformationSearch object.
|
|
1650
1560
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1651
1561
|
*/
|
|
@@ -1674,10 +1584,9 @@ function createIngestionClient({
|
|
|
1674
1584
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1675
1585
|
*
|
|
1676
1586
|
* Required API Key ACLs:
|
|
1677
|
-
*
|
|
1678
|
-
*
|
|
1679
|
-
*
|
|
1680
|
-
*
|
|
1587
|
+
* - addObject
|
|
1588
|
+
* - deleteIndex
|
|
1589
|
+
* - editSettings
|
|
1681
1590
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1682
1591
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1683
1592
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1701,10 +1610,9 @@ function createIngestionClient({
|
|
|
1701
1610
|
* Try a transformation before creating it.
|
|
1702
1611
|
*
|
|
1703
1612
|
* Required API Key ACLs:
|
|
1704
|
-
*
|
|
1705
|
-
*
|
|
1706
|
-
*
|
|
1707
|
-
*
|
|
1613
|
+
* - addObject
|
|
1614
|
+
* - deleteIndex
|
|
1615
|
+
* - editSettings
|
|
1708
1616
|
* @param transformationTry - The transformationTry object.
|
|
1709
1617
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1710
1618
|
*/
|
|
@@ -1734,10 +1642,9 @@ function createIngestionClient({
|
|
|
1734
1642
|
* Try a transformation before updating it.
|
|
1735
1643
|
*
|
|
1736
1644
|
* Required API Key ACLs:
|
|
1737
|
-
*
|
|
1738
|
-
*
|
|
1739
|
-
*
|
|
1740
|
-
*
|
|
1645
|
+
* - addObject
|
|
1646
|
+
* - deleteIndex
|
|
1647
|
+
* - editSettings
|
|
1741
1648
|
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
1742
1649
|
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
1743
1650
|
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
@@ -1777,10 +1684,9 @@ function createIngestionClient({
|
|
|
1777
1684
|
* Updates an authentication resource.
|
|
1778
1685
|
*
|
|
1779
1686
|
* Required API Key ACLs:
|
|
1780
|
-
*
|
|
1781
|
-
*
|
|
1782
|
-
*
|
|
1783
|
-
*
|
|
1687
|
+
* - addObject
|
|
1688
|
+
* - deleteIndex
|
|
1689
|
+
* - editSettings
|
|
1784
1690
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1785
1691
|
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1786
1692
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
@@ -1812,10 +1718,9 @@ function createIngestionClient({
|
|
|
1812
1718
|
* Updates the destination by its ID.
|
|
1813
1719
|
*
|
|
1814
1720
|
* Required API Key ACLs:
|
|
1815
|
-
*
|
|
1816
|
-
*
|
|
1817
|
-
*
|
|
1818
|
-
*
|
|
1721
|
+
* - addObject
|
|
1722
|
+
* - deleteIndex
|
|
1723
|
+
* - editSettings
|
|
1819
1724
|
* @param updateDestination - The updateDestination object.
|
|
1820
1725
|
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1821
1726
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
@@ -1847,10 +1752,9 @@ function createIngestionClient({
|
|
|
1847
1752
|
* Updates a source by its ID.
|
|
1848
1753
|
*
|
|
1849
1754
|
* Required API Key ACLs:
|
|
1850
|
-
*
|
|
1851
|
-
*
|
|
1852
|
-
*
|
|
1853
|
-
*
|
|
1755
|
+
* - addObject
|
|
1756
|
+
* - deleteIndex
|
|
1757
|
+
* - editSettings
|
|
1854
1758
|
* @param updateSource - The updateSource object.
|
|
1855
1759
|
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1856
1760
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
@@ -1877,7 +1781,6 @@ function createIngestionClient({
|
|
|
1877
1781
|
},
|
|
1878
1782
|
/**
|
|
1879
1783
|
* Updates a task by its ID.
|
|
1880
|
-
*
|
|
1881
1784
|
* @param updateTask - The updateTask object.
|
|
1882
1785
|
* @param updateTask.taskID - Unique identifier of a task.
|
|
1883
1786
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
@@ -1904,7 +1807,6 @@ function createIngestionClient({
|
|
|
1904
1807
|
},
|
|
1905
1808
|
/**
|
|
1906
1809
|
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
1907
|
-
*
|
|
1908
1810
|
* @param updateTaskV1 - The updateTaskV1 object.
|
|
1909
1811
|
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
1910
1812
|
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
@@ -1931,7 +1833,6 @@ function createIngestionClient({
|
|
|
1931
1833
|
},
|
|
1932
1834
|
/**
|
|
1933
1835
|
* Updates a transformation by its ID.
|
|
1934
|
-
*
|
|
1935
1836
|
* @param updateTransformation - The updateTransformation object.
|
|
1936
1837
|
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1937
1838
|
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
@@ -1969,11 +1870,10 @@ function createIngestionClient({
|
|
|
1969
1870
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1970
1871
|
*
|
|
1971
1872
|
* Required API Key ACLs:
|
|
1972
|
-
*
|
|
1973
|
-
*
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
1976
|
-
* @param sourceCreate -.
|
|
1873
|
+
* - addObject
|
|
1874
|
+
* - deleteIndex
|
|
1875
|
+
* - editSettings
|
|
1876
|
+
* @param sourceCreate -
|
|
1977
1877
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1978
1878
|
*/
|
|
1979
1879
|
validateSource(sourceCreate, requestOptions = void 0) {
|
|
@@ -1993,10 +1893,9 @@ function createIngestionClient({
|
|
|
1993
1893
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1994
1894
|
*
|
|
1995
1895
|
* Required API Key ACLs:
|
|
1996
|
-
*
|
|
1997
|
-
*
|
|
1998
|
-
*
|
|
1999
|
-
*
|
|
1896
|
+
* - addObject
|
|
1897
|
+
* - deleteIndex
|
|
1898
|
+
* - editSettings
|
|
2000
1899
|
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
2001
1900
|
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
2002
1901
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
@@ -2045,6 +1944,7 @@ function ingestionClient(appId, apiKey, region, options) {
|
|
|
2045
1944
|
read: import_client_common2.DEFAULT_READ_TIMEOUT_NODE,
|
|
2046
1945
|
write: import_client_common2.DEFAULT_WRITE_TIMEOUT_NODE
|
|
2047
1946
|
},
|
|
1947
|
+
logger: (0, import_client_common2.createNullLogger)(),
|
|
2048
1948
|
requester: (0, import_requester_node_http.createHttpRequester)(),
|
|
2049
1949
|
algoliaAgents: [{ segment: "Node.js", version: process.versions.node }],
|
|
2050
1950
|
responsesCache: (0, import_client_common2.createNullCache)(),
|