@datocms/cma-client 1.3.4 → 1.3.6-alpha.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.
Files changed (35) hide show
  1. package/dist/cjs/generated/Client.js +1 -1
  2. package/dist/cjs/generated/Client.js.map +1 -1
  3. package/dist/cjs/generated/resources/Item.js +53 -6
  4. package/dist/cjs/generated/resources/Item.js.map +1 -1
  5. package/dist/cjs/generated/resources/Plugin.js +2 -2
  6. package/dist/cjs/generated/resources/ScheduledPublication.js +1 -1
  7. package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
  8. package/dist/cjs/generated/resources/ScheduledUnpublishing.js +1 -1
  9. package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
  10. package/dist/esm/generated/Client.js +1 -1
  11. package/dist/esm/generated/Client.js.map +1 -1
  12. package/dist/esm/generated/SchemaTypes.d.ts +600 -422
  13. package/dist/esm/generated/SimpleSchemaTypes.d.ts +248 -83
  14. package/dist/esm/generated/resources/Item.d.ts +26 -4
  15. package/dist/esm/generated/resources/Item.js +53 -6
  16. package/dist/esm/generated/resources/Item.js.map +1 -1
  17. package/dist/esm/generated/resources/Plugin.d.ts +2 -2
  18. package/dist/esm/generated/resources/Plugin.js +2 -2
  19. package/dist/esm/generated/resources/ScheduledPublication.js +1 -1
  20. package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
  21. package/dist/esm/generated/resources/ScheduledUnpublishing.js +1 -1
  22. package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
  23. package/dist/types/generated/SchemaTypes.d.ts +600 -422
  24. package/dist/types/generated/SimpleSchemaTypes.d.ts +248 -83
  25. package/dist/types/generated/resources/Item.d.ts +26 -4
  26. package/dist/types/generated/resources/Plugin.d.ts +2 -2
  27. package/package.json +3 -3
  28. package/resources.json +204 -3
  29. package/src/generated/Client.ts +1 -1
  30. package/src/generated/SchemaTypes.ts +626 -443
  31. package/src/generated/SimpleSchemaTypes.ts +255 -86
  32. package/src/generated/resources/Item.ts +69 -2
  33. package/src/generated/resources/Plugin.ts +2 -2
  34. package/src/generated/resources/ScheduledPublication.ts +1 -1
  35. package/src/generated/resources/ScheduledUnpublishing.ts +1 -1
package/resources.json CHANGED
@@ -10,6 +10,7 @@
10
10
  "method": "POST",
11
11
  "comment": "Create a new role",
12
12
  "requestBodyType": "RoleCreateSchema",
13
+ "optionalRequestBody": false,
13
14
  "requestStructure": {
14
15
  "type": "role",
15
16
  "attributes": [
@@ -61,6 +62,7 @@
61
62
  "relType": "RoleData"
62
63
  },
63
64
  "requestBodyType": "RoleUpdateSchema",
65
+ "optionalRequestBody": false,
64
66
  "requestStructure": {
65
67
  "type": "role",
66
68
  "attributes": [
@@ -106,6 +108,7 @@
106
108
  "urlTemplate": "/roles",
107
109
  "method": "GET",
108
110
  "comment": "List all roles",
111
+ "optionalRequestBody": false,
109
112
  "queryParamsRequired": false,
110
113
  "responseType": "RoleInstancesTargetSchema",
111
114
  "name": "list",
@@ -123,6 +126,7 @@
123
126
  "isEntityId": true,
124
127
  "relType": "RoleData"
125
128
  },
129
+ "optionalRequestBody": false,
126
130
  "queryParamsRequired": false,
127
131
  "responseType": "RoleSelfTargetSchema",
128
132
  "name": "find",
@@ -140,6 +144,7 @@
140
144
  "isEntityId": true,
141
145
  "relType": "RoleData"
142
146
  },
147
+ "optionalRequestBody": false,
143
148
  "queryParamsRequired": false,
144
149
  "responseType": "RoleDestroyTargetSchema",
145
150
  "name": "destroy",
@@ -165,6 +170,7 @@
165
170
  "relType": "UserData"
166
171
  },
167
172
  "requestBodyType": "UserUpdateSchema",
173
+ "optionalRequestBody": false,
168
174
  "requestStructure": {
169
175
  "type": "user",
170
176
  "attributes": [
@@ -186,6 +192,7 @@
186
192
  "urlTemplate": "/users",
187
193
  "method": "GET",
188
194
  "comment": "List all collaborators",
195
+ "optionalRequestBody": false,
189
196
  "queryParamsRequired": false,
190
197
  "responseType": "UserInstancesTargetSchema",
191
198
  "name": "list",
@@ -203,6 +210,7 @@
203
210
  "isEntityId": true,
204
211
  "relType": "UserData"
205
212
  },
213
+ "optionalRequestBody": false,
206
214
  "queryParamsType": "UserSelfHrefSchema",
207
215
  "queryParamsRequired": false,
208
216
  "responseType": "UserSelfTargetSchema",
@@ -216,6 +224,7 @@
216
224
  "urlTemplate": "/users/me",
217
225
  "method": "GET",
218
226
  "comment": "Retrieve current signed-in user",
227
+ "optionalRequestBody": false,
219
228
  "queryParamsType": "UserMeHrefSchema",
220
229
  "queryParamsRequired": false,
221
230
  "responseType": "UserMeTargetSchema",
@@ -234,6 +243,7 @@
234
243
  "isEntityId": true,
235
244
  "relType": "UserData"
236
245
  },
246
+ "optionalRequestBody": false,
237
247
  "queryParamsType": "UserDestroyHrefSchema",
238
248
  "queryParamsRequired": false,
239
249
  "responseType": "UserDestroyTargetSchema",
@@ -254,6 +264,7 @@
254
264
  "urlTemplate": "/sso-users",
255
265
  "method": "GET",
256
266
  "comment": "List all users",
267
+ "optionalRequestBody": false,
257
268
  "queryParamsRequired": false,
258
269
  "responseType": "SsoUserInstancesTargetSchema",
259
270
  "name": "list",
@@ -271,6 +282,7 @@
271
282
  "isEntityId": false,
272
283
  "relType": "UserData"
273
284
  },
285
+ "optionalRequestBody": false,
274
286
  "queryParamsRequired": false,
275
287
  "responseType": "SsoUserSelfTargetSchema",
276
288
  "name": "find",
@@ -283,6 +295,7 @@
283
295
  "urlTemplate": "/sso-users/copy-users",
284
296
  "method": "POST",
285
297
  "comment": "Copy editors as SSO users",
298
+ "optionalRequestBody": false,
286
299
  "queryParamsRequired": false,
287
300
  "responseType": "SsoUserCopyUsersTargetSchema",
288
301
  "name": "copyUsers",
@@ -300,6 +313,7 @@
300
313
  "isEntityId": false,
301
314
  "relType": "UserData"
302
315
  },
316
+ "optionalRequestBody": false,
303
317
  "queryParamsType": "SsoUserDestroyHrefSchema",
304
318
  "queryParamsRequired": false,
305
319
  "responseType": "SsoUserDestroyTargetSchema",
@@ -321,6 +335,7 @@
321
335
  "method": "POST",
322
336
  "comment": "List Audit Log events",
323
337
  "requestBodyType": "AuditLogEventQuerySchema",
