@algolia/ingestion 1.27.0 → 1.29.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/node.d.cts CHANGED
@@ -8,7 +8,7 @@ type AuthAPIKeyPartial = {
8
8
  /**
9
9
  * API key. This field is `null` in the API response.
10
10
  */
11
- key?: string;
11
+ key?: string | undefined;
12
12
  };
13
13
 
14
14
  /**
@@ -18,11 +18,11 @@ type AuthAlgoliaInsightsPartial = {
18
18
  /**
19
19
  * Algolia application ID.
20
20
  */
21
- appID?: string;
21
+ appID?: string | undefined;
22
22
  /**
23
23
  * Algolia API key with the ACL: `search`. This field is `null` in the API response.
24
24
  */
25
- apiKey?: string;
25
+ apiKey?: string | undefined;
26
26
  };
27
27
 
28
28
  /**
@@ -32,11 +32,11 @@ type AuthAlgoliaPartial = {
32
32
  /**
33
33
  * Algolia application ID.
34
34
  */
35
- appID?: string;
35
+ appID?: string | undefined;
36
36
  /**
37
37
  * Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`. This field is `null` in the API response.
38
38
  */
39
- apiKey?: string;
39
+ apiKey?: string | undefined;
40
40
  };
41
41
 
42
42
  /**
@@ -46,11 +46,11 @@ type AuthBasicPartial = {
46
46
  /**
47
47
  * Username.
48
48
  */
49
- username?: string;
49
+ username?: string | undefined;
50
50
  /**
51
51
  * Password. This field is `null` in the API response.
52
52
  */
53
- password?: string;
53
+ password?: string | undefined;
54
54
  };
55
55
 
56
56
  /**
@@ -60,11 +60,11 @@ type AuthGoogleServiceAccountPartial = {
60
60
  /**
61
61
  * Email address of the Google service account.
62
62
  */
63
- clientEmail?: string;
63
+ clientEmail?: string | undefined;
64
64
  /**
65
65
  * Private key of the Google service account. This field is `null` in the API response.
66
66
  */
67
- privateKey?: string;
67
+ privateKey?: string | undefined;
68
68
  };
69
69
 
70
70
  /**
@@ -74,19 +74,19 @@ type AuthOAuthPartial = {
74
74
  /**
75
75
  * URL for the OAuth endpoint.
76
76
  */
77
- url?: string;
77
+ url?: string | undefined;
78
78
  /**
79
79
  * Client ID.
80
80
  */
81
- client_id?: string;
81
+ client_id?: string | undefined;
82
82
  /**
83
83
  * Client secret. This field is `null` in the API response.
84
84
  */
85
- client_secret?: string;
85
+ client_secret?: string | undefined;
86
86
  /**
87
87
  * OAuth scope.
88
88
  */
89
- scope?: string;
89
+ scope?: string | undefined;
90
90
  };
91
91
 
92
92
  type AuthInputPartial = AuthGoogleServiceAccountPartial | AuthBasicPartial | AuthAPIKeyPartial | AuthOAuthPartial | AuthAlgoliaPartial | AuthAlgoliaInsightsPartial | {
@@ -116,11 +116,11 @@ type Authentication = {
116
116
  * Descriptive name for the resource.
117
117
  */
118
118
  name: string;
119
- platform?: Platform | null;
119
+ platform?: Platform | null | undefined;
120
120
  /**
121
121
  * Owner of the resource.
122
122
  */
123
- owner?: string | null;
123
+ owner?: string | null | undefined;
124
124
  input: AuthInputPartial;
125
125
  /**
126
126
  * Date of creation in RFC 3339 format.
@@ -217,7 +217,7 @@ type AuthOAuth = {
217
217
  /**
218
218
  * OAuth scope.
219
219
  */
220
- scope?: string;
220
+ scope?: string | undefined;
221
221
  };
222
222
 
223
223
  type AuthInput = AuthGoogleServiceAccount | AuthBasic | AuthAPIKey | AuthOAuth | AuthAlgolia | AuthAlgoliaInsights | {
@@ -233,7 +233,7 @@ type AuthenticationCreate = {
233
233
  * Descriptive name for the resource.
234
234
  */
235
235
  name: string;
236
- platform?: Platform | null;
236
+ platform?: Platform | null | undefined;
237
237
  input: AuthInput;
238
238
  };
239
239
 
@@ -297,11 +297,11 @@ type DestinationInput = {
297
297
  * Algolia index name (case-sensitive).
298
298
  */
299
299
  indexName: string;
300
- recordType?: RecordType;
300
+ recordType?: RecordType | undefined;
301
301
  /**
302
302
  * 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.
303
303
  */
304
- attributesToExclude?: Array<string>;
304
+ attributesToExclude?: Array<string> | undefined;
305
305
  };
306
306
 
307
307
  /**
@@ -325,7 +325,7 @@ type Destination = {
325
325
  /**
326
326
  * Owner of the resource.
327
327
  */
328
- owner?: string | null;
328
+ owner?: string | null | undefined;
329
329
  input: DestinationInput;
330
330
  /**
331
331
  * Date of creation in RFC 3339 format.
@@ -338,8 +338,8 @@ type Destination = {
338
338
  /**
339
339
  * Universally unique identifier (UUID) of an authentication resource.
340
340
  */
341
- authenticationID?: string;
342
- transformationIDs?: Array<string>;
341
+ authenticationID?: string | undefined;
342
+ transformationIDs?: Array<string> | undefined;
343
343
  };
344
344
 
345
345
  /**
@@ -355,8 +355,8 @@ type DestinationCreate = {
355
355
  /**
356
356
  * Universally unique identifier (UUID) of an authentication resource.
357
357
  */
358
- authenticationID?: string;
359
- transformationIDs?: Array<string>;
358
+ authenticationID?: string | undefined;
359
+ transformationIDs?: Array<string> | undefined;
360
360
  };
361
361
 
362
362
  /**
@@ -426,7 +426,7 @@ type Event = {
426
426
  batchSize: number;
427
427
  data?: {
428
428
  [key: string]: any;
429
- } | null;
429
+ } | null | undefined;
430
430
  /**
431
431
  * Date of publish RFC 3339 format.
432
432
  */
@@ -493,7 +493,7 @@ type BigCommerceChannel = {
493
493
  /**
494
494
  * Currencies for the given channel.
495
495
  */
496
- currencies?: Array<string>;
496
+ currencies?: Array<string> | undefined;
497
497
  };
498
498
 
499
499
  type BigCommerceMetafield = {
@@ -512,10 +512,10 @@ type SourceBigCommerce = {
512
512
  * Store hash identifying your BigCommerce store.
513
513
  */
514
514
  storeHash: string;
515
- channel?: BigCommerceChannel;
516
- customFields?: Array<string>;
517
- productMetafields?: Array<BigCommerceMetafield>;
518
- variantMetafields?: Array<BigCommerceMetafield>;
515
+ channel?: BigCommerceChannel | undefined;
516
+ customFields?: Array<string> | undefined;
517
+ productMetafields?: Array<BigCommerceMetafield> | undefined;
518
+ variantMetafields?: Array<BigCommerceMetafield> | undefined;
519
519
  };
520
520
 
521
521
  type BigQueryDataType = 'ga4' | 'ga360';
@@ -529,23 +529,23 @@ type SourceBigQuery = {
529
529
  * Dataset ID of the BigQuery source.
530
530
  */
531
531
  datasetID: string;
532
- dataType?: BigQueryDataType;
532
+ dataType?: BigQueryDataType | undefined;
533
533
  /**
534
534
  * Table name for the BigQuery export.
535
535
  */
536
- table?: string;
536
+ table?: string | undefined;
537
537
  /**
538
538
  * Table prefix for a Google Analytics 4 data export to BigQuery.
539
539
  */
540
- tablePrefix?: string;
540
+ tablePrefix?: string | undefined;
541
541
  /**
542
542
  * Custom SQL request to extract data from the BigQuery table.
543
543
  */
544
- customSQLRequest?: string;
544
+ customSQLRequest?: string | undefined;
545
545
  /**
546
546
  * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
547
547
  */
548
- uniqueIDColumn?: string;
548
+ uniqueIDColumn?: string | undefined;
549
549
  };
550
550
 
551
551
  type MappingTypeCSV = 'string' | 'integer' | 'float' | 'boolean' | 'json';
@@ -563,18 +563,18 @@ type SourceCSV = {
563
563
  /**
564
564
  * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
565
565
  */
566
- uniqueIDColumn?: string;
566
+ uniqueIDColumn?: string | undefined;
567
567
  /**
568
568
  * Key-value pairs of column names and their expected types.
569
569
  */
570
570
  mapping?: {
571
571
  [key: string]: MappingTypeCSV;
572
- };
573
- method?: MethodType;
572
+ } | undefined;
573
+ method?: MethodType | undefined;
574
574
  /**
575
575
  * The character used to split the value on each line, default to a comma (\\r, \\n, 0xFFFD, and space are forbidden).
576
576
  */
577
- delimiter?: string;
577
+ delimiter?: string | undefined;
578
578
  };
