@algolia/ingestion 1.0.0-alpha.83 → 1.0.0-alpha.85

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.
Files changed (237) hide show
  1. package/dist/ingestion.cjs +99 -99
  2. package/dist/ingestion.esm.browser.js +99 -99
  3. package/dist/ingestion.esm.node.js +99 -99
  4. package/dist/ingestion.umd.js +2 -2
  5. package/dist/model/actionType.d.ts +1 -1
  6. package/dist/model/authAPIKey.d.ts +4 -1
  7. package/dist/model/authAPIKey.d.ts.map +1 -1
  8. package/dist/model/authAPIKeyPartial.d.ts +4 -1
  9. package/dist/model/authAPIKeyPartial.d.ts.map +1 -1
  10. package/dist/model/authAlgolia.d.ts +5 -2
  11. package/dist/model/authAlgolia.d.ts.map +1 -1
  12. package/dist/model/authAlgoliaInsights.d.ts +14 -0
  13. package/dist/model/authAlgoliaInsights.d.ts.map +1 -0
  14. package/dist/model/authAlgoliaInsightsPartial.d.ts +14 -0
  15. package/dist/model/authAlgoliaInsightsPartial.d.ts.map +1 -0
  16. package/dist/model/authAlgoliaPartial.d.ts +5 -2
  17. package/dist/model/authAlgoliaPartial.d.ts.map +1 -1
  18. package/dist/model/authBasic.d.ts +7 -1
  19. package/dist/model/authBasic.d.ts.map +1 -1
  20. package/dist/model/authBasicPartial.d.ts +7 -1
  21. package/dist/model/authBasicPartial.d.ts.map +1 -1
  22. package/dist/model/authGoogleServiceAccount.d.ts +3 -3
  23. package/dist/model/authGoogleServiceAccountPartial.d.ts +3 -3
  24. package/dist/model/authInput.d.ts +2 -1
  25. package/dist/model/authInput.d.ts.map +1 -1
  26. package/dist/model/authInputPartial.d.ts +2 -1
  27. package/dist/model/authInputPartial.d.ts.map +1 -1
  28. package/dist/model/authOAuth.d.ts +8 -4
  29. package/dist/model/authOAuth.d.ts.map +1 -1
  30. package/dist/model/authOAuthPartial.d.ts +8 -4
  31. package/dist/model/authOAuthPartial.d.ts.map +1 -1
  32. package/dist/model/authentication.d.ts +5 -5
  33. package/dist/model/authenticationCreate.d.ts +2 -2
  34. package/dist/model/authenticationCreateResponse.d.ts +4 -4
  35. package/dist/model/authenticationSearch.d.ts +1 -1
  36. package/dist/model/authenticationSortKeys.d.ts +1 -1
  37. package/dist/model/authenticationType.d.ts +2 -2
  38. package/dist/model/authenticationType.d.ts.map +1 -1
  39. package/dist/model/authenticationUpdate.d.ts +2 -2
  40. package/dist/model/authenticationUpdateResponse.d.ts +4 -4
  41. package/dist/model/bigCommerceChannel.d.ts +2 -2
  42. package/dist/model/bigCommerceMetafield.d.ts +2 -2
  43. package/dist/model/clientMethodProps.d.ts +64 -64
  44. package/dist/model/commercetoolsCustomFields.d.ts +1 -1
  45. package/dist/model/deleteResponse.d.ts +1 -1
  46. package/dist/model/destination.d.ts +6 -6
  47. package/dist/model/destinationCreate.d.ts +3 -3
  48. package/dist/model/destinationCreateResponse.d.ts +4 -4
  49. package/dist/model/destinationIndexName.d.ts +2 -2
  50. package/dist/model/destinationIndexPrefix.d.ts +1 -1
  51. package/dist/model/destinationSearch.d.ts +1 -1
  52. package/dist/model/destinationSortKeys.d.ts +1 -1
  53. package/dist/model/destinationType.d.ts +2 -2
  54. package/dist/model/destinationType.d.ts.map +1 -1
  55. package/dist/model/destinationUpdate.d.ts +3 -3
  56. package/dist/model/destinationUpdateResponse.d.ts +4 -4
  57. package/dist/model/dockerImageType.d.ts +1 -1
  58. package/dist/model/dockerRegistry.d.ts +1 -1
  59. package/dist/model/dockerSourceDiscover.d.ts +2 -2
  60. package/dist/model/event.d.ts +3 -3
  61. package/dist/model/eventSortKeys.d.ts +1 -1
  62. package/dist/model/index.d.ts +3 -0
  63. package/dist/model/index.d.ts.map +1 -1
  64. package/dist/model/listTasksResponse.d.ts +1 -1
  65. package/dist/model/mappingFormatSchema.d.ts +5 -0
  66. package/dist/model/mappingFormatSchema.d.ts.map +1 -0
  67. package/dist/model/mappingInput.d.ts +3 -5
  68. package/dist/model/mappingInput.d.ts.map +1 -1
  69. package/dist/model/methodType.d.ts +3 -0
  70. package/dist/model/methodType.d.ts.map +1 -1
  71. package/dist/model/onDemandDateUtilsInput.d.ts +3 -3
  72. package/dist/model/onDemandTrigger.d.ts +2 -2
  73. package/dist/model/onDemandTriggerInput.d.ts +1 -1
  74. package/dist/model/onDemandTriggerType.d.ts +1 -1
  75. package/dist/model/orderKeys.d.ts +1 -1
  76. package/dist/model/pagination.d.ts +15 -0
  77. package/dist/model/pagination.d.ts.map +1 -1
  78. package/dist/model/platform.d.ts +2 -2
  79. package/dist/model/platform.d.ts.map +1 -1
  80. package/dist/model/platformNone.d.ts +1 -1
  81. package/dist/model/recordType.d.ts +1 -1
  82. package/dist/model/run.d.ts +7 -7
  83. package/dist/model/runOutcome.d.ts +3 -0
  84. package/dist/model/runOutcome.d.ts.map +1 -1
  85. package/dist/model/runReasonCode.d.ts +1 -1
  86. package/dist/model/runResponse.d.ts +3 -3
  87. package/dist/model/runSortKeys.d.ts +1 -1
  88. package/dist/model/runStatus.d.ts +3 -0
  89. package/dist/model/runStatus.d.ts.map +1 -1
  90. package/dist/model/runType.d.ts +3 -0
  91. package/dist/model/runType.d.ts.map +1 -1
  92. package/dist/model/scheduleDateUtilsInput.d.ts +2 -2
  93. package/dist/model/scheduleTrigger.d.ts +4 -4
  94. package/dist/model/scheduleTriggerInput.d.ts +2 -2
  95. package/dist/model/scheduleTriggerType.d.ts +1 -1
  96. package/dist/model/source.d.ts +4 -4
  97. package/dist/model/sourceBigCommerce.d.ts +1 -1
  98. package/dist/model/sourceBigQuery.d.ts +5 -5
  99. package/dist/model/sourceCSV.d.ts +3 -3
  100. package/dist/model/sourceCommercetools.d.ts +2 -2
  101. package/dist/model/sourceCreate.d.ts +4 -1
  102. package/dist/model/sourceCreate.d.ts.map +1 -1
  103. package/dist/model/sourceCreateResponse.d.ts +5 -2
  104. package/dist/model/sourceCreateResponse.d.ts.map +1 -1
  105. package/dist/model/sourceDocker.d.ts +3 -3
  106. package/dist/model/sourceGA4BigQueryExport.d.ts +3 -3
  107. package/dist/model/sourceJSON.d.ts +2 -2
  108. package/dist/model/sourceSortKeys.d.ts +1 -1
  109. package/dist/model/sourceType.d.ts +1 -1
  110. package/dist/model/sourceType.d.ts.map +1 -1
  111. package/dist/model/sourceUpdate.d.ts +4 -1
  112. package/dist/model/sourceUpdate.d.ts.map +1 -1
  113. package/dist/model/sourceUpdateCommercetools.d.ts +2 -5
  114. package/dist/model/sourceUpdateCommercetools.d.ts.map +1 -1
  115. package/dist/model/sourceUpdateDocker.d.ts +3 -3
  116. package/dist/model/sourceUpdateResponse.d.ts +5 -2
  117. package/dist/model/sourceUpdateResponse.d.ts.map +1 -1
  118. package/dist/model/streamingTrigger.d.ts +1 -1
  119. package/dist/model/streamingTriggerType.d.ts +1 -1
  120. package/dist/model/streamingUtilsInput.d.ts +1 -1
  121. package/dist/model/subscriptionTrigger.d.ts +1 -1
  122. package/dist/model/subscriptionTriggerType.d.ts +1 -1
  123. package/dist/model/task.d.ts +7 -7
  124. package/dist/model/taskCreate.d.ts +5 -5
  125. package/dist/model/taskCreateResponse.d.ts +3 -3
  126. package/dist/model/taskInput.d.ts +3 -0
  127. package/dist/model/taskInput.d.ts.map +1 -1
  128. package/dist/model/taskSortKeys.d.ts +1 -1
  129. package/dist/model/taskUpdate.d.ts +4 -4
  130. package/dist/model/taskUpdateResponse.d.ts +3 -3
  131. package/dist/model/trigger.d.ts +3 -0
  132. package/dist/model/trigger.d.ts.map +1 -1
  133. package/dist/model/triggerType.d.ts +1 -1
  134. package/dist/model/triggerUpdateInput.d.ts +2 -2
  135. package/dist/model/window.d.ts +3 -3
  136. package/dist/src/ingestionClient.d.ts +99 -99
  137. package/model/actionType.ts +1 -1
  138. package/model/authAPIKey.ts +4 -1
  139. package/model/authAPIKeyPartial.ts +4 -1
  140. package/model/authAlgolia.ts +5 -2
  141. package/model/authAlgoliaInsights.ts +16 -0
  142. package/model/authAlgoliaInsightsPartial.ts +16 -0
  143. package/model/authAlgoliaPartial.ts +5 -2
  144. package/model/authBasic.ts +7 -1
  145. package/model/authBasicPartial.ts +7 -1
  146. package/model/authGoogleServiceAccount.ts +3 -3
  147. package/model/authGoogleServiceAccountPartial.ts +3 -3
  148. package/model/authInput.ts +2 -0
  149. package/model/authInputPartial.ts +2 -0
  150. package/model/authOAuth.ts +9 -4
  151. package/model/authOAuthPartial.ts +9 -4
  152. package/model/authentication.ts +5 -5
  153. package/model/authenticationCreate.ts +2 -2
  154. package/model/authenticationCreateResponse.ts +4 -4
  155. package/model/authenticationSearch.ts +1 -1
  156. package/model/authenticationSortKeys.ts +1 -1
  157. package/model/authenticationType.ts +2 -1
  158. package/model/authenticationUpdate.ts +2 -2
  159. package/model/authenticationUpdateResponse.ts +4 -4
  160. package/model/bigCommerceChannel.ts +2 -2
  161. package/model/bigCommerceMetafield.ts +2 -2
  162. package/model/clientMethodProps.ts +64 -64
  163. package/model/commercetoolsCustomFields.ts +1 -1
  164. package/model/deleteResponse.ts +1 -1
  165. package/model/destination.ts +6 -6
  166. package/model/destinationCreate.ts +3 -3
  167. package/model/destinationCreateResponse.ts +4 -4
  168. package/model/destinationIndexName.ts +2 -2
  169. package/model/destinationIndexPrefix.ts +1 -1
  170. package/model/destinationSearch.ts +1 -1
  171. package/model/destinationSortKeys.ts +1 -1
  172. package/model/destinationType.ts +2 -2
  173. package/model/destinationUpdate.ts +3 -3
  174. package/model/destinationUpdateResponse.ts +4 -4
  175. package/model/dockerImageType.ts +1 -1
  176. package/model/dockerRegistry.ts +1 -1
  177. package/model/dockerSourceDiscover.ts +2 -2
  178. package/model/event.ts +3 -3
  179. package/model/eventSortKeys.ts +1 -1
  180. package/model/index.ts +3 -0
  181. package/model/listTasksResponse.ts +1 -1
  182. package/model/mappingFormatSchema.ts +6 -0
  183. package/model/mappingInput.ts +3 -5
  184. package/model/methodType.ts +3 -0
  185. package/model/onDemandDateUtilsInput.ts +3 -3
  186. package/model/onDemandTrigger.ts +2 -2
  187. package/model/onDemandTriggerInput.ts +1 -1
  188. package/model/onDemandTriggerType.ts +1 -1
  189. package/model/orderKeys.ts +1 -1
  190. package/model/pagination.ts +15 -0
  191. package/model/platform.ts +2 -2
  192. package/model/platformNone.ts +1 -1
  193. package/model/recordType.ts +1 -1
  194. package/model/run.ts +7 -7
  195. package/model/runOutcome.ts +3 -0
  196. package/model/runReasonCode.ts +1 -1
  197. package/model/runResponse.ts +3 -3
  198. package/model/runSortKeys.ts +1 -1
  199. package/model/runStatus.ts +3 -0
  200. package/model/runType.ts +3 -0
  201. package/model/scheduleDateUtilsInput.ts +2 -2
  202. package/model/scheduleTrigger.ts +4 -4
  203. package/model/scheduleTriggerInput.ts +2 -2
  204. package/model/scheduleTriggerType.ts +1 -1
  205. package/model/source.ts +4 -4
  206. package/model/sourceBigCommerce.ts +1 -1
  207. package/model/sourceBigQuery.ts +5 -5
  208. package/model/sourceCSV.ts +3 -3
  209. package/model/sourceCommercetools.ts +2 -2
  210. package/model/sourceCreate.ts +4 -1
  211. package/model/sourceCreateResponse.ts +5 -2
  212. package/model/sourceDocker.ts +3 -3
  213. package/model/sourceGA4BigQueryExport.ts +3 -3
  214. package/model/sourceJSON.ts +2 -2
  215. package/model/sourceSortKeys.ts +1 -1
  216. package/model/sourceType.ts +3 -1
  217. package/model/sourceUpdate.ts +4 -1
  218. package/model/sourceUpdateCommercetools.ts +2 -5
  219. package/model/sourceUpdateDocker.ts +3 -3
  220. package/model/sourceUpdateResponse.ts +5 -2
  221. package/model/streamingTrigger.ts +1 -1
  222. package/model/streamingTriggerType.ts +1 -1
  223. package/model/streamingUtilsInput.ts +1 -1
  224. package/model/subscriptionTrigger.ts +1 -1
  225. package/model/subscriptionTriggerType.ts +1 -1
  226. package/model/task.ts +7 -7
  227. package/model/taskCreate.ts +5 -5
  228. package/model/taskCreateResponse.ts +3 -3
  229. package/model/taskInput.ts +3 -0
  230. package/model/taskSortKeys.ts +1 -1
  231. package/model/taskUpdate.ts +4 -4
  232. package/model/taskUpdateResponse.ts +3 -3
  233. package/model/trigger.ts +3 -0
  234. package/model/triggerType.ts +1 -1
  235. package/model/triggerUpdateInput.ts +2 -2
  236. package/model/window.ts +3 -3
  237. package/package.json +7 -7
