@datocms/cma-client 3.3.7 → 3.3.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/generated/Client.js +2 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/ItemType.js +17 -0
- package/dist/cjs/generated/resources/ItemType.js.map +1 -1
- package/dist/cjs/generated/resources/MenuItem.js +36 -0
- package/dist/cjs/generated/resources/MenuItem.js.map +1 -1
- package/dist/cjs/generated/resources/Role.js +2 -0
- package/dist/cjs/generated/resources/Role.js.map +1 -1
- package/dist/cjs/generated/resources/SchemaMenuItem.js +36 -0
- package/dist/cjs/generated/resources/SchemaMenuItem.js.map +1 -1
- package/dist/cjs/generated/resources/Upload.js +34 -2
- package/dist/cjs/generated/resources/Upload.js.map +1 -1
- package/dist/cjs/generated/resources/UploadCollection.js +238 -0
- package/dist/cjs/generated/resources/UploadCollection.js.map +1 -0
- package/dist/cjs/generated/resources/WebhookCall.js +4 -4
- package/dist/cjs/generated/resources/WebhookCall.js.map +1 -1
- package/dist/cjs/generated/resources/index.js +3 -1
- package/dist/cjs/generated/resources/index.js.map +1 -1
- package/dist/esm/generated/Client.d.ts +1 -0
- package/dist/esm/generated/Client.js +2 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +484 -40
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +415 -148
- package/dist/esm/generated/resources/ItemType.d.ts +11 -0
- package/dist/esm/generated/resources/ItemType.js +17 -0
- package/dist/esm/generated/resources/ItemType.js.map +1 -1
- package/dist/esm/generated/resources/MenuItem.d.ts +22 -0
- package/dist/esm/generated/resources/MenuItem.js +36 -0
- package/dist/esm/generated/resources/MenuItem.js.map +1 -1
- package/dist/esm/generated/resources/Role.js +2 -0
- package/dist/esm/generated/resources/Role.js.map +1 -1
- package/dist/esm/generated/resources/SchemaMenuItem.d.ts +22 -0
- package/dist/esm/generated/resources/SchemaMenuItem.js +36 -0
- package/dist/esm/generated/resources/SchemaMenuItem.js.map +1 -1
- package/dist/esm/generated/resources/Upload.d.ts +18 -0
- package/dist/esm/generated/resources/Upload.js +34 -2
- package/dist/esm/generated/resources/Upload.js.map +1 -1
- package/dist/esm/generated/resources/UploadCollection.d.ts +118 -0
- package/dist/esm/generated/resources/UploadCollection.js +210 -0
- package/dist/esm/generated/resources/UploadCollection.js.map +1 -0
- package/dist/esm/generated/resources/WebhookCall.d.ts +2 -2
- package/dist/esm/generated/resources/WebhookCall.js +4 -4
- package/dist/esm/generated/resources/WebhookCall.js.map +1 -1
- package/dist/esm/generated/resources/index.d.ts +1 -0
- package/dist/esm/generated/resources/index.js +1 -0
- package/dist/esm/generated/resources/index.js.map +1 -1
- package/dist/types/generated/Client.d.ts +1 -0
- package/dist/types/generated/SchemaTypes.d.ts +484 -40
- package/dist/types/generated/SimpleSchemaTypes.d.ts +415 -148
- package/dist/types/generated/resources/ItemType.d.ts +11 -0
- package/dist/types/generated/resources/MenuItem.d.ts +22 -0
- package/dist/types/generated/resources/SchemaMenuItem.d.ts +22 -0
- package/dist/types/generated/resources/Upload.d.ts +18 -0
- package/dist/types/generated/resources/UploadCollection.d.ts +118 -0
- package/dist/types/generated/resources/WebhookCall.d.ts +2 -2
- package/dist/types/generated/resources/index.d.ts +1 -0
- package/package.json +2 -2
- package/resources.json +240 -6
- package/src/generated/Client.ts +3 -1
- package/src/generated/SchemaTypes.ts +515 -42
- package/src/generated/SimpleSchemaTypes.ts +425 -149
- package/src/generated/resources/ItemType.ts +22 -0
- package/src/generated/resources/MenuItem.ts +44 -0
- package/src/generated/resources/Role.ts +2 -0
- package/src/generated/resources/SchemaMenuItem.ts +47 -0
- package/src/generated/resources/Upload.ts +49 -2
- package/src/generated/resources/UploadCollection.ts +251 -0
- package/src/generated/resources/WebhookCall.ts +4 -4
- package/src/generated/resources/index.ts +1 -0
|
@@ -330,6 +330,39 @@ export type MenuItemInstancesHrefSchema = {
|
|
|
330
330
|
ids: string;
|
|
331
331
|
};
|
|
332
332
|
};
|
|
333
|
+
/**
|
|
334
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
335
|
+
* via the `reorder.schema` link.
|
|
336
|
+
*/
|
|
337
|
+
export type MenuItemReorderSchema = {
|
|
338
|
+
id: MenuItemIdentity;
|
|
339
|
+
type?: MenuItemType;
|
|
340
|
+
/**
|
|
341
|
+
* Ordering index
|
|
342
|
+
*/
|
|
343
|
+
position: number;
|
|
344
|
+
parent: null | MenuItemData;
|
|
345
|
+
}[];
|
|
346
|
+
/**
|
|
347
|
+
* ID of job
|
|
348
|
+
*
|
|
349
|
+
* This interface was referenced by `Job`'s JSON-Schema
|
|
350
|
+
* via the `definition` "identity".
|
|
351
|
+
*
|
|
352
|
+
* This interface was referenced by `Job`'s JSON-Schema
|
|
353
|
+
* via the `definition` "id".
|
|
354
|
+
*/
|
|
355
|
+
export type JobIdentity = string;
|
|
356
|
+
/**
|
|
357
|
+
* This interface was referenced by `Job`'s JSON-Schema
|
|
358
|
+
* via the `definition` "type".
|
|
359
|
+
*/
|
|
360
|
+
export type JobType = 'job';
|
|
361
|
+
/**
|
|
362
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
363
|
+
* via the `reorder.jobSchema` link.
|
|
364
|
+
*/
|
|
365
|
+
export type MenuItemReorderJobSchema = MenuItem[];
|
|
333
366
|
/**
|
|
334
367
|
* RFC 4122 UUID of schema menu item expressed in URL-safe base64 format
|
|
335
368
|
*
|
|
@@ -364,6 +397,76 @@ export type SchemaMenuItemInstancesHrefSchema = {
|
|
|
364
397
|
ids: string;
|
|
365
398
|
};
|
|
366
399
|
};
|
|
400
|
+
/**
|
|
401
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
402
|
+
* via the `reorder.schema` link.
|
|
403
|
+
*/
|
|
404
|
+
export type SchemaMenuItemReorderSchema = {
|
|
405
|
+
id: SchemaMenuItemIdentity;
|
|
406
|
+
type?: SchemaMenuItemType;
|
|
407
|
+
/**
|
|
408
|
+
* Ordering index
|
|
409
|
+
*/
|
|
410
|
+
position: number;
|
|
411
|
+
parent: null | SchemaMenuItemData;
|
|
412
|
+
}[];
|
|
413
|
+
/**
|
|
414
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
415
|
+
* via the `reorder.jobSchema` link.
|
|
416
|
+
*/
|
|
417
|
+
export type SchemaMenuItemReorderJobSchema = SchemaMenuItem[];
|
|
418
|
+
/**
|
|
419
|
+
* RFC 4122 UUID of upload collection expressed in URL-safe base64 format
|
|
420
|
+
*
|
|
421
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
422
|
+
* via the `definition` "identity".
|
|
423
|
+
*
|
|
424
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
425
|
+
* via the `definition` "id".
|
|
426
|
+
*/
|
|
427
|
+
export type UploadCollectionIdentity = string;
|
|
428
|
+
/**
|
|
429
|
+
* JSON API type field
|
|
430
|
+
*
|
|
431
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
432
|
+
* via the `definition` "type".
|
|
433
|
+
*/
|
|
434
|
+
export type UploadCollectionType = 'upload_collection';
|
|
435
|
+
/**
|
|
436
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
437
|
+
* via the `instances.targetSchema` link.
|
|
438
|
+
*/
|
|
439
|
+
export type UploadCollectionInstancesTargetSchema = UploadCollection[];
|
|
440
|
+
/**
|
|
441
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
442
|
+
* via the `instances.hrefSchema` link.
|
|
443
|
+
*/
|
|
444
|
+
export type UploadCollectionInstancesHrefSchema = {
|
|
445
|
+
filter?: {
|
|
446
|
+
/**
|
|
447
|
+
* IDs to fetch, comma separated
|
|
448
|
+
*/
|
|
449
|
+
ids: string;
|
|
450
|
+
};
|
|
451
|
+
};
|
|
452
|
+
/**
|
|
453
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
454
|
+
* via the `reorder.schema` link.
|
|
455
|
+
*/
|
|
456
|
+
export type UploadCollectionReorderSchema = {
|
|
457
|
+
id: UploadCollectionIdentity;
|
|
458
|
+
type?: UploadCollectionType;
|
|
459
|
+
/**
|
|
460
|
+
* Ordering index
|
|
461
|
+
*/
|
|
462
|
+
position: number;
|
|
463
|
+
parent: null | UploadCollectionData;
|
|
464
|
+
}[];
|
|
465
|
+
/**
|
|
466
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
467
|
+
* via the `reorder.jobSchema` link.
|
|
468
|
+
*/
|
|
469
|
+
export type UploadCollectionReorderJobSchema = UploadCollection[];
|
|
367
470
|
/**
|
|
368
471
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
369
472
|
* via the `definition` "type".
|
|
@@ -433,21 +536,6 @@ export type ItemTypeCreateHrefSchema = {
|
|
|
433
536
|
schema_menu_item_id?: string;
|
|
434
537
|
[k: string]: unknown;
|
|
435
538
|
};
|
|
436
|
-
/**
|
|
437
|
-
* ID of job
|
|
438
|
-
*
|
|
439
|
-
* This interface was referenced by `Job`'s JSON-Schema
|
|
440
|
-
* via the `definition` "identity".
|
|
441
|
-
*
|
|
442
|
-
* This interface was referenced by `Job`'s JSON-Schema
|
|
443
|
-
* via the `definition` "id".
|
|
444
|
-
*/
|
|
445
|
-
export type JobIdentity = string;
|
|
446
|
-
/**
|
|
447
|
-
* This interface was referenced by `Job`'s JSON-Schema
|
|
448
|
-
* via the `definition` "type".
|
|
449
|
-
*/
|
|
450
|
-
export type JobType = 'job';
|
|
451
539
|
/**
|
|
452
540
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
453
541
|
* via the `instances.targetSchema` link.
|
|
@@ -464,6 +552,26 @@ export type ItemTypeDestroyHrefSchema = {
|
|
|
464
552
|
skip_menu_items_deletion?: boolean;
|
|
465
553
|
[k: string]: unknown;
|
|
466
554
|
};
|
|
555
|
+
/**
|
|
556
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
557
|
+
* via the `reorder_fields_and_fieldsets.schema` link.
|
|
558
|
+
*/
|
|
559
|
+
export type ItemTypeReorderFieldsAndFieldsetsSchema = ({
|
|
560
|
+
id: FieldIdentity;
|
|
561
|
+
type?: FieldType;
|
|
562
|
+
/**
|
|
563
|
+
* Ordering index
|
|
564
|
+
*/
|
|
565
|
+
position: number;
|
|
566
|
+
fieldset: null | FieldsetData;
|
|
567
|
+
} | {
|
|
568
|
+
id: FieldsetIdentity;
|
|
569
|
+
type?: FieldsetType;
|
|
570
|
+
/**
|
|
571
|
+
* Ordering index
|
|
572
|
+
*/
|
|
573
|
+
position: number;
|
|
574
|
+
})[];
|
|
467
575
|
/**
|
|
468
576
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
469
577
|
* via the `instances.targetSchema` link.
|
|
@@ -484,6 +592,11 @@ export type FieldRelatedTargetSchema = Field[];
|
|
|
484
592
|
* via the `instances.targetSchema` link.
|
|
485
593
|
*/
|
|
486
594
|
export type FieldsetInstancesTargetSchema = Fieldset[];
|
|
595
|
+
/**
|
|
596
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
597
|
+
* via the `reorder_fields_and_fieldsets.jobSchema` link.
|
|
598
|
+
*/
|
|
599
|
+
export type ItemTypeReorderFieldsAndFieldsetsJobSchema = (Field | Fieldset)[];
|
|
487
600
|
/**
|
|
488
601
|
* JSON web token for the session
|
|
489
602
|
*
|
|
@@ -1043,6 +1156,11 @@ export type UploadReferencesHrefSchema = {
|
|
|
1043
1156
|
* via the `bulk_tag.jobSchema` link.
|
|
1044
1157
|
*/
|
|
1045
1158
|
export type UploadBulkTagJobSchema = unknown[];
|
|
1159
|
+
/**
|
|
1160
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
1161
|
+
* via the `bulk_set_upload_collection.jobSchema` link.
|
|
1162
|
+
*/
|
|
1163
|
+
export type UploadBulkSetUploadCollectionJobSchema = unknown[];
|
|
1046
1164
|
/**
|
|
1047
1165
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
1048
1166
|
* via the `bulk_destroy.jobSchema` link.
|
|
@@ -1698,6 +1816,7 @@ export type DatoApi = {
|
|
|
1698
1816
|
site_plan?: SitePlan;
|
|
1699
1817
|
menu_item?: MenuItem;
|
|
1700
1818
|
schema_menu_item?: SchemaMenuItem;
|
|
1819
|
+
upload_collection?: UploadCollection;
|
|
1701
1820
|
item_type?: ItemType;
|
|
1702
1821
|
field?: Field;
|
|
1703
1822
|
fieldset?: Fieldset;
|
|
@@ -1789,7 +1908,11 @@ export type Role = {
|
|
|
1789
1908
|
/**
|
|
1790
1909
|
* Can create/edit shared filters (both for models and the media area)
|
|
1791
1910
|
*/
|
|
1792
|
-
can_manage_shared_filters
|
|
1911
|
+
can_manage_shared_filters: boolean;
|
|
1912
|
+
/**
|
|
1913
|
+
* Can create/edit upload collections
|
|
1914
|
+
*/
|
|
1915
|
+
can_manage_upload_collections: boolean;
|
|
1793
1916
|
/**
|
|
1794
1917
|
* Can create/edit Build triggers
|
|
1795
1918
|
*/
|
|
@@ -1997,7 +2120,11 @@ export type RoleMeta = {
|
|
|
1997
2120
|
/**
|
|
1998
2121
|
* Can create/edit shared filters (both for models and the media area)
|
|
1999
2122
|
*/
|
|
2000
|
-
can_manage_shared_filters
|
|
2123
|
+
can_manage_shared_filters: boolean;
|
|
2124
|
+
/**
|
|
2125
|
+
* Can create/edit upload collections
|
|
2126
|
+
*/
|
|
2127
|
+
can_manage_upload_collections: boolean;
|
|
2001
2128
|
/**
|
|
2002
2129
|
* Can create/edit Build triggers
|
|
2003
2130
|
*/
|
|
@@ -2190,7 +2317,11 @@ export type RoleAttributes = {
|
|
|
2190
2317
|
/**
|
|
2191
2318
|
* Can create/edit shared filters (both for models and the media area)
|
|
2192
2319
|
*/
|
|
2193
|
-
can_manage_shared_filters
|
|
2320
|
+
can_manage_shared_filters: boolean;
|
|
2321
|
+
/**
|
|
2322
|
+
* Can create/edit upload collections
|
|
2323
|
+
*/
|
|
2324
|
+
can_manage_upload_collections: boolean;
|
|
2194
2325
|
/**
|
|
2195
2326
|
* Can create/edit Build triggers
|
|
2196
2327
|
*/
|
|
@@ -2391,6 +2522,10 @@ export type RoleCreateSchema = {
|
|
|
2391
2522
|
* Can create/edit shared filters (both for models and the media area)
|
|
2392
2523
|
*/
|
|
2393
2524
|
can_manage_shared_filters?: boolean;
|
|
2525
|
+
/**
|
|
2526
|
+
* Can create/edit upload collections
|
|
2527
|
+
*/
|
|
2528
|
+
can_manage_upload_collections?: boolean;
|
|
2394
2529
|
/**
|
|
2395
2530
|
* Can create/edit Build triggers
|
|
2396
2531
|
*/
|
|
@@ -2585,6 +2720,10 @@ export type RoleUpdateSchema = {
|
|
|
2585
2720
|
* Can create/edit shared filters (both for models and the media area)
|
|
2586
2721
|
*/
|
|
2587
2722
|
can_manage_shared_filters?: boolean;
|
|
2723
|
+
/**
|
|
2724
|
+
* Can create/edit upload collections
|
|
2725
|
+
*/
|
|
2726
|
+
can_manage_upload_collections?: boolean;
|
|
2588
2727
|
/**
|
|
2589
2728
|
* Can create/edit Build triggers
|
|
2590
2729
|
*/
|
|
@@ -4014,6 +4153,152 @@ export type MenuItemUpdateSchema = {
|
|
|
4014
4153
|
item_type_filter?: ItemTypeFilterData | null;
|
|
4015
4154
|
parent?: null | MenuItemData;
|
|
4016
4155
|
};
|
|
4156
|
+
/**
|
|
4157
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
4158
|
+
* via the `reorder.targetSchema` link.
|
|
4159
|
+
*
|
|
4160
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
4161
|
+
* via the `reorder.targetSchema` link.
|
|
4162
|
+
*
|
|
4163
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
4164
|
+
* via the `reorder.targetSchema` link.
|
|
4165
|
+
*
|
|
4166
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4167
|
+
* via the `update.targetSchema` link.
|
|
4168
|
+
*
|
|
4169
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4170
|
+
* via the `destroy.targetSchema` link.
|
|
4171
|
+
*
|
|
4172
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4173
|
+
* via the `reorder_fields_and_fieldsets.targetSchema` link.
|
|
4174
|
+
*
|
|
4175
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
4176
|
+
* via the `create.targetSchema` link.
|
|
4177
|
+
*
|
|
4178
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
4179
|
+
* via the `update.targetSchema` link.
|
|
4180
|
+
*
|
|
4181
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
4182
|
+
* via the `destroy.targetSchema` link.
|
|
4183
|
+
*
|
|
4184
|
+
* This interface was referenced by `Field`'s JSON-Schema
|
|
4185
|
+
* via the `duplicate.targetSchema` link.
|
|
4186
|
+
*
|
|
4187
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4188
|
+
* via the `duplicate.targetSchema` link.
|
|
4189
|
+
*
|
|
4190
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4191
|
+
* via the `destroy.targetSchema` link.
|
|
4192
|
+
*
|
|
4193
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4194
|
+
* via the `batch_destroy.targetSchema` link.
|
|
4195
|
+
*
|
|
4196
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4197
|
+
* via the `batch_publish.targetSchema` link.
|
|
4198
|
+
*
|
|
4199
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4200
|
+
* via the `batch_unpublish.targetSchema` link.
|
|
4201
|
+
*
|
|
4202
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4203
|
+
* via the `bulk_publish.targetSchema` link.
|
|
4204
|
+
*
|
|
4205
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4206
|
+
* via the `bulk_unpublish.targetSchema` link.
|
|
4207
|
+
*
|
|
4208
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4209
|
+
* via the `bulk_destroy.targetSchema` link.
|
|
4210
|
+
*
|
|
4211
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
4212
|
+
* via the `bulk_move_to_stage.targetSchema` link.
|
|
4213
|
+
*
|
|
4214
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
4215
|
+
* via the `restore.targetSchema` link.
|
|
4216
|
+
*
|
|
4217
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4218
|
+
* via the `create.targetSchema` link.
|
|
4219
|
+
*
|
|
4220
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4221
|
+
* via the `update.targetSchema` link.
|
|
4222
|
+
*
|
|
4223
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4224
|
+
* via the `batch_add_tags.targetSchema` link.
|
|
4225
|
+
*
|
|
4226
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4227
|
+
* via the `batch_destroy.targetSchema` link.
|
|
4228
|
+
*
|
|
4229
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4230
|
+
* via the `bulk_tag.targetSchema` link.
|
|
4231
|
+
*
|
|
4232
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4233
|
+
* via the `bulk_set_upload_collection.targetSchema` link.
|
|
4234
|
+
*
|
|
4235
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4236
|
+
* via the `bulk_destroy.targetSchema` link.
|
|
4237
|
+
*
|
|
4238
|
+
* This interface was referenced by `UploadTrack`'s JSON-Schema
|
|
4239
|
+
* via the `create.targetSchema` link.
|
|
4240
|
+
*
|
|
4241
|
+
* This interface was referenced by `UploadTrack`'s JSON-Schema
|
|
4242
|
+
* via the `destroy.targetSchema` link.
|
|
4243
|
+
*
|
|
4244
|
+
* This interface was referenced by `UploadTrack`'s JSON-Schema
|
|
4245
|
+
* via the `generate_subtitles.targetSchema` link.
|
|
4246
|
+
*
|
|
4247
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
4248
|
+
* via the `update.targetSchema` link.
|
|
4249
|
+
*
|
|
4250
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
4251
|
+
* via the `activate_improved_timezone_management.targetSchema` link.
|
|
4252
|
+
*
|
|
4253
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4254
|
+
* via the `definition` "job".
|
|
4255
|
+
*/
|
|
4256
|
+
export type Job = {
|
|
4257
|
+
id: JobIdentity;
|
|
4258
|
+
type: JobType;
|
|
4259
|
+
};
|
|
4260
|
+
export type MenuItemReorderTargetSchema = Job;
|
|
4261
|
+
export type SchemaMenuItemReorderTargetSchema = Job;
|
|
4262
|
+
export type UploadCollectionReorderTargetSchema = Job;
|
|
4263
|
+
export type ItemTypeUpdateTargetSchema = Job;
|
|
4264
|
+
export type ItemTypeDestroyTargetSchema = Job;
|
|
4265
|
+
export type ItemTypeReorderFieldsAndFieldsetsTargetSchema = Job;
|
|
4266
|
+
export type FieldCreateTargetSchema = Job;
|
|
4267
|
+
export type FieldUpdateTargetSchema = Job;
|
|
4268
|
+
export type FieldDestroyTargetSchema = Job;
|
|
4269
|
+
export type FieldDuplicateTargetSchema = Job;
|
|
4270
|
+
export type ItemDuplicateTargetSchema = Job;
|
|
4271
|
+
export type ItemDestroyTargetSchema = Job;
|
|
4272
|
+
export type ItemBatchDestroyTargetSchema = Job;
|
|
4273
|
+
export type ItemBatchPublishTargetSchema = Job;
|
|
4274
|
+
export type ItemBatchUnpublishTargetSchema = Job;
|
|
4275
|
+
export type ItemBulkPublishTargetSchema = Job;
|
|
4276
|
+
export type ItemBulkUnpublishTargetSchema = Job;
|
|
4277
|
+
export type ItemBulkDestroyTargetSchema = Job;
|
|
4278
|
+
export type ItemBulkMoveToStageTargetSchema = Job;
|
|
4279
|
+
export type ItemVersionRestoreTargetSchema = Job;
|
|
4280
|
+
export type UploadCreateTargetSchema = Job;
|
|
4281
|
+
export type UploadUpdateTargetSchema = Job;
|
|
4282
|
+
export type UploadBatchAddTagsTargetSchema = Job;
|
|
4283
|
+
export type UploadBatchDestroyTargetSchema = Job;
|
|
4284
|
+
export type UploadBulkTagTargetSchema = Job;
|
|
4285
|
+
export type UploadBulkSetUploadCollectionTargetSchema = Job;
|
|
4286
|
+
export type UploadBulkDestroyTargetSchema = Job;
|
|
4287
|
+
export type UploadTrackCreateTargetSchema = Job;
|
|
4288
|
+
export type UploadTrackDestroyTargetSchema = Job;
|
|
4289
|
+
export type UploadTrackGenerateSubtitlesTargetSchema = Job;
|
|
4290
|
+
export type SiteUpdateTargetSchema = Job;
|
|
4291
|
+
export type SiteActivateImprovedTimezoneManagementTargetSchema = Job;
|
|
4292
|
+
/**
|
|
4293
|
+
* JSON API data
|
|
4294
|
+
*
|
|
4295
|
+
* This interface was referenced by `Job`'s JSON-Schema
|
|
4296
|
+
* via the `definition` "data".
|
|
4297
|
+
*/
|
|
4298
|
+
export type JobData = {
|
|
4299
|
+
type: JobType;
|
|
4300
|
+
id: JobIdentity;
|
|
4301
|
+
};
|
|
4017
4302
|
/**
|
|
4018
4303
|
* In DatoCMS you can organize the different models and blocks present in your administrative area reordering and grouping them, so that their purpose will be more clear to the final editor.
|
|
4019
4304
|
*
|
|
@@ -4129,6 +4414,101 @@ export type SchemaMenuItemUpdateSchema = {
|
|
|
4129
4414
|
parent?: null | SchemaMenuItemData;
|
|
4130
4415
|
children?: SchemaMenuItemData[];
|
|
4131
4416
|
};
|
|
4417
|
+
/**
|
|
4418
|
+
* In DatoCMS you can organize the uploads present in your administrative area in collection, so that the final editors can easily navigate uploads.
|
|
4419
|
+
*
|
|
4420
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4421
|
+
* via the `definition` "upload_collection".
|
|
4422
|
+
*/
|
|
4423
|
+
export type UploadCollection = {
|
|
4424
|
+
id: UploadCollectionIdentity;
|
|
4425
|
+
type: UploadCollectionType;
|
|
4426
|
+
/**
|
|
4427
|
+
* The label of the upload collection
|
|
4428
|
+
*/
|
|
4429
|
+
label: string;
|
|
4430
|
+
/**
|
|
4431
|
+
* Ordering index
|
|
4432
|
+
*/
|
|
4433
|
+
position: number;
|
|
4434
|
+
parent: null | UploadCollectionData;
|
|
4435
|
+
children: UploadCollectionData[];
|
|
4436
|
+
};
|
|
4437
|
+
export type UploadCollectionCreateTargetSchema = UploadCollection;
|
|
4438
|
+
export type UploadCollectionUpdateTargetSchema = UploadCollection;
|
|
4439
|
+
export type UploadCollectionSelfTargetSchema = UploadCollection;
|
|
4440
|
+
export type UploadCollectionDestroyTargetSchema = UploadCollection;
|
|
4441
|
+
/**
|
|
4442
|
+
* JSON API data
|
|
4443
|
+
*
|
|
4444
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
4445
|
+
* via the `definition` "data".
|
|
4446
|
+
*/
|
|
4447
|
+
export type UploadCollectionData = {
|
|
4448
|
+
type: UploadCollectionType;
|
|
4449
|
+
id: UploadCollectionIdentity;
|
|
4450
|
+
};
|
|
4451
|
+
/**
|
|
4452
|
+
* JSON API attributes
|
|
4453
|
+
*
|
|
4454
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
4455
|
+
* via the `definition` "attributes".
|
|
4456
|
+
*/
|
|
4457
|
+
export type UploadCollectionAttributes = {
|
|
4458
|
+
/**
|
|
4459
|
+
* The label of the upload collection
|
|
4460
|
+
*/
|
|
4461
|
+
label: string;
|
|
4462
|
+
/**
|
|
4463
|
+
* Ordering index
|
|
4464
|
+
*/
|
|
4465
|
+
position: number;
|
|
4466
|
+
};
|
|
4467
|
+
/**
|
|
4468
|
+
* JSON API links
|
|
4469
|
+
*
|
|
4470
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
4471
|
+
* via the `definition` "relationships".
|
|
4472
|
+
*/
|
|
4473
|
+
export type UploadCollectionRelationships = {
|
|
4474
|
+
parent: null | UploadCollectionData;
|
|
4475
|
+
children: UploadCollectionData[];
|
|
4476
|
+
};
|
|
4477
|
+
/**
|
|
4478
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
4479
|
+
* via the `create.schema` link.
|
|
4480
|
+
*/
|
|
4481
|
+
export type UploadCollectionCreateSchema = {
|
|
4482
|
+
id?: UploadCollectionIdentity;
|
|
4483
|
+
type?: UploadCollectionType;
|
|
4484
|
+
/**
|
|
4485
|
+
* The label of the upload collection
|
|
4486
|
+
*/
|
|
4487
|
+
label: string;
|
|
4488
|
+
/**
|
|
4489
|
+
* Ordering index
|
|
4490
|
+
*/
|
|
4491
|
+
position?: number;
|
|
4492
|
+
parent?: null | UploadCollectionData;
|
|
4493
|
+
};
|
|
4494
|
+
/**
|
|
4495
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
4496
|
+
* via the `update.schema` link.
|
|
4497
|
+
*/
|
|
4498
|
+
export type UploadCollectionUpdateSchema = {
|
|
4499
|
+
id?: UploadCollectionIdentity;
|
|
4500
|
+
type?: UploadCollectionType;
|
|
4501
|
+
/**
|
|
4502
|
+
* The label of the upload collection
|
|
4503
|
+
*/
|
|
4504
|
+
label?: string;
|
|
4505
|
+
/**
|
|
4506
|
+
* Ordering index
|
|
4507
|
+
*/
|
|
4508
|
+
position?: number;
|
|
4509
|
+
parent?: null | UploadCollectionData;
|
|
4510
|
+
children?: UploadCollectionData[];
|
|
4511
|
+
};
|
|
4132
4512
|
/**
|
|
4133
4513
|
* The way you define the kind of content you can edit inside your administrative area passes through the concept of Models, which are much like database tables. For backward-compatibility reasons, the API refers to models as "item types".
|
|
4134
4514
|
*
|
|
@@ -4497,132 +4877,6 @@ export type ItemTypeUpdateSchema = {
|
|
|
4497
4877
|
has_singleton_item?: boolean;
|
|
4498
4878
|
};
|
|
4499
4879
|
};
|
|
4500
|
-
/**
|
|
4501
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4502
|
-
* via the `update.targetSchema` link.
|
|
4503
|
-
*
|
|
4504
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4505
|
-
* via the `destroy.targetSchema` link.
|
|
4506
|
-
*
|
|
4507
|
-
* This interface was referenced by `Field`'s JSON-Schema
|
|
4508
|
-
* via the `create.targetSchema` link.
|
|
4509
|
-
*
|
|
4510
|
-
* This interface was referenced by `Field`'s JSON-Schema
|
|
4511
|
-
* via the `update.targetSchema` link.
|
|
4512
|
-
*
|
|
4513
|
-
* This interface was referenced by `Field`'s JSON-Schema
|
|
4514
|
-
* via the `destroy.targetSchema` link.
|
|
4515
|
-
*
|
|
4516
|
-
* This interface was referenced by `Field`'s JSON-Schema
|
|
4517
|
-
* via the `duplicate.targetSchema` link.
|
|
4518
|
-
*
|
|
4519
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4520
|
-
* via the `duplicate.targetSchema` link.
|
|
4521
|
-
*
|
|
4522
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4523
|
-
* via the `destroy.targetSchema` link.
|
|
4524
|
-
*
|
|
4525
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4526
|
-
* via the `batch_destroy.targetSchema` link.
|
|
4527
|
-
*
|
|
4528
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4529
|
-
* via the `batch_publish.targetSchema` link.
|
|
4530
|
-
*
|
|
4531
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4532
|
-
* via the `batch_unpublish.targetSchema` link.
|
|
4533
|
-
*
|
|
4534
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4535
|
-
* via the `bulk_publish.targetSchema` link.
|
|
4536
|
-
*
|
|
4537
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4538
|
-
* via the `bulk_unpublish.targetSchema` link.
|
|
4539
|
-
*
|
|
4540
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4541
|
-
* via the `bulk_destroy.targetSchema` link.
|
|
4542
|
-
*
|
|
4543
|
-
* This interface was referenced by `Item`'s JSON-Schema
|
|
4544
|
-
* via the `bulk_move_to_stage.targetSchema` link.
|
|
4545
|
-
*
|
|
4546
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
4547
|
-
* via the `restore.targetSchema` link.
|
|
4548
|
-
*
|
|
4549
|
-
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4550
|
-
* via the `create.targetSchema` link.
|
|
4551
|
-
*
|
|
4552
|
-
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4553
|
-
* via the `update.targetSchema` link.
|
|
4554
|
-
*
|
|
4555
|
-
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4556
|
-
* via the `batch_add_tags.targetSchema` link.
|
|
4557
|
-
*
|
|
4558
|
-
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4559
|
-
* via the `batch_destroy.targetSchema` link.
|
|
4560
|
-
*
|
|
4561
|
-
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4562
|
-
* via the `bulk_tag.targetSchema` link.
|
|
4563
|
-
*
|
|
4564
|
-
* This interface was referenced by `Upload`'s JSON-Schema
|
|
4565
|
-
* via the `bulk_destroy.targetSchema` link.
|
|
4566
|
-
*
|
|
4567
|
-
* This interface was referenced by `UploadTrack`'s JSON-Schema
|
|
4568
|
-
* via the `create.targetSchema` link.
|
|
4569
|
-
*
|
|
4570
|
-
* This interface was referenced by `UploadTrack`'s JSON-Schema
|
|
4571
|
-
* via the `destroy.targetSchema` link.
|
|
4572
|
-
*
|
|
4573
|
-
* This interface was referenced by `UploadTrack`'s JSON-Schema
|
|
4574
|
-
* via the `generate_subtitles.targetSchema` link.
|
|
4575
|
-
*
|
|
4576
|
-
* This interface was referenced by `Site`'s JSON-Schema
|
|
4577
|
-
* via the `update.targetSchema` link.
|
|
4578
|
-
*
|
|
4579
|
-
* This interface was referenced by `Site`'s JSON-Schema
|
|
4580
|
-
* via the `activate_improved_timezone_management.targetSchema` link.
|
|
4581
|
-
*
|
|
4582
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4583
|
-
* via the `definition` "job".
|
|
4584
|
-
*/
|
|
4585
|
-
export type Job = {
|
|
4586
|
-
id: JobIdentity;
|
|
4587
|
-
type: JobType;
|
|
4588
|
-
};
|
|
4589
|
-
export type ItemTypeUpdateTargetSchema = Job;
|
|
4590
|
-
export type ItemTypeDestroyTargetSchema = Job;
|
|
4591
|
-
export type FieldCreateTargetSchema = Job;
|
|
4592
|
-
export type FieldUpdateTargetSchema = Job;
|
|
4593
|
-
export type FieldDestroyTargetSchema = Job;
|
|
4594
|
-
export type FieldDuplicateTargetSchema = Job;
|
|
4595
|
-
export type ItemDuplicateTargetSchema = Job;
|
|
4596
|
-
export type ItemDestroyTargetSchema = Job;
|
|
4597
|
-
export type ItemBatchDestroyTargetSchema = Job;
|
|
4598
|
-
export type ItemBatchPublishTargetSchema = Job;
|
|
4599
|
-
export type ItemBatchUnpublishTargetSchema = Job;
|
|
4600
|
-
export type ItemBulkPublishTargetSchema = Job;
|
|
4601
|
-
export type ItemBulkUnpublishTargetSchema = Job;
|
|
4602
|
-
export type ItemBulkDestroyTargetSchema = Job;
|
|
4603
|
-
export type ItemBulkMoveToStageTargetSchema = Job;
|
|
4604
|
-
export type ItemVersionRestoreTargetSchema = Job;
|
|
4605
|
-
export type UploadCreateTargetSchema = Job;
|
|
4606
|
-
export type UploadUpdateTargetSchema = Job;
|
|
4607
|
-
export type UploadBatchAddTagsTargetSchema = Job;
|
|
4608
|
-
export type UploadBatchDestroyTargetSchema = Job;
|
|
4609
|
-
export type UploadBulkTagTargetSchema = Job;
|
|
4610
|
-
export type UploadBulkDestroyTargetSchema = Job;
|
|
4611
|
-
export type UploadTrackCreateTargetSchema = Job;
|
|
4612
|
-
export type UploadTrackDestroyTargetSchema = Job;
|
|
4613
|
-
export type UploadTrackGenerateSubtitlesTargetSchema = Job;
|
|
4614
|
-
export type SiteUpdateTargetSchema = Job;
|
|
4615
|
-
export type SiteActivateImprovedTimezoneManagementTargetSchema = Job;
|
|
4616
|
-
/**
|
|
4617
|
-
* JSON API data
|
|
4618
|
-
*
|
|
4619
|
-
* This interface was referenced by `Job`'s JSON-Schema
|
|
4620
|
-
* via the `definition` "data".
|
|
4621
|
-
*/
|
|
4622
|
-
export type JobData = {
|
|
4623
|
-
type: JobType;
|
|
4624
|
-
id: JobIdentity;
|
|
4625
|
-
};
|
|
4626
4880
|
/**
|
|
4627
4881
|
* DatoCMS offers a number of different fields that you can combine together to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
|
|
4628
4882
|
*
|
|
@@ -4679,12 +4933,12 @@ export type JobData = {
|
|
|
4679
4933
|
*
|
|
4680
4934
|
* #### Setting the appearance to a field editor provided by a plugin
|
|
4681
4935
|
*
|
|
4682
|
-
* If the project contains a plugin that exposes [manual field editors](/docs/plugin-sdk/manual-field-extensions), you can also configure the field to be presented with it instead of using one of the
|
|
4936
|
+
* If the project contains a plugin that exposes [manual field editors](/docs/plugin-sdk/manual-field-extensions), you can also configure the field to be presented with it instead of using one of the built-in editors.
|
|
4683
4937
|
*
|
|
4684
4938
|
* In this case:
|
|
4685
4939
|
*
|
|
4686
|
-
* - the `editor` property
|
|
4687
|
-
* - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes
|
|
4940
|
+
* - the `editor` property is the plugin's project-specific autogenerated UUID. You can get it from the last part of the plugin's URL within your project's Configuration screen (e.g. `https://your-project.admin.datocms.com/configuration/plugins/PLUGIN_UUID/`), or via API with a [List all plugins](/docs/content-management-api/resources/plugin/instances) call.
|
|
4941
|
+
* - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes. This is set in the plugin's own source code, within a `manualFieldExtension()` call in its entry point (usually something like `index.tsx`).
|
|
4688
4942
|
* - the `parameters` property must provide a configuration object compatible with the [config screen of the manual field extension](/docs/plugin-sdk/manual-field-extensions#add-per-field-config-screens-to-manual-field-extensions), or an empty object if it doesn't require any configuration.
|
|
4689
4943
|
*
|
|
4690
4944
|
* ```js
|
|
@@ -7193,6 +7447,7 @@ export type Upload = {
|
|
|
7193
7447
|
*/
|
|
7194
7448
|
alpha: number;
|
|
7195
7449
|
}[];
|
|
7450
|
+
upload_collection: UploadCollectionData | null;
|
|
7196
7451
|
creator: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
|
|
7197
7452
|
};
|
|
7198
7453
|
export type UploadCreateJobSchema = Upload;
|
|
@@ -7385,6 +7640,7 @@ export type UploadAttributes = {
|
|
|
7385
7640
|
* via the `definition` "relationships".
|
|
7386
7641
|
*/
|
|
7387
7642
|
export type UploadRelationships = {
|
|
7643
|
+
upload_collection: UploadCollectionData | null;
|
|
7388
7644
|
creator: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
|
|
7389
7645
|
};
|
|
7390
7646
|
/**
|
|
@@ -7452,6 +7708,7 @@ export type UploadCreateSchema = {
|
|
|
7452
7708
|
* Tags
|
|
7453
7709
|
*/
|
|
7454
7710
|
tags?: string[];
|
|
7711
|
+
upload_collection?: UploadCollectionData | null;
|
|
7455
7712
|
};
|
|
7456
7713
|
/**
|
|
7457
7714
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
@@ -7523,6 +7780,7 @@ export type UploadUpdateSchema = {
|
|
|
7523
7780
|
};
|
|
7524
7781
|
};
|
|
7525
7782
|
creator?: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
|
|
7783
|
+
upload_collection?: UploadCollectionData | null;
|
|
7526
7784
|
};
|
|
7527
7785
|
/**
|
|
7528
7786
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
@@ -7547,6 +7805,15 @@ export type UploadBulkTagSchema = {
|
|
|
7547
7805
|
tags: string[];
|
|
7548
7806
|
uploads: UploadData[];
|
|
7549
7807
|
};
|
|
7808
|
+
/**
|
|
7809
|
+
* This interface was referenced by `Upload`'s JSON-Schema
|
|
7810
|
+
* via the `bulk_set_upload_collection.schema` link.
|
|
7811
|
+
*/
|
|
7812
|
+
export type UploadBulkSetUploadCollectionSchema = {
|
|
7813
|
+
type?: 'upload_bulk_set_upload_collection_operation';
|
|
7814
|
+
upload_collection: null | UploadCollectionData;
|
|
7815
|
+
uploads: UploadData[];
|
|
7816
|
+
};
|
|
7550
7817
|
/**
|
|
7551
7818
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
7552
7819
|
* via the `bulk_destroy.schema` link.
|
|
@@ -8351,7 +8618,7 @@ export type WebhookUpdateSchema = {
|
|
|
8351
8618
|
auto_retry?: boolean;
|
|
8352
8619
|
};
|
|
8353
8620
|
/**
|
|
8354
|
-
*
|
|
8621
|
+
* This represents a log entry in the webhooks activity list, detailing a specific webhook event along with its delivery attempt information.
|
|
8355
8622
|
*
|
|
8356
8623
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
8357
8624
|
* via the `definition` "webhook_call".
|