579
579
 
580
580
  /**
@@ -584,34 +584,34 @@ type CommercetoolsCustomFields = {
584
584
  /**
585
585
  * Inventory custom fields.
586
586
  */
587
- inventory?: Array<string> | null;
587
+ inventory?: Array<string> | null | undefined;
588
588
  /**
589
589
  * Price custom fields.
590
590
  */
591
- price?: Array<string> | null;
591
+ price?: Array<string> | null | undefined;
592
592
  /**
593
593
  * Category custom fields.
594
594
  */
595
- category?: Array<string> | null;
595
+ category?: Array<string> | null | undefined;
596
596
  };
597
597
 
598
598
  type SourceCommercetools = {
599
- storeKeys?: Array<string>;
599
+ storeKeys?: Array<string> | undefined;
600
600
  /**
601
601
  * Locales for your commercetools stores.
602
602
  */
603
- locales?: Array<string>;
603
+ locales?: Array<string> | undefined;
604
604
  url: string;
605
605
  projectKey: string;
606
606
  /**
607
607
  * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
608
608
  */
609
- fallbackIsInStockValue?: boolean;
609
+ fallbackIsInStockValue?: boolean | undefined;
610
610
  /**
611
611
  * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
612
612
  */
613
- productQueryPredicate?: string;
614
- customFields?: CommercetoolsCustomFields;
613
+ productQueryPredicate?: string | undefined;
614
+ customFields?: CommercetoolsCustomFields | undefined;
615
615
  };
616
616
 
617
617
  type SourceDocker = {
@@ -648,8 +648,8 @@ type SourceJSON = {
648
648
  /**
649
649
  * Name of a column that contains a unique ID which will be used as `objectID` in Algolia.
650
650
  */
651
- uniqueIDColumn?: string;
652
- method?: MethodType;
651
+ uniqueIDColumn?: string | undefined;
652
+ method?: MethodType | undefined;
653
653
  };
654
654
 
655
655
  type SourceShopifyBase = {
@@ -665,7 +665,7 @@ type SourceUpdateShopify = {
665
665
  */
666
666
  featureFlags?: {
667
667
  [key: string]: any;
668
- };
668
+ } | undefined;
669
669
  };
670
670
 
671
671
  type SourceShopify = SourceUpdateShopify & SourceShopifyBase;
@@ -684,12 +684,12 @@ type Source = {
684
684
  /**
685
685
  * Owner of the resource.
686
686
  */
687
- owner?: string | null;
688
- input?: SourceInput;
687
+ owner?: string | null | undefined;
688
+ input?: SourceInput | undefined;
689
689
  /**
690
690
  * Universally unique identifier (UUID) of an authentication resource.
691
691
  */
692
- authenticationID?: string;
692
+ authenticationID?: string | undefined;
693
693
  /**
694
694
  * Date of creation in RFC 3339 format.
695
695
  */
@@ -714,7 +714,7 @@ type EmailNotifications = {
714
714
  /**
715
715
  * Whether to send email notifications, note that this doesn\'t prevent the task from being blocked.
716
716
  */
717
- enabled?: boolean;
717
+ enabled?: boolean | undefined;
718
718
  };
719
719
 
720
720
  /**
@@ -731,7 +731,7 @@ type Policies = {
731
731
  /**
732
732
  * The number of critical failures in a row before blocking the task and sending a notification.
733
733
  */
734
- criticalThreshold?: number;
734
+ criticalThreshold?: number | undefined;
735
735
  };
736
736
 
737
737
  /**
@@ -747,7 +747,7 @@ type DockerStreams = {
747
747
  /**
748
748
  * The properties of the stream to select (e.g. column).
749
749
  */
750
- properties?: Array<string>;
750
+ properties?: Array<string> | undefined;
751
751
  syncMode: DockerStreamsSyncMode;
752
752
  };
753
753
 