@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
4
4
  var requesterNodeHttp = require('@algolia/requester-node-http');
5
5
 
6
6
  // 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.
7
- const apiClientVersion = '1.0.0-alpha.83';
7
+ const apiClientVersion = '1.0.0-alpha.85';
8
8
  const REGIONS = ['eu', 'us'];
9
9
  function getDefaultHosts(region) {
10
10
  const url = 'data.{region}.algolia.com'.replace('{region}', region);
@@ -89,7 +89,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
89
89
  transporter.algoliaAgent.add({ segment, version });
90
90
  },
91
91
  /**
92
- * Create a authentication.
92
+ * Creates a new authentication resource.
93
93
  *
94
94
  * Required API Key ACLs:
95
95
  * - addObject
@@ -125,7 +125,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
125
125
  return transporter.request(request, requestOptions);
126
126
  },
127
127
  /**
128
- * Create a destination.
128
+ * Creates a new destination.
129
129
  *
130
130
  * Required API Key ACLs:
131
131
  * - addObject
@@ -161,7 +161,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
161
161
  return transporter.request(request, requestOptions);
162
162
  },
163
163
  /**
164
- * Create a source.
164
+ * Creates a new source.
165
165
  *
166
166
  * Required API Key ACLs:
167
167
  * - addObject
@@ -197,9 +197,9 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
197
197
  return transporter.request(request, requestOptions);
198
198
  },
199
199
  /**
200
- * Create a task.
200
+ * Creates a new task.
201
201
  *
202
- * @param taskCreate -.
202
+ * @param taskCreate - Request body for creating a task.
203
203
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
204
204
  */