338
+ "optionalRequestBody": false,
324
339
  "requestStructure": {
325
340
  "type": "audit_log_query",
326
341
  "attributes": [
@@ -350,6 +365,7 @@
350
365
  "method": "POST",
351
366
  "comment": "Create a new menu item",
352
367
  "requestBodyType": "MenuItemCreateSchema",
368
+ "optionalRequestBody": false,
353
369
  "requestStructure": {
354
370
  "type": "menu_item",
355
371
  "attributes": [
@@ -382,6 +398,7 @@
382
398
  "relType": "MenuItemData"
383
399
  },
384
400
  "requestBodyType": "MenuItemUpdateSchema",
401
+ "optionalRequestBody": false,
385
402
  "requestStructure": {
386
403
  "type": "menu_item",
387
404
  "attributes": [
@@ -408,6 +425,7 @@
408
425
  "urlTemplate": "/menu-items",
409
426
  "method": "GET",
410
427
  "comment": "List all menu items",
428
+ "optionalRequestBody": false,
411
429
  "queryParamsType": "MenuItemInstancesHrefSchema",
412
430
  "queryParamsRequired": false,
413
431
  "responseType": "MenuItemInstancesTargetSchema",
@@ -426,6 +444,7 @@
426
444
  "isEntityId": true,
427
445
  "relType": "MenuItemData"
428
446
  },
447
+ "optionalRequestBody": false,
429
448
  "queryParamsRequired": false,
430
449
  "responseType": "MenuItemSelfTargetSchema",
431
450
  "name": "find",
@@ -443,6 +462,7 @@
443
462
  "isEntityId": true,
444
463
  "relType": "MenuItemData"
445
464
  },
465
+ "optionalRequestBody": false,
446
466
  "queryParamsRequired": false,
447
467
  "responseType": "MenuItemDestroyTargetSchema",
448
468
  "name": "destroy",
@@ -463,6 +483,7 @@
463
483
  "method": "POST",
464
484
  "comment": "Create a new model",
465
485
  "requestBodyType": "ItemTypeCreateSchema",
486
+ "optionalRequestBody": false,
466
487
  "requestStructure": {
467
488
  "type": "item_type",
468
489
  "attributes": [
@@ -508,6 +529,7 @@
508
529
  "relType": "ItemTypeData"
509
530
  },
510
531
  "requestBodyType": "ItemTypeUpdateSchema",
532
+ "optionalRequestBody": false,
511
533
  "requestStructure": {
512
534
  "type": "item_type",
513
535
  "attributes": [
@@ -547,6 +569,7 @@
547
569
  "urlTemplate": "/item-types",
548
570
  "method": "GET",
549
571
  "comment": "List all models",
572
+ "optionalRequestBody": false,
550
573
  "queryParamsRequired": false,
551
574
  "responseType": "ItemTypeInstancesTargetSchema",
552
575
  "name": "list",
@@ -564,6 +587,7 @@
564
587
  "isEntityId": true,
565
588
  "relType": "ItemTypeData"
566
589
  },
590
+ "optionalRequestBody": false,
567
591
  "queryParamsRequired": false,
568
592
  "responseType": "ItemTypeSelfTargetSchema",
569
593
  "name": "find",
@@ -581,6 +605,7 @@
581
605
  "isEntityId": true,
582
606
  "relType": "ItemTypeData"
583
607
  },
608
+ "optionalRequestBody": false,
584
609
  "queryParamsRequired": false,
585
610
  "responseType": "ItemTypeDuplicateTargetSchema",
586
611
  "name": "duplicate",
@@ -598,6 +623,7 @@
598
623
  "isEntityId": true,
599
624
  "relType": "ItemTypeData"
600
625
  },
626
+ "optionalRequestBody": false,
601
627
  "queryParamsType": "ItemTypeDestroyHrefSchema",
602
628
  "queryParamsRequired": false,
603
629
  "responseType": "ItemTypeDestroyJobSchema",
@@ -624,6 +650,7 @@
624
650
  "relType": "ItemTypeData"
625
651
  },
626
652
  "requestBodyType": "FieldCreateSchema",
653
+ "optionalRequestBody": false,
627
654
  "requestStructure": {
628
655
  "type": "field",
629
656
  "attributes": [
@@ -660,6 +687,7 @@
660
687
  "relType": "FieldData"
661
688
  },
662
689
  "requestBodyType": "FieldUpdateSchema",
690
+ "optionalRequestBody": false,
663
691
  "requestStructure": {
664
692
  "type": "field",
665
693
  "attributes": [
@@ -695,6 +723,7 @@
695
723
  "isEntityId": false,
696
724
  "relType": "ItemTypeData"
697
725
  },
726
+ "optionalRequestBody": false,
698
727
  "queryParamsRequired": false,
699
728
  "responseType": "FieldInstancesTargetSchema",
700
729
  "name": "list",
@@ -712,6 +741,7 @@
712
741
  "isEntityId": false,
713
742
  "relType": "ItemTypeData"
714
743
  },
744
+ "optionalRequestBody": false,
715
745
  "queryParamsRequired": false,
716
746
  "responseType": "FieldReferencingTargetSchema",
717
747
  "deprecated": "This API call is to be considered private and might change without notice",
@@ -730,6 +760,7 @@
730
760
  "isEntityId": false,
731
761
  "relType": "ItemTypeData"
732
762
  },
763
+ "optionalRequestBody": false,
733
764
  "queryParamsRequired": false,
734
765
  "responseType": "FieldRelatedTargetSchema",
735
766
  "deprecated": "This API call is to be considered private and might change without notice",
@@ -748,6 +779,7 @@
748
779
  "isEntityId": true,
749
780
  "relType": "FieldData"
750
781
  },
782
+ "optionalRequestBody": false,
751
783
  "queryParamsRequired": false,
752
784
  "responseType": "FieldSelfTargetSchema",
753
785
  "name": "find",
@@ -765,6 +797,7 @@
765
797
  "isEntityId": true,
766
798
  "relType": "FieldData"
767
799
  },
800
+ "optionalRequestBody": false,
768
801
  "queryParamsRequired": false,
769
802
  "responseType": "FieldDestroyJobSchema",
770
803
  "name": "destroy",
@@ -782,6 +815,7 @@
782
815
  "isEntityId": true,
783
816
  "relType": "FieldData"
784
817
  },
818
+ "optionalRequestBody": false,
785
819
  "queryParamsRequired": false,
786
820
  "responseType": "FieldDuplicateJobSchema",
787
821
  "name": "duplicate",
@@ -807,6 +841,7 @@
807
841
  "relType": "ItemTypeData"
808
842
  },
809
843
  "requestBodyType": "FieldsetCreateSchema",
844
+ "optionalRequestBody": false,
810
845
  "requestStructure": {
811
846
  "type": "fieldset",
812
847
  "attributes": [
@@ -836,6 +871,7 @@
836
871
  "relType": "FieldsetData"
837
872
  },
838
873
  "requestBodyType": "FieldsetUpdateSchema",
874
+ "optionalRequestBody": false,
839
875
  "requestStructure": {
840
876
  "type": "fieldset",
841
877
  "attributes": [
@@ -864,6 +900,7 @@
864
900
  "isEntityId": false,
865
901
  "relType": "ItemTypeData"
866
902
  },
903
+ "optionalRequestBody": false,
867
904
  "queryParamsRequired": false,
868
905
  "responseType": "FieldsetInstancesTargetSchema",
869
906
  "name": "list",
@@ -881,6 +918,7 @@
881
918
  "isEntityId": true,
882
919
  "relType": "FieldsetData"
883
920
  },
921
+ "optionalRequestBody": false,
884
922
  "queryParamsRequired": false,
885
923
  "responseType": "FieldsetSelfTargetSchema",
886
924
  "name": "find",
@@ -898,6 +936,7 @@
898
936
  "isEntityId": true,
899
937
  "relType": "FieldsetData"
900
938
  },
939
+ "optionalRequestBody": false,
901
940
  "queryParamsRequired": false,
902
941
  "responseType": "FieldsetDestroyTargetSchema",
903
942
  "name": "destroy",
@@ -918,6 +957,7 @@
918
957
  "method": "POST",
919
958
  "comment": "Create a new session",
920
959
  "requestBodyType": "SessionCreateSchema",
