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