@@ -812,7 +812,7 @@ type MappingKitAction = {
812
812
  /**
813
813
  * ID to uniquely identify this action.
814
814
  */
815
- id?: string;
815
+ id?: string | undefined;
816
816
  /**
817
817
  * Whether this action has any effect.
818
818
  */
@@ -860,20 +860,20 @@ type Task = {
860
860
  /**
861
861
  * Cron expression for the task\'s schedule.
862
862
  */
863
- cron?: string;
863
+ cron?: string | undefined;
864
864
  /**
865
865
  * The last time the scheduled task ran in RFC 3339 format.
866
866
  */
867
- lastRun?: string;
867
+ lastRun?: string | undefined;
868
868
  /**
869
869
  * The next scheduled run of the task in RFC 3339 format.
870
870
  */
871
- nextRun?: string;
871
+ nextRun?: string | undefined;
872
872
  /**
873
873
  * Owner of the resource.
874
874
  */
875
- owner?: string | null;
876
- input?: TaskInput;
875
+ owner?: string | null | undefined;
876
+ input?: TaskInput | undefined;
877
877
  /**
878
878
  * Whether the task is enabled.
879
879
  */
@@ -881,15 +881,15 @@ type Task = {
881
881
  /**
882
882
  * Maximum accepted percentage of failures for a task run to finish successfully.
883
883
  */
884
- failureThreshold?: number;
885
- action?: ActionType;
886
- subscriptionAction?: ActionType;
884
+ failureThreshold?: number | undefined;
885
+ action?: ActionType | undefined;
886
+ subscriptionAction?: ActionType | undefined;
887
887
  /**
888
888
  * Date of the last cursor in RFC 3339 format.
889
889
  */
890
- cursor?: string;
891
- notifications?: Notifications;
892
- policies?: Policies;
890
+ cursor?: string | undefined;
891
+ notifications?: Notifications | undefined;
892
+ policies?: Policies | undefined;
893
893
  /**
894
894
  * Date of creation in RFC 3339 format.
895
895
  */
@@ -921,7 +921,7 @@ type OnDemandTrigger = {
921
921
  /**
922
922
  * The last time the scheduled task ran in RFC 3339 format.
923
923
  */
924
- lastRun?: string;
924
+ lastRun?: string | undefined;
925
925
  };
926
926
 
927
927
  /**
@@ -941,7 +941,7 @@ type ScheduleTrigger = {
941
941
  /**
942
942
  * The last time the scheduled task ran in RFC 3339 format.
943
943
  */
944
- lastRun?: string;
944
+ lastRun?: string | undefined;
945
945
  /**
946
946
  * The next scheduled run of the task in RFC 3339 format.
947
947
  */
@@ -994,7 +994,7 @@ type TaskV1 = {
994
994
  */
995
995
  destinationID: string;
996
996
  trigger: Trigger;
997
- input?: TaskInput;
997
+ input?: TaskInput | undefined;
998
998
  /**
999
999
  * Whether the task is enabled.
1000
1000
  */
@@ -1002,14 +1002,14 @@ type TaskV1 = {
1002
1002
  /**
1003
1003
  * Maximum accepted percentage of failures for a task run to finish successfully.
1004
1004
  */
1005
- failureThreshold?: number;
1006
- action?: ActionType;
1005
+ failureThreshold?: number | undefined;
1006
+ action?: ActionType | undefined;
1007
1007
  /**
1008
1008
  * Date of the last cursor in RFC 3339 format.
1009
1009
  */
1010
- cursor?: string;
1011
- notifications?: Notifications;
1012
- policies?: Policies;
1010
+ cursor?: string | undefined;
1011
+ notifications?: Notifications | undefined;
1012
+ policies?: Policies | undefined;
1013
1013
  /**
1014
1014
  * Date of creation in RFC 3339 format.
1015
1015
  */
@@ -1063,13 +1063,13 @@ type Transformation = {
1063
1063
  /**
1064
1064
  * The authentications associated with the current transformation.
1065
1065
  */
1066
- authenticationIDs?: Array<string>;
1066
+ authenticationIDs?: Array<string> | undefined;
1067
1067
  /**
1068
1068
  * It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code.
1069
1069
  */
1070
1070
  code: string;
1071
- type?: TransformationType;
1072
- input?: TransformationInput;
1071
+ type?: TransformationType | undefined;
1072
+ input?: TransformationInput | undefined;
1073
1073
  /**
1074
1074
  * The uniquely identified name of your transformation.
1075
1075
  */
@@ -1077,11 +1077,11 @@ type Transformation = {
1077
1077
  /**
1078
1078
  * A descriptive name for your transformation of what it does.
1079
1079
  */
1080
- description?: string;
1080
+ description?: string | undefined;
1081
1081
  /**
1082
1082
  * Owner of the resource.
1083
1083
  */
1084
- owner?: string | null;
1084
+ owner?: string | null | undefined;
1085
1085
  /**
1086
1086
  * Date of creation in RFC 3339 format.
1087
1087
  */
@@ -1136,17 +1136,17 @@ type Run = {
1136
1136
  */
1137
1137
  taskID: string;
1138
1138
  status: RunStatus;
1139
- progress?: RunProgress;
1140
- outcome?: RunOutcome;
1139
+ progress?: RunProgress | undefined;
1140
+ outcome?: RunOutcome | undefined;
1141
1141
  /**
1142
1142
  * Maximum accepted percentage of failures for a task run to finish successfully.
1143
1143
  */
1144
- failureThreshold?: number;
1144
+ failureThreshold?: number | undefined;
1145
1145
  /**
1146
1146
  * More information about the task run\'s outcome.
1147
1147
  */
1148
- reason?: string;
1149
- reasonCode?: RunReasonCode;
1148
+ reason?: string | undefined;
1149
+ reasonCode?: RunReasonCode | undefined;
1150
1150
  type: RunType;
1151
1151
  /**
1152
1152
  * Date of creation in RFC 3339 format.
@@ -1155,11 +1155,11 @@ type Run = {
1155
1155
  /**
1156
1156
  * Date of start in RFC 3339 format.
1157
1157
  */
1158
- startedAt?: string;
1158
+ startedAt?: string | undefined;
1159
1159
  /**
1160
1160
  * Date of finish in RFC 3339 format.
1161
1161
  */
1162
- finishedAt?: string;
1162
+ finishedAt?: string | undefined;
1163
1163
  };
1164
1164
 
1165
1165
  type RunListResponse = {
@@ -1201,11 +1201,11 @@ type SourceCreate = {
1201
1201
  * Descriptive name of the source.
1202
1202
  */
1203
1203
  name: string;
1204
- input?: SourceInput;
1204
+ input?: SourceInput | undefined;
1205
1205
  /**
1206
1206
  * Universally unique identifier (UUID) of an authentication resource.
1207
1207
  */
1208
- authenticationID?: string;
1208
+ authenticationID?: string | undefined;
1209
1209
  };
1210
1210
 
1211
1211
  type SourceCreateResponse = {
@@ -1255,26 +1255,26 @@ type TaskCreate = {
1255
1255
  */
1256
1256
  destinationID: string;
1257
1257
  action: ActionType;
1258
- subscriptionAction?: ActionType;
1258
+ subscriptionAction?: ActionType | undefined;
1259
1259
  /**
1260
1260
  * Cron expression for the task\'s schedule.
1261
1261
  */
1262
- cron?: string;
1262
+ cron?: string | undefined;
1263
1263
  /**
1264
1264
  * Whether the task is enabled.
1265
1265
  */
1266
- enabled?: boolean;
1266
+ enabled?: boolean | undefined;
1267
1267
  /**
1268
1268
  * Maximum accepted percentage of failures for a task run to finish successfully.
1269
1269
  */
1270
- failureThreshold?: number;
1271
- input?: TaskInput;
1270
+ failureThreshold?: number | undefined;
1271
+ input?: TaskInput | undefined;
1272
1272
  /**
1273
1273
  * Date of the last cursor in RFC 3339 format.
1274
1274
  */
1275
- cursor?: string;
1276
- notifications?: Notifications;
1277
- policies?: Policies;
1275
+ cursor?: string | undefined;
1276
+ notifications?: Notifications | undefined;
1277
+ policies?: Policies | undefined;
1278
1278
  };
1279
1279
 
1280
1280
  /**
@@ -1328,16 +1328,16 @@ type TaskCreateV1 = {
1328
1328
  /**
1329
1329
  * Whether the task is enabled.
1330
1330
  */
1331
- enabled?: boolean;
1331
+ enabled?: boolean | undefined;
1332
1332
  /**
1333
1333
  * Maximum accepted percentage of failures for a task run to finish successfully.
1334
1334
  */
1335
- failureThreshold?: number;
1336
- input?: TaskInput;
1335
+ failureThreshold?: number | undefined;
1336
+ input?: TaskInput | undefined;
1337
1337
  /**
1338
1338
  * Date of the last cursor in RFC 3339 format.
1339
1339
  */
1340
- cursor?: string;
1340
+ cursor?: string | undefined;
1341
1341
  };
1342
1342
 
1343
1343
  type TaskSearch = {
@@ -1365,21 +1365,21 @@ type TransformationCreate = {
1365
1365
  /**
1366
1366
  * It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code.
1367
1367
  */
1368
- code?: string;
1368
+ code?: string | undefined;
1369
1369
  /**
1370
1370
  * The uniquely identified name of your transformation.
1371
1371
  */
1372
1372
  name: string;
1373
- type: TransformationType;
1374
- input: TransformationInput;
1373
+ type?: TransformationType | undefined;
1374
+ input?: TransformationInput | undefined;
1375
1375
  /**
1376
1376
  * A descriptive name for your transformation of what it does.
1377
1377
  */
1378
- description?: string;
1378
+ description?: string | undefined;
1379
1379
  /**
1380
1380
  * The authentications associated with the current transformation.
1381
1381
  */
1382
- authenticationIDs?: Array<string>;
1382
+ authenticationIDs?: Array<string> | undefined;
1383
1383
  };
1384
1384
 
1385
1385
  /**
@@ -1404,12 +1404,14 @@ type TransformationTry = {
1404
1404
  /**
1405
1405
  * It is deprecated. Use the `input` field with proper `type` instead to specify the transformation code.
1406
1406
  */
1407
- code: string;
1407
+ code?: string | undefined;
1408
+ type?: TransformationType | undefined;
1409
+ input?: TransformationInput | undefined;
1408
1410
  /**
1409
1411
  * The record to apply the given code to.
1410
1412
  */
1411
1413
  sampleRecord: Record<string, unknown>;
1412
- authentications?: Array<AuthenticationCreate>;
1414
+ authentications?: Array<AuthenticationCreate> | undefined;
1413
1415
  };
1414
1416
 
1415
1417
  /**
@@ -1419,11 +1421,11 @@ type TransformationError = {
1419
1421
  /**
1420
1422
  * The error status code.
1421
1423
  */
1422
- code?: number;
1424
+ code?: number | undefined;
1423
1425
  /**
1424
1426
  * A descriptive message explaining the failure.
1425
1427
  */
1426
- message?: string;
1428
+ message?: string | undefined;
1427
1429
  };
1428
1430
 
1429
1431
  type TransformationTryResponse = {
@@ -1431,7 +1433,7 @@ type TransformationTryResponse = {
1431
1433
  * The array of stringified records returned by the transformation service.
1432
1434
  */
1433
1435
  payloads: Array<string>;
1434
- error?: TransformationError;
1436
+ error?: TransformationError | undefined;
1435
1437
  };
1436
1438
 
1437
1439
  /**
@@ -1456,25 +1458,30 @@ type WatchResponse = {
1456
1458
  /**
1457
1459
  * Universally unique identifier (UUID) of an event.
1458
1460
  */
1459
- eventID?: string;
1461
+ eventID?: string | undefined;
1460
1462
  /**
1461
1463
  * This field is always null when used with the Push endpoint. When used for a source discover or source validate run, it will include the sampled data of the source.
1462
1464
  */
1463
- data?: Array<Record<string, unknown>>;
1465
+ data?: Array<Record<string, unknown>> | undefined;
1464
1466
  /**
1465
1467
  * in case of error, observability events will be added to the response.
1466
1468
  */
1467
- events?: Array<Event>;
1469
+ events?: Array<Event> | undefined;
1468
1470
  /**
1469
1471
  * a message describing the outcome of the operation that has been ran (push, discover or validate) run.
1470
1472
  */
1471
- message?: string;
1473
+ message?: string | undefined;
1472
1474
  /**
1473
1475
  * Date of creation in RFC 3339 format.
1474
1476
  */
1475
- createdAt?: string;
1477
+ createdAt?: string | undefined;
1476
1478
  };
1477
1479
 
1480
+ /**
1481
+ * Type of indexing operation.
1482
+ */
1483
+ type Action = 'addObject' | 'updateObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'deleteObject' | 'delete' | 'clear';
1484
+
1478
1485
  /**
1479
1486
  * Property by which to sort the list of authentications.
1480
1487
  */
@@ -1484,13 +1491,13 @@ type AuthenticationSortKeys = 'name' | 'type' | 'platform' | 'updatedAt' | 'crea
1484
1491
  * Request body for updating an authentication resource.
1485
1492
  */
1486
1493
  type AuthenticationUpdate = {
1487
- type?: AuthenticationType;
1494
+ type?: AuthenticationType | undefined;
1488
1495
  /**
1489
1496
  * Descriptive name for the resource.
1490
1497
  */
1491
- name?: string;
1492
- platform?: Platform | null;
1493
- input?: AuthInputPartial;
1498
+ name?: string | undefined;
1499
+ platform?: Platform | null | undefined;
1500
+ input?: AuthInputPartial | undefined;
1494
1501
  };
1495
1502
 
1496
1503
  /**
@@ -1502,17 +1509,17 @@ type DestinationSortKeys = 'name' | 'type' | 'updatedAt' | 'createdAt';
1502
1509
  * API request body for updating a destination.
1503
1510
  */
1504
1511
  type DestinationUpdate = {
1505
- type?: DestinationType;
1512
+ type?: DestinationType | undefined;
1506
1513
  /**
1507
1514
  * Descriptive name for the resource.
1508
1515
  */
1509
- name?: string;
1510
- input?: DestinationInput;
1516
+ name?: string | undefined;
1517
+ input?: DestinationInput | undefined;
1511
1518
  /**
1512
1519
  * Universally unique identifier (UUID) of an authentication resource.
1513
1520
  */
1514
- authenticationID?: string;
1515
- transformationIDs?: Array<string>;
1521
+ authenticationID?: string | undefined;
1522
+ transformationIDs?: Array<string> | undefined;
1516
1523
  };
1517
1524
 
1518
1525
  /**
@@ -1532,11 +1539,6 @@ type PlatformNone = 'none';
1532
1539
 
1533
1540
  type PlatformWithNone = Platform | PlatformNone;
1534
1541
 
1535
- /**
1536
- * Type of indexing operation.
1537
- */
1538
- type Action = 'addObject' | 'updateObject' | 'partialUpdateObject' | 'partialUpdateObjectNoCreate' | 'deleteObject' | 'delete' | 'clear';
1539
-
1540
1542
  type PushTaskRecords = Record<string, any> & {
1541
1543
  /**
1542
1544
  * Unique record identifier.
@@ -1563,16 +1565,16 @@ type RunSourcePayload = {
1563
1565
  /**
1564
1566
  * List of index names to include in reidexing/update.
1565
1567
  */
1566
- indexToInclude?: Array<string>;
1568
+ indexToInclude?: Array<string> | undefined;
1567
1569
  /**
1568
1570
  * List of index names to exclude in reidexing/update.
1569
1571
  */
1570
- indexToExclude?: Array<string>;
1572
+ indexToExclude?: Array<string> | undefined;
1571
1573
  /**
1572
1574
  * List of entityID to update.
1573
1575
  */
1574
- entityIDs?: Array<string>;
1575
- entityType?: EntityType;
1576
+ entityIDs?: Array<string> | undefined;
1577
+ entityType?: EntityType | undefined;
1576
1578
  };
1577
1579
 
1578
1580
  /**
@@ -1581,21 +1583,21 @@ type RunSourcePayload = {
1581
1583
  type SourceSortKeys = 'name' | 'type' | 'updatedAt' | 'createdAt';
1582
1584
 
1583
1585
  type SourceUpdateCommercetools = {
1584
- storeKeys?: Array<string>;
1586
+ storeKeys?: Array<string> | undefined;
1585
1587
  /**
1586
1588
  * Locales for your commercetools stores.
1587
1589
  */
1588
- locales?: Array<string>;
1589
- url?: string;
1590
+ locales?: Array<string> | undefined;
1591
+ url?: string | undefined;
1590
1592
  /**
1591
1593
  * Whether a fallback value is stored in the Algolia record if there\'s no inventory information about the product.
1592
1594
  */
1593
- fallbackIsInStockValue?: boolean;
1595
+ fallbackIsInStockValue?: boolean | undefined;
1594
1596
  /**
1595
1597
  * Predicate to filter out specific products when indexing. For more information, see [Query Predicate](https://docs.commercetools.com/api/predicates/query).
1596
1598
  */
1597
- productQueryPredicate?: string;
1598
- customFields?: CommercetoolsCustomFields;
1599
+ productQueryPredicate?: string | undefined;
1600
+ customFields?: CommercetoolsCustomFields | undefined;
1599
1601
  };
1600
1602
 
1601
1603
  type SourceUpdateDocker = {
@@ -1611,12 +1613,12 @@ type SourceUpdate = {
1611
1613
  /**
1612
1614
  * Descriptive name of the source.
1613
1615
  */
1614
- name?: string;
1615
- input?: SourceUpdateInput;
1616
+ name?: string | undefined;
1617
+ input?: SourceUpdateInput | undefined;
1616
1618
  /**
1617
1619
  * Universally unique identifier (UUID) of an authentication resource.
1618
1620
  */
1619
- authenticationID?: string;
1621
+ authenticationID?: string | undefined;
1620
1622
  };
1621
1623
 
1622
1624
  /**
@@ -1631,23 +1633,23 @@ type TaskUpdate = {
1631
1633
  /**
1632
1634
  * Universally unique identifier (UUID) of a destination resource.
1633
1635
  */
1634
- destinationID?: string;
1636
+ destinationID?: string | undefined;
1635
1637
  /**
1636
1638
  * Cron expression for the task\'s schedule.
1637
1639
  */
1638
- cron?: string;
1639
- input?: TaskInput;
1640
+ cron?: string | undefined;
1641
+ input?: TaskInput | undefined;
1640
1642
  /**
1641
1643
  * Whether the task is enabled.
1642
1644
  */
1643
- enabled?: boolean;
1644
- subscriptionAction?: ActionType;
1645
+ enabled?: boolean | undefined;
1646
+ subscriptionAction?: ActionType | undefined;
1645
1647
  /**
1646
1648
  * Maximum accepted percentage of failures for a task run to finish successfully.
1647
1649
  */
1648
- failureThreshold?: number;
1649
- notifications?: Notifications;
1650
- policies?: Policies;
1650
+ failureThreshold?: number | undefined;
1651
+ notifications?: Notifications | undefined;
1652
+ policies?: Policies | undefined;
1651
1653
  };
1652
1654
 
1653
1655
  /**
@@ -1667,17 +1669,17 @@ type TaskUpdateV1 = {
1667
1669
  /**
1668
1670
  * Universally unique identifier (UUID) of a destination resource.
1669
1671
  */
1670
- destinationID?: string;
1671
- trigger?: TriggerUpdateInput;
1672
- input?: TaskInput;
1672
+ destinationID?: string | undefined;
1673
+ trigger?: TriggerUpdateInput | undefined;
1674
+ input?: TaskInput | undefined;
1673
1675
  /**
1674
1676
  * Whether the task is enabled.
1675
1677
  */
1676
- enabled?: boolean;
1678
+ enabled?: boolean | undefined;
1677
1679
  /**
1678
1680
  * Maximum accepted percentage of failures for a task run to finish successfully.
1679
1681
  */
1680
- failureThreshold?: number;
1682
+ failureThreshold?: number | undefined;
1681
1683
  };
1682
1684
 
1683
1685
  /**
@@ -1695,7 +1697,7 @@ type TriggerType = 'onDemand' | 'schedule' | 'subscription' | 'streaming';
1695
1697
  */
1696
1698
  type CustomDeleteProps = {
1697
1699
  /**
1698
- * Path of the endpoint, anything after \"/1\" must be specified.
1700
+ * Path of the endpoint, for example `1/newFeature`.
1699
1701
  */
1700
1702
  path: string;
1701
1703
  /**
@@ -1703,14 +1705,14 @@ type CustomDeleteProps = {
1703
1705
  */
1704
1706
  parameters?: {
1705
1707
  [key: string]: any;
1706
- };
1708
+ } | undefined;
1707
1709
  };
1708
1710
  /**
1709
1711
  * Properties for the `customGet` method.
1710
1712
  */
1711
1713
  type CustomGetProps = {
1712
1714
  /**
1713
- * Path of the endpoint, anything after \"/1\" must be specified.
1715
+ * Path of the endpoint, for example `1/newFeature`.
1714
1716
  */
1715
1717
  path: string;
1716
1718
  /**
@@ -1718,14 +1720,14 @@ type CustomGetProps = {
1718
1720
  */
1719
1721
  parameters?: {
1720
1722
  [key: string]: any;
1721
- };
1723
+ } | undefined;
1722
1724
  };
1723
1725
  /**
1724
1726
  * Properties for the `customPost` method.
1725
1727
  */
1726
1728
  type CustomPostProps = {
1727
1729
  /**
1728
- * Path of the endpoint, anything after \"/1\" must be specified.
1730
+ * Path of the endpoint, for example `1/newFeature`.
1729
1731
  */
1730
1732
  path: string;
1731
1733
  /**
@@ -1733,18 +1735,18 @@ type CustomPostProps = {
1733
1735
  */
1734
1736
  parameters?: {
1735
1737
  [key: string]: any;
1736
- };
1738
+ } | undefined;
1737
1739
  /**
1738
1740
  * Parameters to send with the custom request.
1739
1741
  */
1740
- body?: Record<string, unknown>;
1742
+ body?: Record<string, unknown> | undefined;
1741
1743
  };
1742
1744
  /**
1743
1745
  * Properties for the `customPut` method.
1744
1746
  */
1745
1747
  type CustomPutProps = {
1746
1748
  /**
1747
- * Path of the endpoint, anything after \"/1\" must be specified.
1749
+ * Path of the endpoint, for example `1/newFeature`.
1748
1750
  */
1749
1751
  path: string;
1750
1752
  /**
@@ -1752,11 +1754,11 @@ type CustomPutProps = {
1752
1754
  */
1753
1755
  parameters?: {
1754
1756
  [key: string]: any;
1755
- };
1757
+ } | undefined;
1756
1758
  /**
1757
1759
  * Parameters to send with the custom request.
1758
1760
  */
1759
- body?: Record<string, unknown>;
1761
+ body?: Record<string, unknown> | undefined;
1760
1762
  };
1761
1763
  /**
1762
1764
  * Properties for the `deleteAuthentication` method.
@@ -1931,27 +1933,27 @@ type ListAuthenticationsProps = {
1931
1933
  /**
1932
1934
  * Number of items per page.
1933
1935
  */
1934
- itemsPerPage?: number;
1936
+ itemsPerPage?: number | undefined;
1935
1937
  /**
1936
1938
  * Page number of the paginated API response.
1937
1939
  */
1938
- page?: number;
1940
+ page?: number | undefined;
1939
1941
  /**
1940
1942
  * Type of authentication resource to retrieve.
1941
1943
  */
1942
- type?: Array<AuthenticationType>;
1944
+ type?: Array<AuthenticationType> | undefined;
1943
1945
  /**
1944
1946
  * Ecommerce platform for which to retrieve authentications.
1945
1947
  */
1946
- platform?: Array<PlatformWithNone>;
1948
+ platform?: Array<PlatformWithNone> | undefined;
1947
1949
  /**
1948
1950
  * Property by which to sort the list of authentications.
1949
1951
  */
1950
- sort?: AuthenticationSortKeys;
1952
+ sort?: AuthenticationSortKeys | undefined;
1951
1953
  /**
1952
1954
  * Sort order of the response, ascending or descending.
1953
1955
  */
1954
- order?: OrderKeys;
1956
+ order?: OrderKeys | undefined;
1955
1957
  };
