@algolia/n8n-nodes-algolia 0.6.0 → 0.7.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.
@@ -11,10 +11,7 @@
11
11
  "variables": {
12
12
  "region": {
13
13
  "description": "The region where your Algolia application is hosted.",
14
- "enum": [
15
- "eu",
16
- "us"
17
- ],
14
+ "enum": ["eu", "us"],
18
15
  "default": "us"
19
16
  }
20
17
  }
@@ -231,17 +228,11 @@
231
228
  },
232
229
  "/1/push/{indexName}": {
233
230
  "post": {
234
- "tags": [
235
- "tasks"
236
- ],
231
+ "tags": ["tasks"],
237
232
  "summary": "Push records by indexName",
238
- "description": "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.\nIf 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.\nThis method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.\n",
233
+ "description": "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.\nIf 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.\nThis method is similar to `pushTask`, but requires an `indexName` instead of a `taskID`. If zero or many tasks are found, an error will be returned.\n",
239
234
  "operationId": "push",
240
- "x-acl": [
241
- "addObject",
242
- "deleteIndex",
243
- "editSettings"
244
- ],
235
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
245
236
  "x-timeouts": {
246
237
  "connect": 180000,
247
238
  "read": 180000,
@@ -293,17 +284,11 @@
293
284
  },
294
285
  "/1/authentications": {
295
286
  "get": {
296
- "tags": [
297
- "authentications"
298
- ],
287
+ "tags": ["authentications"],
299
288
  "summary": "List authentication resources",
300
289
  "description": "Retrieves a list of all authentication resources.",
301
290
  "operationId": "listAuthentications",
302
- "x-acl": [
303
- "addObject",
304
- "deleteIndex",
305
- "editSettings"
306
- ],
291
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
307
292
  "parameters": [
308
293
  {
309
294
  "$ref": "#/components/parameters/itemsPerPage"
@@ -344,10 +329,7 @@
344
329
  "$ref": "#/components/schemas/Pagination"
345
330
  }
346
331
  },
347
- "required": [
348
- "authentications",
349
- "pagination"
350
- ]
332
+ "required": ["authentications", "pagination"]
351
333
  }
352
334
  }
353
335
  }
@@ -358,17 +340,11 @@
358
340
  }
359
341
  },
