@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.
Files changed (224) 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/authAlgoliaPartial.d.ts +5 -2
  13. package/dist/model/authAlgoliaPartial.d.ts.map +1 -1
  14. package/dist/model/authBasic.d.ts +7 -1
  15. package/dist/model/authBasic.d.ts.map +1 -1
  16. package/dist/model/authBasicPartial.d.ts +7 -1
  17. package/dist/model/authBasicPartial.d.ts.map +1 -1
  18. package/dist/model/authGoogleServiceAccount.d.ts +3 -3
  19. package/dist/model/authGoogleServiceAccountPartial.d.ts +3 -3
  20. package/dist/model/authOAuth.d.ts +8 -4
  21. package/dist/model/authOAuth.d.ts.map +1 -1
  22. package/dist/model/authOAuthPartial.d.ts +8 -4
  23. package/dist/model/authOAuthPartial.d.ts.map +1 -1
  24. package/dist/model/authentication.d.ts +5 -5
  25. package/dist/model/authenticationCreate.d.ts +2 -2
  26. package/dist/model/authenticationCreateResponse.d.ts +4 -4
  27. package/dist/model/authenticationSearch.d.ts +1 -1
  28. package/dist/model/authenticationSortKeys.d.ts +1 -1
  29. package/dist/model/authenticationType.d.ts +1 -1
  30. package/dist/model/authenticationUpdate.d.ts +2 -2
  31. package/dist/model/authenticationUpdateResponse.d.ts +4 -4
  32. package/dist/model/bigCommerceChannel.d.ts +2 -2
  33. package/dist/model/bigCommerceMetafield.d.ts +2 -2
  34. package/dist/model/clientMethodProps.d.ts +64 -64
  35. package/dist/model/commercetoolsCustomFields.d.ts +1 -1
  36. package/dist/model/deleteResponse.d.ts +1 -1
  37. package/dist/model/destination.d.ts +6 -6
  38. package/dist/model/destinationCreate.d.ts +3 -3
  39. package/dist/model/destinationCreateResponse.d.ts +4 -4
  40. package/dist/model/destinationIndexName.d.ts +2 -2
  41. package/dist/model/destinationIndexPrefix.d.ts +1 -1
  42. package/dist/model/destinationSearch.d.ts +1 -1
  43. package/dist/model/destinationSortKeys.d.ts +1 -1
  44. package/dist/model/destinationType.d.ts +2 -2
  45. package/dist/model/destinationType.d.ts.map +1 -1
  46. package/dist/model/destinationUpdate.d.ts +3 -3
  47. package/dist/model/destinationUpdateResponse.d.ts +4 -4
  48. package/dist/model/dockerImageType.d.ts +1 -1
  49. package/dist/model/dockerRegistry.d.ts +1 -1
  50. package/dist/model/dockerSourceDiscover.d.ts +2 -2
  51. package/dist/model/event.d.ts +3 -3
  52. package/dist/model/eventSortKeys.d.ts +1 -1
  53. package/dist/model/index.d.ts +1 -0
  54. package/dist/model/index.d.ts.map +1 -1
  55. package/dist/model/listTasksResponse.d.ts +1 -1
  56. package/dist/model/mappingFormatSchema.d.ts +5 -0
  57. package/dist/model/mappingFormatSchema.d.ts.map +1 -0
  58. package/dist/model/mappingInput.d.ts +3 -5
  59. package/dist/model/mappingInput.d.ts.map +1 -1
  60. package/dist/model/methodType.d.ts +3 -0
  61. package/dist/model/methodType.d.ts.map +1 -1
  62. package/dist/model/onDemandDateUtilsInput.d.ts +3 -3
  63. package/dist/model/onDemandTrigger.d.ts +2 -2
  64. package/dist/model/onDemandTriggerInput.d.ts +1 -1
  65. package/dist/model/onDemandTriggerType.d.ts +1 -1
  66. package/dist/model/orderKeys.d.ts +1 -1
  67. package/dist/model/pagination.d.ts +15 -0
  68. package/dist/model/pagination.d.ts.map +1 -1
  69. package/dist/model/platform.d.ts +2 -2
  70. package/dist/model/platform.d.ts.map +1 -1
  71. package/dist/model/platformNone.d.ts +1 -1
  72. package/dist/model/recordType.d.ts +1 -1
  73. package/dist/model/run.d.ts +7 -7
  74. package/dist/model/runOutcome.d.ts +3 -0
  75. package/dist/model/runOutcome.d.ts.map +1 -1
  76. package/dist/model/runReasonCode.d.ts +1 -1
  77. package/dist/model/runResponse.d.ts +3 -3
  78. package/dist/model/runSortKeys.d.ts +1 -1
  79. package/dist/model/runStatus.d.ts +3 -0
  80. package/dist/model/runStatus.d.ts.map +1 -1
  81. package/dist/model/runType.d.ts +3 -0
  82. package/dist/model/runType.d.ts.map +1 -1
  83. package/dist/model/scheduleDateUtilsInput.d.ts +2 -2
  84. package/dist/model/scheduleTrigger.d.ts +4 -4
  85. package/dist/model/scheduleTriggerInput.d.ts +2 -2
  86. package/dist/model/scheduleTriggerType.d.ts +1 -1
  87. package/dist/model/source.d.ts +4 -4
  88. package/dist/model/sourceBigCommerce.d.ts +1 -1
  89. package/dist/model/sourceBigQuery.d.ts +5 -5
  90. package/dist/model/sourceCSV.d.ts +3 -3
  91. package/dist/model/sourceCommercetools.d.ts +2 -2
  92. package/dist/model/sourceCreate.d.ts +4 -1
  93. package/dist/model/sourceCreate.d.ts.map +1 -1
  94. package/dist/model/sourceCreateResponse.d.ts +5 -2
  95. package/dist/model/sourceCreateResponse.d.ts.map +1 -1
  96. package/dist/model/sourceDocker.d.ts +3 -3
  97. package/dist/model/sourceGA4BigQueryExport.d.ts +3 -3
  98. package/dist/model/sourceJSON.d.ts +2 -2
  99. package/dist/model/sourceSortKeys.d.ts +1 -1
  100. package/dist/model/sourceType.d.ts +1 -1
  101. package/dist/model/sourceType.d.ts.map +1 -1
  102. package/dist/model/sourceUpdate.d.ts +4 -1
  103. package/dist/model/sourceUpdate.d.ts.map +1 -1
  104. package/dist/model/sourceUpdateCommercetools.d.ts +2 -5
  105. package/dist/model/sourceUpdateCommercetools.d.ts.map +1 -1
  106. package/dist/model/sourceUpdateDocker.d.ts +3 -3
  107. package/dist/model/sourceUpdateResponse.d.ts +5 -2
  108. package/dist/model/sourceUpdateResponse.d.ts.map +1 -1
  109. package/dist/model/streamingTrigger.d.ts +1 -1
  110. package/dist/model/streamingTriggerType.d.ts +1 -1
  111. package/dist/model/streamingUtilsInput.d.ts +1 -1
  112. package/dist/model/subscriptionTrigger.d.ts +1 -1
  113. package/dist/model/subscriptionTriggerType.d.ts +1 -1
  114. package/dist/model/task.d.ts +7 -7
  115. package/dist/model/taskCreate.d.ts +5 -5
  116. package/dist/model/taskCreateResponse.d.ts +3 -3
  117. package/dist/model/taskInput.d.ts +3 -0
  118. package/dist/model/taskInput.d.ts.map +1 -1
  119. package/dist/model/taskSortKeys.d.ts +1 -1
  120. package/dist/model/taskUpdate.d.ts +4 -4
  121. package/dist/model/taskUpdateResponse.d.ts +3 -3
  122. package/dist/model/trigger.d.ts +3 -0
  123. package/dist/model/trigger.d.ts.map +1 -1
  124. package/dist/model/triggerType.d.ts +1 -1
  125. package/dist/model/triggerUpdateInput.d.ts +2 -2
  126. package/dist/model/window.d.ts +3 -3
  127. package/dist/src/ingestionClient.d.ts +99 -99
  128. package/model/actionType.ts +1 -1
  129. package/model/authAPIKey.ts +4 -1
  130. package/model/authAPIKeyPartial.ts +4 -1
  131. package/model/authAlgolia.ts +5 -2
  132. package/model/authAlgoliaPartial.ts +5 -2
  133. package/model/authBasic.ts +7 -1
  134. package/model/authBasicPartial.ts +7 -1
  135. package/model/authGoogleServiceAccount.ts +3 -3
  136. package/model/authGoogleServiceAccountPartial.ts +3 -3
  137. package/model/authOAuth.ts +9 -4
  138. package/model/authOAuthPartial.ts +9 -4
  139. package/model/authentication.ts +5 -5
  140. package/model/authenticationCreate.ts +2 -2
  141. package/model/authenticationCreateResponse.ts +4 -4
  142. package/model/authenticationSearch.ts +1 -1
  143. package/model/authenticationSortKeys.ts +1 -1
  144. package/model/authenticationType.ts +1 -1
  145. package/model/authenticationUpdate.ts +2 -2
  146. package/model/authenticationUpdateResponse.ts +4 -4
  147. package/model/bigCommerceChannel.ts +2 -2
  148. package/model/bigCommerceMetafield.ts +2 -2
  149. package/model/clientMethodProps.ts +64 -64
  150. package/model/commercetoolsCustomFields.ts +1 -1
  151. package/model/deleteResponse.ts +1 -1
  152. package/model/destination.ts +6 -6
  153. package/model/destinationCreate.ts +3 -3
  154. package/model/destinationCreateResponse.ts +4 -4
  155. package/model/destinationIndexName.ts +2 -2
  156. package/model/destinationIndexPrefix.ts +1 -1
  157. package/model/destinationSearch.ts +1 -1
  158. package/model/destinationSortKeys.ts +1 -1
  159. package/model/destinationType.ts +2 -2
  160. package/model/destinationUpdate.ts +3 -3
  161. package/model/destinationUpdateResponse.ts +4 -4
  162. package/model/dockerImageType.ts +1 -1
  163. package/model/dockerRegistry.ts +1 -1
  164. package/model/dockerSourceDiscover.ts +2 -2
  165. package/model/event.ts +3 -3
  166. package/model/eventSortKeys.ts +1 -1
  167. package/model/index.ts +1 -0
  168. package/model/listTasksResponse.ts +1 -1
  169. package/model/mappingFormatSchema.ts +6 -0
  170. package/model/mappingInput.ts +3 -5
  171. package/model/methodType.ts +3 -0
  172. package/model/onDemandDateUtilsInput.ts +3 -3
  173. package/model/onDemandTrigger.ts +2 -2
  174. package/model/onDemandTriggerInput.ts +1 -1
  175. package/model/onDemandTriggerType.ts +1 -1
  176. package/model/orderKeys.ts +1 -1
  177. package/model/pagination.ts +15 -0
  178. package/model/platform.ts +2 -2
  179. package/model/platformNone.ts +1 -1
  180. package/model/recordType.ts +1 -1
  181. package/model/run.ts +7 -7
  182. package/model/runOutcome.ts +3 -0
  183. package/model/runReasonCode.ts +1 -1
  184. package/model/runResponse.ts +3 -3
  185. package/model/runSortKeys.ts +1 -1
  186. package/model/runStatus.ts +3 -0
  187. package/model/runType.ts +3 -0
  188. package/model/scheduleDateUtilsInput.ts +2 -2
  189. package/model/scheduleTrigger.ts +4 -4
  190. package/model/scheduleTriggerInput.ts +2 -2
  191. package/model/scheduleTriggerType.ts +1 -1
  192. package/model/source.ts +4 -4
  193. package/model/sourceBigCommerce.ts +1 -1
  194. package/model/sourceBigQuery.ts +5 -5
  195. package/model/sourceCSV.ts +3 -3
  196. package/model/sourceCommercetools.ts +2 -2
  197. package/model/sourceCreate.ts +4 -1
  198. package/model/sourceCreateResponse.ts +5 -2
  199. package/model/sourceDocker.ts +3 -3
  200. package/model/sourceGA4BigQueryExport.ts +3 -3
  201. package/model/sourceJSON.ts +2 -2
  202. package/model/sourceSortKeys.ts +1 -1
  203. package/model/sourceType.ts +3 -1
  204. package/model/sourceUpdate.ts +4 -1
  205. package/model/sourceUpdateCommercetools.ts +2 -5
  206. package/model/sourceUpdateDocker.ts +3 -3
  207. package/model/sourceUpdateResponse.ts +5 -2
  208. package/model/streamingTrigger.ts +1 -1
  209. package/model/streamingTriggerType.ts +1 -1
  210. package/model/streamingUtilsInput.ts +1 -1
  211. package/model/subscriptionTrigger.ts +1 -1
  212. package/model/subscriptionTriggerType.ts +1 -1
  213. package/model/task.ts +7 -7
  214. package/model/taskCreate.ts +5 -5
  215. package/model/taskCreateResponse.ts +3 -3
  216. package/model/taskInput.ts +3 -0
  217. package/model/taskSortKeys.ts +1 -1
  218. package/model/taskUpdate.ts +4 -4
  219. package/model/taskUpdateResponse.ts +3 -3
  220. package/model/trigger.ts +3 -0
  221. package/model/triggerType.ts +1 -1
  222. package/model/triggerUpdateInput.ts +2 -2
  223. package/model/window.ts +3 -3
  224. package/package.json +5 -5
