@algolia/ingestion 1.0.0-beta.10 → 1.0.0-beta.12
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/builds/browser.d.ts +17 -7
- package/dist/builds/browser.d.ts.map +1 -1
- package/dist/builds/node.d.ts +17 -7
- package/dist/builds/node.d.ts.map +1 -1
- package/dist/ingestion.cjs +491 -179
- package/dist/ingestion.esm.browser.js +491 -179
- package/dist/ingestion.esm.node.js +491 -179
- package/dist/ingestion.umd.js +2 -2
- package/dist/model/action.d.ts +5 -0
- package/dist/model/action.d.ts.map +1 -0
- package/dist/model/batchRequest.d.ts +9 -0
- package/dist/model/batchRequest.d.ts.map +1 -0
- package/dist/model/batchWriteParams.d.ts +8 -0
- package/dist/model/batchWriteParams.d.ts.map +1 -0
- package/dist/model/clientMethodProps.d.ts +177 -66
- package/dist/model/clientMethodProps.d.ts.map +1 -1
- package/dist/model/index.d.ts +7 -0
- package/dist/model/index.d.ts.map +1 -1
- package/dist/model/listTasksResponseV1.d.ts +10 -0
- package/dist/model/listTasksResponseV1.d.ts.map +1 -0
- package/dist/model/sourceUpdateShopify.d.ts +2 -26
- package/dist/model/sourceUpdateShopify.d.ts.map +1 -1
- package/dist/model/task.d.ts +12 -2
- package/dist/model/task.d.ts.map +1 -1
- package/dist/model/taskCreate.d.ts +4 -2
- package/dist/model/taskCreate.d.ts.map +1 -1
- package/dist/model/taskCreateV1.d.ts +32 -0
- package/dist/model/taskCreateV1.d.ts.map +1 -0
- package/dist/model/taskUpdate.d.ts +4 -2
- package/dist/model/taskUpdate.d.ts.map +1 -1
- package/dist/model/taskUpdateV1.d.ts +22 -0
- package/dist/model/taskUpdateV1.d.ts.map +1 -0
- package/dist/model/taskV1.d.ts +44 -0
- package/dist/model/taskV1.d.ts.map +1 -0
- package/dist/src/ingestionClient.d.ts +218 -92
- package/dist/src/ingestionClient.d.ts.map +1 -1
- package/model/action.ts +13 -0
- package/model/batchRequest.ts +12 -0
- package/model/batchWriteParams.ts +10 -0
- package/model/clientMethodProps.ts +189 -70
- package/model/index.ts +7 -0
- package/model/listTasksResponseV1.ts +13 -0
- package/model/sourceUpdateShopify.ts +2 -32
- package/model/task.ts +14 -2
- package/model/taskCreate.ts +5 -3
- package/model/taskCreateV1.ts +41 -0
- package/model/taskUpdate.ts +4 -2
- package/model/taskUpdateV1.ts +28 -0
- package/model/taskV1.ts +56 -0
- package/package.json +6 -6
|
@@ -4,7 +4,7 @@ import type { AuthenticationCreate } from '../model/authenticationCreate';
|
|
|
4
4
|
import type { AuthenticationCreateResponse } from '../model/authenticationCreateResponse';
|
|
5
5
|
import type { AuthenticationSearch } from '../model/authenticationSearch';
|
|
6
6
|
import type { AuthenticationUpdateResponse } from '../model/authenticationUpdateResponse';
|
|
7
|
-
import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteAuthenticationProps, DeleteDestinationProps, DeleteSourceProps, DeleteTaskProps, DeleteTransformationProps, DisableTaskProps, EnableTaskProps,
|
|
7
|
+
import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteAuthenticationProps, DeleteDestinationProps, DeleteSourceProps, DeleteTaskProps, DeleteTaskV1Props, DeleteTransformationProps, DisableTaskProps, DisableTaskV1Props, EnableTaskProps, EnableTaskV1Props, GetAuthenticationProps, GetDestinationProps, GetEventProps, GetRunProps, GetSourceProps, GetTaskProps, GetTaskV1Props, GetTransformationProps, ListAuthenticationsProps, ListDestinationsProps, ListEventsProps, ListRunsProps, ListSourcesProps, ListTasksProps, ListTasksV1Props, ListTransformationsProps, PushTaskProps, RunTaskProps, RunTaskV1Props, TriggerDockerSourceDiscoverProps, UpdateAuthenticationProps, UpdateDestinationProps, UpdateSourceProps, UpdateTaskProps, UpdateTaskV1Props, UpdateTransformationProps, ValidateSourceBeforeUpdateProps } from '../model/clientMethodProps';
|
|
8
8
|
import type { DeleteResponse } from '../model/deleteResponse';
|
|
9
9
|
import type { Destination } from '../model/destination';
|
|
10
10
|
import type { DestinationCreate } from '../model/destinationCreate';
|
|
@@ -17,6 +17,7 @@ import type { ListDestinationsResponse } from '../model/listDestinationsResponse
|
|
|
17
17
|
import type { ListEventsResponse } from '../model/listEventsResponse';
|
|
18
18
|
import type { ListSourcesResponse } from '../model/listSourcesResponse';
|
|
19
19
|
import type { ListTasksResponse } from '../model/listTasksResponse';
|
|
20
|
+
import type { ListTasksResponseV1 } from '../model/listTasksResponseV1';
|
|
20
21
|
import type { ListTransformationsResponse } from '../model/listTransformationsResponse';
|
|
21
22
|
import type { OnDemandTrigger } from '../model/onDemandTrigger';
|
|
22
23
|
import type { Run } from '../model/run';
|
|
@@ -34,8 +35,10 @@ import type { Task } from '../model/task';
|
|
|
34
35
|
import type { TaskCreate } from '../model/taskCreate';
|
|
35
36
|
import type { TaskCreateResponse } from '../model/taskCreateResponse';
|
|
36
37
|
import type { TaskCreateTrigger } from '../model/taskCreateTrigger';
|
|
38
|
+
import type { TaskCreateV1 } from '../model/taskCreateV1';
|
|
37
39
|
import type { TaskSearch } from '../model/taskSearch';
|
|
38
40
|
import type { TaskUpdateResponse } from '../model/taskUpdateResponse';
|
|
41
|
+
import type { TaskV1 } from '../model/taskV1';
|
|
39
42
|
import type { Transformation } from '../model/transformation';
|
|
40
43
|
import type { TransformationCreate } from '../model/transformationCreate';
|
|
41
44
|
import type { TransformationCreateResponse } from '../model/transformationCreateResponse';
|
|
@@ -44,7 +47,7 @@ import type { TransformationTry } from '../model/transformationTry';
|
|
|
44
47
|
import type { TransformationTryResponse } from '../model/transformationTryResponse';
|
|
45
48
|
import type { TransformationUpdateResponse } from '../model/transformationUpdateResponse';
|
|
46
49
|
import type { Trigger } from '../model/trigger';
|
|
47
|
-
export declare const apiClientVersion = "1.0.0-beta.
|
|
50
|
+
export declare const apiClientVersion = "1.0.0-beta.12";
|
|
48
51
|
export declare const REGIONS: readonly ["eu", "us"];
|
|
49
52
|
export type Region = (typeof REGIONS)[number];
|
|
50
53
|
/**
|
|
@@ -134,6 +137,13 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
134
137
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
135
138
|
*/
|
|
136
139
|
createTask(taskCreate: TaskCreate, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
|
|
140
|
+
/**
|
|
141
|
+
* Creates a new task using the v1 endpoint, please use `createTask` instead.
|
|
142
|
+
*
|
|
143
|
+
* @param taskCreate - Request body for creating a task.
|
|
144
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
145
|
+
*/
|
|
146
|
+
createTaskV1(taskCreate: TaskCreateV1, requestOptions?: RequestOptions): Promise<TaskCreateResponse>;
|
|
137
147
|
/**
|
|
138
148
|
* Creates a new transformation.
|
|
139
149
|
*
|
|
@@ -226,6 +236,14 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
226
236
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
227
237
|
*/
|
|
228
238
|
deleteTask({ taskID }: DeleteTaskProps, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
239
|
+
/**
|
|
240
|
+
* Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.
|
|
241
|
+
*
|
|
242
|
+
* @param deleteTaskV1 - The deleteTaskV1 object.
|
|
243
|
+
* @param deleteTaskV1.taskID - Unique identifier of a task.
|
|
244
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
245
|
+
*/
|
|
246
|
+
deleteTaskV1({ taskID }: DeleteTaskV1Props, requestOptions?: RequestOptions): Promise<DeleteResponse>;
|
|
229
247
|
/**
|
|
230
248
|
* Deletes a transformation by its ID.
|
|
231
249
|
*
|
|
@@ -247,6 +265,19 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
247
265
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
248
266
|
*/
|
|
249
267
|
disableTask({ taskID }: DisableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
268
|
+
/**
|
|
269
|
+
* Disables a task using the v1 endpoint, please use `disableTask` instead.
|
|
270
|
+
*
|
|
271
|
+
* Required API Key ACLs:
|
|
272
|
+
* - addObject
|
|
273
|
+
* - deleteIndex
|
|
274
|
+
* - editSettings.
|
|
275
|
+
*
|
|
276
|
+
* @param disableTaskV1 - The disableTaskV1 object.
|
|
277
|
+
* @param disableTaskV1.taskID - Unique identifier of a task.
|
|
278
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
279
|
+
*/
|
|
280
|
+
disableTaskV1({ taskID }: DisableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
250
281
|
/**
|
|
251
282
|
* Enables a task.
|
|
252
283
|
*
|
|
@@ -261,36 +292,31 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
261
292
|
*/
|
|
262
293
|
enableTask({ taskID }: EnableTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
263
294
|
/**
|
|
264
|
-
*
|
|
295
|
+
* Enables a task using the v1 endpoint, please use `enableTask` instead.
|
|
265
296
|
*
|
|
266
297
|
* Required API Key ACLs:
|
|
267
298
|
* - addObject
|
|
268
299
|
* - deleteIndex
|
|
269
300
|
* - editSettings.
|
|
270
301
|
*
|
|
271
|
-
* @param
|
|
272
|
-
* @param
|
|
302
|
+
* @param enableTaskV1 - The enableTaskV1 object.
|
|
303
|
+
* @param enableTaskV1.taskID - Unique identifier of a task.
|
|
273
304
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
274
305
|
*/
|
|
275
|
-
|
|
306
|
+
enableTaskV1({ taskID }: EnableTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
276
307
|
/**
|
|
277
|
-
* Retrieves
|
|
308
|
+
* Retrieves an authentication resource by its ID.
|
|
278
309
|
*
|
|
279
310
|
* Required API Key ACLs:
|
|
280
311
|
* - addObject
|
|
281
312
|
* - deleteIndex
|
|
282
313
|
* - editSettings.
|
|
283
314
|
*
|
|
284
|
-
* @param
|
|
285
|
-
* @param
|
|
286
|
-
* @param getAuthentications.page - Page number of the paginated API response.
|
|
287
|
-
* @param getAuthentications.type - Type of authentication resource to retrieve.
|
|
288
|
-
* @param getAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
|
|
289
|
-
* @param getAuthentications.sort - Property by which to sort the list of authentication resources.
|
|
290
|
-
* @param getAuthentications.order - Sort order of the response, ascending or descending.
|
|
315
|
+
* @param getAuthentication - The getAuthentication object.
|
|
316
|
+
* @param getAuthentication.authenticationID - Unique identifier of an authentication resource.
|
|
291
317
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
292
318
|
*/
|
|
293
|
-
|
|
319
|
+
getAuthentication({ authenticationID }: GetAuthenticationProps, requestOptions?: RequestOptions): Promise<Authentication>;
|
|
294
320
|
/**
|
|
295
321
|
* Retrieves a destination by its ID.
|
|
296
322
|
*
|
|
@@ -305,135 +331,179 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
305
331
|
*/
|
|
306
332
|
getDestination({ destinationID }: GetDestinationProps, requestOptions?: RequestOptions): Promise<Destination>;
|
|
307
333
|
/**
|
|
308
|
-
* Retrieves a
|
|
334
|
+
* Retrieves a single task run event by its ID.
|
|
309
335
|
*
|
|
310
336
|
* Required API Key ACLs:
|
|
311
337
|
* - addObject
|
|
312
338
|
* - deleteIndex
|
|
313
339
|
* - editSettings.
|
|
314
340
|
*
|
|
315
|
-
* @param
|
|
316
|
-
* @param
|
|
317
|
-
* @param
|
|
318
|
-
* @param getDestinations.type - Destination type.
|
|
319
|
-
* @param getDestinations.authenticationID - Authentication ID used by destinations.
|
|
320
|
-
* @param getDestinations.sort - Property by which to sort the destinations.
|
|
321
|
-
* @param getDestinations.order - Sort order of the response, ascending or descending.
|
|
341
|
+
* @param getEvent - The getEvent object.
|
|
342
|
+
* @param getEvent.runID - Unique identifier of a task run.
|
|
343
|
+
* @param getEvent.eventID - Unique identifier of an event.
|
|
322
344
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
323
345
|
*/
|
|
324
|
-
|
|
346
|
+
getEvent({ runID, eventID }: GetEventProps, requestOptions?: RequestOptions): Promise<Event>;
|
|
325
347
|
/**
|
|
326
|
-
*
|
|
348
|
+
* Retrieve a single task run by its ID.
|
|
327
349
|
*
|
|
328
350
|
* Required API Key ACLs:
|
|
329
351
|
* - addObject
|
|
330
352
|
* - deleteIndex
|
|
331
353
|
* - editSettings.
|
|
332
354
|
*
|
|
333
|
-
* @param
|
|
334
|
-
* @param
|
|
335
|
-
* @param getEvent.eventID - Unique identifier of an event.
|
|
355
|
+
* @param getRun - The getRun object.
|
|
356
|
+
* @param getRun.runID - Unique identifier of a task run.
|
|
336
357
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
337
358
|
*/
|
|
338
|
-
|
|
359
|
+
getRun({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<Run>;
|
|
339
360
|
/**
|
|
340
|
-
*
|
|
361
|
+
* Retrieve a source by its ID.
|
|
341
362
|
*
|
|
342
363
|
* Required API Key ACLs:
|
|
343
364
|
* - addObject
|
|
344
365
|
* - deleteIndex
|
|
345
366
|
* - editSettings.
|
|
346
367
|
*
|
|
347
|
-
* @param
|
|
348
|
-
* @param
|
|
349
|
-
* @param getEvents.itemsPerPage - Number of items per page.
|
|
350
|
-
* @param getEvents.page - Page number of the paginated API response.
|
|
351
|
-
* @param getEvents.status - Event status for filtering the list of task runs.
|
|
352
|
-
* @param getEvents.type - Event type for filtering the list of task runs.
|
|
353
|
-
* @param getEvents.sort - Property by which to sort the list of task run events.
|
|
354
|
-
* @param getEvents.order - Sort order of the response, ascending or descending.
|
|
355
|
-
* @param getEvents.startDate - Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
|
|
356
|
-
* @param getEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
368
|
+
* @param getSource - The getSource object.
|
|
369
|
+
* @param getSource.sourceID - Unique identifier of a source.
|
|
357
370
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
358
371
|
*/
|
|
359
|
-
|
|
372
|
+
getSource({ sourceID }: GetSourceProps, requestOptions?: RequestOptions): Promise<Source>;
|
|
360
373
|
/**
|
|
361
|
-
*
|
|
374
|
+
* Retrieves a task by its ID.
|
|
362
375
|
*
|
|
363
376
|
* Required API Key ACLs:
|
|
364
377
|
* - addObject
|
|
365
378
|
* - deleteIndex
|
|
366
379
|
* - editSettings.
|
|
367
380
|
*
|
|
368
|
-
* @param
|
|
369
|
-
* @param
|
|
381
|
+
* @param getTask - The getTask object.
|
|
382
|
+
* @param getTask.taskID - Unique identifier of a task.
|
|
370
383
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
371
384
|
*/
|
|
372
|
-
|
|
385
|
+
getTask({ taskID }: GetTaskProps, requestOptions?: RequestOptions): Promise<Task>;
|
|
373
386
|
/**
|
|
374
|
-
*
|
|
387
|
+
* Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.
|
|
375
388
|
*
|
|
376
389
|
* Required API Key ACLs:
|
|
377
390
|
* - addObject
|
|
378
391
|
* - deleteIndex
|
|
379
392
|
* - editSettings.
|
|
380
393
|
*
|
|
381
|
-
* @param
|
|
382
|
-
* @param
|
|
383
|
-
* @param getRuns.page - Page number of the paginated API response.
|
|
384
|
-
* @param getRuns.status - Run status for filtering the list of task runs.
|
|
385
|
-
* @param getRuns.taskID - Task ID for filtering the list of task runs.
|
|
386
|
-
* @param getRuns.sort - Property by which to sort the list of task runs.
|
|
387
|
-
* @param getRuns.order - Sort order of the response, ascending or descending.
|
|
388
|
-
* @param getRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
|
|
389
|
-
* @param getRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
|
|
394
|
+
* @param getTaskV1 - The getTaskV1 object.
|
|
395
|
+
* @param getTaskV1.taskID - Unique identifier of a task.
|
|
390
396
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
391
397
|
*/
|
|
392
|
-
|
|
398
|
+
getTaskV1({ taskID }: GetTaskV1Props, requestOptions?: RequestOptions): Promise<TaskV1>;
|
|
393
399
|
/**
|
|
394
|
-
*
|
|
400
|
+
* Retrieves a transformation by its ID.
|
|
395
401
|
*
|
|
396
402
|
* Required API Key ACLs:
|
|
397
403
|
* - addObject
|
|
398
404
|
* - deleteIndex
|
|
399
405
|
* - editSettings.
|
|
400
406
|
*
|
|
401
|
-
* @param
|
|
402
|
-
* @param
|
|
407
|
+
* @param getTransformation - The getTransformation object.
|
|
408
|
+
* @param getTransformation.transformationID - Unique identifier of a transformation.
|
|
403
409
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
404
410
|
*/
|
|
405
|
-
|
|
411
|
+
getTransformation({ transformationID }: GetTransformationProps, requestOptions?: RequestOptions): Promise<Transformation>;
|
|
406
412
|
/**
|
|
407
|
-
* Retrieves a list of
|
|
413
|
+
* Retrieves a list of all authentication resources.
|
|
408
414
|
*
|
|
409
415
|
* Required API Key ACLs:
|
|
410
416
|
* - addObject
|
|
411
417
|
* - deleteIndex
|
|
412
418
|
* - editSettings.
|
|
413
419
|
*
|
|
414
|
-
* @param
|
|
415
|
-
* @param
|
|
416
|
-
* @param
|
|
417
|
-
* @param
|
|
418
|
-
* @param
|
|
419
|
-
* @param
|
|
420
|
-
* @param
|
|
420
|
+
* @param listAuthentications - The listAuthentications object.
|
|
421
|
+
* @param listAuthentications.itemsPerPage - Number of items per page.
|
|
422
|
+
* @param listAuthentications.page - Page number of the paginated API response.
|
|
423
|
+
* @param listAuthentications.type - Type of authentication resource to retrieve.
|
|
424
|
+
* @param listAuthentications.platform - Ecommerce platform for which to retrieve authentication resources.
|
|
425
|
+
* @param listAuthentications.sort - Property by which to sort the list of authentication resources.
|
|
426
|
+
* @param listAuthentications.order - Sort order of the response, ascending or descending.
|
|
421
427
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
422
428
|
*/
|
|
423
|
-
|
|
429
|
+
listAuthentications({ itemsPerPage, page, type, platform, sort, order, }?: ListAuthenticationsProps, requestOptions?: RequestOptions | undefined): Promise<ListAuthenticationsResponse>;
|
|
424
430
|
/**
|
|
425
|
-
* Retrieves a
|
|
431
|
+
* Retrieves a list of destinations.
|
|
426
432
|
*
|
|
427
433
|
* Required API Key ACLs:
|
|
428
434
|
* - addObject
|
|
429
435
|
* - deleteIndex
|
|
430
436
|
* - editSettings.
|
|
431
437
|
*
|
|
432
|
-
* @param
|
|
433
|
-
* @param
|
|
438
|
+
* @param listDestinations - The listDestinations object.
|
|
439
|
+
* @param listDestinations.itemsPerPage - Number of items per page.
|
|
440
|
+
* @param listDestinations.page - Page number of the paginated API response.
|
|
441
|
+
* @param listDestinations.type - Destination type.
|
|
442
|
+
* @param listDestinations.authenticationID - Authentication ID used by destinations.
|
|
443
|
+
* @param listDestinations.sort - Property by which to sort the destinations.
|
|
444
|
+
* @param listDestinations.order - Sort order of the response, ascending or descending.
|
|
434
445
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
435
446
|
*/
|
|
436
|
-
|
|
447
|
+
listDestinations({ itemsPerPage, page, type, authenticationID, sort, order, }?: ListDestinationsProps, requestOptions?: RequestOptions | undefined): Promise<ListDestinationsResponse>;
|
|
448
|
+
/**
|
|
449
|
+
* Retrieves a list of events for a task run, identified by it\'s ID.
|
|
450
|
+
*
|
|
451
|
+
* Required API Key ACLs:
|
|
452
|
+
* - addObject
|
|
453
|
+
* - deleteIndex
|
|
454
|
+
* - editSettings.
|
|
455
|
+
*
|
|
456
|
+
* @param listEvents - The listEvents object.
|
|
457
|
+
* @param listEvents.runID - Unique identifier of a task run.
|
|
458
|
+
* @param listEvents.itemsPerPage - Number of items per page.
|
|
459
|
+
* @param listEvents.page - Page number of the paginated API response.
|
|
460
|
+
* @param listEvents.status - Event status for filtering the list of task runs.
|
|
461
|
+
* @param listEvents.type - Event type for filtering the list of task runs.
|
|
462
|
+
* @param listEvents.sort - Property by which to sort the list of task run events.
|
|
463
|
+
* @param listEvents.order - Sort order of the response, ascending or descending.
|
|
464
|
+
* @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.
|
|
465
|
+
* @param listEvents.endDate - Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
|
|
466
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
467
|
+
*/
|
|
468
|
+
listEvents({ runID, itemsPerPage, page, status, type, sort, order, startDate, endDate, }: ListEventsProps, requestOptions?: RequestOptions): Promise<ListEventsResponse>;
|
|
469
|
+
/**
|
|
470
|
+
* Retrieve a list of task runs.
|
|
471
|
+
*
|
|
472
|
+
* Required API Key ACLs:
|
|
473
|
+
* - addObject
|
|
474
|
+
* - deleteIndex
|
|
475
|
+
* - editSettings.
|
|
476
|
+
*
|
|
477
|
+
* @param listRuns - The listRuns object.
|
|
478
|
+
* @param listRuns.itemsPerPage - Number of items per page.
|
|
479
|
+
* @param listRuns.page - Page number of the paginated API response.
|
|
480
|
+
* @param listRuns.status - Run status for filtering the list of task runs.
|
|
481
|
+
* @param listRuns.taskID - Task ID for filtering the list of task runs.
|
|
482
|
+
* @param listRuns.sort - Property by which to sort the list of task runs.
|
|
483
|
+
* @param listRuns.order - Sort order of the response, ascending or descending.
|
|
484
|
+
* @param listRuns.startDate - Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
|
|
485
|
+
* @param listRuns.endDate - Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
|
|
486
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
487
|
+
*/
|
|
488
|
+
listRuns({ itemsPerPage, page, status, taskID, sort, order, startDate, endDate, }?: ListRunsProps, requestOptions?: RequestOptions | undefined): Promise<RunListResponse>;
|
|
489
|
+
/**
|
|
490
|
+
* Retrieves a list of sources.
|
|
491
|
+
*
|
|
492
|
+
* Required API Key ACLs:
|
|
493
|
+
* - addObject
|
|
494
|
+
* - deleteIndex
|
|
495
|
+
* - editSettings.
|
|
496
|
+
*
|
|
497
|
+
* @param listSources - The listSources object.
|
|
498
|
+
* @param listSources.itemsPerPage - Number of items per page.
|
|
499
|
+
* @param listSources.page - Page number of the paginated API response.
|
|
500
|
+
* @param listSources.type - Source type. Some sources require authentication.
|
|
501
|
+
* @param listSources.authenticationID - Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication resource.
|
|
502
|
+
* @param listSources.sort - Property by which to sort the list of sources.
|
|
503
|
+
* @param listSources.order - Sort order of the response, ascending or descending.
|
|
504
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
505
|
+
*/
|
|
506
|
+
listSources({ itemsPerPage, page, type, authenticationID, sort, order, }?: ListSourcesProps, requestOptions?: RequestOptions | undefined): Promise<ListSourcesResponse>;
|
|
437
507
|
/**
|
|
438
508
|
* Retrieves a list of tasks.
|
|
439
509
|
*
|
|
@@ -442,32 +512,40 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
442
512
|
* - deleteIndex
|
|
443
513
|
* - editSettings.
|
|
444
514
|
*
|
|
445
|
-
* @param
|
|
446
|
-
* @param
|
|
447
|
-
* @param
|
|
448
|
-
* @param
|
|
449
|
-
* @param
|
|
450
|
-
* @param
|
|
451
|
-
* @param
|
|
452
|
-
* @param
|
|
453
|
-
* @param
|
|
454
|
-
* @param
|
|
515
|
+
* @param listTasks - The listTasks object.
|
|
516
|
+
* @param listTasks.itemsPerPage - Number of items per page.
|
|
517
|
+
* @param listTasks.page - Page number of the paginated API response.
|
|
518
|
+
* @param listTasks.action - Actions for filtering the list of tasks.
|
|
519
|
+
* @param listTasks.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
520
|
+
* @param listTasks.sourceID - Source IDs for filtering the list of tasks.
|
|
521
|
+
* @param listTasks.destinationID - Destination IDs for filtering the list of tasks.
|
|
522
|
+
* @param listTasks.triggerType - Type of task trigger for filtering the list of tasks.
|
|
523
|
+
* @param listTasks.sort - Property by which to sort the list of tasks.
|
|
524
|
+
* @param listTasks.order - Sort order of the response, ascending or descending.
|
|
455
525
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
456
526
|
*/
|
|
457
|
-
|
|
527
|
+
listTasks({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, }?: ListTasksProps, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponse>;
|
|
458
528
|
/**
|
|
459
|
-
* Retrieves a
|
|
529
|
+
* Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.
|
|
460
530
|
*
|
|
461
531
|
* Required API Key ACLs:
|
|
462
532
|
* - addObject
|
|
463
533
|
* - deleteIndex
|
|
464
534
|
* - editSettings.
|
|
465
535
|
*
|
|
466
|
-
* @param
|
|
467
|
-
* @param
|
|
536
|
+
* @param listTasksV1 - The listTasksV1 object.
|
|
537
|
+
* @param listTasksV1.itemsPerPage - Number of items per page.
|
|
538
|
+
* @param listTasksV1.page - Page number of the paginated API response.
|
|
539
|
+
* @param listTasksV1.action - Actions for filtering the list of tasks.
|
|
540
|
+
* @param listTasksV1.enabled - Whether to filter the list of tasks by the `enabled` status.
|
|
541
|
+
* @param listTasksV1.sourceID - Source IDs for filtering the list of tasks.
|
|
542
|
+
* @param listTasksV1.destinationID - Destination IDs for filtering the list of tasks.
|
|
543
|
+
* @param listTasksV1.triggerType - Type of task trigger for filtering the list of tasks.
|
|
544
|
+
* @param listTasksV1.sort - Property by which to sort the list of tasks.
|
|
545
|
+
* @param listTasksV1.order - Sort order of the response, ascending or descending.
|
|
468
546
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
469
547
|
*/
|
|
470
|
-
|
|
548
|
+
listTasksV1({ itemsPerPage, page, action, enabled, sourceID, destinationID, triggerType, sort, order, }?: ListTasksV1Props, requestOptions?: RequestOptions | undefined): Promise<ListTasksResponseV1>;
|
|
471
549
|
/**
|
|
472
550
|
* Retrieves a list of transformations.
|
|
473
551
|
*
|
|
@@ -476,12 +554,26 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
476
554
|
* - deleteIndex
|
|
477
555
|
* - editSettings.
|
|
478
556
|
*
|
|
479
|
-
* @param
|
|
480
|
-
* @param
|
|
481
|
-
* @param
|
|
557
|
+
* @param listTransformations - The listTransformations object.
|
|
558
|
+
* @param listTransformations.sort - Property by which to sort the list.
|
|
559
|
+
* @param listTransformations.order - Sort order of the response, ascending or descending.
|
|
482
560
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
483
561
|
*/
|
|
484
|
-
|
|
562
|
+
listTransformations({ sort, order }?: ListTransformationsProps, requestOptions?: RequestOptions | undefined): Promise<ListTransformationsResponse>;
|
|
563
|
+
/**
|
|
564
|
+
* Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints.
|
|
565
|
+
*
|
|
566
|
+
* Required API Key ACLs:
|
|
567
|
+
* - addObject
|
|
568
|
+
* - deleteIndex
|
|
569
|
+
* - editSettings.
|
|
570
|
+
*
|
|
571
|
+
* @param pushTask - The pushTask object.
|
|
572
|
+
* @param pushTask.taskID - Unique identifier of a task.
|
|
573
|
+
* @param pushTask.batchWriteParams - Request body of a Search API `batch` request that will be pushed in the Connectors pipeline.
|
|
574
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
575
|
+
*/
|
|
576
|
+
pushTask({ taskID, batchWriteParams }: PushTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
|
|
485
577
|
/**
|
|
486
578
|
* Runs a task. You can check the status of task runs with the observability endpoints.
|
|
487
579
|
*
|
|
@@ -495,6 +587,19 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
495
587
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
496
588
|
*/
|
|
497
589
|
runTask({ taskID }: RunTaskProps, requestOptions?: RequestOptions): Promise<RunResponse>;
|
|
590
|
+
/**
|
|
591
|
+
* Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.
|
|
592
|
+
*
|
|
593
|
+
* Required API Key ACLs:
|
|
594
|
+
* - addObject
|
|
595
|
+
* - deleteIndex
|
|
596
|
+
* - editSettings.
|
|
597
|
+
*
|
|
598
|
+
* @param runTaskV1 - The runTaskV1 object.
|
|
599
|
+
* @param runTaskV1.taskID - Unique identifier of a task.
|
|
600
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
601
|
+
*/
|
|
602
|
+
runTaskV1({ taskID }: RunTaskV1Props, requestOptions?: RequestOptions): Promise<RunResponse>;
|
|
498
603
|
/**
|
|
499
604
|
* Searches for authentication resources.
|
|
500
605
|
*
|
|
@@ -543,6 +648,18 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
543
648
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
544
649
|
*/
|
|
545
650
|
searchTasks(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<Task[]>;
|
|
651
|
+
/**
|
|
652
|
+
* Searches for tasks using the v1 endpoint, please use `searchTasks` instead.
|
|
653
|
+
*
|
|
654
|
+
* Required API Key ACLs:
|
|
655
|
+
* - addObject
|
|
656
|
+
* - deleteIndex
|
|
657
|
+
* - editSettings.
|
|
658
|
+
*
|
|
659
|
+
* @param taskSearch - The taskSearch object.
|
|
660
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
661
|
+
*/
|
|
662
|
+
searchTasksV1(taskSearch: TaskSearch, requestOptions?: RequestOptions): Promise<TaskV1[]>;
|
|
546
663
|
/**
|
|
547
664
|
* Searches for transformations.
|
|
548
665
|
*
|
|
@@ -631,6 +748,15 @@ export declare function createIngestionClient({ appId: appIdOption, apiKey: apiK
|
|
|
631
748
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
632
749
|
*/
|
|
633
750
|
updateTask({ taskID, taskUpdate }: UpdateTaskProps, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
751
|
+
/**
|
|
752
|
+
* Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.
|
|
753
|
+
*
|
|
754
|
+
* @param updateTaskV1 - The updateTaskV1 object.
|
|
755
|
+
* @param updateTaskV1.taskID - Unique identifier of a task.
|
|
756
|
+
* @param updateTaskV1.taskUpdate - The taskUpdate object.
|
|
757
|
+
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
758
|
+
*/
|
|
759
|
+
updateTaskV1({ taskID, taskUpdate }: UpdateTaskV1Props, requestOptions?: RequestOptions): Promise<TaskUpdateResponse>;
|
|
634
760
|
/**
|
|
635
761
|
* Updates a transformation by its ID.
|
|
636
762
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ingestionClient.d.ts","sourceRoot":"","sources":["../../src/ingestionClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,yBAAyB,EACzB,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,
|
|
1
|
+
{"version":3,"file":"ingestionClient.d.ts","sourceRoot":"","sources":["../../src/ingestionClient.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,mBAAmB,EAKnB,cAAc,EACf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EACV,iBAAiB,EACjB,cAAc,EACd,eAAe,EACf,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,yBAAyB,EACzB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,aAAa,EACb,WAAW,EACX,cAAc,EACd,YAAY,EACZ,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACxB,qBAAqB,EACrB,eAAe,EACf,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,gBAAgB,EAChB,wBAAwB,EACxB,aAAa,EACb,YAAY,EACZ,cAAc,EACd,gCAAgC,EAChC,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,yBAAyB,EACzB,+BAA+B,EAChC,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAC5C,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,sCAAsC,CAAC;AACxF,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACxC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,8BAA8B,CAAC;AACxE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AACtE,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AACpE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,uCAAuC,CAAC;AAC1F,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAEhD,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAEhD,eAAO,MAAM,OAAO,uBAAwB,CAAC;AAC7C,MAAM,MAAM,MAAM,GAAG,CAAC,OAAO,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC;AAQ9C;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,iBAAiB,GAAG,OAAO,GACnC,OAAO,IAAI,eAAe,CAE5B;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,iBAAiB,GAAG,OAAO,GACnC,OAAO,IAAI,eAAe,CAE5B;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,iBAAiB,GAAG,OAAO,GACnC,OAAO,IAAI,mBAAmB,CAEhC;AAGD,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,MAAM,EAAE,YAAY,EACpB,GAAG,OAAO,EACX,EAAE,mBAAmB,GAAG;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE;;IAwBvC;;OAEG;;IAGH;;OAEG;kBACW,OAAO,CAAC,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;;;OAUG;+CAEqB,oBAAoB,mBACzB,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IAsCxC;;;;;;;;;;OAUG;yCAEkB,iBAAiB,mBACnB,cAAc,GAC9B,OAAO,CAAC,yBAAyB,CAAC;IAsCrC;;;;;;;;;;OAUG;+BAEa,YAAY,mBACT,cAAc,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAsChC;;;;;OAKG;2BAEW,UAAU,mBACL,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAsC9B;;;;;OAKG;6BAEW,YAAY,mBACP,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IA2C9B;;;;;OAKG;+CAEqB,oBAAoB,mBACzB,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IAiCxC;;;;;;;OAOG;uCAEqB,iBAAiB,mBACtB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;OAOG;oCAEqB,cAAc,mBACnB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAqB/B;;;;;;;;OAQG;2CAE2B,eAAe,mBAC1B,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;OAQG;0CAE2B,cAAc,mBACzB,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAsB/B;;;;;;;;;;;OAWG;+CAEqB,yBAAyB,mBAC9B,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;;;;;;OAWG;yCAEkB,sBAAsB,mBACxB,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;;;;;;OAWG;+BAEa,iBAAiB,mBACd,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;OAMG;2BAEW,eAAe,mBACV,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;OAMG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;OAMG;+CAEqB,yBAAyB,mBAC9B,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;;;;;;OAWG;4BAEW,gBAAgB,mBACX,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAwB9B;;;;;;;;;;;OAWG;8BAEW,kBAAkB,mBACb,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAwB9B;;;;;;;;;;;OAWG;2BAEW,eAAe,mBACV,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAwB9B;;;;;;;;;;;OAWG;6BAEW,iBAAiB,mBACZ,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAwB9B;;;;;;;;;;;OAWG;4CAEqB,sBAAsB,mBAC3B,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;;;;;;OAWG;sCAEkB,mBAAmB,mBACrB,cAAc,GAC9B,OAAO,CAAC,WAAW,CAAC;IAwBvB;;;;;;;;;;;;OAYG;iCAEmB,aAAa,mBAChB,cAAc,GAC9B,OAAO,CAAC,KAAK,CAAC;IA6BjB;;;;;;;;;;;OAWG;sBAEU,WAAW,mBACL,cAAc,GAC9B,OAAO,CAAC,GAAG,CAAC;IAsBf;;;;;;;;;;;OAWG;4BAEa,cAAc,mBACX,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC;IAwBlB;;;;;;;;;;;OAWG;wBAEW,YAAY,mBACP,cAAc,GAC9B,OAAO,CAAC,IAAI,CAAC;IAwBhB;;;;;;;;;;;OAWG;0BAEW,cAAc,mBACT,cAAc,GAC9B,OAAO,CAAC,MAAM,CAAC;IAwBlB;;;;;;;;;;;OAWG;4CAEqB,sBAAsB,mBAC3B,cAAc,GAC9B,OAAO,CAAC,cAAc,CAAC;IAwB1B;;;;;;;;;;;;;;;;OAgBG;+EASE,wBAAwB,mBACX,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,2BAA2B,CAAC;IAuCvC;;;;;;;;;;;;;;;;OAgBG;oFASE,qBAAqB,mBACR,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,wBAAwB,CAAC;IAuCpC;;;;;;;;;;;;;;;;;;;OAmBG;8FAYE,eAAe,mBACD,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IAwD9B;;;;;;;;;;;;;;;;;;OAkBG;wFAWE,aAAa,mBACA,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,eAAe,CAAC;IA+C3B;;;;;;;;;;;;;;;;OAgBG;+EASE,gBAAgB,mBACH,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAuC/B;;;;;;;;;;;;;;;;;;;OAmBG;4GAYE,cAAc,mBACD,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,iBAAiB,CAAC;IAmD7B;;;;;;;;;;;;;;;;;;;OAmBG;8GAYE,gBAAgB,mBACH,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAmD/B;;;;;;;;;;;;OAYG;0CAEgB,wBAAwB,mBACzB,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,2BAA2B,CAAC;IAuBvC;;;;;;;;;;;;OAYG;2CAE6B,aAAa,mBAC1B,cAAc,GAC9B,OAAO,CAAC,WAAW,CAAC;IAqCvB;;;;;;;;;;;OAWG;wBAEW,YAAY,mBACP,cAAc,GAC9B,OAAO,CAAC,WAAW,CAAC;IAwBvB;;;;;;;;;;;OAWG;0BAEW,cAAc,mBACT,cAAc,GAC9B,OAAO,CAAC,WAAW,CAAC;IAwBvB;;;;;;;;;;OAUG;gDAEqB,oBAAoB,mBACzB,cAAc,GAC9B,OAAO,CAAC,cAAc,EAAE,CAAC;IA4B5B;;;;;;;;;;OAUG;0CAEkB,iBAAiB,mBACnB,cAAc,GAC9B,OAAO,CAAC,WAAW,EAAE,CAAC;IA4BzB;;;;;;;;;;OAUG;gCAEa,YAAY,mBACT,cAAc,GAC9B,OAAO,CAAC,MAAM,EAAE,CAAC;IA4BpB;;;;;;;;;;OAUG;4BAEW,UAAU,mBACL,cAAc,GAC9B,OAAO,CAAC,IAAI,EAAE,CAAC;IA4BlB;;;;;;;;;;OAUG;8BAEW,UAAU,mBACL,cAAc,GAC9B,OAAO,CAAC,MAAM,EAAE,CAAC;IA4BpB;;;;;;;;;;OAUG;gDAEqB,oBAAoB,mBACzB,cAAc,GAC9B,OAAO,CAAC,cAAc,EAAE,CAAC;IA4B5B;;;;;;;;;;;OAWG;8CAEa,gCAAgC,mBAC7B,cAAc,GAC9B,OAAO,CAAC,mBAAmB,CAAC;IAwB/B;;;;;;;;;;OAUG;0CAEkB,iBAAiB,mBACnB,cAAc,GAC9B,OAAO,CAAC,yBAAyB,CAAC;IAiCrC;;;;;;;;;;;;OAYG;qEAE2C,yBAAyB,mBACpD,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IA+BxC;;;;;;;;;;;;OAYG;4DAEqC,sBAAsB,mBAC3C,cAAc,GAC9B,OAAO,CAAC,yBAAyB,CAAC;IA+BrC;;;;;;;;;;;;OAYG;6CAE2B,iBAAiB,mBAC5B,cAAc,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IA+BhC;;;;;;;OAOG;uCAEuB,eAAe,mBACtB,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IA+B9B;;;;;;;OAOG;yCAEuB,iBAAiB,mBACxB,cAAc,GAC9B,OAAO,CAAC,kBAAkB,CAAC;IA+B9B;;;;;;;OAOG;qEAE2C,yBAAyB,mBACpD,cAAc,GAC9B,OAAO,CAAC,4BAA4B,CAAC;IA0CxC;;;;;;;;;;OAUG;iCAEa,YAAY,mBACV,cAAc,GAAG,SAAS,GACzC,OAAO,CAAC,mBAAmB,CAAC;IAgB/B;;;;;;;;;;;;OAYG;2DAE2B,+BAA+B,mBAC1C,cAAc,GAC9B,OAAO,CAAC,mBAAmB,CAAC;EA+BlC"}
|
package/model/action.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* Type of indexing operation.
|
|
5
|
+
*/
|
|
6
|
+
export type Action =
|
|
7
|
+
| 'addObject'
|
|
8
|
+
| 'clear'
|
|
9
|
+
| 'delete'
|
|
10
|
+
| 'deleteObject'
|
|
11
|
+
| 'partialUpdateObject'
|
|
12
|
+
| 'partialUpdateObjectNoCreate'
|
|
13
|
+
| 'updateObject';
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
import type { Action } from './action';
|
|
4
|
+
|
|
5
|
+
export type BatchRequest = {
|
|
6
|
+
action: Action;
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Operation arguments (varies with specified `action`).
|
|
10
|
+
*/
|
|
11
|
+
body: Record<string, any>;
|
|
12
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
import type { BatchRequest } from './batchRequest';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Batch parameters.
|
|
7
|
+
*/
|
|
8
|
+
export type BatchWriteParams = {
|
|
9
|
+
requests: BatchRequest[];
|
|
10
|
+
};
|