960
+ "optionalRequestBody": false,
921
961
  "requestStructure": {
922
962
  "type": "email_credentials",
923
963
  "attributes": [
@@ -948,6 +988,7 @@
948
988
  "method": "POST",
949
989
  "comment": "Create a new API token",
950
990
  "requestBodyType": "AccessTokenCreateSchema",
991
+ "optionalRequestBody": false,
951
992
  "requestStructure": {
952
993
  "type": "access_token",
953
994
  "attributes": [
@@ -978,6 +1019,7 @@
978
1019
  "relType": "AccessTokenData"
979
1020
  },
980
1021
  "requestBodyType": "AccessTokenUpdateSchema",
1022
+ "optionalRequestBody": false,
981
1023
  "requestStructure": {
982
1024
  "type": "access_token",
983
1025
  "attributes": [
@@ -1002,6 +1044,7 @@
1002
1044
  "urlTemplate": "/access_tokens",
1003
1045
  "method": "GET",
1004
1046
  "comment": "List all API tokens",
1047
+ "optionalRequestBody": false,
1005
1048
  "queryParamsRequired": false,
1006
1049
  "responseType": "AccessTokenInstancesTargetSchema",
1007
1050
  "name": "list",
@@ -1019,6 +1062,7 @@
1019
1062
  "isEntityId": true,
1020
1063
  "relType": "AccessTokenData"
1021
1064
  },
1065
+ "optionalRequestBody": false,
1022
1066
  "queryParamsRequired": false,
1023
1067
  "responseType": "AccessTokenSelfTargetSchema",
1024
1068
  "name": "find",
@@ -1036,6 +1080,7 @@
1036
1080
  "isEntityId": true,
1037
1081
  "relType": "AccessTokenData"
1038
1082
  },
1083
+ "optionalRequestBody": false,
1039
1084
  "queryParamsRequired": false,
1040
1085
  "responseType": "AccessTokenRegenerateTokenTargetSchema",
1041
1086
  "name": "regenerateToken",
@@ -1053,6 +1098,7 @@
1053
1098
  "isEntityId": true,
1054
1099
  "relType": "AccessTokenData"
1055
1100
  },
1101
+ "optionalRequestBody": false,
1056
1102
  "queryParamsType": "AccessTokenDestroyHrefSchema",
1057
1103
  "queryParamsRequired": false,
1058
1104
  "responseType": "AccessTokenDestroyTargetSchema",
@@ -1074,6 +1120,7 @@
1074
1120
  "method": "POST",
1075
1121
  "comment": "Create a new plugin",
1076
1122
  "requestBodyType": "PluginCreateSchema",
1123
+ "optionalRequestBody": false,
1077
1124
  "requestStructure": {
1078
1125
  "type": "plugin",
1079
1126
  "attributes": [
@@ -1107,6 +1154,7 @@
1107
1154
  "relType": "PluginData"
1108
1155
  },
1109
1156
  "requestBodyType": "PluginUpdateSchema",
1157
+ "optionalRequestBody": false,
1110
1158
  "requestStructure": {
1111
1159
  "type": "plugin",
1112
1160
  "attributes": [
@@ -1131,6 +1179,7 @@
1131
1179
  "urlTemplate": "/plugins",
1132
1180
  "method": "GET",
1133
1181
  "comment": "List all plugins",
1182
+ "optionalRequestBody": false,
1134
1183
  "queryParamsRequired": false,
1135
1184
  "responseType": "PluginInstancesTargetSchema",
1136
1185
  "name": "list",
@@ -1142,12 +1191,13 @@
1142
1191
  "rel": "self",
1143
1192
  "urlTemplate": "/plugins/${pluginId}",
1144
1193
  "method": "GET",
1145
- "comment": "Retrieve a plugins",
1194
+ "comment": "Retrieve a plugin",
1146
1195
  "urlPlaceholder": {
1147
1196
  "variableName": "pluginId",
1148
1197
  "isEntityId": true,
1149
1198
  "relType": "PluginData"
1150
1199
  },
1200
+ "optionalRequestBody": false,
1151
1201
  "queryParamsRequired": false,
1152
1202
  "responseType": "PluginSelfTargetSchema",
1153
1203
  "name": "find",
@@ -1165,6 +1215,7 @@
1165
1215
  "isEntityId": true,
1166
1216
  "relType": "PluginData"
1167
1217
  },
1218
+ "optionalRequestBody": false,
1168
1219
  "queryParamsRequired": false,
1169
1220
  "responseType": "PluginDestroyTargetSchema",
1170
1221
  "name": "destroy",
@@ -1182,6 +1233,7 @@
1182
1233
  "isEntityId": true,
1183
1234
  "relType": "PluginData"
1184
1235
  },
1236
+ "optionalRequestBody": false,
1185
1237
  "queryParamsRequired": false,
1186
1238
  "responseType": "PluginFieldsTargetSchema",
1187
1239
  "name": "fields",
@@ -1206,6 +1258,7 @@
1206
1258
  "isEntityId": true,
1207
1259
  "relType": "JobResultData"
1208
1260
  },
1261
+ "optionalRequestBody": false,
1209
1262
  "queryParamsRequired": false,
1210
1263
  "responseType": "JobResultSelfTargetSchema",
1211
1264
  "name": "find",
@@ -1225,6 +1278,7 @@
1225
1278
  "urlTemplate": "/subscription-limits",
1226
1279
  "method": "GET",
1227
1280
  "comment": "Get all the subscription limits",
1281
+ "optionalRequestBody": false,
1228
1282
  "queryParamsRequired": false,
1229
1283
  "responseType": "SubscriptionLimitInstancesTargetSchema",
1230
1284
  "name": "list",
@@ -1242,6 +1296,7 @@
1242
1296
  "isEntityId": true,
1243
1297
  "relType": "SubscriptionLimitData"
1244
1298
  },
1299
+ "optionalRequestBody": false,
1245
1300
  "queryParamsRequired": false,
1246
1301
  "responseType": "SubscriptionLimitSelfTargetSchema",
1247
1302
  "name": "find",
@@ -1261,6 +1316,7 @@
1261
1316
  "urlTemplate": "/subscription-features",
1262
1317
  "method": "GET",
1263
1318
  "comment": "Get all the subscription features",
1319
+ "optionalRequestBody": false,
1264
1320
  "queryParamsRequired": false,
1265
1321
  "responseType": "SubscriptionFeatureInstancesTargetSchema",
1266
1322
  "name": "list",
@@ -1280,6 +1336,7 @@
1280
1336
  "urlTemplate": "/build-events",
1281
1337
  "method": "GET",
1282
1338
  "comment": "List all deploy events",
1339
+ "optionalRequestBody": false,
1283
1340
  "queryParamsRequired": false,
1284
1341
  "responseType": "BuildEventInstancesTargetSchema",
1285
1342
  "name": "list",
@@ -1297,6 +1354,7 @@
1297
1354
  "isEntityId": true,
1298
1355
  "relType": "BuildEventData"
1299
1356
  },
1357
+ "optionalRequestBody": false,
1300
1358
  "queryParamsRequired": false,
1301
1359
  "responseType": "BuildEventSelfTargetSchema",
1302
1360
  "name": "find",
@@ -1316,6 +1374,7 @@
1316
1374
  "urlTemplate": "/items",
1317
1375
  "method": "GET",
1318
1376
  "comment": "List all records",
1377
+ "optionalRequestBody": false,
1319
1378
  "queryParamsType": "ItemInstancesHrefSchema",
1320
1379
  "queryParamsRequired": false,
1321
1380
  "responseType": "ItemInstancesTargetSchema",
@@ -1339,6 +1398,7 @@
1339
1398
  "relType": "ItemData"
1340
1399
  },
1341
1400
  "requestBodyType": "ItemValidateExistingSchema",
1401
+ "optionalRequestBody": false,
1342
1402
  "requestStructure": {
1343
1403
  "type": "item",
1344
1404
  "attributes": "*",
@@ -1360,6 +1420,7 @@
1360
1420
  "method": "POST",
1361
1421
  "comment": "Validates a record field",
1362
1422
  "requestBodyType": "ItemValidateNewSchema",
1423
+ "optionalRequestBody": false,
1363
1424
  "requestStructure": {
1364
1425
  "type": "item",
1365
1426
  "attributes": "*",
@@ -1381,6 +1442,7 @@
1381
1442
  "method": "POST",
1382
1443
  "comment": "Create a new record",
1383
1444
  "requestBodyType": "ItemCreateSchema",
1445
+ "optionalRequestBody": false,
1384
1446
  "requestStructure": {
1385
1447
  "type": "item",
1386
1448
  "attributes": "*",
@@ -1406,6 +1468,7 @@
1406
1468
  "isEntityId": true,
1407
1469
  "relType": "ItemData"
1408
1470
  },
1471
+ "optionalRequestBody": false,
1409
1472
  "queryParamsRequired": false,
1410
1473
  "responseType": "ItemDuplicateJobSchema",
1411
1474
  "name": "duplicate",
@@ -1424,6 +1487,7 @@
1424
1487
  "relType": "ItemData"
1425
1488
  },
1426
1489
  "requestBodyType": "ItemUpdateSchema",
1490
+ "optionalRequestBody": false,
1427
1491
  "requestStructure": {
1428
1492
  "type": "item",
1429
1493
  "attributes": "*",
@@ -1449,6 +1513,7 @@
1449
1513
  "isEntityId": true,
1450
1514
  "relType": "ItemData"
1451
1515
  },
1516
+ "optionalRequestBody": false,
1452
1517
  "queryParamsType": "ItemReferencesHrefSchema",
1453
1518
  "queryParamsRequired": false,
1454
1519
  "responseType": "ItemReferencesTargetSchema",
@@ -1467,12 +1532,32 @@
1467
1532
  "isEntityId": true,
1468
1533
  "relType": "ItemData"
1469
1534
  },