@@ -686,7 +686,7 @@ function createXhrRequester() {
686
686
  }
687
687
 
688
688
  // 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.
689
- const apiClientVersion = '1.0.0-alpha.83';
689
+ const apiClientVersion = '1.0.0-alpha.84';
690
690
  const REGIONS = ['eu', 'us'];
691
691
  function getDefaultHosts(region) {
692
692
  const url = 'data.{region}.algolia.com'.replace('{region}', region);
@@ -771,7 +771,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
771
771
  transporter.algoliaAgent.add({ segment, version });
772
772
  },
773
773
  /**
774
- * Create a authentication.
774
+ * Creates a new authentication resource.
775
775
  *
776
776
  * Required API Key ACLs:
777
777
  * - addObject
@@ -807,7 +807,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
807
807
  return transporter.request(request, requestOptions);
808
808
  },
809
809
  /**
810
- * Create a destination.
810
+ * Creates a new destination.
811
811
  *
812
812
  * Required API Key ACLs:
813
813
  * - addObject
@@ -843,7 +843,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
843
843
  return transporter.request(request, requestOptions);
844
844
  },
845
845
  /**
846
- * Create a source.
846
+ * Creates a new source.
847
847
  *
848
848
  * Required API Key ACLs:
849
849
  * - addObject
@@ -879,9 +879,9 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
879
879
  return transporter.request(request, requestOptions);
880
880
  },
881
881
  /**
882
- * Create a task.
882
+ * Creates a new task.
883
883
  *
884
- * @param taskCreate -.
884
+ * @param taskCreate - Request body for creating a task.
885
885
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
886
886
  */
