@algolia/ingestion 1.0.0-alpha.83 → 1.0.0-alpha.84
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/dist/ingestion.cjs +99 -99
- package/dist/ingestion.esm.browser.js +99 -99
- package/dist/ingestion.esm.node.js +99 -99
- package/dist/ingestion.umd.js +2 -2
- package/dist/model/actionType.d.ts +1 -1
- package/dist/model/authAPIKey.d.ts +4 -1
- package/dist/model/authAPIKey.d.ts.map +1 -1
- package/dist/model/authAPIKeyPartial.d.ts +4 -1
- package/dist/model/authAPIKeyPartial.d.ts.map +1 -1
- package/dist/model/authAlgolia.d.ts +5 -2
- package/dist/model/authAlgolia.d.ts.map +1 -1
- package/dist/model/authAlgoliaPartial.d.ts +5 -2
- package/dist/model/authAlgoliaPartial.d.ts.map +1 -1
- package/dist/model/authBasic.d.ts +7 -1
- package/dist/model/authBasic.d.ts.map +1 -1
- package/dist/model/authBasicPartial.d.ts +7 -1
- package/dist/model/authBasicPartial.d.ts.map +1 -1
- package/dist/model/authGoogleServiceAccount.d.ts +3 -3
- package/dist/model/authGoogleServiceAccountPartial.d.ts +3 -3
- package/dist/model/authOAuth.d.ts +8 -4
- package/dist/model/authOAuth.d.ts.map +1 -1
- package/dist/model/authOAuthPartial.d.ts +8 -4
- package/dist/model/authOAuthPartial.d.ts.map +1 -1
- package/dist/model/authentication.d.ts +5 -5
- package/dist/model/authenticationCreate.d.ts +2 -2
- package/dist/model/authenticationCreateResponse.d.ts +4 -4
- package/dist/model/authenticationSearch.d.ts +1 -1
- package/dist/model/authenticationSortKeys.d.ts +1 -1
- package/dist/model/authenticationType.d.ts +1 -1
- package/dist/model/authenticationUpdate.d.ts +2 -2
- package/dist/model/authenticationUpdateResponse.d.ts +4 -4
- package/dist/model/bigCommerceChannel.d.ts +2 -2
- package/dist/model/bigCommerceMetafield.d.ts +2 -2
- package/dist/model/clientMethodProps.d.ts +64 -64
- package/dist/model/commercetoolsCustomFields.d.ts +1 -1
- package/dist/model/deleteResponse.d.ts +1 -1
- package/dist/model/destination.d.ts +6 -6
- package/dist/model/destinationCreate.d.ts +3 -3
- package/dist/model/destinationCreateResponse.d.ts +4 -4
- package/dist/model/destinationIndexName.d.ts +2 -2
- package/dist/model/destinationIndexPrefix.d.ts +1 -1
- package/dist/model/destinationSearch.d.ts +1 -1
- package/dist/model/destinationSortKeys.d.ts +1 -1
- package/dist/model/destinationType.d.ts +2 -2
- package/dist/model/destinationType.d.ts.map +1 -1
- package/dist/model/destinationUpdate.d.ts +3 -3
- package/dist/model/destinationUpdateResponse.d.ts +4 -4
- package/dist/model/dockerImageType.d.ts +1 -1
- package/dist/model/dockerRegistry.d.ts +1 -1
- package/dist/model/dockerSourceDiscover.d.ts +2 -2
- package/dist/model/event.d.ts +3 -3
- package/dist/model/eventSortKeys.d.ts +1 -1
- package/dist/model/index.d.ts +1 -0
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/listTasksResponse.d.ts +1 -1
- package/dist/model/mappingFormatSchema.d.ts +5 -0
- package/dist/model/mappingFormatSchema.d.ts.map +1 -0
- package/dist/model/mappingInput.d.ts +3 -5
- package/dist/model/mappingInput.d.ts.map +1 -1
- package/dist/model/methodType.d.ts +3 -0
- package/dist/model/methodType.d.ts.map +1 -1
- package/dist/model/onDemandDateUtilsInput.d.ts +3 -3
- package/dist/model/onDemandTrigger.d.ts +2 -2
- package/dist/model/onDemandTriggerInput.d.ts +1 -1
- package/dist/model/onDemandTriggerType.d.ts +1 -1
- package/dist/model/orderKeys.d.ts +1 -1
- package/dist/model/pagination.d.ts +15 -0
- package/dist/model/pagination.d.ts.map +1 -1
- package/dist/model/platform.d.ts +2 -2
- package/dist/model/platform.d.ts.map +1 -1
- package/dist/model/platformNone.d.ts +1 -1
- package/dist/model/recordType.d.ts +1 -1
- package/dist/model/run.d.ts +7 -7
- package/dist/model/runOutcome.d.ts +3 -0
- package/dist/model/runOutcome.d.ts.map +1 -1
- package/dist/model/runReasonCode.d.ts +1 -1
- package/dist/model/runResponse.d.ts +3 -3
- package/dist/model/runSortKeys.d.ts +1 -1
- package/dist/model/runStatus.d.ts +3 -0
- package/dist/model/runStatus.d.ts.map +1 -1
- package/dist/model/runType.d.ts +3 -0
- package/dist/model/runType.d.ts.map +1 -1
- package/dist/model/scheduleDateUtilsInput.d.ts +2 -2
- package/dist/model/scheduleTrigger.d.ts +4 -4
- package/dist/model/scheduleTriggerInput.d.ts +2 -2
- package/dist/model/scheduleTriggerType.d.ts +1 -1
- package/dist/model/source.d.ts +4 -4
- package/dist/model/sourceBigCommerce.d.ts +1 -1
- package/dist/model/sourceBigQuery.d.ts +5 -5
- package/dist/model/sourceCSV.d.ts +3 -3
- package/dist/model/sourceCommercetools.d.ts +2 -2
- package/dist/model/sourceCreate.d.ts +4 -1
- package/dist/model/sourceCreate.d.ts.map +1 -1
- package/dist/model/sourceCreateResponse.d.ts +5 -2
- package/dist/model/sourceCreateResponse.d.ts.map +1 -1
- package/dist/model/sourceDocker.d.ts +3 -3
- package/dist/model/sourceGA4BigQueryExport.d.ts +3 -3
- package/dist/model/sourceJSON.d.ts +2 -2
- package/dist/model/sourceSortKeys.d.ts +1 -1
- package/dist/model/sourceType.d.ts +1 -1
- package/dist/model/sourceType.d.ts.map +1 -1
- package/dist/model/sourceUpdate.d.ts +4 -1
- package/dist/model/sourceUpdate.d.ts.map +1 -1
- package/dist/model/sourceUpdateCommercetools.d.ts +2 -5
- package/dist/model/sourceUpdateCommercetools.d.ts.map +1 -1
- package/dist/model/sourceUpdateDocker.d.ts +3 -3
- package/dist/model/sourceUpdateResponse.d.ts +5 -2
- package/dist/model/sourceUpdateResponse.d.ts.map +1 -1
- package/dist/model/streamingTrigger.d.ts +1 -1
- package/dist/model/streamingTriggerType.d.ts +1 -1
- package/dist/model/streamingUtilsInput.d.ts +1 -1
- package/dist/model/subscriptionTrigger.d.ts +1 -1
- package/dist/model/subscriptionTriggerType.d.ts +1 -1
- package/dist/model/task.d.ts +7 -7
- package/dist/model/taskCreate.d.ts +5 -5
- package/dist/model/taskCreateResponse.d.ts +3 -3
- package/dist/model/taskInput.d.ts +3 -0
- package/dist/model/taskInput.d.ts.map +1 -1
- package/dist/model/taskSortKeys.d.ts +1 -1
- package/dist/model/taskUpdate.d.ts +4 -4
- package/dist/model/taskUpdateResponse.d.ts +3 -3
- package/dist/model/trigger.d.ts +3 -0
- package/dist/model/trigger.d.ts.map +1 -1
- package/dist/model/triggerType.d.ts +1 -1
- package/dist/model/triggerUpdateInput.d.ts +2 -2
- package/dist/model/window.d.ts +3 -3
- package/dist/src/ingestionClient.d.ts +99 -99
- package/model/actionType.ts +1 -1
- package/model/authAPIKey.ts +4 -1
- package/model/authAPIKeyPartial.ts +4 -1
- package/model/authAlgolia.ts +5 -2
- package/model/authAlgoliaPartial.ts +5 -2
- package/model/authBasic.ts +7 -1
- package/model/authBasicPartial.ts +7 -1
- package/model/authGoogleServiceAccount.ts +3 -3
- package/model/authGoogleServiceAccountPartial.ts +3 -3
- package/model/authOAuth.ts +9 -4
- package/model/authOAuthPartial.ts +9 -4
- package/model/authentication.ts +5 -5
- package/model/authenticationCreate.ts +2 -2
- package/model/authenticationCreateResponse.ts +4 -4
- package/model/authenticationSearch.ts +1 -1
- package/model/authenticationSortKeys.ts +1 -1
- package/model/authenticationType.ts +1 -1
- package/model/authenticationUpdate.ts +2 -2
- package/model/authenticationUpdateResponse.ts +4 -4
- package/model/bigCommerceChannel.ts +2 -2
- package/model/bigCommerceMetafield.ts +2 -2
- package/model/clientMethodProps.ts +64 -64
- package/model/commercetoolsCustomFields.ts +1 -1
- package/model/deleteResponse.ts +1 -1
- package/model/destination.ts +6 -6
- package/model/destinationCreate.ts +3 -3
- package/model/destinationCreateResponse.ts +4 -4
- package/model/destinationIndexName.ts +2 -2
- package/model/destinationIndexPrefix.ts +1 -1
- package/model/destinationSearch.ts +1 -1
- package/model/destinationSortKeys.ts +1 -1
- package/model/destinationType.ts +2 -2
- package/model/destinationUpdate.ts +3 -3
- package/model/destinationUpdateResponse.ts +4 -4
- package/model/dockerImageType.ts +1 -1
- package/model/dockerRegistry.ts +1 -1
- package/model/dockerSourceDiscover.ts +2 -2
- package/model/event.ts +3 -3
- package/model/eventSortKeys.ts +1 -1
- package/model/index.ts +1 -0
- package/model/listTasksResponse.ts +1 -1
- package/model/mappingFormatSchema.ts +6 -0
- package/model/mappingInput.ts +3 -5
- package/model/methodType.ts +3 -0
- package/model/onDemandDateUtilsInput.ts +3 -3
- package/model/onDemandTrigger.ts +2 -2
- package/model/onDemandTriggerInput.ts +1 -1
- package/model/onDemandTriggerType.ts +1 -1
- package/model/orderKeys.ts +1 -1
- package/model/pagination.ts +15 -0
- package/model/platform.ts +2 -2
- package/model/platformNone.ts +1 -1
- package/model/recordType.ts +1 -1
- package/model/run.ts +7 -7
- package/model/runOutcome.ts +3 -0
- package/model/runReasonCode.ts +1 -1
- package/model/runResponse.ts +3 -3
- package/model/runSortKeys.ts +1 -1
- package/model/runStatus.ts +3 -0
- package/model/runType.ts +3 -0
- package/model/scheduleDateUtilsInput.ts +2 -2
- package/model/scheduleTrigger.ts +4 -4
- package/model/scheduleTriggerInput.ts +2 -2
- package/model/scheduleTriggerType.ts +1 -1
- package/model/source.ts +4 -4
- package/model/sourceBigCommerce.ts +1 -1
- package/model/sourceBigQuery.ts +5 -5
- package/model/sourceCSV.ts +3 -3
- package/model/sourceCommercetools.ts +2 -2
- package/model/sourceCreate.ts +4 -1
- package/model/sourceCreateResponse.ts +5 -2
- package/model/sourceDocker.ts +3 -3
- package/model/sourceGA4BigQueryExport.ts +3 -3
- package/model/sourceJSON.ts +2 -2
- package/model/sourceSortKeys.ts +1 -1
- package/model/sourceType.ts +3 -1
- package/model/sourceUpdate.ts +4 -1
- package/model/sourceUpdateCommercetools.ts +2 -5
- package/model/sourceUpdateDocker.ts +3 -3
- package/model/sourceUpdateResponse.ts +5 -2
- package/model/streamingTrigger.ts +1 -1
- package/model/streamingTriggerType.ts +1 -1
- package/model/streamingUtilsInput.ts +1 -1
- package/model/subscriptionTrigger.ts +1 -1
- package/model/subscriptionTriggerType.ts +1 -1
- package/model/task.ts +7 -7
- package/model/taskCreate.ts +5 -5
- package/model/taskCreateResponse.ts +3 -3
- package/model/taskInput.ts +3 -0
- package/model/taskSortKeys.ts +1 -1
- package/model/taskUpdate.ts +4 -4
- package/model/taskUpdateResponse.ts +3 -3
- package/model/trigger.ts +3 -0
- package/model/triggerType.ts +1 -1
- package/model/triggerUpdateInput.ts +2 -2
- package/model/window.ts +3 -3
- package/package.json +5 -5
|
@@ -2,7 +2,7 @@ import { createAuth, createTransporter, getAlgoliaAgent, DEFAULT_CONNECT_TIMEOUT
|
|
|
2
2
|
import { createHttpRequester } from '@algolia/requester-node-http';
|
|
3
3
|
|
|
4
4
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
5
|
-
const apiClientVersion = '1.0.0-alpha.
|
|
5
|
+
const apiClientVersion = '1.0.0-alpha.84';
|
|
6
6
|
const REGIONS = ['eu', 'us'];
|
|
7
7
|
function getDefaultHosts(region) {
|
|
8
8
|
const url = 'data.{region}.algolia.com'.replace('{region}', region);
|
|
@@ -87,7 +87,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
87
87
|
transporter.algoliaAgent.add({ segment, version });
|
|
88
88
|
},
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
* Creates a new authentication resource.
|
|
91
91
|
*
|
|
92
92
|
* Required API Key ACLs:
|
|
93
93
|
* - addObject
|
|
@@ -123,7 +123,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
123
123
|
return transporter.request(request, requestOptions);
|
|
124
124
|
},
|
|
125
125
|
/**
|
|
126
|
-
*
|
|
126
|
+
* Creates a new destination.
|
|
127
127
|
*
|
|
128
128
|
* Required API Key ACLs:
|
|
129
129
|
* - addObject
|
|
@@ -159,7 +159,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
159
159
|
return transporter.request(request, requestOptions);
|
|
160
160
|
},
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* Creates a new source.
|
|
163
163
|
*
|
|
164
164
|
* Required API Key ACLs:
|
|
165
165
|
* - addObject
|
|
@@ -195,9 +195,9 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
195
195
|
return transporter.request(request, requestOptions);
|
|
196
196
|
},
|
|
197
197
|
/**
|
|
198
|
-
*
|
|
198
|
+
* Creates a new task.
|
|
199
199
|
*
|
|
200
|
-
* @param taskCreate
|
|
200
|
+
* @param taskCreate - Request body for creating a task.
|
|
201
201
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
202
202
|
*/
|
|
203
203
|
createTask(taskCreate, requestOptions) {
|
|
@@ -325,7 +325,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
325
325
|
return transporter.request(request, requestOptions);
|
|
326
326
|
},
|
|
327
327
|
/**
|
|
328
|
-
*
|
|
328
|
+
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
329
329
|
*
|
|
330
330
|
* Required API Key ACLs:
|
|
331
331
|
* - addObject
|
|
@@ -333,7 +333,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
333
333
|
* - editSettings.
|
|
334
334
|
*
|
|
335
335
|
* @param deleteAuthentication - The deleteAuthentication object.
|
|
336
|
-
* @param deleteAuthentication.authenticationID -
|
|
336
|
+
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
337
337
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
338
338
|
*/
|
|
339
339
|
deleteAuthentication({ authenticationID }, requestOptions) {
|
|
@@ -352,7 +352,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
352
352
|
return transporter.request(request, requestOptions);
|
|
353
353
|
},
|
|
354
354
|
/**
|
|
355
|
-
*
|
|
355
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
356
356
|
*
|
|
357
357
|
* Required API Key ACLs:
|
|
358
358
|
* - addObject
|
|
@@ -360,7 +360,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
360
360
|
* - editSettings.
|
|
361
361
|
*
|
|
362
362
|
* @param deleteDestination - The deleteDestination object.
|
|
363
|
-
* @param deleteDestination.destinationID -
|
|
363
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
364
364
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
365
365
|
*/
|
|
366
366
|
deleteDestination({ destinationID }, requestOptions) {
|
|
@@ -379,7 +379,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
379
379
|
return transporter.request(request, requestOptions);
|
|
380
380
|
},
|
|
381
381
|
/**
|
|
382
|
-
*
|
|
382
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
383
383
|
*
|
|
384
384
|
* Required API Key ACLs:
|
|
385
385
|
* - addObject
|
|
@@ -387,7 +387,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
387
387
|
* - editSettings.
|
|
388
388
|
*
|
|
389
389
|
* @param deleteSource - The deleteSource object.
|
|
390
|
-
* @param deleteSource.sourceID -
|
|
390
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
391
391
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
392
392
|
*/
|
|
393
393
|
deleteSource({ sourceID }, requestOptions) {
|
|
@@ -406,10 +406,10 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
406
406
|
return transporter.request(request, requestOptions);
|
|
407
407
|
},
|
|
408
408
|
/**
|
|
409
|
-
*
|
|
409
|
+
* Deletes a task by its ID.
|
|
410
410
|
*
|
|
411
411
|
* @param deleteTask - The deleteTask object.
|
|
412
|
-
* @param deleteTask.taskID -
|
|
412
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
413
413
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
414
414
|
*/
|
|
415
415
|
deleteTask({ taskID }, requestOptions) {
|
|
@@ -428,7 +428,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
428
428
|
return transporter.request(request, requestOptions);
|
|
429
429
|
},
|
|
430
430
|
/**
|
|
431
|
-
*
|
|
431
|
+
* Disables a task.
|
|
432
432
|
*
|
|
433
433
|
* Required API Key ACLs:
|
|
434
434
|
* - addObject
|
|
@@ -436,7 +436,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
436
436
|
* - editSettings.
|
|
437
437
|
*
|
|
438
438
|
* @param disableTask - The disableTask object.
|
|
439
|
-
* @param disableTask.taskID -
|
|
439
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
440
440
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
441
441
|
*/
|
|
442
442
|
disableTask({ taskID }, requestOptions) {
|
|
@@ -455,7 +455,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
455
455
|
return transporter.request(request, requestOptions);
|
|
456
456
|
},
|
|
457
457
|
/**
|
|
458
|
-
*
|
|
458
|
+
* Enables a task.
|
|
459
459
|
*
|
|
460
460
|
* Required API Key ACLs:
|
|
461
461
|
* - addObject
|
|
@@ -463,7 +463,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
463
463
|
* - editSettings.
|
|
464
464
|
*
|
|
465
465
|
* @param enableTask - The enableTask object.
|
|
466
|
-
* @param enableTask.taskID -
|
|
466
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
467
467
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
468
468
|
*/
|
|
469
469
|
enableTask({ taskID }, requestOptions) {
|
|
@@ -482,7 +482,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
482
482
|
return transporter.request(request, requestOptions);
|
|
483
483
|
},
|
|
484
484
|
/**
|
|
485
|
-
*
|
|
485
|
+
* Retrieves an authentication resource by its ID.
|
|
486
486
|
*
|
|
487
487
|
* Required API Key ACLs:
|
|
488
488
|
* - addObject
|
|
@@ -490,7 +490,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
490
490
|
* - editSettings.
|
|
491
491
|
*
|
|
492
492
|
* @param getAuthentication - The getAuthentication object.
|
|
493
|
-
* @param getAuthentication.authenticationID -
|
|
493
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
494
494
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
495
495
|
*/
|
|
496
496
|
getAuthentication({ authenticationID }, requestOptions) {
|
|
@@ -509,7 +509,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
509
509
|
return transporter.request(request, requestOptions);
|
|
510
510
|
},
|
|
511
511
|
/**
|
|
512
|
-
*
|
|
512
|
+
* Retrieves a list of all authentication resources.
|
|
513
513
|
*
|
|
514
514
|
* Required API Key ACLs:
|
|
515
515
|
* - addObject
|
|
@@ -517,12 +517,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
517
517
|
* - editSettings.
|
|
518
518
|
*
|
|
519
519
|
* @param getAuthentications - The getAuthentications object.
|
|
520
|
-
* @param getAuthentications.itemsPerPage -
|
|
521
|
-
* @param getAuthentications.page -
|
|
522
|
-
* @param getAuthentications.type -
|
|
523
|
-
* @param getAuthentications.platform -
|
|
524
|
-
* @param getAuthentications.sort -
|
|
525
|
-
* @param getAuthentications.order -
|
|
520
|
+
* @param getAuthentications.itemsPerPage - Number of items per page.
|
|
521
|
+
* @param getAuthentications.page - Page number of the paginated API response.
|
|
522
|
+
* @param getAuthentications.type - Type of authentication resource to retrieve.
|
|
523
|
+
* @param getAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
|
|
524
|
+
* @param getAuthentications.sort - Property by which to sort the list of authentication resources.
|
|
525
|
+
* @param getAuthentications.order - Sort order of the response, ascending or descending.
|
|
526
526
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
527
527
|
*/
|
|
528
528
|
getAuthentications({ itemsPerPage, page, type, platform, sort, order, } = {}, requestOptions = undefined) {
|
|
@@ -556,7 +556,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
556
556
|
return transporter.request(request, requestOptions);
|
|
557
557
|
},
|
|
558
558
|
/**
|
|
559
|
-
*
|
|
559
|
+
* Retrieves a destination by its ID.
|
|
560
560
|
*
|
|
561
561
|
* Required API Key ACLs:
|
|
562
562
|
* - addObject
|
|
@@ -564,7 +564,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
564
564
|
* - editSettings.
|
|
565
565
|
*
|
|
566
566
|
* @param getDestination - The getDestination object.
|
|
567
|
-
* @param getDestination.destinationID -
|
|
567
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
568
568
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
569
569
|
*/
|
|
570
570
|
getDestination({ destinationID }, requestOptions) {
|
|
@@ -583,7 +583,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
583
583
|
return transporter.request(request, requestOptions);
|
|
584
584
|
},
|
|
585
585
|
/**
|
|
586
|
-
*
|
|
586
|
+
* Retrieves a list of destinations.
|
|
587
587
|
*
|
|
588
588
|
* Required API Key ACLs:
|
|
589
589
|
* - addObject
|
|
@@ -591,12 +591,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
591
591
|
* - editSettings.
|
|
592
592
|
*
|
|
593
593
|
* @param getDestinations - The getDestinations object.
|
|
594
|
-
* @param getDestinations.itemsPerPage -
|
|
595
|
-
* @param getDestinations.page -
|
|
596
|
-
* @param getDestinations.type -
|
|
597
|
-
* @param getDestinations.authenticationID -
|
|
598
|
-
* @param getDestinations.sort -
|
|
599
|
-
* @param getDestinations.order -
|
|
594
|
+
* @param getDestinations.itemsPerPage - Number of items per page.
|
|
595
|
+
* @param getDestinations.page - Page number of the paginated API response.
|
|
596
|
+
* @param getDestinations.type - Destination type.
|
|
597
|
+
* @param getDestinations.authenticationID - Authentication ID used by destinations.
|
|
598
|
+
* @param getDestinations.sort - Property by which to sort the destinations.
|
|
599
|
+
* @param getDestinations.order - Sort order of the response, ascending or descending.
|
|
600
600
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
601
601
|
*/
|
|
602
602
|
getDestinations({ itemsPerPage, page, type, authenticationID, sort, order, } = {}, requestOptions = undefined) {
|
|
@@ -630,7 +630,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
630
630
|
return transporter.request(request, requestOptions);
|
|
631
631
|
},
|
|
632
632
|
/**
|
|
633
|
-
*
|
|
633
|
+
* Retrieves a stream listing for a source. Listing streams only works with sources with `type: docker` and `imageType: singer`.
|
|
634
634
|
*
|
|
635
635
|
* Required API Key ACLs:
|
|
636
636
|
* - addObject
|
|
@@ -638,7 +638,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
638
638
|
* - editSettings.
|
|
639
639
|
*
|
|
640
640
|
* @param getDockerSourceStreams - The getDockerSourceStreams object.
|
|
641
|
-
* @param getDockerSourceStreams.sourceID -
|
|
641
|
+
* @param getDockerSourceStreams.sourceID - Unique identifier of a source.
|
|
642
642
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
643
643
|
*/
|
|
644
644
|
getDockerSourceStreams({ sourceID }, requestOptions) {
|
|
@@ -657,7 +657,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
657
657
|
return transporter.request(request, requestOptions);
|
|
658
658
|
},
|
|
659
659
|
/**
|
|
660
|
-
*
|
|
660
|
+
* Retrieves a single task run event by its ID.
|
|
661
661
|
*
|
|
662
662
|
* Required API Key ACLs:
|
|
663
663
|
* - addObject
|
|
@@ -665,8 +665,8 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
665
665
|
* - editSettings.
|
|
666
666
|
*
|
|
667
667
|
* @param getEvent - The getEvent object.
|
|
668
|
-
* @param getEvent.runID -
|
|
669
|
-
* @param getEvent.eventID -
|
|
668
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
669
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
670
670
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
671
671
|
*/
|
|
672
672
|
getEvent({ runID, eventID }, requestOptions) {
|
|
@@ -690,7 +690,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
690
690
|
return transporter.request(request, requestOptions);
|
|
691
691
|
},
|
|
692
692
|
/**
|
|
693
|
-
*
|
|
693
|
+
* Retrieves a list of events for a task run, identified by it\'s ID.
|
|
694
694
|
*
|
|
695
695
|
* Required API Key ACLs:
|
|
696
696
|
* - addObject
|
|
@@ -698,15 +698,15 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
698
698
|
* - editSettings.
|
|
699
699
|
*
|
|
700
700
|
* @param getEvents - The getEvents object.
|
|
701
|
-
* @param getEvents.runID -
|
|
702
|
-
* @param getEvents.itemsPerPage -
|
|
703
|
-
* @param getEvents.page -
|
|
704
|
-
* @param getEvents.status -
|
|
705
|
-
* @param getEvents.type -
|
|
706
|
-
* @param getEvents.sort -
|
|
707
|
-
* @param getEvents.order -
|
|
708
|
-
* @param getEvents.startDate -
|
|
709
|
-
* @param getEvents.endDate -
|
|
701
|
+
* @param getEvents.runID - Unique identifier of a task run.
|
|
702
|
+
* @param getEvents.itemsPerPage - Number of items per page.
|
|
703
|
+
* @param getEvents.page - Page number of the paginated API response.
|
|
704
|
+
* @param getEvents.status - Event status for filtering the list of task runs.
|
|
705
|
+
* @param getEvents.type - Event type for filtering the list of task runs.
|
|
706
|
+
* @param getEvents.sort - Property by which to sort the list of task run events.
|
|
707
|
+
* @param getEvents.order - Sort order of the response, ascending or descending.
|
|
708
|
+
* @param getEvents.startDate - Date and time in RFC3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
|
|
709
|
+
* @param getEvents.endDate - Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
|
|
710
710
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
711
711
|
*/
|
|
712
712
|
getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }, requestOptions) {
|
|
@@ -749,7 +749,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
749
749
|
return transporter.request(request, requestOptions);
|
|
750
750
|
},
|
|
751
751
|
/**
|
|
752
|
-
*
|
|
752
|
+
* Retrieve a single task run by its ID.
|
|
753
753
|
*
|
|
754
754
|
* Required API Key ACLs:
|
|
755
755
|
* - addObject
|
|
@@ -757,7 +757,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
757
757
|
* - editSettings.
|
|
758
758
|
*
|
|
759
759
|
* @param getRun - The getRun object.
|
|
760
|
-
* @param getRun.runID -
|
|
760
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
761
761
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
762
762
|
*/
|
|
763
763
|
getRun({ runID }, requestOptions) {
|
|
@@ -776,7 +776,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
776
776
|
return transporter.request(request, requestOptions);
|
|
777
777
|
},
|
|
778
778
|
/**
|
|
779
|
-
*
|
|
779
|
+
* Retrieve a list of task runs.
|
|
780
780
|
*
|
|
781
781
|
* Required API Key ACLs:
|
|
782
782
|
* - addObject
|
|
@@ -784,14 +784,14 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
784
784
|
* - editSettings.
|
|
785
785
|
*
|
|
786
786
|
* @param getRuns - The getRuns object.
|
|
787
|
-
* @param getRuns.itemsPerPage -
|
|
788
|
-
* @param getRuns.page -
|
|
789
|
-
* @param getRuns.status -
|
|
790
|
-
* @param getRuns.taskID -
|
|
791
|
-
* @param getRuns.sort -
|
|
792
|
-
* @param getRuns.order -
|
|
793
|
-
* @param getRuns.startDate -
|
|
794
|
-
* @param getRuns.endDate -
|
|
787
|
+
* @param getRuns.itemsPerPage - Number of items per page.
|
|
788
|
+
* @param getRuns.page - Page number of the paginated API response.
|
|
789
|
+
* @param getRuns.status - Run status for filtering the list of task runs.
|
|
790
|
+
* @param getRuns.taskID - Task ID for filtering the list of task runs.
|
|
791
|
+
* @param getRuns.sort - Property by which to sort the list of task runs.
|
|
792
|
+
* @param getRuns.order - Sort order of the response, ascending or descending.
|
|
793
|
+
* @param getRuns.startDate - Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
|
|
794
|
+
* @param getRuns.endDate - Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
|
|
795
795
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
796
796
|
*/
|
|
797
797
|
getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, } = {}, requestOptions = undefined) {
|
|
@@ -831,7 +831,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
831
831
|
return transporter.request(request, requestOptions);
|
|
832
832
|
},
|
|
833
833
|
/**
|
|
834
|
-
*
|
|
834
|
+
* Retrieve a source by its ID.
|
|
835
835
|
*
|
|
836
836
|
* Required API Key ACLs:
|
|
837
837
|
* - addObject
|
|
@@ -839,7 +839,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
839
839
|
* - editSettings.
|
|
840
840
|
*
|
|
841
841
|
* @param getSource - The getSource object.
|
|
842
|
-
* @param getSource.sourceID -
|
|
842
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
843
843
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
844
844
|
*/
|
|
845
845
|
getSource({ sourceID }, requestOptions) {
|
|
@@ -858,7 +858,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
858
858
|
return transporter.request(request, requestOptions);
|
|
859
859
|
},
|
|
860
860
|
/**
|
|
861
|
-
*
|
|
861
|
+
* Retrieves a list of sources.
|
|
862
862
|
*
|
|
863
863
|
* Required API Key ACLs:
|
|
864
864
|
* - addObject
|
|
@@ -866,12 +866,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
866
866
|
* - editSettings.
|
|
867
867
|
*
|
|
868
868
|
* @param getSources - The getSources object.
|
|
869
|
-
* @param getSources.itemsPerPage -
|
|
870
|
-
* @param getSources.page -
|
|
871
|
-
* @param getSources.type -
|
|
872
|
-
* @param getSources.authenticationID -
|
|
873
|
-
* @param getSources.sort -
|
|
874
|
-
* @param getSources.order -
|
|
869
|
+
* @param getSources.itemsPerPage - Number of items per page.
|
|
870
|
+
* @param getSources.page - Page number of the paginated API response.
|
|
871
|
+
* @param getSources.type - Source type. Some sources require authentication.
|
|
872
|
+
* @param getSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
|
|
873
|
+
* @param getSources.sort - Property by which to sort the list of sources.
|
|
874
|
+
* @param getSources.order - Sort order of the response, ascending or descending.
|
|
875
875
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
876
876
|
*/
|
|
877
877
|
getSources({ itemsPerPage, page, type, authenticationID, sort, order, } = {}, requestOptions = undefined) {
|
|
@@ -905,7 +905,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
905
905
|
return transporter.request(request, requestOptions);
|
|
906
906
|
},
|
|
907
907
|
/**
|
|
908
|
-
*
|
|
908
|
+
* Retrieves a task by its ID.
|
|
909
909
|
*
|
|
910
910
|
* Required API Key ACLs:
|
|
911
911
|
* - addObject
|
|
@@ -913,7 +913,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
913
913
|
* - editSettings.
|
|
914
914
|
*
|
|
915
915
|
* @param getTask - The getTask object.
|
|
916
|
-
* @param getTask.taskID -
|
|
916
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
917
917
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
918
918
|
*/
|
|
919
919
|
getTask({ taskID }, requestOptions) {
|
|
@@ -932,7 +932,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
932
932
|
return transporter.request(request, requestOptions);
|
|
933
933
|
},
|
|
934
934
|
/**
|
|
935
|
-
*
|
|
935
|
+
* Retrieves a list of tasks.
|
|
936
936
|
*
|
|
937
937
|
* Required API Key ACLs:
|
|
938
938
|
* - addObject
|
|
@@ -940,15 +940,15 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
940
940
|
* - editSettings.
|
|
941
941
|
*
|
|
942
942
|
* @param getTasks - The getTasks object.
|
|
943
|
-
* @param getTasks.itemsPerPage -
|
|
944
|
-
* @param getTasks.page -
|
|
945
|
-
* @param getTasks.action -
|
|
946
|
-
* @param getTasks.enabled - Whether the
|
|
947
|
-
* @param getTasks.sourceID -
|
|
948
|
-
* @param getTasks.destinationID -
|
|
949
|
-
* @param getTasks.triggerType -
|
|
950
|
-
* @param getTasks.sort -
|
|
951
|
-
* @param getTasks.order -
|
|
943
|
+
* @param getTasks.itemsPerPage - Number of items per page.
|
|
944
|
+
* @param getTasks.page - Page number of the paginated API response.
|
|
945
|
+
* @param getTasks.action - Actions for filtering the list of tasks.
|
|
946
|
+
* @param getTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
947
|
+
* @param getTasks.sourceID - Source IDs for filtering the list of tasks.
|
|
948
|
+
* @param getTasks.destinationID - Destination IDs for filtering the list of tasks.
|
|
949
|
+
* @param getTasks.triggerType - Type of task trigger for filtering the list of tasks.
|
|
950
|
+
* @param getTasks.sort - Property by which to sort the list of tasks.
|
|
951
|
+
* @param getTasks.order - Sort order of the response, ascending or descending.
|
|
952
952
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
953
953
|
*/
|
|
954
954
|
getTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, } = {}, requestOptions = undefined) {
|
|
@@ -991,7 +991,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
991
991
|
return transporter.request(request, requestOptions);
|
|
992
992
|
},
|
|
993
993
|
/**
|
|
994
|
-
*
|
|
994
|
+
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
995
995
|
*
|
|
996
996
|
* Required API Key ACLs:
|
|
997
997
|
* - addObject
|
|
@@ -999,7 +999,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
999
999
|
* - editSettings.
|
|
1000
1000
|
*
|
|
1001
1001
|
* @param runTask - The runTask object.
|
|
1002
|
-
* @param runTask.taskID -
|
|
1002
|
+
* @param runTask.taskID - Unique identifier of a task.
|
|
1003
1003
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1004
1004
|
*/
|
|
1005
1005
|
runTask({ taskID }, requestOptions) {
|
|
@@ -1018,7 +1018,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1018
1018
|
return transporter.request(request, requestOptions);
|
|
1019
1019
|
},
|
|
1020
1020
|
/**
|
|
1021
|
-
*
|
|
1021
|
+
* Searches for authentication resources.
|
|
1022
1022
|
*
|
|
1023
1023
|
* Required API Key ACLs:
|
|
1024
1024
|
* - addObject
|
|
@@ -1048,7 +1048,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1048
1048
|
return transporter.request(request, requestOptions);
|
|
1049
1049
|
},
|
|
1050
1050
|
/**
|
|
1051
|
-
*
|
|
1051
|
+
* Searches for destinations.
|
|
1052
1052
|
*
|
|
1053
1053
|
* Required API Key ACLs:
|
|
1054
1054
|
* - addObject
|
|
@@ -1078,7 +1078,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1078
1078
|
return transporter.request(request, requestOptions);
|
|
1079
1079
|
},
|
|
1080
1080
|
/**
|
|
1081
|
-
*
|
|
1081
|
+
* Searches for sources.
|
|
1082
1082
|
*
|
|
1083
1083
|
* Required API Key ACLs:
|
|
1084
1084
|
* - addObject
|
|
@@ -1108,7 +1108,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1108
1108
|
return transporter.request(request, requestOptions);
|
|
1109
1109
|
},
|
|
1110
1110
|
/**
|
|
1111
|
-
*
|
|
1111
|
+
* Searches for tasks.
|
|
1112
1112
|
*
|
|
1113
1113
|
* Required API Key ACLs:
|
|
1114
1114
|
* - addObject
|
|
@@ -1138,7 +1138,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1138
1138
|
return transporter.request(request, requestOptions);
|
|
1139
1139
|
},
|
|
1140
1140
|
/**
|
|
1141
|
-
*
|
|
1141
|
+
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
1142
1142
|
*
|
|
1143
1143
|
* Required API Key ACLs:
|
|
1144
1144
|
* - addObject
|
|
@@ -1146,7 +1146,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1146
1146
|
* - editSettings.
|
|
1147
1147
|
*
|
|
1148
1148
|
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
1149
|
-
* @param triggerDockerSourceDiscover.sourceID -
|
|
1149
|
+
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
1150
1150
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1151
1151
|
*/
|
|
1152
1152
|
triggerDockerSourceDiscover({ sourceID }, requestOptions) {
|
|
@@ -1165,7 +1165,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1165
1165
|
return transporter.request(request, requestOptions);
|
|
1166
1166
|
},
|
|
1167
1167
|
/**
|
|
1168
|
-
*
|
|
1168
|
+
* Updates an authentication resource.
|
|
1169
1169
|
*
|
|
1170
1170
|
* Required API Key ACLs:
|
|
1171
1171
|
* - addObject
|
|
@@ -1173,7 +1173,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1173
1173
|
* - editSettings.
|
|
1174
1174
|
*
|
|
1175
1175
|
* @param updateAuthentication - The updateAuthentication object.
|
|
1176
|
-
* @param updateAuthentication.authenticationID -
|
|
1176
|
+
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
1177
1177
|
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
1178
1178
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1179
1179
|
*/
|
|
@@ -1197,7 +1197,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1197
1197
|
return transporter.request(request, requestOptions);
|
|
1198
1198
|
},
|
|
1199
1199
|
/**
|
|
1200
|
-
*
|
|
1200
|
+
* Updates the destination by its ID.
|
|
1201
1201
|
*
|
|
1202
1202
|
* Required API Key ACLs:
|
|
1203
1203
|
* - addObject
|
|
@@ -1205,7 +1205,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1205
1205
|
* - editSettings.
|
|
1206
1206
|
*
|
|
1207
1207
|
* @param updateDestination - The updateDestination object.
|
|
1208
|
-
* @param updateDestination.destinationID -
|
|
1208
|
+
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
1209
1209
|
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
1210
1210
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1211
1211
|
*/
|
|
@@ -1229,7 +1229,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1229
1229
|
return transporter.request(request, requestOptions);
|
|
1230
1230
|
},
|
|
1231
1231
|
/**
|
|
1232
|
-
*
|
|
1232
|
+
* Updates a source by its ID.
|
|
1233
1233
|
*
|
|
1234
1234
|
* Required API Key ACLs:
|
|
1235
1235
|
* - addObject
|
|
@@ -1237,7 +1237,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1237
1237
|
* - editSettings.
|
|
1238
1238
|
*
|
|
1239
1239
|
* @param updateSource - The updateSource object.
|
|
1240
|
-
* @param updateSource.sourceID -
|
|
1240
|
+
* @param updateSource.sourceID - Unique identifier of a source.
|
|
1241
1241
|
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
1242
1242
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1243
1243
|
*/
|
|
@@ -1261,10 +1261,10 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
|
|
|
1261
1261
|
return transporter.request(request, requestOptions);
|
|
1262
1262
|
},
|
|
1263
1263
|
/**
|
|
1264
|
-
*
|
|
1264
|
+
* Updates a task by its ID.
|
|
1265
1265
|
*
|
|
1266
1266
|
* @param updateTask - The updateTask object.
|
|
1267
|
-
* @param updateTask.taskID -
|
|
1267
|
+
* @param updateTask.taskID - Unique identifier of a task.
|
|
1268
1268
|
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
1269
1269
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1270
1270
|
*/
|