@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.js
CHANGED
|
@@ -1,16 +1,17 @@
|
|
|
1
1
|
// builds/node.ts
|
|
2
|
+
import { createHttpRequester } from "@algolia/requester-node-http";
|
|
2
3
|
import {
|
|
3
4
|
createMemoryCache,
|
|
4
5
|
createNullCache,
|
|
6
|
+
createNullLogger,
|
|
5
7
|
DEFAULT_CONNECT_TIMEOUT_NODE,
|
|
6
8
|
DEFAULT_READ_TIMEOUT_NODE,
|
|
7
9
|
DEFAULT_WRITE_TIMEOUT_NODE
|
|
8
10
|
} from "@algolia/client-common";
|
|
9
|
-
import { createHttpRequester } from "@algolia/requester-node-http";
|
|
10
11
|
|
|
11
12
|
// src/ingestionClient.ts
|
|
12
13
|
import { createAuth, createTransporter, getAlgoliaAgent } from "@algolia/client-common";
|
|
13
|
-
var apiClientVersion = "1.
|
|
14
|
+
var apiClientVersion = "1.10.0";
|
|
14
15
|
var REGIONS = ["eu", "us"];
|
|
15
16
|
function getDefaultHosts(region) {
|
|
16
17
|
const url = "data.{region}.algolia.com".replace("{region}", region);
|
|
@@ -79,15 +80,27 @@ function createIngestionClient({
|
|
|
79
80
|
addAlgoliaAgent(segment, version) {
|
|
80
81
|
transporter.algoliaAgent.add({ segment, version });
|
|
81
82
|
},
|
|
83
|
+
/**
|
|
84
|
+
* Helper method to switch the API key used to authenticate the requests.
|
|
85
|
+
*
|
|
86
|
+
* @param params - Method params.
|
|
87
|
+
* @param params.apiKey - The new API Key to use.
|
|
88
|
+
*/
|
|
89
|
+
setClientApiKey({ apiKey }) {
|
|
90
|
+
if (!authMode || authMode === "WithinHeaders") {
|
|
91
|
+
transporter.baseHeaders["x-algolia-api-key"] = apiKey;
|
|
92
|
+
} else {
|
|
93
|
+
transporter.baseQueryParameters["x-algolia-api-key"] = apiKey;
|
|
94
|
+
}
|
|
95
|
+
},
|
|
82
96
|
/**
|
|
83
97
|
* Creates a new authentication resource.
|
|
84
98
|
*
|
|
85
99
|
* Required API Key ACLs:
|
|
86
|
-
*
|
|
87
|
-
*
|
|
88
|
-
*
|
|
89
|
-
*
|
|
90
|
-
* @param authenticationCreate -.
|
|
100
|
+
* - addObject
|
|
101
|
+
* - deleteIndex
|
|
102
|
+
* - editSettings
|
|
103
|
+
* @param authenticationCreate -
|
|
91
104
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
92
105
|
*/
|
|
93
106
|
createAuthentication(authenticationCreate, requestOptions) {
|
|
@@ -119,11 +132,10 @@ function createIngestionClient({
|
|
|
119
132
|
* Creates a new destination.
|
|
120
133
|
*
|
|
121
134
|
* Required API Key ACLs:
|
|
122
|
-
*
|
|
123
|
-
*
|
|
124
|
-
*
|
|
125
|
-
*
|
|
126
|
-
* @param destinationCreate -.
|
|
135
|
+
* - addObject
|
|
136
|
+
* - deleteIndex
|
|
137
|
+
* - editSettings
|
|
138
|
+
* @param destinationCreate -
|
|
127
139
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
128
140
|
*/
|
|
129
141
|
createDestination(destinationCreate, requestOptions) {
|
|
@@ -155,11 +167,10 @@ function createIngestionClient({
|
|
|
155
167
|
* Creates a new source.
|
|
156
168
|
*
|
|
157
169
|
* Required API Key ACLs:
|
|
158
|
-
*
|
|
159
|
-
*
|
|
160
|
-
*
|
|
161
|
-
*
|
|
162
|
-
* @param sourceCreate -.
|
|
170
|
+
* - addObject
|
|
171
|
+
* - deleteIndex
|
|
172
|
+
* - editSettings
|
|
173
|
+
* @param sourceCreate -
|
|
163
174
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
164
175
|
*/
|
|
165
176
|
createSource(sourceCreate, requestOptions) {
|
|
@@ -186,7 +197,6 @@ function createIngestionClient({
|
|
|
186
197
|
},
|
|
187
198
|
/**
|
|
188
199
|
* Creates a new task.
|
|
189
|
-
*
|
|
190
200
|
* @param taskCreate - Request body for creating a task.
|
|
191
201
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
192
202
|
*/
|
|
@@ -217,7 +227,6 @@ function createIngestionClient({
|
|
|
217
227
|
},
|
|
218
228
|
/**
|
|
219
229
|
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
220
|
-
*
|
|
221
230
|
* @param taskCreate - Request body for creating a task.
|
|
222
231
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
223
232
|
*/
|
|
@@ -251,7 +260,6 @@ function createIngestionClient({
|
|
|
251
260
|
},
|
|
252
261
|
/**
|
|
253
262
|
* Creates a new transformation.
|
|
254
|
-
*
|
|
255
263
|
* @param transformationCreate - Request body for creating a transformation.
|
|
256
264
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
257
265
|
*/
|
|
@@ -279,7 +287,6 @@ function createIngestionClient({
|
|
|
279
287
|
},
|
|
280
288
|
/**
|
|
281
289
|
* This method allow you to send requests to the Algolia REST API.
|
|
282
|
-
*
|
|
283
290
|
* @param customDelete - The customDelete object.
|
|
284
291
|
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
285
292
|
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
@@ -302,7 +309,6 @@ function createIngestionClient({
|
|
|
302
309
|
},
|
|
303
310
|
/**
|
|
304
311
|
* This method allow you to send requests to the Algolia REST API.
|
|
305
|
-
*
|
|
306
312
|
* @param customGet - The customGet object.
|
|
307
313
|
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
308
314
|
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
@@ -325,7 +331,6 @@ function createIngestionClient({
|
|
|
325
331
|
},
|
|
326
332
|
/**
|
|
327
333
|
* This method allow you to send requests to the Algolia REST API.
|
|
328
|
-
*
|
|
329
334
|
* @param customPost - The customPost object.
|
|
330
335
|
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
331
336
|
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
@@ -350,7 +355,6 @@ function createIngestionClient({
|
|
|
350
355
|
},
|
|
351
356
|
/**
|
|
352
357
|
* This method allow you to send requests to the Algolia REST API.
|
|
353
|
-
*
|
|
354
358
|
* @param customPut - The customPut object.
|
|
355
359
|
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
356
360
|
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
@@ -377,10 +381,9 @@ function createIngestionClient({
|
|
|
377
381
|
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
378
382
|
*
|
|
379
383
|
* Required API Key ACLs:
|
|
380
|
-
*
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
+
* - addObject
|
|
385
|
+
* - deleteIndex
|
|
386
|
+
* - editSettings
|
|
384
387
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
385
388
|
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
386
389
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -407,10 +410,9 @@ function createIngestionClient({
|
|
|
407
410
|
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
408
411
|
*
|
|
409
412
|
* Required API Key ACLs:
|
|
410
|
-
*
|
|
411
|
-
*
|
|
412
|
-
*
|
|
413
|
-
*
|
|
413
|
+
* - addObject
|
|
414
|
+
* - deleteIndex
|
|
415
|
+
* - editSettings
|
|
414
416
|
* @param deleteDestination - The deleteDestination object.
|
|
415
417
|
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
416
418
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -437,10 +439,9 @@ function createIngestionClient({
|
|
|
437
439
|
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
438
440
|
*
|
|
439
441
|
* Required API Key ACLs:
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
*
|
|
443
|
-
*
|
|
442
|
+
* - addObject
|
|
443
|
+
* - deleteIndex
|
|
444
|
+
* - editSettings
|
|
444
445
|
* @param deleteSource - The deleteSource object.
|
|
445
446
|
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
446
447
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -462,7 +463,6 @@ function createIngestionClient({
|
|
|
462
463
|
},
|
|
463
464
|
/**
|
|
464
465
|
* Deletes a task by its ID.
|
|
465
|
-
*
|
|
466
466
|
* @param deleteTask - The deleteTask object.
|
|
467
467
|
* @param deleteTask.taskID - Unique identifier of a task.
|
|
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 using the v1 endpoint, please use `deleteTask` instead.
|
|
487
|
-
*
|
|
488
487
|
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
489
488
|
* @param deleteTaskV1.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 transformation by its ID.
|
|
509
|
-
*
|
|
510
508
|
* @param deleteTransformation - The deleteTransformation object.
|
|
511
509
|
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
512
510
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -533,10 +531,9 @@ function createIngestionClient({
|
|
|
533
531
|
* Disables a task.
|
|
534
532
|
*
|
|
535
533
|
* Required API Key ACLs:
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
539
|
-
*
|
|
534
|
+
* - addObject
|
|
535
|
+
* - deleteIndex
|
|
536
|
+
* - editSettings
|
|
540
537
|
* @param disableTask - The disableTask object.
|
|
541
538
|
* @param disableTask.taskID - Unique identifier of a task.
|
|
542
539
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -560,10 +557,9 @@ function createIngestionClient({
|
|
|
560
557
|
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
561
558
|
*
|
|
562
559
|
* Required API Key ACLs:
|
|
563
|
-
*
|
|
564
|
-
*
|
|
565
|
-
*
|
|
566
|
-
*
|
|
560
|
+
* - addObject
|
|
561
|
+
* - deleteIndex
|
|
562
|
+
* - editSettings
|
|
567
563
|
* @param disableTaskV1 - The disableTaskV1 object.
|
|
568
564
|
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
569
565
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -587,10 +583,9 @@ function createIngestionClient({
|
|
|
587
583
|
* Enables a task.
|
|
588
584
|
*
|
|
589
585
|
* Required API Key ACLs:
|
|
590
|
-
*
|
|
591
|
-
*
|
|
592
|
-
*
|
|
593
|
-
*
|
|
586
|
+
* - addObject
|
|
587
|
+
* - deleteIndex
|
|
588
|
+
* - editSettings
|
|
594
589
|
* @param enableTask - The enableTask object.
|
|
595
590
|
* @param enableTask.taskID - Unique identifier of a task.
|
|
596
591
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -614,10 +609,9 @@ function createIngestionClient({
|
|
|
614
609
|
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
615
610
|
*
|
|
616
611
|
* Required API Key ACLs:
|
|
617
|
-
*
|
|
618
|
-
*
|
|
619
|
-
*
|
|
620
|
-
*
|
|
612
|
+
* - addObject
|
|
613
|
+
* - deleteIndex
|
|
614
|
+
* - editSettings
|
|
621
615
|
* @param enableTaskV1 - The enableTaskV1 object.
|
|
622
616
|
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
623
617
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -637,53 +631,13 @@ function createIngestionClient({
|
|
|
637
631
|
};
|
|
638
632
|
return transporter.request(request, requestOptions);
|
|
639
633
|
},
|
|
640
|
-
/**
|
|
641
|
-
* Generates code for the selected model based on the given prompt.
|
|
642
|
-
*
|
|
643
|
-
* Required API Key ACLs:
|
|
644
|
-
* - addObject
|
|
645
|
-
* - deleteIndex
|
|
646
|
-
* - editSettings.
|
|
647
|
-
*
|
|
648
|
-
* @param generateTransformationCodePayload - The generateTransformationCodePayload object.
|
|
649
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
650
|
-
*/
|
|
651
|
-
generateTransformationCode(generateTransformationCodePayload, requestOptions) {
|
|
652
|
-
if (!generateTransformationCodePayload) {
|
|
653
|
-
throw new Error(
|
|
654
|
-
"Parameter `generateTransformationCodePayload` is required when calling `generateTransformationCode`."
|
|
655
|
-
);
|
|
656
|
-
}
|
|
657
|
-
if (!generateTransformationCodePayload.id) {
|
|
658
|
-
throw new Error(
|
|
659
|
-
"Parameter `generateTransformationCodePayload.id` is required when calling `generateTransformationCode`."
|
|
660
|
-
);
|
|
661
|
-
}
|
|
662
|
-
if (!generateTransformationCodePayload.userPrompt) {
|
|
663
|
-
throw new Error(
|
|
664
|
-
"Parameter `generateTransformationCodePayload.userPrompt` is required when calling `generateTransformationCode`."
|
|
665
|
-
);
|
|
666
|
-
}
|
|
667
|
-
const requestPath = "/1/transformations/models";
|
|
668
|
-
const headers = {};
|
|
669
|
-
const queryParameters = {};
|
|
670
|
-
const request = {
|
|
671
|
-
method: "POST",
|
|
672
|
-
path: requestPath,
|
|
673
|
-
queryParameters,
|
|
674
|
-
headers,
|
|
675
|
-
data: generateTransformationCodePayload
|
|
676
|
-
};
|
|
677
|
-
return transporter.request(request, requestOptions);
|
|
678
|
-
},
|
|
679
634
|
/**
|
|
680
635
|
* Retrieves an authentication resource by its ID.
|
|
681
636
|
*
|
|
682
637
|
* Required API Key ACLs:
|
|
683
|
-
*
|
|
684
|
-
*
|
|
685
|
-
*
|
|
686
|
-
*
|
|
638
|
+
* - addObject
|
|
639
|
+
* - deleteIndex
|
|
640
|
+
* - editSettings
|
|
687
641
|
* @param getAuthentication - The getAuthentication object.
|
|
688
642
|
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
689
643
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -710,10 +664,9 @@ function createIngestionClient({
|
|
|
710
664
|
* Retrieves a destination by its ID.
|
|
711
665
|
*
|
|
712
666
|
* Required API Key ACLs:
|
|
713
|
-
*
|
|
714
|
-
*
|
|
715
|
-
*
|
|
716
|
-
*
|
|
667
|
+
* - addObject
|
|
668
|
+
* - deleteIndex
|
|
669
|
+
* - editSettings
|
|
717
670
|
* @param getDestination - The getDestination object.
|
|
718
671
|
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
719
672
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -740,10 +693,9 @@ function createIngestionClient({
|
|
|
740
693
|
* Retrieves a single task run event by its ID.
|
|
741
694
|
*
|
|
742
695
|
* Required API Key ACLs:
|
|
743
|
-
*
|
|
744
|
-
*
|
|
745
|
-
*
|
|
746
|
-
*
|
|
696
|
+
* - addObject
|
|
697
|
+
* - deleteIndex
|
|
698
|
+
* - editSettings
|
|
747
699
|
* @param getEvent - The getEvent object.
|
|
748
700
|
* @param getEvent.runID - Unique identifier of a task run.
|
|
749
701
|
* @param getEvent.eventID - Unique identifier of an event.
|
|
@@ -771,10 +723,9 @@ function createIngestionClient({
|
|
|
771
723
|
* Retrieve a single task run by its ID.
|
|
772
724
|
*
|
|
773
725
|
* Required API Key ACLs:
|
|
774
|
-
*
|
|
775
|
-
*
|
|
776
|
-
*
|
|
777
|
-
*
|
|
726
|
+
* - addObject
|
|
727
|
+
* - deleteIndex
|
|
728
|
+
* - editSettings
|
|
778
729
|
* @param getRun - The getRun object.
|
|
779
730
|
* @param getRun.runID - Unique identifier of a task run.
|
|
780
731
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -798,10 +749,9 @@ function createIngestionClient({
|
|
|
798
749
|
* Retrieve a source by its ID.
|
|
799
750
|
*
|
|
800
751
|
* Required API Key ACLs:
|
|
801
|
-
*
|
|
802
|
-
*
|
|
803
|
-
*
|
|
804
|
-
*
|
|
752
|
+
* - addObject
|
|
753
|
+
* - deleteIndex
|
|
754
|
+
* - editSettings
|
|
805
755
|
* @param getSource - The getSource object.
|
|
806
756
|
* @param getSource.sourceID - Unique identifier of a source.
|
|
807
757
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -825,10 +775,9 @@ function createIngestionClient({
|
|
|
825
775
|
* Retrieves a task by its ID.
|
|
826
776
|
*
|
|
827
777
|
* Required API Key ACLs:
|
|
828
|
-
*
|
|
829
|
-
*
|
|
830
|
-
*
|
|
831
|
-
*
|
|
778
|
+
* - addObject
|
|
779
|
+
* - deleteIndex
|
|
780
|
+
* - editSettings
|
|
832
781
|
* @param getTask - The getTask object.
|
|
833
782
|
* @param getTask.taskID - Unique identifier of a task.
|
|
834
783
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -852,10 +801,9 @@ function createIngestionClient({
|
|
|
852
801
|
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
853
802
|
*
|
|
854
803
|
* Required API Key ACLs:
|
|
855
|
-
*
|
|
856
|
-
*
|
|
857
|
-
*
|
|
858
|
-
*
|
|
804
|
+
* - addObject
|
|
805
|
+
* - deleteIndex
|
|
806
|
+
* - editSettings
|
|
859
807
|
* @param getTaskV1 - The getTaskV1 object.
|
|
860
808
|
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
861
809
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -879,10 +827,9 @@ function createIngestionClient({
|
|
|
879
827
|
* Retrieves a transformation by its ID.
|
|
880
828
|
*
|
|
881
829
|
* Required API Key ACLs:
|
|
882
|
-
*
|
|
883
|
-
*
|
|
884
|
-
*
|
|
885
|
-
*
|
|
830
|
+
* - addObject
|
|
831
|
+
* - deleteIndex
|
|
832
|
+
* - editSettings
|
|
886
833
|
* @param getTransformation - The getTransformation object.
|
|
887
834
|
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
888
835
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -909,16 +856,15 @@ function createIngestionClient({
|
|
|
909
856
|
* Retrieves a list of all authentication resources.
|
|
910
857
|
*
|
|
911
858
|
* Required API Key ACLs:
|
|
912
|
-
*
|
|
913
|
-
*
|
|
914
|
-
*
|
|
915
|
-
*
|
|
859
|
+
* - addObject
|
|
860
|
+
* - deleteIndex
|
|
861
|
+
* - editSettings
|
|
916
862
|
* @param listAuthentications - The listAuthentications object.
|
|
917
863
|
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
918
864
|
* @param listAuthentications.page - Page number of the paginated API response.
|
|
919
865
|
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
920
|
-
* @param listAuthentications.platform - Ecommerce platform for which to retrieve
|
|
921
|
-
* @param listAuthentications.sort - Property by which to sort the list of
|
|
866
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
|
|
867
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentications.
|
|
922
868
|
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
923
869
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
924
870
|
*/
|
|
@@ -927,22 +873,22 @@ function createIngestionClient({
|
|
|
927
873
|
const headers = {};
|
|
928
874
|
const queryParameters = {};
|
|
929
875
|
if (itemsPerPage !== void 0) {
|
|
930
|
-
queryParameters
|
|
876
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
931
877
|
}
|
|
932
878
|
if (page !== void 0) {
|
|
933
|
-
queryParameters
|
|
879
|
+
queryParameters["page"] = page.toString();
|
|
934
880
|
}
|
|
935
881
|
if (type !== void 0) {
|
|
936
|
-
queryParameters
|
|
882
|
+
queryParameters["type"] = type.toString();
|
|
937
883
|
}
|
|
938
884
|
if (platform !== void 0) {
|
|
939
|
-
queryParameters
|
|
885
|
+
queryParameters["platform"] = platform.toString();
|
|
940
886
|
}
|
|
941
887
|
if (sort !== void 0) {
|
|
942
|
-
queryParameters
|
|
888
|
+
queryParameters["sort"] = sort.toString();
|
|
943
889
|
}
|
|
944
890
|
if (order !== void 0) {
|
|
945
|
-
queryParameters
|
|
891
|
+
queryParameters["order"] = order.toString();
|
|
946
892
|
}
|
|
947
893
|
const request = {
|
|
948
894
|
method: "GET",
|
|
@@ -956,40 +902,43 @@ function createIngestionClient({
|
|
|
956
902
|
* Retrieves a list of destinations.
|
|
957
903
|
*
|
|
958
904
|
* Required API Key ACLs:
|
|
959
|
-
*
|
|
960
|
-
*
|
|
961
|
-
*
|
|
962
|
-
*
|
|
905
|
+
* - addObject
|
|
906
|
+
* - deleteIndex
|
|
907
|
+
* - editSettings
|
|
963
908
|
* @param listDestinations - The listDestinations object.
|
|
964
909
|
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
965
910
|
* @param listDestinations.page - Page number of the paginated API response.
|
|
966
911
|
* @param listDestinations.type - Destination type.
|
|
967
912
|
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
913
|
+
* @param listDestinations.transformationID - Get the list of destinations used by a transformation.
|
|
968
914
|
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
969
915
|
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
970
916
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
971
917
|
*/
|
|
972
|
-
listDestinations({ itemsPerPage, page, type, authenticationID, sort, order } = {}, requestOptions = void 0) {
|
|
918
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order } = {}, requestOptions = void 0) {
|
|
973
919
|
const requestPath = "/1/destinations";
|
|
974
920
|
const headers = {};
|
|
975
921
|
const queryParameters = {};
|
|
976
922
|
if (itemsPerPage !== void 0) {
|
|
977
|
-
queryParameters
|
|
923
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
978
924
|
}
|
|
979
925
|
if (page !== void 0) {
|
|
980
|
-
queryParameters
|
|
926
|
+
queryParameters["page"] = page.toString();
|
|
981
927
|
}
|
|
982
928
|
if (type !== void 0) {
|
|
983
|
-
queryParameters
|
|
929
|
+
queryParameters["type"] = type.toString();
|
|
984
930
|
}
|
|
985
931
|
if (authenticationID !== void 0) {
|
|
986
|
-
queryParameters
|
|
932
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
933
|
+
}
|
|
934
|
+
if (transformationID !== void 0) {
|
|
935
|
+
queryParameters["transformationID"] = transformationID.toString();
|
|
987
936
|
}
|
|
988
937
|
if (sort !== void 0) {
|
|
989
|
-
queryParameters
|
|
938
|
+
queryParameters["sort"] = sort.toString();
|
|
990
939
|
}
|
|
991
940
|
if (order !== void 0) {
|
|
992
|
-
queryParameters
|
|
941
|
+
queryParameters["order"] = order.toString();
|
|
993
942
|
}
|
|
994
943
|
const request = {
|
|
995
944
|
method: "GET",
|
|
@@ -1000,13 +949,12 @@ function createIngestionClient({
|
|
|
1000
949
|
return transporter.request(request, requestOptions);
|
|
1001
950
|
},
|
|
1002
951
|
/**
|
|
1003
|
-
* Retrieves a list of events for a task run, identified by
|
|
952
|
+
* Retrieves a list of events for a task run, identified by its ID.
|
|
1004
953
|
*
|
|
1005
954
|
* Required API Key ACLs:
|
|
1006
|
-
*
|
|
1007
|
-
*
|
|
1008
|
-
*
|
|
1009
|
-
*
|
|
955
|
+
* - addObject
|
|
956
|
+
* - deleteIndex
|
|
957
|
+
* - editSettings
|
|
1010
958
|
* @param listEvents - The listEvents object.
|
|
1011
959
|
* @param listEvents.runID - Unique identifier of a task run.
|
|
1012
960
|
* @param listEvents.itemsPerPage - Number of items per page.
|
|
@@ -1027,28 +975,28 @@ function createIngestionClient({
|
|
|
1027
975
|
const headers = {};
|
|
1028
976
|
const queryParameters = {};
|
|
1029
977
|
if (itemsPerPage !== void 0) {
|
|
1030
|
-
queryParameters
|
|
978
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1031
979
|
}
|
|
1032
980
|
if (page !== void 0) {
|
|
1033
|
-
queryParameters
|
|
981
|
+
queryParameters["page"] = page.toString();
|
|
1034
982
|
}
|
|
1035
983
|
if (status !== void 0) {
|
|
1036
|
-
queryParameters
|
|
984
|
+
queryParameters["status"] = status.toString();
|
|
1037
985
|
}
|
|
1038
986
|
if (type !== void 0) {
|
|
1039
|
-
queryParameters
|
|
987
|
+
queryParameters["type"] = type.toString();
|
|
1040
988
|
}
|
|
1041
989
|
if (sort !== void 0) {
|
|
1042
|
-
queryParameters
|
|
990
|
+
queryParameters["sort"] = sort.toString();
|
|
1043
991
|
}
|
|
1044
992
|
if (order !== void 0) {
|
|
1045
|
-
queryParameters
|
|
993
|
+
queryParameters["order"] = order.toString();
|
|
1046
994
|
}
|
|
1047
995
|
if (startDate !== void 0) {
|
|
1048
|
-
queryParameters
|
|
996
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1049
997
|
}
|
|
1050
998
|
if (endDate !== void 0) {
|
|
1051
|
-
queryParameters
|
|
999
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1052
1000
|
}
|
|
1053
1001
|
const request = {
|
|
1054
1002
|
method: "GET",
|
|
@@ -1062,10 +1010,9 @@ function createIngestionClient({
|
|
|
1062
1010
|
* Retrieve a list of task runs.
|
|
1063
1011
|
*
|
|
1064
1012
|
* Required API Key ACLs:
|
|
1065
|
-
*
|
|
1066
|
-
*
|
|
1067
|
-
*
|
|
1068
|
-
*
|
|
1013
|
+
* - addObject
|
|
1014
|
+
* - deleteIndex
|
|
1015
|
+
* - editSettings
|
|
1069
1016
|
* @param listRuns - The listRuns object.
|
|
1070
1017
|
* @param listRuns.itemsPerPage - Number of items per page.
|
|
1071
1018
|
* @param listRuns.page - Page number of the paginated API response.
|
|
@@ -1083,31 +1030,31 @@ function createIngestionClient({
|
|
|
1083
1030
|
const headers = {};
|
|
1084
1031
|
const queryParameters = {};
|
|
1085
1032
|
if (itemsPerPage !== void 0) {
|
|
1086
|
-
queryParameters
|
|
1033
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1087
1034
|
}
|
|
1088
1035
|
if (page !== void 0) {
|
|
1089
|
-
queryParameters
|
|
1036
|
+
queryParameters["page"] = page.toString();
|
|
1090
1037
|
}
|
|
1091
1038
|
if (status !== void 0) {
|
|
1092
|
-
queryParameters
|
|
1039
|
+
queryParameters["status"] = status.toString();
|
|
1093
1040
|
}
|
|
1094
1041
|
if (type !== void 0) {
|
|
1095
|
-
queryParameters
|
|
1042
|
+
queryParameters["type"] = type.toString();
|
|
1096
1043
|
}
|
|
1097
1044
|
if (taskID !== void 0) {
|
|
1098
|
-
queryParameters
|
|
1045
|
+
queryParameters["taskID"] = taskID.toString();
|
|
1099
1046
|
}
|
|
1100
1047
|
if (sort !== void 0) {
|
|
1101
|
-
queryParameters
|
|
1048
|
+
queryParameters["sort"] = sort.toString();
|
|
1102
1049
|
}
|
|
1103
1050
|
if (order !== void 0) {
|
|
1104
|
-
queryParameters
|
|
1051
|
+
queryParameters["order"] = order.toString();
|
|
1105
1052
|
}
|
|
1106
1053
|
if (startDate !== void 0) {
|
|
1107
|
-
queryParameters
|
|
1054
|
+
queryParameters["startDate"] = startDate.toString();
|
|
1108
1055
|
}
|
|
1109
1056
|
if (endDate !== void 0) {
|
|
1110
|
-
queryParameters
|
|
1057
|
+
queryParameters["endDate"] = endDate.toString();
|
|
1111
1058
|
}
|
|
1112
1059
|
const request = {
|
|
1113
1060
|
method: "GET",
|
|
@@ -1121,15 +1068,14 @@ function createIngestionClient({
|
|
|
1121
1068
|
* Retrieves a list of sources.
|
|
1122
1069
|
*
|
|
1123
1070
|
* Required API Key ACLs:
|
|
1124
|
-
*
|
|
1125
|
-
*
|
|
1126
|
-
*
|
|
1127
|
-
*
|
|
1071
|
+
* - addObject
|
|
1072
|
+
* - deleteIndex
|
|
1073
|
+
* - editSettings
|
|
1128
1074
|
* @param listSources - The listSources object.
|
|
1129
1075
|
* @param listSources.itemsPerPage - Number of items per page.
|
|
1130
1076
|
* @param listSources.page - Page number of the paginated API response.
|
|
1131
1077
|
* @param listSources.type - Source type. Some sources require authentication.
|
|
1132
|
-
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication
|
|
1078
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
|
|
1133
1079
|
* @param listSources.sort - Property by which to sort the list of sources.
|
|
1134
1080
|
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
1135
1081
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1139,22 +1085,22 @@ function createIngestionClient({
|
|
|
1139
1085
|
const headers = {};
|
|
1140
1086
|
const queryParameters = {};
|
|
1141
1087
|
if (itemsPerPage !== void 0) {
|
|
1142
|
-
queryParameters
|
|
1088
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1143
1089
|
}
|
|
1144
1090
|
if (page !== void 0) {
|
|
1145
|
-
queryParameters
|
|
1091
|
+
queryParameters["page"] = page.toString();
|
|
1146
1092
|
}
|
|
1147
1093
|
if (type !== void 0) {
|
|
1148
|
-
queryParameters
|
|
1094
|
+
queryParameters["type"] = type.toString();
|
|
1149
1095
|
}
|
|
1150
1096
|
if (authenticationID !== void 0) {
|
|
1151
|
-
queryParameters
|
|
1097
|
+
queryParameters["authenticationID"] = authenticationID.toString();
|
|
1152
1098
|
}
|
|
1153
1099
|
if (sort !== void 0) {
|
|
1154
|
-
queryParameters
|
|
1100
|
+
queryParameters["sort"] = sort.toString();
|
|
1155
1101
|
}
|
|
1156
1102
|
if (order !== void 0) {
|
|
1157
|
-
queryParameters
|
|
1103
|
+
queryParameters["order"] = order.toString();
|
|
1158
1104
|
}
|
|
1159
1105
|
const request = {
|
|
1160
1106
|
method: "GET",
|
|
@@ -1168,10 +1114,9 @@ function createIngestionClient({
|
|
|
1168
1114
|
* Retrieves a list of tasks.
|
|
1169
1115
|
*
|
|
1170
1116
|
* Required API Key ACLs:
|
|
1171
|
-
*
|
|
1172
|
-
*
|
|
1173
|
-
*
|
|
1174
|
-
*
|
|
1117
|
+
* - addObject
|
|
1118
|
+
* - deleteIndex
|
|
1119
|
+
* - editSettings
|
|
1175
1120
|
* @param listTasks - The listTasks object.
|
|
1176
1121
|
* @param listTasks.itemsPerPage - Number of items per page.
|
|
1177
1122
|
* @param listTasks.page - Page number of the paginated API response.
|
|
@@ -1189,31 +1134,31 @@ function createIngestionClient({
|
|
|
1189
1134
|
const headers = {};
|
|
1190
1135
|
const queryParameters = {};
|
|
1191
1136
|
if (itemsPerPage !== void 0) {
|
|
1192
|
-
queryParameters
|
|
1137
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1193
1138
|
}
|
|
1194
1139
|
if (page !== void 0) {
|
|
1195
|
-
queryParameters
|
|
1140
|
+
queryParameters["page"] = page.toString();
|
|
1196
1141
|
}
|
|
1197
1142
|
if (action !== void 0) {
|
|
1198
|
-
queryParameters
|
|
1143
|
+
queryParameters["action"] = action.toString();
|
|
1199
1144
|
}
|
|
1200
1145
|
if (enabled !== void 0) {
|
|
1201
|
-
queryParameters
|
|
1146
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1202
1147
|
}
|
|
1203
1148
|
if (sourceID !== void 0) {
|
|
1204
|
-
queryParameters
|
|
1149
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1205
1150
|
}
|
|
1206
1151
|
if (destinationID !== void 0) {
|
|
1207
|
-
queryParameters
|
|
1152
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1208
1153
|
}
|
|
1209
1154
|
if (triggerType !== void 0) {
|
|
1210
|
-
queryParameters
|
|
1155
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1211
1156
|
}
|
|
1212
1157
|
if (sort !== void 0) {
|
|
1213
|
-
queryParameters
|
|
1158
|
+
queryParameters["sort"] = sort.toString();
|
|
1214
1159
|
}
|
|
1215
1160
|
if (order !== void 0) {
|
|
1216
|
-
queryParameters
|
|
1161
|
+
queryParameters["order"] = order.toString();
|
|
1217
1162
|
}
|
|
1218
1163
|
const request = {
|
|
1219
1164
|
method: "GET",
|
|
@@ -1227,10 +1172,9 @@ function createIngestionClient({
|
|
|
1227
1172
|
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
1228
1173
|
*
|
|
1229
1174
|
* Required API Key ACLs:
|
|
1230
|
-
*
|
|
1231
|
-
*
|
|
1232
|
-
*
|
|
1233
|
-
*
|
|
1175
|
+
* - addObject
|
|
1176
|
+
* - deleteIndex
|
|
1177
|
+
* - editSettings
|
|
1234
1178
|
* @param listTasksV1 - The listTasksV1 object.
|
|
1235
1179
|
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
1236
1180
|
* @param listTasksV1.page - Page number of the paginated API response.
|
|
@@ -1248,31 +1192,31 @@ function createIngestionClient({
|
|
|
1248
1192
|
const headers = {};
|
|
1249
1193
|
const queryParameters = {};
|
|
1250
1194
|
if (itemsPerPage !== void 0) {
|
|
1251
|
-
queryParameters
|
|
1195
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1252
1196
|
}
|
|
1253
1197
|
if (page !== void 0) {
|
|
1254
|
-
queryParameters
|
|
1198
|
+
queryParameters["page"] = page.toString();
|
|
1255
1199
|
}
|
|
1256
1200
|
if (action !== void 0) {
|
|
1257
|
-
queryParameters
|
|
1201
|
+
queryParameters["action"] = action.toString();
|
|
1258
1202
|
}
|
|
1259
1203
|
if (enabled !== void 0) {
|
|
1260
|
-
queryParameters
|
|
1204
|
+
queryParameters["enabled"] = enabled.toString();
|
|
1261
1205
|
}
|
|
1262
1206
|
if (sourceID !== void 0) {
|
|
1263
|
-
queryParameters
|
|
1207
|
+
queryParameters["sourceID"] = sourceID.toString();
|
|
1264
1208
|
}
|
|
1265
1209
|
if (destinationID !== void 0) {
|
|
1266
|
-
queryParameters
|
|
1210
|
+
queryParameters["destinationID"] = destinationID.toString();
|
|
1267
1211
|
}
|
|
1268
1212
|
if (triggerType !== void 0) {
|
|
1269
|
-
queryParameters
|
|
1213
|
+
queryParameters["triggerType"] = triggerType.toString();
|
|
1270
1214
|
}
|
|
1271
1215
|
if (sort !== void 0) {
|
|
1272
|
-
queryParameters
|
|
1216
|
+
queryParameters["sort"] = sort.toString();
|
|
1273
1217
|
}
|
|
1274
1218
|
if (order !== void 0) {
|
|
1275
|
-
queryParameters
|
|
1219
|
+
queryParameters["order"] = order.toString();
|
|
1276
1220
|
}
|
|
1277
1221
|
const request = {
|
|
1278
1222
|
method: "GET",
|
|
@@ -1282,40 +1226,17 @@ function createIngestionClient({
|
|
|
1282
1226
|
};
|
|
1283
1227
|
return transporter.request(request, requestOptions);
|
|
1284
1228
|
},
|
|
1285
|
-
/**
|
|
1286
|
-
* Retrieves a list of existing LLM transformation helpers.
|
|
1287
|
-
*
|
|
1288
|
-
* Required API Key ACLs:
|
|
1289
|
-
* - addObject
|
|
1290
|
-
* - deleteIndex
|
|
1291
|
-
* - editSettings.
|
|
1292
|
-
*
|
|
1293
|
-
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1294
|
-
*/
|
|
1295
|
-
listTransformationModels(requestOptions) {
|
|
1296
|
-
const requestPath = "/1/transformations/models";
|
|
1297
|
-
const headers = {};
|
|
1298
|
-
const queryParameters = {};
|
|
1299
|
-
const request = {
|
|
1300
|
-
method: "GET",
|
|
1301
|
-
path: requestPath,
|
|
1302
|
-
queryParameters,
|
|
1303
|
-
headers
|
|
1304
|
-
};
|
|
1305
|
-
return transporter.request(request, requestOptions);
|
|
1306
|
-
},
|
|
1307
1229
|
/**
|
|
1308
1230
|
* Retrieves a list of transformations.
|
|
1309
1231
|
*
|
|
1310
1232
|
* Required API Key ACLs:
|
|
1311
|
-
*
|
|
1312
|
-
*
|
|
1313
|
-
*
|
|
1314
|
-
*
|
|
1233
|
+
* - addObject
|
|
1234
|
+
* - deleteIndex
|
|
1235
|
+
* - editSettings
|
|
1315
1236
|
* @param listTransformations - The listTransformations object.
|
|
1316
1237
|
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
1317
1238
|
* @param listTransformations.page - Page number of the paginated API response.
|
|
1318
|
-
* @param listTransformations.sort - Property by which to sort the list.
|
|
1239
|
+
* @param listTransformations.sort - Property by which to sort the list of transformations.
|
|
1319
1240
|
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
1320
1241
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1321
1242
|
*/
|
|
@@ -1324,16 +1245,16 @@ function createIngestionClient({
|
|
|
1324
1245
|
const headers = {};
|
|
1325
1246
|
const queryParameters = {};
|
|
1326
1247
|
if (itemsPerPage !== void 0) {
|
|
1327
|
-
queryParameters
|
|
1248
|
+
queryParameters["itemsPerPage"] = itemsPerPage.toString();
|
|
1328
1249
|
}
|
|
1329
1250
|
if (page !== void 0) {
|
|
1330
|
-
queryParameters
|
|
1251
|
+
queryParameters["page"] = page.toString();
|
|
1331
1252
|
}
|
|
1332
1253
|
if (sort !== void 0) {
|
|
1333
|
-
queryParameters
|
|
1254
|
+
queryParameters["sort"] = sort.toString();
|
|
1334
1255
|
}
|
|
1335
1256
|
if (order !== void 0) {
|
|
1336
|
-
queryParameters
|
|
1257
|
+
queryParameters["order"] = order.toString();
|
|
1337
1258
|
}
|
|
1338
1259
|
const request = {
|
|
1339
1260
|
method: "GET",
|
|
@@ -1347,10 +1268,9 @@ function createIngestionClient({
|
|
|
1347
1268
|
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
1348
1269
|
*
|
|
1349
1270
|
* Required API Key ACLs:
|
|
1350
|
-
*
|
|
1351
|
-
*
|
|
1352
|
-
*
|
|
1353
|
-
*
|
|
1271
|
+
* - addObject
|
|
1272
|
+
* - deleteIndex
|
|
1273
|
+
* - editSettings
|
|
1354
1274
|
* @param pushTask - The pushTask object.
|
|
1355
1275
|
* @param pushTask.taskID - Unique identifier of a task.
|
|
1356
1276
|
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
@@ -1385,13 +1305,12 @@ function createIngestionClient({
|
|
|
1385
1305
|
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
1386
1306
|
*
|
|
1387
1307
|
* Required API Key ACLs:
|
|
1388
|
-
*
|
|
1389
|
-
*
|
|
1390
|
-
*
|
|
1391
|
-
*
|
|
1308
|
+
* - addObject
|
|
1309
|
+
* - deleteIndex
|
|
1310
|
+
* - editSettings
|
|
1392
1311
|
* @param runSource - The runSource object.
|
|
1393
1312
|
* @param runSource.sourceID - Unique identifier of a source.
|
|
1394
|
-
* @param runSource.runSourcePayload
|
|
1313
|
+
* @param runSource.runSourcePayload -
|
|
1395
1314
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1396
1315
|
*/
|
|
1397
1316
|
runSource({ sourceID, runSourcePayload }, requestOptions) {
|
|
@@ -1414,10 +1333,9 @@ function createIngestionClient({
|
|
|
1414
1333
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
1415
1334
|
*
|
|
1416
1335
|
* Required API Key ACLs:
|
|
1417
|
-
*
|
|
1418
|
-
*
|
|
1419
|
-
*
|
|
1420
|
-
*
|
|
1336
|
+
* - addObject
|
|
1337
|
+
* - deleteIndex
|
|
1338
|
+
* - editSettings
|
|
1421
1339
|
* @param runTask - The runTask object.
|
|
1422
1340
|
* @param runTask.taskID - Unique identifier of a task.
|
|
1423
1341
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1441,10 +1359,9 @@ function createIngestionClient({
|
|
|
1441
1359
|
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
1442
1360
|
*
|
|
1443
1361
|
* Required API Key ACLs:
|
|
1444
|
-
*
|
|
1445
|
-
*
|
|
1446
|
-
*
|
|
1447
|
-
*
|
|
1362
|
+
* - addObject
|
|
1363
|
+
* - deleteIndex
|
|
1364
|
+
* - editSettings
|
|
1448
1365
|
* @param runTaskV1 - The runTaskV1 object.
|
|
1449
1366
|
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
1450
1367
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1468,10 +1385,9 @@ function createIngestionClient({
|
|
|
1468
1385
|
* Searches for authentication resources.
|
|
1469
1386
|
*
|
|
1470
1387
|
* Required API Key ACLs:
|
|
1471
|
-
*
|
|
1472
|
-
*
|
|
1473
|
-
*
|
|
1474
|
-
*
|
|
1388
|
+
* - addObject
|
|
1389
|
+
* - deleteIndex
|
|
1390
|
+
* - editSettings
|
|
1475
1391
|
* @param authenticationSearch - The authenticationSearch object.
|
|
1476
1392
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1477
1393
|
*/
|
|
@@ -1500,10 +1416,9 @@ function createIngestionClient({
|
|
|
1500
1416
|
* Searches for destinations.
|
|
1501
1417
|
*
|
|
1502
1418
|
* Required API Key ACLs:
|
|
1503
|
-
*
|
|
1504
|
-
*
|
|
1505
|
-
*
|
|
1506
|
-
*
|
|
1419
|
+
* - addObject
|
|
1420
|
+
* - deleteIndex
|
|
1421
|
+
* - editSettings
|
|
1507
1422
|
* @param destinationSearch - The destinationSearch object.
|
|
1508
1423
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1509
1424
|
*/
|
|
@@ -1530,10 +1445,9 @@ function createIngestionClient({
|
|
|
1530
1445
|
* Searches for sources.
|
|
1531
1446
|
*
|
|
1532
1447
|
* Required API Key ACLs:
|
|
1533
|
-
*
|
|
1534
|
-
*
|
|
1535
|
-
*
|
|
1536
|
-
*
|
|
1448
|
+
* - addObject
|
|
1449
|
+
* - deleteIndex
|
|
1450
|
+
* - editSettings
|
|
1537
1451
|
* @param sourceSearch - The sourceSearch object.
|
|
1538
1452
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1539
1453
|
*/
|
|
@@ -1560,10 +1474,9 @@ function createIngestionClient({
|
|
|
1560
1474
|
* Searches for tasks.
|
|
1561
1475
|
*
|
|
1562
1476
|
* Required API Key ACLs:
|
|
1563
|
-
*
|
|
1564
|
-
*
|
|
1565
|
-
*
|
|
1566
|
-
*
|
|
1477
|
+
* - addObject
|
|
1478
|
+
* - deleteIndex
|
|
1479
|
+
* - editSettings
|
|
1567
1480
|
* @param taskSearch - The taskSearch object.
|
|
1568
1481
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1569
1482
|
*/
|
|
@@ -1590,10 +1503,9 @@ function createIngestionClient({
|
|
|
1590
1503
|
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
1591
1504
|
*
|
|
1592
1505
|
* Required API Key ACLs:
|
|
1593
|
-
*
|
|
1594
|
-
*
|
|
1595
|
-
*
|
|
1596
|
-
*
|
|
1506
|
+
* - addObject
|
|
1507
|
+
* - deleteIndex
|
|
1508
|
+
* - editSettings
|
|
1597
1509
|
* @param taskSearch - The taskSearch object.
|
|
1598
1510
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1599
1511
|
*/
|
|
@@ -1620,10 +1532,9 @@ function createIngestionClient({
|
|
|
1620
1532
|
* Searches for transformations.
|
|
1621
1533
|
*
|
|
1622
1534
|
* Required API Key ACLs:
|
|
1623
|
-
*
|
|
1624
|
-
*
|
|
1625
|
-
*
|
|
1626
|
-
*
|
|
1535
|
+
* - addObject
|
|
1536
|
+
* - deleteIndex
|
|
1537
|
+
* - editSettings
|
|
1627
1538
|
* @param transformationSearch - The transformationSearch object.
|
|
1628
1539
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1629
1540
|
*/
|
|
@@ -1652,10 +1563,9 @@ function createIngestionClient({
|
|
|
1652
1563
|
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1653
1564
|
*
|
|
1654
1565
|
* Required API Key ACLs:
|
|
1655
|
-
*
|
|
1656
|
-
*
|
|
1657
|
-
*
|
|
1658
|
-
*
|
|
1566
|
+
* - addObject
|
|
1567
|
+
* - deleteIndex
|
|
1568
|
+
* - editSettings
|
|
1659
1569
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1660
1570
|
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1661
1571
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
@@ -1679,10 +1589,9 @@ function createIngestionClient({
|
|
|
1679
1589
|
* Try a transformation before creating it.
|
|
1680
1590
|
*
|
|
1681
1591
|
* Required API Key ACLs:
|
|
1682
|
-
*
|
|
1683
|
-
*
|
|
1684
|
-
*
|
|
1685
|
-
*
|
|
1592
|
+
* - addObject
|
|
1593
|
+
* - deleteIndex
|
|
1594
|
+
* - editSettings
|
|
1686
1595
|
* @param transformationTry - The transformationTry object.
|
|
1687
1596
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1688
1597
|
*/
|
|
@@ -1712,10 +1621,9 @@ function createIngestionClient({
|
|
|
1712
1621
|
* Try a transformation before updating it.
|
|
1713
1622
|
*
|
|
1714
1623
|
* Required API Key ACLs:
|
|
1715
|
-
*
|
|
1716
|
-
*
|
|
1717
|
-
*
|
|
1718
|
-
*
|
|
1624
|
+
* - addObject
|
|
1625
|
+
* - deleteIndex
|
|
1626
|
+
* - editSettings
|
|
1719
1627
|
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
1720
1628
|
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
1721
1629
|
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
@@ -1755,10 +1663,9 @@ function createIngestionClient({
|
|
|
1755
1663
|
* Updates an authentication resource.
|
|
1756
1664
|
*
|
|
1757
1665
|
* Required API Key ACLs:
|
|
1758
|
-
*
|
|
1759
|
-
*
|
|
1760
|
-
*
|
|
1761
|
-
*
|
|
1666
|
+
* - addObject
|
|
1667
|
+
* - deleteIndex
|
|
1668
|
+
* - editSettings
|
|
1762
1669
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1763
1670
|
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1764
1671
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
@@ -1790,10 +1697,9 @@ function createIngestionClient({
|
|
|
1790
1697
|
* Updates the destination by its ID.
|
|
1791
1698
|
*
|
|
1792
1699
|
* Required API Key ACLs:
|
|
1793
|
-
*
|
|
1794
|
-
*
|
|
1795
|
-
*
|
|
1796
|
-
*
|
|
1700
|
+
* - addObject
|
|
1701
|
+
* - deleteIndex
|
|
1702
|
+
* - editSettings
|
|
1797
1703
|
* @param updateDestination - The updateDestination object.
|
|
1798
1704
|
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1799
1705
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
@@ -1825,10 +1731,9 @@ function createIngestionClient({
|
|
|
1825
1731
|
* Updates a source by its ID.
|
|
1826
1732
|
*
|
|
1827
1733
|
* Required API Key ACLs:
|
|
1828
|
-
*
|
|
1829
|
-
*
|
|
1830
|
-
*
|
|
1831
|
-
*
|
|
1734
|
+
* - addObject
|
|
1735
|
+
* - deleteIndex
|
|
1736
|
+
* - editSettings
|
|
1832
1737
|
* @param updateSource - The updateSource object.
|
|
1833
1738
|
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1834
1739
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
@@ -1855,7 +1760,6 @@ function createIngestionClient({
|
|
|
1855
1760
|
},
|
|
1856
1761
|
/**
|
|
1857
1762
|
* Updates a task by its ID.
|
|
1858
|
-
*
|
|
1859
1763
|
* @param updateTask - The updateTask object.
|
|
1860
1764
|
* @param updateTask.taskID - Unique identifier of a task.
|
|
1861
1765
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
@@ -1882,7 +1786,6 @@ function createIngestionClient({
|
|
|
1882
1786
|
},
|
|
1883
1787
|
/**
|
|
1884
1788
|
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
1885
|
-
*
|
|
1886
1789
|
* @param updateTaskV1 - The updateTaskV1 object.
|
|
1887
1790
|
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
1888
1791
|
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
@@ -1909,7 +1812,6 @@ function createIngestionClient({
|
|
|
1909
1812
|
},
|
|
1910
1813
|
/**
|
|
1911
1814
|
* Updates a transformation by its ID.
|
|
1912
|
-
*
|
|
1913
1815
|
* @param updateTransformation - The updateTransformation object.
|
|
1914
1816
|
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
1915
1817
|
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
@@ -1947,11 +1849,10 @@ function createIngestionClient({
|
|
|
1947
1849
|
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1948
1850
|
*
|
|
1949
1851
|
* Required API Key ACLs:
|
|
1950
|
-
*
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
1953
|
-
*
|
|
1954
|
-
* @param sourceCreate -.
|
|
1852
|
+
* - addObject
|
|
1853
|
+
* - deleteIndex
|
|
1854
|
+
* - editSettings
|
|
1855
|
+
* @param sourceCreate -
|
|
1955
1856
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1956
1857
|
*/
|
|
1957
1858
|
validateSource(sourceCreate, requestOptions = void 0) {
|
|
@@ -1971,10 +1872,9 @@ function createIngestionClient({
|
|
|
1971
1872
|
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
1972
1873
|
*
|
|
1973
1874
|
* Required API Key ACLs:
|
|
1974
|
-
*
|
|
1975
|
-
*
|
|
1976
|
-
*
|
|
1977
|
-
*
|
|
1875
|
+
* - addObject
|
|
1876
|
+
* - deleteIndex
|
|
1877
|
+
* - editSettings
|
|
1978
1878
|
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
1979
1879
|
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
1980
1880
|
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
@@ -2023,6 +1923,7 @@ function ingestionClient(appId, apiKey, region, options) {
|
|
|
2023
1923
|
read: DEFAULT_READ_TIMEOUT_NODE,
|
|
2024
1924
|
write: DEFAULT_WRITE_TIMEOUT_NODE
|
|
2025
1925
|
},
|
|
1926
|
+
logger: createNullLogger(),
|
|
2026
1927
|
requester: createHttpRequester(),
|
|
2027
1928
|
algoliaAgents: [{ segment: "Node.js", version: process.versions.node }],
|
|
2028
1929
|
responsesCache: createNullCache(),
|