887
887
  createTask(taskCreate, requestOptions) {
@@ -1009,7 +1009,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1009
1009
  return transporter.request(request, requestOptions);
1010
1010
  },
1011
1011
  /**
1012
- * Soft delete the authentication of the given authenticationID.
1012
+ * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
1013
1013
  *
1014
1014
  * Required API Key ACLs:
1015
1015
  * - addObject
@@ -1017,7 +1017,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1017
1017
  * - editSettings.
1018
1018
  *
1019
1019
  * @param deleteAuthentication - The deleteAuthentication object.
1020
- * @param deleteAuthentication.authenticationID - The authentication UUID.
1020
+ * @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
1021
1021
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1022
1022
  */
1023
1023
  deleteAuthentication({ authenticationID }, requestOptions) {
@@ -1036,7 +1036,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1036
1036
  return transporter.request(request, requestOptions);
1037
1037
  },
1038
1038
  /**
1039
- * Soft delete the destination of the given destinationID.
1039
+ * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
1040
1040
  *
1041
1041
  * Required API Key ACLs:
1042
1042
  * - addObject
@@ -1044,7 +1044,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1044
1044
  * - editSettings.
1045
1045
  *
1046
1046
  * @param deleteDestination - The deleteDestination object.
1047
- * @param deleteDestination.destinationID - The destination UUID.
1047
+ * @param deleteDestination.destinationID - Unique identifier of a destination.
1048
1048
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1049
1049
  */