1956
1958
  /**
1957
1959
  * Properties for the `listDestinations` method.
@@ -1960,31 +1962,31 @@ type ListDestinationsProps = {
1960
1962
  /**
1961
1963
  * Number of items per page.
1962
1964
  */
1963
- itemsPerPage?: number;
1965
+ itemsPerPage?: number | undefined;
1964
1966
  /**
1965
1967
  * Page number of the paginated API response.
1966
1968
  */
1967
- page?: number;
1969
+ page?: number | undefined;
1968
1970
  /**
1969
1971
  * Destination type.
1970
1972
  */
1971
- type?: Array<DestinationType>;
1973
+ type?: Array<DestinationType> | undefined;
1972
1974
  /**
1973
1975
  * Authentication ID used by destinations.
1974
1976
  */
1975
- authenticationID?: Array<string>;
1977
+ authenticationID?: Array<string> | undefined;
1976
1978
  /**
1977
1979
  * Get the list of destinations used by a transformation.
1978
1980
  */
1979
- transformationID?: string;
1981
+ transformationID?: string | undefined;
1980
1982
  /**
1981
1983
  * Property by which to sort the destinations.
1982
1984
  */
1983
- sort?: DestinationSortKeys;
1985
+ sort?: DestinationSortKeys | undefined;
1984
1986
  /**
1985
1987
  * Sort order of the response, ascending or descending.
1986
1988
  */
