@algolia/ingestion 5.2.4-beta.5 → 5.10.0-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (173) hide show
  1. package/README.md +15 -7
  2. package/dist/browser.d.ts +1266 -634
  3. package/dist/builds/browser.js +223 -322
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +6 -6
  8. package/dist/builds/fetch.js +1943 -0
  9. package/dist/builds/fetch.js.map +1 -0
  10. package/dist/builds/node.cjs +220 -320
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +221 -320
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +3001 -0
  15. package/dist/node.d.cts +1267 -634
  16. package/dist/node.d.ts +1267 -634
  17. package/dist/src/ingestionClient.cjs +218 -319
  18. package/dist/src/ingestionClient.cjs.map +1 -1
  19. package/dist/src/ingestionClient.js +218 -319
  20. package/dist/src/ingestionClient.js.map +1 -1
  21. package/index.d.ts +0 -1
  22. package/index.js +1 -2
  23. package/package.json +16 -11
  24. package/model/action.ts +0 -13
  25. package/model/actionType.ts +0 -6
  26. package/model/authAPIKey.ts +0 -11
  27. package/model/authAPIKeyPartial.ts +0 -11
  28. package/model/authAlgolia.ts +0 -16
  29. package/model/authAlgoliaInsights.ts +0 -16
  30. package/model/authAlgoliaInsightsPartial.ts +0 -16
  31. package/model/authAlgoliaPartial.ts +0 -16
  32. package/model/authBasic.ts +0 -16
  33. package/model/authBasicPartial.ts +0 -16
  34. package/model/authGoogleServiceAccount.ts +0 -16
  35. package/model/authGoogleServiceAccountPartial.ts +0 -16
  36. package/model/authInput.ts +0 -16
  37. package/model/authInputPartial.ts +0 -16
  38. package/model/authOAuth.ts +0 -26
  39. package/model/authOAuthPartial.ts +0 -26
  40. package/model/authentication.ts +0 -36
  41. package/model/authenticationCreate.ts +0 -21
  42. package/model/authenticationCreateResponse.ts +0 -21
  43. package/model/authenticationSearch.ts +0 -8
  44. package/model/authenticationSortKeys.ts +0 -6
  45. package/model/authenticationType.ts +0 -6
  46. package/model/authenticationUpdate.ts +0 -21
  47. package/model/authenticationUpdateResponse.ts +0 -21
  48. package/model/bigCommerceChannel.ts +0 -13
  49. package/model/bigCommerceMetafield.ts +0 -13
  50. package/model/bigQueryDataType.ts +0 -3
  51. package/model/clientMethodProps.ts +0 -703
  52. package/model/commercetoolsCustomFields.ts +0 -21
  53. package/model/deleteResponse.ts +0 -8
  54. package/model/destination.ts +0 -40
  55. package/model/destinationCreate.ts +0 -25
  56. package/model/destinationCreateResponse.ts +0 -21
  57. package/model/destinationIndexName.ts +0 -17
  58. package/model/destinationInput.ts +0 -5
  59. package/model/destinationSearch.ts +0 -8
  60. package/model/destinationSortKeys.ts +0 -6
  61. package/model/destinationType.ts +0 -6
  62. package/model/destinationUpdate.ts +0 -25
  63. package/model/destinationUpdateResponse.ts +0 -21
  64. package/model/dockerImageType.ts +0 -6
  65. package/model/dockerRegistry.ts +0 -6
  66. package/model/dockerStreams.ts +0 -17
  67. package/model/dockerStreamsInput.ts +0 -10
  68. package/model/dockerStreamsSyncMode.ts +0 -6
  69. package/model/entityType.ts +0 -6
  70. package/model/errorBase.ts +0 -8
  71. package/model/event.ts +0 -40
  72. package/model/eventSortKeys.ts +0 -6
  73. package/model/eventStatus.ts +0 -3
  74. package/model/eventType.ts +0 -3
  75. package/model/generateTransformationCodePayload.ts +0 -9
  76. package/model/generateTransformationCodeResponse.ts +0 -5
  77. package/model/index.ts +0 -151
  78. package/model/listAuthenticationsResponse.ts +0 -10
  79. package/model/listDestinationsResponse.ts +0 -10
  80. package/model/listEventsResponse.ts +0 -13
  81. package/model/listSourcesResponse.ts +0 -10
  82. package/model/listTasksResponse.ts +0 -13
  83. package/model/listTasksResponseV1.ts +0 -13
  84. package/model/listTransformationsResponse.ts +0 -13
  85. package/model/mappingFieldDirective.ts +0 -16
  86. package/model/mappingFormatSchema.ts +0 -6
  87. package/model/mappingInput.ts +0 -13
  88. package/model/mappingKitAction.ts +0 -25
  89. package/model/mappingTypeCSV.ts +0 -3
  90. package/model/methodType.ts +0 -6
  91. package/model/model.ts +0 -13
  92. package/model/onDemandTrigger.ts +0 -15
  93. package/model/onDemandTriggerInput.ts +0 -10
  94. package/model/onDemandTriggerType.ts +0 -6
  95. package/model/orderKeys.ts +0 -6
  96. package/model/pagination.ts +0 -26
  97. package/model/platform.ts +0 -6
  98. package/model/platformNone.ts +0 -6
  99. package/model/platformWithNone.ts +0 -6
  100. package/model/pushTaskPayload.ts +0 -10
  101. package/model/pushTaskRecords.ts +0 -8
  102. package/model/recordType.ts +0 -6
  103. package/model/run.ts +0 -56
  104. package/model/runListResponse.ts +0 -13
  105. package/model/runOutcome.ts +0 -6
  106. package/model/runProgress.ts +0 -7
  107. package/model/runReasonCode.ts +0 -6
  108. package/model/runResponse.ts +0 -16
  109. package/model/runSortKeys.ts +0 -6
  110. package/model/runSourcePayload.ts +0 -22
  111. package/model/runSourceResponse.ts +0 -13
  112. package/model/runStatus.ts +0 -6
  113. package/model/runType.ts +0 -6
  114. package/model/scheduleTrigger.ts +0 -25
  115. package/model/scheduleTriggerInput.ts +0 -15
  116. package/model/scheduleTriggerType.ts +0 -6
  117. package/model/shopifyInput.ts +0 -13
  118. package/model/shopifyMarket.ts +0 -12
  119. package/model/shopifyMetafield.ts +0 -12
  120. package/model/sortKeys.ts +0 -6
  121. package/model/source.ts +0 -32
  122. package/model/sourceBigCommerce.ts +0 -19
  123. package/model/sourceBigQuery.ts +0 -37
  124. package/model/sourceCSV.ts +0 -28
  125. package/model/sourceCommercetools.ts +0 -23
  126. package/model/sourceCreate.ts +0 -20
  127. package/model/sourceCreateResponse.ts +0 -18
  128. package/model/sourceDocker.ts +0 -25
  129. package/model/sourceGA4BigQueryExport.ts +0 -18
  130. package/model/sourceInput.ts +0 -20
  131. package/model/sourceJSON.ts +0 -17
  132. package/model/sourceSearch.ts +0 -5
  133. package/model/sourceShopify.ts +0 -6
  134. package/model/sourceShopifyBase.ts +0 -8
  135. package/model/sourceSortKeys.ts +0 -6
  136. package/model/sourceType.ts +0 -13
  137. package/model/sourceUpdate.ts +0 -17
  138. package/model/sourceUpdateCommercetools.ts +0 -21
  139. package/model/sourceUpdateDocker.ts +0 -22
  140. package/model/sourceUpdateInput.ts +0 -18
  141. package/model/sourceUpdateResponse.ts +0 -18
  142. package/model/sourceUpdateShopify.ts +0 -8
  143. package/model/sourceWatchResponse.ts +0 -25
  144. package/model/streamingInput.ts +0 -10
  145. package/model/streamingTrigger.ts +0 -10
  146. package/model/streamingTriggerType.ts +0 -6
  147. package/model/subscriptionTrigger.ts +0 -10
  148. package/model/subscriptionTriggerType.ts +0 -6
  149. package/model/task.ts +0 -65
  150. package/model/taskCreate.ts +0 -43
  151. package/model/taskCreateResponse.ts +0 -16
  152. package/model/taskCreateTrigger.ts +0 -8
  153. package/model/taskCreateV1.ts +0 -41
  154. package/model/taskInput.ts +0 -10
  155. package/model/taskSearch.ts +0 -5
  156. package/model/taskSortKeys.ts +0 -6
  157. package/model/taskUpdate.ts +0 -30
  158. package/model/taskUpdateResponse.ts +0 -16
  159. package/model/taskUpdateV1.ts +0 -28
  160. package/model/taskV1.ts +0 -56
  161. package/model/transformation.ts +0 -38
  162. package/model/transformationCreate.ts +0 -26
  163. package/model/transformationCreateResponse.ts +0 -16
  164. package/model/transformationError.ts +0 -16
  165. package/model/transformationModels.ts +0 -10
  166. package/model/transformationSearch.ts +0 -5
  167. package/model/transformationTry.ts +0 -17
  168. package/model/transformationTryResponse.ts +0 -12
  169. package/model/transformationUpdateResponse.ts +0 -16
  170. package/model/trigger.ts +0 -11
  171. package/model/triggerType.ts +0 -6
  172. package/model/triggerUpdateInput.ts +0 -11
  173. package/model/window.ts +0 -16
package/dist/browser.d.ts CHANGED
@@ -1,25 +1,5 @@
1
1
  import * as _algolia_client_common from '@algolia/client-common';
2
- import { ClientOptions } from '@algolia/client-common';
3
-
4
- /**
5
- * Type of indexing operation.
6
- */
7
- type Action = 'addObject' | 'clear' | 'delete' | 'deleteObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'updateObject';
8
-
9
- /**
10
- * Action to perform on the Algolia index.
11
- */
12
- type ActionType = 'append' | 'partial' | 'replace' | 'save';
13
-
14
- /**
15
- * Credentials for authenticating with an API key.
16
- */
17
- type AuthAPIKey = {
18
- /**
19
- * API key. This field is `null` in the API response.
20
- */
21
- key: string;
22
- };
2
+ import { CreateClientOptions, RequestOptions, ClientOptions } from '@algolia/client-common';
23
3
 
24
4
  /**
25
5
  * Credentials for authenticating with an API key.
@@ -31,34 +11,6 @@ type AuthAPIKeyPartial = {
31
11
  key?: string;
32
12
  };
33
13
 
34
- /**
35
- * Credentials for authenticating with Algolia.
36
- */
37
- type AuthAlgolia = {
38
- /**
39
- * Algolia application ID.
40
- */
41
- appID: string;
42
- /**
43
- * Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
44
- */
45
- apiKey: string;
46
- };
47
-
48
- /**
49
- * Credentials for authenticating with the Algolia Insights API.
50
- */
51
- type AuthAlgoliaInsights = {
52
- /**
53
- * Algolia application ID.
54
- */
55
- appID: string;
56
- /**
57
- * Algolia API key with the ACL: `search`. This field is `null` in the API response.
58
- */
59
- apiKey: string;
60
- };
61
-
62
14
  /**
63
15
  * Credentials for authenticating with the Algolia Insights API.
64
16
  */
@@ -87,20 +39,6 @@ type AuthAlgoliaPartial = {
87
39
  apiKey?: string;
88
40
  };
89
41
 
90
- /**
91
- * Credentials for authenticating with user name and password.
92
- */
93
- type AuthBasic = {
94
- /**
95
- * Username.
96
- */
97
- username: string;
98
- /**
99
- * Password. This field is `null` in the API response.
100
- */
101
- password: string;
102
- };
103
-
104
42
  /**
105
43
  * Credentials for authenticating with user name and password.
106
44
  */
@@ -115,20 +53,6 @@ type AuthBasicPartial = {
115
53
  password?: string;
116
54
  };
117
55
 
118
- /**
119
- * Credentials for authenticating with a Google service account, such as BigQuery.
120
- */
121
- type AuthGoogleServiceAccount = {
122
- /**
123
- * Email address of the Google service account.
124
- */
125
- clientEmail: string;
126
- /**
127
- * Private key of the Google service account. This field is `null` in the API response.
128
- */
129
- privateKey: string;
130
- };
131
-
132
56
  /**
133
57
  * Credentials for authenticating with a Google service account, such as BigQuery.
134
58
  */
@@ -143,30 +67,6 @@ type AuthGoogleServiceAccountPartial = {
143
67
  privateKey?: string;
144
68
  };
145
69
 
146
- /**
147
- * Credentials for authenticating with OAuth 2.0.
148
- */
149
- type AuthOAuth = {
150
- /**
151
- * URL for the OAuth endpoint.
152
- */
153
- url: string;
154
- /**
155
- * Client ID.
156
- */
157
- client_id: string;
158
- /**
159
- * Client secret. This field is `null` in the API response.
160
- */
161
- client_secret: string;
162
- /**
163
- * OAuth scope.
164
- */
165
- scope?: string;
166
- };
167
-
168
- type AuthInput = AuthAlgolia | AuthAlgoliaInsights | AuthAPIKey | AuthBasic | AuthGoogleServiceAccount | AuthOAuth;
169
-
170
70
  /**
171
71
  * Credentials for authenticating with OAuth 2.0.
172
72
  */
@@ -189,12 +89,12 @@ type AuthOAuthPartial = {
189
89
  scope?: string;
190
90
  };
191
91
 
192
- type AuthInputPartial = AuthAlgoliaInsightsPartial | AuthAlgoliaPartial | AuthAPIKeyPartial | AuthBasicPartial | AuthGoogleServiceAccountPartial | AuthOAuthPartial;
92
+ type AuthInputPartial = AuthGoogleServiceAccountPartial | AuthBasicPartial | AuthAPIKeyPartial | AuthOAuthPartial | AuthAlgoliaPartial | AuthAlgoliaInsightsPartial;
193
93
 