360
342
  "post": {
361
- "tags": [
362
- "authentications"
363
- ],
343
+ "tags": ["authentications"],
364
344
  "summary": "Create an authentication resource",
365
345
  "description": "Creates a new authentication resource.",
366
346
  "operationId": "createAuthentication",
367
- "x-acl": [
368
- "addObject",
369
- "deleteIndex",
370
- "editSettings"
371
- ],
347
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
372
348
  "requestBody": {
373
349
  "description": "",
374
350
  "content": {
@@ -399,17 +375,11 @@
399
375
  },
400
376
  "/1/authentications/search": {
401
377
  "post": {
402
- "tags": [
403
- "authentications"
404
- ],
378
+ "tags": ["authentications"],
405
379
  "summary": "Search for authentication resources",
406
380
  "description": "Searches for authentication resources.",
407
381
  "operationId": "searchAuthentications",
408
- "x-acl": [
409
- "addObject",
410
- "deleteIndex",
411
- "editSettings"
412
- ],
382
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
413
383
  "requestBody": {
414
384
  "content": {
415
385
  "application/json": {
@@ -443,17 +413,11 @@
443
413
  },
444
414
  "/1/authentications/{authenticationID}": {
445
415
  "get": {
446
- "tags": [
447
- "authentications"
448
- ],
416
+ "tags": ["authentications"],
449
417
  "summary": "Retrieve an authentication resource",
450
418
  "description": "Retrieves an authentication resource by its ID.",
451
419
  "operationId": "getAuthentication",
452
- "x-acl": [
453
- "addObject",
454
- "deleteIndex",
455
- "editSettings"
456
- ],
420
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
457
421
  "parameters": [
458
422
  {
459
423
  "$ref": "#/components/parameters/pathAuthenticationID"
@@ -476,17 +440,11 @@
476
440
  }
477
441
  },
478
442
  "patch": {
479
- "tags": [
480
- "authentications"
481
- ],
443
+ "tags": ["authentications"],
482
444
  "summary": "Update an authentication resource",
483
445
  "description": "Updates an authentication resource.",
484
446
  "operationId": "updateAuthentication",
485
- "x-acl": [
486
- "addObject",
487
- "deleteIndex",
488
- "editSettings"
489
- ],
447
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
490
448
  "parameters": [
491
449
  {
492
450
  "$ref": "#/components/parameters/pathAuthenticationID"
@@ -519,17 +477,11 @@
519
477
  }
520
478
  },
521
479
  "delete": {
522
- "tags": [
523
- "authentications"
524
- ],
480
+ "tags": ["authentications"],
525
481
  "summary": "Delete an authentication resource",
526
482
  "description": "Deletes an authentication resource. You can't delete authentication resources that are used by a source or a destination.",
527
483
  "operationId": "deleteAuthentication",
528
- "x-acl": [
529
- "addObject",
530
- "deleteIndex",
531
- "editSettings"
532
- ],
484
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
533
485
  "parameters": [
534
486
  {
535
487
  "$ref": "#/components/parameters/pathAuthenticationID"
@@ -554,18 +506,12 @@
554
506
  },
555
507
  "/1/destinations": {
556
508
  "get": {
557
- "tags": [
558
- "destinations"
559
- ],
509
+ "tags": ["destinations"],
560
510
  "summary": "List destinations",
561
511
  "description": "Retrieves a list of destinations.",
562
512
  "operationId": "listDestinations",
563
513
  "x-mcp-tool": true,
564
- "x-acl": [
565
- "addObject",
566
- "deleteIndex",
567
- "editSettings"
568
- ],
514
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
569
515
  "parameters": [
570
516
  {
571
517
  "$ref": "#/components/parameters/itemsPerPage"
@@ -609,10 +555,7 @@
609
555
  "$ref": "#/components/schemas/Pagination"
610
556
  }
611
557
  },
612
- "required": [
613
- "destinations",
614
- "pagination"
615
- ]
558
+ "required": ["destinations", "pagination"]
616
559
  }
617
560
  }
618
561
  }
@@ -623,17 +566,11 @@
623
566
  }
624
567
  },
625
568
  "post": {
626
- "tags": [
627
- "destinations"
628
- ],
569
+ "tags": ["destinations"],
629
570
  "summary": "Create a destination",
630
571
  "description": "Creates a new destination.",
631
572
  "operationId": "createDestination",
632
- "x-acl": [
633
- "addObject",
634
- "deleteIndex",
635
- "editSettings"
636
- ],
573
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
637
574
  "requestBody": {
638
575
  "description": "",
639
576
  "content": {
@@ -664,17 +601,11 @@
664
601
  },
665
602
  "/1/destinations/search": {
666
603
  "post": {
667
- "tags": [
668
- "destinations"
669
- ],
604
+ "tags": ["destinations"],
670
605
  "summary": "Search for destinations",
671
606
  "description": "Searches for destinations.",
672
607
  "operationId": "searchDestinations",
673
- "x-acl": [
674
- "addObject",
675
- "deleteIndex",
676
- "editSettings"
677
- ],
608
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
678
609
  "requestBody": {
679
610
  "content": {
680
611
  "application/json": {
@@ -708,17 +639,11 @@
708
639
  },
709
640
  "/1/destinations/{destinationID}": {
710
641
  "get": {
711
- "tags": [
712
- "destinations"
713
- ],
642
+ "tags": ["destinations"],
714
643
  "summary": "Retrieve a destination",
715
644
  "description": "Retrieves a destination by its ID.",
716
645
  "operationId": "getDestination",
717
- "x-acl": [
718
- "addObject",
719
- "deleteIndex",
720
- "editSettings"
721
- ],
646
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
722
647
  "parameters": [
723
648
  {
724
649
  "$ref": "#/components/parameters/pathDestinationID"
@@ -741,17 +666,11 @@
741
666
  }
742
667
  },
743
668
  "patch": {
744
- "tags": [
745
- "destinations"
746
- ],
669
+ "tags": ["destinations"],
747
670
  "summary": "Update a destination",
748
671
  "description": "Updates the destination by its ID.",
749
672
  "operationId": "updateDestination",
750
- "x-acl": [
751
- "addObject",
752
- "deleteIndex",
753
- "editSettings"
754
- ],
673
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
755
674
  "parameters": [
756
675
  {
757
676
  "$ref": "#/components/parameters/pathDestinationID"
@@ -784,17 +703,11 @@
784
703
  }
785
704
  },
786
705
  "delete": {
787
- "tags": [
788
- "destinations"
789
- ],
706
+ "tags": ["destinations"],
790
707
  "summary": "Delete a destination",
791
708
  "description": "Deletes a destination by its ID. You can't delete destinations that are referenced in tasks.",
792
709
  "operationId": "deleteDestination",
793
- "x-acl": [
794
- "addObject",
795
- "deleteIndex",
796
- "editSettings"
797
- ],
710
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
798
711
  "parameters": [
799
712
  {
800
713
  "$ref": "#/components/parameters/pathDestinationID"
@@ -819,18 +732,12 @@
819
732
  },
820
733
  "/1/sources": {
821
734
  "get": {
822
- "tags": [
823
- "sources"
824
- ],
735
+ "tags": ["sources"],
825
736
  "summary": "List sources",
826
737
  "description": "Retrieves a list of sources.",
827
738
  "operationId": "listSources",
828
739
  "x-mcp-tool": true,
829
- "x-acl": [
830
- "addObject",
831
- "deleteIndex",
832
- "editSettings"
833
- ],
740
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
834
741
  "parameters": [
835
742
  {
836
743
  "$ref": "#/components/parameters/itemsPerPage"
@@ -871,10 +778,7 @@
871
778
  "$ref": "#/components/schemas/Pagination"
872
779
  }
873
780
  },
874
- "required": [
875
- "sources",
876
- "pagination"
877
- ]
781
+ "required": ["sources", "pagination"]
878
782
  }
879
783
  }
880
784
  }
@@ -885,17 +789,11 @@
885
789
  }
886
790
  },
887
791
  "post": {
888
- "tags": [
889
- "sources"
890
- ],
792
+ "tags": ["sources"],
891
793
  "summary": "Create a source",
892
794
  "description": "Creates a new source.",
893
795
  "operationId": "createSource",
894
- "x-acl": [
895
- "addObject",
896
- "deleteIndex",
897
- "editSettings"
898
- ],
796
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
899
797
  "requestBody": {
900
798
  "description": "",
901
799
  "content": {
@@ -926,17 +824,11 @@
926
824
  },
927
825
  "/1/sources/validate": {
928
826
  "post": {
929
- "tags": [
930
- "sources"
931
- ],
827
+ "tags": ["sources"],
932
828
  "summary": "Validate a source payload",
933
829
  "description": "Validates a source payload to ensure it can be created and that the data source can be reached by Algolia.\n",
934
830
  "operationId": "validateSource",
935
- "x-acl": [
936
- "addObject",
937
- "deleteIndex",
938
- "editSettings"
939
- ],
831
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
940
832
  "x-timeouts": {
941
833
  "connect": 180000,
942
834
  "read": 180000,
@@ -971,17 +863,11 @@
971
863
  },
972
864
  "/1/sources/search": {
973
865
  "post": {
974
- "tags": [
975
- "sources"
976
- ],
866
+ "tags": ["sources"],
977
867
  "summary": "Search for sources",
978
868
  "description": "Searches for sources.",
979
869
  "operationId": "searchSources",
980
- "x-acl": [
981
- "addObject",
982
- "deleteIndex",
983
- "editSettings"
984
- ],
870
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
985
871
  "requestBody": {
986
872
  "content": {
987
873
  "application/json": {
@@ -1015,17 +901,11 @@
1015
901
  },
1016
902
  "/1/sources/{sourceID}": {
1017
903
  "get": {
1018
- "tags": [
1019
- "sources"
1020
- ],
904
+ "tags": ["sources"],
1021
905
  "summary": "Retrieve a source",
1022
906
  "description": "Retrieve a source by its ID.",
1023
907
  "operationId": "getSource",
1024
- "x-acl": [
1025
- "addObject",
1026
- "deleteIndex",
1027
- "editSettings"
1028
- ],
908
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1029
909
  "parameters": [
1030
910
  {
1031
911
  "$ref": "#/components/parameters/pathSourceID"
@@ -1048,17 +928,11 @@
1048
928
  }
1049
929
  },
1050
930
  "patch": {
1051
- "tags": [
1052
- "sources"
1053
- ],
931
+ "tags": ["sources"],
1054
932
  "summary": "Update a source",
1055
933
  "description": "Updates a source by its ID.",
1056
934
  "operationId": "updateSource",
1057
- "x-acl": [
1058
- "addObject",
1059
- "deleteIndex",
1060
- "editSettings"
1061
- ],
935
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1062
936
  "parameters": [
1063
937
  {
1064
938
  "$ref": "#/components/parameters/pathSourceID"
@@ -1091,17 +965,11 @@
1091
965
  }
1092
966
  },
1093
967
  "delete": {
1094
- "tags": [
1095
- "sources"
1096
- ],
968
+ "tags": ["sources"],
1097
969
  "summary": "Delete a source",
1098
970
  "description": "Deletes a source by its ID. You can't delete sources that are referenced in tasks.",
1099
971
  "operationId": "deleteSource",
1100
- "x-acl": [
1101
- "addObject",
1102
- "deleteIndex",
1103
- "editSettings"
1104
- ],
972
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1105
973
  "parameters": [
1106
974
  {
1107
975
  "$ref": "#/components/parameters/pathSourceID"
@@ -1126,17 +994,11 @@
1126
994
  },
1127
995
  "/1/sources/{sourceID}/validate": {
1128
996
  "post": {
1129
- "tags": [
1130
- "sources"
1131
- ],
997
+ "tags": ["sources"],
1132
998
  "summary": "Validate an update of a source payload",
1133
999
  "description": "Validates an update of a source payload to ensure it can be created and that the data source can be reached by Algolia.\n",
1134
1000
  "operationId": "validateSourceBeforeUpdate",
1135
- "x-acl": [
1136
- "addObject",
1137
- "deleteIndex",
1138
- "editSettings"
1139
- ],
1001
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1140
1002
  "x-timeouts": {
1141
1003
  "connect": 180000,
1142
1004
  "read": 180000,
@@ -1176,17 +1038,11 @@
1176
1038
  },
1177
1039
  "/1/sources/{sourceID}/discover": {
1178
1040
  "post": {
1179
- "tags": [
1180
- "sources"
1181
- ],
1041
+ "tags": ["sources"],
1182
1042
  "summary": "Trigger a stream-listing request",
1183
1043
  "description": "Triggers a stream-listing request for a source.\nTriggering stream-listing requests only works with sources with `type: docker` and `imageType: airbyte`.\n",
1184
1044
  "operationId": "triggerDockerSourceDiscover",
1185
- "x-acl": [
1186
- "addObject",
1187
- "deleteIndex",
1188
- "editSettings"
1189
- ],
1045
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1190
1046
  "x-timeouts": {
1191
1047
  "connect": 180000,
1192
1048
  "read": 180000,
@@ -1216,17 +1072,11 @@
1216
1072
  },
1217
1073
  "/1/sources/{sourceID}/run": {
1218
1074
  "post": {
1219
- "tags": [
1220
- "sources"
1221
- ],
1075
+ "tags": ["sources"],
1222
1076
  "summary": "Run all tasks linked to a source",
1223
1077
  "description": "Runs all tasks linked to a source, only available for Shopify, BigCommerce and commercetools sources. Creates one run per task.",
1224
1078
  "operationId": "runSource",
1225
- "x-acl": [
1226
- "addObject",
1227
- "deleteIndex",
1228
- "editSettings"
1229
- ],
1079
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1230
1080
  "parameters": [
1231
1081
  {
1232
1082
  "$ref": "#/components/parameters/pathSourceID"
@@ -1262,10 +1112,7 @@
1262
1112
  "$ref": "#/components/schemas/CreatedAt"
1263
1113
  }
1264
1114
  },
1265
- "required": [
1266
- "taskWithRunID",
1267
- "createdAt"
1268
- ]
1115
+ "required": ["taskWithRunID", "createdAt"]
1269
1116
  }
1270
1117
  }
1271
1118
  }
@@ -1278,18 +1125,12 @@
1278
1125
  },
1279
1126
  "/2/tasks": {
1280
1127
  "get": {
1281
- "tags": [
1282
- "tasks"
1283
- ],
1128
+ "tags": ["tasks"],
1284
1129
  "summary": "List tasks",
1285
1130
  "description": "Retrieves a list of tasks.",
1286
1131
  "operationId": "listTasks",
1287
1132
  "x-mcp-tool": true,
1288
- "x-acl": [
1289
- "addObject",
1290
- "deleteIndex",
1291
- "editSettings"
1292
- ],
1133
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1293
1134
  "parameters": [
1294
1135
  {
1295
1136
  "$ref": "#/components/parameters/itemsPerPage"
@@ -1346,10 +1187,7 @@
1346
1187
  "$ref": "#/components/schemas/Pagination"
1347
1188
  }
1348
1189
  },
1349
- "required": [
1350
- "tasks",
1351
- "pagination"
1352
- ]
1190
+ "required": ["tasks", "pagination"]
1353
1191
  }
1354
1192
  }
1355
1193
  }
@@ -1360,9 +1198,7 @@
1360
1198
  }
1361
1199
  },
1362
1200
  "post": {
1363
- "tags": [
1364
- "tasks"
1365
- ],
1201
+ "tags": ["tasks"],
1366
1202
  "summary": "Create a task",
1367
1203
  "description": "Creates a new task.",
1368
1204
  "operationId": "createTask",
@@ -1396,17 +1232,11 @@
1396
1232
  },
1397
1233
  "/2/tasks/search": {
1398
1234
  "post": {
1399
- "tags": [
1400
- "tasks"
1401
- ],
1235
+ "tags": ["tasks"],
1402
1236
  "summary": "Search for tasks",
1403
1237
  "description": "Searches for tasks.",
1404
1238
  "operationId": "searchTasks",
1405
- "x-acl": [
1406
- "addObject",
1407
- "deleteIndex",
1408
- "editSettings"
1409
- ],
1239
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1410
1240
  "requestBody": {
1411
1241
  "content": {
1412
1242
  "application/json": {
@@ -1440,17 +1270,11 @@
1440
1270
  },
1441
1271
  "/2/tasks/{taskID}": {
1442
1272
  "get": {
1443
- "tags": [
1444
- "tasks"
1445
- ],
1273
+ "tags": ["tasks"],
1446
1274
  "summary": "Retrieve a task",
1447
1275
  "description": "Retrieves a task by its ID.",
1448
1276
  "operationId": "getTask",
1449
- "x-acl": [
1450
- "addObject",
1451
- "deleteIndex",
1452
- "editSettings"
1453
- ],
1277
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1454
1278
  "parameters": [
1455
1279
  {
1456
1280
  "$ref": "#/components/parameters/pathTaskID"
@@ -1473,9 +1297,7 @@
1473
1297
  }
1474
1298
  },
1475
1299
  "put": {
1476
- "tags": [
1477
- "tasks"
1478
- ],
1300
+ "tags": ["tasks"],
1479
1301
  "summary": "Fully update a task",
1480
1302
  "description": "Fully updates a task by its ID, use partialUpdateTask if you only want to update a subset of fields.",
1481
1303
  "operationId": "replaceTask",
@@ -1511,9 +1333,7 @@
1511
1333
  }
1512
1334
  },
1513
1335
  "patch": {
1514
- "tags": [
1515
- "tasks"
1516
- ],
1336
+ "tags": ["tasks"],
1517
1337
  "summary": "Partially update a task",
1518
1338
  "description": "Partially updates a task by its ID.",
1519
1339
  "operationId": "updateTask",
@@ -1549,9 +1369,7 @@
1549
1369
  }
1550
1370
  },
1551
1371
  "delete": {
1552
- "tags": [
1553
- "tasks"
1554
- ],
1372
+ "tags": ["tasks"],
1555
1373
  "summary": "Delete a task",
1556
1374
  "description": "Deletes a task by its ID.",
1557
1375
  "operationId": "deleteTask",
@@ -1579,17 +1397,11 @@
1579
1397
  },
1580
1398
  "/2/tasks/{taskID}/run": {
1581
1399
  "post": {
1582
- "tags": [
1583
- "tasks"
1584
- ],
1400
+ "tags": ["tasks"],
1585
1401
  "summary": "Run a task",
1586
1402
  "description": "Runs a task. You can check the status of task runs with the observability endpoints.",
1587
1403
  "operationId": "runTask",
1588
- "x-acl": [
1589
- "addObject",
1590
- "deleteIndex",
1591
- "editSettings"
1592
- ],
1404
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1593
1405
  "parameters": [
1594
1406
  {
1595
1407
  "$ref": "#/components/parameters/pathTaskID"
@@ -1624,21 +1436,15 @@
1624
1436
  },
1625
1437
  "/2/tasks/{taskID}/push": {
1626
1438
  "post": {
1627
- "tags": [
1628
- "tasks"
1629
- ],
1439
+ "tags": ["tasks"],
1630
1440
  "summary": "Push records by task ID",
1631
1441
  "description": "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 or the debugger dashboard to see the status of your task.\nIf you want to transform your data before indexing, this is the recommended way of ingesting your records.\nThis method is similar to `push`, but requires a `taskID` instead of a `indexName`, which is useful when many `destinations` target the same `indexName`.\n",
1632
1442
  "operationId": "pushTask",
1633
1443
  "externalDocs": {
1634
- "url": "https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data/",
1635
- "description": "Related guide: Pre-indexing data transformation.\n"
1444
+ "url": "https://www.algolia.com/doc/guides/sending-and-managing-data/send-and-update-your-data/how-to/transform-your-data",
1445
+ "description": "Pre-indexing data transformation."
1636
1446
  },
1637
- "x-acl": [
1638
- "addObject",
1639
- "deleteIndex",
1640
- "editSettings"
1641
- ],
1447
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1642
1448
  "x-timeouts": {
1643
1449
  "connect": 180000,
1644
1450
  "read": 180000,
@@ -1681,17 +1487,11 @@
1681
1487
  },
1682
1488
  "/2/tasks/{taskID}/enable": {
1683
1489
  "put": {
1684
- "tags": [
1685
- "tasks"
1686
- ],
1490
+ "tags": ["tasks"],
1687
1491
  "summary": "Enable a task",
1688
1492
  "description": "Enables a task.",
1689
1493
  "operationId": "enableTask",
1690
- "x-acl": [
1691
- "addObject",
1692
- "deleteIndex",
1693
- "editSettings"
1694
- ],
1494
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1695
1495
  "parameters": [
1696
1496
  {
1697
1497
  "$ref": "#/components/parameters/pathTaskID"
@@ -1716,17 +1516,11 @@
1716
1516
  },
1717
1517
  "/2/tasks/{taskID}/disable": {
1718
1518
  "put": {
1719
- "tags": [
1720
- "tasks"
1721
- ],
1519
+ "tags": ["tasks"],
1722
1520
  "summary": "Disable a task",
1723
1521
  "description": "Disables a task.",
1724
1522
  "operationId": "disableTask",
1725
- "x-acl": [
1726
- "addObject",
1727
- "deleteIndex",
1728
- "editSettings"
1729
- ],
1523
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1730
1524
  "parameters": [
1731
1525
  {
1732
1526
  "$ref": "#/components/parameters/pathTaskID"
@@ -1751,18 +1545,12 @@
1751
1545
  },
1752
1546
  "/1/tasks": {
1753
1547
  "get": {
1754
- "tags": [
1755
- "tasks"
1756
- ],
1548
+ "tags": ["tasks"],
1757
1549
  "summary": "List tasks V1",
1758
1550
  "description": "Retrieves a list of tasks using the v1 endpoint, please use `getTasks` instead.",
1759
1551
  "operationId": "listTasksV1",
1760
1552
  "deprecated": true,
1761
- "x-acl": [
1762
- "addObject",
1763
- "deleteIndex",
1764
- "editSettings"
1765
- ],
1553
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1766
1554
  "parameters": [
1767
1555
  {
1768
1556
  "$ref": "#/components/parameters/itemsPerPage"
@@ -1813,10 +1601,7 @@
1813
1601
  "$ref": "#/components/schemas/Pagination"
1814
1602
  }
1815
1603
  },
1816
- "required": [
1817
- "tasks",
1818
- "pagination"
1819
- ]
1604
+ "required": ["tasks", "pagination"]
1820
1605
  }
1821
1606
  }
1822
1607
  }
@@ -1827,9 +1612,7 @@
1827
1612
  }
1828
1613
  },
1829
1614
  "post": {
1830
- "tags": [
1831
- "tasks"
1832
- ],
1615
+ "tags": ["tasks"],
1833
1616
  "summary": "Create a task V1",
1834
1617
  "description": "Creates a new task using the v1 endpoint, please use `createTask` instead.",
1835
1618
  "operationId": "createTaskV1",
@@ -1865,18 +1648,12 @@
1865
1648
  },
1866
1649
  "/1/tasks/search": {
1867
1650
  "post": {
1868
- "tags": [
1869
- "tasks"
1870
- ],
1651
+ "tags": ["tasks"],
1871
1652
  "summary": "Search for tasks V1",
1872
1653
  "description": "Searches for tasks using the v1 endpoint, please use `searchTasks` instead.",
1873
1654
  "operationId": "searchTasksV1",
1874
1655
  "deprecated": true,
1875
- "x-acl": [
1876
- "addObject",
1877
- "deleteIndex",
1878
- "editSettings"
1879
- ],
1656
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1880
1657
  "requestBody": {
1881
1658
  "content": {
1882
1659
  "application/json": {
@@ -1910,18 +1687,12 @@
1910
1687
  },
1911
1688
  "/1/tasks/{taskID}": {
1912
1689
  "get": {
1913
- "tags": [
1914
- "tasks"
1915
- ],
1690
+ "tags": ["tasks"],
1916
1691
  "summary": "Retrieve a task V1",
1917
1692
  "description": "Retrieves a task by its ID using the v1 endpoint, please use `getTask` instead.",
1918
1693
  "operationId": "getTaskV1",
1919
1694
  "deprecated": true,
1920
- "x-acl": [
1921
- "addObject",
1922
- "deleteIndex",
1923
- "editSettings"
1924
- ],
1695
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
1925
1696
  "parameters": [
1926
1697
  {
1927
1698
  "$ref": "#/components/parameters/pathTaskID"
@@ -1944,9 +1715,7 @@
1944
1715
  }
1945
1716
  },
1946
1717
  "patch": {
1947
- "tags": [
1948
- "tasks"
1949
- ],
1718
+ "tags": ["tasks"],
1950
1719
  "summary": "Update a task V1",
1951
1720
  "description": "Updates a task by its ID using the v1 endpoint, please use `updateTask` instead.",
1952
1721
  "operationId": "updateTaskV1",
@@ -1984,9 +1753,7 @@
1984
1753
  }
1985
1754
  },
1986
1755
  "delete": {
1987
- "tags": [
1988
- "tasks"
1989
- ],
1756
+ "tags": ["tasks"],
1990
1757
  "summary": "Delete a task",
1991
1758
  "description": "Deletes a task by its ID using the v1 endpoint, please use `deleteTask` instead.",
1992
1759
  "operationId": "deleteTaskV1",
@@ -2015,18 +1782,12 @@
2015
1782
  },
2016
1783
  "/1/tasks/{taskID}/run": {
2017
1784
  "post": {
2018
- "tags": [
2019
- "tasks"
2020
- ],
1785
+ "tags": ["tasks"],
2021
1786
  "summary": "Run a task V1",
2022
1787
  "description": "Runs a task using the v1 endpoint, please use `runTask` instead. You can check the status of task runs with the observability endpoints.",
2023
1788
  "operationId": "runTaskV1",
2024
1789
  "deprecated": true,
2025
- "x-acl": [
2026
- "addObject",
2027
- "deleteIndex",
2028
- "editSettings"
2029
- ],
1790
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2030
1791
  "parameters": [
2031
1792
  {
2032
1793
  "$ref": "#/components/parameters/pathTaskID"
@@ -2061,18 +1822,12 @@
2061
1822
  },
2062
1823
  "/1/tasks/{taskID}/enable": {
2063
1824
  "put": {
2064
- "tags": [
2065
- "tasks"
2066
- ],
1825
+ "tags": ["tasks"],
2067
1826
  "summary": "Enable a task V1",
2068
1827
  "description": "Enables a task using the v1 endpoint, please use `enableTask` instead.",
2069
1828
  "operationId": "enableTaskV1",
2070
1829
  "deprecated": true,
2071
- "x-acl": [
2072
- "addObject",
2073
- "deleteIndex",
2074
- "editSettings"
2075
- ],
1830
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2076
1831
  "parameters": [
2077
1832
  {
2078
1833
  "$ref": "#/components/parameters/pathTaskID"
@@ -2097,18 +1852,12 @@
2097
1852
  },
2098
1853
  "/1/tasks/{taskID}/disable": {
2099
1854
  "put": {
2100
- "tags": [
2101
- "tasks"
2102
- ],
1855
+ "tags": ["tasks"],
2103
1856
  "summary": "Disable a task V1",
2104
1857
  "description": "Disables a task using the v1 endpoint, please use `disableTask` instead.",
2105
1858
  "operationId": "disableTaskV1",
2106
1859
  "deprecated": true,
2107
- "x-acl": [
2108
- "addObject",
2109
- "deleteIndex",
2110
- "editSettings"
2111
- ],
1860
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2112
1861
  "parameters": [
2113
1862
  {
2114
1863
  "$ref": "#/components/parameters/pathTaskID"
@@ -2133,18 +1882,12 @@
2133
1882
  },
2134
1883
  "/1/transformations": {
2135
1884
  "get": {
2136
- "tags": [
2137
- "transformations"
2138
- ],
1885
+ "tags": ["transformations"],
2139
1886
  "summary": "List transformations",
2140
1887
  "description": "Retrieves a list of transformations.",
2141
1888
  "operationId": "listTransformations",
2142
1889
  "x-mcp-tool": true,
2143
- "x-acl": [
2144
- "addObject",
2145
- "deleteIndex",
2146
- "editSettings"
2147
- ],
1890
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2148
1891
  "parameters": [
2149
1892
  {
2150
1893
  "$ref": "#/components/parameters/itemsPerPage"
@@ -2183,10 +1926,7 @@
2183
1926
  "$ref": "#/components/schemas/Pagination"
2184
1927
  }
2185
1928
  },
2186
- "required": [
2187
- "transformations",
2188
- "pagination"
2189
- ]
1929
+ "required": ["transformations", "pagination"]
2190
1930
  }
2191
1931
  }
2192
1932
  }
@@ -2197,9 +1937,7 @@
2197
1937
  }
2198
1938
  },
2199
1939
  "post": {
2200
- "tags": [
2201
- "transformations"
2202
- ],
1940
+ "tags": ["transformations"],
2203
1941
  "summary": "Create a transformation",
2204
1942
  "description": "Creates a new transformation.",
2205
1943
  "operationId": "createTransformation",
@@ -2233,17 +1971,11 @@
2233
1971
  },
2234
1972
  "/1/transformations/try": {
2235
1973
  "post": {
2236
- "tags": [
2237
- "transformations"
2238
- ],
1974
+ "tags": ["transformations"],
2239
1975
  "summary": "Try a transformation before creating it",
2240
1976
  "description": "Try a transformation before creating it.",
2241
1977
  "operationId": "tryTransformation",
2242
- "x-acl": [
2243
- "addObject",
2244
- "deleteIndex",
2245
- "editSettings"
2246
- ],
1978
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2247
1979
  "requestBody": {
2248
1980
  "content": {
2249
1981
  "application/json": {
@@ -2273,17 +2005,11 @@
2273
2005
  },
2274
2006
  "/1/transformations/search": {
2275
2007
  "post": {
2276
- "tags": [
2277
- "transformations"
2278
- ],
2008
+ "tags": ["transformations"],
2279
2009
  "summary": "Search for transformations",
2280
2010
  "description": "Searches for transformations.",
2281
2011
  "operationId": "searchTransformations",
2282
- "x-acl": [
2283
- "addObject",
2284
- "deleteIndex",
2285
- "editSettings"
2286
- ],
2012
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2287
2013
  "requestBody": {
2288
2014
  "content": {
2289
2015
  "application/json": {
@@ -2317,17 +2043,11 @@
2317
2043
  },
2318
2044
  "/1/transformations/{transformationID}": {
2319
2045
  "get": {
2320
- "tags": [
2321
- "transformations"
2322
- ],
2046
+ "tags": ["transformations"],
2323
2047
  "summary": "Retrieve a transformation",
2324
2048
  "description": "Retrieves a transformation by its ID.",
2325
2049
  "operationId": "getTransformation",
2326
- "x-acl": [
2327
- "addObject",
2328
- "deleteIndex",
2329
- "editSettings"
2330
- ],
2050
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2331
2051
  "parameters": [
2332
2052
  {
2333
2053
  "$ref": "#/components/parameters/pathTransformationID"
@@ -2350,9 +2070,7 @@
2350
2070
  }
2351
2071
  },
2352
2072
  "put": {
2353
- "tags": [
2354
- "transformations"
2355
- ],
2073
+ "tags": ["transformations"],
2356
2074
  "summary": "Update a transformation",
2357
2075
  "description": "Updates a transformation by its ID.",
2358
2076
  "operationId": "updateTransformation",
@@ -2388,9 +2106,7 @@
2388
2106
  }
2389
2107
  },
2390
2108
  "delete": {
2391
- "tags": [
2392
- "transformations"
2393
- ],
2109
+ "tags": ["transformations"],
2394
2110
  "summary": "Delete a transformation",
2395
2111
  "description": "Deletes a transformation by its ID.",
2396
2112
  "operationId": "deleteTransformation",
@@ -2418,17 +2134,11 @@
2418
2134
  },
2419
2135
  "/1/transformations/{transformationID}/try": {
2420
2136
  "post": {
2421
- "tags": [
2422
- "transformations"
2423
- ],
2137
+ "tags": ["transformations"],
2424
2138
  "summary": "Try a transformation before updating it",
2425
2139
  "description": "Try a transformation before updating it.",
2426
2140
  "operationId": "tryTransformationBeforeUpdate",
2427
- "x-acl": [
2428
- "addObject",
2429
- "deleteIndex",
2430
- "editSettings"
2431
- ],
2141
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2432
2142
  "parameters": [
2433
2143
  {
2434
2144
  "$ref": "#/components/parameters/pathTransformationID"
@@ -2463,17 +2173,11 @@
2463
2173
  },
2464
2174
  "/1/runs": {
2465
2175
  "get": {
2466
- "tags": [
2467
- "observability"
2468
- ],
2176
+ "tags": ["observability"],
2469
2177
  "summary": "List task runs",
2470
2178
  "description": "Retrieve a list of task runs.",
2471
2179
  "operationId": "listRuns",
2472
- "x-acl": [
2473
- "addObject",
2474
- "deleteIndex",
2475
- "editSettings"
2476
- ],
2180
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2477
2181
  "parameters": [
2478
2182
  {
2479
2183
  "$ref": "#/components/parameters/itemsPerPage"
@@ -2532,17 +2236,11 @@
2532
2236
  },
2533
2237
  "/1/runs/{runID}": {
2534
2238
  "get": {
2535
- "tags": [
2536
- "observability"
2537
- ],
2239
+ "tags": ["observability"],
2538
2240
  "summary": "Retrieve a task run",
2539
2241
  "description": "Retrieve a single task run by its ID.",
2540
2242
  "operationId": "getRun",
2541
- "x-acl": [
2542
- "addObject",
2543
- "deleteIndex",
2544
- "editSettings"
2545
- ],
2243
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2546
2244
  "parameters": [
2547
2245
  {
2548
2246
  "$ref": "#/components/parameters/pathRunID"
@@ -2567,17 +2265,11 @@
2567
2265
  },
2568
2266
  "/1/runs/{runID}/events": {
2569
2267
  "get": {
2570
- "tags": [
2571
- "observability"
2572
- ],
2268
+ "tags": ["observability"],
2573
2269
  "summary": "List task run events",
2574
2270
  "description": "Retrieves a list of events for a task run, identified by its ID.",
2575
2271
  "operationId": "listEvents",
2576
- "x-acl": [
2577
- "addObject",
2578
- "deleteIndex",
2579
- "editSettings"
2580
- ],
2272
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2581
2273
  "parameters": [
2582
2274
  {
2583
2275
  "$ref": "#/components/parameters/pathRunID"
@@ -2640,11 +2332,7 @@
2640
2332
  "$ref": "#/components/schemas/Window"
2641
2333
  }
2642
2334
  },
2643
- "required": [
2644
- "events",
2645
- "pagination",
2646
- "window"
2647
- ]
2335
+ "required": ["events", "pagination", "window"]
2648
2336
  }
2649
2337
  }
2650
2338
  }
@@ -2657,17 +2345,11 @@
2657
2345
  },
2658
2346
  "/1/runs/{runID}/events/{eventID}": {
2659
2347
  "get": {
2660
- "tags": [
2661
- "observability"
2662
- ],
2348
+ "tags": ["observability"],
2663
2349
  "summary": "Retrieve a task run event",
2664
2350
  "description": "Retrieves a single task run event by its ID.",
2665
2351
  "operationId": "getEvent",
2666
- "x-acl": [
2667
- "addObject",
2668
- "deleteIndex",
2669
- "editSettings"
2670
- ],
2352
+ "x-acl": ["addObject", "deleteIndex", "editSettings"],
2671
2353
  "parameters": [
2672
2354
  {
2673
2355
  "$ref": "#/components/parameters/pathRunID"
@@ -2697,9 +2379,7 @@
2697
2379
  "get": {
2698
2380
  "x-helper": true,
2699
2381
  "x-asynchronous-helper": false,
2700
- "tags": [
2701
- "Api Key"
2702
- ],
2382
+ "tags": ["Api Key"],
2703
2383
  "operationId": "setClientApiKey",
2704
2384
  "summary": "Switch the API key used to authenticate requests",
2705
2385
  "description": "Switch the API key used to authenticate requests.\n",
@@ -2724,19 +2404,11 @@
2724
2404
  "/chunkedPush": {
2725
2405
  "get": {
2726
2406
  "x-helper": true,
2727
- "tags": [
2728
- "Records"
2729
- ],
2730
- "x-available-languages": [
2731
- "javascript",
2732
- "go",
2733
- "java",
2734
- "php",
2735
- "python"
2736
- ],
2407
+ "tags": ["Records"],
2408
+ "x-available-languages": ["javascript", "go", "java", "php", "python"],
2737
2409
  "operationId": "chunkedPush",
2738
2410
  "summary": "Replace all records in an index",
2739
- "description": "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/).\n",
2411
+ "description": "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).\n",
2740
2412
  "parameters": [
2741
2413
  {
2742
2414
  "in": "query",
@@ -3023,10 +2695,7 @@
3023
2695
  "items": {
3024
2696
  "$ref": "#/components/schemas/authenticationID"
3025
2697
  },
3026
- "example": [
3027
- "10000000-0a75-4000-a000-000000000001",
3028
- "none"
3029
- ]
2698
+ "example": ["10000000-0a75-4000-a000-000000000001", "none"]
3030
2699
  }
3031
2700
  },
3032
2701
  "sourceParameters_sort": {
@@ -3317,9 +2986,7 @@
3317
2986
  "title": "pushTaskRecords",
3318
2987
  "type": "object",
3319
2988
  "additionalProperties": true,
3320
- "required": [
3321
- "objectID"
3322
- ],
2989
+ "required": ["objectID"],
3323
2990
  "properties": {
3324
2991
  "objectID": {
3325
2992
  "$ref": "#/components/schemas/objectID"
@@ -3328,10 +2995,7 @@
3328
2995
  }
3329
2996
  }
3330
2997
  },
3331
- "required": [
3332
- "action",
3333
- "records"
3334
- ]
2998
+ "required": ["action", "records"]
3335
2999
  },
3336
3000
  "RunID": {
3337
3001
  "type": "string",
@@ -3347,14 +3011,7 @@
3347
3011
  "oneOf": [
3348
3012
  {
3349
3013
  "type": "string",
3350
- "enum": [
3351
- "created",
3352
- "started",
3353
- "retried",
3354
- "failed",
3355
- "succeeded",
3356
- "critical"
3357
- ]
3014
+ "enum": ["created", "started", "retried", "failed", "succeeded", "critical"]
3358
3015
  },
3359
3016
  {
3360
3017
  "type": "null"
@@ -3363,12 +3020,7 @@
3363
3020
  },
3364
3021
  "EventType": {
3365
3022
  "type": "string",
3366
- "enum": [
3367
- "fetch",
3368
- "record",
3369
- "log",
3370
- "transform"
3371
- ]
3023
+ "enum": ["fetch", "record", "log", "transform"]
3372
3024
  },
3373
3025
  "PublishedAt": {
3374
3026
  "type": "string",
@@ -3413,14 +3065,7 @@
3413
3065
  "$ref": "#/components/schemas/PublishedAt"
3414
3066
  }
3415
3067
  },
3416
- "required": [
3417
- "eventID",
3418
- "runID",
3419
- "status",
3420
- "type",
3421
- "batchSize",
3422
- "publishedAt"
3423
- ]
3068
+ "required": ["eventID", "runID", "status", "type", "batchSize", "publishedAt"]
3424
3069
  },
3425
3070
  "CreatedAt": {
3426
3071
  "type": "string",
@@ -3458,9 +3103,7 @@
3458
3103
  "$ref": "#/components/schemas/CreatedAt"
3459
3104
  }
3460
3105
  },
3461
- "required": [
3462
- "runID"
3463
- ]
3106
+ "required": ["runID"]
3464
3107
  },
3465
3108
  "itemsPerPage": {
3466
3109
  "type": "integer",
@@ -3493,11 +3136,7 @@
3493
3136
  {
3494
3137
  "type": "string",
3495
3138
  "description": "Name of an ecommerce platform with which to authenticate.\nThis determines which authentication type you can select.\n",
3496
- "enum": [
3497
- "bigcommerce",
3498
- "commercetools",
3499
- "shopify"
3500
- ]
3139
+ "enum": ["bigcommerce", "commercetools", "shopify"]
3501
3140
  },
3502
3141
  {
3503
3142
  "type": "null"
@@ -3507,9 +3146,7 @@
3507
3146
  "platformNone": {
3508
3147
  "type": "string",
3509
3148
  "description": "Authentication resource not tied to any ecommerce platform, used for filtering.",
3510
- "enum": [
3511
- "none"
3512
- ]
3149
+ "enum": ["none"]
3513
3150
  },
3514
3151
  "platformWithNone": {
3515
3152
  "oneOf": [
@@ -3525,22 +3162,13 @@
3525
3162
  "type": "string",
3526
3163
  "description": "Property by which to sort the list of authentications.",
3527
3164
  "default": "createdAt",
3528
- "enum": [
3529
- "name",
3530
- "type",
3531
- "platform",
3532
- "updatedAt",
3533
- "createdAt"
3534
- ]
3165
+ "enum": ["name", "type", "platform", "updatedAt", "createdAt"]
3535
3166
  },
3536
3167
  "orderKeys": {
3537
3168
  "type": "string",
3538
3169
  "description": "Ascending or descending sort order.",
3539
3170
  "default": "desc",
3540
- "enum": [
3541
- "asc",
3542
- "desc"
3543
- ]
3171
+ "enum": ["asc", "desc"]
3544
3172
  },
3545
3173
  "authenticationID": {
3546
3174
  "type": "string",
@@ -3577,9 +3205,7 @@
3577
3205
  "description": "Private key of the Google service account. This field is `null` in the API response."
3578
3206
  }
3579
3207
  },
3580
- "x-discriminator-fields": [
3581
- "clientEmail"
3582
- ]
3208
+ "x-discriminator-fields": ["clientEmail"]
3583
3209
  },
3584
3210
  "AuthBasicPartial": {
3585
3211
  "type": "object",
@@ -3595,9 +3221,7 @@
3595
3221
  "description": "Password. This field is `null` in the API response."
3596
3222
  }
3597
3223
  },
3598
- "x-discriminator-fields": [
3599
- "username"
3600
- ]
3224
+ "x-discriminator-fields": ["username"]
3601
3225
  },
3602
3226
  "AuthAPIKeyPartial": {
3603
3227
  "type": "object",
@@ -3609,9 +3233,7 @@
3609
3233
  "description": "API key. This field is `null` in the API response."
3610
3234
  }
3611
3235
  },
3612
- "x-discriminator-fields": [
3613
- "key"
3614
- ]
3236
+ "x-discriminator-fields": ["key"]
3615
3237
  },
3616
3238
  "AuthOAuthPartial": {
3617
3239
  "type": "object",
@@ -3636,9 +3258,7 @@
3636
3258
  "description": "OAuth scope."
3637
3259
  }
3638
3260
  },
3639
- "x-discriminator-fields": [
3640
- "url"
3641
- ]
3261
+ "x-discriminator-fields": ["url"]
3642
3262
  },
3643
3263
  "AuthAlgoliaPartial": {
3644
3264
  "type": "object",
@@ -3736,14 +3356,7 @@
3736
3356
  "$ref": "#/components/schemas/updatedAt"
3737
3357
  }
3738
3358
  },
3739
- "required": [
3740
- "authenticationID",
3741
- "type",
3742
- "name",
3743
- "input",
3744
- "createdAt",
3745
- "updatedAt"
3746
- ]
3359
+ "required": ["authenticationID", "type", "name", "input", "createdAt", "updatedAt"]
3747
3360
  },
3748
3361
  "Pagination": {
3749
3362
  "type": "object",
@@ -3767,12 +3380,7 @@
3767
3380
  "$ref": "#/components/schemas/itemsPerPage"
3768
3381
  }
3769
3382
  },
3770
- "required": [
3771
- "nbPages",
3772
- "page",
3773
- "nbItems",
3774
- "itemsPerPage"
3775
- ]
3383
+ "required": ["nbPages", "page", "nbItems", "itemsPerPage"]
3776
3384
  },
3777
3385
  "AuthGoogleServiceAccount": {
3778
3386
  "type": "object",
@@ -3789,14 +3397,8 @@
3789
3397
  "description": "Private key of the Google service account. This field is `null` in the API response."
3790
3398
  }
3791
3399
  },
3792
- "required": [
3793
- "clientEmail",
3794
- "privateKey"
3795
- ],
3796
- "x-discriminator-fields": [
3797
- "clientEmail",
3798
- "privateKey"
3799
- ]
3400
+ "required": ["clientEmail", "privateKey"],
3401
+ "x-discriminator-fields": ["clientEmail", "privateKey"]
3800
3402
  },
3801
3403
  "AuthBasic": {
3802
3404
  "type": "object",
@@ -3812,14 +3414,8 @@
3812
3414
  "description": "Password. This field is `null` in the API response."
3813
3415
  }
3814
3416
  },
3815
- "required": [
3816
- "username",
3817
- "password"
3818
- ],
3819
- "x-discriminator-fields": [
3820
- "username",
3821
- "password"
3822
- ]
3417
+ "required": ["username", "password"],
3418
+ "x-discriminator-fields": ["username", "password"]
3823
3419
  },
3824
3420
  "AuthAPIKey": {
3825
3421
  "type": "object",
@@ -3831,12 +3427,8 @@
3831
3427
  "description": "API key. This field is `null` in the API response."
3832
3428
  }
3833
3429
  },
3834
- "required": [
3835
- "key"
3836
- ],
3837
- "x-discriminator-fields": [
3838
- "key"
3839
- ]
3430
+ "required": ["key"],
3431
+ "x-discriminator-fields": ["key"]
3840
3432
  },
3841
3433
  "AuthOAuth": {
3842
3434
  "type": "object",
@@ -3861,16 +3453,8 @@
3861
3453
  "description": "OAuth scope."
3862
3454
  }
3863
3455
  },
3864
- "required": [
3865
- "url",
3866
- "client_id",
3867
- "client_secret"
3868
- ],
3869
- "x-discriminator-fields": [
3870
- "url",
3871
- "client_id",
3872
- "client_secret"
3873
- ]
3456
+ "required": ["url", "client_id", "client_secret"],
3457
+ "x-discriminator-fields": ["url", "client_id", "client_secret"]
3874
3458
  },
3875
3459
  "AuthAlgolia": {
3876
3460
  "type": "object",
@@ -3886,10 +3470,7 @@
3886
3470
  "description": "Algolia API key with the ACL: `addObject`, `deleteObject`, `settings`, `editSettings`, `listIndexes`, `deleteIndex`.\nThis field is `null` in the API response.\n"
3887
3471
  }
3888
3472
  },
3889
- "required": [
3890
- "appID",
3891
- "apiKey"
3892
- ]
3473
+ "required": ["appID", "apiKey"]
3893
3474
  },
3894
3475
  "AuthAlgoliaInsights": {
3895
3476
  "type": "object",
@@ -3905,10 +3486,7 @@
3905
3486
  "description": "Algolia API key with the ACL: `search`.\nThis field is `null` in the API response.\n"
3906
3487
  }
3907
3488
  },
3908
- "required": [
3909
- "appID",
3910
- "apiKey"
3911
- ]
3489
+ "required": ["appID", "apiKey"]
3912
3490
  },
3913
3491
  "AuthInput": {
3914
3492
  "oneOf": [
@@ -3953,11 +3531,7 @@
3953
3531
  "$ref": "#/components/schemas/AuthInput"
3954
3532
  }
3955
3533
  },
3956
- "required": [
3957
- "type",
3958
- "name",
3959
- "input"
3960
- ]
3534
+ "required": ["type", "name", "input"]
3961
3535
  },
3962
3536
  "AuthenticationCreateResponse": {
3963
3537
  "type": "object",
@@ -3974,11 +3548,7 @@
3974
3548
  "$ref": "#/components/schemas/CreatedAt"
3975
3549
  }
3976
3550
  },
3977
- "required": [
3978
- "authenticationID",
3979
- "name",
3980
- "createdAt"
3981
- ]
3551
+ "required": ["authenticationID", "name", "createdAt"]
3982
3552
  },
3983
3553
  "AuthenticationSearch": {
3984
3554
  "type": "object",
@@ -3992,9 +3562,7 @@
3992
3562
  }
3993
3563
  }
3994
3564
  },
3995
- "required": [
3996
- "authenticationIDs"
3997
- ]
3565
+ "required": ["authenticationIDs"]
3998
3566
  },
3999
3567
  "DeleteResponse": {
4000
3568
  "type": "object",
@@ -4004,9 +3572,7 @@
4004
3572
  "description": "Date of deletion in RFC 3339 format."
4005
3573
  }
4006
3574
  },
4007
- "required": [
4008
- "deletedAt"
4009
- ]
3575
+ "required": ["deletedAt"]
4010
3576
  },
4011
3577
  "AuthenticationUpdate": {
4012
3578
  "type": "object",
@@ -4042,19 +3608,12 @@
4042
3608
  "$ref": "#/components/schemas/updatedAt"
4043
3609
  }
4044
3610
  },
4045
- "required": [
4046
- "authenticationID",
4047
- "name",
4048
- "updatedAt"
4049
- ]
3611
+ "required": ["authenticationID", "name", "updatedAt"]
4050
3612
  },
4051
3613
  "DestinationType": {
4052
3614
  "type": "string",
4053
3615
  "description": "Destination type.\n\n- `search`.\n Data is stored in an Algolia index.\n\n- `insights`.\n Data is recorded as user events in the Insights API.\n",
4054
- "enum": [
4055
- "search",
4056
- "insights"
4057
- ]
3616
+ "enum": ["search", "insights"]
4058
3617
  },
4059
3618
  "transformationID": {
4060
3619
  "type": "string",
@@ -4065,12 +3624,7 @@
4065
3624
  "type": "string",
4066
3625
  "description": "Property by which to sort the destinations.",
4067
3626
  "default": "createdAt",
4068
- "enum": [
4069
- "name",
4070
- "type",
4071
- "updatedAt",
4072
- "createdAt"
4073
- ]
3627
+ "enum": ["name", "type", "updatedAt", "createdAt"]
4074
3628
  },
4075
3629
  "destinationID": {
4076
3630
  "type": "string",
@@ -4080,11 +3634,7 @@
4080
3634
  "RecordType": {
4081
3635
  "type": "string",
4082
3636
  "description": "Record type for ecommerce sources.",
4083
- "enum": [
4084
- "product",
4085
- "variant",
4086
- "collection"
4087
- ]
3637
+ "enum": ["product", "variant", "collection"]
4088
3638
  },
4089
3639
  "AttributesToExclude": {
4090
3640
  "type": "array",
@@ -4108,9 +3658,7 @@
4108
3658
  "$ref": "#/components/schemas/AttributesToExclude"
4109
3659
  }
4110
3660
  },
4111
- "required": [
4112
- "indexName"
4113
- ]
3661
+ "required": ["indexName"]
4114
3662
  },
4115
3663
  "transformationIDs": {
4116
3664
  "type": "array",
@@ -4151,14 +3699,7 @@
4151
3699
  "$ref": "#/components/schemas/transformationIDs"
4152
3700
  }
4153
3701
  },
4154
- "required": [
4155
- "destinationID",
4156
- "type",
4157
- "name",
4158
- "input",
4159
- "createdAt",
4160
- "updatedAt"
4161
- ]
3702
+ "required": ["destinationID", "type", "name", "input", "createdAt", "updatedAt"]
4162
3703
  },
4163
3704
  "DestinationCreate": {
4164
3705
  "type": "object",
@@ -4181,11 +3722,7 @@
4181
3722
  "$ref": "#/components/schemas/transformationIDs"
4182
3723
  }
4183
3724
  },
4184
- "required": [
4185
- "type",
4186
- "name",
4187
- "input"
4188
- ]
3725
+ "required": ["type", "name", "input"]
4189
3726
  },
4190
3727
  "DestinationCreateResponse": {
4191
3728
  "type": "object",
@@ -4202,11 +3739,7 @@
4202
3739
  "$ref": "#/components/schemas/CreatedAt"
4203
3740
  }
4204
3741
  },
4205
- "required": [
4206
- "destinationID",
4207
- "name",
4208
- "createdAt"
4209
- ]
3742
+ "required": ["destinationID", "name", "createdAt"]
4210
3743
  },
4211
3744
  "DestinationSearch": {
4212
3745
  "type": "object",
@@ -4220,9 +3753,7 @@
4220
3753
  }
4221
3754
  }
4222
3755
  },
4223
- "required": [
4224
- "destinationIDs"
4225
- ]
3756
+ "required": ["destinationIDs"]
4226
3757
  },
4227
3758
  "DestinationUpdate": {
4228
3759
  "type": "object",
@@ -4261,11 +3792,7 @@
4261
3792
  "$ref": "#/components/schemas/updatedAt"
4262
3793
  }
4263
3794
  },
4264
- "required": [
4265
- "destinationID",
4266
- "name",
4267
- "updatedAt"
4268
- ]
3795
+ "required": ["destinationID", "name", "updatedAt"]
4269
3796
  },
4270
3797
  "SourceType": {
4271
3798
  "type": "string",
@@ -4285,12 +3812,7 @@
4285
3812
  "type": "string",
4286
3813
  "description": "Property by which to sort the list of sources.",
4287
3814
  "default": "createdAt",
4288
- "enum": [
4289
- "name",
4290
- "type",
4291
- "updatedAt",
4292
- "createdAt"
4293
- ]
3815
+ "enum": ["name", "type", "updatedAt", "createdAt"]
4294
3816
  },
4295
3817
  "sourceID": {
4296
3818
  "type": "string",
@@ -4386,13 +3908,8 @@
4386
3908
  "$ref": "#/components/schemas/CommercetoolsCustomFields"
4387
3909
  }
4388
3910
  },
4389
- "required": [
4390
- "url",
4391
- "projectKey"
4392
- ],
4393
- "x-discriminator-fields": [
4394
- "projectKey"
4395
- ]
3911
+ "required": ["url", "projectKey"],
3912
+ "x-discriminator-fields": ["projectKey"]
4396
3913
  },
4397
3914
  "BigCommerceChannel": {
4398
3915
  "type": "object",
@@ -4405,10 +3922,7 @@
4405
3922
  "currencies": {
4406
3923
  "type": "array",
4407
3924
  "description": "Currencies for the given channel.",
4408
- "example": [
4409
- "usd",
4410
- "eur"
4411
- ],
3925
+ "example": ["usd", "eur"],
4412
3926
  "items": {
4413
3927
  "type": "string",
4414
3928
  "description": "Three-letter code for the currency.",
@@ -4416,9 +3930,7 @@
4416
3930
  }
4417
3931
  }
4418
3932
  },
4419
- "required": [
4420
- "id"
4421
- ]
3933
+ "required": ["id"]
4422
3934
  },
4423
3935
  "BigCommerceMetafield": {
4424
3936
  "type": "object",
@@ -4433,10 +3945,7 @@
4433
3945
  "description": "Key identifier of the metafield."
4434
3946
  }
4435
3947
  },
4436
- "required": [
4437
- "namespace",
4438
- "key"
4439
- ]
3948
+ "required": ["namespace", "key"]
4440
3949
  },
4441
3950
  "SourceBigCommerce": {
4442
3951
  "type": "object",
@@ -4468,12 +3977,8 @@
4468
3977
  }
4469
3978
  }
4470
3979
  },
4471
- "required": [
4472
- "storeHash"
4473
- ],
4474
- "x-discriminator-fields": [
4475
- "storeHash"
4476
- ]
3980
+ "required": ["storeHash"],
3981
+ "x-discriminator-fields": ["storeHash"]
4477
3982
  },
4478
3983
  "UniqueIDColumn": {
4479
3984
  "type": "string",
@@ -4482,10 +3987,7 @@
4482
3987
  "MethodType": {
4483
3988
  "type": "string",
4484
3989
  "description": "HTTP method to be used for retrieving your data.",
4485
- "enum": [
4486
- "GET",
4487
- "POST"
4488
- ]
3990
+ "enum": ["GET", "POST"]
4489
3991
  },
4490
3992
  "SourceJSON": {
4491
3993
  "type": "object",
@@ -4502,19 +4004,11 @@
4502
4004
  "$ref": "#/components/schemas/MethodType"
4503
4005
  }
4504
4006
  },
4505
- "required": [
4506
- "url"
4507
- ]
4007
+ "required": ["url"]
4508
4008
  },
4509
4009
  "MappingTypeCSV": {
4510
4010
  "type": "string",
4511
- "enum": [
4512
- "string",
4513
- "integer",
4514
- "float",
4515
- "boolean",
4516
- "json"
4517
- ]
4011
+ "enum": ["string", "integer", "float", "boolean", "json"]
4518
4012
  },
4519
4013
  "SourceCSV": {
4520
4014
  "type": "object",
@@ -4546,16 +4040,11 @@
4546
4040
  "description": "The character used to split the value on each line, default to a comma (\\r, \\n, 0xFFFD, and space are forbidden)."
4547
4041
  }
4548
4042
  },
4549
- "required": [
4550
- "url"
4551
- ]
4043
+ "required": ["url"]
4552
4044
  },
4553
4045
  "BigQueryDataType": {
4554
4046
  "type": "string",
4555
- "enum": [
4556
- "ga4",
4557
- "ga360"
4558
- ]
4047
+ "enum": ["ga4", "ga360"]
4559
4048
  },
4560
4049
  "SourceBigQuery": {
4561
4050
  "type": "object",
@@ -4588,13 +4077,8 @@
4588
4077
  "$ref": "#/components/schemas/UniqueIDColumn"
4589
4078
  }
4590
4079
  },
4591
- "required": [
4592
- "projectID",
4593
- "datasetID"
4594
- ],
4595
- "x-discriminator-fields": [
4596
- "projectID"
4597
- ]
4080
+ "required": ["projectID", "datasetID"],
4081
+ "x-discriminator-fields": ["projectID"]
4598
4082
  },
4599
4083
  "SourceGA4BigQueryExport": {
4600
4084
  "type": "object",
@@ -4614,16 +4098,8 @@
4614
4098
  "example": "events_intraday_"
4615
4099
  }
4616
4100
  },
4617
- "required": [
4618
- "projectID",
4619
- "datasetID",
4620
- "tablePrefix"
4621
- ],
4622
- "x-discriminator-fields": [
4623
- "projectID",
4624
- "datasetID",
4625
- "tablePrefix"
4626
- ]
4101
+ "required": ["projectID", "datasetID", "tablePrefix"],
4102
+ "x-discriminator-fields": ["projectID", "datasetID", "tablePrefix"]
4627
4103
  },
4628
4104
  "SourceDocker": {
4629
4105
  "type": "object",
@@ -4639,14 +4115,8 @@
4639
4115
  "description": "Configuration of the spec."
4640
4116
  }
4641
4117
  },
4642
- "required": [
4643
- "image",
4644
- "configuration"
4645
- ],
4646
- "x-discriminator-fields": [
4647
- "image",
4648
- "configuration"
4649
- ]
4118
+ "required": ["image", "configuration"],
4119
+ "x-discriminator-fields": ["image", "configuration"]
4650
4120
  },
4651
4121
  "SourceUpdateShopify": {
4652
4122
  "type": "object",
@@ -4668,12 +4138,8 @@
4668
4138
  "description": "URL of the Shopify store."
4669
4139
  }
4670
4140
  },
4671
- "required": [
4672
- "shopURL"
4673
- ],
4674
- "x-discriminator-fields": [
4675
- "shopURL"
4676
- ]
4141
+ "required": ["shopURL"],
4142
+ "x-discriminator-fields": ["shopURL"]
4677
4143
  },
4678
4144
  "SourceShopify": {
4679
4145
  "allOf": [
@@ -4742,13 +4208,7 @@
4742
4208
  "$ref": "#/components/schemas/updatedAt"
4743
4209
  }
4744
4210
  },
4745
- "required": [
4746
- "sourceID",
4747
- "type",
4748
- "name",
4749
- "createdAt",
4750
- "updatedAt"
4751
- ]
4211
+ "required": ["sourceID", "type", "name", "createdAt", "updatedAt"]
4752
4212
  },
4753
4213
  "SourceCreate": {
4754
4214
  "type": "object",
@@ -4768,10 +4228,7 @@
4768
4228
  "$ref": "#/components/schemas/authenticationID"
4769
4229
  }
4770
4230
  },
4771
- "required": [
4772
- "type",
4773
- "name"
4774
- ]
4231
+ "required": ["type", "name"]
4775
4232
  },
4776
4233
  "SourceCreateResponse": {
4777
4234
  "type": "object",
@@ -4788,11 +4245,7 @@
4788
4245
  "$ref": "#/components/schemas/CreatedAt"
4789
4246
  }
4790
4247
  },
4791
- "required": [
4792
- "sourceID",
4793
- "name",
4794
- "createdAt"
4795
- ]
4248
+ "required": ["sourceID", "name", "createdAt"]
4796
4249
  },
4797
4250
  "SourceSearch": {
4798
4251
  "type": "object",
@@ -4805,9 +4258,7 @@
4805
4258
  }
4806
4259
  }
4807
4260
  },
4808
- "required": [
4809
- "sourceIDs"
4810
- ]
4261
+ "required": ["sourceIDs"]
4811
4262
  },
4812
4263
  "SourceUpdateCommercetools": {
4813
4264
  "type": "object",
@@ -4855,12 +4306,8 @@
4855
4306
  "description": "Configuration of the spec."
4856
4307
  }
4857
4308
  },