1050
1050
  deleteDestination({ destinationID }, requestOptions) {
@@ -1063,7 +1063,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1063
1063
  return transporter.request(request, requestOptions);
1064
1064
  },
1065
1065
  /**
1066
- * Soft delete the source of the given sourceID.
1066
+ * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
1067
1067
  *
1068
1068
  * Required API Key ACLs:
1069
1069
  * - addObject
@@ -1071,7 +1071,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1071
1071
  * - editSettings.
1072
1072
  *
1073
1073
  * @param deleteSource - The deleteSource object.
1074
- * @param deleteSource.sourceID - The source UUID.
1074
+ * @param deleteSource.sourceID - Unique identifier of a source.
1075
1075
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1076
1076
  */
1077
1077
  deleteSource({ sourceID }, requestOptions) {
@@ -1090,10 +1090,10 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1090
1090
  return transporter.request(request, requestOptions);
1091
1091
  },
1092
1092
  /**
1093
- * Soft delete the task of the given taskID.
1093
+ * Deletes a task by its ID.
1094
1094
  *
1095
1095
  * @param deleteTask - The deleteTask object.
1096
- * @param deleteTask.taskID - The task UUID.
1096
+ * @param deleteTask.taskID - Unique identifier of a task.
1097
1097
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1098
1098
  */
1099
1099
  deleteTask({ taskID }, requestOptions) {
@@ -1112,7 +1112,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1112
1112
  return transporter.request(request, requestOptions);
1113
1113
  },
1114
1114
  /**
1115
- * Disable the task of the given taskID.
1115
+ * Disables a task.
1116
1116
  *
1117
1117
  * Required API Key ACLs:
1118
1118
  * - addObject
@@ -1120,7 +1120,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1120
1120
  * - editSettings.
1121
1121
  *
1122
1122
  * @param disableTask - The disableTask object.
1123
- * @param disableTask.taskID - The task UUID.
1123
+ * @param disableTask.taskID - Unique identifier of a task.
1124
1124
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1125
1125
  */
1126
1126
  disableTask({ taskID }, requestOptions) {
@@ -1139,7 +1139,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1139
1139
  return transporter.request(request, requestOptions);
1140
1140
  },
1141
1141
  /**
1142
- * Enable the task of the given taskID.
1142
+ * Enables a task.
1143
1143
  *
1144
1144
  * Required API Key ACLs:
1145
1145
  * - addObject
@@ -1147,7 +1147,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1147
1147
  * - editSettings.
1148
1148
  *
1149
1149
  * @param enableTask - The enableTask object.
1150
- * @param enableTask.taskID - The task UUID.
1150
+ * @param enableTask.taskID - Unique identifier of a task.
1151
1151
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1152
1152
  */
1153
1153
  enableTask({ taskID }, requestOptions) {
@@ -1166,7 +1166,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1166
1166
  return transporter.request(request, requestOptions);
1167
1167
  },
1168
1168
  /**
1169
- * Get the authentication of the given authenticationID.
1169
+ * Retrieves an authentication resource by its ID.
1170
1170
  *
1171
1171
  * Required API Key ACLs:
1172
1172
  * - addObject
@@ -1174,7 +1174,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1174
1174
  * - editSettings.
1175
1175
  *
1176
1176
  * @param getAuthentication - The getAuthentication object.
1177
- * @param getAuthentication.authenticationID - The authentication UUID.
1177
+ * @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
1178
1178
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1179
1179
  */
1180
1180
  getAuthentication({ authenticationID }, requestOptions) {
@@ -1193,7 +1193,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1193
1193
  return transporter.request(request, requestOptions);
1194
1194
  },