194
94
  /**
195
95
  * Type of authentication. This determines the type of credentials required in the `input` object.
196
96
  */
197
- type AuthenticationType = 'algolia' | 'algoliaInsights' | 'apiKey' | 'basic' | 'googleServiceAccount' | 'oauth';
97
+ type AuthenticationType = 'googleServiceAccount' | 'basic' | 'apiKey' | 'oauth' | 'algolia' | 'algoliaInsights';
198
98
 
199
99
  /**
200
100
  * Name of an ecommerce platform with which to authenticate. This determines which authentication type you can select.
@@ -227,119 +127,149 @@ type Authentication = {
227
127
  };
228
128
 
229
129
  /**
230
- * Request body for creating a new authentication resource.
130
+ * Credentials for authenticating with an API key.
231
131
  */
232
- type AuthenticationCreate = {
233
- type: AuthenticationType;
132
+ type AuthAPIKey = {
234
133
  /**
235
- * Descriptive name for the resource.
134
+ * API key. This field is `null` in the API response.
236
135
  */
237
- name: string;
238
- platform?: Platform | null;
239
- input: AuthInput;
136
+ key: string;
240
137
  };
241
138
 
242
139
  /**
243
- * API response for the successful creation of an authentication resource.
140
+ * Credentials for authenticating with Algolia.
244
141
  */
245
- type AuthenticationCreateResponse = {
246
- /**
247
- * Universally unique identifier (UUID) of an authentication resource.
248
- */
249
- authenticationID: string;
142
+ type AuthAlgolia = {
250
143
  /**
251
- * Descriptive name for the resource.
144
+ * Algolia application ID.
252
145
  */
253
- name: string;
146
+ appID: string;
254
147
  /**
255
- * Date of creation in RFC 3339 format.
148
+ * Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
256
149
  */
257
- createdAt: string;
150
+ apiKey: string;
258
151
  };
259
152
 
260
153
  /**
261
- * Request body for searching for authentication resources.
154
+ * Credentials for authenticating with the Algolia Insights API.
262
155
  */
263
- type AuthenticationSearch = {
264
- authenticationIDs: string[];
156
+ type AuthAlgoliaInsights = {
157
+ /**
158
+ * Algolia application ID.
159
+ */
160
+ appID: string;
161
+ /**
162
+ * Algolia API key with the ACL: `search`. This field is `null` in the API response.
163
+ */
164
+ apiKey: string;
265
165
  };
266
166
 
267
167
  /**
268
- * Property by which to sort the list of authentication resources.
168
+ * Credentials for authenticating with user name and password.
269
169
  */
270
- type AuthenticationSortKeys = 'auth_type' | 'createdAt' | 'name' | 'platform' | 'updatedAt';
170
+ type AuthBasic = {
171
+ /**
172
+ * Username.
173
+ */
174
+ username: string;
175
+ /**
176
+ * Password. This field is `null` in the API response.
177
+ */
178
+ password: string;
179
+ };
271
180
 
272
181
  /**
273
- * Request body for updating an authentication resource.
182
+ * Credentials for authenticating with a Google service account, such as BigQuery.
274
183
  */
275
- type AuthenticationUpdate = {
276
- type?: AuthenticationType;
184
+ type AuthGoogleServiceAccount = {
277
185
  /**
278
- * Descriptive name for the resource.
186
+ * Email address of the Google service account.
279
187
  */
280
- name?: string;
281
- platform?: Platform | null;
282
- input?: AuthInputPartial;
188
+ clientEmail: string;
189
+ /**
190
+ * Private key of the Google service account. This field is `null` in the API response.
191
+ */
192
+ privateKey: string;
283
193
  };
284
194
 
285
195
  /**
286
- * API response for a successful update of an authentication resource.
196
+ * Credentials for authenticating with OAuth 2.0.
287
197
  */
288
- type AuthenticationUpdateResponse = {
198
+ type AuthOAuth = {
289
199
  /**
290
- * Universally unique identifier (UUID) of an authentication resource.
200
+ * URL for the OAuth endpoint.
291
201
  */
292
- authenticationID: string;
202
+ url: string;
293
203
  /**
294
- * Descriptive name for the resource.
204
+ * Client ID.
295
205
  */
296
- name: string;
206
+ client_id: string;
297
207
  /**
298
- * Date of last update in RFC 3339 format.
208
+ * Client secret. This field is `null` in the API response.
299
209
  */
300
- updatedAt: string;
301
- };
302
-
303
- type BigCommerceChannel = {
210
+ client_secret: string;
304
211
  /**
305
- * ID of the BigCommerce channel.
212
+ * OAuth scope.
306
213
  */
307
- id: number;
214
+ scope?: string;
215
+ };
216
+
217
+ type AuthInput = AuthGoogleServiceAccount | AuthBasic | AuthAPIKey | AuthOAuth | AuthAlgolia | AuthAlgoliaInsights;
218
+
219
+ /**
220
+ * Request body for creating a new authentication resource.
221
+ */
222
+ type AuthenticationCreate = {
223
+ type: AuthenticationType;
308
224
  /**
309
- * Currencies for the given channel.
225
+ * Descriptive name for the resource.
310
226
  */
311
- currencies?: string[];
227
+ name: string;
228
+ platform?: Platform | null;
229
+ input: AuthInput;
312
230
  };
313
231
 
314
- type BigCommerceMetafield = {
232
+ /**
233
+ * API response for the successful creation of an authentication resource.
234
+ */
235
+ type AuthenticationCreateResponse = {
315
236
  /**
316
- * Namespace of the metafield.
237
+ * Universally unique identifier (UUID) of an authentication resource.
317
238
  */
318
- namespace: string;
239
+ authenticationID: string;
319
240
  /**
320
- * Key identifier of the metafield.
241
+ * Descriptive name for the resource.
321
242
  */
322
- key: string;
243
+ name: string;
244
+ /**
245
+ * Date of creation in RFC 3339 format.
246
+ */
247
+ createdAt: string;
323
248
  };
324
249
 
325
- type BigQueryDataType = 'ga4' | 'ga360';
250
+ /**
251
+ * Request body for searching for authentication resources.
252
+ */
253
+ type AuthenticationSearch = {
254
+ authenticationIDs: Array<string>;
255
+ };
326
256
 
327
257
  /**
328
- * Custom fields from commercetools to add to the records. For more information, see [Using Custom Types and Custom Fields](https://docs.commercetools.com/tutorials/custom-types).
258
+ * API response for a successful update of an authentication resource.
329
259
  */
330
- type CommercetoolsCustomFields = {
260
+ type AuthenticationUpdateResponse = {
331
261
  /**
332
- * Inventory custom fields.
262
+ * Universally unique identifier (UUID) of an authentication resource.
333
263
  */
334
- inventory?: string[] | null;
264
+ authenticationID: string;
335
265
  /**
336
- * Price custom fields.
266
+ * Descriptive name for the resource.
337
267
  */
338
- price?: string[] | null;
268
+ name: string;
339
269
  /**
340
- * Category custom fields.
270
+ * Date of last update in RFC 3339 format.
341
271
  */
342
- category?: string[] | null;
272
+ updatedAt: string;
343
273
  };
344
274
 
345
275
  type DeleteResponse = {
@@ -363,7 +293,7 @@ type DestinationIndexName = {
363
293
  /**
364
294
  * Attributes from your source to exclude from Algolia records. Not all your data attributes will be useful for searching. Keeping your Algolia records small increases indexing and search performance. - Exclude nested attributes with `.` notation. For example, `foo.bar` indexes the `foo` attribute and all its children **except** the `bar` attribute. - Exclude attributes from arrays with `[i]`, where `i` is the index of the array element. For example, `foo.[0].bar` only excludes the `bar` attribute from the first element of the `foo` array, but indexes the complete `foo` attribute for all other elements. Use `*` as wildcard: `foo.[*].bar` excludes `bar` from all elements of the `foo` array.
365
295
  */
366
- attributesToExclude?: string[];
296
+ attributesToExclude?: Array<string>;
367
297
  };
368
298
 
369
299
  type DestinationInput = DestinationIndexName;
@@ -371,7 +301,7 @@ type DestinationInput = DestinationIndexName;
371
301
  /**
372
302
  * Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is recorded as user events in the Insights API.
373
303
  */
374
- type DestinationType = 'insights' | 'search';
304
+ type DestinationType = 'search' | 'insights';
375
305
 
376
306
  /**
377
307
  * Destinations are Algolia resources like indices or event streams.
@@ -399,7 +329,7 @@ type Destination = {
399
329
  * Universally unique identifier (UUID) of an authentication resource.
400
330
  */
401
331
  authenticationID?: string;
402
- transformationIDs?: string[];
332
+ transformationIDs?: Array<string>;
403
333
  };
404
334
 
405
335
  /**
@@ -416,7 +346,7 @@ type DestinationCreate = {
416
346
  * Universally unique identifier (UUID) of an authentication resource.
417
347
  */
418
348
  authenticationID?: string;
419
- transformationIDs?: string[];
349
+ transformationIDs?: Array<string>;
420
350
  };
421
351
 
422
352
  /**
@@ -441,29 +371,7 @@ type DestinationCreateResponse = {
441
371
  * API request body for searching destinations.
442
372
  */
443
373
  type DestinationSearch = {
444
- destinationIDs: string[];
445
- };
446
-
447
- /**
448
- * Property by which to sort the destinations.
449
- */
450
- type DestinationSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
451
-
452
- /**
453
- * API request body for updating a destination.
454
- */
455
- type DestinationUpdate = {
456
- type?: DestinationType;
457
- /**
458
- * Descriptive name for the resource.
459
- */
460
- name?: string;
461
- input?: DestinationInput;
462
- /**
463
- * Universally unique identifier (UUID) of an authentication resource.
464
- */
465
- authenticationID?: string;
466
- transformationIDs?: string[];
374
+ destinationIDs: Array<string>;
467
375
  };
468
376
 
469
377
  /**
@@ -483,56 +391,10 @@ type DestinationUpdateResponse = {
483
391
  */
484
392
  updatedAt: string;
485
393
  };
486
-
487
- /**
488
- * Image type.
489
- */
490
- type DockerImageType = 'airbyte' | 'custom' | 'singer';
491
-
492
- /**
493
- * Container registry name from where to pull the image.
494
- */
495
- type DockerRegistry = 'dockerhub' | 'ghcr';
496
-
497
- /**
498
- * The strategy to use to fetch the data.
499
- */
500
- type DockerStreamsSyncMode = 'fullTable' | 'incremental';
501
-
502
- type DockerStreams = {
503
- /**
504
- * The name of the stream to fetch the data from (e.g. Table name).
505
- */
506
- name: string;
507
- /**
508
- * The properties of the stream to select (e.g. Column).
509
- */
510
- properties?: string[];
511
- syncMode: DockerStreamsSyncMode;
512
- };
513
-
514
- /**
515
- * The selected streams of a singer or airbyte connector.
516
- */
517
- type DockerStreamsInput = {
518
- streams: DockerStreams[];
519
- };
520
-
521
- /**
522
- * Type of entity to update.
523
- */
524
- type EntityType = 'collection' | 'product';
525
-
526
- /**
527
- * Error.
528
- */
529
- type ErrorBase = Record<string, any> & {
530
- message?: string;
531
- };
532
-
533
- type EventStatus = 'created' | 'critical' | 'failed' | 'retried' | 'started' | 'succeeded';
534
-
535
- type EventType = 'fetch' | 'log' | 'record' | 'transform';
394
+
395
+ type EventStatus = 'created' | 'started' | 'retried' | 'failed' | 'succeeded' | 'critical';
396
+
397
+ type EventType = 'fetch' | 'record' | 'log' | 'transform';
536
398
 
537
399
  /**
538
400
  * An event describe a step of the task execution flow..
@@ -546,38 +408,21 @@ type Event = {
546
408
  * Universally unique identifier (UUID) of a task run.
547
409
  */
548
410
  runID: string;
549
- /**
550
- * The parent event, the cause of this event.
551
- */
552
- parentID?: string;
553
411
  status: EventStatus;
554
412
  type: EventType;
555
413
  /**
556
414
  * The extracted record batch size.
557
415
  */
558
416
  batchSize: number;
559
- data?: Record<string, any>;
417
+ data?: {
418
+ [key: string]: any;
419
+ };
560
420
  /**
561
421
  * Date of publish RFC 3339 format.
562
422
  */
563
423
  publishedAt: string;
564
424
  };
565
425
 
566
- /**
567
- * Property by which to sort the list of task run events.
568
- */
569
- type EventSortKeys = 'publishedAt' | 'status' | 'type';
570
-
571
- type GenerateTransformationCodePayload = {
572
- id: string;
573
- systemPrompt?: string;
574
- userPrompt: string;
575
- };
576
-
577
- type GenerateTransformationCodeResponse = {
578
- generatedCode?: string;
579
- };
580
-
581
426
  /**
582
427
  * Paginated API response.
583
428
  */
@@ -601,12 +446,12 @@ type Pagination = {
601
446
  };
602
447
 
603
448
  type ListAuthenticationsResponse = {
604
- authentications: Authentication[];
449
+ authentications: Array<Authentication>;
605
450
  pagination: Pagination;
606
451
  };
607
452
 
608
453
  type ListDestinationsResponse = {
609
- destinations: Destination[];
454
+ destinations: Array<Destination>;
610
455
  pagination: Pagination;
611
456
  };
612
457
 
@@ -625,22 +470,46 @@ type Window = {
625
470
  };
626
471
 
627
472
  type ListEventsResponse = {
628
- events: Event[];
473
+ events: Array<Event>;
629
474
  pagination: Pagination;
630
475
  window: Window;
631
476
  };
632
477
 
478
+ type BigCommerceChannel = {
479
+ /**
480
+ * ID of the BigCommerce channel.
481
+ */
482
+ id: number;
483
+ /**
484
+ * Currencies for the given channel.
485
+ */
486
+ currencies?: Array<string>;
487
+ };
488
+
489
+ type BigCommerceMetafield = {
490
+ /**
491
+ * Namespace of the metafield.
492
+ */
493
+ namespace: string;
494
+ /**
495
+ * Key identifier of the metafield.
496
+ */
497
+ key: string;
498
+ };
499
+
633
500
  type SourceBigCommerce = {
634
501
  /**
635
502
  * Store hash identifying your BigCommerce store.
636
503
  */
637
504
  storeHash: string;
638
505
  channel?: BigCommerceChannel;
639
- customFields?: string[];
640
- productMetafields?: BigCommerceMetafield[];
641
- variantMetafields?: BigCommerceMetafield[];
506
+ customFields?: Array<string>;
507
+ productMetafields?: Array<BigCommerceMetafield>;
508
+ variantMetafields?: Array<BigCommerceMetafield>;
642
509
  };
643
510
 
511
+ type BigQueryDataType = 'ga4' | 'ga360';
512
+
644
513
  type SourceBigQuery = {
645
514
  /**
646
515
  * Project ID of the BigQuery source.
@@ -669,7 +538,7 @@ type SourceBigQuery = {
669
538
  uniqueIDColumn?: string;
670
539
  };
671
540
 
672
- type MappingTypeCSV = 'boolean' | 'float' | 'integer' | 'json' | 'string';
541
+ type MappingTypeCSV = 'string' | 'integer' | 'float' | 'boolean' | 'json';
673
542
 
674
543
  /**
675
544
  * HTTP method to be used for retrieving your data.
@@ -688,7 +557,9 @@ type SourceCSV = {
688
557
  /**
689
558
  * Key-value pairs of column names and their expected types.
690
559
  */
691
- mapping?: Record<string, MappingTypeCSV>;
560
+ mapping?: {
561
+ [key: string]: MappingTypeCSV;
562
+ };
692
563
  method?: MethodType;
693
564
  /**
694
565
  * The character used to split the value on each line, default to a comma (\\r, \\n, 0xFFFD, and space are forbidden).
@@ -696,12 +567,30 @@ type SourceCSV = {
696
567
  delimiter?: string;
697
568
  };
698
569
 
570
+ /**
571
+ * Custom fields from commercetools to add to the records. For more information, see [Using Custom Types and Custom Fields](https://docs.commercetools.com/tutorials/custom-types).
572
+ */
573
+ type CommercetoolsCustomFields = {
574
+ /**
575
+ * Inventory custom fields.
576
+ */
577
+ inventory?: Array<string> | null;
578
+ /**
579
+ * Price custom fields.
580
+ */
581
+ price?: Array<string> | null;
582
+ /**
583
+ * Category custom fields.
584
+ */
585
+ category?: Array<string> | null;
586
+ };
587
+
699
588
  type SourceCommercetools = {
700
- storeKeys?: string[];
589
+ storeKeys?: Array<string>;
701
590
  /**
702
591
  * Locales for your commercetools stores.
703
592
  */
704
- locales?: string[];
593
+ locales?: Array<string>;
705
594
  url: string;
706
595
  projectKey: string;
707
596
  /**
@@ -711,6 +600,16 @@ type SourceCommercetools = {
711
600
  customFields?: CommercetoolsCustomFields;
712
601
  };
713
602
 
603
+ /**
604
+ * Image type.
605
+ */
606
+ type DockerImageType = 'singer' | 'custom' | 'airbyte';
607
+
608
+ /**
609
+ * Container registry name from where to pull the image.
610
+ */
611
+ type DockerRegistry = 'dockerhub' | 'ghcr';
612
+
714
613
  type SourceDocker = {
715
614
  imageType: DockerImageType;
716
615
  registry: DockerRegistry;
@@ -766,14 +665,16 @@ type SourceUpdateShopify = {
766
665
  /**
767
666
  * Feature flags for the Shopify source.
768
667
  */
769
- featureFlags?: Record<string, any>;
668
+ featureFlags?: {
669
+ [key: string]: any;
670
+ };
770
671
  };
771
672
 
772
- type SourceShopify = SourceShopifyBase & SourceUpdateShopify;
673
+ type SourceShopify = SourceUpdateShopify & SourceShopifyBase;
773
674
 
774
- type SourceInput = SourceBigCommerce | SourceBigQuery | SourceCommercetools | SourceCSV | SourceDocker | SourceGA4BigQueryExport | SourceJSON | SourceShopify;
675
+ type SourceInput = SourceCommercetools | SourceBigCommerce | SourceJSON | SourceCSV | SourceBigQuery | SourceGA4BigQueryExport | SourceDocker | SourceShopify;
775
676
 
776
- type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'push' | 'sfcc' | 'shopify';
677
+ type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'shopify' | 'sfcc' | 'push';
777
678
 
778
679
  type Source = {
779
680
  /**
@@ -798,17 +699,46 @@ type Source = {
798
699
  };
799
700
 
800
701
  type ListSourcesResponse = {
801
- sources: Source[];
702
+ sources: Array<Source>;
802
703
  pagination: Pagination;
803
704
  };
804
705
 
706
+ /**
707
+ * Action to perform on the Algolia index.
708
+ */
709
+ type ActionType = 'replace' | 'save' | 'partial' | 'append';
710
+
711
+ /**
712
+ * The strategy to use to fetch the data.
713
+ */
714
+ type DockerStreamsSyncMode = 'incremental' | 'fullTable';
715
+
716
+ type DockerStreams = {
717
+ /**
718
+ * The name of the stream to fetch the data from (e.g. table name).
719
+ */
720
+ name: string;
721
+ /**
722
+ * The properties of the stream to select (e.g. column).
723
+ */
724
+ properties?: Array<string>;
725
+ syncMode: DockerStreamsSyncMode;
726
+ };
727
+
728
+ /**
729
+ * The selected streams of a singer or airbyte connector.
730
+ */
731
+ type DockerStreamsInput = {
732
+ streams: Array<DockerStreams>;
733
+ };
734
+
805
735
  /**
806
736
  * Represents a market in Shopify.
807
737
  */
808
738
  type ShopifyMarket = {
809
- countries: string[];
810
- currencies: string[];
811
- locales: string[];
739
+ countries: Array<string>;
740
+ currencies: Array<string>;
741
+ locales: Array<string>;
812
742
  };
813
743
 
814
744
  /**
@@ -824,7 +754,7 @@ type ShopifyMetafield = {
824
754
  * Represents the required elements of the task input when using a `shopify` source.
825
755
  */
826
756
  type ShopifyInput = {
827
- metafields: ShopifyMetafield[];
757
+ metafields: Array<ShopifyMetafield>;
828
758
  market: ShopifyMarket;
829
759
  };
830
760
 
@@ -844,7 +774,9 @@ type MappingFieldDirective = {
844
774
  /**
845
775
  * How the destination field should be resolved from the source.
846
776
  */
847
- value: Record<string, any>;
777
+ value: {
778
+ [key: string]: any;
779
+ };
848
780
  };
849
781
 
850
782
  /**
@@ -863,7 +795,7 @@ type MappingKitAction = {
863
795
  * Condition which must be satisfied to apply the action. If this evaluates to false, the action is not applied, and the process attempts to apply the next action, if any.
864
796
  */
865
797
  trigger: string;
866
- fieldDirectives: MappingFieldDirective[];
798
+ fieldDirectives: Array<MappingFieldDirective>;
867
799
  };
868
800
 
869
801
  /**
@@ -871,7 +803,7 @@ type MappingKitAction = {
871
803
  */
872
804
  type MappingInput = {
873
805
  format: MappingFormatSchema;
874
- actions: MappingKitAction[];
806
+ actions: Array<MappingKitAction>;
875
807
  };
876
808
 
877
809
  /**
@@ -884,7 +816,7 @@ type StreamingInput = {
884
816
  /**
885
817
  * Configuration of the task, depending on its type.
886
818
  */
887
- type TaskInput = DockerStreamsInput | ShopifyInput | StreamingInput;
819
+ type TaskInput = StreamingInput | DockerStreamsInput | ShopifyInput;
888
820
 
889
821
  type Task = {
890
822
  /**
@@ -939,7 +871,7 @@ type Task = {
939
871
  * Configured tasks and pagination information.
940
872
  */
941
873
  type ListTasksResponse = {
942
- tasks: Task[];
874
+ tasks: Array<Task>;
943
875
  pagination: Pagination;
944
876
  };
945
877
 
@@ -1010,7 +942,7 @@ type SubscriptionTrigger = {
1010
942
  /**
1011
943
  * Trigger that runs the task.
1012
944
  */
1013
- type Trigger = OnDemandTrigger | ScheduleTrigger | StreamingTrigger | SubscriptionTrigger;
945
+ type Trigger = OnDemandTrigger | ScheduleTrigger | SubscriptionTrigger | StreamingTrigger;
1014
946
 
1015
947
  /**
1016
948
  * The V1 task object, please use methods and types that don\'t contain the V1 suffix.
@@ -1057,7 +989,7 @@ type TaskV1 = {
1057
989
  * Configured tasks and pagination information.
1058
990
  */
1059
991
  type ListTasksResponseV1 = {
1060
- tasks: TaskV1[];
992
+ tasks: Array<TaskV1>;
1061
993
  pagination: Pagination;
1062
994
  };
1063
995
 
@@ -1067,9 +999,9 @@ type Transformation = {
1067
999
  */
1068
1000
  transformationID: string;
1069
1001
  /**
1070
- * The authentications associated for the current transformation.
1002
+ * The authentications associated with the current transformation.
1071
1003
  */
1072
- authenticationIDs?: string[];
1004
+ authenticationIDs?: Array<string>;
1073
1005
  /**
1074
1006
  * The source code of the transformation.
1075
1007
  */
@@ -1096,53 +1028,14 @@ type Transformation = {
1096
1028
  * Configured transformations and pagination information.
1097
1029
  */
1098
1030
  type ListTransformationsResponse = {
1099
- transformations: Transformation[];
1031
+ transformations: Array<Transformation>;
1100
1032
  pagination: Pagination;
1101
1033
  };
1102
1034
 
1103
- type Model = {
1104
- fullname: string;
1105
- modelName: string;
1106
- systemPrompt: string;
1107
- id: string;
1108
- provider: string;
1109
- };
1110
-
1111
- /**
1112
- * Trigger information for manually-triggered tasks.
1113
- */
1114
- type OnDemandTriggerInput = {
1115
- type: OnDemandTriggerType;
1116
- };
1117
-
1118
- /**
1119
- * Ascending or descending sort order.
1120
- */
1121
- type OrderKeys = 'asc' | 'desc';
1122
-
1123
- /**
1124
- * Authentication resource not tied to any ecommerce platform, used for filtering.
1125
- */
1126
- type PlatformNone = 'none';
1127
-
1128
- type PlatformWithNone = Platform | PlatformNone;
1129
-
1130
- type PushTaskRecords = Record<string, any> & {
1131
- /**
1132
- * Unique record identifier.
1133
- */
1134
- objectID: string;
1135
- };
1136
-
1137
- type PushTaskPayload = {
1138
- action: Action;
1139
- records: PushTaskRecords[];
1140
- };
1141
-
1142
1035
  /**
1143
1036
  * Task run outcome.
1144
1037
  */
1145
- type RunOutcome = 'failure' | 'processing' | 'success';
1038
+ type RunOutcome = 'success' | 'failure' | 'processing';
1146
1039
 
1147
1040
  type RunProgress = {
1148
1041
  expectedNbOfEvents?: number;
@@ -1152,17 +1045,17 @@ type RunProgress = {
1152
1045
  /**
1153
1046
  * A code for the task run\'s outcome. A readable description of the code is included in the `reason` response property.
1154
1047
  */
1155
- type RunReasonCode = 'blocking' | 'critical' | 'discarded' | 'internal' | 'no_events' | 'ok' | 'too_many_errors';
1048
+ type RunReasonCode = 'internal' | 'critical' | 'no_events' | 'too_many_errors' | 'ok' | 'discarded' | 'blocking';
1156
1049
 
1157
1050
  /**
1158
1051
  * Task run status.
1159
1052
  */
1160
- type RunStatus = 'created' | 'finished' | 'idled' | 'skipped' | 'started';
1053
+ type RunStatus = 'created' | 'started' | 'idled' | 'finished' | 'skipped';
1161
1054
 
1162
1055
  /**
1163
1056
  * Task run type.
1164
1057
  */
1165
- type RunType = 'discover' | 'push' | 'reindex' | 'update' | 'validate';
1058
+ type RunType = 'reindex' | 'update' | 'discover' | 'validate' | 'push';
1166
1059
 
1167
1060
  type Run = {
1168
1061
  /**
@@ -1202,7 +1095,7 @@ type Run = {
1202
1095
  };
1203
1096
 
1204
1097
  type RunListResponse = {
1205
- runs: Run[];
1098
+ runs: Array<Run>;
1206
1099
  pagination: Pagination;
1207
1100
  window: Window;
1208
1101
  };
@@ -1221,54 +1114,19 @@ type RunResponse = {
1221
1114
  createdAt: string;
1222
1115
  };
1223
1116
 
1224
- /**
1225
- * Property by which to sort the list of task runs.
1226
- */
1227
- type RunSortKeys = 'createdAt' | 'status' | 'updatedAt';
1228
-
1229
- type RunSourcePayload = {
1230
- /**
1231
- * List of index names to include in reidexing/update.
1232
- */
1233
- indexToInclude?: string[];
1234
- /**
1235
- * List of index names to exclude in reidexing/update.
1236
- */
1237
- indexToExclude?: string[];
1238
- /**
1239
- * List of entityID to update.
1240
- */
1241
- entityIDs?: string[];
1242
- entityType?: EntityType;
1243
- };
1244
-
1245
1117
  type RunSourceResponse = {
1246
1118
  /**
1247
1119
  * Map of taskID sent for reindex with the corresponding runID.
1248
1120
  */
1249
- taskWithRunID: Record<string, string>;
1121
+ taskWithRunID: {
1122
+ [key: string]: string;
1123
+ };
1250
1124
  /**
1251
1125
  * Date of creation in RFC 3339 format.
1252
1126
  */
1253
1127
  createdAt: string;
1254
1128
  };
1255
1129
 
1256
- /**
1257
- * Trigger input for scheduled tasks.
1258
- */
1259
- type ScheduleTriggerInput = {
1260
- type: ScheduleTriggerType;
1261
- /**
1262
- * Cron expression for the task\'s schedule.
1263
- */
1264
- cron: string;
1265
- };
1266
-
1267
- /**
1268
- * Property by which to sort the list.
1269
- */
1270
- type SortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
1271
-
1272
1130
  type SourceCreate = {
1273
1131
  type: SourceType;
1274
1132
  /**
@@ -1298,56 +1156,7 @@ type SourceCreateResponse = {
1298
1156
  };
1299
1157
 
1300
1158
  type SourceSearch = {
1301
- sourceIDs: string[];
1302
- };
1303
-
1304
- /**
1305
- * Property by which to sort the list of sources.
1306
- */
1307
- type SourceSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
1308
-
1309
- type SourceUpdateCommercetools = {
1310
- storeKeys?: string[];
1311
- /**
1312
- * Locales for your commercetools stores.
1313
- */
1314
- locales?: string[];
1315
- url?: string;
1316
- /**
1317
- * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
1318
- */
1319
- fallbackIsInStockValue?: boolean;
1320
- customFields?: CommercetoolsCustomFields;
1321
- };
1322
-
1323
- type SourceUpdateDocker = {
1324
- registry?: DockerRegistry;
1325
- /**
1326
- * Docker image name.
1327
- */
1328
- image?: string;
1329
- /**
1330
- * Docker image version.
1331
- */
1332
- version?: string;
1333
- /**
1334
- * Configuration of the spec.
1335
- */
1336
- configuration: Record<string, unknown>;
1337
- };
1338
-
1339
- type SourceUpdateInput = SourceBigQuery | SourceCSV | SourceGA4BigQueryExport | SourceJSON | SourceUpdateCommercetools | SourceUpdateDocker | SourceUpdateShopify;
1340
-
1341
- type SourceUpdate = {
1342
- /**
1343
- * Descriptive name of the source.
1344
- */
1345
- name?: string;
1346
- input?: SourceUpdateInput;
1347
- /**
1348
- * Universally unique identifier (UUID) of an authentication resource.
1349
- */
1350
- authenticationID?: string;
1159
+ sourceIDs: Array<string>;
1351
1160
  };
1352
1161
 
1353
1162
  type SourceUpdateResponse = {
@@ -1371,15 +1180,15 @@ type SourceWatchResponse = {
1371
1180
  */
1372
1181
  runID?: string;
1373
1182
  /**
1374
- * Depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
1183
+ * depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
1375
1184
  */
1376
1185
  data?: Array<Record<string, unknown>>;
1377
1186
  /**
1378
- * In case of error, observability events will be added to the response, if any.
1187
+ * in case of error, observability events will be added to the response, if any.
1379
1188
  */
1380
- events?: Event[];
1189
+ events?: Array<Event>;
1381
1190
  /**
1382
- * A message describing the outcome of a validate run.
1191
+ * a message describing the outcome of a validate run.
1383
1192
  */
1384
1193
  message: string;
1385
1194
  };
@@ -1430,7 +1239,25 @@ type TaskCreateResponse = {
1430
1239
  createdAt: string;
1431
1240
  };
1432
1241
 
1433
- type TaskCreateTrigger = OnDemandTriggerInput | ScheduleTriggerInput | StreamingTrigger | SubscriptionTrigger;
1242
+ /**
1243
+ * Trigger information for manually-triggered tasks.
1244
+ */
1245
+ type OnDemandTriggerInput = {
1246
+ type: OnDemandTriggerType;
1247
+ };
1248
+
1249
+ /**
1250
+ * Trigger input for scheduled tasks.
1251
+ */
1252
+ type ScheduleTriggerInput = {
1253
+ type: ScheduleTriggerType;
1254
+ /**
1255
+ * Cron expression for the task\'s schedule.
1256
+ */
1257
+ cron: string;
1258
+ };
1259
+
1260
+ type TaskCreateTrigger = OnDemandTriggerInput | ScheduleTriggerInput | SubscriptionTrigger | StreamingTrigger;
1434
1261
 
1435
1262
  /**
1436
1263
  * API request body for creating a task using the V1 shape, please use methods and types that don\'t contain the V1 suffix.
@@ -1456,19 +1283,270 @@ type TaskCreateV1 = {
1456
1283
  failureThreshold?: number;
1457
1284
  input?: TaskInput;
1458
1285
  /**
1459
- * Date of the last cursor in RFC 3339 format.
1286
+ * Date of the last cursor in RFC 3339 format.
1287
+ */
1288
+ cursor?: string;
1289
+ };
1290
+
1291
+ type TaskSearch = {
1292
+ taskIDs: Array<string>;
1293
+ };
1294
+
1295
+ /**
1296
+ * API response for updating a task.
1297
+ */
1298
+ type TaskUpdateResponse = {
1299
+ /**
1300
+ * Universally unique identifier (UUID) of a task.
1301
+ */
1302
+ taskID: string;
1303
+ /**
1304
+ * Date of last update in RFC 3339 format.
1305
+ */
1306
+ updatedAt: string;
1307
+ };
1308
+
1309
+ /**
1310
+ * API request body for creating a transformation.
1311
+ */
1312
+ type TransformationCreate = {
1313
+ /**
1314
+ * The source code of the transformation.
1315
+ */
1316
+ code: string;
1317
+ /**
1318
+ * The uniquely identified name of your transformation.
1319
+ */
1320
+ name: string;
1321
+ /**
1322
+ * A descriptive name for your transformation of what it does.
1323
+ */
1324
+ description?: string;
1325
+ /**
1326
+ * The authentications associated with the current transformation.
1327
+ */
1328
+ authenticationIDs?: Array<string>;
1329
+ };
1330
+
1331
+ /**
1332
+ * API response for creating a transformation.
1333
+ */
1334
+ type TransformationCreateResponse = {
1335
+ /**
1336
+ * Universally unique identifier (UUID) of a transformation.
1337
+ */
1338
+ transformationID: string;
1339
+ /**
1340
+ * Date of creation in RFC 3339 format.
1341
+ */
1342
+ createdAt: string;
1343
+ };
1344
+
1345
+ type TransformationSearch = {
1346
+ transformationIDs: Array<string>;
1347
+ };
1348
+
1349
+ type TransformationTry = {
1350
+ /**
1351
+ * The source code of the transformation.
1352
+ */
1353
+ code: string;
1354
+ /**
1355
+ * The record to apply the given code to.
1356
+ */
1357
+ sampleRecord: Record<string, unknown>;
1358
+ authentications?: Array<AuthenticationCreate>;
1359
+ };
1360
+
1361
+ /**
1362
+ * The error if the transformation failed.
1363
+ */
1364
+ type TransformationError = {
1365
+ /**
1366
+ * The error status code.
1367
+ */
1368
+ code?: number;
1369
+ /**
1370
+ * A descriptive message explaining the failure.
1371
+ */
1372
+ message?: string;
1373
+ };
1374
+
1375
+ type TransformationTryResponse = {
1376
+ /**
1377
+ * The array of records returned by the transformation service.
1378
+ */
1379
+ payloads: Array<Record<string, unknown>>;
1380
+ error?: TransformationError;
1381
+ };
1382
+
1383
+ /**
1384
+ * API response for updating a transformation.
1385
+ */
1386
+ type TransformationUpdateResponse = {
1387
+ /**
1388
+ * Universally unique identifier (UUID) of a transformation.
1389
+ */
1390
+ transformationID: string;
1391
+ /**
1392
+ * Date of last update in RFC 3339 format.
1393
+ */
1394
+ updatedAt: string;
1395
+ };
1396
+
1397
+ /**
1398
+ * Property by which to sort the list of authentications.
1399
+ */
1400
+ type AuthenticationSortKeys = 'name' | 'type' | 'platform' | 'updatedAt' | 'createdAt';
1401
+
1402
+ /**
1403
+ * Request body for updating an authentication resource.
1404
+ */
1405
+ type AuthenticationUpdate = {
1406
+ type?: AuthenticationType;
1407
+ /**
1408
+ * Descriptive name for the resource.
1409
+ */
1410
+ name?: string;
1411
+ platform?: Platform | null;
1412
+ input?: AuthInputPartial;
1413
+ };
1414
+
1415
+ /**
1416
+ * Property by which to sort the destinations.
1417
+ */
1418
+ type DestinationSortKeys = 'name' | 'type' | 'updatedAt' | 'createdAt';
1419
+
1420
+ /**
1421
+ * API request body for updating a destination.
1422
+ */
1423
+ type DestinationUpdate = {
1424
+ type?: DestinationType;
1425
+ /**
1426
+ * Descriptive name for the resource.
1427
+ */
1428
+ name?: string;
1429
+ input?: DestinationInput;
1430
+ /**
1431
+ * Universally unique identifier (UUID) of an authentication resource.
1432
+ */
1433
+ authenticationID?: string;
1434
+ transformationIDs?: Array<string>;
1435
+ };
1436
+
1437
+ /**
1438
+ * Property by which to sort the list of task run events.
1439
+ */
1440
+ type EventSortKeys = 'status' | 'type' | 'publishedAt';
1441
+
1442
+ /**
1443
+ * Ascending or descending sort order.
1444
+ */
1445
+ type OrderKeys = 'asc' | 'desc';
1446
+
1447
+ /**
1448
+ * Authentication resource not tied to any ecommerce platform, used for filtering.
1449
+ */
1450
+ type PlatformNone = 'none';
1451
+
1452
+ type PlatformWithNone = Platform | PlatformNone;
1453
+
1454
+ /**
1455
+ * Type of indexing operation.
1456
+ */
1457
+ type Action = 'addObject' | 'updateObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'deleteObject' | 'delete' | 'clear';
1458
+
1459
+ type PushTaskRecords = Record<string, any> & {
1460
+ /**
1461
+ * Unique record identifier.
1462
+ */
1463
+ objectID: string;
1464
+ };
1465
+
1466
+ type PushTaskPayload = {
1467
+ action: Action;
1468
+ records: Array<PushTaskRecords>;
1469
+ };
1470
+
1471
+ /**
1472
+ * Property by which to sort the list of task runs.
1473
+ */
1474
+ type RunSortKeys = 'status' | 'updatedAt' | 'createdAt';
1475
+
1476
+ /**
1477
+ * Type of entity to update.
1478
+ */
1479
+ type EntityType = 'product' | 'collection';
1480
+
1481
+ type RunSourcePayload = {
1482
+ /**
1483
+ * List of index names to include in reidexing/update.
1484
+ */
1485
+ indexToInclude?: Array<string>;
1486
+ /**
1487
+ * List of index names to exclude in reidexing/update.
1488
+ */
1489
+ indexToExclude?: Array<string>;
1490
+ /**
1491
+ * List of entityID to update.
1492
+ */
1493
+ entityIDs?: Array<string>;
1494
+ entityType?: EntityType;
1495
+ };
1496
+
1497
+ /**
1498
+ * Property by which to sort the list of sources.
1499
+ */
1500
+ type SourceSortKeys = 'name' | 'type' | 'updatedAt' | 'createdAt';
1501
+
1502
+ type SourceUpdateCommercetools = {
1503
+ storeKeys?: Array<string>;
1504
+ /**
1505
+ * Locales for your commercetools stores.
1506
+ */
1507
+ locales?: Array<string>;
1508
+ url?: string;
1509
+ /**
1510
+ * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
1511
+ */
1512
+ fallbackIsInStockValue?: boolean;
1513
+ customFields?: CommercetoolsCustomFields;
1514
+ };
1515
+
1516
+ type SourceUpdateDocker = {
1517
+ registry?: DockerRegistry;
1518
+ /**
1519
+ * Docker image name.
1520
+ */
1521
+ image?: string;
1522
+ /**
1523
+ * Docker image version.
1524
+ */
1525
+ version?: string;
1526
+ /**
1527
+ * Configuration of the spec.
1528
+ */
1529
+ configuration: Record<string, unknown>;
1530
+ };
1531
+
1532
+ type SourceUpdateInput = SourceUpdateCommercetools | SourceJSON | SourceCSV | SourceBigQuery | SourceGA4BigQueryExport | SourceUpdateDocker | SourceUpdateShopify;
1533
+
1534
+ type SourceUpdate = {
1535
+ /**
1536
+ * Descriptive name of the source.
1537
+ */
1538
+ name?: string;
1539
+ input?: SourceUpdateInput;
1540
+ /**
1541
+ * Universally unique identifier (UUID) of an authentication resource.
1460
1542
  */
1461
- cursor?: string;
1462
- };
1463
-
1464
- type TaskSearch = {
1465
- taskIDs: string[];
1543
+ authenticationID?: string;
1466
1544
  };
1467
1545
 
1468
1546
  /**
1469
1547
  * Property by which to sort the list of tasks.
1470
1548
  */
1471
- type TaskSortKeys = 'action' | 'createdAt' | 'enabled' | 'triggerType' | 'updatedAt';
1549
+ type TaskSortKeys = 'enabled' | 'triggerType' | 'action' | 'updatedAt' | 'createdAt';
1472
1550
 
1473
1551
  /**
1474
1552
  * API request body for updating a task.
@@ -1493,20 +1571,6 @@ type TaskUpdate = {
1493
1571
  failureThreshold?: number;
1494
1572
  };
1495
1573
 
1496
- /**
1497
- * API response for updating a task.
1498
- */
1499
- type TaskUpdateResponse = {
1500
- /**
1501
- * Universally unique identifier (UUID) of a task.
1502
- */
1503
- taskID: string;
1504
- /**
1505
- * Date of last update in RFC 3339 format.
1506
- */
1507
- updatedAt: string;
1508
- };
1509
-
1510
1574
  /**
1511
1575
  * Trigger for a task update.
1512
1576
  */
@@ -1538,104 +1602,14 @@ type TaskUpdateV1 = {
1538
1602
  };
1539
1603
 
1540
1604
  /**
1541
- * API request body for creating a transformation.
1542
- */
1543
- type TransformationCreate = {
1544
- /**
1545
- * The source code of the transformation.
1546
- */
1547
- code: string;
1548
- /**
1549
- * The uniquely identified name of your transformation.
1550
- */
1551
- name: string;
1552
- /**
1553
- * A descriptive name for your transformation of what it does.
1554
- */
1555
- description?: string;
1556
- /**
1557
- * The authentications associated for the current transformation.
1558
- */
1559
- authenticationIDs?: string[];
1560
- };
1561
-
1562
- /**
1563
- * API response for creating a transformation.
1564
- */
1565
- type TransformationCreateResponse = {
1566
- /**
1567
- * Universally unique identifier (UUID) of a transformation.
1568
- */
1569
- transformationID: string;
1570
- /**
1571
- * Date of creation in RFC 3339 format.
1572
- */
1573
- createdAt: string;
1574
- };
1575
-
1576
- /**
1577
- * The error if the transformation failed.
1578
- */
1579
- type TransformationError = {
1580
- /**
1581
- * The error status code.
1582
- */
1583
- code?: number;
1584
- /**
1585
- * A descriptive message explaining the failure.
1586
- */
1587
- message?: string;
1588
- };
1589
-
1590
- /**
1591
- * List of available AI models for transformation purposes.
1592
- */
1593
- type TransformationModels = {
1594
- llms: Model[];
1595
- };
1596
-
1597
- type TransformationSearch = {
1598
- transformationIDs: string[];
1599
- };
1600
-
1601
- type TransformationTry = {
1602
- /**
1603
- * The source code of the transformation.
1604
- */
1605
- code: string;
1606
- /**
1607
- * The record to apply the given code to.
1608
- */
1609
- sampleRecord: Record<string, unknown>;
1610
- authentications?: AuthenticationCreate[];
1611
- };
1612
-
1613
- type TransformationTryResponse = {
1614
- /**
1615
- * The array of records returned by the transformation service.
1616
- */
1617
- payloads: Array<Record<string, unknown>>;
1618
- error?: TransformationError;
1619
- };
1620
-
1621
- /**
1622
- * API response for updating a transformation.
1605
+ * Property by which to sort the list of transformations.
1623
1606
  */
1624
- type TransformationUpdateResponse = {
1625
- /**
1626
- * Universally unique identifier (UUID) of a transformation.
1627
- */
1628
- transformationID: string;
1629
- /**
1630
- * Date of last update in RFC 3339 format.
1631
- */
1632
- updatedAt: string;
1633
- };
1607
+ type TransformationSortKeys = 'name' | 'updatedAt' | 'createdAt';
1634
1608
 
1635
1609
  /**
1636
1610
  * Task trigger, describing when a task should run. - `onDemand`. Manually trigger the task with the `/run` endpoint. - `schedule`. Regularly trigger the task on a `cron` schedule. - `subscription`. Trigger the task after an event is received, such as, a webhook. - `streaming`. Run the task continuously.
1637
1611
  */
1638
- type TriggerType = 'onDemand' | 'schedule' | 'streaming' | 'subscription';
1612
+ type TriggerType = 'onDemand' | 'schedule' | 'subscription' | 'streaming';
1639
1613
 
1640
1614
  /**
1641
1615
  * Properties for the `customDelete` method.
@@ -1648,7 +1622,9 @@ type CustomDeleteProps = {
1648
1622
  /**
1649
1623
  * Query parameters to apply to the current query.
1650
1624
  */
1651
- parameters?: Record<string, any>;
1625
+ parameters?: {
1626
+ [key: string]: any;
1627
+ };
1652
1628
  };
1653
1629
  /**
1654
1630
  * Properties for the `customGet` method.
@@ -1661,7 +1637,9 @@ type CustomGetProps = {
1661
1637
  /**
1662
1638
  * Query parameters to apply to the current query.
1663
1639
  */
1664
- parameters?: Record<string, any>;
1640
+ parameters?: {
1641
+ [key: string]: any;
1642
+ };
1665
1643
  };
1666
1644
  /**
1667
1645
  * Properties for the `customPost` method.
@@ -1674,7 +1652,9 @@ type CustomPostProps = {
1674
1652
  /**
1675
1653
  * Query parameters to apply to the current query.
1676
1654
  */
1677
- parameters?: Record<string, any>;
1655
+ parameters?: {
1656
+ [key: string]: any;
1657
+ };
1678
1658
  /**
1679
1659
  * Parameters to send with the custom request.
1680
1660
  */
@@ -1691,7 +1671,9 @@ type CustomPutProps = {
1691
1671
  /**
1692
1672
  * Query parameters to apply to the current query.
1693
1673
  */
1694
- parameters?: Record<string, any>;
1674
+ parameters?: {
1675
+ [key: string]: any;
1676
+ };
1695
1677
  /**
1696
1678
  * Parameters to send with the custom request.
1697
1679
  */
@@ -1878,13 +1860,13 @@ type ListAuthenticationsProps = {
1878
1860
  /**
1879
1861
  * Type of authentication resource to retrieve.
1880
1862
  */
1881
- type?: AuthenticationType[];
1863
+ type?: Array<AuthenticationType>;
1882
1864
  /**
1883
- * Ecommerce platform for which to retrieve authentication resources.
1865
+ * Ecommerce platform for which to retrieve authentications.
1884
1866
  */
1885
- platform?: PlatformWithNone[];
1867
+ platform?: Array<PlatformWithNone>;
1886
1868
  /**
1887
- * Property by which to sort the list of authentication resources.
1869
+ * Property by which to sort the list of authentications.
1888
1870
  */
1889
1871
  sort?: AuthenticationSortKeys;
1890
1872
  /**
@@ -1907,11 +1889,15 @@ type ListDestinationsProps = {
1907
1889
  /**
1908
1890
  * Destination type.
1909
1891
  */
1910
- type?: DestinationType[];
1892
+ type?: Array<DestinationType>;
1911
1893
  /**
1912
1894
  * Authentication ID used by destinations.
1913
1895
  */
1914
- authenticationID?: string[];
1896
+ authenticationID?: Array<string>;
1897
+ /**
1898
+ * Get the list of destinations used by a transformation.
1899
+ */
1900
+ transformationID?: string;
1915
1901
  /**
1916
1902
  * Property by which to sort the destinations.
1917
1903
  */
@@ -1940,11 +1926,11 @@ type ListEventsProps = {
1940
1926
  /**
1941
1927
  * Event status for filtering the list of task runs.
1942
1928
  */
1943
- status?: EventStatus[];
1929
+ status?: Array<EventStatus>;
1944
1930
  /**
1945
1931
  * Event type for filtering the list of task runs.
1946
1932
  */
1947
- type?: EventType[];
1933
+ type?: Array<EventType>;
1948
1934
  /**
1949
1935
  * Property by which to sort the list of task run events.
1950
1936
  */
@@ -1977,11 +1963,11 @@ type ListRunsProps = {
1977
1963
  /**
1978
1964
  * Run status for filtering the list of task runs.
1979
1965
  */
1980
- status?: RunStatus[];
1966
+ status?: Array<RunStatus>;
1981
1967
  /**
1982
1968
  * Run type for filtering the list of task runs.
1983
1969
  */
1984
- type?: RunType[];
1970
+ type?: Array<RunType>;
1985
1971
  /**
1986
1972
  * Task ID for filtering the list of task runs.
1987
1973
  */
@@ -2018,11 +2004,11 @@ type ListSourcesProps = {
2018
2004
  /**
2019
2005
  * Source type. Some sources require authentication.
2020
2006
  */
2021
- type?: SourceType[];
2007
+ type?: Array<SourceType>;
2022
2008
  /**
2023
- * Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
2009
+ * Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
2024
2010
  */
2025
- authenticationID?: string[];
2011
+ authenticationID?: Array<string>;
2026
2012
  /**
2027
2013
  * Property by which to sort the list of sources.
2028
2014
  */
@@ -2047,7 +2033,7 @@ type ListTasksProps = {
2047
2033
  /**
2048
2034
  * Actions for filtering the list of tasks.
2049
2035
  */
2050
- action?: ActionType[];
2036
+ action?: Array<ActionType>;
2051
2037
  /**
2052
2038
  * Whether to filter the list of tasks by the `enabled` status.
2053
2039
  */
@@ -2055,15 +2041,15 @@ type ListTasksProps = {
2055
2041
  /**
2056
2042
  * Source IDs for filtering the list of tasks.
2057
2043
  */
2058
- sourceID?: string[];
2044
+ sourceID?: Array<string>;
2059
2045
  /**
2060
2046
  * Destination IDs for filtering the list of tasks.
2061
2047
  */
2062
- destinationID?: string[];
2048
+ destinationID?: Array<string>;
2063
2049
  /**
2064
2050
  * Type of task trigger for filtering the list of tasks.
2065
2051
  */
2066
- triggerType?: TriggerType[];
2052
+ triggerType?: Array<TriggerType>;
2067
2053
  /**
2068
2054
  * Property by which to sort the list of tasks.
2069
2055
  */
@@ -2088,7 +2074,7 @@ type ListTasksV1Props = {
2088
2074
  /**
2089
2075
  * Actions for filtering the list of tasks.
2090
2076
  */
2091
- action?: ActionType[];
2077
+ action?: Array<ActionType>;
2092
2078
  /**
2093
2079
  * Whether to filter the list of tasks by the `enabled` status.
2094
2080
  */
@@ -2096,15 +2082,15 @@ type ListTasksV1Props = {
2096
2082
  /**
2097
2083
  * Source IDs for filtering the list of tasks.
2098
2084
  */
2099
- sourceID?: string[];
2085
+ sourceID?: Array<string>;
2100
2086
  /**
2101
2087
  * Destination IDs for filtering the list of tasks.
2102
2088
  */
2103
- destinationID?: string[];
2089
+ destinationID?: Array<string>;
2104
2090
  /**
2105
2091
  * Type of task trigger for filtering the list of tasks.
2106
2092
  */
2107
- triggerType?: TriggerType[];
2093
+ triggerType?: Array<TriggerType>;
2108
2094
  /**
2109
2095
  * Property by which to sort the list of tasks.
2110
2096
  */
@@ -2127,9 +2113,9 @@ type ListTransformationsProps = {
2127
2113
  */
2128
2114
  page?: number;
2129
2115
  /**
2130
- * Property by which to sort the list.
2116
+ * Property by which to sort the list of transformations.
2131
2117
  */
2132
- sort?: SortKeys;
2118
+ sort?: TransformationSortKeys;
2133
2119
  /**
2134
2120
  * Sort order of the response, ascending or descending.
2135
2121
  */
@@ -2269,9 +2255,12 @@ type ValidateSourceBeforeUpdateProps = {
2269
2255
  sourceUpdate: SourceUpdate;
2270
2256
  };
2271
2257
 
2272
- declare const apiClientVersion = "1.2.4";
2258
+ declare const apiClientVersion = "1.10.0";
2273
2259
  declare const REGIONS: readonly ["eu", "us"];
2274
2260
  type Region = (typeof REGIONS)[number];
2261
+ type RegionOptions = {
2262
+ region: Region;
2263
+ };
2275
2264
  /**
2276
2265
  * Guard: Return strongly typed specific OnDemandTrigger for a given Trigger.
2277
2266
  *
@@ -2293,76 +2282,719 @@ declare function isScheduleTrigger(trigger: TaskCreateTrigger | Trigger): trigge
2293
2282
  * @param trigger - The given Task Trigger.
2294
2283
  */
2295
2284
  declare function isSubscriptionTrigger(trigger: TaskCreateTrigger | Trigger): trigger is SubscriptionTrigger;
2296
-
2297
- /**
2298
- * The client type.
2299
- */
2300
- type IngestionClient = ReturnType<typeof ingestionClient>;
2301
- declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): {
2285
+ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & RegionOptions): {
2302
2286
  transporter: _algolia_client_common.Transporter;
2287
+ /**
2288
+ * The `appId` currently in use.
2289
+ */
2303
2290
  appId: string;
2291
+ /**
2292
+ * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
2293
+ */
2304
2294
  clearCache(): Promise<void>;
2295
+ /**
2296
+ * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
2297
+ */
2305
2298
  readonly _ua: string;
2299
+ /**
2300
+ * Adds a `segment` to the `x-algolia-agent` sent with every requests.
2301
+ *
2302
+ * @param segment - The algolia agent (user-agent) segment to add.
2303
+ * @param version - The version of the agent.
2304
+ */
2306
2305
  addAlgoliaAgent(segment: string, version?: string): void;
2307
- createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions?: _algolia_client_common.RequestOptions): Promise<AuthenticationCreateResponse>;
2308
- createDestination(destinationCreate: DestinationCreate, requestOptions?: _algolia_client_common.RequestOptions): Promise<DestinationCreateResponse>;
2309
- createSource(sourceCreate: SourceCreate, requestOptions?: _algolia_client_common.RequestOptions): Promise<SourceCreateResponse>;
2310
- createTask(taskCreate: TaskCreate, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskCreateResponse>;
2311
- createTaskV1(taskCreate: TaskCreateV1, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskCreateResponse>;
2312
- createTransformation(transformationCreate: TransformationCreate, requestOptions?: _algolia_client_common.RequestOptions): Promise<TransformationCreateResponse>;
2313
- customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
2314
- customGet({ path, parameters }: CustomGetProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
2315
- customPost({ path, parameters, body }: CustomPostProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
2316
- customPut({ path, parameters, body }: CustomPutProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Record<string, unknown>>;
2317
- deleteAuthentication({ authenticationID }: DeleteAuthenticationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteResponse>;
2318
- deleteDestination({ destinationID }: DeleteDestinationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteResponse>;
2319
- deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteResponse>;
2320
- deleteTask({ taskID }: DeleteTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteResponse>;
2321
- deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteResponse>;
2322
- deleteTransformation({ transformationID }: DeleteTransformationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DeleteResponse>;
2323
- disableTask({ taskID }: DisableTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskUpdateResponse>;
2324
- disableTaskV1({ taskID }: DisableTaskV1Props, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskUpdateResponse>;
2325
- enableTask({ taskID }: EnableTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskUpdateResponse>;
2326
- enableTaskV1({ taskID }: EnableTaskV1Props, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskUpdateResponse>;
2327
- generateTransformationCode(generateTransformationCodePayload: GenerateTransformationCodePayload, requestOptions?: _algolia_client_common.RequestOptions): Promise<GenerateTransformationCodeResponse>;
2328
- getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Authentication>;
2329
- getDestination({ destinationID }: GetDestinationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Destination>;
2330
- getEvent({ runID, eventID }: GetEventProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Event>;
2331
- getRun({ runID }: GetRunProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Run>;
2332
- getSource({ sourceID }: GetSourceProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Source>;
2333
- getTask({ taskID }: GetTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Task>;
2334
- getTaskV1({ taskID }: GetTaskV1Props, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskV1>;
2335
- getTransformation({ transformationID }: GetTransformationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<Transformation>;
2336
- listAuthentications({ itemsPerPage, page, type, platform, sort, order }?: ListAuthenticationsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
2337
- listDestinations({ itemsPerPage, page, type, authenticationID, sort, order }?: ListDestinationsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListDestinationsResponse>;
2338
- listEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }: ListEventsProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<ListEventsResponse>;
2339
- listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<RunListResponse>;
2340
- listSources({ itemsPerPage, page, type, authenticationID, sort, order }?: ListSourcesProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListSourcesResponse>;
2341
- listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListTasksResponse>;
2342
- listTasksV1({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksV1Props, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListTasksResponseV1>;
2343
- listTransformationModels(requestOptions?: _algolia_client_common.RequestOptions): Promise<TransformationModels>;
2344
- listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<ListTransformationsResponse>;
2345
- pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<RunResponse>;
2346
- runSource({ sourceID, runSourcePayload }: RunSourceProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<RunSourceResponse>;
2347
- runTask({ taskID }: RunTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<RunResponse>;
2348
- runTaskV1({ taskID }: RunTaskV1Props, requestOptions?: _algolia_client_common.RequestOptions): Promise<RunResponse>;
2349
- searchAuthentications(authenticationSearch: AuthenticationSearch, requestOptions?: _algolia_client_common.RequestOptions): Promise<Authentication[]>;
2350
- searchDestinations(destinationSearch: DestinationSearch, requestOptions?: _algolia_client_common.RequestOptions): Promise<Destination[]>;
2351
- searchSources(sourceSearch: SourceSearch, requestOptions?: _algolia_client_common.RequestOptions): Promise<Source[]>;
2352
- searchTasks(taskSearch: TaskSearch, requestOptions?: _algolia_client_common.RequestOptions): Promise<Task[]>;
2353
- searchTasksV1(taskSearch: TaskSearch, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskV1[]>;
2354
- searchTransformations(transformationSearch: TransformationSearch, requestOptions?: _algolia_client_common.RequestOptions): Promise<Transformation[]>;
2355
- triggerDockerSourceDiscover({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<SourceWatchResponse>;
2356
- tryTransformation(transformationTry: TransformationTry, requestOptions?: _algolia_client_common.RequestOptions): Promise<TransformationTryResponse>;
2357
- tryTransformationBeforeUpdate({ transformationID, transformationTry }: TryTransformationBeforeUpdateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<TransformationTryResponse>;
2358
- updateAuthentication({ authenticationID, authenticationUpdate }: UpdateAuthenticationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<AuthenticationUpdateResponse>;
2359
- updateDestination({ destinationID, destinationUpdate }: UpdateDestinationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<DestinationUpdateResponse>;
2360
- updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<SourceUpdateResponse>;
2361
- updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskUpdateResponse>;
2362
- updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: _algolia_client_common.RequestOptions): Promise<TaskUpdateResponse>;
2363
- updateTransformation({ transformationID, transformationCreate }: UpdateTransformationProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<TransformationUpdateResponse>;
2364
- validateSource(sourceCreate: SourceCreate, requestOptions?: _algolia_client_common.RequestOptions | undefined): Promise<SourceWatchResponse>;
2365
- validateSourceBeforeUpdate({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: _algolia_client_common.RequestOptions): Promise<SourceWatchResponse>;
2366
- };
2367
-
2368
- export { type Action, type ActionType, type AuthAPIKey, type AuthAPIKeyPartial, type AuthAlgolia, type AuthAlgoliaInsights, type AuthAlgoliaInsightsPartial, type AuthAlgoliaPartial, type AuthBasic, type AuthBasicPartial, type AuthGoogleServiceAccount, type AuthGoogleServiceAccountPartial, type AuthInput, type AuthInputPartial, type AuthOAuth, type AuthOAuthPartial, type Authentication, type AuthenticationCreate, type AuthenticationCreateResponse, type AuthenticationSearch, type AuthenticationSortKeys, type AuthenticationType, type AuthenticationUpdate, type AuthenticationUpdateResponse, type BigCommerceChannel, type BigCommerceMetafield, type BigQueryDataType, type CommercetoolsCustomFields, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteAuthenticationProps, type DeleteDestinationProps, type DeleteResponse, type DeleteSourceProps, type DeleteTaskProps, type DeleteTaskV1Props, type DeleteTransformationProps, type Destination, type DestinationCreate, type DestinationCreateResponse, type DestinationIndexName, type DestinationInput, type DestinationSearch, type DestinationSortKeys, type DestinationType, type DestinationUpdate, type DestinationUpdateResponse, type DisableTaskProps, type DisableTaskV1Props, type DockerImageType, type DockerRegistry, type DockerStreams, type DockerStreamsInput, type DockerStreamsSyncMode, type EnableTaskProps, type EnableTaskV1Props, type EntityType, type ErrorBase, type Event, type EventSortKeys, type EventStatus, type EventType, type GenerateTransformationCodePayload, type GenerateTransformationCodeResponse, type GetAuthenticationProps, type GetDestinationProps, type GetEventProps, type GetRunProps, type GetSourceProps, type GetTaskProps, type GetTaskV1Props, type GetTransformationProps, type IngestionClient, type ListAuthenticationsProps, type ListAuthenticationsResponse, type ListDestinationsProps, type ListDestinationsResponse, type ListEventsProps, type ListEventsResponse, type ListRunsProps, type ListSourcesProps, type ListSourcesResponse, type ListTasksProps, type ListTasksResponse, type ListTasksResponseV1, type ListTasksV1Props, type ListTransformationsProps, type ListTransformationsResponse, type MappingFieldDirective, type MappingFormatSchema, type MappingInput, type MappingKitAction, type MappingTypeCSV, type MethodType, type Model, type OnDemandTrigger, type OnDemandTriggerInput, type OnDemandTriggerType, type OrderKeys, type Pagination, type Platform, type PlatformNone, type PlatformWithNone, type PushTaskPayload, type PushTaskProps, type PushTaskRecords, type RecordType, type Region, type Run, type RunListResponse, type RunOutcome, type RunProgress, type RunReasonCode, type RunResponse, type RunSortKeys, type RunSourcePayload, type RunSourceProps, type RunSourceResponse, type RunStatus, type RunTaskProps, type RunTaskV1Props, type RunType, type ScheduleTrigger, type ScheduleTriggerInput, type ScheduleTriggerType, type ShopifyInput, type ShopifyMarket, type ShopifyMetafield, type SortKeys, type Source, type SourceBigCommerce, type SourceBigQuery, type SourceCSV, type SourceCommercetools, type SourceCreate, type SourceCreateResponse, type SourceDocker, type SourceGA4BigQueryExport, type SourceInput, type SourceJSON, type SourceSearch, type SourceShopify, type SourceShopifyBase, type SourceSortKeys, type SourceType, type SourceUpdate, type SourceUpdateCommercetools, type SourceUpdateDocker, type SourceUpdateInput, type SourceUpdateResponse, type SourceUpdateShopify, type SourceWatchResponse, type StreamingInput, type StreamingTrigger, type StreamingTriggerType, type SubscriptionTrigger, type SubscriptionTriggerType, type Task, type TaskCreate, type TaskCreateResponse, type TaskCreateTrigger, type TaskCreateV1, type TaskInput, type TaskSearch, type TaskSortKeys, type TaskUpdate, type TaskUpdateResponse, type TaskUpdateV1, type TaskV1, type Transformation, type TransformationCreate, type TransformationCreateResponse, type TransformationError, type TransformationModels, type TransformationSearch, type TransformationTry, type TransformationTryResponse, type TransformationUpdateResponse, type Trigger, type TriggerDockerSourceDiscoverProps, type TriggerType, type TriggerUpdateInput, type TryTransformationBeforeUpdateProps, type UpdateAuthenticationProps, type UpdateDestinationProps, type UpdateSourceProps, type UpdateTaskProps, type UpdateTaskV1Props, type UpdateTransformationProps, type ValidateSourceBeforeUpdateProps, type Window, apiClientVersion, ingestionClient, isOnDemandTrigger, isScheduleTrigger, isSubscriptionTrigger };
2306
+ /**
2307
+ * Helper method to switch the API key used to authenticate the requests.
2308
+ *
2309
+ * @param params - Method params.
2310
+ * @param params.apiKey - The new API Key to use.
2311
+ */
2312
+ setClientApiKey({ apiKey }: {
2313
+ apiKey: string;
2314
+ }): void;
2315
+ /**
2316
+ * Creates a new authentication resource.
2317
+ *
2318
+ * Required API Key ACLs:
2319
+ * - addObject
2320
+ * - deleteIndex
2321
+ * - editSettings
2322
+ * @param authenticationCreate -
2323
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2324
+ */
2325
+ createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions?: RequestOptions): Promise<AuthenticationCreateResponse>;
2326
+ /**
2327
+ * Creates a new destination.
2328
+ *
2329
+ * Required API Key ACLs:
2330
+ * - addObject
2331
+ * - deleteIndex
2332
+ * - editSettings
2333
+ * @param destinationCreate -
2334
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2335
+ */
2336
+ createDestination(destinationCreate: DestinationCreate, requestOptions?: RequestOptions): Promise<DestinationCreateResponse>;
2337
+ /**
2338
+ * Creates a new source.
2339
+ *
2340
+ * Required API Key ACLs:
2341
+ * - addObject
2342
+ * - deleteIndex
2343
+ * - editSettings
2344
+ * @param sourceCreate -
2345
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2346
+ */
2347
+ createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
2348
+ /**
2349
+ * Creates a new task.
2350
+ * @param taskCreate - Request body for creating a task.
2351
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2352
+ */
2353
+ createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
2354
+ /**
2355
+ * Creates a new task using the v1 endpoint, please use `createTask` instead.
2356
+ * @param taskCreate - Request body for creating a task.
2357
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2358
+ */
2359
+ createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
2360
+ /**
2361
+ * Creates a new transformation.
2362
+ * @param transformationCreate - Request body for creating a transformation.
2363
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2364
+ */
2365
+ createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
2366
+ /**
2367
+ * This method allow you to send requests to the Algolia REST API.
2368
+ * @param customDelete - The customDelete object.
2369
+ * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
2370
+ * @param customDelete.parameters - Query parameters to apply to the current query.
2371
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2372
+ */
2373
+ customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2374
+ /**
2375
+ * This method allow you to send requests to the Algolia REST API.
2376
+ * @param customGet - The customGet object.
2377
+ * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
2378
+ * @param customGet.parameters - Query parameters to apply to the current query.
2379
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2380
+ */
2381
+ customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2382
+ /**
2383
+ * This method allow you to send requests to the Algolia REST API.
2384
+ * @param customPost - The customPost object.
2385
+ * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
2386
+ * @param customPost.parameters - Query parameters to apply to the current query.
2387
+ * @param customPost.body - Parameters to send with the custom request.
2388
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2389
+ */
2390
+ customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2391
+ /**
2392
+ * This method allow you to send requests to the Algolia REST API.
2393
+ * @param customPut - The customPut object.
2394
+ * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
2395
+ * @param customPut.parameters - Query parameters to apply to the current query.
2396
+ * @param customPut.body - Parameters to send with the custom request.
2397
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2398
+ */
2399
+ customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
2400
+ /**
2401
+ * Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
2402
+ *
2403
+ * Required API Key ACLs:
2404
+ * - addObject
2405
+ * - deleteIndex
2406
+ * - editSettings
2407
+ * @param deleteAuthentication - The deleteAuthentication object.
2408
+ * @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
2409
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2410
+ */
2411
+ deleteAuthentication({ authenticationID }: DeleteAuthenticationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2412
+ /**
2413
+ * Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
2414
+ *
2415
+ * Required API Key ACLs:
2416
+ * - addObject
2417
+ * - deleteIndex
2418
+ * - editSettings
2419
+ * @param deleteDestination - The deleteDestination object.
2420
+ * @param deleteDestination.destinationID - Unique identifier of a destination.
2421
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2422
+ */
2423
+ deleteDestination({ destinationID }: DeleteDestinationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2424
+ /**
2425
+ * Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
2426
+ *
2427
+ * Required API Key ACLs:
2428
+ * - addObject
2429
+ * - deleteIndex
2430
+ * - editSettings
2431
+ * @param deleteSource - The deleteSource object.
2432
+ * @param deleteSource.sourceID - Unique identifier of a source.
2433
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2434
+ */
2435
+ deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2436
+ /**
2437
+ * Deletes a task by its ID.
2438
+ * @param deleteTask - The deleteTask object.
2439
+ * @param deleteTask.taskID - Unique identifier of a task.
2440
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2441
+ */
2442
+ deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2443
+ /**
2444
+ * Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
2445
+ * @param deleteTaskV1 - The deleteTaskV1 object.
2446
+ * @param deleteTaskV1.taskID - Unique identifier of a task.
2447
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2448
+ */
2449
+ deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2450
+ /**
2451
+ * Deletes a transformation by its ID.
2452
+ * @param deleteTransformation - The deleteTransformation object.
2453
+ * @param deleteTransformation.transformationID - Unique identifier of a transformation.
2454
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2455
+ */
2456
+ deleteTransformation({ transformationID }: DeleteTransformationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
2457
+ /**
2458
+ * Disables a task.
2459
+ *
2460
+ * Required API Key ACLs:
2461
+ * - addObject
2462
+ * - deleteIndex
2463
+ * - editSettings
2464
+ * @param disableTask - The disableTask object.
2465
+ * @param disableTask.taskID - Unique identifier of a task.
2466
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2467
+ */
2468
+ disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
2469
+ /**
2470
+ * Disables a task using the v1 endpoint, please use `disableTask` instead.
2471
+ *
2472
+ * Required API Key ACLs:
2473
+ * - addObject
2474
+ * - deleteIndex
2475
+ * - editSettings
2476
+ * @param disableTaskV1 - The disableTaskV1 object.
2477
+ * @param disableTaskV1.taskID - Unique identifier of a task.
2478
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2479
+ */
2480
+ disableTaskV1({ taskID }: DisableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
2481
+ /**
2482
+ * Enables a task.
2483
+ *
2484
+ * Required API Key ACLs:
2485
+ * - addObject
2486
+ * - deleteIndex
2487
+ * - editSettings
2488
+ * @param enableTask - The enableTask object.
2489
+ * @param enableTask.taskID - Unique identifier of a task.
2490
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2491
+ */
2492
+ enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
2493
+ /**
2494
+ * Enables a task using the v1 endpoint, please use `enableTask` instead.
2495
+ *
2496
+ * Required API Key ACLs:
2497
+ * - addObject
2498
+ * - deleteIndex
2499
+ * - editSettings
2500
+ * @param enableTaskV1 - The enableTaskV1 object.
2501
+ * @param enableTaskV1.taskID - Unique identifier of a task.
2502
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2503
+ */
2504
+ enableTaskV1({ taskID }: EnableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
2505
+ /**
2506
+ * Retrieves an authentication resource by its ID.
2507
+ *
2508
+ * Required API Key ACLs:
2509
+ * - addObject
2510
+ * - deleteIndex
2511
+ * - editSettings
2512
+ * @param getAuthentication - The getAuthentication object.
2513
+ * @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
2514
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2515
+ */
2516
+ getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<Authentication>;
2517
+ /**
2518
+ * Retrieves a destination by its ID.
2519
+ *
2520
+ * Required API Key ACLs:
2521
+ * - addObject
2522
+ * - deleteIndex
2523
+ * - editSettings
2524
+ * @param getDestination - The getDestination object.
2525
+ * @param getDestination.destinationID - Unique identifier of a destination.
2526
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2527
+ */
2528
+ getDestination({ destinationID }: GetDestinationProps, requestOptions?: RequestOptions): Promise<Destination>;
2529
+ /**
2530
+ * Retrieves a single task run event by its ID.
2531
+ *
2532
+ * Required API Key ACLs:
2533
+ * - addObject
2534
+ * - deleteIndex
2535
+ * - editSettings
2536
+ * @param getEvent - The getEvent object.
2537
+ * @param getEvent.runID - Unique identifier of a task run.
2538
+ * @param getEvent.eventID - Unique identifier of an event.
2539
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2540
+ */
2541
+ getEvent({ runID, eventID }: GetEventProps, requestOptions?: RequestOptions): Promise<Event>;
2542
+ /**
2543
+ * Retrieve a single task run by its ID.
2544
+ *
2545
+ * Required API Key ACLs:
2546
+ * - addObject
2547
+ * - deleteIndex
2548
+ * - editSettings
2549
+ * @param getRun - The getRun object.
2550
+ * @param getRun.runID - Unique identifier of a task run.
2551
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2552
+ */
2553
+ getRun({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<Run>;
2554
+ /**
2555
+ * Retrieve a source by its ID.
2556
+ *
2557
+ * Required API Key ACLs:
2558
+ * - addObject
2559
+ * - deleteIndex
2560
+ * - editSettings
2561
+ * @param getSource - The getSource object.
2562
+ * @param getSource.sourceID - Unique identifier of a source.
2563
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2564
+ */
2565
+ getSource({ sourceID }: GetSourceProps, requestOptions?: RequestOptions): Promise<Source>;
2566
+ /**
2567
+ * Retrieves a task by its ID.
2568
+ *
2569
+ * Required API Key ACLs:
2570
+ * - addObject
2571
+ * - deleteIndex
2572
+ * - editSettings
2573
+ * @param getTask - The getTask object.
2574
+ * @param getTask.taskID - Unique identifier of a task.
2575
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2576
+ */
2577
+ getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
2578
+ /**
2579
+ * Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
2580
+ *
2581
+ * Required API Key ACLs:
2582
+ * - addObject
2583
+ * - deleteIndex
2584
+ * - editSettings
2585
+ * @param getTaskV1 - The getTaskV1 object.
2586
+ * @param getTaskV1.taskID - Unique identifier of a task.
2587
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2588
+ */
2589
+ getTaskV1({ taskID }: GetTaskV1Props, requestOptions?: RequestOptions): Promise<TaskV1>;
2590
+ /**
2591
+ * Retrieves a transformation by its ID.
2592
+ *
2593
+ * Required API Key ACLs:
2594
+ * - addObject
2595
+ * - deleteIndex
2596
+ * - editSettings
2597
+ * @param getTransformation - The getTransformation object.
2598
+ * @param getTransformation.transformationID - Unique identifier of a transformation.
2599
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2600
+ */
2601
+ getTransformation({ transformationID }: GetTransformationProps, requestOptions?: RequestOptions): Promise<Transformation>;
2602
+ /**
2603
+ * Retrieves a list of all authentication resources.
2604
+ *
2605
+ * Required API Key ACLs:
2606
+ * - addObject
2607
+ * - deleteIndex
2608
+ * - editSettings
2609
+ * @param listAuthentications - The listAuthentications object.
2610
+ * @param listAuthentications.itemsPerPage - Number of items per page.
2611
+ * @param listAuthentications.page - Page number of the paginated API response.
2612
+ * @param listAuthentications.type - Type of authentication resource to retrieve.
2613
+ * @param listAuthentications.platform - Ecommerce platform for which to retrieve authentications.
2614
+ * @param listAuthentications.sort - Property by which to sort the list of authentications.
2615
+ * @param listAuthentications.order - Sort order of the response, ascending or descending.
2616
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2617
+ */
2618
+ listAuthentications({ itemsPerPage, page, type, platform, sort, order }?: ListAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
2619
+ /**
2620
+ * Retrieves a list of destinations.
2621
+ *
2622
+ * Required API Key ACLs:
2623
+ * - addObject
2624
+ * - deleteIndex
2625
+ * - editSettings
2626
+ * @param listDestinations - The listDestinations object.
2627
+ * @param listDestinations.itemsPerPage - Number of items per page.
2628
+ * @param listDestinations.page - Page number of the paginated API response.
2629
+ * @param listDestinations.type - Destination type.
2630
+ * @param listDestinations.authenticationID - Authentication ID used by destinations.
2631
+ * @param listDestinations.transformationID - Get the list of destinations used by a transformation.
2632
+ * @param listDestinations.sort - Property by which to sort the destinations.
2633
+ * @param listDestinations.order - Sort order of the response, ascending or descending.
2634
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2635
+ */
2636
+ listDestinations({ itemsPerPage, page, type, authenticationID, transformationID, sort, order }?: ListDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
2637
+ /**
2638
+ * Retrieves a list of events for a task run, identified by its ID.
2639
+ *
2640
+ * Required API Key ACLs:
2641
+ * - addObject
2642
+ * - deleteIndex
2643
+ * - editSettings
2644
+ * @param listEvents - The listEvents object.
2645
+ * @param listEvents.runID - Unique identifier of a task run.
2646
+ * @param listEvents.itemsPerPage - Number of items per page.
2647
+ * @param listEvents.page - Page number of the paginated API response.
2648
+ * @param listEvents.status - Event status for filtering the list of task runs.
2649
+ * @param listEvents.type - Event type for filtering the list of task runs.
2650
+ * @param listEvents.sort - Property by which to sort the list of task run events.
2651
+ * @param listEvents.order - Sort order of the response, ascending or descending.
2652
+ * @param listEvents.startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
2653
+ * @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
2654
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2655
+ */
2656
+ listEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }: ListEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
2657
+ /**
2658
+ * Retrieve a list of task runs.
2659
+ *
2660
+ * Required API Key ACLs:
2661
+ * - addObject
2662
+ * - deleteIndex
2663
+ * - editSettings
2664
+ * @param listRuns - The listRuns object.
2665
+ * @param listRuns.itemsPerPage - Number of items per page.
2666
+ * @param listRuns.page - Page number of the paginated API response.
2667
+ * @param listRuns.status - Run status for filtering the list of task runs.
2668
+ * @param listRuns.type - Run type for filtering the list of task runs.
2669
+ * @param listRuns.taskID - Task ID for filtering the list of task runs.
2670
+ * @param listRuns.sort - Property by which to sort the list of task runs.
2671
+ * @param listRuns.order - Sort order of the response, ascending or descending.
2672
+ * @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
2673
+ * @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
2674
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2675
+ */
2676
+ listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
2677
+ /**
2678
+ * Retrieves a list of sources.
2679
+ *
2680
+ * Required API Key ACLs:
2681
+ * - addObject
2682
+ * - deleteIndex
2683
+ * - editSettings
2684
+ * @param listSources - The listSources object.
2685
+ * @param listSources.itemsPerPage - Number of items per page.
2686
+ * @param listSources.page - Page number of the paginated API response.
2687
+ * @param listSources.type - Source type. Some sources require authentication.
2688
+ * @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
2689
+ * @param listSources.sort - Property by which to sort the list of sources.
2690
+ * @param listSources.order - Sort order of the response, ascending or descending.
2691
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2692
+ */
2693
+ listSources({ itemsPerPage, page, type, authenticationID, sort, order }?: ListSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
2694
+ /**
2695
+ * Retrieves a list of tasks.
2696
+ *
2697
+ * Required API Key ACLs:
2698
+ * - addObject
2699
+ * - deleteIndex
2700
+ * - editSettings
2701
+ * @param listTasks - The listTasks object.
2702
+ * @param listTasks.itemsPerPage - Number of items per page.
2703
+ * @param listTasks.page - Page number of the paginated API response.
2704
+ * @param listTasks.action - Actions for filtering the list of tasks.
2705
+ * @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
2706
+ * @param listTasks.sourceID - Source IDs for filtering the list of tasks.
2707
+ * @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
2708
+ * @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
2709
+ * @param listTasks.sort - Property by which to sort the list of tasks.
2710
+ * @param listTasks.order - Sort order of the response, ascending or descending.
2711
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2712
+ */
2713
+ listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
2714
+ /**
2715
+ * Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
2716
+ *
2717
+ * Required API Key ACLs:
2718
+ * - addObject
2719
+ * - deleteIndex
2720
+ * - editSettings
2721
+ * @param listTasksV1 - The listTasksV1 object.
2722
+ * @param listTasksV1.itemsPerPage - Number of items per page.
2723
+ * @param listTasksV1.page - Page number of the paginated API response.
2724
+ * @param listTasksV1.action - Actions for filtering the list of tasks.
2725
+ * @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
2726
+ * @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
2727
+ * @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
2728
+ * @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
2729
+ * @param listTasksV1.sort - Property by which to sort the list of tasks.
2730
+ * @param listTasksV1.order - Sort order of the response, ascending or descending.
2731
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2732
+ */
2733
+ listTasksV1({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksV1Props, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponseV1>;
2734
+ /**
2735
+ * Retrieves a list of transformations.
2736
+ *
2737
+ * Required API Key ACLs:
2738
+ * - addObject
2739
+ * - deleteIndex
2740
+ * - editSettings
2741
+ * @param listTransformations - The listTransformations object.
2742
+ * @param listTransformations.itemsPerPage - Number of items per page.
2743
+ * @param listTransformations.page - Page number of the paginated API response.
2744
+ * @param listTransformations.sort - Property by which to sort the list of transformations.
2745
+ * @param listTransformations.order - Sort order of the response, ascending or descending.
2746
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2747
+ */
2748
+ listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
2749
+ /**
2750
+ * Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
2751
+ *
2752
+ * Required API Key ACLs:
2753
+ * - addObject
2754
+ * - deleteIndex
2755
+ * - editSettings
2756
+ * @param pushTask - The pushTask object.
2757
+ * @param pushTask.taskID - Unique identifier of a task.
2758
+ * @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
2759
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2760
+ */
2761
+ pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
2762
+ /**
2763
+ * Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
2764
+ *
2765
+ * Required API Key ACLs:
2766
+ * - addObject
2767
+ * - deleteIndex
2768
+ * - editSettings
2769
+ * @param runSource - The runSource object.
2770
+ * @param runSource.sourceID - Unique identifier of a source.
2771
+ * @param runSource.runSourcePayload -
2772
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2773
+ */
2774
+ runSource({ sourceID, runSourcePayload }: RunSourceProps, requestOptions?: RequestOptions): Promise<RunSourceResponse>;
2775
+ /**
2776
+ * Runs a task. You can check the status of task runs with the observability endpoints.
2777
+ *
2778
+ * Required API Key ACLs:
2779
+ * - addObject
2780
+ * - deleteIndex
2781
+ * - editSettings
2782
+ * @param runTask - The runTask object.
2783
+ * @param runTask.taskID - Unique identifier of a task.
2784
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2785
+ */
2786
+ runTask({ taskID }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
2787
+ /**
2788
+ * Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
2789
+ *
2790
+ * Required API Key ACLs:
2791
+ * - addObject
2792
+ * - deleteIndex
2793
+ * - editSettings
2794
+ * @param runTaskV1 - The runTaskV1 object.
2795
+ * @param runTaskV1.taskID - Unique identifier of a task.
2796
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2797
+ */
2798
+ runTaskV1({ taskID }: RunTaskV1Props, requestOptions?: RequestOptions): Promise<RunResponse>;
2799
+ /**
2800
+ * Searches for authentication resources.
2801
+ *
2802
+ * Required API Key ACLs:
2803
+ * - addObject
2804
+ * - deleteIndex
2805
+ * - editSettings
2806
+ * @param authenticationSearch - The authenticationSearch object.
2807
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2808
+ */
2809
+ searchAuthentications(authenticationSearch: AuthenticationSearch, requestOptions?: RequestOptions): Promise<Array<Authentication>>;
2810
+ /**
2811
+ * Searches for destinations.
2812
+ *
2813
+ * Required API Key ACLs:
2814
+ * - addObject
2815
+ * - deleteIndex
2816
+ * - editSettings
2817
+ * @param destinationSearch - The destinationSearch object.
2818
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2819
+ */
2820
+ searchDestinations(destinationSearch: DestinationSearch, requestOptions?: RequestOptions): Promise<Array<Destination>>;
2821
+ /**
2822
+ * Searches for sources.
2823
+ *
2824
+ * Required API Key ACLs:
2825
+ * - addObject
2826
+ * - deleteIndex
2827
+ * - editSettings
2828
+ * @param sourceSearch - The sourceSearch object.
2829
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2830
+ */
2831
+ searchSources(sourceSearch: SourceSearch, requestOptions?: RequestOptions): Promise<Array<Source>>;
2832
+ /**
2833
+ * Searches for tasks.
2834
+ *
2835
+ * Required API Key ACLs:
2836
+ * - addObject
2837
+ * - deleteIndex
2838
+ * - editSettings
2839
+ * @param taskSearch - The taskSearch object.
2840
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2841
+ */
2842
+ searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Array<Task>>;
2843
+ /**
2844
+ * Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
2845
+ *
2846
+ * Required API Key ACLs:
2847
+ * - addObject
2848
+ * - deleteIndex
2849
+ * - editSettings
2850
+ * @param taskSearch - The taskSearch object.
2851
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2852
+ */
2853
+ searchTasksV1(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Array<TaskV1>>;
2854
+ /**
2855
+ * Searches for transformations.
2856
+ *
2857
+ * Required API Key ACLs:
2858
+ * - addObject
2859
+ * - deleteIndex
2860
+ * - editSettings
2861
+ * @param transformationSearch - The transformationSearch object.
2862
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2863
+ */
2864
+ searchTransformations(transformationSearch: TransformationSearch, requestOptions?: RequestOptions): Promise<Array<Transformation>>;
2865
+ /**
2866
+ * Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
2867
+ *
2868
+ * Required API Key ACLs:
2869
+ * - addObject
2870
+ * - deleteIndex
2871
+ * - editSettings
2872
+ * @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
2873
+ * @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
2874
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2875
+ */
2876
+ triggerDockerSourceDiscover({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: RequestOptions): Promise<SourceWatchResponse>;
2877
+ /**
2878
+ * Try a transformation before creating it.
2879
+ *
2880
+ * Required API Key ACLs:
2881
+ * - addObject
2882
+ * - deleteIndex
2883
+ * - editSettings
2884
+ * @param transformationTry - The transformationTry object.
2885
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2886
+ */
2887
+ tryTransformation(transformationTry: TransformationTry, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
2888
+ /**
2889
+ * Try a transformation before updating it.
2890
+ *
2891
+ * Required API Key ACLs:
2892
+ * - addObject
2893
+ * - deleteIndex
2894
+ * - editSettings
2895
+ * @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
2896
+ * @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
2897
+ * @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
2898
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2899
+ */
2900
+ tryTransformationBeforeUpdate({ transformationID, transformationTry }: TryTransformationBeforeUpdateProps, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
2901
+ /**
2902
+ * Updates an authentication resource.
2903
+ *
2904
+ * Required API Key ACLs:
2905
+ * - addObject
2906
+ * - deleteIndex
2907
+ * - editSettings
2908
+ * @param updateAuthentication - The updateAuthentication object.
2909
+ * @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
2910
+ * @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
2911
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2912
+ */
2913
+ updateAuthentication({ authenticationID, authenticationUpdate }: UpdateAuthenticationProps, requestOptions?: RequestOptions): Promise<AuthenticationUpdateResponse>;
2914
+ /**
2915
+ * Updates the destination by its ID.
2916
+ *
2917
+ * Required API Key ACLs:
2918
+ * - addObject
2919
+ * - deleteIndex
2920
+ * - editSettings
2921
+ * @param updateDestination - The updateDestination object.
2922
+ * @param updateDestination.destinationID - Unique identifier of a destination.
2923
+ * @param updateDestination.destinationUpdate - The destinationUpdate object.
2924
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2925
+ */
2926
+ updateDestination({ destinationID, destinationUpdate }: UpdateDestinationProps, requestOptions?: RequestOptions): Promise<DestinationUpdateResponse>;
2927
+ /**
2928
+ * Updates a source by its ID.
2929
+ *
2930
+ * Required API Key ACLs:
2931
+ * - addObject
2932
+ * - deleteIndex
2933
+ * - editSettings
2934
+ * @param updateSource - The updateSource object.
2935
+ * @param updateSource.sourceID - Unique identifier of a source.
2936
+ * @param updateSource.sourceUpdate - The sourceUpdate object.
2937
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2938
+ */
2939
+ updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
2940
+ /**
2941
+ * Updates a task by its ID.
2942
+ * @param updateTask - The updateTask object.
2943
+ * @param updateTask.taskID - Unique identifier of a task.
2944
+ * @param updateTask.taskUpdate - The taskUpdate object.
2945
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2946
+ */
2947
+ updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
2948
+ /**
2949
+ * Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
2950
+ * @param updateTaskV1 - The updateTaskV1 object.
2951
+ * @param updateTaskV1.taskID - Unique identifier of a task.
2952
+ * @param updateTaskV1.taskUpdate - The taskUpdate object.
2953
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2954
+ */
2955
+ updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
2956
+ /**
2957
+ * Updates a transformation by its ID.
2958
+ * @param updateTransformation - The updateTransformation object.
2959
+ * @param updateTransformation.transformationID - Unique identifier of a transformation.
2960
+ * @param updateTransformation.transformationCreate - The transformationCreate object.
2961
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2962
+ */
2963
+ updateTransformation({ transformationID, transformationCreate }: UpdateTransformationProps, requestOptions?: RequestOptions): Promise<TransformationUpdateResponse>;
2964
+ /**
2965
+ * Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
2966
+ *
2967
+ * Required API Key ACLs:
2968
+ * - addObject
2969
+ * - deleteIndex
2970
+ * - editSettings
2971
+ * @param sourceCreate -
2972
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2973
+ */
2974
+ validateSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions | undefined): Promise<SourceWatchResponse>;
2975
+ /**
2976
+ * Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
2977
+ *
2978
+ * Required API Key ACLs:
2979
+ * - addObject
2980
+ * - deleteIndex
2981
+ * - editSettings
2982
+ * @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
2983
+ * @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
2984
+ * @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
2985
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2986
+ */
2987
+ validateSourceBeforeUpdate({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: RequestOptions): Promise<SourceWatchResponse>;
2988
+ };
2989
+
2990
+ /**
2991
+ * Error.
2992
+ */
2993
+ type ErrorBase = Record<string, any> & {
2994
+ message?: string;
2995
+ };
2996
+
2997
+ declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): IngestionClient;
2998
+ type IngestionClient = ReturnType<typeof createIngestionClient>;
2999
+
3000
+ export { type Action, type ActionType, type AuthAPIKey, type AuthAPIKeyPartial, type AuthAlgolia, type AuthAlgoliaInsights, type AuthAlgoliaInsightsPartial, type AuthAlgoliaPartial, type AuthBasic, type AuthBasicPartial, type AuthGoogleServiceAccount, type AuthGoogleServiceAccountPartial, type AuthInput, type AuthInputPartial, type AuthOAuth, type AuthOAuthPartial, type Authentication, type AuthenticationCreate, type AuthenticationCreateResponse, type AuthenticationSearch, type AuthenticationSortKeys, type AuthenticationType, type AuthenticationUpdate, type AuthenticationUpdateResponse, type BigCommerceChannel, type BigCommerceMetafield, type BigQueryDataType, type CommercetoolsCustomFields, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteAuthenticationProps, type DeleteDestinationProps, type DeleteResponse, type DeleteSourceProps, type DeleteTaskProps, type DeleteTaskV1Props, type DeleteTransformationProps, type Destination, type DestinationCreate, type DestinationCreateResponse, type DestinationIndexName, type DestinationInput, type DestinationSearch, type DestinationSortKeys, type DestinationType, type DestinationUpdate, type DestinationUpdateResponse, type DisableTaskProps, type DisableTaskV1Props, type DockerImageType, type DockerRegistry, type DockerStreams, type DockerStreamsInput, type DockerStreamsSyncMode, type EnableTaskProps, type EnableTaskV1Props, type EntityType, type ErrorBase, type Event, type EventSortKeys, type EventStatus, type EventType, type GetAuthenticationProps, type GetDestinationProps, type GetEventProps, type GetRunProps, type GetSourceProps, type GetTaskProps, type GetTaskV1Props, type GetTransformationProps, type IngestionClient, type ListAuthenticationsProps, type ListAuthenticationsResponse, type ListDestinationsProps, type ListDestinationsResponse, type ListEventsProps, type ListEventsResponse, type ListRunsProps, type ListSourcesProps, type ListSourcesResponse, type ListTasksProps, type ListTasksResponse, type ListTasksResponseV1, type ListTasksV1Props, type ListTransformationsProps, type ListTransformationsResponse, type MappingFieldDirective, type MappingFormatSchema, type MappingInput, type MappingKitAction, type MappingTypeCSV, type MethodType, type OnDemandTrigger, type OnDemandTriggerInput, type OnDemandTriggerType, type OrderKeys, type Pagination, type Platform, type PlatformNone, type PlatformWithNone, type PushTaskPayload, type PushTaskProps, type PushTaskRecords, type RecordType, type Region, type RegionOptions, type Run, type RunListResponse, type RunOutcome, type RunProgress, type RunReasonCode, type RunResponse, type RunSortKeys, type RunSourcePayload, type RunSourceProps, type RunSourceResponse, type RunStatus, type RunTaskProps, type RunTaskV1Props, type RunType, type ScheduleTrigger, type ScheduleTriggerInput, type ScheduleTriggerType, type ShopifyInput, type ShopifyMarket, type ShopifyMetafield, type Source, type SourceBigCommerce, type SourceBigQuery, type SourceCSV, type SourceCommercetools, type SourceCreate, type SourceCreateResponse, type SourceDocker, type SourceGA4BigQueryExport, type SourceInput, type SourceJSON, type SourceSearch, type SourceShopify, type SourceShopifyBase, type SourceSortKeys, type SourceType, type SourceUpdate, type SourceUpdateCommercetools, type SourceUpdateDocker, type SourceUpdateInput, type SourceUpdateResponse, type SourceUpdateShopify, type SourceWatchResponse, type StreamingInput, type StreamingTrigger, type StreamingTriggerType, type SubscriptionTrigger, type SubscriptionTriggerType, type Task, type TaskCreate, type TaskCreateResponse, type TaskCreateTrigger, type TaskCreateV1, type TaskInput, type TaskSearch, type TaskSortKeys, type TaskUpdate, type TaskUpdateResponse, type TaskUpdateV1, type TaskV1, type Transformation, type TransformationCreate, type TransformationCreateResponse, type TransformationError, type TransformationSearch, type TransformationSortKeys, type TransformationTry, type TransformationTryResponse, type TransformationUpdateResponse, type Trigger, type TriggerDockerSourceDiscoverProps, type TriggerType, type TriggerUpdateInput, type TryTransformationBeforeUpdateProps, type UpdateAuthenticationProps, type UpdateDestinationProps, type UpdateSourceProps, type UpdateTaskProps, type UpdateTaskV1Props, type UpdateTransformationProps, type ValidateSourceBeforeUpdateProps, type Window, apiClientVersion, ingestionClient, isOnDemandTrigger, isScheduleTrigger, isSubscriptionTrigger };