1987
- order?: OrderKeys;
1989
+ order?: OrderKeys | undefined;
1988
1990
  };
1989
1991
  /**
1990
1992
  * Properties for the `listEvents` method.
@@ -1997,35 +1999,35 @@ type ListEventsProps = {
1997
1999
  /**
1998
2000
  * Number of items per page.
1999
2001
  */
2000
- itemsPerPage?: number;
2002
+ itemsPerPage?: number | undefined;
2001
2003
  /**
2002
2004
  * Page number of the paginated API response.
2003
2005
  */
2004
- page?: number;
2006
+ page?: number | undefined;
2005
2007
  /**
2006
2008
  * Event status for filtering the list of task runs.
2007
2009
  */
2008
- status?: Array<EventStatus>;
2010
+ status?: Array<EventStatus> | undefined;
2009
2011
  /**
2010
2012
  * Event type for filtering the list of task runs.
2011
2013
  */
2012
- type?: Array<EventType>;
2014
+ type?: Array<EventType> | undefined;
2013
2015
  /**
2014
2016
  * Property by which to sort the list of task run events.
2015
2017
  */
2016
- sort?: EventSortKeys;
2018
+ sort?: EventSortKeys | undefined;
2017
2019
  /**
2018
2020
  * Sort order of the response, ascending or descending.
2019
2021
  */
2020
- order?: OrderKeys;
2022
+ order?: OrderKeys | undefined;
2021
2023
  /**
2022
2024
  * Date and time in RFC 3339 format for the earliest events to retrieve. By default, the current time minus three hours is used.
2023
2025
  */
2024
- startDate?: string;
2026
+ startDate?: string | undefined;
2025
2027
  /**
2026
2028
  * Date and time in RFC 3339 format for the latest events to retrieve. By default, the current time is used.
2027
2029
  */
2028
- endDate?: string;
2030
+ endDate?: string | undefined;
2029
2031
  };
2030
2032
  /**
2031
2033
  * Properties for the `listRuns` method.
@@ -2034,39 +2036,39 @@ type ListRunsProps = {
2034
2036
  /**
2035
2037
  * Number of items per page.
2036
2038
  */
2037
- itemsPerPage?: number;
2039
+ itemsPerPage?: number | undefined;
2038
2040
  /**
2039
2041
  * Page number of the paginated API response.
2040
2042
  */
2041
- page?: number;
2043
+ page?: number | undefined;
2042
2044
  /**
2043
2045
  * Run status for filtering the list of task runs.
2044
2046
  */
2045
- status?: Array<RunStatus>;
2047
+ status?: Array<RunStatus> | undefined;
2046
2048
  /**
2047
2049
  * Run type for filtering the list of task runs.
2048
2050
  */
2049
- type?: Array<RunType>;
2051
+ type?: Array<RunType> | undefined;
2050
2052
  /**
2051
2053
  * Task ID for filtering the list of task runs.
2052
2054
  */