1535
+ "optionalRequestBody": false,
1470
1536
  "queryParamsType": "ItemSelfHrefSchema",
1471
1537
  "queryParamsRequired": false,
1472
1538
  "responseType": "ItemSelfTargetSchema",
1473
1539
  "name": "find",
1474
1540
  "rawName": "rawFind"
1475
1541
  },
1542
+ {
1543
+ "returnsCollection": false,
1544
+ "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/current_vs_published_state",
1545
+ "rel": "current_vs_published_state",
1546
+ "urlTemplate": "/items/${itemId}/current-vs-published-state",
1547
+ "method": "GET",
1548
+ "comment": "Retrieve information regarding changes between current and published versions of the record",
1549
+ "urlPlaceholder": {
1550
+ "variableName": "itemId",
1551
+ "isEntityId": true,
1552
+ "relType": "ItemData"
1553
+ },
1554
+ "optionalRequestBody": false,
1555
+ "queryParamsRequired": false,
1556
+ "responseType": "ItemCurrentVsPublishedStateTargetSchema",
1557
+ "deprecated": "This API call is to be considered private and might change without notice",
1558
+ "name": "currentVsPublishedState",
1559
+ "rawName": "rawCurrentVsPublishedState"
1560
+ },
1476
1561
  {
1477
1562
  "returnsCollection": false,
1478
1563
  "docUrl": "https://www.datocms.com/docs/content-management-api/resources/item/destroy",
@@ -1485,6 +1570,7 @@
1485
1570
  "isEntityId": true,
1486
1571
  "relType": "ItemData"
1487
1572
  },
1573
+ "optionalRequestBody": false,
1488
1574
  "queryParamsRequired": false,
1489
1575
  "responseType": "ItemDestroyJobSchema",
1490
1576
  "name": "destroy",
@@ -1497,6 +1583,7 @@
1497
1583
  "urlTemplate": "/items",
1498
1584
  "method": "DELETE",
1499
1585
  "comment": "Delete multiple records",
1586
+ "optionalRequestBody": false,
1500
1587
  "queryParamsType": "ItemBatchDestroyHrefSchema",
1501
1588
  "queryParamsRequired": true,
1502
1589
  "responseType": "ItemBatchDestroyJobSchema",
@@ -1511,6 +1598,7 @@
1511
1598
  "urlTemplate": "/items/publish",
1512
1599
  "method": "PUT",
1513
1600
  "comment": "Publish multiple records",
1601
+ "optionalRequestBody": false,
1514
1602
  "queryParamsType": "ItemBatchPublishHrefSchema",
1515
1603
  "queryParamsRequired": true,
1516
1604
  "responseType": "ItemBatchPublishJobSchema",
@@ -1525,6 +1613,7 @@
1525
1613
  "urlTemplate": "/items/unpublish",
1526
1614
  "method": "PUT",
1527
1615
  "comment": "Unpublish multiple records",
1616
+ "optionalRequestBody": false,
1528
1617
  "queryParamsType": "ItemBatchUnpublishHrefSchema",
1529
1618
  "queryParamsRequired": true,
1530
1619
  "responseType": "ItemBatchUnpublishJobSchema",
@@ -1544,6 +1633,16 @@
1544
1633
  "isEntityId": true,
1545
1634
  "relType": "ItemData"
1546
1635
  },
1636
+ "requestBodyType": "ItemPublishSchema",
1637
+ "optionalRequestBody": true,
1638
+ "requestStructure": {
1639
+ "type": "selective_publish_operation",
1640
+ "attributes": [
1641
+ "content_in_locales",
1642
+ "non_localized_content"
1643
+ ],
1644
+ "relationships": []
1645
+ },
1547
1646
  "queryParamsType": "ItemPublishHrefSchema",
1548
1647
  "queryParamsRequired": false,
1549
1648
  "responseType": "ItemPublishTargetSchema",
@@ -1562,6 +1661,15 @@
1562
1661
  "isEntityId": true,
1563
1662
  "relType": "ItemData"
1564
1663
  },
1664
+ "requestBodyType": "ItemUnpublishSchema",
1665
+ "optionalRequestBody": true,
1666
+ "requestStructure": {
1667
+ "type": "selective_unpublish_operation",
1668
+ "attributes": [
1669
+ "content_in_locales"
1670
+ ],
1671
+ "relationships": []
1672
+ },
1565
1673
  "queryParamsType": "ItemUnpublishHrefSchema",
1566
1674
  "queryParamsRequired": false,
1567
1675
  "responseType": "ItemUnpublishTargetSchema",
@@ -1576,6 +1684,7 @@
1576
1684
  "method": "POST",
1577
1685
  "comment": "Publish items in bulk",
1578
1686
  "requestBodyType": "ItemBulkPublishSchema",