205
205
  createTask(taskCreate, requestOptions) {
@@ -327,7 +327,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
327
327
  return transporter.request(request, requestOptions);
328
328
  },
329
329
  /**
330
- * Soft delete the authentication of the given authenticationID.
330
+ * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
331
331
  *
332
332
  * Required API Key ACLs:
333
333
  * - addObject
@@ -335,7 +335,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
335
335
  * - editSettings.
336
336
  *
337
337
  * @param deleteAuthentication - The deleteAuthentication object.
338
- * @param deleteAuthentication.authenticationID - The authentication UUID.
338
+ * @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
339
339
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
340
340
  */
341
341
  deleteAuthentication({ authenticationID }, requestOptions) {
@@ -354,7 +354,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
354
354
  return transporter.request(request, requestOptions);
355
355
  },
356
356
  /**
357
- * Soft delete the destination of the given destinationID.
357
+ * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
358
358
  *
359
359
  * Required API Key ACLs:
360
360
  * - addObject
@@ -362,7 +362,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
362
362
  * - editSettings.
363
363
  *
364
364
  * @param deleteDestination - The deleteDestination object.
365
- * @param deleteDestination.destinationID - The destination UUID.
365
+ * @param deleteDestination.destinationID - Unique identifier of a destination.
366
366
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
367
367
  */