2053
- taskID?: string;
2055
+ taskID?: string | undefined;
2054
2056
  /**
2055
2057
  * Property by which to sort the list of task runs.
2056
2058
  */
2057
- sort?: RunSortKeys;
2059
+ sort?: RunSortKeys | undefined;
2058
2060
  /**
2059
2061
  * Sort order of the response, ascending or descending.
2060
2062
  */
2061
- order?: OrderKeys;
2063
+ order?: OrderKeys | undefined;
2062
2064
  /**
2063
2065
  * Date in RFC 3339 format for the earliest run to retrieve. By default, the current day minus seven days is used.
2064
2066
  */
2065
- startDate?: string;
2067
+ startDate?: string | undefined;
2066
2068
  /**
2067
2069
  * Date in RFC 3339 format for the latest run to retrieve. By default, the current day is used.
2068
2070
  */
2069
- endDate?: string;
2071
+ endDate?: string | undefined;
2070
2072
  };
2071
2073
  /**
2072
2074
  * Properties for the `listSources` method.
@@ -2075,27 +2077,27 @@ type ListSourcesProps = {
2075
2077
  /**
2076
2078
  * Number of items per page.
2077
2079
  */
2078
- itemsPerPage?: number;
2080
+ itemsPerPage?: number | undefined;
2079
2081
  /**
2080
2082
  * Page number of the paginated API response.
2081
2083
  */
2082
- page?: number;
2084
+ page?: number | undefined;
2083
2085
  /**
2084
2086
  * Source type. Some sources require authentication.
2085
2087
  */
2086
- type?: Array<SourceType>;
2088
+ type?: Array<SourceType> | undefined;
2087
2089
  /**
2088
2090
  * Authentication IDs of the sources to retrieve. \'none\' returns sources that doesn\'t have an authentication.
2089
2091
  */
2090
- authenticationID?: Array<string>;
2092
+ authenticationID?: Array<string> | undefined;
2091
2093
  /**
2092
2094
  * Property by which to sort the list of sources.
2093
2095
  */
2094
- sort?: SourceSortKeys;
2096
+ sort?: SourceSortKeys | undefined;
2095
2097
  /**
2096
2098
  * Sort order of the response, ascending or descending.
2097
2099
  */
2098
- order?: OrderKeys;
2100
+ order?: OrderKeys | undefined;
2099
2101
  };
2100
2102
  /**
2101
2103
  * Properties for the `listTasks` method.
@@ -2104,47 +2106,47 @@ type ListTasksProps = {
2104
2106
  /**
2105
2107
  * Number of items per page.
2106
2108
  */
2107
- itemsPerPage?: number;
2109
+ itemsPerPage?: number | undefined;
2108
2110
  /**
2109
2111
  * Page number of the paginated API response.
2110
2112
  */
2111
- page?: number;
2113
+ page?: number | undefined;
2112
2114
  /**
2113
2115
  * Actions for filtering the list of tasks.
2114
2116
  */
2115
- action?: Array<ActionType>;
2117
+ action?: Array<ActionType> | undefined;
2116
2118
  /**
2117
2119
  * Whether to filter the list of tasks by the `enabled` status.
2118
2120
  */
2119
- enabled?: boolean;
2121
+ enabled?: boolean | undefined;
2120
2122
  /**
2121
2123
  * Source IDs for filtering the list of tasks.
2122
2124
  */
2123
- sourceID?: Array<string>;
2125
+ sourceID?: Array<string> | undefined;
2124
2126
  /**
2125
2127
  * Filters the tasks with the specified source type.
2126
2128
  */
2127
- sourceType?: Array<SourceType>;
2129
+ sourceType?: Array<SourceType> | undefined;
2128
2130
  /**
2129
2131
  * Destination IDs for filtering the list of tasks.
2130
2132
  */
2131
- destinationID?: Array<string>;
2133
+ destinationID?: Array<string> | undefined;
2132
2134
  /**
2133
2135
  * Type of task trigger for filtering the list of tasks.
2134
2136
  */
2135
- triggerType?: Array<TriggerType>;
2137
+ triggerType?: Array<TriggerType> | undefined;
2136
2138
  /**
2137
2139
  * If specified, the response only includes tasks with notifications.email.enabled set to this value.
2138
2140
  */
2139
- withEmailNotifications?: boolean;
2141
+ withEmailNotifications?: boolean | undefined;
2140
2142
  /**
2141
2143
  * Property by which to sort the list of tasks.
2142
2144
  */
2143
- sort?: TaskSortKeys;
2145
+ sort?: TaskSortKeys | undefined;
2144
2146
  /**
2145
2147
  * Sort order of the response, ascending or descending.
2146
2148
  */
2147
- order?: OrderKeys;
2149
+ order?: OrderKeys | undefined;
2148
2150
  };
2149
2151
  /**
2150
2152
  * Properties for the `listTasksV1` method.
@@ -2153,39 +2155,39 @@ type ListTasksV1Props = {
2153
2155
  /**
2154
2156
  * Number of items per page.
2155
2157
  */
2156
- itemsPerPage?: number;
2158
+ itemsPerPage?: number | undefined;
2157
2159
  /**
2158
2160
  * Page number of the paginated API response.
2159
2161
  */
2160
- page?: number;
2162
+ page?: number | undefined;
2161
2163
  /**
2162
2164
  * Actions for filtering the list of tasks.
2163
2165
  */
2164
- action?: Array<ActionType>;
2166
+ action?: Array<ActionType> | undefined;
2165
2167
  /**
2166
2168
  * Whether to filter the list of tasks by the `enabled` status.
2167
2169
  */
2168
- enabled?: boolean;
2170
+ enabled?: boolean | undefined;
2169
2171
  /**
2170
2172
  * Source IDs for filtering the list of tasks.
2171
2173
  */
2172
- sourceID?: Array<string>;
2174
+ sourceID?: Array<string> | undefined;
2173
2175
  /**
2174
2176
  * Destination IDs for filtering the list of tasks.
2175
2177
  */
2176
- destinationID?: Array<string>;
2178
+ destinationID?: Array<string> | undefined;
2177
2179
  /**
2178
2180
  * Type of task trigger for filtering the list of tasks.
2179
2181
  */
2180
- triggerType?: Array<TriggerType>;
2182
+ triggerType?: Array<TriggerType> | undefined;
2181
2183
  /**
2182
2184
  * Property by which to sort the list of tasks.
2183
2185
  */
2184
- sort?: TaskSortKeys;
2186
+ sort?: TaskSortKeys | undefined;
2185
2187
  /**
2186
2188
  * Sort order of the response, ascending or descending.
2187
2189
  */
2188
- order?: OrderKeys;
2190
+ order?: OrderKeys | undefined;
2189
2191
  };
2190
2192
  /**
2191
2193
  * Properties for the `listTransformations` method.
@@ -2194,19 +2196,19 @@ type ListTransformationsProps = {
2194
2196
  /**
2195
2197
  * Number of items per page.
2196
2198
  */
2197
- itemsPerPage?: number;
2199
+ itemsPerPage?: number | undefined;
2198
2200
  /**
2199
2201
  * Page number of the paginated API response.
2200
2202
  */
2201
- page?: number;
2203
+ page?: number | undefined;
2202
2204
  /**
2203
2205
  * Property by which to sort the list of transformations.
2204
2206
  */
2205
- sort?: TransformationSortKeys;
2207
+ sort?: TransformationSortKeys | undefined;
2206
2208
  /**
2207
2209
  * Sort order of the response, ascending or descending.
2208
2210
  */
2209
- order?: OrderKeys;
2211
+ order?: OrderKeys | undefined;
2210
2212
  };
2211
2213
  /**
2212
2214
  * Properties for the `push` method.
@@ -2220,7 +2222,11 @@ type PushProps = {
2220
2222
  /**
2221
2223
  * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
2222
2224
  */
2223
- watch?: boolean;
2225
+ watch?: boolean | undefined;
2226
+ /**
2227
+ * This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index\'s transformation to it (e.g. the source index name).
2228
+ */
2229
+ referenceIndexName?: string | undefined;
2224
2230
  };
2225
2231
  /**
2226
2232
  * Properties for the `pushTask` method.
@@ -2234,7 +2240,7 @@ type PushTaskProps = {
2234
2240
  /**
2235
2241
  * When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
2236
2242
  */
2237
- watch?: boolean;
2243
+ watch?: boolean | undefined;
2238
2244
  };