1687
+ "optionalRequestBody": false,
1579
1688
  "requestStructure": {
1580
1689
  "type": "item_bulk_publish_operation",
1581
1690
  "attributes": [],
@@ -1596,6 +1705,7 @@
1596
1705
  "method": "POST",
1597
1706
  "comment": "Unpublish items in bulk",
1598
1707
  "requestBodyType": "ItemBulkUnpublishSchema",
1708
+ "optionalRequestBody": false,
1599
1709
  "requestStructure": {
1600
1710
  "type": "item_bulk_unpublish_operation",
1601
1711
  "attributes": [],
@@ -1616,6 +1726,7 @@
1616
1726
  "method": "POST",
1617
1727
  "comment": "Destroy items in bulk",
1618
1728
  "requestBodyType": "ItemBulkDestroySchema",
1729
+ "optionalRequestBody": false,
1619
1730
  "requestStructure": {
1620
1731
  "type": "item_bulk_destroy_operation",
1621
1732
  "attributes": [],
@@ -1636,6 +1747,7 @@
1636
1747
  "method": "POST",
1637
1748
  "comment": "Move items to stage in bulk",
1638
1749
  "requestBodyType": "ItemBulkMoveToStageSchema",
1750
+ "optionalRequestBody": false,
1639
1751
  "requestStructure": {
1640
1752
  "type": "item_bulk_move_to_stage_operation",
1641
1753
  "attributes": [
@@ -1669,6 +1781,7 @@
1669
1781
  "isEntityId": true,
1670
1782
  "relType": "ItemVersionData"
1671
1783
  },
1784
+ "optionalRequestBody": false,
1672
1785
  "queryParamsRequired": false,
1673
1786
  "responseType": "ItemVersionRestoreJobSchema",
1674
1787
  "name": "restore",
@@ -1686,6 +1799,7 @@
1686
1799
  "isEntityId": false,
1687
1800
  "relType": "ItemData"
1688
1801
  },
1802
+ "optionalRequestBody": false,
1689
1803
  "queryParamsType": "ItemVersionInstancesHrefSchema",
1690
1804
  "queryParamsRequired": false,
1691
1805
  "responseType": "ItemVersionInstancesTargetSchema",
@@ -1708,6 +1822,7 @@
1708
1822
  "isEntityId": true,
1709
1823
  "relType": "ItemVersionData"
1710
1824
  },
1825
+ "optionalRequestBody": false,
1711
1826
  "queryParamsRequired": false,
1712
1827
  "responseType": "ItemVersionSelfTargetSchema",
1713
1828
  "name": "find",
@@ -1728,6 +1843,7 @@
1728
1843
  "method": "POST",
1729
1844
  "comment": "Create a new upload",
1730
1845
  "requestBodyType": "UploadCreateSchema",
1846
+ "optionalRequestBody": false,
1731
1847
  "requestStructure": {
1732
1848
  "type": "upload",
1733
1849
  "attributes": [
@@ -1752,6 +1868,7 @@
1752
1868
  "urlTemplate": "/uploads",
1753
1869
  "method": "GET",
1754
1870
  "comment": "List all uploads",
1871
+ "optionalRequestBody": false,
1755
1872
  "queryParamsType": "UploadInstancesHrefSchema",
1756
1873
  "queryParamsRequired": false,
1757
1874
  "responseType": "UploadInstancesTargetSchema",
@@ -1774,6 +1891,7 @@
1774
1891
  "isEntityId": true,
1775
1892
  "relType": "UploadData"
1776
1893
  },
1894
+ "optionalRequestBody": false,
1777
1895
  "queryParamsRequired": false,
1778
1896
  "responseType": "UploadSelfTargetSchema",
1779
1897
  "name": "find",
@@ -1791,6 +1909,7 @@
1791
1909
  "isEntityId": true,
1792
1910
  "relType": "UploadData"
1793
1911
  },
1912
+ "optionalRequestBody": false,
1794
1913
  "queryParamsRequired": false,
1795
1914
  "responseType": "UploadDestroyTargetSchema",
1796
1915
  "name": "destroy",
@@ -1809,6 +1928,7 @@
1809
1928
  "relType": "UploadData"
1810
1929
  },
1811
1930
  "requestBodyType": "UploadUpdateSchema",
1931
+ "optionalRequestBody": false,
1812
1932
  "requestStructure": {
1813
1933
  "type": "upload",
1814
1934
  "attributes": [
@@ -1837,6 +1957,7 @@
1837
1957
  "method": "PUT",
1838
1958
  "comment": "Batch add tags to uploads",
1839
1959
  "requestBodyType": "UploadBatchAddTagsSchema",
1960
+ "optionalRequestBody": false,
1840
1961
  "requestStructure": {
1841
1962
  "type": "upload",
1842
1963
  "attributes": [
@@ -1858,6 +1979,7 @@
1858
1979
  "urlTemplate": "/uploads/batch-destroy",
1859
1980
  "method": "DELETE",
1860
1981
  "comment": "Delete multiple uploads",
1982
+ "optionalRequestBody": false,
1861
1983
  "queryParamsType": "UploadBatchDestroyHrefSchema",
1862
1984
  "queryParamsRequired": false,
1863
1985
  "responseType": "UploadBatchDestroyJobSchema",
@@ -1877,6 +1999,7 @@
1877
1999
  "isEntityId": true,
1878
2000
  "relType": "UploadData"
1879
2001
  },
2002
+ "optionalRequestBody": false,
1880
2003
  "queryParamsType": "UploadReferencesHrefSchema",
1881
2004
  "queryParamsRequired": false,
1882
2005
  "responseType": "UploadReferencesTargetSchema",
@@ -1891,6 +2014,7 @@
1891
2014
  "method": "POST",
1892
2015
  "comment": "Add tags to assets in bulk",
1893
2016
  "requestBodyType": "UploadBulkTagSchema",
2017
+ "optionalRequestBody": false,
1894
2018
  "requestStructure": {
1895
2019
  "type": "upload_bulk_tag_operation",
1896
2020
  "attributes": [
@@ -1913,6 +2037,7 @@
1913
2037
  "method": "POST",
1914
2038
  "comment": "Destroy uploads",
1915
2039
  "requestBodyType": "UploadBulkDestroySchema",
2040
+ "optionalRequestBody": false,
1916
2041
  "requestStructure": {
1917
2042
  "type": "upload_bulk_destroy_operation",
1918
2043
  "attributes": [],
@@ -1940,6 +2065,7 @@
1940
2065
  "method": "POST",
1941
2066
  "comment": "Request a new upload",
1942
2067
  "requestBodyType": "UploadRequestCreateSchema",
2068
+ "optionalRequestBody": false,
1943
2069
  "requestStructure": {
1944
2070
  "type": "upload_request",
1945
2071
  "attributes": [
@@ -1972,10 +2098,12 @@
1972
2098
  "relType": "ItemData"
1973
2099
  },
1974
2100
  "requestBodyType": "ScheduledPublicationCreateSchema",
2101
+ "optionalRequestBody": false,
1975
2102
  "requestStructure": {
1976
2103
  "type": "scheduled_publication",
1977
2104
  "attributes": [
1978
- "publication_scheduled_at"
2105
+ "publication_scheduled_at",
2106
+ "selective_publication"
1979
2107
  ],
1980
2108
  "relationships": []
1981
2109
  },
@@ -1996,6 +2124,7 @@
1996
2124
  "isEntityId": false,
1997
2125
  "relType": "ItemData"
1998
2126
  },
2127
+ "optionalRequestBody": false,
1999
2128
  "queryParamsRequired": false,
2000
2129
  "responseType": "ScheduledPublicationDestroyTargetSchema",
2001
2130
  "name": "destroy",
@@ -2021,10 +2150,12 @@
2021
2150
  "relType": "ItemData"
2022
2151
  },
2023
2152
  "requestBodyType": "ScheduledUnpublishingCreateSchema",
2153
+ "optionalRequestBody": false,
2024
2154
  "requestStructure": {
2025
2155
  "type": "scheduled_unpublishing",
2026
2156
  "attributes": [
2027
- "unpublishing_scheduled_at"
2157
+ "unpublishing_scheduled_at",
2158
+ "content_in_locales"
2028
2159
  ],
2029
2160
  "relationships": []
2030
2161
  },
@@ -2045,6 +2176,7 @@
2045
2176
  "isEntityId": false,
2046
2177
  "relType": "ItemData"
2047
2178
  },
2179
+ "optionalRequestBody": false,
2048
2180
  "queryParamsRequired": false,
2049
2181
  "responseType": "ScheduledUnpublishingDestroyTargetSchema",
2050
2182
  "name": "destroy",
@@ -2064,6 +2196,7 @@
2064
2196
  "urlTemplate": "/search-results",
2065
2197
  "method": "GET",
2066
2198
  "comment": "Search for results",
2199
+ "optionalRequestBody": false,
2067
2200
  "queryParamsType": "SearchResultInstancesHrefSchema",
2068
2201
  "queryParamsRequired": true,
2069
2202
  "responseType": "SearchResultInstancesTargetSchema",
@@ -2094,6 +2227,7 @@
2094
2227
  "relType": "EnvironmentData"
2095
2228
  },
2096
2229
  "requestBodyType": "EnvironmentForkSchema",
2230
+ "optionalRequestBody": false,
2097
2231
  "requestStructure": {
2098
2232
  "type": "environment",
2099
2233
  "attributes": [],
@@ -2117,6 +2251,7 @@
2117
2251
  "isEntityId": true,
2118
2252
  "relType": "EnvironmentData"
2119
2253
  },
2254
+ "optionalRequestBody": false,
2120
2255
  "queryParamsRequired": false,
2121
2256
  "responseType": "EnvironmentPromoteTargetSchema",
2122
2257
  "name": "promote",
@@ -2129,6 +2264,7 @@
2129
2264
  "urlTemplate": "/environments",
2130
2265
  "method": "GET",
2131
2266
  "comment": "List all environments",
2267
+ "optionalRequestBody": false,
2132
2268
  "queryParamsRequired": false,
2133
2269
  "responseType": "EnvironmentInstancesTargetSchema",
2134
2270
  "name": "list",
@@ -2146,6 +2282,7 @@
2146
2282
  "isEntityId": true,
2147
2283
  "relType": "EnvironmentData"
2148
2284
  },
2285
+ "optionalRequestBody": false,
2149
2286
  "queryParamsRequired": false,
2150
2287
  "responseType": "EnvironmentSelfTargetSchema",
2151
2288
  "name": "find",
@@ -2163,6 +2300,7 @@
2163
2300
  "isEntityId": true,
2164
2301
  "relType": "EnvironmentData"
2165
2302
  },
2303
+ "optionalRequestBody": false,
2166
2304
  "queryParamsRequired": false,
2167
2305
  "responseType": "EnvironmentDestroyJobSchema",
2168
2306
  "name": "destroy",
@@ -2182,6 +2320,7 @@
2182
2320
  "urlTemplate": "/maintenance-mode",
2183
2321
  "method": "GET",
2184
2322
  "comment": "Retrieve maintenence mode",
2323
+ "optionalRequestBody": false,
2185
2324
  "queryParamsRequired": false,
2186
2325
  "responseType": "MaintenanceModeSelfTargetSchema",
2187
2326
  "name": "find",
@@ -2194,6 +2333,7 @@
2194
2333
  "urlTemplate": "/maintenance-mode/activate",
2195
2334
  "method": "PUT",
2196
2335
  "comment": "Activate maintenance mode: this means that the primary environment will be read-only",
2336
+ "optionalRequestBody": false,
2197
2337
  "queryParamsType": "MaintenanceModeActivateHrefSchema",
2198
2338
  "queryParamsRequired": false,
2199
2339
  "responseType": "MaintenanceModeActivateTargetSchema",
@@ -2207,6 +2347,7 @@
2207
2347
  "urlTemplate": "/maintenance-mode/deactivate",
2208
2348
  "method": "PUT",
2209
2349
  "comment": "De-activate maintenance mode",
2350
+ "optionalRequestBody": false,
2210
2351
  "queryParamsRequired": false,
2211
2352
  "responseType": "MaintenanceModeDeactivateTargetSchema",
2212
2353
  "name": "deactivate",
@@ -2227,6 +2368,7 @@
2227
2368
  "method": "POST",
2228
2369
  "comment": "Create a new webhook",
2229
2370
  "requestBodyType": "WebhookCreateSchema",
2371
+ "optionalRequestBody": false,
2230
2372
  "requestStructure": {
2231
2373
  "type": "webhook",
2232
2374
  "attributes": [
@@ -2261,6 +2403,7 @@
2261
2403
  "relType": "UserData"
2262
2404
  },
2263
2405
  "requestBodyType": "WebhookUpdateSchema",
2406
+ "optionalRequestBody": false,
2264
2407
  "requestStructure": {
2265
2408
  "type": "webhook",
2266
2409
  "attributes": [
@@ -2289,6 +2432,7 @@
2289
2432
  "urlTemplate": "/webhooks",
2290
2433
  "method": "GET",
2291
2434
  "comment": "List all webhooks",
2435
+ "optionalRequestBody": false,
2292
2436
  "queryParamsRequired": false,
2293
2437
  "responseType": "WebhookInstancesTargetSchema",
2294
2438
  "name": "list",
@@ -2306,6 +2450,7 @@
2306
2450
  "isEntityId": false,
2307
2451
  "relType": "UserData"
2308
2452
  },
2453
+ "optionalRequestBody": false,
2309
2454
  "queryParamsRequired": false,
2310
2455
  "responseType": "WebhookSelfTargetSchema",
2311
2456
  "name": "find",
@@ -2323,6 +2468,7 @@
2323
2468
  "isEntityId": false,
2324
2469
  "relType": "UserData"
2325
2470
  },
2471
+ "optionalRequestBody": false,
2326
2472
  "queryParamsRequired": false,
2327
2473
  "responseType": "WebhookDestroyTargetSchema",
2328
2474
  "name": "destroy",
@@ -2342,6 +2488,7 @@
2342
2488
  "urlTemplate": "/webhook_calls",
2343
2489
  "method": "GET",
2344
2490
  "comment": "List all webhooks calls",
2491
+ "optionalRequestBody": false,
2345
2492
  "queryParamsType": "WebhookCallInstancesHrefSchema",
2346
2493
  "queryParamsRequired": false,
2347
2494
  "responseType": "WebhookCallInstancesTargetSchema",
@@ -2364,6 +2511,7 @@
2364
2511
  "isEntityId": false,
2365
2512
  "relType": "UserData"
2366
2513
  },
2514
+ "optionalRequestBody": false,
2367
2515
  "queryParamsRequired": false,
2368
2516
  "name": "resendWebhook",
2369
2517
  "rawName": "rawResendWebhook"
@@ -2382,6 +2530,7 @@
2382
2530
  "urlTemplate": "/build-triggers",
2383
2531
  "method": "GET",
2384
2532
  "comment": "List all build triggers for a site",
2533
+ "optionalRequestBody": false,
2385
2534
  "queryParamsRequired": false,
2386
2535
  "responseType": "BuildTriggerInstancesTargetSchema",
2387
2536
  "name": "list",
@@ -2399,6 +2548,7 @@
2399
2548
  "isEntityId": true,
2400
2549
  "relType": "BuildTriggerData"
2401
2550
  },
2551
+ "optionalRequestBody": false,
2402
2552
  "queryParamsRequired": false,
2403
2553
  "responseType": "BuildTriggerSelfTargetSchema",
2404
2554
  "name": "find",
@@ -2412,6 +2562,7 @@
2412
2562
  "method": "POST",
2413
2563
  "comment": "Create build trigger",
2414
2564
  "requestBodyType": "BuildTriggerCreateSchema",
2565
+ "optionalRequestBody": false,
2415
2566
  "requestStructure": {
2416
2567
  "type": "build_trigger",
2417
2568
  "attributes": [
@@ -2443,6 +2594,7 @@
2443
2594
  "relType": "BuildTriggerData"
2444
2595
  },
2445
2596
  "requestBodyType": "BuildTriggerUpdateSchema",
2597
+ "optionalRequestBody": false,
2446
2598
  "requestStructure": {
2447
2599
  "type": "build_trigger",
2448
2600
  "attributes": [
@@ -2472,6 +2624,7 @@
2472
2624
  "isEntityId": true,
2473
2625
  "relType": "BuildTriggerData"
2474
2626
  },
2627
+ "optionalRequestBody": false,
2475
2628
  "queryParamsRequired": false,
2476
2629
  "name": "trigger",
2477
2630
  "rawName": "rawTrigger"
@@ -2488,6 +2641,7 @@
2488
2641
  "isEntityId": true,
2489
2642
  "relType": "BuildTriggerData"
2490
2643
  },
2644
+ "optionalRequestBody": false,
2491
2645
  "queryParamsRequired": false,
2492
2646
  "name": "abort",
2493
2647
  "rawName": "rawAbort"
@@ -2504,6 +2658,7 @@
2504
2658
  "isEntityId": true,
2505
2659
  "relType": "BuildTriggerData"
2506
2660
  },
2661
+ "optionalRequestBody": false,
2507
2662
  "queryParamsRequired": false,
2508
2663
  "name": "abortIndexing",
2509
2664
  "rawName": "rawAbortIndexing"
@@ -2520,6 +2675,7 @@
2520
2675
  "isEntityId": true,
2521
2676
  "relType": "BuildTriggerData"
2522
2677
  },