4858
- "required": [
4859
- "configuration"
4860
- ],
4861
- "x-discriminator-fields": [
4862
- "configuration"
4863
- ]
4309
+ "required": ["configuration"],
4310
+ "x-discriminator-fields": ["configuration"]
4864
4311
  },
4865
4312
  "SourceUpdateInput": {
4866
4313
  "oneOf": [
@@ -4918,19 +4365,12 @@
4918
4365
  "$ref": "#/components/schemas/updatedAt"
4919
4366
  }
4920
4367
  },
4921
- "required": [
4922
- "sourceID",
4923
- "name",
4924
- "updatedAt"
4925
- ]
4368
+ "required": ["sourceID", "name", "updatedAt"]
4926
4369
  },
4927
4370
  "EntityType": {
4928
4371
  "type": "string",
4929
4372
  "description": "Type of entity to update.",
4930
- "enum": [
4931
- "product",
4932
- "collection"
4933
- ]
4373
+ "enum": ["product", "collection"]
4934
4374
  },
4935
4375
  "RunSourcePayload": {
4936
4376
  "type": "object",
@@ -4970,35 +4410,18 @@
4970
4410
  "ActionType": {
4971
4411
  "type": "string",
4972
4412
  "description": "Action to perform on the Algolia index.",
4973
- "enum": [
4974
- "replace",
4975
- "save",
4976
- "partial",
4977
- "partialNoCreate",
4978
- "append"
4979
- ]
4413
+ "enum": ["replace", "save", "partial", "partialNoCreate", "append"]
4980
4414
  },
4981
4415
  "TriggerType": {
4982
4416
  "type": "string",
4983
4417
  "description": "Task trigger, describing when a task should run.\n\n- `onDemand`.\n Manually trigger the task with the `/run` endpoint.\n\n- `schedule`.\n Regularly trigger the task on a `cron` schedule.\n\n- `subscription`.\n Trigger the task after an event is received, such as, a webhook.\n\n- `streaming`.\n Run the task continuously.\n",
4984
- "enum": [
4985
- "onDemand",
4986
- "schedule",
4987
- "subscription",
4988
- "streaming"
4989
- ]
4418
+ "enum": ["onDemand", "schedule", "subscription", "streaming"]
4990
4419
  },
4991
4420
  "taskSortKeys": {
4992
4421
  "type": "string",
4993
4422
  "description": "Property by which to sort the list of tasks.",
4994
4423
  "default": "createdAt",
4995
- "enum": [
4996
- "enabled",
4997
- "triggerType",
4998
- "action",
4999
- "updatedAt",
5000
- "createdAt"
5001
- ]
4424
+ "enum": ["enabled", "triggerType", "action", "updatedAt", "createdAt"]
5002
4425
  },
5003
4426
  "taskID": {
5004
4427
  "type": "string",
@@ -5021,9 +4444,7 @@
5021
4444
  "MappingFormatSchema": {
5022
4445
  "type": "string",
5023
4446
  "description": "Mapping format schema.",
5024
- "enum": [
5025
- "mappingkit/v1"
5026
- ]
4447
+ "enum": ["mappingkit/v1"]
5027
4448
  },
5028
4449
  "MappingFieldDirective": {
5029
4450
  "type": "object",
@@ -5040,10 +4461,7 @@
5040
4461
  "description": "How the destination field should be resolved from the source."
5041
4462
  }
5042
4463
  },
5043
- "required": [
5044
- "fieldKey",
5045
- "value"
5046
- ]
4464
+ "required": ["fieldKey", "value"]
5047
4465
  },