368
368
  deleteDestination({ destinationID }, requestOptions) {
@@ -381,7 +381,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
381
381
  return transporter.request(request, requestOptions);
382
382
  },
383
383
  /**
384
- * Soft delete the source of the given sourceID.
384
+ * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
385
385
  *
386
386
  * Required API Key ACLs:
387
387
  * - addObject
@@ -389,7 +389,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
389
389
  * - editSettings.
390
390
  *
391
391
  * @param deleteSource - The deleteSource object.
392
- * @param deleteSource.sourceID - The source UUID.
392
+ * @param deleteSource.sourceID - Unique identifier of a source.
393
393
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
394
394
  */
395
395
  deleteSource({ sourceID }, requestOptions) {
@@ -408,10 +408,10 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
408
408
  return transporter.request(request, requestOptions);
409
409
  },
410
410
  /**
411
- * Soft delete the task of the given taskID.
411
+ * Deletes a task by its ID.
412
412
  *
413
413
  * @param deleteTask - The deleteTask object.
414
- * @param deleteTask.taskID - The task UUID.
414
+ * @param deleteTask.taskID - Unique identifier of a task.
415
415
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
416
416
  */
417
417
  deleteTask({ taskID }, requestOptions) {
@@ -430,7 +430,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
430
430
  return transporter.request(request, requestOptions);
431
431
  },
432
432
  /**
433
- * Disable the task of the given taskID.
433
+ * Disables a task.
434
434
  *
435
435
  * Required API Key ACLs:
436
436
  * - addObject
@@ -438,7 +438,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
438
438
  * - editSettings.
439
439
  *
440
440
  * @param disableTask - The disableTask object.
441
- * @param disableTask.taskID - The task UUID.
441
+ * @param disableTask.taskID - Unique identifier of a task.
442
442
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
443
443
  */
444
444
  disableTask({ taskID }, requestOptions) {
@@ -457,7 +457,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
457
457
  return transporter.request(request, requestOptions);
458
458
  },
