@datocms/cma-client 1.3.5 → 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.
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js +53 -6
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/Plugin.js +2 -2
- package/dist/cjs/generated/resources/ScheduledPublication.js +1 -1
- package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +600 -422
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +248 -83
- package/dist/esm/generated/resources/Item.d.ts +26 -4
- package/dist/esm/generated/resources/Item.js +53 -6
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/Plugin.d.ts +2 -2
- package/dist/esm/generated/resources/Plugin.js +2 -2
- package/dist/esm/generated/resources/ScheduledPublication.js +1 -1
- package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.js +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/types/generated/SchemaTypes.d.ts +600 -422
- package/dist/types/generated/SimpleSchemaTypes.d.ts +248 -83
- package/dist/types/generated/resources/Item.d.ts +26 -4
- package/dist/types/generated/resources/Plugin.d.ts +2 -2
- package/package.json +3 -3
- package/resources.json +204 -3
- package/src/generated/Client.ts +1 -1
- package/src/generated/SchemaTypes.ts +626 -443
- package/src/generated/SimpleSchemaTypes.ts +255 -86
- package/src/generated/resources/Item.ts +69 -2
- package/src/generated/resources/Plugin.ts +2 -2
- package/src/generated/resources/ScheduledPublication.ts +1 -1
- package/src/generated/resources/ScheduledUnpublishing.ts +1 -1
|
@@ -616,57 +616,56 @@ export declare type ItemSelfHrefSchema = {
|
|
|
616
616
|
[k: string]: unknown;
|
|
617
617
|
};
|
|
618
618
|
/**
|
|
619
|
-
*
|
|
620
|
-
*
|
|
619
|
+
* JSON API type field
|
|
620
|
+
*
|
|
621
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
622
|
+
* via the `definition` "type".
|
|
621
623
|
*/
|
|
622
|
-
export declare type
|
|
623
|
-
/**
|
|
624
|
-
* IDs of records to delete, comma separated (a maximum of 200 IDs are allowed per request)
|
|
625
|
-
*/
|
|
626
|
-
'filter[ids]': string;
|
|
627
|
-
};
|
|
624
|
+
export declare type ItemCurrentVsPublishedStateType = 'item_current_vs_published_state';
|
|
628
625
|
/**
|
|
629
|
-
*
|
|
630
|
-
*
|
|
626
|
+
* ID of record
|
|
627
|
+
*
|
|
628
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
629
|
+
* via the `definition` "identity".
|
|
630
|
+
*
|
|
631
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
632
|
+
* via the `definition` "id".
|
|
631
633
|
*/
|
|
632
|
-
export declare type
|
|
633
|
-
/**
|
|
634
|
-
* IDs of records to publish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
635
|
-
*/
|
|
636
|
-
'filter[ids]': string;
|
|
637
|
-
};
|
|
634
|
+
export declare type ItemCurrentVsPublishedStateIdentity = string;
|
|
638
635
|
/**
|
|
639
|
-
*
|
|
640
|
-
*
|
|
636
|
+
* JSON API type field
|
|
637
|
+
*
|
|
638
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
639
|
+
* via the `definition` "type".
|
|
641
640
|
*/
|
|
642
|
-
export declare type
|
|
643
|
-
/**
|
|
644
|
-
* IDs of records to unpublish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
645
|
-
*/
|
|
646
|
-
'filter[ids]': string;
|
|
647
|
-
};
|
|
641
|
+
export declare type ScheduledPublicationType = 'scheduled_publication';
|
|
648
642
|
/**
|
|
649
|
-
*
|
|
650
|
-
*
|
|
643
|
+
* ID of scheduled_publication
|
|
644
|
+
*
|
|
645
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
646
|
+
* via the `definition` "identity".
|
|
647
|
+
*
|
|
648
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
649
|
+
* via the `definition` "id".
|
|
651
650
|
*/
|
|
652
|
-
export declare type
|
|
653
|
-
/**
|
|
654
|
-
* If the record references other draft records, force a recursive publication
|
|
655
|
-
*/
|
|
656
|
-
recursive?: boolean;
|
|
657
|
-
[k: string]: unknown;
|
|
658
|
-
};
|
|
651
|
+
export declare type ScheduledPublicationIdentity = string;
|
|
659
652
|
/**
|
|
660
|
-
*
|
|
661
|
-
*
|
|
653
|
+
* JSON API type field
|
|
654
|
+
*
|
|
655
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
656
|
+
* via the `definition` "type".
|
|
662
657
|
*/
|
|
663
|
-
export declare type
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
658
|
+
export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
659
|
+
/**
|
|
660
|
+
* ID of scheduled_unpublishing
|
|
661
|
+
*
|
|
662
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
663
|
+
* via the `definition` "identity".
|
|
664
|
+
*
|
|
665
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
666
|
+
* via the `definition` "id".
|
|
667
|
+
*/
|
|
668
|
+
export declare type ScheduledUnpublishingIdentity = string;
|
|
670
669
|
/**
|
|
671
670
|
* JSON API type field
|
|
672
671
|
*
|
|
@@ -709,6 +708,98 @@ export declare type ItemVersionInstancesHrefSchema = {
|
|
|
709
708
|
};
|
|
710
709
|
[k: string]: unknown;
|
|
711
710
|
};
|
|
711
|
+
/**
|
|
712
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
713
|
+
* via the `batch_destroy.hrefSchema` link.
|
|
714
|
+
*/
|
|
715
|
+
export declare type ItemBatchDestroyHrefSchema = {
|
|
716
|
+
/**
|
|
717
|
+
* IDs of records to delete, comma separated (a maximum of 200 IDs are allowed per request)
|
|
718
|
+
*/
|
|
719
|
+
'filter[ids]': string;
|
|
720
|
+
};
|
|
721
|
+
/**
|
|
722
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
723
|
+
* via the `batch_publish.hrefSchema` link.
|
|
724
|
+
*/
|
|
725
|
+
export declare type ItemBatchPublishHrefSchema = {
|
|
726
|
+
/**
|
|
727
|
+
* IDs of records to publish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
728
|
+
*/
|
|
729
|
+
'filter[ids]': string;
|
|
730
|
+
};
|
|
731
|
+
/**
|
|
732
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
733
|
+
* via the `batch_unpublish.hrefSchema` link.
|
|
734
|
+
*/
|
|
735
|
+
export declare type ItemBatchUnpublishHrefSchema = {
|
|
736
|
+
/**
|
|
737
|
+
* IDs of records to unpublish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
738
|
+
*/
|
|
739
|
+
'filter[ids]': string;
|
|
740
|
+
};
|
|
741
|
+
/**
|
|
742
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
743
|
+
* via the `publish.schema` link.
|
|
744
|
+
*/
|
|
745
|
+
export declare type ItemPublishSchema = {
|
|
746
|
+
data: {
|
|
747
|
+
/**
|
|
748
|
+
* JSON API type field
|
|
749
|
+
*/
|
|
750
|
+
type: 'selective_publish_operation';
|
|
751
|
+
attributes: {
|
|
752
|
+
/**
|
|
753
|
+
* List of locales whose content will be published
|
|
754
|
+
*/
|
|
755
|
+
content_in_locales: string[];
|
|
756
|
+
/**
|
|
757
|
+
* Whether non-localized content has to be published or not
|
|
758
|
+
*/
|
|
759
|
+
non_localized_content: boolean;
|
|
760
|
+
};
|
|
761
|
+
};
|
|
762
|
+
} | null;
|
|
763
|
+
/**
|
|
764
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
765
|
+
* via the `publish.hrefSchema` link.
|
|
766
|
+
*/
|
|
767
|
+
export declare type ItemPublishHrefSchema = {
|
|
768
|
+
/**
|
|
769
|
+
* If the record references other draft records, force a recursive publication
|
|
770
|
+
*/
|
|
771
|
+
recursive?: boolean;
|
|
772
|
+
[k: string]: unknown;
|
|
773
|
+
};
|
|
774
|
+
/**
|
|
775
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
776
|
+
* via the `unpublish.schema` link.
|
|
777
|
+
*/
|
|
778
|
+
export declare type ItemUnpublishSchema = {
|
|
779
|
+
data: {
|
|
780
|
+
/**
|
|
781
|
+
* JSON API type field
|
|
782
|
+
*/
|
|
783
|
+
type: 'selective_unpublish_operation';
|
|
784
|
+
attributes: {
|
|
785
|
+
/**
|
|
786
|
+
* List of locales whose content will be unpublished
|
|
787
|
+
*/
|
|
788
|
+
content_in_locales: string[];
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
} | null;
|
|
792
|
+
/**
|
|
793
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
794
|
+
* via the `unpublish.hrefSchema` link.
|
|
795
|
+
*/
|
|
796
|
+
export declare type ItemUnpublishHrefSchema = {
|
|
797
|
+
/**
|
|
798
|
+
* If the record is referenced by other published records, unpublish them recursively
|
|
799
|
+
*/
|
|
800
|
+
recursive?: boolean;
|
|
801
|
+
[k: string]: unknown;
|
|
802
|
+
};
|
|
712
803
|
/**
|
|
713
804
|
* JSON API type upload
|
|
714
805
|
*
|
|
@@ -829,40 +920,6 @@ export declare type UploadRequestType = 'upload_request';
|
|
|
829
920
|
* via the `definition` "id".
|
|
830
921
|
*/
|
|
831
922
|
export declare type UploadRequestIdentity = string;
|
|
832
|
-
/**
|
|
833
|
-
* JSON API type field
|
|
834
|
-
*
|
|
835
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
836
|
-
* via the `definition` "type".
|
|
837
|
-
*/
|
|
838
|
-
export declare type ScheduledPublicationType = 'scheduled_publication';
|
|
839
|
-
/**
|
|
840
|
-
* ID of scheduled_publication
|
|
841
|
-
*
|
|
842
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
843
|
-
* via the `definition` "identity".
|
|
844
|
-
*
|
|
845
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
846
|
-
* via the `definition` "id".
|
|
847
|
-
*/
|
|
848
|
-
export declare type ScheduledPublicationIdentity = string;
|
|
849
|
-
/**
|
|
850
|
-
* JSON API type field
|
|
851
|
-
*
|
|
852
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
853
|
-
* via the `definition` "type".
|
|
854
|
-
*/
|
|
855
|
-
export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
856
|
-
/**
|
|
857
|
-
* ID of scheduled_unpublishing
|
|
858
|
-
*
|
|
859
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
860
|
-
* via the `definition` "identity".
|
|
861
|
-
*
|
|
862
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
863
|
-
* via the `definition` "id".
|
|
864
|
-
*/
|
|
865
|
-
export declare type ScheduledUnpublishingIdentity = string;
|
|
866
923
|
/**
|
|
867
924
|
* JSON API type field
|
|
868
925
|
*
|
|
@@ -1340,6 +1397,7 @@ export declare type DatoApi = {
|
|
|
1340
1397
|
subscription_feature?: SubscriptionFeature;
|
|
1341
1398
|
build_event?: BuildEvent;
|
|
1342
1399
|
item?: Item;
|
|
1400
|
+
item_current_vs_published_state?: ItemCurrentVsPublishedState;
|
|
1343
1401
|
item_version?: ItemVersion;
|
|
1344
1402
|
upload?: Upload;
|
|
1345
1403
|
upload_request?: UploadRequest;
|
|
@@ -6190,121 +6248,409 @@ export declare type ItemSelfTargetSchema = {
|
|
|
6190
6248
|
};
|
|
6191
6249
|
/**
|
|
6192
6250
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6193
|
-
* via the `
|
|
6251
|
+
* via the `current_vs_published_state.targetSchema` link.
|
|
6194
6252
|
*/
|
|
6195
|
-
export declare type
|
|
6196
|
-
data:
|
|
6253
|
+
export declare type ItemCurrentVsPublishedStateTargetSchema = {
|
|
6254
|
+
data: ItemCurrentVsPublishedState;
|
|
6255
|
+
included: (ScheduledPublication | ScheduledUnpublishing | ItemVersion)[];
|
|
6197
6256
|
};
|
|
6198
6257
|
/**
|
|
6199
|
-
*
|
|
6200
|
-
*
|
|
6258
|
+
* Information about the record
|
|
6259
|
+
*
|
|
6260
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6261
|
+
* via the `definition` "item_current_vs_published_state".
|
|
6201
6262
|
*/
|
|
6202
|
-
export declare type
|
|
6203
|
-
|
|
6263
|
+
export declare type ItemCurrentVsPublishedState = {
|
|
6264
|
+
type: ItemCurrentVsPublishedStateType;
|
|
6265
|
+
id: ItemCurrentVsPublishedStateIdentity;
|
|
6266
|
+
attributes: ItemCurrentVsPublishedStateAttributes;
|
|
6267
|
+
relationships: ItemCurrentVsPublishedStateRelationships;
|
|
6204
6268
|
};
|
|
6205
6269
|
/**
|
|
6206
|
-
*
|
|
6207
|
-
*
|
|
6270
|
+
* The JSON data associated to the record
|
|
6271
|
+
*
|
|
6272
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
6273
|
+
* via the `definition` "attributes".
|
|
6208
6274
|
*/
|
|
6209
|
-
export declare type
|
|
6210
|
-
|
|
6275
|
+
export declare type ItemCurrentVsPublishedStateAttributes = {
|
|
6276
|
+
current_version_locales: string[];
|
|
6277
|
+
published_version_locales: string[];
|
|
6278
|
+
changed_locales: string[];
|
|
6279
|
+
added_locales: string[];
|
|
6280
|
+
removed_locales: string[];
|
|
6281
|
+
non_localized_fields_changed: boolean;
|
|
6211
6282
|
};
|
|
6212
6283
|
/**
|
|
6213
|
-
*
|
|
6214
|
-
*
|
|
6284
|
+
* JSON API links
|
|
6285
|
+
*
|
|
6286
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
6287
|
+
* via the `definition` "relationships".
|
|
6215
6288
|
*/
|
|
6216
|
-
export declare type
|
|
6217
|
-
|
|
6218
|
-
|
|
6219
|
-
|
|
6220
|
-
|
|
6289
|
+
export declare type ItemCurrentVsPublishedStateRelationships = {
|
|
6290
|
+
/**
|
|
6291
|
+
* The scheduled publication entity, if available
|
|
6292
|
+
*/
|
|
6293
|
+
scheduled_publication: {
|
|
6294
|
+
data: ScheduledPublicationData | null;
|
|
6295
|
+
};
|
|
6296
|
+
/**
|
|
6297
|
+
* The scheduled unpublishing entity, if available
|
|
6298
|
+
*/
|
|
6299
|
+
scheduled_unpublishing: {
|
|
6300
|
+
data: ScheduledUnpublishingData | null;
|
|
6301
|
+
};
|
|
6302
|
+
/**
|
|
6303
|
+
* The currently published version for the record, if available
|
|
6304
|
+
*/
|
|
6305
|
+
published_version: {
|
|
6306
|
+
data: ItemVersionData | null;
|
|
6221
6307
|
};
|
|
6222
6308
|
};
|
|
6223
6309
|
/**
|
|
6224
|
-
*
|
|
6225
|
-
*
|
|
6310
|
+
* JSON API data
|
|
6311
|
+
*
|
|
6312
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6313
|
+
* via the `definition` "data".
|
|
6226
6314
|
*/
|
|
6227
|
-
export declare type
|
|
6228
|
-
|
|
6315
|
+
export declare type ScheduledPublicationData = {
|
|
6316
|
+
type: ScheduledPublicationType;
|
|
6317
|
+
id: ScheduledPublicationIdentity;
|
|
6229
6318
|
};
|
|
6230
6319
|
/**
|
|
6231
|
-
*
|
|
6232
|
-
*
|
|
6320
|
+
* JSON API data
|
|
6321
|
+
*
|
|
6322
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6323
|
+
* via the `definition` "data".
|
|
6233
6324
|
*/
|
|
6234
|
-
export declare type
|
|
6235
|
-
|
|
6236
|
-
|
|
6237
|
-
successful: number;
|
|
6238
|
-
failed: number;
|
|
6239
|
-
};
|
|
6325
|
+
export declare type ScheduledUnpublishingData = {
|
|
6326
|
+
type: ScheduledUnpublishingType;
|
|
6327
|
+
id: ScheduledUnpublishingIdentity;
|
|
6240
6328
|
};
|
|
6241
6329
|
/**
|
|
6242
|
-
*
|
|
6243
|
-
*
|
|
6330
|
+
* JSON API data
|
|
6331
|
+
*
|
|
6332
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6333
|
+
* via the `definition` "data".
|
|
6244
6334
|
*/
|
|
6245
|
-
export declare type
|
|
6246
|
-
|
|
6335
|
+
export declare type ItemVersionData = {
|
|
6336
|
+
type: ItemVersionType;
|
|
6337
|
+
id: ItemVersionIdentity;
|
|
6247
6338
|
};
|
|
6248
6339
|
/**
|
|
6249
|
-
*
|
|
6250
|
-
*
|
|
6340
|
+
* JSON API data
|
|
6341
|
+
*
|
|
6342
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
6343
|
+
* via the `definition` "data".
|
|
6251
6344
|
*/
|
|
6252
|
-
export declare type
|
|
6253
|
-
|
|
6254
|
-
|
|
6255
|
-
|
|
6256
|
-
|
|
6345
|
+
export declare type ItemCurrentVsPublishedStateData = {
|
|
6346
|
+
type: ItemCurrentVsPublishedStateType;
|
|
6347
|
+
id: ItemCurrentVsPublishedStateIdentity;
|
|
6348
|
+
};
|
|
6349
|
+
/**
|
|
6350
|
+
* You can create scheduled publication to publish records in the future
|
|
6351
|
+
*
|
|
6352
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6353
|
+
* via the `definition` "scheduled_publication".
|
|
6354
|
+
*/
|
|
6355
|
+
export declare type ScheduledPublication = {
|
|
6356
|
+
type: ScheduledPublicationType;
|
|
6357
|
+
id: ScheduledPublicationIdentity;
|
|
6358
|
+
attributes: ScheduledPublicationAttributes;
|
|
6359
|
+
relationships: ScheduledPublicationRelationships;
|
|
6360
|
+
};
|
|
6361
|
+
/**
|
|
6362
|
+
* JSON API attributes
|
|
6363
|
+
*
|
|
6364
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6365
|
+
* via the `definition` "attributes".
|
|
6366
|
+
*/
|
|
6367
|
+
export declare type ScheduledPublicationAttributes = {
|
|
6368
|
+
/**
|
|
6369
|
+
* The future date for the publication
|
|
6370
|
+
*/
|
|
6371
|
+
publication_scheduled_at: string;
|
|
6372
|
+
/**
|
|
6373
|
+
* Specifies which content should be published. If null, the whole record will be published.
|
|
6374
|
+
*/
|
|
6375
|
+
selective_publication: null | {
|
|
6376
|
+
/**
|
|
6377
|
+
* List of locales whose content will be published
|
|
6378
|
+
*/
|
|
6379
|
+
content_in_locales: string[];
|
|
6380
|
+
/**
|
|
6381
|
+
* Whether the non-localized content has to be published or not
|
|
6382
|
+
*/
|
|
6383
|
+
non_localized_content: boolean;
|
|
6257
6384
|
};
|
|
6258
6385
|
};
|
|
6259
6386
|
/**
|
|
6260
|
-
*
|
|
6261
|
-
*
|
|
6387
|
+
* JSON API links
|
|
6388
|
+
*
|
|
6389
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6390
|
+
* via the `definition` "relationships".
|
|
6262
6391
|
*/
|
|
6263
|
-
export declare type
|
|
6264
|
-
|
|
6265
|
-
|
|
6392
|
+
export declare type ScheduledPublicationRelationships = {
|
|
6393
|
+
/**
|
|
6394
|
+
* Item
|
|
6395
|
+
*/
|
|
6396
|
+
item: {
|
|
6397
|
+
data: ItemData;
|
|
6398
|
+
};
|
|
6266
6399
|
};
|
|
6267
6400
|
/**
|
|
6268
|
-
* This interface was referenced by `
|
|
6269
|
-
* via the `
|
|
6401
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6402
|
+
* via the `create.schema` link.
|
|
6270
6403
|
*/
|
|
6271
|
-
export declare type
|
|
6404
|
+
export declare type ScheduledPublicationCreateSchema = {
|
|
6405
|
+
data: {
|
|
6406
|
+
type: ScheduledPublicationType;
|
|
6407
|
+
/**
|
|
6408
|
+
* JSON API attributes
|
|
6409
|
+
*/
|
|
6410
|
+
attributes: {
|
|
6411
|
+
/**
|
|
6412
|
+
* The future date for the publication
|
|
6413
|
+
*/
|
|
6414
|
+
publication_scheduled_at: string;
|
|
6415
|
+
/**
|
|
6416
|
+
* Specifies which content should be published. If null, the whole record will be published.
|
|
6417
|
+
*/
|
|
6418
|
+
selective_publication?: null | {
|
|
6419
|
+
/**
|
|
6420
|
+
* List of locales whose content will be published
|
|
6421
|
+
*/
|
|
6422
|
+
content_in_locales: string[];
|
|
6423
|
+
/**
|
|
6424
|
+
* Whether the non-localized content has to be published or not
|
|
6425
|
+
*/
|
|
6426
|
+
non_localized_content: boolean;
|
|
6427
|
+
};
|
|
6428
|
+
};
|
|
6429
|
+
};
|
|
6430
|
+
};
|
|
6431
|
+
/**
|
|
6432
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6433
|
+
* via the `create.targetSchema` link.
|
|
6434
|
+
*/
|
|
6435
|
+
export declare type ScheduledPublicationCreateTargetSchema = {
|
|
6436
|
+
data: ScheduledPublication;
|
|
6437
|
+
included: Item[];
|
|
6438
|
+
};
|
|
6439
|
+
/**
|
|
6440
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6441
|
+
* via the `destroy.targetSchema` link.
|
|
6442
|
+
*/
|
|
6443
|
+
export declare type ScheduledPublicationDestroyTargetSchema = {
|
|
6272
6444
|
data: Item;
|
|
6273
|
-
included?: ItemType[];
|
|
6274
6445
|
};
|
|
6275
6446
|
/**
|
|
6276
|
-
*
|
|
6277
|
-
*
|
|
6447
|
+
* You can create a scheduled unpublishing to unpublish records in the future
|
|
6448
|
+
*
|
|
6449
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6450
|
+
* via the `definition` "scheduled_unpublishing".
|
|
6278
6451
|
*/
|
|
6279
|
-
export declare type
|
|
6452
|
+
export declare type ScheduledUnpublishing = {
|
|
6453
|
+
type: ScheduledUnpublishingType;
|
|
6454
|
+
id: ScheduledUnpublishingIdentity;
|
|
6455
|
+
attributes: ScheduledUnpublishingAttributes;
|
|
6456
|
+
relationships: ScheduledUnpublishingRelationships;
|
|
6457
|
+
};
|
|
6458
|
+
/**
|
|
6459
|
+
* JSON API attributes
|
|
6460
|
+
*
|
|
6461
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6462
|
+
* via the `definition` "attributes".
|
|
6463
|
+
*/
|
|
6464
|
+
export declare type ScheduledUnpublishingAttributes = {
|
|
6465
|
+
/**
|
|
6466
|
+
* The future date for the unpublishing
|
|
6467
|
+
*/
|
|
6468
|
+
unpublishing_scheduled_at: string;
|
|
6469
|
+
/**
|
|
6470
|
+
* List of locales whose content will be unpublished, or nil if the whole record needs to be unpublished
|
|
6471
|
+
*/
|
|
6472
|
+
content_in_locales: null | string[];
|
|
6473
|
+
};
|
|
6474
|
+
/**
|
|
6475
|
+
* JSON API links
|
|
6476
|
+
*
|
|
6477
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6478
|
+
* via the `definition` "relationships".
|
|
6479
|
+
*/
|
|
6480
|
+
export declare type ScheduledUnpublishingRelationships = {
|
|
6481
|
+
/**
|
|
6482
|
+
* Item
|
|
6483
|
+
*/
|
|
6484
|
+
item: {
|
|
6485
|
+
data: ItemData;
|
|
6486
|
+
};
|
|
6487
|
+
};
|
|
6488
|
+
/**
|
|
6489
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6490
|
+
* via the `create.schema` link.
|
|
6491
|
+
*/
|
|
6492
|
+
export declare type ScheduledUnpublishingCreateSchema = {
|
|
6280
6493
|
data: {
|
|
6494
|
+
type: ScheduledUnpublishingType;
|
|
6281
6495
|
/**
|
|
6282
|
-
* JSON API
|
|
6496
|
+
* JSON API attributes
|
|
6283
6497
|
*/
|
|
6284
|
-
|
|
6285
|
-
relationships: {
|
|
6498
|
+
attributes: {
|
|
6286
6499
|
/**
|
|
6287
|
-
*
|
|
6500
|
+
* The future date for the unpublishing
|
|
6288
6501
|
*/
|
|
6289
|
-
|
|
6290
|
-
|
|
6291
|
-
|
|
6292
|
-
|
|
6502
|
+
unpublishing_scheduled_at: string;
|
|
6503
|
+
/**
|
|
6504
|
+
* List of locales whose content will be unpublished, or nil if the whole record needs to be unpublished
|
|
6505
|
+
*/
|
|
6506
|
+
content_in_locales?: null | string[];
|
|
6293
6507
|
};
|
|
6294
6508
|
};
|
|
6295
6509
|
};
|
|
6510
|
+
/**
|
|
6511
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6512
|
+
* via the `create.targetSchema` link.
|
|
6513
|
+
*/
|
|
6514
|
+
export declare type ScheduledUnpublishingCreateTargetSchema = {
|
|
6515
|
+
data: ScheduledUnpublishing;
|
|
6516
|
+
included: Item[];
|
|
6517
|
+
};
|
|
6518
|
+
/**
|
|
6519
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6520
|
+
* via the `destroy.targetSchema` link.
|
|
6521
|
+
*/
|
|
6522
|
+
export declare type ScheduledUnpublishingDestroyTargetSchema = {
|
|
6523
|
+
data: Item;
|
|
6524
|
+
};
|
|
6525
|
+
/**
|
|
6526
|
+
* Every change to a record is stored as a separate record version in DatoCMS.
|
|
6527
|
+
*
|
|
6528
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6529
|
+
* via the `definition` "item_version".
|
|
6530
|
+
*/
|
|
6531
|
+
export declare type ItemVersion = {
|
|
6532
|
+
type: ItemVersionType;
|
|
6533
|
+
id: ItemVersionIdentity;
|
|
6534
|
+
attributes: ItemVersionAttributes;
|
|
6535
|
+
relationships: ItemVersionRelationships;
|
|
6536
|
+
meta: ItemVersionMeta;
|
|
6537
|
+
};
|
|
6538
|
+
/**
|
|
6539
|
+
* The JSON data associated to the record version
|
|
6540
|
+
*
|
|
6541
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6542
|
+
* via the `definition` "attributes".
|
|
6543
|
+
*/
|
|
6544
|
+
export declare type ItemVersionAttributes = {
|
|
6545
|
+
[k: string]: unknown;
|
|
6546
|
+
};
|
|
6547
|
+
/**
|
|
6548
|
+
* JSON API links
|
|
6549
|
+
*
|
|
6550
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6551
|
+
* via the `definition` "relationships".
|
|
6552
|
+
*/
|
|
6553
|
+
export declare type ItemVersionRelationships = {
|
|
6554
|
+
/**
|
|
6555
|
+
* The record version's model
|
|
6556
|
+
*/
|
|
6557
|
+
item_type: {
|
|
6558
|
+
data: ItemTypeData;
|
|
6559
|
+
};
|
|
6560
|
+
/**
|
|
6561
|
+
* The record this version belongs to
|
|
6562
|
+
*/
|
|
6563
|
+
item: {
|
|
6564
|
+
data: ItemData;
|
|
6565
|
+
};
|
|
6566
|
+
/**
|
|
6567
|
+
* The entity (account/collaborator/access token/sso user) who made this change to the record. It must be an object with `type` (e.g. 'account') and `id` properties.
|
|
6568
|
+
*/
|
|
6569
|
+
editor: {
|
|
6570
|
+
data: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
|
|
6571
|
+
};
|
|
6572
|
+
};
|
|
6573
|
+
/**
|
|
6574
|
+
* Meta information regarding the record version
|
|
6575
|
+
*
|
|
6576
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6577
|
+
* via the `definition` "meta".
|
|
6578
|
+
*/
|
|
6579
|
+
export declare type ItemVersionMeta = {
|
|
6580
|
+
/**
|
|
6581
|
+
* Date of record version creation
|
|
6582
|
+
*/
|
|
6583
|
+
created_at: string;
|
|
6584
|
+
/**
|
|
6585
|
+
* Whether the record version is valid or not
|
|
6586
|
+
*/
|
|
6587
|
+
is_valid: boolean;
|
|
6588
|
+
/**
|
|
6589
|
+
* Whether the record version is the published version or not
|
|
6590
|
+
*/
|
|
6591
|
+
is_published: boolean;
|
|
6592
|
+
/**
|
|
6593
|
+
* Whether the record version is the most recent version or not
|
|
6594
|
+
*/
|
|
6595
|
+
is_current: boolean;
|
|
6596
|
+
};
|
|
6597
|
+
/**
|
|
6598
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6599
|
+
* via the `restore.targetSchema` link.
|
|
6600
|
+
*/
|
|
6601
|
+
export declare type ItemVersionRestoreTargetSchema = {
|
|
6602
|
+
data: Job;
|
|
6603
|
+
};
|
|
6604
|
+
/**
|
|
6605
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6606
|
+
* via the `restore.jobSchema` link.
|
|
6607
|
+
*/
|
|
6608
|
+
export declare type ItemVersionRestoreJobSchema = {
|
|
6609
|
+
data: [Item, ItemVersion];
|
|
6610
|
+
};
|
|
6611
|
+
/**
|
|
6612
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6613
|
+
* via the `instances.targetSchema` link.
|
|
6614
|
+
*/
|
|
6615
|
+
export declare type ItemVersionInstancesTargetSchema = {
|
|
6616
|
+
data: ItemVersion[];
|
|
6617
|
+
meta: {
|
|
6618
|
+
total_count: number;
|
|
6619
|
+
};
|
|
6620
|
+
};
|
|
6621
|
+
/**
|
|
6622
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6623
|
+
* via the `self.targetSchema` link.
|
|
6624
|
+
*/
|
|
6625
|
+
export declare type ItemVersionSelfTargetSchema = {
|
|
6626
|
+
data: ItemVersion;
|
|
6627
|
+
};
|
|
6296
6628
|
/**
|
|
6297
6629
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6298
|
-
* via the `
|
|
6630
|
+
* via the `destroy.targetSchema` link.
|
|
6299
6631
|
*/
|
|
6300
|
-
export declare type
|
|
6632
|
+
export declare type ItemDestroyTargetSchema = {
|
|
6301
6633
|
data: Job;
|
|
6302
6634
|
};
|
|
6303
6635
|
/**
|
|
6304
6636
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6305
|
-
* via the `
|
|
6637
|
+
* via the `destroy.jobSchema` link.
|
|
6306
6638
|
*/
|
|
6307
|
-
export declare type
|
|
6639
|
+
export declare type ItemDestroyJobSchema = {
|
|
6640
|
+
data: Item;
|
|
6641
|
+
};
|
|
6642
|
+
/**
|
|
6643
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6644
|
+
* via the `batch_destroy.targetSchema` link.
|
|
6645
|
+
*/
|
|
6646
|
+
export declare type ItemBatchDestroyTargetSchema = {
|
|
6647
|
+
data: Job;
|
|
6648
|
+
};
|
|
6649
|
+
/**
|
|
6650
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6651
|
+
* via the `batch_destroy.jobSchema` link.
|
|
6652
|
+
*/
|
|
6653
|
+
export declare type ItemBatchDestroyJobSchema = {
|
|
6308
6654
|
data: unknown[];
|
|
6309
6655
|
meta: {
|
|
6310
6656
|
successful: number;
|
|
@@ -6313,37 +6659,34 @@ export declare type ItemBulkPublishJobSchema = {
|
|
|
6313
6659
|
};
|
|
6314
6660
|
/**
|
|
6315
6661
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6316
|
-
* via the `
|
|
6662
|
+
* via the `batch_publish.targetSchema` link.
|
|
6317
6663
|
*/
|
|
6318
|
-
export declare type
|
|
6319
|
-
data:
|
|
6320
|
-
|
|
6321
|
-
|
|
6322
|
-
|
|
6323
|
-
|
|
6324
|
-
|
|
6325
|
-
|
|
6326
|
-
|
|
6327
|
-
|
|
6328
|
-
|
|
6329
|
-
|
|
6330
|
-
};
|
|
6331
|
-
minItems?: unknown;
|
|
6332
|
-
};
|
|
6664
|
+
export declare type ItemBatchPublishTargetSchema = {
|
|
6665
|
+
data: Job;
|
|
6666
|
+
};
|
|
6667
|
+
/**
|
|
6668
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6669
|
+
* via the `batch_publish.jobSchema` link.
|
|
6670
|
+
*/
|
|
6671
|
+
export declare type ItemBatchPublishJobSchema = {
|
|
6672
|
+
data: unknown[];
|
|
6673
|
+
meta: {
|
|
6674
|
+
successful: number;
|
|
6675
|
+
failed: number;
|
|
6333
6676
|
};
|
|
6334
6677
|
};
|
|
6335
6678
|
/**
|
|
6336
6679
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6337
|
-
* via the `
|
|
6680
|
+
* via the `batch_unpublish.targetSchema` link.
|
|
6338
6681
|
*/
|
|
6339
|
-
export declare type
|
|
6682
|
+
export declare type ItemBatchUnpublishTargetSchema = {
|
|
6340
6683
|
data: Job;
|
|
6341
6684
|
};
|
|
6342
6685
|
/**
|
|
6343
6686
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6344
|
-
* via the `
|
|
6687
|
+
* via the `batch_unpublish.jobSchema` link.
|
|
6345
6688
|
*/
|
|
6346
|
-
export declare type
|
|
6689
|
+
export declare type ItemBatchUnpublishJobSchema = {
|
|
6347
6690
|
data: unknown[];
|
|
6348
6691
|
meta: {
|
|
6349
6692
|
successful: number;
|
|
@@ -6352,17 +6695,33 @@ export declare type ItemBulkUnpublishJobSchema = {
|
|
|
6352
6695
|
};
|
|
6353
6696
|
/**
|
|
6354
6697
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6355
|
-
* via the `
|
|
6698
|
+
* via the `publish.targetSchema` link.
|
|
6356
6699
|
*/
|
|
6357
|
-
export declare type
|
|
6700
|
+
export declare type ItemPublishTargetSchema = {
|
|
6701
|
+
data: Item;
|
|
6702
|
+
included?: ItemType[];
|
|
6703
|
+
};
|
|
6704
|
+
/**
|
|
6705
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6706
|
+
* via the `unpublish.targetSchema` link.
|
|
6707
|
+
*/
|
|
6708
|
+
export declare type ItemUnpublishTargetSchema = {
|
|
6709
|
+
data: Item;
|
|
6710
|
+
included?: ItemType[];
|
|
6711
|
+
};
|
|
6712
|
+
/**
|
|
6713
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6714
|
+
* via the `bulk_publish.schema` link.
|
|
6715
|
+
*/
|
|
6716
|
+
export declare type ItemBulkPublishSchema = {
|
|
6358
6717
|
data: {
|
|
6359
6718
|
/**
|
|
6360
6719
|
* JSON API type field
|
|
6361
6720
|
*/
|
|
6362
|
-
type: '
|
|
6721
|
+
type: 'item_bulk_publish_operation';
|
|
6363
6722
|
relationships: {
|
|
6364
6723
|
/**
|
|
6365
|
-
* Records to
|
|
6724
|
+
* Records to publish (a maximum of 200 records are allowed per request)
|
|
6366
6725
|
*/
|
|
6367
6726
|
items: {
|
|
6368
6727
|
data: ItemData[];
|
|
@@ -6373,16 +6732,16 @@ export declare type ItemBulkDestroySchema = {
|
|
|
6373
6732
|
};
|
|
6374
6733
|
/**
|
|
6375
6734
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6376
|
-
* via the `
|
|
6735
|
+
* via the `bulk_publish.targetSchema` link.
|
|
6377
6736
|
*/
|
|
6378
|
-
export declare type
|
|
6737
|
+
export declare type ItemBulkPublishTargetSchema = {
|
|
6379
6738
|
data: Job;
|
|
6380
6739
|
};
|
|
6381
6740
|
/**
|
|
6382
6741
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6383
|
-
* via the `
|
|
6742
|
+
* via the `bulk_publish.jobSchema` link.
|
|
6384
6743
|
*/
|
|
6385
|
-
export declare type
|
|
6744
|
+
export declare type ItemBulkPublishJobSchema = {
|
|
6386
6745
|
data: unknown[];
|
|
6387
6746
|
meta: {
|
|
6388
6747
|
successful: number;
|
|
@@ -6391,23 +6750,17 @@ export declare type ItemBulkDestroyJobSchema = {
|
|
|
6391
6750
|
};
|
|
6392
6751
|
/**
|
|
6393
6752
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6394
|
-
* via the `
|
|
6753
|
+
* via the `bulk_unpublish.schema` link.
|
|
6395
6754
|
*/
|
|
6396
|
-
export declare type
|
|
6755
|
+
export declare type ItemBulkUnpublishSchema = {
|
|
6397
6756
|
data: {
|
|
6398
6757
|
/**
|
|
6399
6758
|
* JSON API type field
|
|
6400
6759
|
*/
|
|
6401
|
-
type: '
|
|
6402
|
-
attributes: {
|
|
6403
|
-
/**
|
|
6404
|
-
* Stage to be moved to
|
|
6405
|
-
*/
|
|
6406
|
-
stage: string;
|
|
6407
|
-
};
|
|
6760
|
+
type: 'item_bulk_unpublish_operation';
|
|
6408
6761
|
relationships: {
|
|
6409
6762
|
/**
|
|
6410
|
-
* Records to
|
|
6763
|
+
* Records to unpublish (a maximum of 200 records are allowed per request)
|
|
6411
6764
|
*/
|
|
6412
6765
|
items: {
|
|
6413
6766
|
data: ItemData[];
|
|
@@ -6418,16 +6771,16 @@ export declare type ItemBulkMoveToStageSchema = {
|
|
|
6418
6771
|
};
|
|
6419
6772
|
/**
|
|
6420
6773
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6421
|
-
* via the `
|
|
6774
|
+
* via the `bulk_unpublish.targetSchema` link.
|
|
6422
6775
|
*/
|
|
6423
|
-
export declare type
|
|
6776
|
+
export declare type ItemBulkUnpublishTargetSchema = {
|
|
6424
6777
|
data: Job;
|
|
6425
6778
|
};
|
|
6426
6779
|
/**
|
|
6427
6780
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6428
|
-
* via the `
|
|
6781
|
+
* via the `bulk_unpublish.jobSchema` link.
|
|
6429
6782
|
*/
|
|
6430
|
-
export declare type
|
|
6783
|
+
export declare type ItemBulkUnpublishJobSchema = {
|
|
6431
6784
|
data: unknown[];
|
|
6432
6785
|
meta: {
|
|
6433
6786
|
successful: number;
|
|
@@ -6435,118 +6788,89 @@ export declare type ItemBulkMoveToStageJobSchema = {
|
|
|
6435
6788
|
};
|
|
6436
6789
|
};
|
|
6437
6790
|
/**
|
|
6438
|
-
*
|
|
6439
|
-
*
|
|
6440
|
-
|
|
6441
|
-
|
|
6442
|
-
|
|
6443
|
-
|
|
6444
|
-
|
|
6445
|
-
|
|
6446
|
-
|
|
6447
|
-
|
|
6448
|
-
|
|
6449
|
-
|
|
6450
|
-
|
|
6451
|
-
|
|
6452
|
-
|
|
6453
|
-
|
|
6454
|
-
|
|
6455
|
-
|
|
6456
|
-
export declare type ItemVersionAttributes = {
|
|
6457
|
-
[k: string]: unknown;
|
|
6458
|
-
};
|
|
6459
|
-
/**
|
|
6460
|
-
* JSON API links
|
|
6461
|
-
*
|
|
6462
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6463
|
-
* via the `definition` "relationships".
|
|
6464
|
-
*/
|
|
6465
|
-
export declare type ItemVersionRelationships = {
|
|
6466
|
-
/**
|
|
6467
|
-
* The record version's model
|
|
6468
|
-
*/
|
|
6469
|
-
item_type: {
|
|
6470
|
-
data: ItemTypeData;
|
|
6471
|
-
};
|
|
6472
|
-
/**
|
|
6473
|
-
* The record this version belongs to
|
|
6474
|
-
*/
|
|
6475
|
-
item: {
|
|
6476
|
-
data: ItemData;
|
|
6477
|
-
};
|
|
6478
|
-
/**
|
|
6479
|
-
* The entity (account/collaborator/access token/sso user) who made this change to the record. It must be an object with `type` (e.g. 'account') and `id` properties.
|
|
6480
|
-
*/
|
|
6481
|
-
editor: {
|
|
6482
|
-
data: AccountData | AccessTokenData | UserData | SsoUserData | OrganizationData;
|
|
6791
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6792
|
+
* via the `bulk_destroy.schema` link.
|
|
6793
|
+
*/
|
|
6794
|
+
export declare type ItemBulkDestroySchema = {
|
|
6795
|
+
data: {
|
|
6796
|
+
/**
|
|
6797
|
+
* JSON API type field
|
|
6798
|
+
*/
|
|
6799
|
+
type: 'item_bulk_destroy_operation';
|
|
6800
|
+
relationships: {
|
|
6801
|
+
/**
|
|
6802
|
+
* Records to delete (a maximum of 200 records are allowed per request)
|
|
6803
|
+
*/
|
|
6804
|
+
items: {
|
|
6805
|
+
data: ItemData[];
|
|
6806
|
+
};
|
|
6807
|
+
minItems?: unknown;
|
|
6808
|
+
};
|
|
6483
6809
|
};
|
|
6484
6810
|
};
|
|
6485
6811
|
/**
|
|
6486
|
-
*
|
|
6487
|
-
*
|
|
6488
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6489
|
-
* via the `definition` "meta".
|
|
6812
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6813
|
+
* via the `bulk_destroy.targetSchema` link.
|
|
6490
6814
|
*/
|
|
6491
|
-
export declare type
|
|
6492
|
-
|
|
6493
|
-
* Date of record version creation
|
|
6494
|
-
*/
|
|
6495
|
-
created_at: string;
|
|
6496
|
-
/**
|
|
6497
|
-
* Whether the record version is valid or not
|
|
6498
|
-
*/
|
|
6499
|
-
is_valid: boolean;
|
|
6500
|
-
/**
|
|
6501
|
-
* Whether the record version is the published version or not
|
|
6502
|
-
*/
|
|
6503
|
-
is_published: boolean;
|
|
6504
|
-
/**
|
|
6505
|
-
* Whether the record version is the most recent version or not
|
|
6506
|
-
*/
|
|
6507
|
-
is_current: boolean;
|
|
6815
|
+
export declare type ItemBulkDestroyTargetSchema = {
|
|
6816
|
+
data: Job;
|
|
6508
6817
|
};
|
|
6509
6818
|
/**
|
|
6510
|
-
*
|
|
6511
|
-
*
|
|
6512
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6513
|
-
* via the `definition` "data".
|
|
6819
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6820
|
+
* via the `bulk_destroy.jobSchema` link.
|
|
6514
6821
|
*/
|
|
6515
|
-
export declare type
|
|
6516
|
-
|
|
6517
|
-
|
|
6822
|
+
export declare type ItemBulkDestroyJobSchema = {
|
|
6823
|
+
data: unknown[];
|
|
6824
|
+
meta: {
|
|
6825
|
+
successful: number;
|
|
6826
|
+
failed: number;
|
|
6827
|
+
};
|
|
6518
6828
|
};
|
|
6519
6829
|
/**
|
|
6520
|
-
* This interface was referenced by `
|
|
6521
|
-
* via the `
|
|
6830
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6831
|
+
* via the `bulk_move_to_stage.schema` link.
|
|
6522
6832
|
*/
|
|
6523
|
-
export declare type
|
|
6524
|
-
data:
|
|
6833
|
+
export declare type ItemBulkMoveToStageSchema = {
|
|
6834
|
+
data: {
|
|
6835
|
+
/**
|
|
6836
|
+
* JSON API type field
|
|
6837
|
+
*/
|
|
6838
|
+
type: 'item_bulk_move_to_stage_operation';
|
|
6839
|
+
attributes: {
|
|
6840
|
+
/**
|
|
6841
|
+
* Stage to be moved to
|
|
6842
|
+
*/
|
|
6843
|
+
stage: string;
|
|
6844
|
+
};
|
|
6845
|
+
relationships: {
|
|
6846
|
+
/**
|
|
6847
|
+
* Records to move (a maximum of 200 records are allowed per request)
|
|
6848
|
+
*/
|
|
6849
|
+
items: {
|
|
6850
|
+
data: ItemData[];
|
|
6851
|
+
};
|
|
6852
|
+
minItems?: unknown;
|
|
6853
|
+
};
|
|
6854
|
+
};
|
|
6525
6855
|
};
|
|
6526
6856
|
/**
|
|
6527
|
-
* This interface was referenced by `
|
|
6528
|
-
* via the `
|
|
6857
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6858
|
+
* via the `bulk_move_to_stage.targetSchema` link.
|
|
6529
6859
|
*/
|
|
6530
|
-
export declare type
|
|
6531
|
-
data:
|
|
6860
|
+
export declare type ItemBulkMoveToStageTargetSchema = {
|
|
6861
|
+
data: Job;
|
|
6532
6862
|
};
|
|
6533
6863
|
/**
|
|
6534
|
-
* This interface was referenced by `
|
|
6535
|
-
* via the `
|
|
6864
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
6865
|
+
* via the `bulk_move_to_stage.jobSchema` link.
|
|
6536
6866
|
*/
|
|
6537
|
-
export declare type
|
|
6538
|
-
data:
|
|
6867
|
+
export declare type ItemBulkMoveToStageJobSchema = {
|
|
6868
|
+
data: unknown[];
|
|
6539
6869
|
meta: {
|
|
6540
|
-
|
|
6870
|
+
successful: number;
|
|
6871
|
+
failed: number;
|
|
6541
6872
|
};
|
|
6542
6873
|
};
|
|
6543
|
-
/**
|
|
6544
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6545
|
-
* via the `self.targetSchema` link.
|
|
6546
|
-
*/
|
|
6547
|
-
export declare type ItemVersionSelfTargetSchema = {
|
|
6548
|
-
data: ItemVersion;
|
|
6549
|
-
};
|
|
6550
6874
|
/**
|
|
6551
6875
|
* Every file you upload to DatoCMS will be retrievable from this endpoint.
|
|
6552
6876
|
*
|
|
@@ -7150,152 +7474,6 @@ export declare type UploadRequestCreateSchema = {
|
|
|
7150
7474
|
export declare type UploadRequestCreateTargetSchema = {
|
|
7151
7475
|
data: UploadRequest;
|
|
7152
7476
|
};
|
|
7153
|
-
/**
|
|
7154
|
-
* You can create scheduled publication to publish records in the future
|
|
7155
|
-
*
|
|
7156
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7157
|
-
* via the `definition` "scheduled_publication".
|
|
7158
|
-
*/
|
|
7159
|
-
export declare type ScheduledPublication = {
|
|
7160
|
-
type: ScheduledPublicationType;
|
|
7161
|
-
id: ScheduledPublicationIdentity;
|
|
7162
|
-
attributes: ScheduledPublicationAttributes;
|
|
7163
|
-
relationships: ScheduledPublicationRelationships;
|
|
7164
|
-
};
|
|
7165
|
-
/**
|
|
7166
|
-
* JSON API attributes
|
|
7167
|
-
*
|
|
7168
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7169
|
-
* via the `definition` "attributes".
|
|
7170
|
-
*/
|
|
7171
|
-
export declare type ScheduledPublicationAttributes = {
|
|
7172
|
-
/**
|
|
7173
|
-
* The future date for the publication
|
|
7174
|
-
*/
|
|
7175
|
-
publication_scheduled_at: string;
|
|
7176
|
-
};
|
|
7177
|
-
/**
|
|
7178
|
-
* JSON API links
|
|
7179
|
-
*
|
|
7180
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7181
|
-
* via the `definition` "relationships".
|
|
7182
|
-
*/
|
|
7183
|
-
export declare type ScheduledPublicationRelationships = {
|
|
7184
|
-
/**
|
|
7185
|
-
* Item
|
|
7186
|
-
*/
|
|
7187
|
-
item: {
|
|
7188
|
-
data: ItemData;
|
|
7189
|
-
};
|
|
7190
|
-
};
|
|
7191
|
-
/**
|
|
7192
|
-
* JSON API data
|
|
7193
|
-
*
|
|
7194
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7195
|
-
* via the `definition` "data".
|
|
7196
|
-
*/
|
|
7197
|
-
export declare type ScheduledPublicationData = {
|
|
7198
|
-
type: ScheduledPublicationType;
|
|
7199
|
-
id: ScheduledPublicationIdentity;
|
|
7200
|
-
};
|
|
7201
|
-
/**
|
|
7202
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7203
|
-
* via the `create.schema` link.
|
|
7204
|
-
*/
|
|
7205
|
-
export declare type ScheduledPublicationCreateSchema = {
|
|
7206
|
-
data: {
|
|
7207
|
-
type: ScheduledPublicationType;
|
|
7208
|
-
attributes: ScheduledPublicationAttributes;
|
|
7209
|
-
};
|
|
7210
|
-
};
|
|
7211
|
-
/**
|
|
7212
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7213
|
-
* via the `create.targetSchema` link.
|
|
7214
|
-
*/
|
|
7215
|
-
export declare type ScheduledPublicationCreateTargetSchema = {
|
|
7216
|
-
data: ScheduledPublication;
|
|
7217
|
-
included: Item[];
|
|
7218
|
-
};
|
|
7219
|
-
/**
|
|
7220
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7221
|
-
* via the `destroy.targetSchema` link.
|
|
7222
|
-
*/
|
|
7223
|
-
export declare type ScheduledPublicationDestroyTargetSchema = {
|
|
7224
|
-
data: Item;
|
|
7225
|
-
};
|
|
7226
|
-
/**
|
|
7227
|
-
* You can create a scheduled unpublishing to unpublish records in the future
|
|
7228
|
-
*
|
|
7229
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7230
|
-
* via the `definition` "scheduled_unpublishing".
|
|
7231
|
-
*/
|
|
7232
|
-
export declare type ScheduledUnpublishing = {
|
|
7233
|
-
type: ScheduledUnpublishingType;
|
|
7234
|
-
id: ScheduledUnpublishingIdentity;
|
|
7235
|
-
attributes: ScheduledUnpublishingAttributes;
|
|
7236
|
-
relationships: ScheduledUnpublishingRelationships;
|
|
7237
|
-
};
|
|
7238
|
-
/**
|
|
7239
|
-
* JSON API attributes
|
|
7240
|
-
*
|
|
7241
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7242
|
-
* via the `definition` "attributes".
|
|
7243
|
-
*/
|
|
7244
|
-
export declare type ScheduledUnpublishingAttributes = {
|
|
7245
|
-
/**
|
|
7246
|
-
* The future date for the unpublishing
|
|
7247
|
-
*/
|
|
7248
|
-
unpublishing_scheduled_at: string;
|
|
7249
|
-
};
|
|
7250
|
-
/**
|
|
7251
|
-
* JSON API links
|
|
7252
|
-
*
|
|
7253
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7254
|
-
* via the `definition` "relationships".
|
|
7255
|
-
*/
|
|
7256
|
-
export declare type ScheduledUnpublishingRelationships = {
|
|
7257
|
-
/**
|
|
7258
|
-
* Item
|
|
7259
|
-
*/
|
|
7260
|
-
item: {
|
|
7261
|
-
data: ItemData;
|
|
7262
|
-
};
|
|
7263
|
-
};
|
|
7264
|
-
/**
|
|
7265
|
-
* JSON API data
|
|
7266
|
-
*
|
|
7267
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7268
|
-
* via the `definition` "data".
|
|
7269
|
-
*/
|
|
7270
|
-
export declare type ScheduledUnpublishingData = {
|
|
7271
|
-
type: ScheduledUnpublishingType;
|
|
7272
|
-
id: ScheduledUnpublishingIdentity;
|
|
7273
|
-
};
|
|
7274
|
-
/**
|
|
7275
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7276
|
-
* via the `create.schema` link.
|
|
7277
|
-
*/
|
|
7278
|
-
export declare type ScheduledUnpublishingCreateSchema = {
|
|
7279
|
-
data: {
|
|
7280
|
-
type: ScheduledUnpublishingType;
|
|
7281
|
-
attributes: ScheduledUnpublishingAttributes;
|
|
7282
|
-
};
|
|
7283
|
-
};
|
|
7284
|
-
/**
|
|
7285
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7286
|
-
* via the `create.targetSchema` link.
|
|
7287
|
-
*/
|
|
7288
|
-
export declare type ScheduledUnpublishingCreateTargetSchema = {
|
|
7289
|
-
data: ScheduledUnpublishing;
|
|
7290
|
-
included: Item[];
|
|
7291
|
-
};
|
|
7292
|
-
/**
|
|
7293
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7294
|
-
* via the `destroy.targetSchema` link.
|
|
7295
|
-
*/
|
|
7296
|
-
export declare type ScheduledUnpublishingDestroyTargetSchema = {
|
|
7297
|
-
data: Item;
|
|
7298
|
-
};
|
|
7299
7477
|
/**
|
|
7300
7478
|
* DatoCMS Site Search is a way to deliver tailored search results to your site visitors. This is the endpoint you can use to query for results.
|
|
7301
7479
|
*
|