5048
4466
  "MappingKitAction": {
5049
4467
  "type": "object",
@@ -5069,11 +4487,7 @@
5069
4487
  }
5070
4488
  }
5071
4489
  },
5072
- "required": [
5073
- "enabled",
5074
- "trigger",
5075
- "fieldDirectives"
5076
- ]
4490
+ "required": ["enabled", "trigger", "fieldDirectives"]
5077
4491
  },
5078
4492
  "MappingInput": {
5079
4493
  "type": "object",
@@ -5090,14 +4504,8 @@
5090
4504
  }
5091
4505
  }
5092
4506
  },
5093
- "required": [
5094
- "format",
5095
- "actions"
5096
- ],
5097
- "x-discriminator-fields": [
5098
- "format",
5099
- "actions"
5100
- ]
4507
+ "required": ["format", "actions"],
4508
+ "x-discriminator-fields": ["format", "actions"]
5101
4509
  },
5102
4510
  "StreamingInput": {
5103
4511
  "type": "object",
@@ -5108,20 +4516,13 @@
5108
4516
  "$ref": "#/components/schemas/MappingInput"
5109
4517
  }
5110
4518
  },
5111
- "required": [
5112
- "mapping"
5113
- ],
5114
- "x-discriminator-fields": [
5115
- "mapping"
5116
- ]
4519
+ "required": ["mapping"],
4520
+ "x-discriminator-fields": ["mapping"]
5117
4521
  },