1195
1195
  /**
1196
- * Get a list of authentications for the given query parameters, with pagination details.
1196
+ * Retrieves a list of all authentication resources.
1197
1197
  *
1198
1198
  * Required API Key ACLs:
1199
1199
  * - addObject
@@ -1201,12 +1201,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1201
1201
  * - editSettings.
1202
1202
  *
1203
1203
  * @param getAuthentications - The getAuthentications object.
1204
- * @param getAuthentications.itemsPerPage - The number of items per page to return.
1205
- * @param getAuthentications.page - The page number to fetch, starting at 1.
1206
- * @param getAuthentications.type - The type of the authentications to retrieve.
1207
- * @param getAuthentications.platform - The platform of the authentications to retrieve.
1208
- * @param getAuthentications.sort - The key by which the list should be sorted.
1209
- * @param getAuthentications.order - The order of the returned list.
1204
+ * @param getAuthentications.itemsPerPage - Number of items per page.
1205
+ * @param getAuthentications.page - Page number of the paginated API response.
1206
+ * @param getAuthentications.type - Type of authentication resource to retrieve.
1207
+ * @param getAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
1208
+ * @param getAuthentications.sort - Property by which to sort the list of authentication resources.
1209
+ * @param getAuthentications.order - Sort order of the response, ascending or descending.
1210
1210
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1211
1211
  */
1212
1212
  getAuthentications({ itemsPerPage, page, type, platform, sort, order, } = {}, requestOptions = undefined) {
@@ -1240,7 +1240,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1240
1240
  return transporter.request(request, requestOptions);
1241
1241
  },
1242
1242
  /**
1243
- * Get the destination of the given destinationID.
1243
+ * Retrieves a destination by its ID.
1244
1244
  *
1245
1245
  * Required API Key ACLs:
1246
1246
  * - addObject
@@ -1248,7 +1248,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1248
1248
  * - editSettings.
1249
1249
  *
1250
1250
  * @param getDestination - The getDestination object.
1251
- * @param getDestination.destinationID - The destination UUID.
1251
+ * @param getDestination.destinationID - Unique identifier of a destination.
1252
1252
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1253
1253
  */
1254
1254
  getDestination({ destinationID }, requestOptions) {
@@ -1267,7 +1267,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1267
1267
  return transporter.request(request, requestOptions);
1268
1268
  },
1269
1269
  /**
1270
- * Get a list of destinations for the given query parameters, with pagination details.
1270
+ * Retrieves a list of destinations.
1271
1271
  *
1272
1272
  * Required API Key ACLs:
1273
1273
  * - addObject
@@ -1275,12 +1275,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1275
1275
  * - editSettings.
1276
1276
  *
1277
1277
  * @param getDestinations - The getDestinations object.
1278
- * @param getDestinations.itemsPerPage - The number of items per page to return.
1279
- * @param getDestinations.page - The page number to fetch, starting at 1.
1280
- * @param getDestinations.type - The type of the destinations to retrive.
1281
- * @param getDestinations.authenticationID - The authenticationIDs of the destinations to retrive.
1282
- * @param getDestinations.sort - The key by which the list should be sorted.
1283
- * @param getDestinations.order - The order of the returned list.
1278
+ * @param getDestinations.itemsPerPage - Number of items per page.
1279
+ * @param getDestinations.page - Page number of the paginated API response.
1280
+ * @param getDestinations.type - Destination type.
1281
+ * @param getDestinations.authenticationID - Authentication ID used by destinations.
1282
+ * @param getDestinations.sort - Property by which to sort the destinations.
1283
+ * @param getDestinations.order - Sort order of the response, ascending or descending.
1284
1284
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1285
1285
  */
1286
1286
  getDestinations({ itemsPerPage, page, type, authenticationID, sort, order, } = {}, requestOptions = undefined) {
@@ -1314,7 +1314,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1314
1314
  return transporter.request(request, requestOptions);
1315
1315
  },
1316
1316
  /**
1317
- * Retrieve a stream listing for a given Singer specification compatible docker type source ID.
1317
+ * Retrieves a stream listing for a source. Listing streams only works with sources with `type: docker` and `imageType: singer`.
1318
1318
  *
1319
1319
  * Required API Key ACLs:
1320
1320
  * - addObject
@@ -1322,7 +1322,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1322
1322
  * - editSettings.
1323
1323
  *
1324
1324
  * @param getDockerSourceStreams - The getDockerSourceStreams object.
1325
- * @param getDockerSourceStreams.sourceID - The source UUID.
1325
+ * @param getDockerSourceStreams.sourceID - Unique identifier of a source.
1326
1326
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1327
1327
  */
1328
1328
  getDockerSourceStreams({ sourceID }, requestOptions) {
@@ -1341,7 +1341,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1341
1341
  return transporter.request(request, requestOptions);
1342
1342
  },
1343
1343
  /**
1344
- * Get a single event for a specific runID.
1344
+ * Retrieves a single task run event by its ID.
1345
1345
  *
1346
1346
  * Required API Key ACLs:
1347
1347
  * - addObject
@@ -1349,8 +1349,8 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1349
1349
  * - editSettings.
1350
1350
  *
1351
1351
  * @param getEvent - The getEvent object.
1352
- * @param getEvent.runID - The run UUID.
1353
- * @param getEvent.eventID - The event UUID.
1352
+ * @param getEvent.runID - Unique identifier of a task run.
1353
+ * @param getEvent.eventID - Unique identifier of an event.
1354
1354
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1355
1355
  */