459
459
  /**
460
- * Enable the task of the given taskID.
460
+ * Enables a task.
461
461
  *
462
462
  * Required API Key ACLs:
463
463
  * - addObject
@@ -465,7 +465,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
465
465
  * - editSettings.
466
466
  *
467
467
  * @param enableTask - The enableTask object.
468
- * @param enableTask.taskID - The task UUID.
468
+ * @param enableTask.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.
470
470
  */
471
471
  enableTask({ taskID }, requestOptions) {
@@ -484,7 +484,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
484
484
  return transporter.request(request, requestOptions);
485
485
  },
486
486
  /**
487
- * Get the authentication of the given authenticationID.
487
+ * Retrieves an authentication resource by its ID.
488
488
  *
489
489
  * Required API Key ACLs:
490
490
  * - addObject
@@ -492,7 +492,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
492
492
  * - editSettings.
493
493
  *
494
494
  * @param getAuthentication - The getAuthentication object.
495
- * @param getAuthentication.authenticationID - The authentication UUID.
495
+ * @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
496
496
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
497
497
  */
498
498
  getAuthentication({ authenticationID }, requestOptions) {
@@ -511,7 +511,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
511
511
  return transporter.request(request, requestOptions);
512
512
  },
513
513
  /**
514
- * Get a list of authentications for the given query parameters, with pagination details.
514
+ * Retrieves a list of all authentication resources.
515
515
  *
516
516
  * Required API Key ACLs:
517
517
  * - addObject
@@ -519,12 +519,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
519
519
  * - editSettings.
520
520
  *
521
521
  * @param getAuthentications - The getAuthentications object.
522
- * @param getAuthentications.itemsPerPage - The number of items per page to return.
523
- * @param getAuthentications.page - The page number to fetch, starting at 1.
524
- * @param getAuthentications.type - The type of the authentications to retrieve.
525
- * @param getAuthentications.platform - The platform of the authentications to retrieve.
526
- * @param getAuthentications.sort - The key by which the list should be sorted.
527
- * @param getAuthentications.order - The order of the returned list.
522
+ * @param getAuthentications.itemsPerPage - Number of items per page.
523
+ * @param getAuthentications.page - Page number of the paginated API response.
524
+ * @param getAuthentications.type - Type of authentication resource to retrieve.
525
+ * @param getAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
526
+ * @param getAuthentications.sort - Property by which to sort the list of authentication resources.
527
+ * @param getAuthentications.order - Sort order of the response, ascending or descending.
528
528
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
529
529
  */
530
530
  getAuthentications({ itemsPerPage, page, type, platform, sort, order, } = {}, requestOptions = undefined) {
@@ -558,7 +558,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
558
558
  return transporter.request(request, requestOptions);
559
559
  },
560
560
  /**
561
- * Get the destination of the given destinationID.
561
+ * Retrieves a destination by its ID.
562
562
  *
563
563
  * Required API Key ACLs:
564
564
  * - addObject
@@ -566,7 +566,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
566
566
  * - editSettings.
567
567
  *
568
568
  * @param getDestination - The getDestination object.
569
- * @param getDestination.destinationID - The destination UUID.
569
+ * @param getDestination.destinationID - Unique identifier of a destination.
570
570
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
571
571
  */
572
572
  getDestination({ destinationID }, requestOptions) {
@@ -585,7 +585,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
585
585
  return transporter.request(request, requestOptions);
586
586
  },
587
587
  /**
588
- * Get a list of destinations for the given query parameters, with pagination details.
588
+ * Retrieves a list of destinations.
589
589
  *
590
590
  * Required API Key ACLs:
591
591
  * - addObject
@@ -593,12 +593,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
593
593
  * - editSettings.
594
594
  *
595
595
  * @param getDestinations - The getDestinations object.
596
- * @param getDestinations.itemsPerPage - The number of items per page to return.
597
- * @param getDestinations.page - The page number to fetch, starting at 1.
598
- * @param getDestinations.type - The type of the destinations to retrive.
599
- * @param getDestinations.authenticationID - The authenticationIDs of the destinations to retrive.
600
- * @param getDestinations.sort - The key by which the list should be sorted.
601
- * @param getDestinations.order - The order of the returned list.
596
+ * @param getDestinations.itemsPerPage - Number of items per page.
597
+ * @param getDestinations.page - Page number of the paginated API response.
598
+ * @param getDestinations.type - Destination type.
599
+ * @param getDestinations.authenticationID - Authentication ID used by destinations.
600
+ * @param getDestinations.sort - Property by which to sort the destinations.
601
+ * @param getDestinations.order - Sort order of the response, ascending or descending.
602
602
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
603
603
  */
604
604
  getDestinations({ itemsPerPage, page, type, authenticationID, sort, order, } = {}, requestOptions = undefined) {
@@ -632,7 +632,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
632
632
  return transporter.request(request, requestOptions);
633
633
  },
634
634
  /**
635
- * Retrieve a stream listing for a given Singer specification compatible docker type source ID.
635
+ * Retrieves a stream listing for a source. Listing streams only works with sources with `type: docker` and `imageType: singer`.
636
636
  *
637
637
  * Required API Key ACLs:
638
638
  * - addObject
@@ -640,7 +640,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
640
640
  * - editSettings.
641
641
  *
642
642
  * @param getDockerSourceStreams - The getDockerSourceStreams object.
643
- * @param getDockerSourceStreams.sourceID - The source UUID.
643
+ * @param getDockerSourceStreams.sourceID - Unique identifier of a source.
644
644
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
645
645
  */