5118
4522
  "DockerStreamsSyncMode": {
5119
4523
  "type": "string",
5120
4524
  "description": "The strategy to use to fetch the data.",
5121
- "enum": [
5122
- "incremental",
5123
- "fullTable"
5124
- ]
4525
+ "enum": ["incremental", "fullTable"]
5125
4526
  },
5126
4527
  "DockerStreams": {
5127
4528
  "type": "object",
@@ -5141,10 +4542,7 @@
5141
4542
  "$ref": "#/components/schemas/DockerStreamsSyncMode"
5142
4543
  }
5143
4544
  },
5144
- "required": [
5145
- "name",
5146
- "syncMode"
5147
- ]
4545
+ "required": ["name", "syncMode"]
5148
4546
  },
5149
4547
  "DockerStreamsInput": {
5150
4548
  "description": "The selected streams of an airbyte connector.",
@@ -5157,12 +4555,8 @@
5157
4555
  }
5158
4556
  }
5159
4557
  },
5160
- "required": [
5161
- "streams"
5162
- ],
5163
- "x-discriminator-fields": [
5164
- "streams"
5165
- ]
4558
+ "required": ["streams"],
4559
+ "x-discriminator-fields": ["streams"]
5166
4560
  },
5167
4561
  "ShopifyMetafield": {
5168
4562
  "type": "object",
@@ -5179,11 +4573,7 @@
5179
4573
  "type": "string"
5180
4574
  }