1356
1356
  getEvent({ runID, eventID }, requestOptions) {
@@ -1374,7 +1374,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1374
1374
  return transporter.request(request, requestOptions);
1375
1375
  },
1376
1376
  /**
1377
- * Get a list of events associated to the given runID, for the given query parameters.
1377
+ * Retrieves a list of events for a task run, identified by it\'s ID.
1378
1378
  *
1379
1379
  * Required API Key ACLs:
1380
1380
  * - addObject
@@ -1382,15 +1382,15 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1382
1382
  * - editSettings.
1383
1383
  *
1384
1384
  * @param getEvents - The getEvents object.
1385
- * @param getEvents.runID - The run UUID.
1386
- * @param getEvents.itemsPerPage - The number of items per page to return.
1387
- * @param getEvents.page - The page number to fetch, starting at 1.
1388
- * @param getEvents.status - Filter the status of the events.
1389
- * @param getEvents.type - Filter the type of the events.
1390
- * @param getEvents.sort - The key by which the list should be sorted.
1391
- * @param getEvents.order - The order of the returned list.
1392
- * @param getEvents.startDate - The start date (in RFC3339 format) of the events fetching window. Defaults to \'now\'-3 hours if omitted.
1393
- * @param getEvents.endDate - The end date (in RFC3339 format) of the events fetching window. Defaults to \'now\' days if omitted.
1385
+ * @param getEvents.runID - Unique identifier of a task run.
1386
+ * @param getEvents.itemsPerPage - Number of items per page.
1387
+ * @param getEvents.page - Page number of the paginated API response.
1388
+ * @param getEvents.status - Event status for filtering the list of task runs.
1389
+ * @param getEvents.type - Event type for filtering the list of task runs.
1390
+ * @param getEvents.sort - Property by which to sort the list of task run events.
1391
+ * @param getEvents.order - Sort order of the response, ascending or descending.
1392
+ * @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.
1393
+ * @param getEvents.endDate - Date and time in RFC3339 format for the latest events to retrieve. By default, the current time is used.
1394
1394
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1395
1395
  */
1396
1396
  getEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }, requestOptions) {
@@ -1433,7 +1433,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1433
1433
  return transporter.request(request, requestOptions);
1434
1434
  },
1435
1435
  /**
1436
- * Get a single run for the given ID.
1436
+ * Retrieve a single task run by its ID.
1437
1437
  *
1438
1438
  * Required API Key ACLs:
1439
1439
  * - addObject
@@ -1441,7 +1441,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1441
1441
  * - editSettings.
1442
1442
  *
1443
1443
  * @param getRun - The getRun object.
1444
- * @param getRun.runID - The run UUID.
1444
+ * @param getRun.runID - Unique identifier of a task run.
1445
1445
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1446
1446
  */
1447
1447
  getRun({ runID }, requestOptions) {
@@ -1460,7 +1460,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1460
1460
  return transporter.request(request, requestOptions);
1461
1461
  },
1462
1462
  /**
1463
- * Get a list of runs for the given query parameters, with pagination details.
1463
+ * Retrieve a list of task runs.
1464
1464
  *
1465
1465
  * Required API Key ACLs:
1466
1466
  * - addObject
@@ -1468,14 +1468,14 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1468
1468
  * - editSettings.
1469
1469
  *
1470
1470
  * @param getRuns - The getRuns object.
1471
- * @param getRuns.itemsPerPage - The number of items per page to return.
1472
- * @param getRuns.page - The page number to fetch, starting at 1.
1473
- * @param getRuns.status - Filter the status of the runs.
1474
- * @param getRuns.taskID - Filter by taskID.
1475
- * @param getRuns.sort - The key by which the list should be sorted.
1476
- * @param getRuns.order - The order of the returned list.
1477
- * @param getRuns.startDate - The start date (in RFC3339 format) of the runs fetching window. Defaults to \'now\'-7 days if omitted.
1478
- * @param getRuns.endDate - The end date (in RFC3339 format) of the runs fetching window. Defaults to \'now\' days if omitted.
1471
+ * @param getRuns.itemsPerPage - Number of items per page.
1472
+ * @param getRuns.page - Page number of the paginated API response.
1473
+ * @param getRuns.status - Run status for filtering the list of task runs.
1474
+ * @param getRuns.taskID - Task ID for filtering the list of task runs.
1475
+ * @param getRuns.sort - Property by which to sort the list of task runs.
1476
+ * @param getRuns.order - Sort order of the response, ascending or descending.
1477
+ * @param getRuns.startDate - Date in RFC3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
1478
+ * @param getRuns.endDate - Date in RFC3339 format for the latest run to retrieve. By default, the current day is used.
1479
1479
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1480
1480
  */
1481
1481
  getRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, } = {}, requestOptions = undefined) {
@@ -1515,7 +1515,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1515
1515
  return transporter.request(request, requestOptions);
1516
1516
  },