646
646
  getDockerSourceStreams({ sourceID }, requestOptions) {
@@ -659,7 +659,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
659
659
  return transporter.request(request, requestOptions);
660
660
  },
661
661
  /**
662
- * Get a single event for a specific runID.
662
+ * Retrieves a single task run event by its ID.
663
663
  *
664
664
  * Required API Key ACLs:
665
665
  * - addObject
@@ -667,8 +667,8 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
667
667
  * - editSettings.
668
668
  *
669
669
  * @param getEvent - The getEvent object.
670
- * @param getEvent.runID - The run UUID.
671
- * @param getEvent.eventID - The event UUID.
670
+ * @param getEvent.runID - Unique identifier of a task run.
671
+ * @param getEvent.eventID - Unique identifier of an event.
672
672
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
673
673
  */
674
674
  getEvent({ runID, eventID }, requestOptions) {
@@ -692,7 +692,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
692
692
  return transporter.request(request, requestOptions);
693
693
  },
694
694
  /**
695
- * Get a list of events associated to the given runID, for the given query parameters.
695
+ * Retrieves a list of events for a task run, identified by it\'s ID.
696
696
  *
697
697
  * Required API Key ACLs:
698
698
  * - addObject
@@ -700,15 +700,15 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
700
700
  * - editSettings.
701
701
  *
702
702
  * @param getEvents - The getEvents object.
703
- * @param getEvents.runID - The run UUID.
704
- * @param getEvents.itemsPerPage - The number of items per page to return.
705
- * @param getEvents.page - The page number to fetch, starting at 1.
706
- * @param getEvents.status - Filter the status of the events.
707
- * @param getEvents.type - Filter the type of the events.
708
- * @param getEvents.sort - The key by which the list should be sorted.
709
- * @param getEvents.order - The order of the returned list.
710
- * @param getEvents.startDate - The start date (in RFC3339 format) of the events fetching window. Defaults to \'now\'-3 hours if omitted.
711
- * @param getEvents.endDate - The end date (in RFC3339 format) of the events fetching window. Defaults to \'now\' days if omitted.
703
+ * @param getEvents.runID - Unique identifier of a task run.
704
+ * @param getEvents.itemsPerPage - Number of items per page.
705
+ * @param getEvents.page - Page number of the paginated API response.
706
+ * @param getEvents.status - Event status for filtering the list of task runs.
707
+ * @param getEvents.type - Event type for filtering the list of task runs.
708
+ * @param getEvents.sort - Property by which to sort the list of task run events.
709
+ * @param getEvents.order - Sort order of the response, ascending or descending.
710
+ * @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.
711
+ * @param getEvents.endDate - Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
712
712
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
713
713
  */
714
714
  getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }, requestOptions) {
@@ -751,7 +751,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
751
751
  return transporter.request(request, requestOptions);
752
752
  },
753
753
  /**
754
- * Get a single run for the given ID.
754
+ * Retrieve a single task run by its ID.
755
755
  *
756
756
  * Required API Key ACLs:
757
757
  * - addObject
@@ -759,7 +759,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
759
759
  * - editSettings.
760
760
  *
761
761
  * @param getRun - The getRun object.
762
- * @param getRun.runID - The run UUID.
762
+ * @param getRun.runID - Unique identifier of a task run.
763
763
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
764
764
  */
765
765
  getRun({ runID }, requestOptions) {
@@ -778,7 +778,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
778
778
  return transporter.request(request, requestOptions);
779
779
  },
780
780
  /**
781
- * Get a list of runs for the given query parameters, with pagination details.
781
+ * Retrieve a list of task runs.
782
782
  *
783
783
  * Required API Key ACLs:
784
784
  * - addObject
@@ -786,14 +786,14 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
786
786
  * - editSettings.
787
787
  *
788
788
  * @param getRuns - The getRuns object.
789
- * @param getRuns.itemsPerPage - The number of items per page to return.
790
- * @param getRuns.page - The page number to fetch, starting at 1.
791
- * @param getRuns.status - Filter the status of the runs.
792
- * @param getRuns.taskID - Filter by taskID.
793
- * @param getRuns.sort - The key by which the list should be sorted.
794
- * @param getRuns.order - The order of the returned list.
795
- * @param getRuns.startDate - The start date (in RFC3339 format) of the runs fetching window. Defaults to \'now\'-7 days if omitted.
796
- * @param getRuns.endDate - The end date (in RFC3339 format) of the runs fetching window. Defaults to \'now\' days if omitted.
789
+ * @param getRuns.itemsPerPage - Number of items per page.
790
+ * @param getRuns.page - Page number of the paginated API response.
791
+ * @param getRuns.status - Run status for filtering the list of task runs.
792
+ * @param getRuns.taskID - Task ID for filtering the list of task runs.
793
+ * @param getRuns.sort - Property by which to sort the list of task runs.
794
+ * @param getRuns.order - Sort order of the response, ascending or descending.
795
+ * @param getRuns.startDate - Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
796
+ * @param getRuns.endDate - Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
797
797
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
798
798
  */
