@algolia/ingestion 1.2.5 → 1.3.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/browser.d.ts +2133 -1415
- package/dist/builds/browser.js +96 -82
- package/dist/builds/browser.js.map +1 -1
- package/dist/builds/browser.min.js +1 -1
- package/dist/builds/browser.min.js.map +1 -1
- package/dist/builds/browser.umd.js +2 -2
- package/dist/builds/node.cjs +96 -82
- package/dist/builds/node.cjs.map +1 -1
- package/dist/builds/node.js +96 -82
- package/dist/builds/node.js.map +1 -1
- package/dist/node.d.cts +2120 -1402
- package/dist/node.d.ts +2120 -1402
- package/dist/src/ingestionClient.cjs +96 -82
- package/dist/src/ingestionClient.cjs.map +1 -1
- package/dist/src/ingestionClient.js +96 -82
- package/dist/src/ingestionClient.js.map +1 -1
- package/package.json +4 -4
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
|
*/
|
|
@@ -226,6 +126,96 @@ type Authentication = {
|
|
|
226
126
|
updatedAt?: string;
|
|
227
127
|
};
|
|
228
128
|
|
|
129
|
+
/**
|
|
130
|
+
* Credentials for authenticating with an API key.
|
|
131
|
+
*/
|
|
132
|
+
type AuthAPIKey = {
|
|
133
|
+
/**
|
|
134
|
+
* API key. This field is `null` in the API response.
|
|
135
|
+
*/
|
|
136
|
+
key: string;
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
/**
|
|
140
|
+
* Credentials for authenticating with Algolia.
|
|
141
|
+
*/
|
|
142
|
+
type AuthAlgolia = {
|
|
143
|
+
/**
|
|
144
|
+
* Algolia application ID.
|
|
145
|
+
*/
|
|
146
|
+
appID: string;
|
|
147
|
+
/**
|
|
148
|
+
* Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
|
|
149
|
+
*/
|
|
150
|
+
apiKey: string;
|
|
151
|
+
};
|
|
152
|
+
|
|
153
|
+
/**
|
|
154
|
+
* Credentials for authenticating with the Algolia Insights API.
|
|
155
|
+
*/
|
|
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;
|
|
165
|
+
};
|
|
166
|
+
|
|
167
|
+
/**
|
|
168
|
+
* Credentials for authenticating with user name and password.
|
|
169
|
+
*/
|
|
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
|
+
};
|
|
180
|
+
|
|
181
|
+
/**
|
|
182
|
+
* Credentials for authenticating with a Google service account, such as BigQuery.
|
|
183
|
+
*/
|
|
184
|
+
type AuthGoogleServiceAccount = {
|
|
185
|
+
/**
|
|
186
|
+
* Email address of the Google service account.
|
|
187
|
+
*/
|
|
188
|
+
clientEmail: string;
|
|
189
|
+
/**
|
|
190
|
+
* Private key of the Google service account. This field is `null` in the API response.
|
|
191
|
+
*/
|
|
192
|
+
privateKey: string;
|
|
193
|
+
};
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* Credentials for authenticating with OAuth 2.0.
|
|
197
|
+
*/
|
|
198
|
+
type AuthOAuth = {
|
|
199
|
+
/**
|
|
200
|
+
* URL for the OAuth endpoint.
|
|
201
|
+
*/
|
|
202
|
+
url: string;
|
|
203
|
+
/**
|
|
204
|
+
* Client ID.
|
|
205
|
+
*/
|
|
206
|
+
client_id: string;
|
|
207
|
+
/**
|
|
208
|
+
* Client secret. This field is `null` in the API response.
|
|
209
|
+
*/
|
|
210
|
+
client_secret: string;
|
|
211
|
+
/**
|
|
212
|
+
* OAuth scope.
|
|
213
|
+
*/
|
|
214
|
+
scope?: string;
|
|
215
|
+
};
|
|
216
|
+
|
|
217
|
+
type AuthInput = AuthAlgolia | AuthAlgoliaInsights | AuthAPIKey | AuthBasic | AuthGoogleServiceAccount | AuthOAuth;
|
|
218
|
+
|
|
229
219
|
/**
|
|
230
220
|
* Request body for creating a new authentication resource.
|
|
231
221
|
*/
|
|
@@ -264,6 +254,29 @@ type AuthenticationSearch = {
|
|
|
264
254
|
authenticationIDs: string[];
|
|
265
255
|
};
|
|
266
256
|
|
|
257
|
+
/**
|
|
258
|
+
* API response for a successful update of an authentication resource.
|
|
259
|
+
*/
|
|
260
|
+
type AuthenticationUpdateResponse = {
|
|
261
|
+
/**
|
|
262
|
+
* Universally unique identifier (UUID) of an authentication resource.
|
|
263
|
+
*/
|
|
264
|
+
authenticationID: string;
|
|
265
|
+
/**
|
|
266
|
+
* Descriptive name for the resource.
|
|
267
|
+
*/
|
|
268
|
+
name: string;
|
|
269
|
+
/**
|
|
270
|
+
* Date of last update in RFC 3339 format.
|
|
271
|
+
*/
|
|
272
|
+
updatedAt: string;
|
|
273
|
+
};
|
|
274
|
+
|
|
275
|
+
/**
|
|
276
|
+
* Action to perform on the Algolia index.
|
|
277
|
+
*/
|
|
278
|
+
type ActionType = 'append' | 'partial' | 'replace' | 'save';
|
|
279
|
+
|
|
267
280
|
/**
|
|
268
281
|
* Property by which to sort the list of authentication resources.
|
|
269
282
|
*/
|
|
@@ -283,227 +296,310 @@ type AuthenticationUpdate = {
|
|
|
283
296
|
};
|
|
284
297
|
|
|
285
298
|
/**
|
|
286
|
-
*
|
|
299
|
+
* Property by which to sort the destinations.
|
|
287
300
|
*/
|
|
288
|
-
type
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
301
|
+
type DestinationSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
|
|
302
|
+
|
|
303
|
+
/**
|
|
304
|
+
* Destination type. - `search`. Data is stored in an Algolia index. - `insights`. Data is recorded as user events in the Insights API.
|
|
305
|
+
*/
|
|
306
|
+
type DestinationType = 'insights' | 'search';
|
|
307
|
+
|
|
308
|
+
/**
|
|
309
|
+
* Record type for ecommerce sources.
|
|
310
|
+
*/
|
|
311
|
+
type RecordType = 'product' | 'variant';
|
|
312
|
+
|
|
313
|
+
type DestinationIndexName = {
|
|
293
314
|
/**
|
|
294
|
-
*
|
|
315
|
+
* Algolia index name (case-sensitive).
|
|
295
316
|
*/
|
|
296
|
-
|
|
317
|
+
indexName: string;
|
|
318
|
+
recordType?: RecordType;
|
|
297
319
|
/**
|
|
298
|
-
*
|
|
320
|
+
* 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.
|
|
299
321
|
*/
|
|
300
|
-
|
|
322
|
+
attributesToExclude?: string[];
|
|
301
323
|
};
|
|
302
324
|
|
|
303
|
-
type
|
|
325
|
+
type DestinationInput = DestinationIndexName;
|
|
326
|
+
|
|
327
|
+
/**
|
|
328
|
+
* API request body for updating a destination.
|
|
329
|
+
*/
|
|
330
|
+
type DestinationUpdate = {
|
|
331
|
+
type?: DestinationType;
|
|
304
332
|
/**
|
|
305
|
-
*
|
|
333
|
+
* Descriptive name for the resource.
|
|
306
334
|
*/
|
|
307
|
-
|
|
335
|
+
name?: string;
|
|
336
|
+
input?: DestinationInput;
|
|
308
337
|
/**
|
|
309
|
-
*
|
|
338
|
+
* Universally unique identifier (UUID) of an authentication resource.
|
|
310
339
|
*/
|
|
311
|
-
|
|
340
|
+
authenticationID?: string;
|
|
341
|
+
transformationIDs?: string[];
|
|
312
342
|
};
|
|
313
343
|
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
namespace: string;
|
|
319
|
-
/**
|
|
320
|
-
* Key identifier of the metafield.
|
|
321
|
-
*/
|
|
322
|
-
key: string;
|
|
323
|
-
};
|
|
344
|
+
/**
|
|
345
|
+
* Property by which to sort the list of task run events.
|
|
346
|
+
*/
|
|
347
|
+
type EventSortKeys = 'publishedAt' | 'status' | 'type';
|
|
324
348
|
|
|
325
|
-
type
|
|
349
|
+
type EventStatus = 'created' | 'critical' | 'failed' | 'retried' | 'started' | 'succeeded';
|
|
350
|
+
|
|
351
|
+
type EventType = 'fetch' | 'log' | 'record' | 'transform';
|
|
326
352
|
|
|
327
353
|
/**
|
|
328
|
-
*
|
|
354
|
+
* Ascending or descending sort order.
|
|
329
355
|
*/
|
|
330
|
-
type
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
356
|
+
type OrderKeys = 'asc' | 'desc';
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* Authentication resource not tied to any ecommerce platform, used for filtering.
|
|
360
|
+
*/
|
|
361
|
+
type PlatformNone = 'none';
|
|
362
|
+
|
|
363
|
+
type PlatformWithNone = Platform | PlatformNone;
|
|
364
|
+
|
|
365
|
+
/**
|
|
366
|
+
* Type of indexing operation.
|
|
367
|
+
*/
|
|
368
|
+
type Action = 'addObject' | 'clear' | 'delete' | 'deleteObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'updateObject';
|
|
369
|
+
|
|
370
|
+
type PushTaskRecords = Record<string, any> & {
|
|
339
371
|
/**
|
|
340
|
-
*
|
|
372
|
+
* Unique record identifier.
|
|
341
373
|
*/
|
|
342
|
-
|
|
374
|
+
objectID: string;
|
|
343
375
|
};
|
|
344
376
|
|
|
345
|
-
type
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
*/
|
|
349
|
-
deletedAt: string;
|
|
377
|
+
type PushTaskPayload = {
|
|
378
|
+
action: Action;
|
|
379
|
+
records: PushTaskRecords[];
|
|
350
380
|
};
|
|
351
381
|
|
|
352
382
|
/**
|
|
353
|
-
*
|
|
383
|
+
* Property by which to sort the list of task runs.
|
|
354
384
|
*/
|
|
355
|
-
type
|
|
385
|
+
type RunSortKeys = 'createdAt' | 'status' | 'updatedAt';
|
|
356
386
|
|
|
357
|
-
|
|
387
|
+
/**
|
|
388
|
+
* Type of entity to update.
|
|
389
|
+
*/
|
|
390
|
+
type EntityType = 'collection' | 'product';
|
|
391
|
+
|
|
392
|
+
type RunSourcePayload = {
|
|
358
393
|
/**
|
|
359
|
-
*
|
|
394
|
+
* List of index names to include in reidexing/update.
|
|
360
395
|
*/
|
|
361
|
-
|
|
362
|
-
recordType?: RecordType;
|
|
396
|
+
indexToInclude?: string[];
|
|
363
397
|
/**
|
|
364
|
-
*
|
|
398
|
+
* List of index names to exclude in reidexing/update.
|
|
365
399
|
*/
|
|
366
|
-
|
|
400
|
+
indexToExclude?: string[];
|
|
401
|
+
/**
|
|
402
|
+
* List of entityID to update.
|
|
403
|
+
*/
|
|
404
|
+
entityIDs?: string[];
|
|
405
|
+
entityType?: EntityType;
|
|
367
406
|
};
|
|
368
407
|
|
|
369
|
-
|
|
408
|
+
/**
|
|
409
|
+
* Task run status.
|
|
410
|
+
*/
|
|
411
|
+
type RunStatus = 'created' | 'finished' | 'idled' | 'skipped' | 'started';
|
|
370
412
|
|
|
371
413
|
/**
|
|
372
|
-
*
|
|
414
|
+
* Task run type.
|
|
373
415
|
*/
|
|
374
|
-
type
|
|
416
|
+
type RunType = 'discover' | 'push' | 'reindex' | 'update' | 'validate';
|
|
375
417
|
|
|
376
418
|
/**
|
|
377
|
-
*
|
|
419
|
+
* Property by which to sort the list.
|
|
378
420
|
*/
|
|
379
|
-
type
|
|
421
|
+
type SortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
|
|
422
|
+
|
|
423
|
+
/**
|
|
424
|
+
* Property by which to sort the list of sources.
|
|
425
|
+
*/
|
|
426
|
+
type SourceSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
|
|
427
|
+
|
|
428
|
+
type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'push' | 'sfcc' | 'shopify';
|
|
429
|
+
|
|
430
|
+
type BigQueryDataType = 'ga4' | 'ga360';
|
|
431
|
+
|
|
432
|
+
type SourceBigQuery = {
|
|
380
433
|
/**
|
|
381
|
-
*
|
|
434
|
+
* Project ID of the BigQuery source.
|
|
382
435
|
*/
|
|
383
|
-
|
|
384
|
-
type: DestinationType;
|
|
436
|
+
projectID: string;
|
|
385
437
|
/**
|
|
386
|
-
*
|
|
438
|
+
* Dataset ID of the BigQuery source.
|
|
387
439
|
*/
|
|
388
|
-
|
|
389
|
-
|
|
440
|
+
datasetID: string;
|
|
441
|
+
dataType?: BigQueryDataType;
|
|
390
442
|
/**
|
|
391
|
-
*
|
|
443
|
+
* Table name for the BigQuery export.
|
|
392
444
|
*/
|
|
393
|
-
|
|
445
|
+
table?: string;
|
|
394
446
|
/**
|
|
395
|
-
*
|
|
447
|
+
* Table prefix for a Google Analytics 4 data export to BigQuery.
|
|
396
448
|
*/
|
|
397
|
-
|
|
449
|
+
tablePrefix?: string;
|
|
398
450
|
/**
|
|
399
|
-
*
|
|
451
|
+
* Custom SQL request to extract data from the BigQuery table.
|
|
400
452
|
*/
|
|
401
|
-
|
|
402
|
-
|
|
453
|
+
customSQLRequest?: string;
|
|
454
|
+
/**
|
|
455
|
+
* Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
|
|
456
|
+
*/
|
|
457
|
+
uniqueIDColumn?: string;
|
|
403
458
|
};
|
|
404
459
|
|
|
460
|
+
type MappingTypeCSV = 'boolean' | 'float' | 'integer' | 'json' | 'string';
|
|
461
|
+
|
|
405
462
|
/**
|
|
406
|
-
*
|
|
463
|
+
* HTTP method to be used for retrieving your data.
|
|
407
464
|
*/
|
|
408
|
-
type
|
|
409
|
-
|
|
465
|
+
type MethodType = 'GET' | 'POST';
|
|
466
|
+
|
|
467
|
+
type SourceCSV = {
|
|
410
468
|
/**
|
|
411
|
-
*
|
|
469
|
+
* URL of the file.
|
|
412
470
|
*/
|
|
413
|
-
|
|
414
|
-
input: DestinationInput;
|
|
471
|
+
url: string;
|
|
415
472
|
/**
|
|
416
|
-
*
|
|
473
|
+
* Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
|
|
417
474
|
*/
|
|
418
|
-
|
|
419
|
-
|
|
475
|
+
uniqueIDColumn?: string;
|
|
476
|
+
/**
|
|
477
|
+
* Key-value pairs of column names and their expected types.
|
|
478
|
+
*/
|
|
479
|
+
mapping?: Record<string, MappingTypeCSV>;
|
|
480
|
+
method?: MethodType;
|
|
481
|
+
/**
|
|
482
|
+
* The character used to split the value on each line, default to a comma (\\r, \\n, 0xFFFD, and space are forbidden).
|
|
483
|
+
*/
|
|
484
|
+
delimiter?: string;
|
|
420
485
|
};
|
|
421
486
|
|
|
422
|
-
|
|
423
|
-
* API response for creating a new destination.
|
|
424
|
-
*/
|
|
425
|
-
type DestinationCreateResponse = {
|
|
487
|
+
type SourceGA4BigQueryExport = {
|
|
426
488
|
/**
|
|
427
|
-
*
|
|
489
|
+
* GCP project ID that the BigQuery export writes to.
|
|
428
490
|
*/
|
|
429
|
-
|
|
491
|
+
projectID: string;
|
|
430
492
|
/**
|
|
431
|
-
*
|
|
493
|
+
* BigQuery dataset ID that the BigQuery export writes to.
|
|
432
494
|
*/
|
|
433
|
-
|
|
495
|
+
datasetID: string;
|
|
434
496
|
/**
|
|
435
|
-
*
|
|
497
|
+
* Prefix of the tables that the BigQuery Export writes to.
|
|
436
498
|
*/
|
|
437
|
-
|
|
438
|
-
};
|
|
439
|
-
|
|
440
|
-
/**
|
|
441
|
-
* API request body for searching destinations.
|
|
442
|
-
*/
|
|
443
|
-
type DestinationSearch = {
|
|
444
|
-
destinationIDs: string[];
|
|
499
|
+
tablePrefix: string;
|
|
445
500
|
};
|
|
446
501
|
|
|
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;
|
|
502
|
+
type SourceJSON = {
|
|
457
503
|
/**
|
|
458
|
-
*
|
|
504
|
+
* URL of the file.
|
|
459
505
|
*/
|
|
460
|
-
|
|
461
|
-
input?: DestinationInput;
|
|
506
|
+
url: string;
|
|
462
507
|
/**
|
|
463
|
-
*
|
|
508
|
+
* Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
|
|
464
509
|
*/
|
|
465
|
-
|
|
466
|
-
|
|
510
|
+
uniqueIDColumn?: string;
|
|
511
|
+
method?: MethodType;
|
|
467
512
|
};
|
|
468
513
|
|
|
469
514
|
/**
|
|
470
|
-
*
|
|
515
|
+
* 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).
|
|
471
516
|
*/
|
|
472
|
-
type
|
|
517
|
+
type CommercetoolsCustomFields = {
|
|
473
518
|
/**
|
|
474
|
-
*
|
|
519
|
+
* Inventory custom fields.
|
|
475
520
|
*/
|
|
476
|
-
|
|
521
|
+
inventory?: string[] | null;
|
|
477
522
|
/**
|
|
478
|
-
*
|
|
523
|
+
* Price custom fields.
|
|
479
524
|
*/
|
|
480
|
-
|
|
525
|
+
price?: string[] | null;
|
|
481
526
|
/**
|
|
482
|
-
*
|
|
527
|
+
* Category custom fields.
|
|
483
528
|
*/
|
|
484
|
-
|
|
529
|
+
category?: string[] | null;
|
|
485
530
|
};
|
|
486
531
|
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
532
|
+
type SourceUpdateCommercetools = {
|
|
533
|
+
storeKeys?: string[];
|
|
534
|
+
/**
|
|
535
|
+
* Locales for your commercetools stores.
|
|
536
|
+
*/
|
|
537
|
+
locales?: string[];
|
|
538
|
+
url?: string;
|
|
539
|
+
/**
|
|
540
|
+
* Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
|
|
541
|
+
*/
|
|
542
|
+
fallbackIsInStockValue?: boolean;
|
|
543
|
+
customFields?: CommercetoolsCustomFields;
|
|
544
|
+
};
|
|
491
545
|
|
|
492
546
|
/**
|
|
493
547
|
* Container registry name from where to pull the image.
|
|
494
548
|
*/
|
|
495
549
|
type DockerRegistry = 'dockerhub' | 'ghcr';
|
|
496
550
|
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
*/
|
|
500
|
-
type DockerStreamsSyncMode = 'fullTable' | 'incremental';
|
|
501
|
-
|
|
502
|
-
type DockerStreams = {
|
|
551
|
+
type SourceUpdateDocker = {
|
|
552
|
+
registry?: DockerRegistry;
|
|
503
553
|
/**
|
|
504
|
-
*
|
|
554
|
+
* Docker image name.
|
|
505
555
|
*/
|
|
506
|
-
|
|
556
|
+
image?: string;
|
|
557
|
+
/**
|
|
558
|
+
* Docker image version.
|
|
559
|
+
*/
|
|
560
|
+
version?: string;
|
|
561
|
+
/**
|
|
562
|
+
* Configuration of the spec.
|
|
563
|
+
*/
|
|
564
|
+
configuration: Record<string, unknown>;
|
|
565
|
+
};
|
|
566
|
+
|
|
567
|
+
type SourceUpdateShopify = {
|
|
568
|
+
/**
|
|
569
|
+
* Feature flags for the Shopify source.
|
|
570
|
+
*/
|
|
571
|
+
featureFlags?: Record<string, any>;
|
|
572
|
+
};
|
|
573
|
+
|
|
574
|
+
type SourceUpdateInput = SourceBigQuery | SourceCSV | SourceGA4BigQueryExport | SourceJSON | SourceUpdateCommercetools | SourceUpdateDocker | SourceUpdateShopify;
|
|
575
|
+
|
|
576
|
+
type SourceUpdate = {
|
|
577
|
+
/**
|
|
578
|
+
* Descriptive name of the source.
|
|
579
|
+
*/
|
|
580
|
+
name?: string;
|
|
581
|
+
input?: SourceUpdateInput;
|
|
582
|
+
/**
|
|
583
|
+
* Universally unique identifier (UUID) of an authentication resource.
|
|
584
|
+
*/
|
|
585
|
+
authenticationID?: string;
|
|
586
|
+
};
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* Property by which to sort the list of tasks.
|
|
590
|
+
*/
|
|
591
|
+
type TaskSortKeys = 'action' | 'createdAt' | 'enabled' | 'triggerType' | 'updatedAt';
|
|
592
|
+
|
|
593
|
+
/**
|
|
594
|
+
* The strategy to use to fetch the data.
|
|
595
|
+
*/
|
|
596
|
+
type DockerStreamsSyncMode = 'fullTable' | 'incremental';
|
|
597
|
+
|
|
598
|
+
type DockerStreams = {
|
|
599
|
+
/**
|
|
600
|
+
* The name of the stream to fetch the data from (e.g. Table name).
|
|
601
|
+
*/
|
|
602
|
+
name: string;
|
|
507
603
|
/**
|
|
508
604
|
* The properties of the stream to select (e.g. Column).
|
|
509
605
|
*/
|
|
@@ -519,800 +615,1041 @@ type DockerStreamsInput = {
|
|
|
519
615
|
};
|
|
520
616
|
|
|
521
617
|
/**
|
|
522
|
-
*
|
|
618
|
+
* Represents a market in Shopify.
|
|
523
619
|
*/
|
|
524
|
-
type
|
|
620
|
+
type ShopifyMarket = {
|
|
621
|
+
countries: string[];
|
|
622
|
+
currencies: string[];
|
|
623
|
+
locales: string[];
|
|
624
|
+
};
|
|
525
625
|
|
|
526
626
|
/**
|
|
527
|
-
*
|
|
627
|
+
* Represents a metafield in Shopify.
|
|
528
628
|
*/
|
|
529
|
-
type
|
|
530
|
-
|
|
629
|
+
type ShopifyMetafield = {
|
|
630
|
+
namespace: string;
|
|
631
|
+
key: string;
|
|
632
|
+
value: string;
|
|
531
633
|
};
|
|
532
634
|
|
|
533
|
-
|
|
635
|
+
/**
|
|
636
|
+
* Represents the required elements of the task input when using a `shopify` source.
|
|
637
|
+
*/
|
|
638
|
+
type ShopifyInput = {
|
|
639
|
+
metafields: ShopifyMetafield[];
|
|
640
|
+
market: ShopifyMarket;
|
|
641
|
+
};
|
|
534
642
|
|
|
535
|
-
|
|
643
|
+
/**
|
|
644
|
+
* Mapping format schema.
|
|
645
|
+
*/
|
|
646
|
+
type MappingFormatSchema = 'mappingkit/v1';
|
|
536
647
|
|
|
537
648
|
/**
|
|
538
|
-
*
|
|
649
|
+
* Describes how a field should be resolved by applying a set of directives.
|
|
539
650
|
*/
|
|
540
|
-
type
|
|
651
|
+
type MappingFieldDirective = {
|
|
541
652
|
/**
|
|
542
|
-
*
|
|
653
|
+
* Destination field key.
|
|
543
654
|
*/
|
|
544
|
-
|
|
655
|
+
fieldKey: string;
|
|
545
656
|
/**
|
|
546
|
-
*
|
|
657
|
+
* How the destination field should be resolved from the source.
|
|
547
658
|
*/
|
|
548
|
-
|
|
659
|
+
value: Record<string, any>;
|
|
660
|
+
};
|
|
661
|
+
|
|
662
|
+
/**
|
|
663
|
+
* Describes how a destination object should be resolved by means of applying a set of directives.
|
|
664
|
+
*/
|
|
665
|
+
type MappingKitAction = {
|
|
549
666
|
/**
|
|
550
|
-
*
|
|
667
|
+
* ID to uniquely identify this action.
|
|
551
668
|
*/
|
|
552
|
-
|
|
553
|
-
status: EventStatus;
|
|
554
|
-
type: EventType;
|
|
669
|
+
id?: string;
|
|
555
670
|
/**
|
|
556
|
-
*
|
|
671
|
+
* Whether this action has any effect.
|
|
557
672
|
*/
|
|
558
|
-
|
|
559
|
-
data?: Record<string, any>;
|
|
673
|
+
enabled: boolean;
|
|
560
674
|
/**
|
|
561
|
-
*
|
|
675
|
+
* 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.
|
|
562
676
|
*/
|
|
563
|
-
|
|
677
|
+
trigger: string;
|
|
678
|
+
fieldDirectives: MappingFieldDirective[];
|
|
564
679
|
};
|
|
565
680
|
|
|
566
681
|
/**
|
|
567
|
-
*
|
|
682
|
+
* Transformations to apply to the source, serialized as a JSON string.
|
|
568
683
|
*/
|
|
569
|
-
type
|
|
570
|
-
|
|
571
|
-
|
|
572
|
-
id: string;
|
|
573
|
-
systemPrompt?: string;
|
|
574
|
-
userPrompt: string;
|
|
684
|
+
type MappingInput = {
|
|
685
|
+
format: MappingFormatSchema;
|
|
686
|
+
actions: MappingKitAction[];
|
|
575
687
|
};
|
|
576
688
|
|
|
577
|
-
|
|
578
|
-
|
|
689
|
+
/**
|
|
690
|
+
* Input for a `streaming` task whose source is of type `ga4BigqueryExport` and for which extracted data is continuously streamed.
|
|
691
|
+
*/
|
|
692
|
+
type StreamingInput = {
|
|
693
|
+
mapping: MappingInput;
|
|
579
694
|
};
|
|
580
695
|
|
|
581
696
|
/**
|
|
582
|
-
*
|
|
697
|
+
* Configuration of the task, depending on its type.
|
|
583
698
|
*/
|
|
584
|
-
type
|
|
699
|
+
type TaskInput = DockerStreamsInput | ShopifyInput | StreamingInput;
|
|
700
|
+
|
|
701
|
+
/**
|
|
702
|
+
* API request body for updating a task.
|
|
703
|
+
*/
|
|
704
|
+
type TaskUpdate = {
|
|
585
705
|
/**
|
|
586
|
-
*
|
|
706
|
+
* Universally unique identifier (UUID) of a destination resource.
|
|
587
707
|
*/
|
|
588
|
-
|
|
708
|
+
destinationID?: string;
|
|
589
709
|
/**
|
|
590
|
-
*
|
|
710
|
+
* Cron expression for the task\'s schedule.
|
|
591
711
|
*/
|
|
592
|
-
|
|
712
|
+
cron?: string;
|
|
713
|
+
input?: TaskInput;
|
|
593
714
|
/**
|
|
594
|
-
*
|
|
715
|
+
* Whether the task is enabled.
|
|
595
716
|
*/
|
|
596
|
-
|
|
717
|
+
enabled?: boolean;
|
|
597
718
|
/**
|
|
598
|
-
*
|
|
719
|
+
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
599
720
|
*/
|
|
600
|
-
|
|
601
|
-
};
|
|
602
|
-
|
|
603
|
-
type ListAuthenticationsResponse = {
|
|
604
|
-
authentications: Authentication[];
|
|
605
|
-
pagination: Pagination;
|
|
721
|
+
failureThreshold?: number;
|
|
606
722
|
};
|
|
607
723
|
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
724
|
+
/**
|
|
725
|
+
* Trigger for a task update.
|
|
726
|
+
*/
|
|
727
|
+
type TriggerUpdateInput = {
|
|
728
|
+
/**
|
|
729
|
+
* Cron expression for the task\'s schedule.
|
|
730
|
+
*/
|
|
731
|
+
cron: string;
|
|
611
732
|
};
|
|
612
733
|
|
|
613
734
|
/**
|
|
614
|
-
*
|
|
735
|
+
* API request body for updating a task using the V1 shape, please use methods and types that don\'t contain the V1 suffix.
|
|
615
736
|
*/
|
|
616
|
-
type
|
|
737
|
+
type TaskUpdateV1 = {
|
|
617
738
|
/**
|
|
618
|
-
*
|
|
739
|
+
* Universally unique identifier (UUID) of a destination resource.
|
|
619
740
|
*/
|
|
620
|
-
|
|
741
|
+
destinationID?: string;
|
|
742
|
+
trigger?: TriggerUpdateInput;
|
|
743
|
+
input?: TaskInput;
|
|
621
744
|
/**
|
|
622
|
-
*
|
|
745
|
+
* Whether the task is enabled.
|
|
623
746
|
*/
|
|
624
|
-
|
|
625
|
-
};
|
|
626
|
-
|
|
627
|
-
type ListEventsResponse = {
|
|
628
|
-
events: Event[];
|
|
629
|
-
pagination: Pagination;
|
|
630
|
-
window: Window;
|
|
631
|
-
};
|
|
632
|
-
|
|
633
|
-
type SourceBigCommerce = {
|
|
747
|
+
enabled?: boolean;
|
|
634
748
|
/**
|
|
635
|
-
*
|
|
749
|
+
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
636
750
|
*/
|
|
637
|
-
|
|
638
|
-
channel?: BigCommerceChannel;
|
|
639
|
-
customFields?: string[];
|
|
640
|
-
productMetafields?: BigCommerceMetafield[];
|
|
641
|
-
variantMetafields?: BigCommerceMetafield[];
|
|
751
|
+
failureThreshold?: number;
|
|
642
752
|
};
|
|
643
753
|
|
|
644
|
-
|
|
754
|
+
/**
|
|
755
|
+
* API request body for creating a transformation.
|
|
756
|
+
*/
|
|
757
|
+
type TransformationCreate = {
|
|
645
758
|
/**
|
|
646
|
-
*
|
|
759
|
+
* The source code of the transformation.
|
|
647
760
|
*/
|
|
648
|
-
|
|
761
|
+
code: string;
|
|
649
762
|
/**
|
|
650
|
-
*
|
|
763
|
+
* The uniquely identified name of your transformation.
|
|
651
764
|
*/
|
|
652
|
-
|
|
653
|
-
dataType?: BigQueryDataType;
|
|
765
|
+
name: string;
|
|
654
766
|
/**
|
|
655
|
-
*
|
|
767
|
+
* A descriptive name for your transformation of what it does.
|
|
656
768
|
*/
|
|
657
|
-
|
|
769
|
+
description?: string;
|
|
658
770
|
/**
|
|
659
|
-
*
|
|
771
|
+
* The authentications associated for the current transformation.
|
|
660
772
|
*/
|
|
661
|
-
|
|
773
|
+
authenticationIDs?: string[];
|
|
774
|
+
};
|
|
775
|
+
|
|
776
|
+
type TransformationTry = {
|
|
662
777
|
/**
|
|
663
|
-
*
|
|
778
|
+
* The source code of the transformation.
|
|
664
779
|
*/
|
|
665
|
-
|
|
780
|
+
code: string;
|
|
666
781
|
/**
|
|
667
|
-
*
|
|
782
|
+
* The record to apply the given code to.
|
|
668
783
|
*/
|
|
669
|
-
|
|
784
|
+
sampleRecord: Record<string, unknown>;
|
|
785
|
+
authentications?: AuthenticationCreate[];
|
|
670
786
|
};
|
|
671
787
|
|
|
672
|
-
type MappingTypeCSV = 'boolean' | 'float' | 'integer' | 'json' | 'string';
|
|
673
|
-
|
|
674
788
|
/**
|
|
675
|
-
*
|
|
789
|
+
* 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.
|
|
676
790
|
*/
|
|
677
|
-
type
|
|
791
|
+
type TriggerType = 'onDemand' | 'schedule' | 'streaming' | 'subscription';
|
|
678
792
|
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
url: string;
|
|
793
|
+
/**
|
|
794
|
+
* Properties for the `customDelete` method.
|
|
795
|
+
*/
|
|
796
|
+
type CustomDeleteProps = {
|
|
684
797
|
/**
|
|
685
|
-
*
|
|
798
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
686
799
|
*/
|
|
687
|
-
|
|
800
|
+
path: string;
|
|
688
801
|
/**
|
|
689
|
-
*
|
|
802
|
+
* Query parameters to apply to the current query.
|
|
690
803
|
*/
|
|
691
|
-
|
|
692
|
-
method?: MethodType;
|
|
693
|
-
/**
|
|
694
|
-
* The character used to split the value on each line, default to a comma (\\r, \\n, 0xFFFD, and space are forbidden).
|
|
695
|
-
*/
|
|
696
|
-
delimiter?: string;
|
|
804
|
+
parameters?: Record<string, any>;
|
|
697
805
|
};
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
806
|
+
/**
|
|
807
|
+
* Properties for the `customGet` method.
|
|
808
|
+
*/
|
|
809
|
+
type CustomGetProps = {
|
|
701
810
|
/**
|
|
702
|
-
*
|
|
811
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
703
812
|
*/
|
|
704
|
-
|
|
705
|
-
url: string;
|
|
706
|
-
projectKey: string;
|
|
813
|
+
path: string;
|
|
707
814
|
/**
|
|
708
|
-
*
|
|
815
|
+
* Query parameters to apply to the current query.
|
|
709
816
|
*/
|
|
710
|
-
|
|
711
|
-
customFields?: CommercetoolsCustomFields;
|
|
817
|
+
parameters?: Record<string, any>;
|
|
712
818
|
};
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
819
|
+
/**
|
|
820
|
+
* Properties for the `customPost` method.
|
|
821
|
+
*/
|
|
822
|
+
type CustomPostProps = {
|
|
717
823
|
/**
|
|
718
|
-
*
|
|
824
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
719
825
|
*/
|
|
720
|
-
|
|
826
|
+
path: string;
|
|
721
827
|
/**
|
|
722
|
-
*
|
|
828
|
+
* Query parameters to apply to the current query.
|
|
723
829
|
*/
|
|
724
|
-
|
|
830
|
+
parameters?: Record<string, any>;
|
|
725
831
|
/**
|
|
726
|
-
*
|
|
832
|
+
* Parameters to send with the custom request.
|
|
727
833
|
*/
|
|
728
|
-
|
|
834
|
+
body?: Record<string, unknown>;
|
|
729
835
|
};
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
|
|
734
|
-
*/
|
|
735
|
-
projectID: string;
|
|
736
|
-
/**
|
|
737
|
-
* BigQuery dataset ID that the BigQuery export writes to.
|
|
738
|
-
*/
|
|
739
|
-
datasetID: string;
|
|
836
|
+
/**
|
|
837
|
+
* Properties for the `customPut` method.
|
|
838
|
+
*/
|
|
839
|
+
type CustomPutProps = {
|
|
740
840
|
/**
|
|
741
|
-
*
|
|
841
|
+
* Path of the endpoint, anything after \"/1\" must be specified.
|
|
742
842
|
*/
|
|
743
|
-
|
|
744
|
-
};
|
|
745
|
-
|
|
746
|
-
type SourceJSON = {
|
|
843
|
+
path: string;
|
|
747
844
|
/**
|
|
748
|
-
*
|
|
845
|
+
* Query parameters to apply to the current query.
|
|
749
846
|
*/
|
|
750
|
-
|
|
847
|
+
parameters?: Record<string, any>;
|
|
751
848
|
/**
|
|
752
|
-
*
|
|
849
|
+
* Parameters to send with the custom request.
|
|
753
850
|
*/
|
|
754
|
-
|
|
755
|
-
method?: MethodType;
|
|
851
|
+
body?: Record<string, unknown>;
|
|
756
852
|
};
|
|
757
|
-
|
|
758
|
-
|
|
853
|
+
/**
|
|
854
|
+
* Properties for the `deleteAuthentication` method.
|
|
855
|
+
*/
|
|
856
|
+
type DeleteAuthenticationProps = {
|
|
759
857
|
/**
|
|
760
|
-
*
|
|
858
|
+
* Unique identifier of an authentication resource.
|
|
761
859
|
*/
|
|
762
|
-
|
|
860
|
+
authenticationID: string;
|
|
763
861
|
};
|
|
764
|
-
|
|
765
|
-
|
|
862
|
+
/**
|
|
863
|
+
* Properties for the `deleteDestination` method.
|
|
864
|
+
*/
|
|
865
|
+
type DeleteDestinationProps = {
|
|
766
866
|
/**
|
|
767
|
-
*
|
|
867
|
+
* Unique identifier of a destination.
|
|
768
868
|
*/
|
|
769
|
-
|
|
869
|
+
destinationID: string;
|
|
770
870
|
};
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
type
|
|
775
|
-
|
|
776
|
-
type SourceType = 'bigcommerce' | 'bigquery' | 'commercetools' | 'csv' | 'docker' | 'ga4BigqueryExport' | 'json' | 'push' | 'sfcc' | 'shopify';
|
|
777
|
-
|
|
778
|
-
type Source = {
|
|
871
|
+
/**
|
|
872
|
+
* Properties for the `deleteSource` method.
|
|
873
|
+
*/
|
|
874
|
+
type DeleteSourceProps = {
|
|
779
875
|
/**
|
|
780
|
-
*
|
|
876
|
+
* Unique identifier of a source.
|
|
781
877
|
*/
|
|
782
878
|
sourceID: string;
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
*/
|
|
789
|
-
authenticationID?: string;
|
|
879
|
+
};
|
|
880
|
+
/**
|
|
881
|
+
* Properties for the `deleteTask` method.
|
|
882
|
+
*/
|
|
883
|
+
type DeleteTaskProps = {
|
|
790
884
|
/**
|
|
791
|
-
*
|
|
885
|
+
* Unique identifier of a task.
|
|
792
886
|
*/
|
|
793
|
-
|
|
887
|
+
taskID: string;
|
|
888
|
+
};
|
|
889
|
+
/**
|
|
890
|
+
* Properties for the `deleteTaskV1` method.
|
|
891
|
+
*/
|
|
892
|
+
type DeleteTaskV1Props = {
|
|
794
893
|
/**
|
|
795
|
-
*
|
|
894
|
+
* Unique identifier of a task.
|
|
796
895
|
*/
|
|
797
|
-
|
|
798
|
-
};
|
|
799
|
-
|
|
800
|
-
type ListSourcesResponse = {
|
|
801
|
-
sources: Source[];
|
|
802
|
-
pagination: Pagination;
|
|
896
|
+
taskID: string;
|
|
803
897
|
};
|
|
804
|
-
|
|
805
898
|
/**
|
|
806
|
-
*
|
|
899
|
+
* Properties for the `deleteTransformation` method.
|
|
807
900
|
*/
|
|
808
|
-
type
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
901
|
+
type DeleteTransformationProps = {
|
|
902
|
+
/**
|
|
903
|
+
* Unique identifier of a transformation.
|
|
904
|
+
*/
|
|
905
|
+
transformationID: string;
|
|
812
906
|
};
|
|
813
|
-
|
|
814
907
|
/**
|
|
815
|
-
*
|
|
908
|
+
* Properties for the `disableTask` method.
|
|
816
909
|
*/
|
|
817
|
-
type
|
|
818
|
-
|
|
819
|
-
|
|
820
|
-
|
|
910
|
+
type DisableTaskProps = {
|
|
911
|
+
/**
|
|
912
|
+
* Unique identifier of a task.
|
|
913
|
+
*/
|
|
914
|
+
taskID: string;
|
|
821
915
|
};
|
|
822
|
-
|
|
823
916
|
/**
|
|
824
|
-
*
|
|
917
|
+
* Properties for the `disableTaskV1` method.
|
|
825
918
|
*/
|
|
826
|
-
type
|
|
827
|
-
|
|
828
|
-
|
|
919
|
+
type DisableTaskV1Props = {
|
|
920
|
+
/**
|
|
921
|
+
* Unique identifier of a task.
|
|
922
|
+
*/
|
|
923
|
+
taskID: string;
|
|
829
924
|
};
|
|
830
|
-
|
|
831
925
|
/**
|
|
832
|
-
*
|
|
926
|
+
* Properties for the `enableTask` method.
|
|
833
927
|
*/
|
|
834
|
-
type
|
|
835
|
-
|
|
928
|
+
type EnableTaskProps = {
|
|
929
|
+
/**
|
|
930
|
+
* Unique identifier of a task.
|
|
931
|
+
*/
|
|
932
|
+
taskID: string;
|
|
933
|
+
};
|
|
836
934
|
/**
|
|
837
|
-
*
|
|
935
|
+
* Properties for the `enableTaskV1` method.
|
|
838
936
|
*/
|
|
839
|
-
type
|
|
937
|
+
type EnableTaskV1Props = {
|
|
840
938
|
/**
|
|
841
|
-
*
|
|
939
|
+
* Unique identifier of a task.
|
|
842
940
|
*/
|
|
843
|
-
|
|
941
|
+
taskID: string;
|
|
942
|
+
};
|
|
943
|
+
/**
|
|
944
|
+
* Properties for the `getAuthentication` method.
|
|
945
|
+
*/
|
|
946
|
+
type GetAuthenticationProps = {
|
|
844
947
|
/**
|
|
845
|
-
*
|
|
948
|
+
* Unique identifier of an authentication resource.
|
|
846
949
|
*/
|
|
847
|
-
|
|
950
|
+
authenticationID: string;
|
|
848
951
|
};
|
|
849
|
-
|
|
850
952
|
/**
|
|
851
|
-
*
|
|
953
|
+
* Properties for the `getDestination` method.
|
|
852
954
|
*/
|
|
853
|
-
type
|
|
955
|
+
type GetDestinationProps = {
|
|
854
956
|
/**
|
|
855
|
-
*
|
|
957
|
+
* Unique identifier of a destination.
|
|
856
958
|
*/
|
|
857
|
-
|
|
959
|
+
destinationID: string;
|
|
960
|
+
};
|
|
961
|
+
/**
|
|
962
|
+
* Properties for the `getEvent` method.
|
|
963
|
+
*/
|
|
964
|
+
type GetEventProps = {
|
|
858
965
|
/**
|
|
859
|
-
*
|
|
966
|
+
* Unique identifier of a task run.
|
|
860
967
|
*/
|
|
861
|
-
|
|
968
|
+
runID: string;
|
|
862
969
|
/**
|
|
863
|
-
*
|
|
970
|
+
* Unique identifier of an event.
|
|
864
971
|
*/
|
|
865
|
-
|
|
866
|
-
fieldDirectives: MappingFieldDirective[];
|
|
972
|
+
eventID: string;
|
|
867
973
|
};
|
|
868
|
-
|
|
869
974
|
/**
|
|
870
|
-
*
|
|
975
|
+
* Properties for the `getRun` method.
|
|
871
976
|
*/
|
|
872
|
-
type
|
|
873
|
-
|
|
874
|
-
|
|
977
|
+
type GetRunProps = {
|
|
978
|
+
/**
|
|
979
|
+
* Unique identifier of a task run.
|
|
980
|
+
*/
|
|
981
|
+
runID: string;
|
|
875
982
|
};
|
|
876
|
-
|
|
877
983
|
/**
|
|
878
|
-
*
|
|
984
|
+
* Properties for the `getSource` method.
|
|
879
985
|
*/
|
|
880
|
-
type
|
|
881
|
-
|
|
986
|
+
type GetSourceProps = {
|
|
987
|
+
/**
|
|
988
|
+
* Unique identifier of a source.
|
|
989
|
+
*/
|
|
990
|
+
sourceID: string;
|
|
882
991
|
};
|
|
883
|
-
|
|
884
992
|
/**
|
|
885
|
-
*
|
|
993
|
+
* Properties for the `getTask` method.
|
|
886
994
|
*/
|
|
887
|
-
type
|
|
888
|
-
|
|
889
|
-
type Task = {
|
|
995
|
+
type GetTaskProps = {
|
|
890
996
|
/**
|
|
891
|
-
*
|
|
997
|
+
* Unique identifier of a task.
|
|
892
998
|
*/
|
|
893
999
|
taskID: string;
|
|
1000
|
+
};
|
|
1001
|
+
/**
|
|
1002
|
+
* Properties for the `getTaskV1` method.
|
|
1003
|
+
*/
|
|
1004
|
+
type GetTaskV1Props = {
|
|
894
1005
|
/**
|
|
895
|
-
*
|
|
896
|
-
*/
|
|
897
|
-
sourceID: string;
|
|
898
|
-
/**
|
|
899
|
-
* Universally unique identifier (UUID) of a destination resource.
|
|
900
|
-
*/
|
|
901
|
-
destinationID: string;
|
|
902
|
-
/**
|
|
903
|
-
* Cron expression for the task\'s schedule.
|
|
1006
|
+
* Unique identifier of a task.
|
|
904
1007
|
*/
|
|
905
|
-
|
|
1008
|
+
taskID: string;
|
|
1009
|
+
};
|
|
1010
|
+
/**
|
|
1011
|
+
* Properties for the `getTransformation` method.
|
|
1012
|
+
*/
|
|
1013
|
+
type GetTransformationProps = {
|
|
906
1014
|
/**
|
|
907
|
-
*
|
|
1015
|
+
* Unique identifier of a transformation.
|
|
908
1016
|
*/
|
|
909
|
-
|
|
1017
|
+
transformationID: string;
|
|
1018
|
+
};
|
|
1019
|
+
/**
|
|
1020
|
+
* Properties for the `listAuthentications` method.
|
|
1021
|
+
*/
|
|
1022
|
+
type ListAuthenticationsProps = {
|
|
910
1023
|
/**
|
|
911
|
-
*
|
|
1024
|
+
* Number of items per page.
|
|
912
1025
|
*/
|
|
913
|
-
|
|
914
|
-
input?: TaskInput;
|
|
1026
|
+
itemsPerPage?: number;
|
|
915
1027
|
/**
|
|
916
|
-
*
|
|
1028
|
+
* Page number of the paginated API response.
|
|
917
1029
|
*/
|
|
918
|
-
|
|
1030
|
+
page?: number;
|
|
919
1031
|
/**
|
|
920
|
-
*
|
|
1032
|
+
* Type of authentication resource to retrieve.
|
|
921
1033
|
*/
|
|
922
|
-
|
|
923
|
-
action: ActionType;
|
|
1034
|
+
type?: AuthenticationType[];
|
|
924
1035
|
/**
|
|
925
|
-
*
|
|
1036
|
+
* Ecommerce platform for which to retrieve authentication resources.
|
|
926
1037
|
*/
|
|
927
|
-
|
|
1038
|
+
platform?: PlatformWithNone[];
|
|
928
1039
|
/**
|
|
929
|
-
*
|
|
1040
|
+
* Property by which to sort the list of authentication resources.
|
|
930
1041
|
*/
|
|
931
|
-
|
|
1042
|
+
sort?: AuthenticationSortKeys;
|
|
932
1043
|
/**
|
|
933
|
-
*
|
|
1044
|
+
* Sort order of the response, ascending or descending.
|
|
934
1045
|
*/
|
|
935
|
-
|
|
936
|
-
};
|
|
937
|
-
|
|
938
|
-
/**
|
|
939
|
-
* Configured tasks and pagination information.
|
|
940
|
-
*/
|
|
941
|
-
type ListTasksResponse = {
|
|
942
|
-
tasks: Task[];
|
|
943
|
-
pagination: Pagination;
|
|
1046
|
+
order?: OrderKeys;
|
|
944
1047
|
};
|
|
945
|
-
|
|
946
1048
|
/**
|
|
947
|
-
*
|
|
948
|
-
*/
|
|
949
|
-
type OnDemandTriggerType = 'onDemand';
|
|
950
|
-
|
|
951
|
-
/**
|
|
952
|
-
* Trigger information for manually-triggered tasks.
|
|
1049
|
+
* Properties for the `listDestinations` method.
|
|
953
1050
|
*/
|
|
954
|
-
type
|
|
955
|
-
type: OnDemandTriggerType;
|
|
1051
|
+
type ListDestinationsProps = {
|
|
956
1052
|
/**
|
|
957
|
-
*
|
|
1053
|
+
* Number of items per page.
|
|
958
1054
|
*/
|
|
959
|
-
|
|
960
|
-
};
|
|
961
|
-
|
|
962
|
-
/**
|
|
963
|
-
* Task runs on a schedule.
|
|
964
|
-
*/
|
|
965
|
-
type ScheduleTriggerType = 'schedule';
|
|
966
|
-
|
|
967
|
-
/**
|
|
968
|
-
* Trigger information for scheduled tasks.
|
|
969
|
-
*/
|
|
970
|
-
type ScheduleTrigger = {
|
|
971
|
-
type: ScheduleTriggerType;
|
|
1055
|
+
itemsPerPage?: number;
|
|
972
1056
|
/**
|
|
973
|
-
*
|
|
1057
|
+
* Page number of the paginated API response.
|
|
974
1058
|
*/
|
|
975
|
-
|
|
1059
|
+
page?: number;
|
|
976
1060
|
/**
|
|
977
|
-
*
|
|
1061
|
+
* Destination type.
|
|
978
1062
|
*/
|
|
979
|
-
|
|
1063
|
+
type?: DestinationType[];
|
|
980
1064
|
/**
|
|
981
|
-
*
|
|
1065
|
+
* Authentication ID used by destinations.
|
|
982
1066
|
*/
|
|
983
|
-
|
|
984
|
-
|
|
985
|
-
|
|
986
|
-
|
|
987
|
-
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
* Trigger input for continuously running tasks.
|
|
993
|
-
*/
|
|
994
|
-
type StreamingTrigger = {
|
|
995
|
-
type: StreamingTriggerType;
|
|
996
|
-
};
|
|
997
|
-
|
|
998
|
-
/**
|
|
999
|
-
* Task runs after receiving subscribed event.
|
|
1000
|
-
*/
|
|
1001
|
-
type SubscriptionTriggerType = 'subscription';
|
|
1002
|
-
|
|
1003
|
-
/**
|
|
1004
|
-
* Trigger input for subscription tasks.
|
|
1005
|
-
*/
|
|
1006
|
-
type SubscriptionTrigger = {
|
|
1007
|
-
type: SubscriptionTriggerType;
|
|
1067
|
+
authenticationID?: string[];
|
|
1068
|
+
/**
|
|
1069
|
+
* Property by which to sort the destinations.
|
|
1070
|
+
*/
|
|
1071
|
+
sort?: DestinationSortKeys;
|
|
1072
|
+
/**
|
|
1073
|
+
* Sort order of the response, ascending or descending.
|
|
1074
|
+
*/
|
|
1075
|
+
order?: OrderKeys;
|
|
1008
1076
|
};
|
|
1009
|
-
|
|
1010
|
-
/**
|
|
1011
|
-
* Trigger that runs the task.
|
|
1012
|
-
*/
|
|
1013
|
-
type Trigger = OnDemandTrigger | ScheduleTrigger | StreamingTrigger | SubscriptionTrigger;
|
|
1014
|
-
|
|
1015
1077
|
/**
|
|
1016
|
-
*
|
|
1078
|
+
* Properties for the `listEvents` method.
|
|
1017
1079
|
*/
|
|
1018
|
-
type
|
|
1080
|
+
type ListEventsProps = {
|
|
1019
1081
|
/**
|
|
1020
|
-
*
|
|
1082
|
+
* Unique identifier of a task run.
|
|
1021
1083
|
*/
|
|
1022
|
-
|
|
1084
|
+
runID: string;
|
|
1023
1085
|
/**
|
|
1024
|
-
*
|
|
1086
|
+
* Number of items per page.
|
|
1025
1087
|
*/
|
|
1026
|
-
|
|
1088
|
+
itemsPerPage?: number;
|
|
1027
1089
|
/**
|
|
1028
|
-
*
|
|
1090
|
+
* Page number of the paginated API response.
|
|
1029
1091
|
*/
|
|
1030
|
-
|
|
1031
|
-
trigger: Trigger;
|
|
1032
|
-
input?: TaskInput;
|
|
1092
|
+
page?: number;
|
|
1033
1093
|
/**
|
|
1034
|
-
*
|
|
1094
|
+
* Event status for filtering the list of task runs.
|
|
1035
1095
|
*/
|
|
1036
|
-
|
|
1096
|
+
status?: EventStatus[];
|
|
1037
1097
|
/**
|
|
1038
|
-
*
|
|
1098
|
+
* Event type for filtering the list of task runs.
|
|
1039
1099
|
*/
|
|
1040
|
-
|
|
1041
|
-
action: ActionType;
|
|
1100
|
+
type?: EventType[];
|
|
1042
1101
|
/**
|
|
1043
|
-
*
|
|
1102
|
+
* Property by which to sort the list of task run events.
|
|
1044
1103
|
*/
|
|
1045
|
-
|
|
1104
|
+
sort?: EventSortKeys;
|
|
1046
1105
|
/**
|
|
1047
|
-
*
|
|
1106
|
+
* Sort order of the response, ascending or descending.
|
|
1048
1107
|
*/
|
|
1049
|
-
|
|
1108
|
+
order?: OrderKeys;
|
|
1050
1109
|
/**
|
|
1051
|
-
* Date
|
|
1110
|
+
* Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
|
|
1052
1111
|
*/
|
|
1053
|
-
|
|
1112
|
+
startDate?: string;
|
|
1113
|
+
/**
|
|
1114
|
+
* Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
1115
|
+
*/
|
|
1116
|
+
endDate?: string;
|
|
1054
1117
|
};
|
|
1055
|
-
|
|
1056
1118
|
/**
|
|
1057
|
-
*
|
|
1119
|
+
* Properties for the `listRuns` method.
|
|
1058
1120
|
*/
|
|
1059
|
-
type
|
|
1060
|
-
tasks: TaskV1[];
|
|
1061
|
-
pagination: Pagination;
|
|
1062
|
-
};
|
|
1063
|
-
|
|
1064
|
-
type Transformation = {
|
|
1121
|
+
type ListRunsProps = {
|
|
1065
1122
|
/**
|
|
1066
|
-
*
|
|
1123
|
+
* Number of items per page.
|
|
1067
1124
|
*/
|
|
1068
|
-
|
|
1125
|
+
itemsPerPage?: number;
|
|
1069
1126
|
/**
|
|
1070
|
-
*
|
|
1127
|
+
* Page number of the paginated API response.
|
|
1071
1128
|
*/
|
|
1072
|
-
|
|
1129
|
+
page?: number;
|
|
1073
1130
|
/**
|
|
1074
|
-
*
|
|
1131
|
+
* Run status for filtering the list of task runs.
|
|
1075
1132
|
*/
|
|
1076
|
-
|
|
1133
|
+
status?: RunStatus[];
|
|
1077
1134
|
/**
|
|
1078
|
-
*
|
|
1135
|
+
* Run type for filtering the list of task runs.
|
|
1079
1136
|
*/
|
|
1080
|
-
|
|
1137
|
+
type?: RunType[];
|
|
1081
1138
|
/**
|
|
1082
|
-
*
|
|
1139
|
+
* Task ID for filtering the list of task runs.
|
|
1083
1140
|
*/
|
|
1084
|
-
|
|
1141
|
+
taskID?: string;
|
|
1085
1142
|
/**
|
|
1086
|
-
*
|
|
1143
|
+
* Property by which to sort the list of task runs.
|
|
1087
1144
|
*/
|
|
1088
|
-
|
|
1145
|
+
sort?: RunSortKeys;
|
|
1089
1146
|
/**
|
|
1090
|
-
*
|
|
1147
|
+
* Sort order of the response, ascending or descending.
|
|
1091
1148
|
*/
|
|
1092
|
-
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
|
|
1097
|
-
|
|
1098
|
-
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
};
|
|
1102
|
-
|
|
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;
|
|
1149
|
+
order?: OrderKeys;
|
|
1150
|
+
/**
|
|
1151
|
+
* Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
|
|
1152
|
+
*/
|
|
1153
|
+
startDate?: string;
|
|
1154
|
+
/**
|
|
1155
|
+
* Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
|
|
1156
|
+
*/
|
|
1157
|
+
endDate?: string;
|
|
1116
1158
|
};
|
|
1117
|
-
|
|
1118
1159
|
/**
|
|
1119
|
-
*
|
|
1160
|
+
* Properties for the `listSources` method.
|
|
1120
1161
|
*/
|
|
1121
|
-
type
|
|
1122
|
-
|
|
1162
|
+
type ListSourcesProps = {
|
|
1163
|
+
/**
|
|
1164
|
+
* Number of items per page.
|
|
1165
|
+
*/
|
|
1166
|
+
itemsPerPage?: number;
|
|
1167
|
+
/**
|
|
1168
|
+
* Page number of the paginated API response.
|
|
1169
|
+
*/
|
|
1170
|
+
page?: number;
|
|
1171
|
+
/**
|
|
1172
|
+
* Source type. Some sources require authentication.
|
|
1173
|
+
*/
|
|
1174
|
+
type?: SourceType[];
|
|
1175
|
+
/**
|
|
1176
|
+
* Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
|
|
1177
|
+
*/
|
|
1178
|
+
authenticationID?: string[];
|
|
1179
|
+
/**
|
|
1180
|
+
* Property by which to sort the list of sources.
|
|
1181
|
+
*/
|
|
1182
|
+
sort?: SourceSortKeys;
|
|
1183
|
+
/**
|
|
1184
|
+
* Sort order of the response, ascending or descending.
|
|
1185
|
+
*/
|
|
1186
|
+
order?: OrderKeys;
|
|
1187
|
+
};
|
|
1123
1188
|
/**
|
|
1124
|
-
*
|
|
1189
|
+
* Properties for the `listTasks` method.
|
|
1125
1190
|
*/
|
|
1126
|
-
type
|
|
1127
|
-
|
|
1128
|
-
type PlatformWithNone = Platform | PlatformNone;
|
|
1129
|
-
|
|
1130
|
-
type PushTaskRecords = Record<string, any> & {
|
|
1191
|
+
type ListTasksProps = {
|
|
1131
1192
|
/**
|
|
1132
|
-
*
|
|
1193
|
+
* Number of items per page.
|
|
1133
1194
|
*/
|
|
1134
|
-
|
|
1195
|
+
itemsPerPage?: number;
|
|
1196
|
+
/**
|
|
1197
|
+
* Page number of the paginated API response.
|
|
1198
|
+
*/
|
|
1199
|
+
page?: number;
|
|
1200
|
+
/**
|
|
1201
|
+
* Actions for filtering the list of tasks.
|
|
1202
|
+
*/
|
|
1203
|
+
action?: ActionType[];
|
|
1204
|
+
/**
|
|
1205
|
+
* Whether to filter the list of tasks by the `enabled` status.
|
|
1206
|
+
*/
|
|
1207
|
+
enabled?: boolean;
|
|
1208
|
+
/**
|
|
1209
|
+
* Source IDs for filtering the list of tasks.
|
|
1210
|
+
*/
|
|
1211
|
+
sourceID?: string[];
|
|
1212
|
+
/**
|
|
1213
|
+
* Destination IDs for filtering the list of tasks.
|
|
1214
|
+
*/
|
|
1215
|
+
destinationID?: string[];
|
|
1216
|
+
/**
|
|
1217
|
+
* Type of task trigger for filtering the list of tasks.
|
|
1218
|
+
*/
|
|
1219
|
+
triggerType?: TriggerType[];
|
|
1220
|
+
/**
|
|
1221
|
+
* Property by which to sort the list of tasks.
|
|
1222
|
+
*/
|
|
1223
|
+
sort?: TaskSortKeys;
|
|
1224
|
+
/**
|
|
1225
|
+
* Sort order of the response, ascending or descending.
|
|
1226
|
+
*/
|
|
1227
|
+
order?: OrderKeys;
|
|
1135
1228
|
};
|
|
1136
|
-
|
|
1137
|
-
|
|
1138
|
-
|
|
1139
|
-
|
|
1229
|
+
/**
|
|
1230
|
+
* Properties for the `listTasksV1` method.
|
|
1231
|
+
*/
|
|
1232
|
+
type ListTasksV1Props = {
|
|
1233
|
+
/**
|
|
1234
|
+
* Number of items per page.
|
|
1235
|
+
*/
|
|
1236
|
+
itemsPerPage?: number;
|
|
1237
|
+
/**
|
|
1238
|
+
* Page number of the paginated API response.
|
|
1239
|
+
*/
|
|
1240
|
+
page?: number;
|
|
1241
|
+
/**
|
|
1242
|
+
* Actions for filtering the list of tasks.
|
|
1243
|
+
*/
|
|
1244
|
+
action?: ActionType[];
|
|
1245
|
+
/**
|
|
1246
|
+
* Whether to filter the list of tasks by the `enabled` status.
|
|
1247
|
+
*/
|
|
1248
|
+
enabled?: boolean;
|
|
1249
|
+
/**
|
|
1250
|
+
* Source IDs for filtering the list of tasks.
|
|
1251
|
+
*/
|
|
1252
|
+
sourceID?: string[];
|
|
1253
|
+
/**
|
|
1254
|
+
* Destination IDs for filtering the list of tasks.
|
|
1255
|
+
*/
|
|
1256
|
+
destinationID?: string[];
|
|
1257
|
+
/**
|
|
1258
|
+
* Type of task trigger for filtering the list of tasks.
|
|
1259
|
+
*/
|
|
1260
|
+
triggerType?: TriggerType[];
|
|
1261
|
+
/**
|
|
1262
|
+
* Property by which to sort the list of tasks.
|
|
1263
|
+
*/
|
|
1264
|
+
sort?: TaskSortKeys;
|
|
1265
|
+
/**
|
|
1266
|
+
* Sort order of the response, ascending or descending.
|
|
1267
|
+
*/
|
|
1268
|
+
order?: OrderKeys;
|
|
1140
1269
|
};
|
|
1141
|
-
|
|
1142
1270
|
/**
|
|
1143
|
-
*
|
|
1271
|
+
* Properties for the `listTransformations` method.
|
|
1144
1272
|
*/
|
|
1145
|
-
type
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1149
|
-
|
|
1273
|
+
type ListTransformationsProps = {
|
|
1274
|
+
/**
|
|
1275
|
+
* Number of items per page.
|
|
1276
|
+
*/
|
|
1277
|
+
itemsPerPage?: number;
|
|
1278
|
+
/**
|
|
1279
|
+
* Page number of the paginated API response.
|
|
1280
|
+
*/
|
|
1281
|
+
page?: number;
|
|
1282
|
+
/**
|
|
1283
|
+
* Property by which to sort the list.
|
|
1284
|
+
*/
|
|
1285
|
+
sort?: SortKeys;
|
|
1286
|
+
/**
|
|
1287
|
+
* Sort order of the response, ascending or descending.
|
|
1288
|
+
*/
|
|
1289
|
+
order?: OrderKeys;
|
|
1150
1290
|
};
|
|
1151
|
-
|
|
1152
1291
|
/**
|
|
1153
|
-
*
|
|
1292
|
+
* Properties for the `pushTask` method.
|
|
1154
1293
|
*/
|
|
1155
|
-
type
|
|
1156
|
-
|
|
1294
|
+
type PushTaskProps = {
|
|
1295
|
+
/**
|
|
1296
|
+
* Unique identifier of a task.
|
|
1297
|
+
*/
|
|
1298
|
+
taskID: string;
|
|
1299
|
+
/**
|
|
1300
|
+
* Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
1301
|
+
*/
|
|
1302
|
+
pushTaskPayload: PushTaskPayload;
|
|
1303
|
+
};
|
|
1157
1304
|
/**
|
|
1158
|
-
*
|
|
1305
|
+
* Properties for the `runSource` method.
|
|
1159
1306
|
*/
|
|
1160
|
-
type
|
|
1307
|
+
type RunSourceProps = {
|
|
1308
|
+
/**
|
|
1309
|
+
* Unique identifier of a source.
|
|
1310
|
+
*/
|
|
1311
|
+
sourceID: string;
|
|
1312
|
+
/**
|
|
1313
|
+
*
|
|
1314
|
+
*/
|
|
1315
|
+
runSourcePayload?: RunSourcePayload;
|
|
1316
|
+
};
|
|
1317
|
+
/**
|
|
1318
|
+
* Properties for the `runTask` method.
|
|
1319
|
+
*/
|
|
1320
|
+
type RunTaskProps = {
|
|
1321
|
+
/**
|
|
1322
|
+
* Unique identifier of a task.
|
|
1323
|
+
*/
|
|
1324
|
+
taskID: string;
|
|
1325
|
+
};
|
|
1326
|
+
/**
|
|
1327
|
+
* Properties for the `runTaskV1` method.
|
|
1328
|
+
*/
|
|
1329
|
+
type RunTaskV1Props = {
|
|
1330
|
+
/**
|
|
1331
|
+
* Unique identifier of a task.
|
|
1332
|
+
*/
|
|
1333
|
+
taskID: string;
|
|
1334
|
+
};
|
|
1335
|
+
/**
|
|
1336
|
+
* Properties for the `triggerDockerSourceDiscover` method.
|
|
1337
|
+
*/
|
|
1338
|
+
type TriggerDockerSourceDiscoverProps = {
|
|
1339
|
+
/**
|
|
1340
|
+
* Unique identifier of a source.
|
|
1341
|
+
*/
|
|
1342
|
+
sourceID: string;
|
|
1343
|
+
};
|
|
1344
|
+
/**
|
|
1345
|
+
* Properties for the `tryTransformationBeforeUpdate` method.
|
|
1346
|
+
*/
|
|
1347
|
+
type TryTransformationBeforeUpdateProps = {
|
|
1348
|
+
/**
|
|
1349
|
+
* Unique identifier of a transformation.
|
|
1350
|
+
*/
|
|
1351
|
+
transformationID: string;
|
|
1352
|
+
transformationTry: TransformationTry;
|
|
1353
|
+
};
|
|
1354
|
+
/**
|
|
1355
|
+
* Properties for the `updateAuthentication` method.
|
|
1356
|
+
*/
|
|
1357
|
+
type UpdateAuthenticationProps = {
|
|
1358
|
+
/**
|
|
1359
|
+
* Unique identifier of an authentication resource.
|
|
1360
|
+
*/
|
|
1361
|
+
authenticationID: string;
|
|
1362
|
+
authenticationUpdate: AuthenticationUpdate;
|
|
1363
|
+
};
|
|
1364
|
+
/**
|
|
1365
|
+
* Properties for the `updateDestination` method.
|
|
1366
|
+
*/
|
|
1367
|
+
type UpdateDestinationProps = {
|
|
1368
|
+
/**
|
|
1369
|
+
* Unique identifier of a destination.
|
|
1370
|
+
*/
|
|
1371
|
+
destinationID: string;
|
|
1372
|
+
destinationUpdate: DestinationUpdate;
|
|
1373
|
+
};
|
|
1374
|
+
/**
|
|
1375
|
+
* Properties for the `updateSource` method.
|
|
1376
|
+
*/
|
|
1377
|
+
type UpdateSourceProps = {
|
|
1378
|
+
/**
|
|
1379
|
+
* Unique identifier of a source.
|
|
1380
|
+
*/
|
|
1381
|
+
sourceID: string;
|
|
1382
|
+
sourceUpdate: SourceUpdate;
|
|
1383
|
+
};
|
|
1384
|
+
/**
|
|
1385
|
+
* Properties for the `updateTask` method.
|
|
1386
|
+
*/
|
|
1387
|
+
type UpdateTaskProps = {
|
|
1388
|
+
/**
|
|
1389
|
+
* Unique identifier of a task.
|
|
1390
|
+
*/
|
|
1391
|
+
taskID: string;
|
|
1392
|
+
taskUpdate: TaskUpdate;
|
|
1393
|
+
};
|
|
1394
|
+
/**
|
|
1395
|
+
* Properties for the `updateTaskV1` method.
|
|
1396
|
+
*/
|
|
1397
|
+
type UpdateTaskV1Props = {
|
|
1398
|
+
/**
|
|
1399
|
+
* Unique identifier of a task.
|
|
1400
|
+
*/
|
|
1401
|
+
taskID: string;
|
|
1402
|
+
taskUpdate: TaskUpdateV1;
|
|
1403
|
+
};
|
|
1404
|
+
/**
|
|
1405
|
+
* Properties for the `updateTransformation` method.
|
|
1406
|
+
*/
|
|
1407
|
+
type UpdateTransformationProps = {
|
|
1408
|
+
/**
|
|
1409
|
+
* Unique identifier of a transformation.
|
|
1410
|
+
*/
|
|
1411
|
+
transformationID: string;
|
|
1412
|
+
transformationCreate: TransformationCreate;
|
|
1413
|
+
};
|
|
1414
|
+
/**
|
|
1415
|
+
* Properties for the `validateSourceBeforeUpdate` method.
|
|
1416
|
+
*/
|
|
1417
|
+
type ValidateSourceBeforeUpdateProps = {
|
|
1418
|
+
/**
|
|
1419
|
+
* Unique identifier of a source.
|
|
1420
|
+
*/
|
|
1421
|
+
sourceID: string;
|
|
1422
|
+
sourceUpdate: SourceUpdate;
|
|
1423
|
+
};
|
|
1424
|
+
|
|
1425
|
+
type DeleteResponse = {
|
|
1426
|
+
/**
|
|
1427
|
+
* Date of deletion in RFC 3339 format.
|
|
1428
|
+
*/
|
|
1429
|
+
deletedAt: string;
|
|
1430
|
+
};
|
|
1161
1431
|
|
|
1162
1432
|
/**
|
|
1163
|
-
*
|
|
1433
|
+
* Destinations are Algolia resources like indices or event streams.
|
|
1164
1434
|
*/
|
|
1165
|
-
type
|
|
1435
|
+
type Destination = {
|
|
1436
|
+
/**
|
|
1437
|
+
* Universally unique identifier (UUID) of a destination resource.
|
|
1438
|
+
*/
|
|
1439
|
+
destinationID: string;
|
|
1440
|
+
type: DestinationType;
|
|
1441
|
+
/**
|
|
1442
|
+
* Descriptive name for the resource.
|
|
1443
|
+
*/
|
|
1444
|
+
name: string;
|
|
1445
|
+
input: DestinationInput;
|
|
1446
|
+
/**
|
|
1447
|
+
* Date of creation in RFC 3339 format.
|
|
1448
|
+
*/
|
|
1449
|
+
createdAt: string;
|
|
1450
|
+
/**
|
|
1451
|
+
* Date of last update in RFC 3339 format.
|
|
1452
|
+
*/
|
|
1453
|
+
updatedAt?: string;
|
|
1454
|
+
/**
|
|
1455
|
+
* Universally unique identifier (UUID) of an authentication resource.
|
|
1456
|
+
*/
|
|
1457
|
+
authenticationID?: string;
|
|
1458
|
+
transformationIDs?: string[];
|
|
1459
|
+
};
|
|
1166
1460
|
|
|
1167
|
-
|
|
1461
|
+
/**
|
|
1462
|
+
* API request body for creating a new destination.
|
|
1463
|
+
*/
|
|
1464
|
+
type DestinationCreate = {
|
|
1465
|
+
type: DestinationType;
|
|
1168
1466
|
/**
|
|
1169
|
-
*
|
|
1467
|
+
* Descriptive name for the resource.
|
|
1170
1468
|
*/
|
|
1171
|
-
|
|
1172
|
-
|
|
1469
|
+
name: string;
|
|
1470
|
+
input: DestinationInput;
|
|
1173
1471
|
/**
|
|
1174
|
-
* Universally unique identifier (UUID) of
|
|
1472
|
+
* Universally unique identifier (UUID) of an authentication resource.
|
|
1175
1473
|
*/
|
|
1176
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1474
|
+
authenticationID?: string;
|
|
1475
|
+
transformationIDs?: string[];
|
|
1476
|
+
};
|
|
1477
|
+
|
|
1478
|
+
/**
|
|
1479
|
+
* API response for creating a new destination.
|
|
1480
|
+
*/
|
|
1481
|
+
type DestinationCreateResponse = {
|
|
1180
1482
|
/**
|
|
1181
|
-
*
|
|
1483
|
+
* Universally unique identifier (UUID) of a destination resource.
|
|
1182
1484
|
*/
|
|
1183
|
-
|
|
1485
|
+
destinationID: string;
|
|
1184
1486
|
/**
|
|
1185
|
-
*
|
|
1487
|
+
* Descriptive name for the resource.
|
|
1186
1488
|
*/
|
|
1187
|
-
|
|
1188
|
-
reasonCode?: RunReasonCode;
|
|
1189
|
-
type: RunType;
|
|
1489
|
+
name: string;
|
|
1190
1490
|
/**
|
|
1191
1491
|
* Date of creation in RFC 3339 format.
|
|
1192
1492
|
*/
|
|
1193
|
-
createdAt: string;
|
|
1493
|
+
createdAt: string;
|
|
1494
|
+
};
|
|
1495
|
+
|
|
1496
|
+
/**
|
|
1497
|
+
* API request body for searching destinations.
|
|
1498
|
+
*/
|
|
1499
|
+
type DestinationSearch = {
|
|
1500
|
+
destinationIDs: string[];
|
|
1501
|
+
};
|
|
1502
|
+
|
|
1503
|
+
/**
|
|
1504
|
+
* API response for updating a destination.
|
|
1505
|
+
*/
|
|
1506
|
+
type DestinationUpdateResponse = {
|
|
1507
|
+
/**
|
|
1508
|
+
* Universally unique identifier (UUID) of a destination resource.
|
|
1509
|
+
*/
|
|
1510
|
+
destinationID: string;
|
|
1194
1511
|
/**
|
|
1195
|
-
*
|
|
1512
|
+
* Descriptive name for the resource.
|
|
1196
1513
|
*/
|
|
1197
|
-
|
|
1514
|
+
name: string;
|
|
1198
1515
|
/**
|
|
1199
|
-
* Date of
|
|
1516
|
+
* Date of last update in RFC 3339 format.
|
|
1200
1517
|
*/
|
|
1201
|
-
|
|
1202
|
-
};
|
|
1203
|
-
|
|
1204
|
-
type RunListResponse = {
|
|
1205
|
-
runs: Run[];
|
|
1206
|
-
pagination: Pagination;
|
|
1207
|
-
window: Window;
|
|
1518
|
+
updatedAt: string;
|
|
1208
1519
|
};
|
|
1209
1520
|
|
|
1210
1521
|
/**
|
|
1211
|
-
*
|
|
1522
|
+
* An event describe a step of the task execution flow..
|
|
1212
1523
|
*/
|
|
1213
|
-
type
|
|
1524
|
+
type Event = {
|
|
1525
|
+
/**
|
|
1526
|
+
* Universally unique identifier (UUID) of an event.
|
|
1527
|
+
*/
|
|
1528
|
+
eventID: string;
|
|
1214
1529
|
/**
|
|
1215
1530
|
* Universally unique identifier (UUID) of a task run.
|
|
1216
1531
|
*/
|
|
1217
1532
|
runID: string;
|
|
1218
1533
|
/**
|
|
1219
|
-
*
|
|
1534
|
+
* The parent event, the cause of this event.
|
|
1220
1535
|
*/
|
|
1221
|
-
|
|
1536
|
+
parentID?: string;
|
|
1537
|
+
status: EventStatus;
|
|
1538
|
+
type: EventType;
|
|
1539
|
+
/**
|
|
1540
|
+
* The extracted record batch size.
|
|
1541
|
+
*/
|
|
1542
|
+
batchSize: number;
|
|
1543
|
+
data?: Record<string, any>;
|
|
1544
|
+
/**
|
|
1545
|
+
* Date of publish RFC 3339 format.
|
|
1546
|
+
*/
|
|
1547
|
+
publishedAt: string;
|
|
1548
|
+
};
|
|
1549
|
+
|
|
1550
|
+
type GenerateTransformationCodePayload = {
|
|
1551
|
+
id: string;
|
|
1552
|
+
systemPrompt?: string;
|
|
1553
|
+
userPrompt: string;
|
|
1554
|
+
};
|
|
1555
|
+
|
|
1556
|
+
type GenerateTransformationCodeResponse = {
|
|
1557
|
+
generatedCode?: string;
|
|
1222
1558
|
};
|
|
1223
1559
|
|
|
1224
1560
|
/**
|
|
1225
|
-
*
|
|
1561
|
+
* Paginated API response.
|
|
1226
1562
|
*/
|
|
1227
|
-
type
|
|
1228
|
-
|
|
1229
|
-
type RunSourcePayload = {
|
|
1230
|
-
/**
|
|
1231
|
-
* List of index names to include in reidexing/update.
|
|
1232
|
-
*/
|
|
1233
|
-
indexToInclude?: string[];
|
|
1563
|
+
type Pagination = {
|
|
1234
1564
|
/**
|
|
1235
|
-
*
|
|
1565
|
+
* Number of pages in the API response.
|
|
1236
1566
|
*/
|
|
1237
|
-
|
|
1567
|
+
nbPages: number;
|
|
1238
1568
|
/**
|
|
1239
|
-
*
|
|
1569
|
+
* Page of the API response to retrieve.
|
|
1240
1570
|
*/
|
|
1241
|
-
|
|
1242
|
-
entityType?: EntityType;
|
|
1243
|
-
};
|
|
1244
|
-
|
|
1245
|
-
type RunSourceResponse = {
|
|
1571
|
+
page: number;
|
|
1246
1572
|
/**
|
|
1247
|
-
*
|
|
1573
|
+
* Number of items in the API response.
|
|
1248
1574
|
*/
|
|
1249
|
-
|
|
1575
|
+
nbItems: number;
|
|
1250
1576
|
/**
|
|
1251
|
-
*
|
|
1577
|
+
* Number of items per page.
|
|
1252
1578
|
*/
|
|
1253
|
-
|
|
1579
|
+
itemsPerPage: number;
|
|
1580
|
+
};
|
|
1581
|
+
|
|
1582
|
+
type ListAuthenticationsResponse = {
|
|
1583
|
+
authentications: Authentication[];
|
|
1584
|
+
pagination: Pagination;
|
|
1585
|
+
};
|
|
1586
|
+
|
|
1587
|
+
type ListDestinationsResponse = {
|
|
1588
|
+
destinations: Destination[];
|
|
1589
|
+
pagination: Pagination;
|
|
1254
1590
|
};
|
|
1255
1591
|
|
|
1256
1592
|
/**
|
|
1257
|
-
*
|
|
1593
|
+
* Time window by which to filter the observability data.
|
|
1258
1594
|
*/
|
|
1259
|
-
type
|
|
1260
|
-
type: ScheduleTriggerType;
|
|
1595
|
+
type Window = {
|
|
1261
1596
|
/**
|
|
1262
|
-
*
|
|
1597
|
+
* Date in RFC 3339 format representing the oldest data in the time window.
|
|
1263
1598
|
*/
|
|
1264
|
-
|
|
1599
|
+
startDate: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* Date in RFC 3339 format representing the newest data in the time window.
|
|
1602
|
+
*/
|
|
1603
|
+
endDate: string;
|
|
1265
1604
|
};
|
|
1266
1605
|
|
|
1267
|
-
|
|
1268
|
-
|
|
1269
|
-
|
|
1270
|
-
|
|
1606
|
+
type ListEventsResponse = {
|
|
1607
|
+
events: Event[];
|
|
1608
|
+
pagination: Pagination;
|
|
1609
|
+
window: Window;
|
|
1610
|
+
};
|
|
1271
1611
|
|
|
1272
|
-
type
|
|
1273
|
-
type: SourceType;
|
|
1612
|
+
type BigCommerceChannel = {
|
|
1274
1613
|
/**
|
|
1275
|
-
*
|
|
1614
|
+
* ID of the BigCommerce channel.
|
|
1276
1615
|
*/
|
|
1277
|
-
|
|
1278
|
-
input?: SourceInput;
|
|
1616
|
+
id: number;
|
|
1279
1617
|
/**
|
|
1280
|
-
*
|
|
1618
|
+
* Currencies for the given channel.
|
|
1281
1619
|
*/
|
|
1282
|
-
|
|
1620
|
+
currencies?: string[];
|
|
1283
1621
|
};
|
|
1284
1622
|
|
|
1285
|
-
type
|
|
1286
|
-
/**
|
|
1287
|
-
* Universally uniqud identifier (UUID) of a source.
|
|
1288
|
-
*/
|
|
1289
|
-
sourceID: string;
|
|
1623
|
+
type BigCommerceMetafield = {
|
|
1290
1624
|
/**
|
|
1291
|
-
*
|
|
1625
|
+
* Namespace of the metafield.
|
|
1292
1626
|
*/
|
|
1293
|
-
|
|
1627
|
+
namespace: string;
|
|
1294
1628
|
/**
|
|
1295
|
-
*
|
|
1629
|
+
* Key identifier of the metafield.
|
|
1296
1630
|
*/
|
|
1297
|
-
|
|
1631
|
+
key: string;
|
|
1298
1632
|
};
|
|
1299
1633
|
|
|
1300
|
-
type
|
|
1301
|
-
|
|
1634
|
+
type SourceBigCommerce = {
|
|
1635
|
+
/**
|
|
1636
|
+
* Store hash identifying your BigCommerce store.
|
|
1637
|
+
*/
|
|
1638
|
+
storeHash: string;
|
|
1639
|
+
channel?: BigCommerceChannel;
|
|
1640
|
+
customFields?: string[];
|
|
1641
|
+
productMetafields?: BigCommerceMetafield[];
|
|
1642
|
+
variantMetafields?: BigCommerceMetafield[];
|
|
1302
1643
|
};
|
|
1303
1644
|
|
|
1304
|
-
|
|
1305
|
-
* Property by which to sort the list of sources.
|
|
1306
|
-
*/
|
|
1307
|
-
type SourceSortKeys = 'createdAt' | 'name' | 'type' | 'updatedAt';
|
|
1308
|
-
|
|
1309
|
-
type SourceUpdateCommercetools = {
|
|
1645
|
+
type SourceCommercetools = {
|
|
1310
1646
|
storeKeys?: string[];
|
|
1311
1647
|
/**
|
|
1312
1648
|
* Locales for your commercetools stores.
|
|
1313
1649
|
*/
|
|
1314
1650
|
locales?: string[];
|
|
1315
|
-
url
|
|
1651
|
+
url: string;
|
|
1652
|
+
projectKey: string;
|
|
1316
1653
|
/**
|
|
1317
1654
|
* Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
|
|
1318
1655
|
*/
|
|
@@ -1320,12 +1657,18 @@ type SourceUpdateCommercetools = {
|
|
|
1320
1657
|
customFields?: CommercetoolsCustomFields;
|
|
1321
1658
|
};
|
|
1322
1659
|
|
|
1323
|
-
|
|
1324
|
-
|
|
1660
|
+
/**
|
|
1661
|
+
* Image type.
|
|
1662
|
+
*/
|
|
1663
|
+
type DockerImageType = 'airbyte' | 'custom' | 'singer';
|
|
1664
|
+
|
|
1665
|
+
type SourceDocker = {
|
|
1666
|
+
imageType: DockerImageType;
|
|
1667
|
+
registry: DockerRegistry;
|
|
1325
1668
|
/**
|
|
1326
1669
|
* Docker image name.
|
|
1327
1670
|
*/
|
|
1328
|
-
image
|
|
1671
|
+
image: string;
|
|
1329
1672
|
/**
|
|
1330
1673
|
* Docker image version.
|
|
1331
1674
|
*/
|
|
@@ -1336,106 +1679,49 @@ type SourceUpdateDocker = {
|
|
|
1336
1679
|
configuration: Record<string, unknown>;
|
|
1337
1680
|
};
|
|
1338
1681
|
|
|
1339
|
-
type
|
|
1340
|
-
|
|
1341
|
-
type SourceUpdate = {
|
|
1342
|
-
/**
|
|
1343
|
-
* Descriptive name of the source.
|
|
1344
|
-
*/
|
|
1345
|
-
name?: string;
|
|
1346
|
-
input?: SourceUpdateInput;
|
|
1682
|
+
type SourceShopifyBase = {
|
|
1347
1683
|
/**
|
|
1348
|
-
*
|
|
1684
|
+
* URL of the Shopify store.
|
|
1349
1685
|
*/
|
|
1350
|
-
|
|
1686
|
+
shopURL: string;
|
|
1351
1687
|
};
|
|
1352
1688
|
|
|
1353
|
-
type
|
|
1354
|
-
/**
|
|
1355
|
-
* Universally uniqud identifier (UUID) of a source.
|
|
1356
|
-
*/
|
|
1357
|
-
sourceID: string;
|
|
1358
|
-
/**
|
|
1359
|
-
* Descriptive name of the source.
|
|
1360
|
-
*/
|
|
1361
|
-
name: string;
|
|
1362
|
-
/**
|
|
1363
|
-
* Date of last update in RFC 3339 format.
|
|
1364
|
-
*/
|
|
1365
|
-
updatedAt: string;
|
|
1366
|
-
};
|
|
1689
|
+
type SourceShopify = SourceShopifyBase & SourceUpdateShopify;
|
|
1367
1690
|
|
|
1368
|
-
type
|
|
1369
|
-
/**
|
|
1370
|
-
* Universally unique identifier (UUID) of a task run.
|
|
1371
|
-
*/
|
|
1372
|
-
runID?: string;
|
|
1373
|
-
/**
|
|
1374
|
-
* Depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
|
|
1375
|
-
*/
|
|
1376
|
-
data?: Array<Record<string, unknown>>;
|
|
1377
|
-
/**
|
|
1378
|
-
* In case of error, observability events will be added to the response, if any.
|
|
1379
|
-
*/
|
|
1380
|
-
events?: Event[];
|
|
1381
|
-
/**
|
|
1382
|
-
* A message describing the outcome of a validate run.
|
|
1383
|
-
*/
|
|
1384
|
-
message: string;
|
|
1385
|
-
};
|
|
1691
|
+
type SourceInput = SourceBigCommerce | SourceBigQuery | SourceCommercetools | SourceCSV | SourceDocker | SourceGA4BigQueryExport | SourceJSON | SourceShopify;
|
|
1386
1692
|
|
|
1387
|
-
|
|
1388
|
-
* API request body for creating a task.
|
|
1389
|
-
*/
|
|
1390
|
-
type TaskCreate = {
|
|
1693
|
+
type Source = {
|
|
1391
1694
|
/**
|
|
1392
1695
|
* Universally uniqud identifier (UUID) of a source.
|
|
1393
1696
|
*/
|
|
1394
1697
|
sourceID: string;
|
|
1698
|
+
type: SourceType;
|
|
1699
|
+
name: string;
|
|
1700
|
+
input?: SourceInput;
|
|
1395
1701
|
/**
|
|
1396
|
-
* Universally unique identifier (UUID) of
|
|
1397
|
-
*/
|
|
1398
|
-
destinationID: string;
|
|
1399
|
-
action: ActionType;
|
|
1400
|
-
/**
|
|
1401
|
-
* Cron expression for the task\'s schedule.
|
|
1402
|
-
*/
|
|
1403
|
-
cron?: string;
|
|
1404
|
-
/**
|
|
1405
|
-
* Whether the task is enabled.
|
|
1406
|
-
*/
|
|
1407
|
-
enabled?: boolean;
|
|
1408
|
-
/**
|
|
1409
|
-
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
1410
|
-
*/
|
|
1411
|
-
failureThreshold?: number;
|
|
1412
|
-
input?: TaskInput;
|
|
1413
|
-
/**
|
|
1414
|
-
* Date of the last cursor in RFC 3339 format.
|
|
1415
|
-
*/
|
|
1416
|
-
cursor?: string;
|
|
1417
|
-
};
|
|
1418
|
-
|
|
1419
|
-
/**
|
|
1420
|
-
* API response for creating a task.
|
|
1421
|
-
*/
|
|
1422
|
-
type TaskCreateResponse = {
|
|
1423
|
-
/**
|
|
1424
|
-
* Universally unique identifier (UUID) of a task.
|
|
1702
|
+
* Universally unique identifier (UUID) of an authentication resource.
|
|
1425
1703
|
*/
|
|
1426
|
-
|
|
1704
|
+
authenticationID?: string;
|
|
1427
1705
|
/**
|
|
1428
1706
|
* Date of creation in RFC 3339 format.
|
|
1429
1707
|
*/
|
|
1430
1708
|
createdAt: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* Date of last update in RFC 3339 format.
|
|
1711
|
+
*/
|
|
1712
|
+
updatedAt?: string;
|
|
1431
1713
|
};
|
|
1432
1714
|
|
|
1433
|
-
type
|
|
1715
|
+
type ListSourcesResponse = {
|
|
1716
|
+
sources: Source[];
|
|
1717
|
+
pagination: Pagination;
|
|
1718
|
+
};
|
|
1434
1719
|
|
|
1435
|
-
|
|
1436
|
-
|
|
1437
|
-
|
|
1438
|
-
|
|
1720
|
+
type Task = {
|
|
1721
|
+
/**
|
|
1722
|
+
* Universally unique identifier (UUID) of a task.
|
|
1723
|
+
*/
|
|
1724
|
+
taskID: string;
|
|
1439
1725
|
/**
|
|
1440
1726
|
* Universally uniqud identifier (UUID) of a source.
|
|
1441
1727
|
*/
|
|
@@ -1444,925 +1730,1357 @@ type TaskCreateV1 = {
|
|
|
1444
1730
|
* Universally unique identifier (UUID) of a destination resource.
|
|
1445
1731
|
*/
|
|
1446
1732
|
destinationID: string;
|
|
1447
|
-
|
|
1448
|
-
|
|
1733
|
+
/**
|
|
1734
|
+
* Cron expression for the task\'s schedule.
|
|
1735
|
+
*/
|
|
1736
|
+
cron?: string;
|
|
1737
|
+
/**
|
|
1738
|
+
* The last time the scheduled task ran in RFC 3339 format.
|
|
1739
|
+
*/
|
|
1740
|
+
lastRun?: string;
|
|
1741
|
+
/**
|
|
1742
|
+
* The next scheduled run of the task in RFC 3339 format.
|
|
1743
|
+
*/
|
|
1744
|
+
nextRun?: string;
|
|
1745
|
+
input?: TaskInput;
|
|
1449
1746
|
/**
|
|
1450
1747
|
* Whether the task is enabled.
|
|
1451
1748
|
*/
|
|
1452
|
-
enabled
|
|
1749
|
+
enabled: boolean;
|
|
1453
1750
|
/**
|
|
1454
1751
|
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
1455
1752
|
*/
|
|
1456
1753
|
failureThreshold?: number;
|
|
1457
|
-
|
|
1754
|
+
action: ActionType;
|
|
1458
1755
|
/**
|
|
1459
1756
|
* Date of the last cursor in RFC 3339 format.
|
|
1460
1757
|
*/
|
|
1461
1758
|
cursor?: string;
|
|
1759
|
+
/**
|
|
1760
|
+
* Date of creation in RFC 3339 format.
|
|
1761
|
+
*/
|
|
1762
|
+
createdAt: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* Date of last update in RFC 3339 format.
|
|
1765
|
+
*/
|
|
1766
|
+
updatedAt?: string;
|
|
1462
1767
|
};
|
|
1463
1768
|
|
|
1464
|
-
|
|
1465
|
-
|
|
1769
|
+
/**
|
|
1770
|
+
* Configured tasks and pagination information.
|
|
1771
|
+
*/
|
|
1772
|
+
type ListTasksResponse = {
|
|
1773
|
+
tasks: Task[];
|
|
1774
|
+
pagination: Pagination;
|
|
1466
1775
|
};
|
|
1467
1776
|
|
|
1468
1777
|
/**
|
|
1469
|
-
*
|
|
1778
|
+
* Task is run manually, with the `/run` endpoint.
|
|
1470
1779
|
*/
|
|
1471
|
-
type
|
|
1780
|
+
type OnDemandTriggerType = 'onDemand';
|
|
1472
1781
|
|
|
1473
1782
|
/**
|
|
1474
|
-
*
|
|
1783
|
+
* Trigger information for manually-triggered tasks.
|
|
1475
1784
|
*/
|
|
1476
|
-
type
|
|
1785
|
+
type OnDemandTrigger = {
|
|
1786
|
+
type: OnDemandTriggerType;
|
|
1477
1787
|
/**
|
|
1478
|
-
*
|
|
1788
|
+
* The last time the scheduled task ran in RFC 3339 format.
|
|
1479
1789
|
*/
|
|
1480
|
-
|
|
1790
|
+
lastRun?: string;
|
|
1791
|
+
};
|
|
1792
|
+
|
|
1793
|
+
/**
|
|
1794
|
+
* Task runs on a schedule.
|
|
1795
|
+
*/
|
|
1796
|
+
type ScheduleTriggerType = 'schedule';
|
|
1797
|
+
|
|
1798
|
+
/**
|
|
1799
|
+
* Trigger information for scheduled tasks.
|
|
1800
|
+
*/
|
|
1801
|
+
type ScheduleTrigger = {
|
|
1802
|
+
type: ScheduleTriggerType;
|
|
1481
1803
|
/**
|
|
1482
1804
|
* Cron expression for the task\'s schedule.
|
|
1483
1805
|
*/
|
|
1484
|
-
cron
|
|
1485
|
-
input?: TaskInput;
|
|
1806
|
+
cron: string;
|
|
1486
1807
|
/**
|
|
1487
|
-
*
|
|
1808
|
+
* The last time the scheduled task ran in RFC 3339 format.
|
|
1488
1809
|
*/
|
|
1489
|
-
|
|
1810
|
+
lastRun?: string;
|
|
1490
1811
|
/**
|
|
1491
|
-
*
|
|
1812
|
+
* The next scheduled run of the task in RFC 3339 format.
|
|
1492
1813
|
*/
|
|
1493
|
-
|
|
1814
|
+
nextRun: string;
|
|
1494
1815
|
};
|
|
1495
1816
|
|
|
1496
1817
|
/**
|
|
1497
|
-
*
|
|
1818
|
+
* Task runs continuously.
|
|
1498
1819
|
*/
|
|
1499
|
-
type
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
*/
|
|
1507
|
-
updatedAt: string;
|
|
1820
|
+
type StreamingTriggerType = 'streaming';
|
|
1821
|
+
|
|
1822
|
+
/**
|
|
1823
|
+
* Trigger input for continuously running tasks.
|
|
1824
|
+
*/
|
|
1825
|
+
type StreamingTrigger = {
|
|
1826
|
+
type: StreamingTriggerType;
|
|
1508
1827
|
};
|
|
1509
1828
|
|
|
1510
1829
|
/**
|
|
1511
|
-
*
|
|
1830
|
+
* Task runs after receiving subscribed event.
|
|
1512
1831
|
*/
|
|
1513
|
-
type
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
|
|
1832
|
+
type SubscriptionTriggerType = 'subscription';
|
|
1833
|
+
|
|
1834
|
+
/**
|
|
1835
|
+
* Trigger input for subscription tasks.
|
|
1836
|
+
*/
|
|
1837
|
+
type SubscriptionTrigger = {
|
|
1838
|
+
type: SubscriptionTriggerType;
|
|
1518
1839
|
};
|
|
1519
1840
|
|
|
1520
1841
|
/**
|
|
1521
|
-
*
|
|
1842
|
+
* Trigger that runs the task.
|
|
1522
1843
|
*/
|
|
1523
|
-
type
|
|
1844
|
+
type Trigger = OnDemandTrigger | ScheduleTrigger | StreamingTrigger | SubscriptionTrigger;
|
|
1845
|
+
|
|
1846
|
+
/**
|
|
1847
|
+
* The V1 task object, please use methods and types that don\'t contain the V1 suffix.
|
|
1848
|
+
*/
|
|
1849
|
+
type TaskV1 = {
|
|
1850
|
+
/**
|
|
1851
|
+
* Universally unique identifier (UUID) of a task.
|
|
1852
|
+
*/
|
|
1853
|
+
taskID: string;
|
|
1854
|
+
/**
|
|
1855
|
+
* Universally uniqud identifier (UUID) of a source.
|
|
1856
|
+
*/
|
|
1857
|
+
sourceID: string;
|
|
1524
1858
|
/**
|
|
1525
1859
|
* Universally unique identifier (UUID) of a destination resource.
|
|
1526
1860
|
*/
|
|
1527
|
-
destinationID
|
|
1528
|
-
trigger
|
|
1861
|
+
destinationID: string;
|
|
1862
|
+
trigger: Trigger;
|
|
1529
1863
|
input?: TaskInput;
|
|
1530
1864
|
/**
|
|
1531
1865
|
* Whether the task is enabled.
|
|
1532
1866
|
*/
|
|
1533
|
-
enabled
|
|
1867
|
+
enabled: boolean;
|
|
1534
1868
|
/**
|
|
1535
1869
|
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
1536
1870
|
*/
|
|
1537
1871
|
failureThreshold?: number;
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
/**
|
|
1541
|
-
* API request body for creating a transformation.
|
|
1542
|
-
*/
|
|
1543
|
-
type TransformationCreate = {
|
|
1544
|
-
/**
|
|
1545
|
-
* The source code of the transformation.
|
|
1546
|
-
*/
|
|
1547
|
-
code: string;
|
|
1872
|
+
action: ActionType;
|
|
1548
1873
|
/**
|
|
1549
|
-
*
|
|
1874
|
+
* Date of the last cursor in RFC 3339 format.
|
|
1550
1875
|
*/
|
|
1551
|
-
|
|
1876
|
+
cursor?: string;
|
|
1552
1877
|
/**
|
|
1553
|
-
*
|
|
1878
|
+
* Date of creation in RFC 3339 format.
|
|
1554
1879
|
*/
|
|
1555
|
-
|
|
1880
|
+
createdAt: string;
|
|
1556
1881
|
/**
|
|
1557
|
-
*
|
|
1882
|
+
* Date of last update in RFC 3339 format.
|
|
1558
1883
|
*/
|
|
1559
|
-
|
|
1884
|
+
updatedAt?: string;
|
|
1560
1885
|
};
|
|
1561
1886
|
|
|
1562
1887
|
/**
|
|
1563
|
-
*
|
|
1888
|
+
* Configured tasks and pagination information.
|
|
1564
1889
|
*/
|
|
1565
|
-
type
|
|
1890
|
+
type ListTasksResponseV1 = {
|
|
1891
|
+
tasks: TaskV1[];
|
|
1892
|
+
pagination: Pagination;
|
|
1893
|
+
};
|
|
1894
|
+
|
|
1895
|
+
type Transformation = {
|
|
1566
1896
|
/**
|
|
1567
1897
|
* Universally unique identifier (UUID) of a transformation.
|
|
1568
1898
|
*/
|
|
1569
1899
|
transformationID: string;
|
|
1570
1900
|
/**
|
|
1571
|
-
*
|
|
1901
|
+
* The authentications associated for the current transformation.
|
|
1572
1902
|
*/
|
|
1573
|
-
|
|
1574
|
-
};
|
|
1575
|
-
|
|
1576
|
-
/**
|
|
1577
|
-
* The error if the transformation failed.
|
|
1578
|
-
*/
|
|
1579
|
-
type TransformationError = {
|
|
1903
|
+
authenticationIDs?: string[];
|
|
1580
1904
|
/**
|
|
1581
|
-
* The
|
|
1905
|
+
* The source code of the transformation.
|
|
1582
1906
|
*/
|
|
1583
|
-
code
|
|
1907
|
+
code: string;
|
|
1584
1908
|
/**
|
|
1585
|
-
*
|
|
1909
|
+
* The uniquely identified name of your transformation.
|
|
1586
1910
|
*/
|
|
1587
|
-
|
|
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 = {
|
|
1911
|
+
name: string;
|
|
1602
1912
|
/**
|
|
1603
|
-
*
|
|
1913
|
+
* A descriptive name for your transformation of what it does.
|
|
1604
1914
|
*/
|
|
1605
|
-
|
|
1915
|
+
description?: string;
|
|
1606
1916
|
/**
|
|
1607
|
-
*
|
|
1917
|
+
* Date of creation in RFC 3339 format.
|
|
1608
1918
|
*/
|
|
1609
|
-
|
|
1610
|
-
authentications?: AuthenticationCreate[];
|
|
1611
|
-
};
|
|
1612
|
-
|
|
1613
|
-
type TransformationTryResponse = {
|
|
1919
|
+
createdAt: string;
|
|
1614
1920
|
/**
|
|
1615
|
-
*
|
|
1921
|
+
* Date of last update in RFC 3339 format.
|
|
1616
1922
|
*/
|
|
1617
|
-
|
|
1618
|
-
error?: TransformationError;
|
|
1923
|
+
updatedAt?: string;
|
|
1619
1924
|
};
|
|
1620
1925
|
|
|
1621
1926
|
/**
|
|
1622
|
-
*
|
|
1927
|
+
* Configured transformations and pagination information.
|
|
1623
1928
|
*/
|
|
1624
|
-
type
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
*/
|
|
1628
|
-
transformationID: string;
|
|
1629
|
-
/**
|
|
1630
|
-
* Date of last update in RFC 3339 format.
|
|
1631
|
-
*/
|
|
1632
|
-
updatedAt: string;
|
|
1929
|
+
type ListTransformationsResponse = {
|
|
1930
|
+
transformations: Transformation[];
|
|
1931
|
+
pagination: Pagination;
|
|
1633
1932
|
};
|
|
1634
1933
|
|
|
1635
1934
|
/**
|
|
1636
|
-
* Task
|
|
1935
|
+
* Task run outcome.
|
|
1637
1936
|
*/
|
|
1638
|
-
type
|
|
1937
|
+
type RunOutcome = 'failure' | 'processing' | 'success';
|
|
1938
|
+
|
|
1939
|
+
type RunProgress = {
|
|
1940
|
+
expectedNbOfEvents?: number;
|
|
1941
|
+
receivedNbOfEvents?: number;
|
|
1942
|
+
};
|
|
1639
1943
|
|
|
1640
1944
|
/**
|
|
1641
|
-
*
|
|
1945
|
+
* A code for the task run\'s outcome. A readable description of the code is included in the `reason` response property.
|
|
1642
1946
|
*/
|
|
1643
|
-
type
|
|
1947
|
+
type RunReasonCode = 'blocking' | 'critical' | 'discarded' | 'internal' | 'no_events' | 'ok' | 'too_many_errors';
|
|
1948
|
+
|
|
1949
|
+
type Run = {
|
|
1644
1950
|
/**
|
|
1645
|
-
*
|
|
1951
|
+
* Universally unique identifier (UUID) of a task run.
|
|
1646
1952
|
*/
|
|
1647
|
-
|
|
1953
|
+
runID: string;
|
|
1954
|
+
appID: string;
|
|
1648
1955
|
/**
|
|
1649
|
-
*
|
|
1956
|
+
* Universally unique identifier (UUID) of a task.
|
|
1650
1957
|
*/
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
*/
|
|
1656
|
-
type CustomGetProps = {
|
|
1958
|
+
taskID: string;
|
|
1959
|
+
status: RunStatus;
|
|
1960
|
+
progress?: RunProgress;
|
|
1961
|
+
outcome?: RunOutcome;
|
|
1657
1962
|
/**
|
|
1658
|
-
*
|
|
1963
|
+
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
1659
1964
|
*/
|
|
1660
|
-
|
|
1965
|
+
failureThreshold?: number;
|
|
1661
1966
|
/**
|
|
1662
|
-
*
|
|
1967
|
+
* More information about the task run\'s outcome.
|
|
1663
1968
|
*/
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
* Properties for the `customPost` method.
|
|
1668
|
-
*/
|
|
1669
|
-
type CustomPostProps = {
|
|
1969
|
+
reason?: string;
|
|
1970
|
+
reasonCode?: RunReasonCode;
|
|
1971
|
+
type: RunType;
|
|
1670
1972
|
/**
|
|
1671
|
-
*
|
|
1973
|
+
* Date of creation in RFC 3339 format.
|
|
1672
1974
|
*/
|
|
1673
|
-
|
|
1975
|
+
createdAt: string;
|
|
1674
1976
|
/**
|
|
1675
|
-
*
|
|
1977
|
+
* Date of start in RFC 3339 format.
|
|
1676
1978
|
*/
|
|
1677
|
-
|
|
1979
|
+
startedAt?: string;
|
|
1678
1980
|
/**
|
|
1679
|
-
*
|
|
1981
|
+
* Date of finish in RFC 3339 format.
|
|
1680
1982
|
*/
|
|
1681
|
-
|
|
1983
|
+
finishedAt?: string;
|
|
1984
|
+
};
|
|
1985
|
+
|
|
1986
|
+
type RunListResponse = {
|
|
1987
|
+
runs: Run[];
|
|
1988
|
+
pagination: Pagination;
|
|
1989
|
+
window: Window;
|
|
1682
1990
|
};
|
|
1991
|
+
|
|
1683
1992
|
/**
|
|
1684
|
-
*
|
|
1993
|
+
* API response for running a task.
|
|
1685
1994
|
*/
|
|
1686
|
-
type
|
|
1995
|
+
type RunResponse = {
|
|
1687
1996
|
/**
|
|
1688
|
-
*
|
|
1997
|
+
* Universally unique identifier (UUID) of a task run.
|
|
1689
1998
|
*/
|
|
1690
|
-
|
|
1999
|
+
runID: string;
|
|
1691
2000
|
/**
|
|
1692
|
-
*
|
|
2001
|
+
* Date of creation in RFC 3339 format.
|
|
1693
2002
|
*/
|
|
1694
|
-
|
|
2003
|
+
createdAt: string;
|
|
2004
|
+
};
|
|
2005
|
+
|
|
2006
|
+
type RunSourceResponse = {
|
|
1695
2007
|
/**
|
|
1696
|
-
*
|
|
2008
|
+
* Map of taskID sent for reindex with the corresponding runID.
|
|
1697
2009
|
*/
|
|
1698
|
-
|
|
1699
|
-
};
|
|
1700
|
-
/**
|
|
1701
|
-
* Properties for the `deleteAuthentication` method.
|
|
1702
|
-
*/
|
|
1703
|
-
type DeleteAuthenticationProps = {
|
|
2010
|
+
taskWithRunID: Record<string, string>;
|
|
1704
2011
|
/**
|
|
1705
|
-
*
|
|
2012
|
+
* Date of creation in RFC 3339 format.
|
|
1706
2013
|
*/
|
|
1707
|
-
|
|
2014
|
+
createdAt: string;
|
|
1708
2015
|
};
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
type DeleteDestinationProps = {
|
|
2016
|
+
|
|
2017
|
+
type SourceCreate = {
|
|
2018
|
+
type: SourceType;
|
|
1713
2019
|
/**
|
|
1714
|
-
*
|
|
2020
|
+
* Descriptive name of the source.
|
|
1715
2021
|
*/
|
|
1716
|
-
|
|
2022
|
+
name: string;
|
|
2023
|
+
input?: SourceInput;
|
|
2024
|
+
/**
|
|
2025
|
+
* Universally unique identifier (UUID) of an authentication resource.
|
|
2026
|
+
*/
|
|
2027
|
+
authenticationID?: string;
|
|
1717
2028
|
};
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
*/
|
|
1721
|
-
type DeleteSourceProps = {
|
|
2029
|
+
|
|
2030
|
+
type SourceCreateResponse = {
|
|
1722
2031
|
/**
|
|
1723
|
-
*
|
|
2032
|
+
* Universally uniqud identifier (UUID) of a source.
|
|
1724
2033
|
*/
|
|
1725
2034
|
sourceID: string;
|
|
1726
|
-
};
|
|
1727
|
-
/**
|
|
1728
|
-
* Properties for the `deleteTask` method.
|
|
1729
|
-
*/
|
|
1730
|
-
type DeleteTaskProps = {
|
|
1731
2035
|
/**
|
|
1732
|
-
*
|
|
2036
|
+
* Descriptive name of the source.
|
|
1733
2037
|
*/
|
|
1734
|
-
|
|
1735
|
-
};
|
|
1736
|
-
/**
|
|
1737
|
-
* Properties for the `deleteTaskV1` method.
|
|
1738
|
-
*/
|
|
1739
|
-
type DeleteTaskV1Props = {
|
|
2038
|
+
name: string;
|
|
1740
2039
|
/**
|
|
1741
|
-
*
|
|
2040
|
+
* Date of creation in RFC 3339 format.
|
|
1742
2041
|
*/
|
|
1743
|
-
|
|
2042
|
+
createdAt: string;
|
|
1744
2043
|
};
|
|
1745
|
-
|
|
1746
|
-
|
|
1747
|
-
|
|
1748
|
-
|
|
2044
|
+
|
|
2045
|
+
type SourceSearch = {
|
|
2046
|
+
sourceIDs: string[];
|
|
2047
|
+
};
|
|
2048
|
+
|
|
2049
|
+
type SourceUpdateResponse = {
|
|
1749
2050
|
/**
|
|
1750
|
-
*
|
|
2051
|
+
* Universally uniqud identifier (UUID) of a source.
|
|
1751
2052
|
*/
|
|
1752
|
-
|
|
1753
|
-
};
|
|
1754
|
-
/**
|
|
1755
|
-
* Properties for the `disableTask` method.
|
|
1756
|
-
*/
|
|
1757
|
-
type DisableTaskProps = {
|
|
2053
|
+
sourceID: string;
|
|
1758
2054
|
/**
|
|
1759
|
-
*
|
|
2055
|
+
* Descriptive name of the source.
|
|
1760
2056
|
*/
|
|
1761
|
-
|
|
1762
|
-
};
|
|
1763
|
-
/**
|
|
1764
|
-
* Properties for the `disableTaskV1` method.
|
|
1765
|
-
*/
|
|
1766
|
-
type DisableTaskV1Props = {
|
|
2057
|
+
name: string;
|
|
1767
2058
|
/**
|
|
1768
|
-
*
|
|
2059
|
+
* Date of last update in RFC 3339 format.
|
|
1769
2060
|
*/
|
|
1770
|
-
|
|
2061
|
+
updatedAt: string;
|
|
1771
2062
|
};
|
|
1772
|
-
|
|
1773
|
-
|
|
1774
|
-
*/
|
|
1775
|
-
type EnableTaskProps = {
|
|
2063
|
+
|
|
2064
|
+
type SourceWatchResponse = {
|
|
1776
2065
|
/**
|
|
1777
|
-
*
|
|
2066
|
+
* Universally unique identifier (UUID) of a task run.
|
|
1778
2067
|
*/
|
|
1779
|
-
|
|
1780
|
-
};
|
|
1781
|
-
/**
|
|
1782
|
-
* Properties for the `enableTaskV1` method.
|
|
1783
|
-
*/
|
|
1784
|
-
type EnableTaskV1Props = {
|
|
2068
|
+
runID?: string;
|
|
1785
2069
|
/**
|
|
1786
|
-
*
|
|
2070
|
+
* Depending on the source type, the validation returns sampling data of your source (JSON, CSV, BigQuery).
|
|
1787
2071
|
*/
|
|
1788
|
-
|
|
1789
|
-
};
|
|
1790
|
-
/**
|
|
1791
|
-
* Properties for the `getAuthentication` method.
|
|
1792
|
-
*/
|
|
1793
|
-
type GetAuthenticationProps = {
|
|
2072
|
+
data?: Array<Record<string, unknown>>;
|
|
1794
2073
|
/**
|
|
1795
|
-
*
|
|
2074
|
+
* In case of error, observability events will be added to the response, if any.
|
|
1796
2075
|
*/
|
|
1797
|
-
|
|
2076
|
+
events?: Event[];
|
|
2077
|
+
/**
|
|
2078
|
+
* A message describing the outcome of a validate run.
|
|
2079
|
+
*/
|
|
2080
|
+
message: string;
|
|
1798
2081
|
};
|
|
2082
|
+
|
|
1799
2083
|
/**
|
|
1800
|
-
*
|
|
2084
|
+
* API request body for creating a task.
|
|
1801
2085
|
*/
|
|
1802
|
-
type
|
|
2086
|
+
type TaskCreate = {
|
|
1803
2087
|
/**
|
|
1804
|
-
*
|
|
2088
|
+
* Universally uniqud identifier (UUID) of a source.
|
|
2089
|
+
*/
|
|
2090
|
+
sourceID: string;
|
|
2091
|
+
/**
|
|
2092
|
+
* Universally unique identifier (UUID) of a destination resource.
|
|
1805
2093
|
*/
|
|
1806
2094
|
destinationID: string;
|
|
1807
|
-
|
|
1808
|
-
/**
|
|
1809
|
-
* Properties for the `getEvent` method.
|
|
1810
|
-
*/
|
|
1811
|
-
type GetEventProps = {
|
|
2095
|
+
action: ActionType;
|
|
1812
2096
|
/**
|
|
1813
|
-
*
|
|
2097
|
+
* Cron expression for the task\'s schedule.
|
|
1814
2098
|
*/
|
|
1815
|
-
|
|
2099
|
+
cron?: string;
|
|
1816
2100
|
/**
|
|
1817
|
-
*
|
|
2101
|
+
* Whether the task is enabled.
|
|
1818
2102
|
*/
|
|
1819
|
-
|
|
1820
|
-
};
|
|
1821
|
-
/**
|
|
1822
|
-
* Properties for the `getRun` method.
|
|
1823
|
-
*/
|
|
1824
|
-
type GetRunProps = {
|
|
2103
|
+
enabled?: boolean;
|
|
1825
2104
|
/**
|
|
1826
|
-
*
|
|
2105
|
+
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
1827
2106
|
*/
|
|
1828
|
-
|
|
1829
|
-
|
|
1830
|
-
/**
|
|
1831
|
-
* Properties for the `getSource` method.
|
|
1832
|
-
*/
|
|
1833
|
-
type GetSourceProps = {
|
|
2107
|
+
failureThreshold?: number;
|
|
2108
|
+
input?: TaskInput;
|
|
1834
2109
|
/**
|
|
1835
|
-
*
|
|
2110
|
+
* Date of the last cursor in RFC 3339 format.
|
|
1836
2111
|
*/
|
|
1837
|
-
|
|
2112
|
+
cursor?: string;
|
|
1838
2113
|
};
|
|
2114
|
+
|
|
1839
2115
|
/**
|
|
1840
|
-
*
|
|
2116
|
+
* API response for creating a task.
|
|
1841
2117
|
*/
|
|
1842
|
-
type
|
|
2118
|
+
type TaskCreateResponse = {
|
|
1843
2119
|
/**
|
|
1844
|
-
*
|
|
2120
|
+
* Universally unique identifier (UUID) of a task.
|
|
1845
2121
|
*/
|
|
1846
2122
|
taskID: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* Date of creation in RFC 3339 format.
|
|
2125
|
+
*/
|
|
2126
|
+
createdAt: string;
|
|
1847
2127
|
};
|
|
2128
|
+
|
|
1848
2129
|
/**
|
|
1849
|
-
*
|
|
2130
|
+
* Trigger information for manually-triggered tasks.
|
|
1850
2131
|
*/
|
|
1851
|
-
type
|
|
1852
|
-
|
|
1853
|
-
* Unique identifier of a task.
|
|
1854
|
-
*/
|
|
1855
|
-
taskID: string;
|
|
2132
|
+
type OnDemandTriggerInput = {
|
|
2133
|
+
type: OnDemandTriggerType;
|
|
1856
2134
|
};
|
|
2135
|
+
|
|
1857
2136
|
/**
|
|
1858
|
-
*
|
|
2137
|
+
* Trigger input for scheduled tasks.
|
|
1859
2138
|
*/
|
|
1860
|
-
type
|
|
2139
|
+
type ScheduleTriggerInput = {
|
|
2140
|
+
type: ScheduleTriggerType;
|
|
1861
2141
|
/**
|
|
1862
|
-
*
|
|
2142
|
+
* Cron expression for the task\'s schedule.
|
|
1863
2143
|
*/
|
|
1864
|
-
|
|
2144
|
+
cron: string;
|
|
1865
2145
|
};
|
|
2146
|
+
|
|
2147
|
+
type TaskCreateTrigger = OnDemandTriggerInput | ScheduleTriggerInput | StreamingTrigger | SubscriptionTrigger;
|
|
2148
|
+
|
|
1866
2149
|
/**
|
|
1867
|
-
*
|
|
2150
|
+
* API request body for creating a task using the V1 shape, please use methods and types that don\'t contain the V1 suffix.
|
|
1868
2151
|
*/
|
|
1869
|
-
type
|
|
1870
|
-
/**
|
|
1871
|
-
* Number of items per page.
|
|
1872
|
-
*/
|
|
1873
|
-
itemsPerPage?: number;
|
|
2152
|
+
type TaskCreateV1 = {
|
|
1874
2153
|
/**
|
|
1875
|
-
*
|
|
2154
|
+
* Universally uniqud identifier (UUID) of a source.
|
|
1876
2155
|
*/
|
|
1877
|
-
|
|
2156
|
+
sourceID: string;
|
|
1878
2157
|
/**
|
|
1879
|
-
*
|
|
2158
|
+
* Universally unique identifier (UUID) of a destination resource.
|
|
1880
2159
|
*/
|
|
1881
|
-
|
|
2160
|
+
destinationID: string;
|
|
2161
|
+
trigger: TaskCreateTrigger;
|
|
2162
|
+
action: ActionType;
|
|
1882
2163
|
/**
|
|
1883
|
-
*
|
|
2164
|
+
* Whether the task is enabled.
|
|
1884
2165
|
*/
|
|
1885
|
-
|
|
2166
|
+
enabled?: boolean;
|
|
1886
2167
|
/**
|
|
1887
|
-
*
|
|
2168
|
+
* Maximum accepted percentage of failures for a task run to finish successfully.
|
|
1888
2169
|
*/
|
|
1889
|
-
|
|
2170
|
+
failureThreshold?: number;
|
|
2171
|
+
input?: TaskInput;
|
|
1890
2172
|
/**
|
|
1891
|
-
*
|
|
2173
|
+
* Date of the last cursor in RFC 3339 format.
|
|
1892
2174
|
*/
|
|
1893
|
-
|
|
2175
|
+
cursor?: string;
|
|
2176
|
+
};
|
|
2177
|
+
|
|
2178
|
+
type TaskSearch = {
|
|
2179
|
+
taskIDs: string[];
|
|
1894
2180
|
};
|
|
2181
|
+
|
|
1895
2182
|
/**
|
|
1896
|
-
*
|
|
2183
|
+
* API response for updating a task.
|
|
1897
2184
|
*/
|
|
1898
|
-
type
|
|
1899
|
-
/**
|
|
1900
|
-
* Number of items per page.
|
|
1901
|
-
*/
|
|
1902
|
-
itemsPerPage?: number;
|
|
1903
|
-
/**
|
|
1904
|
-
* Page number of the paginated API response.
|
|
1905
|
-
*/
|
|
1906
|
-
page?: number;
|
|
2185
|
+
type TaskUpdateResponse = {
|
|
1907
2186
|
/**
|
|
1908
|
-
*
|
|
2187
|
+
* Universally unique identifier (UUID) of a task.
|
|
1909
2188
|
*/
|
|
1910
|
-
|
|
2189
|
+
taskID: string;
|
|
1911
2190
|
/**
|
|
1912
|
-
*
|
|
2191
|
+
* Date of last update in RFC 3339 format.
|
|
1913
2192
|
*/
|
|
1914
|
-
|
|
2193
|
+
updatedAt: string;
|
|
2194
|
+
};
|
|
2195
|
+
|
|
2196
|
+
/**
|
|
2197
|
+
* API response for creating a transformation.
|
|
2198
|
+
*/
|
|
2199
|
+
type TransformationCreateResponse = {
|
|
1915
2200
|
/**
|
|
1916
|
-
*
|
|
2201
|
+
* Universally unique identifier (UUID) of a transformation.
|
|
1917
2202
|
*/
|
|
1918
|
-
|
|
2203
|
+
transformationID: string;
|
|
1919
2204
|
/**
|
|
1920
|
-
*
|
|
2205
|
+
* Date of creation in RFC 3339 format.
|
|
1921
2206
|
*/
|
|
1922
|
-
|
|
2207
|
+
createdAt: string;
|
|
2208
|
+
};
|
|
2209
|
+
|
|
2210
|
+
type Model = {
|
|
2211
|
+
fullname: string;
|
|
2212
|
+
modelName: string;
|
|
2213
|
+
systemPrompt: string;
|
|
2214
|
+
id: string;
|
|
2215
|
+
provider: string;
|
|
1923
2216
|
};
|
|
2217
|
+
|
|
1924
2218
|
/**
|
|
1925
|
-
*
|
|
2219
|
+
* List of available AI models for transformation purposes.
|
|
1926
2220
|
*/
|
|
1927
|
-
type
|
|
2221
|
+
type TransformationModels = {
|
|
2222
|
+
llms: Model[];
|
|
2223
|
+
};
|
|
2224
|
+
|
|
2225
|
+
type TransformationSearch = {
|
|
2226
|
+
transformationIDs: string[];
|
|
2227
|
+
};
|
|
2228
|
+
|
|
2229
|
+
/**
|
|
2230
|
+
* The error if the transformation failed.
|
|
2231
|
+
*/
|
|
2232
|
+
type TransformationError = {
|
|
1928
2233
|
/**
|
|
1929
|
-
*
|
|
2234
|
+
* The error status code.
|
|
1930
2235
|
*/
|
|
1931
|
-
|
|
2236
|
+
code?: number;
|
|
1932
2237
|
/**
|
|
1933
|
-
*
|
|
2238
|
+
* A descriptive message explaining the failure.
|
|
1934
2239
|
*/
|
|
1935
|
-
|
|
2240
|
+
message?: string;
|
|
2241
|
+
};
|
|
2242
|
+
|
|
2243
|
+
type TransformationTryResponse = {
|
|
1936
2244
|
/**
|
|
1937
|
-
*
|
|
2245
|
+
* The array of records returned by the transformation service.
|
|
1938
2246
|
*/
|
|
1939
|
-
|
|
2247
|
+
payloads: Array<Record<string, unknown>>;
|
|
2248
|
+
error?: TransformationError;
|
|
2249
|
+
};
|
|
2250
|
+
|
|
2251
|
+
/**
|
|
2252
|
+
* API response for updating a transformation.
|
|
2253
|
+
*/
|
|
2254
|
+
type TransformationUpdateResponse = {
|
|
1940
2255
|
/**
|
|
1941
|
-
*
|
|
2256
|
+
* Universally unique identifier (UUID) of a transformation.
|
|
1942
2257
|
*/
|
|
1943
|
-
|
|
2258
|
+
transformationID: string;
|
|
1944
2259
|
/**
|
|
1945
|
-
*
|
|
2260
|
+
* Date of last update in RFC 3339 format.
|
|
1946
2261
|
*/
|
|
1947
|
-
|
|
2262
|
+
updatedAt: string;
|
|
2263
|
+
};
|
|
2264
|
+
|
|
2265
|
+
declare const apiClientVersion = "1.3.1";
|
|
2266
|
+
declare const REGIONS: readonly ["eu", "us"];
|
|
2267
|
+
type Region = (typeof REGIONS)[number];
|
|
2268
|
+
/**
|
|
2269
|
+
* Guard: Return strongly typed specific OnDemandTrigger for a given Trigger.
|
|
2270
|
+
*
|
|
2271
|
+
* @summary Guard method that returns a strongly typed specific OnDemandTrigger for a given Trigger.
|
|
2272
|
+
* @param trigger - The given Task Trigger.
|
|
2273
|
+
*/
|
|
2274
|
+
declare function isOnDemandTrigger(trigger: TaskCreateTrigger | Trigger): trigger is OnDemandTrigger;
|
|
2275
|
+
/**
|
|
2276
|
+
* Guard: Return strongly typed specific ScheduleTrigger for a given Trigger.
|
|
2277
|
+
*
|
|
2278
|
+
* @summary Guard method that returns a strongly typed specific ScheduleTrigger for a given Trigger.
|
|
2279
|
+
* @param trigger - The given Task Trigger.
|
|
2280
|
+
*/
|
|
2281
|
+
declare function isScheduleTrigger(trigger: TaskCreateTrigger | Trigger): trigger is ScheduleTrigger;
|
|
2282
|
+
/**
|
|
2283
|
+
* Guard: Return strongly typed specific SubscriptionTrigger for a given Trigger.
|
|
2284
|
+
*
|
|
2285
|
+
* @summary Guard method that returns a strongly typed specific SubscriptionTrigger for a given Trigger.
|
|
2286
|
+
* @param trigger - The given Task Trigger.
|
|
2287
|
+
*/
|
|
2288
|
+
declare function isSubscriptionTrigger(trigger: TaskCreateTrigger | Trigger): trigger is SubscriptionTrigger;
|
|
2289
|
+
declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
2290
|
+
region: Region;
|
|
2291
|
+
}): {
|
|
2292
|
+
transporter: _algolia_client_common.Transporter;
|
|
1948
2293
|
/**
|
|
1949
|
-
*
|
|
2294
|
+
* The `appId` currently in use.
|
|
1950
2295
|
*/
|
|
1951
|
-
|
|
2296
|
+
appId: string;
|
|
1952
2297
|
/**
|
|
1953
|
-
*
|
|
2298
|
+
* Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
|
|
1954
2299
|
*/
|
|
1955
|
-
|
|
2300
|
+
clearCache(): Promise<void>;
|
|
1956
2301
|
/**
|
|
1957
|
-
*
|
|
2302
|
+
* Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
|
|
1958
2303
|
*/
|
|
1959
|
-
|
|
2304
|
+
readonly _ua: string;
|
|
1960
2305
|
/**
|
|
1961
|
-
*
|
|
2306
|
+
* Adds a `segment` to the `x-algolia-agent` sent with every requests.
|
|
2307
|
+
*
|
|
2308
|
+
* @param segment - The algolia agent (user-agent) segment to add.
|
|
2309
|
+
* @param version - The version of the agent.
|
|
1962
2310
|
*/
|
|
1963
|
-
|
|
1964
|
-
};
|
|
1965
|
-
/**
|
|
1966
|
-
* Properties for the `listRuns` method.
|
|
1967
|
-
*/
|
|
1968
|
-
type ListRunsProps = {
|
|
2311
|
+
addAlgoliaAgent(segment: string, version?: string): void;
|
|
1969
2312
|
/**
|
|
1970
|
-
*
|
|
2313
|
+
* Helper method to switch the API key used to authenticate the requests.
|
|
2314
|
+
*
|
|
2315
|
+
* @param params - Method params.
|
|
2316
|
+
* @param params.apiKey - The new API Key to use.
|
|
1971
2317
|
*/
|
|
1972
|
-
|
|
2318
|
+
setClientApiKey({ apiKey }: {
|
|
2319
|
+
apiKey: string;
|
|
2320
|
+
}): void;
|
|
1973
2321
|
/**
|
|
1974
|
-
*
|
|
2322
|
+
* Creates a new authentication resource.
|
|
2323
|
+
*
|
|
2324
|
+
* Required API Key ACLs:
|
|
2325
|
+
* - addObject
|
|
2326
|
+
* - deleteIndex
|
|
2327
|
+
* - editSettings.
|
|
2328
|
+
*
|
|
2329
|
+
* @param authenticationCreate -.
|
|
2330
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1975
2331
|
*/
|
|
1976
|
-
|
|
2332
|
+
createAuthentication(authenticationCreate: AuthenticationCreate, requestOptions?: RequestOptions): Promise<AuthenticationCreateResponse>;
|
|
1977
2333
|
/**
|
|
1978
|
-
*
|
|
2334
|
+
* Creates a new destination.
|
|
2335
|
+
*
|
|
2336
|
+
* Required API Key ACLs:
|
|
2337
|
+
* - addObject
|
|
2338
|
+
* - deleteIndex
|
|
2339
|
+
* - editSettings.
|
|
2340
|
+
*
|
|
2341
|
+
* @param destinationCreate -.
|
|
2342
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1979
2343
|
*/
|
|
1980
|
-
|
|
2344
|
+
createDestination(destinationCreate: DestinationCreate, requestOptions?: RequestOptions): Promise<DestinationCreateResponse>;
|
|
1981
2345
|
/**
|
|
1982
|
-
*
|
|
2346
|
+
* Creates a new source.
|
|
2347
|
+
*
|
|
2348
|
+
* Required API Key ACLs:
|
|
2349
|
+
* - addObject
|
|
2350
|
+
* - deleteIndex
|
|
2351
|
+
* - editSettings.
|
|
2352
|
+
*
|
|
2353
|
+
* @param sourceCreate -.
|
|
2354
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1983
2355
|
*/
|
|
1984
|
-
|
|
2356
|
+
createSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions): Promise<SourceCreateResponse>;
|
|
1985
2357
|
/**
|
|
1986
|
-
*
|
|
2358
|
+
* Creates a new task.
|
|
2359
|
+
*
|
|
2360
|
+
* @param taskCreate - Request body for creating a task.
|
|
2361
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1987
2362
|
*/
|
|
1988
|
-
|
|
2363
|
+
createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
|
|
1989
2364
|
/**
|
|
1990
|
-
*
|
|
2365
|
+
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
2366
|
+
*
|
|
2367
|
+
* @param taskCreate - Request body for creating a task.
|
|
2368
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1991
2369
|
*/
|
|
1992
|
-
|
|
2370
|
+
createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
|
|
1993
2371
|
/**
|
|
1994
|
-
*
|
|
2372
|
+
* Creates a new transformation.
|
|
2373
|
+
*
|
|
2374
|
+
* @param transformationCreate - Request body for creating a transformation.
|
|
2375
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1995
2376
|
*/
|
|
1996
|
-
|
|
2377
|
+
createTransformation(transformationCreate: TransformationCreate, requestOptions?: RequestOptions): Promise<TransformationCreateResponse>;
|
|
1997
2378
|
/**
|
|
1998
|
-
*
|
|
2379
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
2380
|
+
*
|
|
2381
|
+
* @param customDelete - The customDelete object.
|
|
2382
|
+
* @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2383
|
+
* @param customDelete.parameters - Query parameters to apply to the current query.
|
|
2384
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
1999
2385
|
*/
|
|
2000
|
-
|
|
2386
|
+
customDelete({ path, parameters }: CustomDeleteProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
2001
2387
|
/**
|
|
2002
|
-
*
|
|
2388
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
2389
|
+
*
|
|
2390
|
+
* @param customGet - The customGet object.
|
|
2391
|
+
* @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2392
|
+
* @param customGet.parameters - Query parameters to apply to the current query.
|
|
2393
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2003
2394
|
*/
|
|
2004
|
-
|
|
2005
|
-
};
|
|
2006
|
-
/**
|
|
2007
|
-
* Properties for the `listSources` method.
|
|
2008
|
-
*/
|
|
2009
|
-
type ListSourcesProps = {
|
|
2395
|
+
customGet({ path, parameters }: CustomGetProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
2010
2396
|
/**
|
|
2011
|
-
*
|
|
2397
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
2398
|
+
*
|
|
2399
|
+
* @param customPost - The customPost object.
|
|
2400
|
+
* @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2401
|
+
* @param customPost.parameters - Query parameters to apply to the current query.
|
|
2402
|
+
* @param customPost.body - Parameters to send with the custom request.
|
|
2403
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2012
2404
|
*/
|
|
2013
|
-
|
|
2405
|
+
customPost({ path, parameters, body }: CustomPostProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
2014
2406
|
/**
|
|
2015
|
-
*
|
|
2407
|
+
* This method allow you to send requests to the Algolia REST API.
|
|
2408
|
+
*
|
|
2409
|
+
* @param customPut - The customPut object.
|
|
2410
|
+
* @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
|
|
2411
|
+
* @param customPut.parameters - Query parameters to apply to the current query.
|
|
2412
|
+
* @param customPut.body - Parameters to send with the custom request.
|
|
2413
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2016
2414
|
*/
|
|
2017
|
-
|
|
2415
|
+
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, unknown>>;
|
|
2018
2416
|
/**
|
|
2019
|
-
*
|
|
2417
|
+
* Deletes an authentication resource. You can\'t delete authentication resources that are used by a source or a destination.
|
|
2418
|
+
*
|
|
2419
|
+
* Required API Key ACLs:
|
|
2420
|
+
* - addObject
|
|
2421
|
+
* - deleteIndex
|
|
2422
|
+
* - editSettings.
|
|
2423
|
+
*
|
|
2424
|
+
* @param deleteAuthentication - The deleteAuthentication object.
|
|
2425
|
+
* @param deleteAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
2426
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2020
2427
|
*/
|
|
2021
|
-
|
|
2428
|
+
deleteAuthentication({ authenticationID }: DeleteAuthenticationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
2022
2429
|
/**
|
|
2023
|
-
*
|
|
2430
|
+
* Deletes a destination by its ID. You can\'t delete destinations that are referenced in tasks.
|
|
2431
|
+
*
|
|
2432
|
+
* Required API Key ACLs:
|
|
2433
|
+
* - addObject
|
|
2434
|
+
* - deleteIndex
|
|
2435
|
+
* - editSettings.
|
|
2436
|
+
*
|
|
2437
|
+
* @param deleteDestination - The deleteDestination object.
|
|
2438
|
+
* @param deleteDestination.destinationID - Unique identifier of a destination.
|
|
2439
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2024
2440
|
*/
|
|
2025
|
-
|
|
2441
|
+
deleteDestination({ destinationID }: DeleteDestinationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
2026
2442
|
/**
|
|
2027
|
-
*
|
|
2443
|
+
* Deletes a source by its ID. You can\'t delete sources that are referenced in tasks.
|
|
2444
|
+
*
|
|
2445
|
+
* Required API Key ACLs:
|
|
2446
|
+
* - addObject
|
|
2447
|
+
* - deleteIndex
|
|
2448
|
+
* - editSettings.
|
|
2449
|
+
*
|
|
2450
|
+
* @param deleteSource - The deleteSource object.
|
|
2451
|
+
* @param deleteSource.sourceID - Unique identifier of a source.
|
|
2452
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2028
2453
|
*/
|
|
2029
|
-
|
|
2454
|
+
deleteSource({ sourceID }: DeleteSourceProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
2030
2455
|
/**
|
|
2031
|
-
*
|
|
2456
|
+
* Deletes a task by its ID.
|
|
2457
|
+
*
|
|
2458
|
+
* @param deleteTask - The deleteTask object.
|
|
2459
|
+
* @param deleteTask.taskID - Unique identifier of a task.
|
|
2460
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2032
2461
|
*/
|
|
2033
|
-
|
|
2034
|
-
};
|
|
2035
|
-
/**
|
|
2036
|
-
* Properties for the `listTasks` method.
|
|
2037
|
-
*/
|
|
2038
|
-
type ListTasksProps = {
|
|
2462
|
+
deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
2039
2463
|
/**
|
|
2040
|
-
*
|
|
2464
|
+
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
2465
|
+
*
|
|
2466
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
2467
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
2468
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2041
2469
|
*/
|
|
2042
|
-
|
|
2470
|
+
deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
2043
2471
|
/**
|
|
2044
|
-
*
|
|
2472
|
+
* Deletes a transformation by its ID.
|
|
2473
|
+
*
|
|
2474
|
+
* @param deleteTransformation - The deleteTransformation object.
|
|
2475
|
+
* @param deleteTransformation.transformationID - Unique identifier of a transformation.
|
|
2476
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2045
2477
|
*/
|
|
2046
|
-
|
|
2478
|
+
deleteTransformation({ transformationID }: DeleteTransformationProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
2047
2479
|
/**
|
|
2048
|
-
*
|
|
2480
|
+
* Disables a task.
|
|
2481
|
+
*
|
|
2482
|
+
* Required API Key ACLs:
|
|
2483
|
+
* - addObject
|
|
2484
|
+
* - deleteIndex
|
|
2485
|
+
* - editSettings.
|
|
2486
|
+
*
|
|
2487
|
+
* @param disableTask - The disableTask object.
|
|
2488
|
+
* @param disableTask.taskID - Unique identifier of a task.
|
|
2489
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2049
2490
|
*/
|
|
2050
|
-
|
|
2491
|
+
disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2051
2492
|
/**
|
|
2052
|
-
*
|
|
2493
|
+
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
2494
|
+
*
|
|
2495
|
+
* Required API Key ACLs:
|
|
2496
|
+
* - addObject
|
|
2497
|
+
* - deleteIndex
|
|
2498
|
+
* - editSettings.
|
|
2499
|
+
*
|
|
2500
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
2501
|
+
* @param disableTaskV1.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.
|
|
2053
2503
|
*/
|
|
2054
|
-
|
|
2504
|
+
disableTaskV1({ taskID }: DisableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2055
2505
|
/**
|
|
2056
|
-
*
|
|
2506
|
+
* Enables a task.
|
|
2507
|
+
*
|
|
2508
|
+
* Required API Key ACLs:
|
|
2509
|
+
* - addObject
|
|
2510
|
+
* - deleteIndex
|
|
2511
|
+
* - editSettings.
|
|
2512
|
+
*
|
|
2513
|
+
* @param enableTask - The enableTask object.
|
|
2514
|
+
* @param enableTask.taskID - Unique identifier of a task.
|
|
2515
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2516
|
+
*/
|
|
2517
|
+
enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2518
|
+
/**
|
|
2519
|
+
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
2520
|
+
*
|
|
2521
|
+
* Required API Key ACLs:
|
|
2522
|
+
* - addObject
|
|
2523
|
+
* - deleteIndex
|
|
2524
|
+
* - editSettings.
|
|
2525
|
+
*
|
|
2526
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
2527
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
2528
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2057
2529
|
*/
|
|
2058
|
-
|
|
2530
|
+
enableTaskV1({ taskID }: EnableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2059
2531
|
/**
|
|
2060
|
-
*
|
|
2532
|
+
* Generates code for the selected model based on the given prompt.
|
|
2533
|
+
*
|
|
2534
|
+
* Required API Key ACLs:
|
|
2535
|
+
* - addObject
|
|
2536
|
+
* - deleteIndex
|
|
2537
|
+
* - editSettings.
|
|
2538
|
+
*
|
|
2539
|
+
* @param generateTransformationCodePayload - The generateTransformationCodePayload object.
|
|
2540
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2061
2541
|
*/
|
|
2062
|
-
|
|
2542
|
+
generateTransformationCode(generateTransformationCodePayload: GenerateTransformationCodePayload, requestOptions?: RequestOptions): Promise<GenerateTransformationCodeResponse>;
|
|
2063
2543
|
/**
|
|
2064
|
-
*
|
|
2544
|
+
* Retrieves an authentication resource by its ID.
|
|
2545
|
+
*
|
|
2546
|
+
* Required API Key ACLs:
|
|
2547
|
+
* - addObject
|
|
2548
|
+
* - deleteIndex
|
|
2549
|
+
* - editSettings.
|
|
2550
|
+
*
|
|
2551
|
+
* @param getAuthentication - The getAuthentication object.
|
|
2552
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
2553
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2065
2554
|
*/
|
|
2066
|
-
|
|
2555
|
+
getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<Authentication>;
|
|
2067
2556
|
/**
|
|
2068
|
-
*
|
|
2557
|
+
* Retrieves a destination by its ID.
|
|
2558
|
+
*
|
|
2559
|
+
* Required API Key ACLs:
|
|
2560
|
+
* - addObject
|
|
2561
|
+
* - deleteIndex
|
|
2562
|
+
* - editSettings.
|
|
2563
|
+
*
|
|
2564
|
+
* @param getDestination - The getDestination object.
|
|
2565
|
+
* @param getDestination.destinationID - Unique identifier of a destination.
|
|
2566
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2069
2567
|
*/
|
|
2070
|
-
|
|
2568
|
+
getDestination({ destinationID }: GetDestinationProps, requestOptions?: RequestOptions): Promise<Destination>;
|
|
2071
2569
|
/**
|
|
2072
|
-
*
|
|
2570
|
+
* Retrieves a single task run event by its ID.
|
|
2571
|
+
*
|
|
2572
|
+
* Required API Key ACLs:
|
|
2573
|
+
* - addObject
|
|
2574
|
+
* - deleteIndex
|
|
2575
|
+
* - editSettings.
|
|
2576
|
+
*
|
|
2577
|
+
* @param getEvent - The getEvent object.
|
|
2578
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
2579
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
2580
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2073
2581
|
*/
|
|
2074
|
-
|
|
2075
|
-
};
|
|
2076
|
-
/**
|
|
2077
|
-
* Properties for the `listTasksV1` method.
|
|
2078
|
-
*/
|
|
2079
|
-
type ListTasksV1Props = {
|
|
2582
|
+
getEvent({ runID, eventID }: GetEventProps, requestOptions?: RequestOptions): Promise<Event>;
|
|
2080
2583
|
/**
|
|
2081
|
-
*
|
|
2584
|
+
* Retrieve a single task run by its ID.
|
|
2585
|
+
*
|
|
2586
|
+
* Required API Key ACLs:
|
|
2587
|
+
* - addObject
|
|
2588
|
+
* - deleteIndex
|
|
2589
|
+
* - editSettings.
|
|
2590
|
+
*
|
|
2591
|
+
* @param getRun - The getRun object.
|
|
2592
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
2593
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2082
2594
|
*/
|
|
2083
|
-
|
|
2595
|
+
getRun({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<Run>;
|
|
2084
2596
|
/**
|
|
2085
|
-
*
|
|
2597
|
+
* Retrieve a source by its ID.
|
|
2598
|
+
*
|
|
2599
|
+
* Required API Key ACLs:
|
|
2600
|
+
* - addObject
|
|
2601
|
+
* - deleteIndex
|
|
2602
|
+
* - editSettings.
|
|
2603
|
+
*
|
|
2604
|
+
* @param getSource - The getSource object.
|
|
2605
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
2606
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2086
2607
|
*/
|
|
2087
|
-
|
|
2608
|
+
getSource({ sourceID }: GetSourceProps, requestOptions?: RequestOptions): Promise<Source>;
|
|
2088
2609
|
/**
|
|
2089
|
-
*
|
|
2610
|
+
* Retrieves a task by its ID.
|
|
2611
|
+
*
|
|
2612
|
+
* Required API Key ACLs:
|
|
2613
|
+
* - addObject
|
|
2614
|
+
* - deleteIndex
|
|
2615
|
+
* - editSettings.
|
|
2616
|
+
*
|
|
2617
|
+
* @param getTask - The getTask object.
|
|
2618
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
2619
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2090
2620
|
*/
|
|
2091
|
-
|
|
2621
|
+
getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
|
|
2092
2622
|
/**
|
|
2093
|
-
*
|
|
2623
|
+
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
2624
|
+
*
|
|
2625
|
+
* Required API Key ACLs:
|
|
2626
|
+
* - addObject
|
|
2627
|
+
* - deleteIndex
|
|
2628
|
+
* - editSettings.
|
|
2629
|
+
*
|
|
2630
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
2631
|
+
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
2632
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2094
2633
|
*/
|
|
2095
|
-
|
|
2634
|
+
getTaskV1({ taskID }: GetTaskV1Props, requestOptions?: RequestOptions): Promise<TaskV1>;
|
|
2096
2635
|
/**
|
|
2097
|
-
*
|
|
2636
|
+
* Retrieves a transformation by its ID.
|
|
2637
|
+
*
|
|
2638
|
+
* Required API Key ACLs:
|
|
2639
|
+
* - addObject
|
|
2640
|
+
* - deleteIndex
|
|
2641
|
+
* - editSettings.
|
|
2642
|
+
*
|
|
2643
|
+
* @param getTransformation - The getTransformation object.
|
|
2644
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
2645
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2098
2646
|
*/
|
|
2099
|
-
|
|
2647
|
+
getTransformation({ transformationID }: GetTransformationProps, requestOptions?: RequestOptions): Promise<Transformation>;
|
|
2100
2648
|
/**
|
|
2101
|
-
*
|
|
2649
|
+
* Retrieves a list of all authentication resources.
|
|
2650
|
+
*
|
|
2651
|
+
* Required API Key ACLs:
|
|
2652
|
+
* - addObject
|
|
2653
|
+
* - deleteIndex
|
|
2654
|
+
* - editSettings.
|
|
2655
|
+
*
|
|
2656
|
+
* @param listAuthentications - The listAuthentications object.
|
|
2657
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
2658
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
2659
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
2660
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
|
|
2661
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentication resources.
|
|
2662
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
2663
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2664
|
+
*/
|
|
2665
|
+
listAuthentications({ itemsPerPage, page, type, platform, sort, order }?: ListAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
|
|
2666
|
+
/**
|
|
2667
|
+
* Retrieves a list of destinations.
|
|
2668
|
+
*
|
|
2669
|
+
* Required API Key ACLs:
|
|
2670
|
+
* - addObject
|
|
2671
|
+
* - deleteIndex
|
|
2672
|
+
* - editSettings.
|
|
2673
|
+
*
|
|
2674
|
+
* @param listDestinations - The listDestinations object.
|
|
2675
|
+
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
2676
|
+
* @param listDestinations.page - Page number of the paginated API response.
|
|
2677
|
+
* @param listDestinations.type - Destination type.
|
|
2678
|
+
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
2679
|
+
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
2680
|
+
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
2681
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2682
|
+
*/
|
|
2683
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, sort, order }?: ListDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
|
|
2684
|
+
/**
|
|
2685
|
+
* Retrieves a list of events for a task run, identified by it\'s ID.
|
|
2686
|
+
*
|
|
2687
|
+
* Required API Key ACLs:
|
|
2688
|
+
* - addObject
|
|
2689
|
+
* - deleteIndex
|
|
2690
|
+
* - editSettings.
|
|
2691
|
+
*
|
|
2692
|
+
* @param listEvents - The listEvents object.
|
|
2693
|
+
* @param listEvents.runID - Unique identifier of a task run.
|
|
2694
|
+
* @param listEvents.itemsPerPage - Number of items per page.
|
|
2695
|
+
* @param listEvents.page - Page number of the paginated API response.
|
|
2696
|
+
* @param listEvents.status - Event status for filtering the list of task runs.
|
|
2697
|
+
* @param listEvents.type - Event type for filtering the list of task runs.
|
|
2698
|
+
* @param listEvents.sort - Property by which to sort the list of task run events.
|
|
2699
|
+
* @param listEvents.order - Sort order of the response, ascending or descending.
|
|
2700
|
+
* @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.
|
|
2701
|
+
* @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
2702
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2703
|
+
*/
|
|
2704
|
+
listEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate }: ListEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
|
|
2705
|
+
/**
|
|
2706
|
+
* Retrieve a list of task runs.
|
|
2707
|
+
*
|
|
2708
|
+
* Required API Key ACLs:
|
|
2709
|
+
* - addObject
|
|
2710
|
+
* - deleteIndex
|
|
2711
|
+
* - editSettings.
|
|
2712
|
+
*
|
|
2713
|
+
* @param listRuns - The listRuns object.
|
|
2714
|
+
* @param listRuns.itemsPerPage - Number of items per page.
|
|
2715
|
+
* @param listRuns.page - Page number of the paginated API response.
|
|
2716
|
+
* @param listRuns.status - Run status for filtering the list of task runs.
|
|
2717
|
+
* @param listRuns.type - Run type for filtering the list of task runs.
|
|
2718
|
+
* @param listRuns.taskID - Task ID for filtering the list of task runs.
|
|
2719
|
+
* @param listRuns.sort - Property by which to sort the list of task runs.
|
|
2720
|
+
* @param listRuns.order - Sort order of the response, ascending or descending.
|
|
2721
|
+
* @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
|
|
2722
|
+
* @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
|
|
2723
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2724
|
+
*/
|
|
2725
|
+
listRuns({ itemsPerPage, page, status, type, taskID, sort, order, startDate, endDate }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
|
|
2726
|
+
/**
|
|
2727
|
+
* Retrieves a list of sources.
|
|
2728
|
+
*
|
|
2729
|
+
* Required API Key ACLs:
|
|
2730
|
+
* - addObject
|
|
2731
|
+
* - deleteIndex
|
|
2732
|
+
* - editSettings.
|
|
2733
|
+
*
|
|
2734
|
+
* @param listSources - The listSources object.
|
|
2735
|
+
* @param listSources.itemsPerPage - Number of items per page.
|
|
2736
|
+
* @param listSources.page - Page number of the paginated API response.
|
|
2737
|
+
* @param listSources.type - Source type. Some sources require authentication.
|
|
2738
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
|
|
2739
|
+
* @param listSources.sort - Property by which to sort the list of sources.
|
|
2740
|
+
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
2741
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2742
|
+
*/
|
|
2743
|
+
listSources({ itemsPerPage, page, type, authenticationID, sort, order }?: ListSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
|
|
2744
|
+
/**
|
|
2745
|
+
* Retrieves a list of tasks.
|
|
2746
|
+
*
|
|
2747
|
+
* Required API Key ACLs:
|
|
2748
|
+
* - addObject
|
|
2749
|
+
* - deleteIndex
|
|
2750
|
+
* - editSettings.
|
|
2751
|
+
*
|
|
2752
|
+
* @param listTasks - The listTasks object.
|
|
2753
|
+
* @param listTasks.itemsPerPage - Number of items per page.
|
|
2754
|
+
* @param listTasks.page - Page number of the paginated API response.
|
|
2755
|
+
* @param listTasks.action - Actions for filtering the list of tasks.
|
|
2756
|
+
* @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2757
|
+
* @param listTasks.sourceID - Source IDs for filtering the list of tasks.
|
|
2758
|
+
* @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
|
|
2759
|
+
* @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2760
|
+
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
2761
|
+
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
2762
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2763
|
+
*/
|
|
2764
|
+
listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
|
|
2765
|
+
/**
|
|
2766
|
+
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
2767
|
+
*
|
|
2768
|
+
* Required API Key ACLs:
|
|
2769
|
+
* - addObject
|
|
2770
|
+
* - deleteIndex
|
|
2771
|
+
* - editSettings.
|
|
2772
|
+
*
|
|
2773
|
+
* @param listTasksV1 - The listTasksV1 object.
|
|
2774
|
+
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
2775
|
+
* @param listTasksV1.page - Page number of the paginated API response.
|
|
2776
|
+
* @param listTasksV1.action - Actions for filtering the list of tasks.
|
|
2777
|
+
* @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
2778
|
+
* @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
|
|
2779
|
+
* @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
|
|
2780
|
+
* @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
|
|
2781
|
+
* @param listTasksV1.sort - Property by which to sort the list of tasks.
|
|
2782
|
+
* @param listTasksV1.order - Sort order of the response, ascending or descending.
|
|
2783
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2784
|
+
*/
|
|
2785
|
+
listTasksV1({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order }?: ListTasksV1Props, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponseV1>;
|
|
2786
|
+
/**
|
|
2787
|
+
* Retrieves a list of existing LLM transformation helpers.
|
|
2788
|
+
*
|
|
2789
|
+
* Required API Key ACLs:
|
|
2790
|
+
* - addObject
|
|
2791
|
+
* - deleteIndex
|
|
2792
|
+
* - editSettings.
|
|
2793
|
+
*
|
|
2794
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2102
2795
|
*/
|
|
2103
|
-
|
|
2796
|
+
listTransformationModels(requestOptions?: RequestOptions): Promise<TransformationModels>;
|
|
2104
2797
|
/**
|
|
2105
|
-
*
|
|
2798
|
+
* Retrieves a list of transformations.
|
|
2799
|
+
*
|
|
2800
|
+
* Required API Key ACLs:
|
|
2801
|
+
* - addObject
|
|
2802
|
+
* - deleteIndex
|
|
2803
|
+
* - editSettings.
|
|
2804
|
+
*
|
|
2805
|
+
* @param listTransformations - The listTransformations object.
|
|
2806
|
+
* @param listTransformations.itemsPerPage - Number of items per page.
|
|
2807
|
+
* @param listTransformations.page - Page number of the paginated API response.
|
|
2808
|
+
* @param listTransformations.sort - Property by which to sort the list.
|
|
2809
|
+
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
2810
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2106
2811
|
*/
|
|
2107
|
-
|
|
2812
|
+
listTransformations({ itemsPerPage, page, sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
|
|
2108
2813
|
/**
|
|
2109
|
-
*
|
|
2814
|
+
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
2815
|
+
*
|
|
2816
|
+
* Required API Key ACLs:
|
|
2817
|
+
* - addObject
|
|
2818
|
+
* - deleteIndex
|
|
2819
|
+
* - editSettings.
|
|
2820
|
+
*
|
|
2821
|
+
* @param pushTask - The pushTask object.
|
|
2822
|
+
* @param pushTask.taskID - Unique identifier of a task.
|
|
2823
|
+
* @param pushTask.pushTaskPayload - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
2824
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2110
2825
|
*/
|
|
2111
|
-
|
|
2826
|
+
pushTask({ taskID, pushTaskPayload }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
|
|
2112
2827
|
/**
|
|
2113
|
-
*
|
|
2828
|
+
* Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
|
|
2829
|
+
*
|
|
2830
|
+
* Required API Key ACLs:
|
|
2831
|
+
* - addObject
|
|
2832
|
+
* - deleteIndex
|
|
2833
|
+
* - editSettings.
|
|
2834
|
+
*
|
|
2835
|
+
* @param runSource - The runSource object.
|
|
2836
|
+
* @param runSource.sourceID - Unique identifier of a source.
|
|
2837
|
+
* @param runSource.runSourcePayload -.
|
|
2838
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2114
2839
|
*/
|
|
2115
|
-
|
|
2116
|
-
};
|
|
2117
|
-
/**
|
|
2118
|
-
* Properties for the `listTransformations` method.
|
|
2119
|
-
*/
|
|
2120
|
-
type ListTransformationsProps = {
|
|
2840
|
+
runSource({ sourceID, runSourcePayload }: RunSourceProps, requestOptions?: RequestOptions): Promise<RunSourceResponse>;
|
|
2121
2841
|
/**
|
|
2122
|
-
*
|
|
2842
|
+
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
2843
|
+
*
|
|
2844
|
+
* Required API Key ACLs:
|
|
2845
|
+
* - addObject
|
|
2846
|
+
* - deleteIndex
|
|
2847
|
+
* - editSettings.
|
|
2848
|
+
*
|
|
2849
|
+
* @param runTask - The runTask object.
|
|
2850
|
+
* @param runTask.taskID - Unique identifier of a task.
|
|
2851
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2123
2852
|
*/
|
|
2124
|
-
|
|
2853
|
+
runTask({ taskID }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
|
|
2125
2854
|
/**
|
|
2126
|
-
*
|
|
2855
|
+
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
2856
|
+
*
|
|
2857
|
+
* Required API Key ACLs:
|
|
2858
|
+
* - addObject
|
|
2859
|
+
* - deleteIndex
|
|
2860
|
+
* - editSettings.
|
|
2861
|
+
*
|
|
2862
|
+
* @param runTaskV1 - The runTaskV1 object.
|
|
2863
|
+
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
2864
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2127
2865
|
*/
|
|
2128
|
-
|
|
2866
|
+
runTaskV1({ taskID }: RunTaskV1Props, requestOptions?: RequestOptions): Promise<RunResponse>;
|
|
2129
2867
|
/**
|
|
2130
|
-
*
|
|
2868
|
+
* Searches for authentication resources.
|
|
2869
|
+
*
|
|
2870
|
+
* Required API Key ACLs:
|
|
2871
|
+
* - addObject
|
|
2872
|
+
* - deleteIndex
|
|
2873
|
+
* - editSettings.
|
|
2874
|
+
*
|
|
2875
|
+
* @param authenticationSearch - The authenticationSearch object.
|
|
2876
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2131
2877
|
*/
|
|
2132
|
-
|
|
2878
|
+
searchAuthentications(authenticationSearch: AuthenticationSearch, requestOptions?: RequestOptions): Promise<Authentication[]>;
|
|
2133
2879
|
/**
|
|
2134
|
-
*
|
|
2880
|
+
* Searches for destinations.
|
|
2881
|
+
*
|
|
2882
|
+
* Required API Key ACLs:
|
|
2883
|
+
* - addObject
|
|
2884
|
+
* - deleteIndex
|
|
2885
|
+
* - editSettings.
|
|
2886
|
+
*
|
|
2887
|
+
* @param destinationSearch - The destinationSearch object.
|
|
2888
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2135
2889
|
*/
|
|
2136
|
-
|
|
2137
|
-
};
|
|
2138
|
-
/**
|
|
2139
|
-
* Properties for the `pushTask` method.
|
|
2140
|
-
*/
|
|
2141
|
-
type PushTaskProps = {
|
|
2890
|
+
searchDestinations(destinationSearch: DestinationSearch, requestOptions?: RequestOptions): Promise<Destination[]>;
|
|
2142
2891
|
/**
|
|
2143
|
-
*
|
|
2892
|
+
* Searches for sources.
|
|
2893
|
+
*
|
|
2894
|
+
* Required API Key ACLs:
|
|
2895
|
+
* - addObject
|
|
2896
|
+
* - deleteIndex
|
|
2897
|
+
* - editSettings.
|
|
2898
|
+
*
|
|
2899
|
+
* @param sourceSearch - The sourceSearch object.
|
|
2900
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2144
2901
|
*/
|
|
2145
|
-
|
|
2902
|
+
searchSources(sourceSearch: SourceSearch, requestOptions?: RequestOptions): Promise<Source[]>;
|
|
2146
2903
|
/**
|
|
2147
|
-
*
|
|
2904
|
+
* Searches for tasks.
|
|
2905
|
+
*
|
|
2906
|
+
* Required API Key ACLs:
|
|
2907
|
+
* - addObject
|
|
2908
|
+
* - deleteIndex
|
|
2909
|
+
* - editSettings.
|
|
2910
|
+
*
|
|
2911
|
+
* @param taskSearch - The taskSearch object.
|
|
2912
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2148
2913
|
*/
|
|
2149
|
-
|
|
2150
|
-
};
|
|
2151
|
-
/**
|
|
2152
|
-
* Properties for the `runSource` method.
|
|
2153
|
-
*/
|
|
2154
|
-
type RunSourceProps = {
|
|
2914
|
+
searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Task[]>;
|
|
2155
2915
|
/**
|
|
2156
|
-
*
|
|
2916
|
+
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
2917
|
+
*
|
|
2918
|
+
* Required API Key ACLs:
|
|
2919
|
+
* - addObject
|
|
2920
|
+
* - deleteIndex
|
|
2921
|
+
* - editSettings.
|
|
2922
|
+
*
|
|
2923
|
+
* @param taskSearch - The taskSearch object.
|
|
2924
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2157
2925
|
*/
|
|
2158
|
-
|
|
2926
|
+
searchTasksV1(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<TaskV1[]>;
|
|
2159
2927
|
/**
|
|
2928
|
+
* Searches for transformations.
|
|
2160
2929
|
*
|
|
2930
|
+
* Required API Key ACLs:
|
|
2931
|
+
* - addObject
|
|
2932
|
+
* - deleteIndex
|
|
2933
|
+
* - editSettings.
|
|
2934
|
+
*
|
|
2935
|
+
* @param transformationSearch - The transformationSearch object.
|
|
2936
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2161
2937
|
*/
|
|
2162
|
-
|
|
2163
|
-
};
|
|
2164
|
-
/**
|
|
2165
|
-
* Properties for the `runTask` method.
|
|
2166
|
-
*/
|
|
2167
|
-
type RunTaskProps = {
|
|
2938
|
+
searchTransformations(transformationSearch: TransformationSearch, requestOptions?: RequestOptions): Promise<Transformation[]>;
|
|
2168
2939
|
/**
|
|
2169
|
-
*
|
|
2940
|
+
* Triggers a stream-listing request for a source. Triggering stream-listing requests only works with sources with `type: docker` and `imageType: singer`.
|
|
2941
|
+
*
|
|
2942
|
+
* Required API Key ACLs:
|
|
2943
|
+
* - addObject
|
|
2944
|
+
* - deleteIndex
|
|
2945
|
+
* - editSettings.
|
|
2946
|
+
*
|
|
2947
|
+
* @param triggerDockerSourceDiscover - The triggerDockerSourceDiscover object.
|
|
2948
|
+
* @param triggerDockerSourceDiscover.sourceID - Unique identifier of a source.
|
|
2949
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2170
2950
|
*/
|
|
2171
|
-
|
|
2172
|
-
};
|
|
2173
|
-
/**
|
|
2174
|
-
* Properties for the `runTaskV1` method.
|
|
2175
|
-
*/
|
|
2176
|
-
type RunTaskV1Props = {
|
|
2951
|
+
triggerDockerSourceDiscover({ sourceID }: TriggerDockerSourceDiscoverProps, requestOptions?: RequestOptions): Promise<SourceWatchResponse>;
|
|
2177
2952
|
/**
|
|
2178
|
-
*
|
|
2953
|
+
* Try a transformation before creating it.
|
|
2954
|
+
*
|
|
2955
|
+
* Required API Key ACLs:
|
|
2956
|
+
* - addObject
|
|
2957
|
+
* - deleteIndex
|
|
2958
|
+
* - editSettings.
|
|
2959
|
+
*
|
|
2960
|
+
* @param transformationTry - The transformationTry object.
|
|
2961
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2179
2962
|
*/
|
|
2180
|
-
|
|
2181
|
-
};
|
|
2182
|
-
/**
|
|
2183
|
-
* Properties for the `triggerDockerSourceDiscover` method.
|
|
2184
|
-
*/
|
|
2185
|
-
type TriggerDockerSourceDiscoverProps = {
|
|
2963
|
+
tryTransformation(transformationTry: TransformationTry, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
|
|
2186
2964
|
/**
|
|
2187
|
-
*
|
|
2965
|
+
* Try a transformation before updating it.
|
|
2966
|
+
*
|
|
2967
|
+
* Required API Key ACLs:
|
|
2968
|
+
* - addObject
|
|
2969
|
+
* - deleteIndex
|
|
2970
|
+
* - editSettings.
|
|
2971
|
+
*
|
|
2972
|
+
* @param tryTransformationBeforeUpdate - The tryTransformationBeforeUpdate object.
|
|
2973
|
+
* @param tryTransformationBeforeUpdate.transformationID - Unique identifier of a transformation.
|
|
2974
|
+
* @param tryTransformationBeforeUpdate.transformationTry - The transformationTry object.
|
|
2975
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2188
2976
|
*/
|
|
2189
|
-
|
|
2190
|
-
};
|
|
2191
|
-
/**
|
|
2192
|
-
* Properties for the `tryTransformationBeforeUpdate` method.
|
|
2193
|
-
*/
|
|
2194
|
-
type TryTransformationBeforeUpdateProps = {
|
|
2977
|
+
tryTransformationBeforeUpdate({ transformationID, transformationTry }: TryTransformationBeforeUpdateProps, requestOptions?: RequestOptions): Promise<TransformationTryResponse>;
|
|
2195
2978
|
/**
|
|
2196
|
-
*
|
|
2979
|
+
* Updates an authentication resource.
|
|
2980
|
+
*
|
|
2981
|
+
* Required API Key ACLs:
|
|
2982
|
+
* - addObject
|
|
2983
|
+
* - deleteIndex
|
|
2984
|
+
* - editSettings.
|
|
2985
|
+
*
|
|
2986
|
+
* @param updateAuthentication - The updateAuthentication object.
|
|
2987
|
+
* @param updateAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
2988
|
+
* @param updateAuthentication.authenticationUpdate - The authenticationUpdate object.
|
|
2989
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2197
2990
|
*/
|
|
2198
|
-
|
|
2199
|
-
transformationTry: TransformationTry;
|
|
2200
|
-
};
|
|
2201
|
-
/**
|
|
2202
|
-
* Properties for the `updateAuthentication` method.
|
|
2203
|
-
*/
|
|
2204
|
-
type UpdateAuthenticationProps = {
|
|
2991
|
+
updateAuthentication({ authenticationID, authenticationUpdate }: UpdateAuthenticationProps, requestOptions?: RequestOptions): Promise<AuthenticationUpdateResponse>;
|
|
2205
2992
|
/**
|
|
2206
|
-
*
|
|
2993
|
+
* Updates the destination by its ID.
|
|
2994
|
+
*
|
|
2995
|
+
* Required API Key ACLs:
|
|
2996
|
+
* - addObject
|
|
2997
|
+
* - deleteIndex
|
|
2998
|
+
* - editSettings.
|
|
2999
|
+
*
|
|
3000
|
+
* @param updateDestination - The updateDestination object.
|
|
3001
|
+
* @param updateDestination.destinationID - Unique identifier of a destination.
|
|
3002
|
+
* @param updateDestination.destinationUpdate - The destinationUpdate object.
|
|
3003
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2207
3004
|
*/
|
|
2208
|
-
|
|
2209
|
-
authenticationUpdate: AuthenticationUpdate;
|
|
2210
|
-
};
|
|
2211
|
-
/**
|
|
2212
|
-
* Properties for the `updateDestination` method.
|
|
2213
|
-
*/
|
|
2214
|
-
type UpdateDestinationProps = {
|
|
3005
|
+
updateDestination({ destinationID, destinationUpdate }: UpdateDestinationProps, requestOptions?: RequestOptions): Promise<DestinationUpdateResponse>;
|
|
2215
3006
|
/**
|
|
2216
|
-
*
|
|
3007
|
+
* Updates a source by its ID.
|
|
3008
|
+
*
|
|
3009
|
+
* Required API Key ACLs:
|
|
3010
|
+
* - addObject
|
|
3011
|
+
* - deleteIndex
|
|
3012
|
+
* - editSettings.
|
|
3013
|
+
*
|
|
3014
|
+
* @param updateSource - The updateSource object.
|
|
3015
|
+
* @param updateSource.sourceID - Unique identifier of a source.
|
|
3016
|
+
* @param updateSource.sourceUpdate - The sourceUpdate object.
|
|
3017
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2217
3018
|
*/
|
|
2218
|
-
|
|
2219
|
-
destinationUpdate: DestinationUpdate;
|
|
2220
|
-
};
|
|
2221
|
-
/**
|
|
2222
|
-
* Properties for the `updateSource` method.
|
|
2223
|
-
*/
|
|
2224
|
-
type UpdateSourceProps = {
|
|
3019
|
+
updateSource({ sourceID, sourceUpdate }: UpdateSourceProps, requestOptions?: RequestOptions): Promise<SourceUpdateResponse>;
|
|
2225
3020
|
/**
|
|
2226
|
-
*
|
|
3021
|
+
* Updates a task by its ID.
|
|
3022
|
+
*
|
|
3023
|
+
* @param updateTask - The updateTask object.
|
|
3024
|
+
* @param updateTask.taskID - Unique identifier of a task.
|
|
3025
|
+
* @param updateTask.taskUpdate - The taskUpdate object.
|
|
3026
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2227
3027
|
*/
|
|
2228
|
-
|
|
2229
|
-
sourceUpdate: SourceUpdate;
|
|
2230
|
-
};
|
|
2231
|
-
/**
|
|
2232
|
-
* Properties for the `updateTask` method.
|
|
2233
|
-
*/
|
|
2234
|
-
type UpdateTaskProps = {
|
|
3028
|
+
updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2235
3029
|
/**
|
|
2236
|
-
*
|
|
3030
|
+
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
3031
|
+
*
|
|
3032
|
+
* @param updateTaskV1 - The updateTaskV1 object.
|
|
3033
|
+
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
3034
|
+
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
3035
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2237
3036
|
*/
|
|
2238
|
-
taskID:
|
|
2239
|
-
taskUpdate: TaskUpdate;
|
|
2240
|
-
};
|
|
2241
|
-
/**
|
|
2242
|
-
* Properties for the `updateTaskV1` method.
|
|
2243
|
-
*/
|
|
2244
|
-
type UpdateTaskV1Props = {
|
|
3037
|
+
updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
2245
3038
|
/**
|
|
2246
|
-
*
|
|
3039
|
+
* Updates a transformation by its ID.
|
|
3040
|
+
*
|
|
3041
|
+
* @param updateTransformation - The updateTransformation object.
|
|
3042
|
+
* @param updateTransformation.transformationID - Unique identifier of a transformation.
|
|
3043
|
+
* @param updateTransformation.transformationCreate - The transformationCreate object.
|
|
3044
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2247
3045
|
*/
|
|
2248
|
-
|
|
2249
|
-
taskUpdate: TaskUpdateV1;
|
|
2250
|
-
};
|
|
2251
|
-
/**
|
|
2252
|
-
* Properties for the `updateTransformation` method.
|
|
2253
|
-
*/
|
|
2254
|
-
type UpdateTransformationProps = {
|
|
3046
|
+
updateTransformation({ transformationID, transformationCreate }: UpdateTransformationProps, requestOptions?: RequestOptions): Promise<TransformationUpdateResponse>;
|
|
2255
3047
|
/**
|
|
2256
|
-
*
|
|
3048
|
+
* Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
3049
|
+
*
|
|
3050
|
+
* Required API Key ACLs:
|
|
3051
|
+
* - addObject
|
|
3052
|
+
* - deleteIndex
|
|
3053
|
+
* - editSettings.
|
|
3054
|
+
*
|
|
3055
|
+
* @param sourceCreate -.
|
|
3056
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2257
3057
|
*/
|
|
2258
|
-
|
|
2259
|
-
transformationCreate: TransformationCreate;
|
|
2260
|
-
};
|
|
2261
|
-
/**
|
|
2262
|
-
* Properties for the `validateSourceBeforeUpdate` method.
|
|
2263
|
-
*/
|
|
2264
|
-
type ValidateSourceBeforeUpdateProps = {
|
|
3058
|
+
validateSource(sourceCreate: SourceCreate, requestOptions?: RequestOptions | undefined): Promise<SourceWatchResponse>;
|
|
2265
3059
|
/**
|
|
2266
|
-
*
|
|
3060
|
+
* Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.
|
|
3061
|
+
*
|
|
3062
|
+
* Required API Key ACLs:
|
|
3063
|
+
* - addObject
|
|
3064
|
+
* - deleteIndex
|
|
3065
|
+
* - editSettings.
|
|
3066
|
+
*
|
|
3067
|
+
* @param validateSourceBeforeUpdate - The validateSourceBeforeUpdate object.
|
|
3068
|
+
* @param validateSourceBeforeUpdate.sourceID - Unique identifier of a source.
|
|
3069
|
+
* @param validateSourceBeforeUpdate.sourceUpdate - The sourceUpdate object.
|
|
3070
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
2267
3071
|
*/
|
|
2268
|
-
sourceID:
|
|
2269
|
-
sourceUpdate: SourceUpdate;
|
|
3072
|
+
validateSourceBeforeUpdate({ sourceID, sourceUpdate }: ValidateSourceBeforeUpdateProps, requestOptions?: RequestOptions): Promise<SourceWatchResponse>;
|
|
2270
3073
|
};
|
|
2271
3074
|
|
|
2272
|
-
declare const apiClientVersion = "1.2.5";
|
|
2273
|
-
declare const REGIONS: readonly ["eu", "us"];
|
|
2274
|
-
type Region = (typeof REGIONS)[number];
|
|
2275
|
-
/**
|
|
2276
|
-
* Guard: Return strongly typed specific OnDemandTrigger for a given Trigger.
|
|
2277
|
-
*
|
|
2278
|
-
* @summary Guard method that returns a strongly typed specific OnDemandTrigger for a given Trigger.
|
|
2279
|
-
* @param trigger - The given Task Trigger.
|
|
2280
|
-
*/
|
|
2281
|
-
declare function isOnDemandTrigger(trigger: TaskCreateTrigger | Trigger): trigger is OnDemandTrigger;
|
|
2282
|
-
/**
|
|
2283
|
-
* Guard: Return strongly typed specific ScheduleTrigger for a given Trigger.
|
|
2284
|
-
*
|
|
2285
|
-
* @summary Guard method that returns a strongly typed specific ScheduleTrigger for a given Trigger.
|
|
2286
|
-
* @param trigger - The given Task Trigger.
|
|
2287
|
-
*/
|
|
2288
|
-
declare function isScheduleTrigger(trigger: TaskCreateTrigger | Trigger): trigger is ScheduleTrigger;
|
|
2289
|
-
/**
|
|
2290
|
-
* Guard: Return strongly typed specific SubscriptionTrigger for a given Trigger.
|
|
2291
|
-
*
|
|
2292
|
-
* @summary Guard method that returns a strongly typed specific SubscriptionTrigger for a given Trigger.
|
|
2293
|
-
* @param trigger - The given Task Trigger.
|
|
2294
|
-
*/
|
|
2295
|
-
declare function isSubscriptionTrigger(trigger: TaskCreateTrigger | Trigger): trigger is SubscriptionTrigger;
|
|
2296
|
-
|
|
2297
3075
|
/**
|
|
2298
|
-
*
|
|
3076
|
+
* Error.
|
|
2299
3077
|
*/
|
|
2300
|
-
type
|
|
2301
|
-
|
|
2302
|
-
transporter: _algolia_client_common.Transporter;
|
|
2303
|
-
appId: string;
|
|
2304
|
-
clearCache(): Promise<void>;
|
|
2305
|
-
readonly _ua: string;
|
|
2306
|
-
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>;
|
|
3078
|
+
type ErrorBase = Record<string, any> & {
|
|
3079
|
+
message?: string;
|
|
2366
3080
|
};
|
|
2367
3081
|
|
|
3082
|
+
type IngestionClient = ReturnType<typeof createIngestionClient>;
|
|
3083
|
+
|
|
3084
|
+
declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): IngestionClient;
|
|
3085
|
+
|
|
2368
3086
|
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 };
|