1517
1517
  /**
1518
- * Get the source of the given sourceID.
1518
+ * Retrieve a source by its ID.
1519
1519
  *
1520
1520
  * Required API Key ACLs:
1521
1521
  * - addObject
@@ -1523,7 +1523,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1523
1523
  * - editSettings.
1524
1524
  *
1525
1525
  * @param getSource - The getSource object.
1526
- * @param getSource.sourceID - The source UUID.
1526
+ * @param getSource.sourceID - Unique identifier of a source.
1527
1527
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1528
1528
  */
1529
1529
  getSource({ sourceID }, requestOptions) {
@@ -1542,7 +1542,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1542
1542
  return transporter.request(request, requestOptions);
1543
1543
  },
1544
1544
  /**
1545
- * Get a list of sources for the given query parameters, with pagination details.
1545
+ * Retrieves a list of sources.
1546
1546
  *
1547
1547
  * Required API Key ACLs:
1548
1548
  * - addObject
@@ -1550,12 +1550,12 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1550
1550
  * - editSettings.
1551
1551
  *
1552
1552
  * @param getSources - The getSources object.
1553
- * @param getSources.itemsPerPage - The number of items per page to return.
1554
- * @param getSources.page - The page number to fetch, starting at 1.
1555
- * @param getSources.type - The type of the sources to retrieve.
1556
- * @param getSources.authenticationID - The authenticationIDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
1557
- * @param getSources.sort - The key by which the list should be sorted.
1558
- * @param getSources.order - The order of the returned list.
1553
+ * @param getSources.itemsPerPage - Number of items per page.
1554
+ * @param getSources.page - Page number of the paginated API response.
1555
+ * @param getSources.type - Source type. Some sources require authentication.
1556
+ * @param getSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
1557
+ * @param getSources.sort - Property by which to sort the list of sources.
1558
+ * @param getSources.order - Sort order of the response, ascending or descending.
1559
1559
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1560
1560
  */
1561
1561
  getSources({ itemsPerPage, page, type, authenticationID, sort, order, } = {}, requestOptions = undefined) {
@@ -1589,7 +1589,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1589
1589
  return transporter.request(request, requestOptions);
1590
1590
  },
1591
1591
  /**
1592
- * Get the task of the given taskID.
1592
+ * Retrieves a task by its ID.
1593
1593
  *
1594
1594
  * Required API Key ACLs:
1595
1595
  * - addObject
@@ -1597,7 +1597,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1597
1597
  * - editSettings.
1598
1598
  *
1599
1599
  * @param getTask - The getTask object.
1600
- * @param getTask.taskID - The task UUID.
1600
+ * @param getTask.taskID - Unique identifier of a task.
1601
1601
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1602
1602
  */
1603
1603
  getTask({ taskID }, requestOptions) {
@@ -1616,7 +1616,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1616
1616
  return transporter.request(request, requestOptions);
1617
1617
  },
1618
1618
  /**
1619
- * Get a list of tasks for the given query parameters, with pagination details.
1619
+ * Retrieves a list of tasks.
1620
1620
  *
1621
1621
  * Required API Key ACLs:
1622
1622
  * - addObject
@@ -1624,15 +1624,15 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1624
1624
  * - editSettings.
1625
1625
  *
1626
1626
  * @param getTasks - The getTasks object.
1627
- * @param getTasks.itemsPerPage - The number of items per page to return.
1628
- * @param getTasks.page - The page number to fetch, starting at 1.
1629
- * @param getTasks.action - The action of the tasks to retrieve.
1630
- * @param getTasks.enabled - Whether the task is enabled or not.
1631
- * @param getTasks.sourceID - The sourceIDs of the tasks to retrieve.
1632
- * @param getTasks.destinationID - The destinationIDs of the tasks to retrieve.
1633
- * @param getTasks.triggerType - The trigger type of the task.
1634
- * @param getTasks.sort - The key by which the list should be sorted.
1635
- * @param getTasks.order - The order of the returned list.
1627
+ * @param getTasks.itemsPerPage - Number of items per page.
1628
+ * @param getTasks.page - Page number of the paginated API response.
1629
+ * @param getTasks.action - Actions for filtering the list of tasks.
1630
+ * @param getTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
1631
+ * @param getTasks.sourceID - Source IDs for filtering the list of tasks.
1632
+ * @param getTasks.destinationID - Destination IDs for filtering the list of tasks.
1633
+ * @param getTasks.triggerType - Type of task trigger for filtering the list of tasks.
1634
+ * @param getTasks.sort - Property by which to sort the list of tasks.
1635
+ * @param getTasks.order - Sort order of the response, ascending or descending.
1636
1636
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1637
1637
  */
1638
1638
  getTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, } = {}, requestOptions = undefined) {
@@ -1675,7 +1675,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1675
1675
  return transporter.request(request, requestOptions);
1676
1676
  },
1677
1677
  /**
1678
- * Run the task of the given taskID.
1678
+ * Runs a task. You can check the status of task runs with the observability endpoints.
1679
1679
  *
1680
1680
  * Required API Key ACLs:
1681
1681
  * - addObject
@@ -1683,7 +1683,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1683
1683
  * - editSettings.
1684
1684
  *
1685
1685
  * @param runTask - The runTask object.
1686
- * @param runTask.taskID - The task UUID.
1686
+ * @param runTask.taskID - Unique identifier of a task.
1687
1687
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1688
1688
  */