799
799
  getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, } = {}, requestOptions = undefined) {
@@ -833,7 +833,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
833
833
  return transporter.request(request, requestOptions);
834
834
  },
835
835
  /**
836
- * Get the source of the given sourceID.
836
+ * Retrieve a source by its ID.
837
837
  *
838
838
  * Required API Key ACLs:
839
839
  * - addObject
@@ -841,7 +841,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
841
841
  * - editSettings.
842
842
  *
843
843
  * @param getSource - The getSource object.
844
- * @param getSource.sourceID - The source UUID.
844
+ * @param getSource.sourceID - Unique identifier of a source.
845
845
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
846
846
  */
847
847
  getSource({ sourceID }, requestOptions) {
@@ -860,7 +860,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
860
860
  return transporter.request(request, requestOptions);
861
861
  },
862
862
  /**
863
- * Get a list of sources for the given query parameters, with pagination details.
863
+ * Retrieves a list of sources.
864
864
  *
865
865
  * Required API Key ACLs:
866
866
  * - addObject
@@ -868,12 +868,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
868
868
  * - editSettings.
869
869
  *
870
870
  * @param getSources - The getSources object.
871
- * @param getSources.itemsPerPage - The number of items per page to return.
872
- * @param getSources.page - The page number to fetch, starting at 1.
873
- * @param getSources.type - The type of the sources to retrieve.
874
- * @param getSources.authenticationID - The authenticationIDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
875
- * @param getSources.sort - The key by which the list should be sorted.
876
- * @param getSources.order - The order of the returned list.
871
+ * @param getSources.itemsPerPage - Number of items per page.
872
+ * @param getSources.page - Page number of the paginated API response.
873
+ * @param getSources.type - Source type. Some sources require authentication.
874
+ * @param getSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
875
+ * @param getSources.sort - Property by which to sort the list of sources.
876
+ * @param getSources.order - Sort order of the response, ascending or descending.
877
877
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
878
878
  */
879
879
  getSources({ itemsPerPage, page, type, authenticationID, sort, order, } = {}, requestOptions = undefined) {
@@ -907,7 +907,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
907
907
  return transporter.request(request, requestOptions);
908
908
  },
909
909
  /**
910
- * Get the task of the given taskID.
910
+ * Retrieves a task by its ID.
911
911
  *
912
912
  * Required API Key ACLs:
913
913
  * - addObject
@@ -915,7 +915,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
915
915
  * - editSettings.
916
916
  *
917
917
  * @param getTask - The getTask object.
918
- * @param getTask.taskID - The task UUID.
918
+ * @param getTask.taskID - Unique identifier of a task.
919
919
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
920
920
  */
921
921
  getTask({ taskID }, requestOptions) {
@@ -934,7 +934,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
934
934
  return transporter.request(request, requestOptions);
935
935
  },
936
936
  /**
937
- * Get a list of tasks for the given query parameters, with pagination details.
937
+ * Retrieves a list of tasks.
938
938
  *
939
939
  * Required API Key ACLs:
940
940
  * - addObject
@@ -942,15 +942,15 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
942
942
  * - editSettings.
943
943
  *
944
944
  * @param getTasks - The getTasks object.
945
- * @param getTasks.itemsPerPage - The number of items per page to return.
946
- * @param getTasks.page - The page number to fetch, starting at 1.
947
- * @param getTasks.action - The action of the tasks to retrieve.
948
- * @param getTasks.enabled - Whether the task is enabled or not.
949
- * @param getTasks.sourceID - The sourceIDs of the tasks to retrieve.
950
- * @param getTasks.destinationID - The destinationIDs of the tasks to retrieve.
951
- * @param getTasks.triggerType - The trigger type of the task.
952
- * @param getTasks.sort - The key by which the list should be sorted.
953
- * @param getTasks.order - The order of the returned list.
945
+ * @param getTasks.itemsPerPage - Number of items per page.
946
+ * @param getTasks.page - Page number of the paginated API response.
947
+ * @param getTasks.action - Actions for filtering the list of tasks.
948
+ * @param getTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
949
+ * @param getTasks.sourceID - Source IDs for filtering the list of tasks.
950
+ * @param getTasks.destinationID - Destination IDs for filtering the list of tasks.
951
+ * @param getTasks.triggerType - Type of task trigger for filtering the list of tasks.
952
+ * @param getTasks.sort - Property by which to sort the list of tasks.
953
+ * @param getTasks.order - Sort order of the response, ascending or descending.
954
954
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
955
955
  */
956
956
  getTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, } = {}, requestOptions = undefined) {
@@ -993,7 +993,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
993
993
  return transporter.request(request, requestOptions);
994
994
  },