5181
4575
  },
5182
- "required": [
5183
- "namespace",
5184
- "key",
5185
- "value"
5186
- ]
4576
+ "required": ["namespace", "key", "value"]
5187
4577
  },
5188
4578
  "ShopifyMarket": {
5189
4579
  "type": "object",
@@ -5209,11 +4599,7 @@
5209
4599
  }
5210
4600
  }
5211
4601
  },
5212
- "required": [
5213
- "countries",
5214
- "currencies",
5215
- "locales"
5216
- ]
4602
+ "required": ["countries", "currencies", "locales"]
5217
4603
  },
5218
4604
  "ShopifyInput": {
5219
4605
  "type": "object",
@@ -5230,10 +4616,7 @@
5230
4616
  "$ref": "#/components/schemas/ShopifyMarket"
5231
4617
  }
5232
4618
  },
5233
- "required": [
5234
- "metafields",
5235
- "market"
5236
- ]
4619
+ "required": ["metafields", "market"]
5237
4620
  },
5238
4621
  "TaskInput": {
5239
4622
  "description": "Configuration of the task, depending on its type.",
@@ -5276,9 +4659,7 @@
5276
4659
  }
5277
4660
  }
5278
4661
  },
5279
- "required": [
5280
- "email"
5281
- ]
4662
+ "required": ["email"]
5282
4663
  },