1689
1689
  runTask({ taskID }, requestOptions) {
@@ -1702,7 +1702,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1702
1702
  return transporter.request(request, requestOptions);
1703
1703
  },
1704
1704
  /**
1705
- * Search among authentications with a defined set of parameters.
1705
+ * Searches for authentication resources.
1706
1706
  *
1707
1707
  * Required API Key ACLs:
1708
1708
  * - addObject
@@ -1732,7 +1732,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1732
1732
  return transporter.request(request, requestOptions);
1733
1733
  },
1734
1734
  /**
1735
- * Search among destinations with a defined set of parameters.
1735
+ * Searches for destinations.
1736
1736
  *
1737
1737
  * Required API Key ACLs:
1738
1738
  * - addObject
@@ -1762,7 +1762,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1762
1762
  return transporter.request(request, requestOptions);
1763
1763
  },
1764
1764
  /**
1765
- * Search among sources with a defined set of parameters.
1765
+ * Searches for sources.
1766
1766
  *
1767
1767
  * Required API Key ACLs:
1768
1768
  * - addObject
@@ -1792,7 +1792,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1792
1792
  return transporter.request(request, requestOptions);
1793
1793
  },
1794
1794
  /**
1795
- * Search among tasks with a defined set of parameters.
1795
+ * Searches for tasks.
1796
1796
  *
1797
1797
  * Required API Key ACLs:
1798
1798
  * - addObject
@@ -1822,7 +1822,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1822
1822
  return transporter.request(request, requestOptions);
1823
1823
  },
1824
1824
  /**
1825
- * Trigger a stream listing request for a Singer specification compatible docker type source.
1825
+ * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
1826
1826
  *
1827
1827
  * Required API Key ACLs:
1828
1828
  * - addObject
@@ -1830,7 +1830,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1830
1830
  * - editSettings.
1831
1831
  *
1832
1832
  * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
1833
- * @param triggerDockerSourceDiscover.sourceID - The source UUID.
1833
+ * @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
1834
1834
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1835
1835
  */
1836
1836
  triggerDockerSourceDiscover({ sourceID }, requestOptions) {
@@ -1849,7 +1849,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1849
1849
  return transporter.request(request, requestOptions);
1850
1850
  },
1851
1851
  /**
1852
- * Update the authentication of the given authenticationID.
1852
+ * Updates an authentication resource.
1853
1853
  *
1854
1854
  * Required API Key ACLs:
1855
1855
  * - addObject
@@ -1857,7 +1857,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1857
1857
  * - editSettings.
1858
1858
  *
1859
1859
  * @param updateAuthentication - The updateAuthentication object.
1860
- * @param updateAuthentication.authenticationID - The authentication UUID.
1860
+ * @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
1861
1861
  * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
1862
1862
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1863
1863
  */
@@ -1881,7 +1881,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1881
1881
  return transporter.request(request, requestOptions);
1882
1882
  },
1883
1883
  /**
1884
- * Update the destination of the given destinationID.
1884
+ * Updates the destination by its ID.
1885
1885
  *
1886
1886
  * Required API Key ACLs:
1887
1887
  * - addObject
@@ -1889,7 +1889,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1889
1889
  * - editSettings.
1890
1890
  *
1891
1891
  * @param updateDestination - The updateDestination object.
1892
- * @param updateDestination.destinationID - The destination UUID.
1892
+ * @param updateDestination.destinationID - Unique identifier of a destination.
1893
1893
  * @param updateDestination.destinationUpdate - The destinationUpdate object.
1894
1894
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1895
1895
  */
@@ -1913,7 +1913,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1913
1913
  return transporter.request(request, requestOptions);
1914
1914
  },
1915
1915
  /**
1916
- * Update the source of the given sourceID.
1916
+ * Updates a source by its ID.
1917
1917
  *
1918
1918
  * Required API Key ACLs:
1919
1919
  * - addObject
@@ -1921,7 +1921,7 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1921
1921
  * - editSettings.
1922
1922
  *
1923
1923
  * @param updateSource - The updateSource object.
1924
- * @param updateSource.sourceID - The source UUID.
1924
+ * @param updateSource.sourceID - Unique identifier of a source.
1925
1925
  * @param updateSource.sourceUpdate - The sourceUpdate object.
1926
1926
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1927
1927
  */
@@ -1945,10 +1945,10 @@ function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authM
1945
1945
  return transporter.request(request, requestOptions);
1946
1946
  },
1947
1947
  /**
1948
- * Update the task of the given taskID.
1948
+ * Updates a task by its ID.
1949
1949
  *
1950
1950
  * @param updateTask - The updateTask object.
1951
- * @param updateTask.taskID - The task UUID.
1951
+ * @param updateTask.taskID - Unique identifier of a task.
1952
1952
  * @param updateTask.taskUpdate - The taskUpdate object.
1953
1953
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1954
1954
  */