@algolia/ingestion 1.7.0 → 1.8.1

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