5283
4664
  "Policies": {
5284
4665
  "type": "object",
@@ -5351,14 +4732,7 @@
5351
4732
  "$ref": "#/components/schemas/updatedAt"
5352
4733
  }
5353
4734
  },
5354
- "required": [
5355
- "taskID",
5356
- "sourceID",
5357
- "destinationID",
5358
- "enabled",
5359
- "createdAt",
5360
- "updatedAt"
5361
- ]
4735
+ "required": ["taskID", "sourceID", "destinationID", "enabled", "createdAt", "updatedAt"]
5362
4736
  },
5363
4737
  "TaskCreate": {
5364
4738
  "type": "object",
@@ -5400,11 +4774,7 @@
5400
4774
  "$ref": "#/components/schemas/Policies"
5401
4775
  }
5402
4776
  },
5403
- "required": [
5404
- "sourceID",
5405
- "destinationID",
5406
- "action"
5407
- ]
4777
+ "required": ["sourceID", "destinationID", "action"]
5408
4778
  },
5409
4779
  "TaskCreateResponse": {
5410
4780
  "type": "object",
@@ -5418,10 +4788,7 @@
5418
4788
  "$ref": "#/components/schemas/CreatedAt"
5419
4789
  }
5420
4790
  },
5421
- "required": [
5422
- "taskID",
5423
- "createdAt"
5424
- ]
4791
+ "required": ["taskID", "createdAt"]
5425
4792
  },
5426
4793
  "TaskSearch": {
5427
4794
  "type": "object",
@@ -5434,9 +4801,7 @@
5434
4801
  }
5435
4802
  }
5436
4803
  },
5437
- "required": [
5438
- "taskIDs"
5439
- ]
4804
+ "required": ["taskIDs"]
5440
4805
  },
5441
4806
  "TaskReplace": {
5442
4807
  "type": "object",
@@ -5475,10 +4840,7 @@
5475
4840
  "$ref": "#/components/schemas/Policies"
5476
4841
  }
5477
4842
  },
5478
- "required": [
5479
- "destinationID",
5480
- "action"
5481
- ]
4843
+ "required": ["destinationID", "action"]
5482
4844
  },
5483
4845
  "TaskUpdateResponse": {
5484
4846
  "type": "object",
@@ -5492,10 +4854,7 @@
5492
4854
  "$ref": "#/components/schemas/updatedAt"
5493
4855
  }
5494
4856
  },
5495
- "required": [
5496
- "taskID",
5497
- "updatedAt"
5498
- ]
4857
+ "required": ["taskID", "updatedAt"]
5499
4858
  },
5500
4859
  "TaskUpdate": {
5501
4860
  "type": "object",
@@ -5552,17 +4911,12 @@
5552
4911
  "$ref": "#/components/schemas/CreatedAt"
5553
4912
  }
5554
4913
  },
5555
- "required": [
5556
- "runID",
5557
- "createdAt"
5558
- ]
4914
+ "required": ["runID", "createdAt"]
5559
4915
  },
5560
4916
  "OnDemandTriggerType": {
5561
4917
  "type": "string",
5562
4918
  "description": "Task is run manually, with the `/run` endpoint.",
5563
- "enum": [
5564
- "onDemand"
5565
- ]
4919
+ "enum": ["onDemand"]
5566
4920
  },
5567
4921
  "OnDemandTrigger": {
5568
4922
  "type": "object",
@@ -5576,16 +4930,12 @@
5576
4930
  "$ref": "#/components/schemas/LastRun"
5577
4931
  }
5578
4932
  },
5579
- "required": [
5580
- "type"
5581
- ]
4933
+ "required": ["type"]
5582
4934
  },
5583
4935
  "ScheduleTriggerType": {
5584
4936
  "type": "string",
5585
4937
  "description": "Task runs on a schedule.",
5586
- "enum": [
5587
- "schedule"
5588
- ]
4938
+ "enum": ["schedule"]
5589
4939
  },
5590
4940
  "ScheduleTrigger": {
5591
4941
  "type": "object",
@@ -5605,18 +4955,12 @@
5605
4955
  "$ref": "#/components/schemas/NextRun"
5606
4956
  }
5607
4957
  },
5608
- "required": [
5609
- "type",
5610
- "cron",
5611
- "nextRun"
5612
- ]
4958
+ "required": ["type", "cron", "nextRun"]
5613
4959
  },