2678
+ "optionalRequestBody": false,
2523
2679
  "queryParamsRequired": false,
2524
2680
  "name": "reindex",
2525
2681
  "rawName": "rawReindex"
@@ -2536,6 +2692,7 @@
2536
2692
  "isEntityId": true,
2537
2693
  "relType": "BuildTriggerData"
2538
2694
  },
2695
+ "optionalRequestBody": false,
2539
2696
  "queryParamsRequired": false,
2540
2697
  "responseType": "BuildTriggerDestroyTargetSchema",
2541
2698
  "name": "destroy",
@@ -2556,6 +2713,7 @@
2556
2713
  "method": "POST",
2557
2714
  "comment": "Create a new filter",
2558
2715
  "requestBodyType": "ItemTypeFilterCreateSchema",
2716
+ "optionalRequestBody": false,
2559
2717
  "requestStructure": {
2560
2718
  "type": "item_type_filter",
2561
2719
  "attributes": [
@@ -2587,6 +2745,7 @@
2587
2745
  "relType": "ItemTypeFilterData"
2588
2746
  },
2589
2747
  "requestBodyType": "ItemTypeFilterUpdateSchema",
2748
+ "optionalRequestBody": false,
2590
2749
  "requestStructure": {
2591
2750
  "type": "item_type_filter",
2592
2751
  "attributes": [
@@ -2612,6 +2771,7 @@
2612
2771
  "urlTemplate": "/item-type-filters",
2613
2772
  "method": "GET",
2614
2773
  "comment": "List all filters",
2774
+ "optionalRequestBody": false,
2615
2775
  "queryParamsRequired": false,
2616
2776
  "responseType": "ItemTypeFilterInstancesTargetSchema",
2617
2777
  "name": "list",
@@ -2629,6 +2789,7 @@
2629
2789
  "isEntityId": true,
2630
2790
  "relType": "ItemTypeFilterData"
2631
2791
  },
2792
+ "optionalRequestBody": false,
2632
2793
  "queryParamsRequired": false,
2633
2794
  "responseType": "ItemTypeFilterSelfTargetSchema",
2634
2795
  "name": "find",
@@ -2646,6 +2807,7 @@
2646
2807
  "isEntityId": true,
2647
2808
  "relType": "ItemTypeFilterData"
2648
2809
  },
2810
+ "optionalRequestBody": false,
2649
2811
  "queryParamsRequired": false,
2650
2812
  "responseType": "ItemTypeFilterDestroyTargetSchema",
2651
2813
  "name": "destroy",
@@ -2666,6 +2828,7 @@
2666
2828
  "method": "POST",
2667
2829
  "comment": "Create a new filter",
2668
2830
  "requestBodyType": "UploadFilterCreateSchema",
2831
+ "optionalRequestBody": false,
2669
2832
  "requestStructure": {
2670
2833
  "type": "upload_filter",
2671
2834
  "attributes": [
@@ -2693,6 +2856,7 @@
2693
2856
  "relType": "UploadFilterData"
2694
2857
  },
2695
2858
  "requestBodyType": "UploadFilterUpdateSchema",
2859
+ "optionalRequestBody": false,
2696
2860
  "requestStructure": {
2697
2861
  "type": "upload_filter",
2698
2862
  "attributes": [
@@ -2714,6 +2878,7 @@
2714
2878
  "urlTemplate": "/upload-filters",
2715
2879
  "method": "GET",
2716
2880
  "comment": "List all filters",
2881
+ "optionalRequestBody": false,
2717
2882
  "queryParamsRequired": false,
2718
2883
  "responseType": "UploadFilterInstancesTargetSchema",
2719
2884
  "name": "list",
@@ -2731,6 +2896,7 @@
2731
2896
  "isEntityId": true,
2732
2897
  "relType": "UploadFilterData"
2733
2898
  },
2899
+ "optionalRequestBody": false,
2734
2900
  "queryParamsRequired": false,
2735
2901
  "responseType": "UploadFilterSelfTargetSchema",
2736
2902
  "name": "find",
@@ -2748,6 +2914,7 @@
2748
2914
  "isEntityId": true,
2749
2915
  "relType": "UploadFilterData"
2750
2916
  },
2917
+ "optionalRequestBody": false,
2751
2918
  "queryParamsRequired": false,
2752
2919
  "responseType": "UploadFilterDestroyTargetSchema",
2753
2920
  "name": "destroy",
@@ -2768,6 +2935,7 @@
2768
2935
  "method": "POST",
2769
2936
  "comment": "Invite a new user",
2770
2937
  "requestBodyType": "SiteInvitationCreateSchema",
2938
+ "optionalRequestBody": false,
2771
2939
  "requestStructure": {
2772
2940
  "type": "site_invitation",
2773
2941
  "attributes": [
@@ -2795,6 +2963,7 @@
2795
2963
  "relType": "SiteInvitationData"
2796
2964
  },
2797
2965
  "requestBodyType": "SiteInvitationUpdateSchema",
2966
+ "optionalRequestBody": false,
2798
2967
  "requestStructure": {
2799
2968
  "type": "site_invitation",
2800
2969
  "attributes": [],
@@ -2814,6 +2983,7 @@
2814
2983
  "urlTemplate": "/site-invitations",
2815
2984
  "method": "GET",
2816
2985
  "comment": "List all invitations",
2986
+ "optionalRequestBody": false,
2817
2987
  "queryParamsRequired": false,
2818
2988
  "responseType": "SiteInvitationInstancesTargetSchema",
2819
2989
  "name": "list",
@@ -2831,6 +3001,7 @@
2831
3001
  "isEntityId": true,
2832
3002
  "relType": "SiteInvitationData"
2833
3003
  },
3004
+ "optionalRequestBody": false,
2834
3005
  "queryParamsRequired": false,
2835
3006
  "responseType": "SiteInvitationSelfTargetSchema",
2836
3007
  "name": "find",
@@ -2848,6 +3019,7 @@
2848
3019
  "isEntityId": true,
2849
3020
  "relType": "SiteInvitationData"
2850
3021
  },
3022
+ "optionalRequestBody": false,
2851
3023
  "queryParamsRequired": false,
2852
3024
  "responseType": "SiteInvitationDestroyTargetSchema",
2853
3025
  "name": "destroy",
@@ -2865,6 +3037,7 @@
2865
3037
  "isEntityId": true,
2866
3038
  "relType": "SiteInvitationData"
2867
3039
  },
3040
+ "optionalRequestBody": false,
2868
3041
  "queryParamsRequired": false,
2869
3042
  "name": "resend",
2870
3043
  "rawName": "rawResend"
@@ -2883,6 +3056,7 @@
2883
3056
  "urlTemplate": "/editing-sessions",
2884
3057
  "method": "GET",
2885
3058
  "comment": "List all editing sessions",
3059
+ "optionalRequestBody": false,
2886
3060
  "queryParamsRequired": false,
2887
3061
  "responseType": "EditingSessionInstancesTargetSchema",
2888
3062
  "deprecated": "This API call is to be considered private and might change without notice",
@@ -2902,6 +3076,7 @@
2902
3076
  "relType": "EditingSessionData"
2903
3077
  },