2239
2245
  /**
2240
2246
  * Properties for the `runSource` method.
@@ -2247,7 +2253,7 @@ type RunSourceProps = {
2247
2253
  /**
2248
2254
  *
2249
2255
  */
2250
- runSourcePayload?: RunSourcePayload;
2256
+ runSourcePayload?: RunSourcePayload | undefined;
2251
2257
  };
2252
2258
  /**
2253
2259
  * Properties for the `runTask` method.
@@ -2356,8 +2362,34 @@ type ValidateSourceBeforeUpdateProps = {
2356
2362
  sourceID: string;
2357
2363
  sourceUpdate: SourceUpdate;
2358
2364
  };
2365
+ type ChunkedPushOptions = {
2366
+ /**
2367
+ * The `indexName` to replace `objects` in.
2368
+ */
2369
+ indexName: string;
2370
+ /**
2371
+ * The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
2372
+ */
2373
+ action?: Action | undefined;
2374
+ /**
2375
+ * Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
2376
+ */
2377
+ waitForTasks?: boolean | undefined;
2378
+ /**
2379
+ * The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
2380
+ */
2381
+ batchSize?: number | undefined;
2382
+ /**
2383
+ * This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
2384
+ */
2385
+ referenceIndexName?: string | undefined;
2386
+ /**
2387
+ * The array of `objects` to store in the given Algolia `indexName`.
2388
+ */
2389
+ objects: Array<Record<string, unknown>>;
2390
+ };
2359
2391
 
2360
- declare const apiClientVersion = "1.27.0";
2392
+ declare const apiClientVersion = "1.29.0";
2361
2393
  declare const REGIONS: readonly ["eu", "us"];
2362
2394
  type Region = (typeof REGIONS)[number];