5614
4960
  "SubscriptionTriggerType": {
5615
4961
  "type": "string",
5616
4962
  "description": "Task runs after receiving subscribed event.",
5617
- "enum": [
5618
- "subscription"
5619
- ]
4963
+ "enum": ["subscription"]
5620
4964
  },
5621
4965
  "SubscriptionTrigger": {
5622
4966
  "type": "object",
@@ -5627,16 +4971,12 @@
5627
4971
  "$ref": "#/components/schemas/SubscriptionTriggerType"
5628
4972
  }
5629
4973
  },
5630
- "required": [
5631
- "type"
5632
- ]
4974
+ "required": ["type"]
5633
4975
  },
5634
4976
  "StreamingTriggerType": {
5635
4977
  "type": "string",
5636
4978
  "description": "Task runs continuously.",
5637
- "enum": [
5638
- "streaming"
5639
- ]
4979
+ "enum": ["streaming"]
5640
4980
  },
5641
4981
  "StreamingTrigger": {
5642
4982
  "type": "object",
@@ -5647,9 +4987,7 @@
5647
4987
  "$ref": "#/components/schemas/StreamingTriggerType"
5648
4988
  }
5649
4989
  },
5650
- "required": [
5651
- "type"
5652
- ]
4990
+ "required": ["type"]
5653
4991
  },
5654
4992
  "Trigger": {
5655
4993
  "description": "Trigger that runs the task.",
@@ -5735,9 +5073,7 @@
5735
5073
  "$ref": "#/components/schemas/OnDemandTriggerType"
5736
5074
  }
5737
5075
  },
5738
- "required": [
5739
- "type"
5740
- ]
5076
+ "required": ["type"]
5741
5077
  },
5742
5078
  "ScheduleTriggerInput": {
5743
5079
  "type": "object",
@@ -5751,13 +5087,8 @@
5751
5087
  "$ref": "#/components/schemas/Cron"
5752
5088
  }
5753
5089
  },
5754
- "required": [
5755
- "type",
5756
- "cron"
5757
- ],
5758
- "x-discriminator-fields": [
5759
- "cron"
5760
- ]
5090
+ "required": ["type", "cron"],
5091
+ "x-discriminator-fields": ["cron"]
5761
5092
  },
5762
5093
  "TaskCreateTrigger": {
5763
5094
  "oneOf": [
@@ -5807,12 +5138,7 @@
5807
5138
  "$ref": "#/components/schemas/cursor"
5808
5139
  }
5809
5140
  },
5810
- "required": [
5811
- "sourceID",
5812
- "destinationID",
5813
- "trigger",
5814
- "action"
5815
- ]
5141
+ "required": ["sourceID", "destinationID", "trigger", "action"]
5816
5142
  },
5817
5143
  "TriggerUpdateInput": {
5818
5144
  "type": "object",
@@ -5823,9 +5149,7 @@
5823
5149
  "$ref": "#/components/schemas/Cron"
5824
5150
  }
5825
5151
  },
5826
- "required": [
5827
- "cron"
5828
- ]
5152
+ "required": ["cron"]
5829
5153
  },
5830
5154
  "Enabled": {
5831
5155
  "type": "boolean",
@@ -5858,19 +5182,12 @@
5858
5182
  "type": "string",
5859
5183
  "description": "Property by which to sort the list of transformations.",
5860
5184
  "default": "createdAt",
5861
- "enum": [
5862
- "name",
5863
- "updatedAt",
5864
- "createdAt"
5865
- ]
5185
+ "enum": ["name", "updatedAt", "createdAt"]
5866
5186
  },
5867
5187
  "TransformationType": {
5868
5188
  "type": "string",
5869
5189
  "description": "The type of transformation, which can be either 'code' or 'noCode'.",
5870
- "enum": [
5871
- "code",
5872
- "noCode"
5873
- ]
5190
+ "enum": ["code", "noCode"]
5874
5191
  },
5875
5192
  "AuthenticationIDs": {
5876
5193
  "description": "The authentications associated with the current transformation.",
@@ -5894,9 +5211,7 @@
5894
5211
  "description": "The source code of the transformation."
5895
5212
  }
5896
5213
  },
5897
- "required": [
5898
- "code"
5899
- ]
5214
+ "required": ["code"]
5900
5215
  },
5901
5216
  "TransformationNoCodeStep": {
5902
5217
  "type": "object",
@@ -5914,9 +5229,7 @@
5914
5229
  }
5915
5230
  }
5916
5231
  },
5917
- "required": [
5918
- "steps"
5919
- ]
5232
+ "required": ["steps"]
5920
5233
  },
5921
5234
  "TransformationInput": {
5922
5235
  "description": "The input for the transformation, which can be either code or a no-code configuration.",
@@ -5972,13 +5285,7 @@
5972
5285
  "$ref": "#/components/schemas/updatedAt"
5973
5286
  }
5974
5287
  },
5975
- "required": [
5976
- "transformationID",
5977
- "code",
5978
- "name",
5979
- "createdAt",
5980
- "updatedAt"
5981
- ]
5288
+ "required": ["transformationID", "code", "name", "createdAt", "updatedAt"]
5982
5289
  },
5983
5290
  "TransformationCreate": {
5984
5291
  "type": "object",
@@ -6004,9 +5311,7 @@
6004
5311
  "$ref": "#/components/schemas/AuthenticationIDs"
6005
5312
  }
6006
5313
  },
6007
- "required": [
6008
- "name"
6009
- ]
5314
+ "required": ["name"]
6010
5315
  },
6011
5316
  "TransformationCreateResponse": {
6012
5317
  "type": "object",
@@ -6020,10 +5325,7 @@
6020
5325
  "$ref": "#/components/schemas/CreatedAt"
6021
5326
  }
6022
5327
  },
6023
- "required": [
6024
- "transformationID",
6025
- "createdAt"
6026
- ]
5328
+ "required": ["transformationID", "createdAt"]
6027
5329
  },
6028
5330
  "TransformationTry": {
6029
5331
  "type": "object",
@@ -6049,9 +5351,7 @@
6049
5351
  }
6050
5352
  }
6051
5353
  },
6052
- "required": [
6053
- "sampleRecord"
6054
- ]
5354
+ "required": ["sampleRecord"]
6055
5355
  },
6056
5356
  "TransformationTryResponse": {
6057
5357
  "type": "object",
@@ -6080,9 +5380,7 @@
6080
5380
  }
6081
5381
  }
6082
5382
  },
6083
- "required": [
6084
- "payloads"
6085
- ]
5383
+ "required": ["payloads"]
6086
5384
  },
6087
5385
  "TransformationSearch": {
6088
5386
  "type": "object",
@@ -6095,9 +5393,7 @@
6095
5393
  }
6096
5394
  }
6097
5395
  },
6098
- "required": [
6099
- "transformationIDs"
6100
- ]
5396
+ "required": ["transformationIDs"]
6101
5397
  },
6102
5398
  "TransformationUpdateResponse": {
6103
5399
  "type": "object",
@@ -6111,50 +5407,28 @@
6111
5407
  "$ref": "#/components/schemas/updatedAt"
6112
5408
  }
6113
5409
  },
6114
- "required": [
6115
- "transformationID",
6116
- "updatedAt"
6117
- ]
5410
+ "required": ["transformationID", "updatedAt"]
6118
5411
  },
6119
5412
  "RunStatus": {
6120
5413
  "type": "string",
6121
5414
  "description": "Task run status.",
6122
- "enum": [
6123
- "created",
6124
- "started",
6125
- "idled",
6126
- "finished",
6127
- "skipped"
6128
- ]
5415
+ "enum": ["created", "started", "idled", "finished", "skipped"]
6129
5416
  },
6130
5417
  "RunType": {
6131
5418
  "type": "string",
6132
5419
  "description": "Task run type.",
6133
- "enum": [
6134
- "reindex",
6135
- "update",
6136
- "discover",
6137
- "validate",
6138
- "push"
6139
- ]
5420
+ "enum": ["reindex", "update", "discover", "validate", "push"]
6140
5421
  },
6141
5422
  "runSortKeys": {
6142
5423
  "type": "string",
6143
5424
  "description": "Property by which to sort the list of task runs.",
6144
5425
  "default": "createdAt",
6145
- "enum": [
6146
- "status",
6147
- "updatedAt",
6148
- "createdAt"
6149
- ]
5426
+ "enum": ["status", "updatedAt", "createdAt"]
6150
5427
  },
6151
5428
  "RunOutcome": {
6152
5429
  "type": "string",
6153
5430
  "description": "Task run outcome.",
6154
- "enum": [
6155
- "success",
6156
- "failure"
6157
- ]
5431
+ "enum": ["success", "failure"]
6158
5432
  },
6159
5433
  "RunReasonCode": {
6160
5434
  "type": "string",
@@ -6205,10 +5479,7 @@
6205
5479
  "type": "integer"
6206
5480
  }
6207
5481
  },
6208
- "required": [
6209
- "expectedNbOfEvents",
6210
- "receivedNbOfEvents"
6211
- ]
5482
+ "required": ["expectedNbOfEvents", "receivedNbOfEvents"]
6212
5483
  },
6213
5484
  "outcome": {
6214
5485
  "$ref": "#/components/schemas/RunOutcome"
@@ -6236,14 +5507,7 @@
6236
5507
  "$ref": "#/components/schemas/finishedAt"
6237
5508
  }
6238
5509
  },
6239
- "required": [
6240
- "runID",
6241
- "appID",
6242
- "taskID",
6243
- "status",
6244
- "type",
6245
- "createdAt"
6246
- ]
5510
+ "required": ["runID", "appID", "taskID", "status", "type", "createdAt"]
6247
5511
  },
6248
5512
  "Window": {
6249
5513
  "type": "object",
@@ -6259,10 +5523,7 @@
6259
5523
  "description": "Date in RFC 3339 format representing the newest data in the time window."
6260
5524
  }
6261
5525
  },
6262
- "required": [
6263
- "startDate",
6264
- "endDate"
6265
- ]
5526
+ "required": ["startDate", "endDate"]
6266
5527
  },
6267
5528
  "RunListResponse": {
6268
5529
  "type": "object",
@@ -6281,20 +5542,12 @@
6281
5542
  "$ref": "#/components/schemas/Window"
6282
5543
  }
6283
5544
  },
6284
- "required": [
6285
- "runs",
6286
- "pagination",
6287
- "window"
6288
- ]
5545
+ "required": ["runs", "pagination", "window"]
6289
5546
  },
6290
5547
  "eventSortKeys": {
6291
5548
  "type": "string",
6292
5549
  "description": "Property by which to sort the list of task run events.",
6293
- "enum": [
6294
- "status",
6295
- "type",
6296
- "publishedAt"
6297
- ]
5550
+ "enum": ["status", "type", "publishedAt"]
6298
5551
  }
6299
5552
  },
6300
5553
  "responses": {
@@ -6365,4 +5618,4 @@
6365
5618
  "write": 25000
6366
5619
  }
6367
5620
  }
6368
- }
5621
+ }