2904
3078
  "requestBodyType": "EditingSessionUpdateSchema",
3079
+ "optionalRequestBody": false,
2905
3080
  "requestStructure": {
2906
3081
  "type": "*",
2907
3082
  "attributes": [],
@@ -2928,6 +3103,7 @@
2928
3103
  "isEntityId": true,
2929
3104
  "relType": "EditingSessionData"
2930
3105
  },
3106
+ "optionalRequestBody": false,
2931
3107
  "queryParamsRequired": false,
2932
3108
  "responseType": "EditingSessionDestroyTargetSchema",
2933
3109
  "deprecated": "This API call is to be considered private and might change without notice",
@@ -2948,6 +3124,7 @@
2948
3124
  "urlTemplate": "/sso-groups",
2949
3125
  "method": "GET",
2950
3126
  "comment": "List all SSO groups",
3127
+ "optionalRequestBody": false,
2951
3128
  "queryParamsRequired": false,
2952
3129
  "responseType": "SsoGroupInstancesTargetSchema",
2953
3130
  "name": "list",
@@ -2965,6 +3142,7 @@
2965
3142
  "isEntityId": true,
2966
3143
  "relType": "SsoGroupData"
2967
3144
  },
3145
+ "optionalRequestBody": false,
2968
3146
  "queryParamsRequired": false,
2969
3147
  "responseType": "SsoGroupCopyRolesTargetSchema",
2970
3148
  "name": "copyRoles",
@@ -2983,6 +3161,7 @@
2983
3161
  "relType": "SsoGroupData"
2984
3162
  },
2985
3163
  "requestBodyType": "SsoGroupUpdateSchema",