2363
2395
  type RegionOptions = {
@@ -2408,7 +2440,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2408
2440
  * @param segment - The algolia agent (user-agent) segment to add.
2409
2441
  * @param version - The version of the agent.
2410
2442
  */
2411
- addAlgoliaAgent(segment: string, version?: string): void;
2443
+ addAlgoliaAgent(segment: string, version?: string | undefined): void;
2412
2444
  /**
2413
2445
  * Helper method to switch the API key used to authenticate the requests.
2414
2446
  *
@@ -2418,6 +2450,20 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2418
2450
  setClientApiKey({ apiKey }: {
2419
2451
  apiKey: string;
2420
2452
  }): void;
2453
+ /**
2454
+ * Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `push` requests by leveraging the Transformation pipeline setup in the Push connector (https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/connectors/push/).
2455
+ *
2456
+ * @summary Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
2457
+ * @param chunkedPush - The `chunkedPush` object.
2458
+ * @param chunkedPush.indexName - The `indexName` to replace `objects` in.
2459
+ * @param chunkedPush.objects - The array of `objects` to store in the given Algolia `indexName`.
2460
+ * @param chunkedPush.action - The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
2461
+ * @param chunkedPush.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
2462
+ * @param chunkedPush.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
2463
+ * @param chunkedPush.referenceIndexName - This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index's transformation to it (e.g. the source index name).
2464
+ * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getEvent` method and merged with the transporter requestOptions.
2465
+ */
2466
+ chunkedPush({ indexName, objects, action, waitForTasks, batchSize, referenceIndexName, }: ChunkedPushOptions, requestOptions?: RequestOptions): Promise<Array<WatchResponse>>;
2421
2467
  /**
2422
2468
  * Creates a new authentication resource.
2423
2469
  *
@@ -2474,7 +2520,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2474
2520
  /**
2475
2521
  * This method lets you send requests to the Algolia REST API.
2476
2522
  * @param customDelete - The customDelete object.
2477
- * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
2523
+ * @param customDelete.path - Path of the endpoint, for example `1/newFeature`.
2478
2524
  * @param customDelete.parameters - Query parameters to apply to the current query.
2479
2525
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2480
2526
  */
@@ -2482,7 +2528,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2482
2528
  /**
2483
2529
  * This method lets you send requests to the Algolia REST API.
2484
2530
  * @param customGet - The customGet object.
2485
- * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
2531
+ * @param customGet.path - Path of the endpoint, for example `1/newFeature`.
2486
2532
  * @param customGet.parameters - Query parameters to apply to the current query.
2487
2533
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2488
2534
  */
@@ -2490,7 +2536,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2490
2536
  /**
2491
2537
  * This method lets you send requests to the Algolia REST API.
2492
2538
  * @param customPost - The customPost object.
2493
- * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
2539
+ * @param customPost.path - Path of the endpoint, for example `1/newFeature`.
2494
2540
  * @param customPost.parameters - Query parameters to apply to the current query.
2495
2541
  * @param customPost.body - Parameters to send with the custom request.
2496
2542
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2499,7 +2545,7 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2499
2545
  /**
2500
2546
  * This method lets you send requests to the Algolia REST API.
2501
2547
  * @param customPut - The customPut object.
2502
- * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
2548
+ * @param customPut.path - Path of the endpoint, for example `1/newFeature`.
2503
2549
  * @param customPut.parameters - Query parameters to apply to the current query.
2504
2550
  * @param customPut.body - Parameters to send with the custom request.
2505
2551
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
@@ -2877,9 +2923,10 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
2877
2923
  * @param push.indexName - Name of the index on which to perform the operation.
2878
2924
  * @param push.pushTaskPayload - The pushTaskPayload object.
2879
2925
  * @param push.watch - When provided, the push operation will be synchronous and the API will wait for the ingestion to be finished before responding.
2926
+ * @param push.referenceIndexName - This is required when targeting an index that does not have a push connector setup (e.g. a tmp index), but you wish to attach another index\'s transformation to it (e.g. the source index name).
2880
2927
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
2881
2928
  */
2882
- push({ indexName, pushTaskPayload, watch }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
2929
+ push({ indexName, pushTaskPayload, watch, referenceIndexName }: PushProps, requestOptions?: RequestOptions): Promise<WatchResponse>;
2883
2930
  /**
2884
2931
  * Pushes records through the Pipeline, directly to an index. You can make the call synchronous by providing the `watch` parameter, for asynchronous calls, you can use the observability endpoints and/or debugger dashboard to see the status of your task. If you want to leverage the [pre-indexing data transformation](https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/), this is the recommended way of ingesting your records. This method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.
2885
2932
  *
@@ -3132,11 +3179,11 @@ declare function createIngestionClient({ appId: appIdOption, apiKey: apiKeyOptio
3132
3179
  * Error.
3133
3180
  */
3134
3181
  type ErrorBase = Record<string, any> & {
3135
- message?: string;
3182
+ message?: string | undefined;
3136
3183
  };
3137
3184
 
3138
3185
  type IngestionClient = ReturnType<typeof createIngestionClient>;
3139
3186
 
3140
- declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions): IngestionClient;
3187
+ declare function ingestionClient(appId: string, apiKey: string, region: Region, options?: ClientOptions | undefined): IngestionClient;
3141
3188
 
3142
- export { type Action, type ActionType, type AuthAPIKey, type AuthAPIKeyPartial, type AuthAlgolia, type AuthAlgoliaInsights, type AuthAlgoliaInsightsPartial, type AuthAlgoliaPartial, type AuthBasic, type AuthBasicPartial, type AuthGoogleServiceAccount, type AuthGoogleServiceAccountPartial, type AuthInput, type AuthInputPartial, type AuthOAuth, type AuthOAuthPartial, type Authentication, type AuthenticationCreate, type AuthenticationCreateResponse, type AuthenticationSearch, type AuthenticationSortKeys, type AuthenticationType, type AuthenticationUpdate, type AuthenticationUpdateResponse, type BigCommerceChannel, type BigCommerceMetafield, type BigQueryDataType, type CommercetoolsCustomFields, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteAuthenticationProps, type DeleteDestinationProps, type DeleteResponse, type DeleteSourceProps, type DeleteTaskProps, type DeleteTaskV1Props, type DeleteTransformationProps, type Destination, type DestinationCreate, type DestinationCreateResponse, type DestinationInput, type DestinationSearch, type DestinationSortKeys, type DestinationType, type DestinationUpdate, type DestinationUpdateResponse, type DisableTaskProps, type DisableTaskV1Props, type DockerStreams, type DockerStreamsInput, type DockerStreamsSyncMode, type EmailNotifications, type EnableTaskProps, type EnableTaskV1Props, type EntityType, type ErrorBase, type Event, type EventSortKeys, type EventStatus, type EventType, type GetAuthenticationProps, type GetDestinationProps, type GetEventProps, type GetRunProps, type GetSourceProps, type GetTaskProps, type GetTaskV1Props, type GetTransformationProps, type IngestionClient, type ListAuthenticationsProps, type ListAuthenticationsResponse, type ListDestinationsProps, type ListDestinationsResponse, type ListEventsProps, type ListEventsResponse, type ListRunsProps, type ListSourcesProps, type ListSourcesResponse, type ListTasksProps, type ListTasksResponse, type ListTasksResponseV1, type ListTasksV1Props, type ListTransformationsProps, type ListTransformationsResponse, type MappingFieldDirective, type MappingFormatSchema, type MappingInput, type MappingKitAction, type MappingTypeCSV, type MethodType, type Notifications, type OnDemandTrigger, type OnDemandTriggerInput, type OnDemandTriggerType, type OrderKeys, type Pagination, type Platform, type PlatformNone, type PlatformWithNone, type Policies, type PushProps, type PushTaskPayload, type PushTaskProps, type PushTaskRecords, type RecordType, type Region, type RegionOptions, type Run, type RunListResponse, type RunOutcome, type RunProgress, type RunReasonCode, type RunResponse, type RunSortKeys, type RunSourcePayload, type RunSourceProps, type RunSourceResponse, type RunStatus, type RunTaskProps, type RunTaskV1Props, type RunType, type ScheduleTrigger, type ScheduleTriggerInput, type ScheduleTriggerType, type ShopifyInput, type ShopifyMarket, type ShopifyMetafield, type Source, type SourceBigCommerce, type SourceBigQuery, type SourceCSV, type SourceCommercetools, type SourceCreate, type SourceCreateResponse, type SourceDocker, type SourceGA4BigQueryExport, type SourceInput, type SourceJSON, type SourceSearch, type SourceShopify, type SourceShopifyBase, type SourceSortKeys, type SourceType, type SourceUpdate, type SourceUpdateCommercetools, type SourceUpdateDocker, type SourceUpdateInput, type SourceUpdateResponse, type SourceUpdateShopify, type StreamingInput, type StreamingTrigger, type StreamingTriggerType, type SubscriptionTrigger, type SubscriptionTriggerType, type Task, type TaskCreate, type TaskCreateResponse, type TaskCreateTrigger, type TaskCreateV1, type TaskInput, type TaskSearch, type TaskSortKeys, type TaskUpdate, type TaskUpdateResponse, type TaskUpdateV1, type TaskV1, type Transformation, type TransformationCode, type TransformationCreate, type TransformationCreateResponse, type TransformationError, type TransformationInput, type TransformationNoCode, type TransformationSearch, type TransformationSortKeys, type TransformationTry, type TransformationTryResponse, type TransformationType, type TransformationUpdateResponse, type Trigger, type TriggerDockerSourceDiscoverProps, type TriggerType, type TriggerUpdateInput, type TryTransformationBeforeUpdateProps, type UpdateAuthenticationProps, type UpdateDestinationProps, type UpdateSourceProps, type UpdateTaskProps, type UpdateTaskV1Props, type UpdateTransformationProps, type ValidateSourceBeforeUpdateProps, type WatchResponse, type Window, apiClientVersion, ingestionClient, isOnDemandTrigger, isScheduleTrigger, isSubscriptionTrigger };
3189
+ export { type Action, type ActionType, type AuthAPIKey, type AuthAPIKeyPartial, type AuthAlgolia, type AuthAlgoliaInsights, type AuthAlgoliaInsightsPartial, type AuthAlgoliaPartial, type AuthBasic, type AuthBasicPartial, type AuthGoogleServiceAccount, type AuthGoogleServiceAccountPartial, type AuthInput, type AuthInputPartial, type AuthOAuth, type AuthOAuthPartial, type Authentication, type AuthenticationCreate, type AuthenticationCreateResponse, type AuthenticationSearch, type AuthenticationSortKeys, type AuthenticationType, type AuthenticationUpdate, type AuthenticationUpdateResponse, type BigCommerceChannel, type BigCommerceMetafield, type BigQueryDataType, type ChunkedPushOptions, type CommercetoolsCustomFields, type CustomDeleteProps, type CustomGetProps, type CustomPostProps, type CustomPutProps, type DeleteAuthenticationProps, type DeleteDestinationProps, type DeleteResponse, type DeleteSourceProps, type DeleteTaskProps, type DeleteTaskV1Props, type DeleteTransformationProps, type Destination, type DestinationCreate, type DestinationCreateResponse, type DestinationInput, type DestinationSearch, type DestinationSortKeys, type DestinationType, type DestinationUpdate, type DestinationUpdateResponse, type DisableTaskProps, type DisableTaskV1Props, type DockerStreams, type DockerStreamsInput, type DockerStreamsSyncMode, type EmailNotifications, type EnableTaskProps, type EnableTaskV1Props, type EntityType, type ErrorBase, type Event, type EventSortKeys, type EventStatus, type EventType, type GetAuthenticationProps, type GetDestinationProps, type GetEventProps, type GetRunProps, type GetSourceProps, type GetTaskProps, type GetTaskV1Props, type GetTransformationProps, type IngestionClient, type ListAuthenticationsProps, type ListAuthenticationsResponse, type ListDestinationsProps, type ListDestinationsResponse, type ListEventsProps, type ListEventsResponse, type ListRunsProps, type ListSourcesProps, type ListSourcesResponse, type ListTasksProps, type ListTasksResponse, type ListTasksResponseV1, type ListTasksV1Props, type ListTransformationsProps, type ListTransformationsResponse, type MappingFieldDirective, type MappingFormatSchema, type MappingInput, type MappingKitAction, type MappingTypeCSV, type MethodType, type Notifications, type OnDemandTrigger, type OnDemandTriggerInput, type OnDemandTriggerType, type OrderKeys, type Pagination, type Platform, type PlatformNone, type PlatformWithNone, type Policies, type PushProps, type PushTaskPayload, type PushTaskProps, type PushTaskRecords, type RecordType, type Region, type RegionOptions, type Run, type RunListResponse, type RunOutcome, type RunProgress, type RunReasonCode, type RunResponse, type RunSortKeys, type RunSourcePayload, type RunSourceProps, type RunSourceResponse, type RunStatus, type RunTaskProps, type RunTaskV1Props, type RunType, type ScheduleTrigger, type ScheduleTriggerInput, type ScheduleTriggerType, type ShopifyInput, type ShopifyMarket, type ShopifyMetafield, type Source, type SourceBigCommerce, type SourceBigQuery, type SourceCSV, type SourceCommercetools, type SourceCreate, type SourceCreateResponse, type SourceDocker, type SourceGA4BigQueryExport, type SourceInput, type SourceJSON, type SourceSearch, type SourceShopify, type SourceShopifyBase, type SourceSortKeys, type SourceType, type SourceUpdate, type SourceUpdateCommercetools, type SourceUpdateDocker, type SourceUpdateInput, type SourceUpdateResponse, type SourceUpdateShopify, type StreamingInput, type StreamingTrigger, type StreamingTriggerType, type SubscriptionTrigger, type SubscriptionTriggerType, type Task, type TaskCreate, type TaskCreateResponse, type TaskCreateTrigger, type TaskCreateV1, type TaskInput, type TaskSearch, type TaskSortKeys, type TaskUpdate, type TaskUpdateResponse, type TaskUpdateV1, type TaskV1, type Transformation, type TransformationCode, type TransformationCreate, type TransformationCreateResponse, type TransformationError, type TransformationInput, type TransformationNoCode, type TransformationSearch, type TransformationSortKeys, type TransformationTry, type TransformationTryResponse, type TransformationType, type TransformationUpdateResponse, type Trigger, type TriggerDockerSourceDiscoverProps, type TriggerType, type TriggerUpdateInput, type TryTransformationBeforeUpdateProps, type UpdateAuthenticationProps, type UpdateDestinationProps, type UpdateSourceProps, type UpdateTaskProps, type UpdateTaskV1Props, type UpdateTransformationProps, type ValidateSourceBeforeUpdateProps, type WatchResponse, type Window, apiClientVersion, ingestionClient, isOnDemandTrigger, isScheduleTrigger, isSubscriptionTrigger };