995
995
  /**
996
- * Run the task of the given taskID.
996
+ * Runs a task. You can check the status of task runs with the observability endpoints.
997
997
  *
998
998
  * Required API Key ACLs:
999
999
  * - addObject
@@ -1001,7 +1001,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1001
1001
  * - editSettings.
1002
1002
  *
1003
1003
  * @param runTask - The runTask object.
1004
- * @param runTask.taskID - The task UUID.
1004
+ * @param runTask.taskID - Unique identifier of a task.
1005
1005
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1006
1006
  */
1007
1007
  runTask({ taskID }, requestOptions) {
@@ -1020,7 +1020,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1020
1020
  return transporter.request(request, requestOptions);
1021
1021
  },
1022
1022
  /**
1023
- * Search among authentications with a defined set of parameters.
1023
+ * Searches for authentication resources.
1024
1024
  *
1025
1025
  * Required API Key ACLs:
1026
1026
  * - addObject
@@ -1050,7 +1050,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1050
1050
  return transporter.request(request, requestOptions);
1051
1051
  },
1052
1052
  /**
1053
- * Search among destinations with a defined set of parameters.
1053
+ * Searches for destinations.
1054
1054
  *
1055
1055
  * Required API Key ACLs:
1056
1056
  * - addObject
@@ -1080,7 +1080,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1080
1080
  return transporter.request(request, requestOptions);
1081
1081
  },
1082
1082
  /**
1083
- * Search among sources with a defined set of parameters.
1083
+ * Searches for sources.
1084
1084
  *
1085
1085
  * Required API Key ACLs:
1086
1086
  * - addObject
@@ -1110,7 +1110,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1110
1110
  return transporter.request(request, requestOptions);
1111
1111
  },
1112
1112
  /**
1113
- * Search among tasks with a defined set of parameters.
1113
+ * Searches for tasks.
1114
1114
  *
1115
1115
  * Required API Key ACLs:
1116
1116
  * - addObject
@@ -1140,7 +1140,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1140
1140
  return transporter.request(request, requestOptions);
1141
1141
  },
1142
1142
  /**
1143
- * Trigger a stream listing request for a Singer specification compatible docker type source.
1143
+ * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
1144
1144
  *
1145
1145
  * Required API Key ACLs:
1146
1146
  * - addObject
@@ -1148,7 +1148,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1148
1148
  * - editSettings.
1149
1149
  *
1150
1150
  * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
1151
- * @param triggerDockerSourceDiscover.sourceID - The source UUID.
1151
+ * @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
1152
1152
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1153
1153
  */
1154
1154
  triggerDockerSourceDiscover({ sourceID }, requestOptions) {
@@ -1167,7 +1167,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1167
1167
  return transporter.request(request, requestOptions);
1168
1168
  },
1169
1169
  /**
1170
- * Update the authentication of the given authenticationID.
1170
+ * Updates an authentication resource.
1171
1171
  *
1172
1172
  * Required API Key ACLs:
1173
1173
  * - addObject
@@ -1175,7 +1175,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1175
1175
  * - editSettings.
1176
1176
  *
1177
1177
  * @param updateAuthentication - The updateAuthentication object.
1178
- * @param updateAuthentication.authenticationID - The authentication UUID.
1178
+ * @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
1179
1179
  * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
1180
1180
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1181
1181
  */
@@ -1199,7 +1199,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1199
1199
  return transporter.request(request, requestOptions);
1200
1200
  },
1201
1201
  /**
1202
- * Update the destination of the given destinationID.
1202
+ * Updates the destination by its ID.
1203
1203
  *
1204
1204
  * Required API Key ACLs:
1205
1205
  * - addObject
@@ -1207,7 +1207,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1207
1207
  * - editSettings.
1208
1208
  *
1209
1209
  * @param updateDestination - The updateDestination object.
1210
- * @param updateDestination.destinationID - The destination UUID.
1210
+ * @param updateDestination.destinationID - Unique identifier of a destination.
1211
1211
  * @param updateDestination.destinationUpdate - The destinationUpdate object.
1212
1212
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1213
1213
  */
@@ -1231,7 +1231,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1231
1231
  return transporter.request(request, requestOptions);
1232
1232
  },
1233
1233
  /**
1234
- * Update the source of the given sourceID.
1234
+ * Updates a source by its ID.
1235
1235
  *
1236
1236
  * Required API Key ACLs:
1237
1237
  * - addObject
@@ -1239,7 +1239,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1239
1239
  * - editSettings.
1240
1240
  *
1241
1241
  * @param updateSource - The updateSource object.
1242
- * @param updateSource.sourceID - The source UUID.
1242
+ * @param updateSource.sourceID - Unique identifier of a source.
1243
1243
  * @param updateSource.sourceUpdate - The sourceUpdate object.
1244
1244
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1245
1245
  */
@@ -1263,10 +1263,10 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1263
1263
  return transporter.request(request, requestOptions);
1264
1264
  },
1265
1265
  /**
1266
- * Update the task of the given taskID.
1266
+ * Updates a task by its ID.
1267
1267
  *
1268
1268
  * @param updateTask - The updateTask object.
1269
- * @param updateTask.taskID - The task UUID.
1269
+ * @param updateTask.taskID - Unique identifier of a task.
1270
1270
  * @param updateTask.taskUpdate - The taskUpdate object.
1271
1271
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1272
1272
  */