3164
+ "optionalRequestBody": false,
2986
3165
  "requestStructure": {
2987
3166
  "type": "sso_group",
2988
3167
  "attributes": [
@@ -3009,6 +3188,7 @@
3009
3188
  "isEntityId": true,
3010
3189
  "relType": "SsoGroupData"
3011
3190
  },
3191
+ "optionalRequestBody": false,
3012
3192
  "queryParamsRequired": false,
3013
3193
  "responseType": "SsoGroupDestroyTargetSchema",
3014
3194
  "name": "destroy",
@@ -3028,6 +3208,7 @@
3028
3208
  "urlTemplate": "/sso-settings",
3029
3209
  "method": "GET",
3030
3210
  "comment": "Retrieve SSO Settings",
3211
+ "optionalRequestBody": false,
3031
3212
  "queryParamsRequired": false,
3032
3213
  "responseType": "SsoSettingsSelfTargetSchema",
3033
3214
  "name": "find",
@@ -3040,6 +3221,7 @@
3040
3221
  "urlTemplate": "/sso-settings/generate-token",
3041
3222
  "method": "PUT",
3042
3223
  "comment": "Generate SSO token",
3224
+ "optionalRequestBody": false,
3043
3225
  "queryParamsRequired": false,
3044
3226
  "responseType": "SsoSettingsGenerateTokenTargetSchema",
3045
3227
  "name": "generateToken",
@@ -3053,6 +3235,7 @@
3053
3235
  "method": "PUT",
3054
3236
  "comment": "Update SSO Settings",
3055
3237
  "requestBodyType": "SsoSettingsUpdateSchema",
3238
+ "optionalRequestBody": false,
3056
3239
  "requestStructure": {
3057
3240
  "type": "sso_settings",
3058
3241
  "attributes": [
@@ -3082,6 +3265,7 @@
3082
3265
  "urlTemplate": "/white-label-settings",
3083
3266
  "method": "GET",
3084
3267
  "comment": "Retrieve white-label settings",
3268
+ "optionalRequestBody": false,
3085
3269
  "queryParamsRequired": false,
3086
3270
  "responseType": "WhiteLabelSettingsSelfTargetSchema",
3087
3271
  "name": "find",
@@ -3095,6 +3279,7 @@
3095
3279
  "method": "PUT",
3096
3280
  "comment": "Update white-label settings",
3097
3281
  "requestBodyType": "WhiteLabelSettingsUpdateSchema",
3282
+ "optionalRequestBody": false,
3098
3283
  "requestStructure": {
3099
3284
  "type": "white_label_settings",
3100
3285
  "attributes": [
@@ -3121,6 +3306,7 @@
3121
3306
  "urlTemplate": "/public-info",
3122
3307
  "method": "GET",
3123
3308
  "comment": "Retrieve public site info",
3309
+ "optionalRequestBody": false,
3124
3310
  "queryParamsRequired": false,
3125
3311
  "responseType": "PublicInfoSelfTargetSchema",
3126
3312
  "name": "find",
@@ -3140,6 +3326,7 @@
3140
3326
  "urlTemplate": "/daily-site-usages",
3141
3327
  "method": "GET",
3142
3328
  "comment": "Retrieve project's daily usage info",
3329
+ "optionalRequestBody": false,
3143
3330
  "queryParamsRequired": false,
3144
3331
  "responseType": "DailyUsageInstancesTargetSchema",
3145
3332
  "name": "list",
@@ -3164,6 +3351,7 @@
3164
3351
  "isEntityId": true,
3165
3352
  "relType": "UsageCounterData"
3166
3353
  },
3354
+ "optionalRequestBody": false,
3167
3355
  "queryParamsType": "UsageCounterSelfHrefSchema",
3168
3356
  "queryParamsRequired": false,
3169
3357
  "responseType": "UsageCounterSelfTargetSchema",
@@ -3184,6 +3372,7 @@
3184
3372
  "urlTemplate": "/upload-tags",
3185
3373
  "method": "GET",
3186
3374
  "comment": "List all manually created upload tags",
3375
+ "optionalRequestBody": false,
3187
3376
  "queryParamsType": "UploadTagInstancesHrefSchema",
3188
3377
  "queryParamsRequired": false,
3189
3378
  "responseType": "UploadTagInstancesTargetSchema",
@@ -3202,6 +3391,7 @@
3202
3391
  "method": "POST",
3203
3392
  "comment": "Create a new upload tag",
3204
3393
  "requestBodyType": "UploadTagCreateSchema",
3394
+ "optionalRequestBody": false,
3205
3395
  "requestStructure": {
3206
3396
  "type": "upload_tag",
3207
3397
  "attributes": [
@@ -3228,6 +3418,7 @@
3228
3418
  "urlTemplate": "/upload-smart-tags",
3229
3419
  "method": "GET",
3230
3420
  "comment": "List all automatically created upload tags",
3421
+ "optionalRequestBody": false,
3231
3422
  "queryParamsType": "UploadSmartTagInstancesHrefSchema",
3232
3423
  "queryParamsRequired": false,
3233
3424
  "responseType": "UploadSmartTagInstancesTargetSchema",
@@ -3252,6 +3443,7 @@
3252
3443
  "urlTemplate": "/site",
3253
3444
  "method": "GET",
3254
3445
  "comment": "Retrieve the site",
3446
+ "optionalRequestBody": false,
3255
3447
  "queryParamsType": "SiteSelfHrefSchema",
3256
3448
  "queryParamsRequired": false,
3257
3449
  "responseType": "SiteSelfTargetSchema",
@@ -3266,6 +3458,7 @@
3266
3458
  "method": "PUT",
3267
3459
  "comment": "Update the site's settings",
3268
3460
  "requestBodyType": "SiteUpdateSchema",
3461
+ "optionalRequestBody": false,
3269
3462
  "requestStructure": {
3270
3463
  "type": "site",
3271
3464
  "attributes": [
@@ -3295,6 +3488,7 @@
3295
3488
  "urlTemplate": "/site/activate-improved-timezone-management",
3296
3489
  "method": "PUT",
3297
3490
  "comment": "Activate improved timezone management",
3491
+ "optionalRequestBody": false,
3298
3492
  "queryParamsRequired": false,
3299
3493
  "responseType": "SiteActivateImprovedTimezoneManagementJobSchema",
3300
3494
  "deprecated": "This API call is to be considered private and might change without notice",
@@ -3308,6 +3502,7 @@
3308
3502
  "urlTemplate": "/site/activate-improved-hex-management",
3309
3503
  "method": "PUT",
3310
3504
  "comment": "Activate improved hex management",
3505
+ "optionalRequestBody": false,
3311
3506
  "queryParamsRequired": false,
3312
3507
  "responseType": "SiteActivateImprovedHexManagementTargetSchema",
3313
3508
  "deprecated": "This API call is to be considered private and might change without notice",
@@ -3321,6 +3516,7 @@
3321
3516
  "urlTemplate": "/site/activate-improved-gql-multilocale-fields",
3322
3517
  "method": "PUT",
3323
3518
  "comment": "Activate improved GraphQL multi-locale fields option",
3519
+ "optionalRequestBody": false,
3324
3520
  "queryParamsRequired": false,
3325
3521
  "responseType": "SiteActivateImprovedGqlMultilocaleFieldsTargetSchema",
3326
3522
  "deprecated": "This API call is to be considered private and might change without notice",
@@ -3342,6 +3538,7 @@
3342
3538
  "method": "POST",
3343
3539
  "comment": "Create a new workflow",
3344
3540
  "requestBodyType": "WorkflowCreateSchema",
3541
+ "optionalRequestBody": false,
3345
3542
  "requestStructure": {
3346
3543
  "type": "workflow",
3347
3544
  "attributes": [
@@ -3369,6 +3566,7 @@
3369
3566
  "relType": "WorkflowData"
3370
3567
  },
3371
3568
  "requestBodyType": "WorkflowUpdateSchema",
3569
+ "optionalRequestBody": false,
3372
3570
  "requestStructure": {
3373
3571
  "type": "workflow",
3374
3572
  "attributes": [
@@ -3390,6 +3588,7 @@
3390
3588
  "urlTemplate": "/workflows",
3391
3589
  "method": "GET",
3392
3590
  "comment": "List all workflows",
3591
+ "optionalRequestBody": false,
3393
3592
  "queryParamsRequired": false,
3394
3593
  "responseType": "WorkflowInstancesTargetSchema",
3395
3594
  "name": "list",
@@ -3407,6 +3606,7 @@
3407
3606
  "isEntityId": true,
3408
3607
  "relType": "WorkflowData"
3409
3608
  },
3609
+ "optionalRequestBody": false,
3410
3610
  "queryParamsRequired": false,
3411
3611
  "responseType": "WorkflowSelfTargetSchema",
3412
3612
  "name": "find",
@@ -3424,6 +3624,7 @@
3424
3624
  "isEntityId": true,
3425
3625
  "relType": "WorkflowData"
3426
3626
  },
3627
+ "optionalRequestBody": false,
3427
3628
  "queryParamsRequired": false,
3428
3629
  "name": "destroy",
3429
3630
  "rawName": "rawDestroy"