@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.
- 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
|
@@ -618,57 +618,56 @@ export type ItemSelfHrefSchema = {
|
|
|
618
618
|
[k: string]: unknown;
|
|
619
619
|
};
|
|
620
620
|
/**
|
|
621
|
-
*
|
|
622
|
-
*
|
|
621
|
+
* JSON API type field
|
|
622
|
+
*
|
|
623
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
624
|
+
* via the `definition` "type".
|
|
623
625
|
*/
|
|
624
|
-
export type
|
|
625
|
-
/**
|
|
626
|
-
* IDs of records to delete, comma separated (a maximum of 200 IDs are allowed per request)
|
|
627
|
-
*/
|
|
628
|
-
'filter[ids]': string;
|
|
629
|
-
};
|
|
626
|
+
export type ItemCurrentVsPublishedStateType = 'item_current_vs_published_state';
|
|
630
627
|
/**
|
|
631
|
-
*
|
|
632
|
-
*
|
|
628
|
+
* ID of record
|
|
629
|
+
*
|
|
630
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
631
|
+
* via the `definition` "identity".
|
|
632
|
+
*
|
|
633
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
634
|
+
* via the `definition` "id".
|
|
633
635
|
*/
|
|
634
|
-
export type
|
|
635
|
-
/**
|
|
636
|
-
* IDs of records to publish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
637
|
-
*/
|
|
638
|
-
'filter[ids]': string;
|
|
639
|
-
};
|
|
636
|
+
export type ItemCurrentVsPublishedStateIdentity = string;
|
|
640
637
|
/**
|
|
641
|
-
*
|
|
642
|
-
*
|
|
638
|
+
* JSON API type field
|
|
639
|
+
*
|
|
640
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
641
|
+
* via the `definition` "type".
|
|
643
642
|
*/
|
|
644
|
-
export type
|
|
645
|
-
/**
|
|
646
|
-
* IDs of records to unpublish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
647
|
-
*/
|
|
648
|
-
'filter[ids]': string;
|
|
649
|
-
};
|
|
643
|
+
export type ScheduledPublicationType = 'scheduled_publication';
|
|
650
644
|
/**
|
|
651
|
-
*
|
|
652
|
-
*
|
|
645
|
+
* ID of scheduled_publication
|
|
646
|
+
*
|
|
647
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
648
|
+
* via the `definition` "identity".
|
|
649
|
+
*
|
|
650
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
651
|
+
* via the `definition` "id".
|
|
653
652
|
*/
|
|
654
|
-
export type
|
|
655
|
-
/**
|
|
656
|
-
* If the record references other draft records, force a recursive publication
|
|
657
|
-
*/
|
|
658
|
-
recursive?: boolean;
|
|
659
|
-
[k: string]: unknown;
|
|
660
|
-
};
|
|
653
|
+
export type ScheduledPublicationIdentity = string;
|
|
661
654
|
/**
|
|
662
|
-
*
|
|
663
|
-
*
|
|
655
|
+
* JSON API type field
|
|
656
|
+
*
|
|
657
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
658
|
+
* via the `definition` "type".
|
|
664
659
|
*/
|
|
665
|
-
export type
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
660
|
+
export type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
661
|
+
/**
|
|
662
|
+
* ID of scheduled_unpublishing
|
|
663
|
+
*
|
|
664
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
665
|
+
* via the `definition` "identity".
|
|
666
|
+
*
|
|
667
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
668
|
+
* via the `definition` "id".
|
|
669
|
+
*/
|
|
670
|
+
export type ScheduledUnpublishingIdentity = string;
|
|
672
671
|
/**
|
|
673
672
|
* JSON API type field
|
|
674
673
|
*
|
|
@@ -711,6 +710,98 @@ export type ItemVersionInstancesHrefSchema = {
|
|
|
711
710
|
};
|
|
712
711
|
[k: string]: unknown;
|
|
713
712
|
};
|
|
713
|
+
/**
|
|
714
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
715
|
+
* via the `batch_destroy.hrefSchema` link.
|
|
716
|
+
*/
|
|
717
|
+
export type ItemBatchDestroyHrefSchema = {
|
|
718
|
+
/**
|
|
719
|
+
* IDs of records to delete, comma separated (a maximum of 200 IDs are allowed per request)
|
|
720
|
+
*/
|
|
721
|
+
'filter[ids]': string;
|
|
722
|
+
};
|
|
723
|
+
/**
|
|
724
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
725
|
+
* via the `batch_publish.hrefSchema` link.
|
|
726
|
+
*/
|
|
727
|
+
export type ItemBatchPublishHrefSchema = {
|
|
728
|
+
/**
|
|
729
|
+
* IDs of records to publish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
730
|
+
*/
|
|
731
|
+
'filter[ids]': string;
|
|
732
|
+
};
|
|
733
|
+
/**
|
|
734
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
735
|
+
* via the `batch_unpublish.hrefSchema` link.
|
|
736
|
+
*/
|
|
737
|
+
export type ItemBatchUnpublishHrefSchema = {
|
|
738
|
+
/**
|
|
739
|
+
* IDs of records to unpublish, comma separated (a maximum of 200 IDs are allowed per request)
|
|
740
|
+
*/
|
|
741
|
+
'filter[ids]': string;
|
|
742
|
+
};
|
|
743
|
+
/**
|
|
744
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
745
|
+
* via the `publish.schema` link.
|
|
746
|
+
*/
|
|
747
|
+
export type ItemPublishSchema = {
|
|
748
|
+
data: {
|
|
749
|
+
/**
|
|
750
|
+
* JSON API type field
|
|
751
|
+
*/
|
|
752
|
+
type: 'selective_publish_operation';
|
|
753
|
+
attributes: {
|
|
754
|
+
/**
|
|
755
|
+
* List of locales whose content will be published
|
|
756
|
+
*/
|
|
757
|
+
content_in_locales: string[];
|
|
758
|
+
/**
|
|
759
|
+
* Whether non-localized content has to be published or not
|
|
760
|
+
*/
|
|
761
|
+
non_localized_content: boolean;
|
|
762
|
+
};
|
|
763
|
+
};
|
|
764
|
+
} | null;
|
|
765
|
+
/**
|
|
766
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
767
|
+
* via the `publish.hrefSchema` link.
|
|
768
|
+
*/
|
|
769
|
+
export type ItemPublishHrefSchema = {
|
|
770
|
+
/**
|
|
771
|
+
* If the record references other draft records, force a recursive publication
|
|
772
|
+
*/
|
|
773
|
+
recursive?: boolean;
|
|
774
|
+
[k: string]: unknown;
|
|
775
|
+
};
|
|
776
|
+
/**
|
|
777
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
778
|
+
* via the `unpublish.schema` link.
|
|
779
|
+
*/
|
|
780
|
+
export type ItemUnpublishSchema = {
|
|
781
|
+
data: {
|
|
782
|
+
/**
|
|
783
|
+
* JSON API type field
|
|
784
|
+
*/
|
|
785
|
+
type: 'selective_unpublish_operation';
|
|
786
|
+
attributes: {
|
|
787
|
+
/**
|
|
788
|
+
* List of locales whose content will be unpublished
|
|
789
|
+
*/
|
|
790
|
+
content_in_locales: string[];
|
|
791
|
+
};
|
|
792
|
+
};
|
|
793
|
+
} | null;
|
|
794
|
+
/**
|
|
795
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
796
|
+
* via the `unpublish.hrefSchema` link.
|
|
797
|
+
*/
|
|
798
|
+
export type ItemUnpublishHrefSchema = {
|
|
799
|
+
/**
|
|
800
|
+
* If the record is referenced by other published records, unpublish them recursively
|
|
801
|
+
*/
|
|
802
|
+
recursive?: boolean;
|
|
803
|
+
[k: string]: unknown;
|
|
804
|
+
};
|
|
714
805
|
/**
|
|
715
806
|
* JSON API type upload
|
|
716
807
|
*
|
|
@@ -831,40 +922,6 @@ export type UploadRequestType = 'upload_request';
|
|
|
831
922
|
* via the `definition` "id".
|
|
832
923
|
*/
|
|
833
924
|
export type UploadRequestIdentity = string;
|
|
834
|
-
/**
|
|
835
|
-
* JSON API type field
|
|
836
|
-
*
|
|
837
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
838
|
-
* via the `definition` "type".
|
|
839
|
-
*/
|
|
840
|
-
export type ScheduledPublicationType = 'scheduled_publication';
|
|
841
|
-
/**
|
|
842
|
-
* ID of scheduled_publication
|
|
843
|
-
*
|
|
844
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
845
|
-
* via the `definition` "identity".
|
|
846
|
-
*
|
|
847
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
848
|
-
* via the `definition` "id".
|
|
849
|
-
*/
|
|
850
|
-
export type ScheduledPublicationIdentity = string;
|
|
851
|
-
/**
|
|
852
|
-
* JSON API type field
|
|
853
|
-
*
|
|
854
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
855
|
-
* via the `definition` "type".
|
|
856
|
-
*/
|
|
857
|
-
export type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
858
|
-
/**
|
|
859
|
-
* ID of scheduled_unpublishing
|
|
860
|
-
*
|
|
861
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
862
|
-
* via the `definition` "identity".
|
|
863
|
-
*
|
|
864
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
865
|
-
* via the `definition` "id".
|
|
866
|
-
*/
|
|
867
|
-
export type ScheduledUnpublishingIdentity = string;
|
|
868
925
|
/**
|
|
869
926
|
* JSON API type field
|
|
870
927
|
*
|
|
@@ -1362,6 +1419,7 @@ export type DatoApi = {
|
|
|
1362
1419
|
subscription_feature?: SubscriptionFeature;
|
|
1363
1420
|
build_event?: BuildEvent;
|
|
1364
1421
|
item?: Item;
|
|
1422
|
+
item_current_vs_published_state?: ItemCurrentVsPublishedState;
|
|
1365
1423
|
item_version?: ItemVersion;
|
|
1366
1424
|
upload?: Upload;
|
|
1367
1425
|
upload_request?: UploadRequest;
|
|
@@ -6682,133 +6740,445 @@ export type ItemSelfTargetSchema = {
|
|
|
6682
6740
|
|
|
6683
6741
|
/**
|
|
6684
6742
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6685
|
-
* via the `
|
|
6743
|
+
* via the `current_vs_published_state.targetSchema` link.
|
|
6686
6744
|
*/
|
|
6687
|
-
export type
|
|
6688
|
-
data:
|
|
6745
|
+
export type ItemCurrentVsPublishedStateTargetSchema = {
|
|
6746
|
+
data: ItemCurrentVsPublishedState;
|
|
6747
|
+
included: (ScheduledPublication | ScheduledUnpublishing | ItemVersion)[];
|
|
6689
6748
|
};
|
|
6690
6749
|
|
|
6691
6750
|
/**
|
|
6692
|
-
*
|
|
6693
|
-
*
|
|
6751
|
+
* Information about the record
|
|
6752
|
+
*
|
|
6753
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6754
|
+
* via the `definition` "item_current_vs_published_state".
|
|
6694
6755
|
*/
|
|
6695
|
-
export type
|
|
6696
|
-
|
|
6756
|
+
export type ItemCurrentVsPublishedState = {
|
|
6757
|
+
type: ItemCurrentVsPublishedStateType;
|
|
6758
|
+
id: ItemCurrentVsPublishedStateIdentity;
|
|
6759
|
+
attributes: ItemCurrentVsPublishedStateAttributes;
|
|
6760
|
+
relationships: ItemCurrentVsPublishedStateRelationships;
|
|
6697
6761
|
};
|
|
6698
6762
|
|
|
6699
6763
|
/**
|
|
6700
|
-
*
|
|
6701
|
-
*
|
|
6764
|
+
* The JSON data associated to the record
|
|
6765
|
+
*
|
|
6766
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
6767
|
+
* via the `definition` "attributes".
|
|
6702
6768
|
*/
|
|
6703
|
-
export type
|
|
6704
|
-
|
|
6769
|
+
export type ItemCurrentVsPublishedStateAttributes = {
|
|
6770
|
+
current_version_locales: string[];
|
|
6771
|
+
published_version_locales: string[];
|
|
6772
|
+
changed_locales: string[];
|
|
6773
|
+
added_locales: string[];
|
|
6774
|
+
removed_locales: string[];
|
|
6775
|
+
non_localized_fields_changed: boolean;
|
|
6705
6776
|
};
|
|
6706
6777
|
|
|
6707
6778
|
/**
|
|
6708
|
-
*
|
|
6709
|
-
*
|
|
6779
|
+
* JSON API links
|
|
6780
|
+
*
|
|
6781
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
6782
|
+
* via the `definition` "relationships".
|
|
6710
6783
|
*/
|
|
6711
|
-
export type
|
|
6712
|
-
|
|
6713
|
-
|
|
6714
|
-
|
|
6715
|
-
|
|
6784
|
+
export type ItemCurrentVsPublishedStateRelationships = {
|
|
6785
|
+
/**
|
|
6786
|
+
* The scheduled publication entity, if available
|
|
6787
|
+
*/
|
|
6788
|
+
scheduled_publication: {
|
|
6789
|
+
data: ScheduledPublicationData | null;
|
|
6790
|
+
};
|
|
6791
|
+
/**
|
|
6792
|
+
* The scheduled unpublishing entity, if available
|
|
6793
|
+
*/
|
|
6794
|
+
scheduled_unpublishing: {
|
|
6795
|
+
data: ScheduledUnpublishingData | null;
|
|
6796
|
+
};
|
|
6797
|
+
/**
|
|
6798
|
+
* The currently published version for the record, if available
|
|
6799
|
+
*/
|
|
6800
|
+
published_version: {
|
|
6801
|
+
data: ItemVersionData | null;
|
|
6716
6802
|
};
|
|
6717
6803
|
};
|
|
6718
6804
|
|
|
6719
6805
|
/**
|
|
6720
|
-
*
|
|
6721
|
-
*
|
|
6806
|
+
* JSON API data
|
|
6807
|
+
*
|
|
6808
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6809
|
+
* via the `definition` "data".
|
|
6722
6810
|
*/
|
|
6723
|
-
export type
|
|
6724
|
-
|
|
6811
|
+
export type ScheduledPublicationData = {
|
|
6812
|
+
type: ScheduledPublicationType;
|
|
6813
|
+
id: ScheduledPublicationIdentity;
|
|
6725
6814
|
};
|
|
6726
6815
|
|
|
6727
6816
|
/**
|
|
6728
|
-
*
|
|
6729
|
-
*
|
|
6817
|
+
* JSON API data
|
|
6818
|
+
*
|
|
6819
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6820
|
+
* via the `definition` "data".
|
|
6730
6821
|
*/
|
|
6731
|
-
export type
|
|
6732
|
-
|
|
6733
|
-
|
|
6734
|
-
successful: number;
|
|
6735
|
-
failed: number;
|
|
6736
|
-
};
|
|
6822
|
+
export type ScheduledUnpublishingData = {
|
|
6823
|
+
type: ScheduledUnpublishingType;
|
|
6824
|
+
id: ScheduledUnpublishingIdentity;
|
|
6737
6825
|
};
|
|
6738
6826
|
|
|
6739
6827
|
/**
|
|
6740
|
-
*
|
|
6741
|
-
*
|
|
6828
|
+
* JSON API data
|
|
6829
|
+
*
|
|
6830
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6831
|
+
* via the `definition` "data".
|
|
6742
6832
|
*/
|
|
6743
|
-
export type
|
|
6744
|
-
|
|
6833
|
+
export type ItemVersionData = {
|
|
6834
|
+
type: ItemVersionType;
|
|
6835
|
+
id: ItemVersionIdentity;
|
|
6745
6836
|
};
|
|
6746
6837
|
|
|
6747
6838
|
/**
|
|
6748
|
-
*
|
|
6749
|
-
*
|
|
6839
|
+
* JSON API data
|
|
6840
|
+
*
|
|
6841
|
+
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
6842
|
+
* via the `definition` "data".
|
|
6750
6843
|
*/
|
|
6751
|
-
export type
|
|
6752
|
-
|
|
6753
|
-
|
|
6754
|
-
|
|
6755
|
-
|
|
6844
|
+
export type ItemCurrentVsPublishedStateData = {
|
|
6845
|
+
type: ItemCurrentVsPublishedStateType;
|
|
6846
|
+
id: ItemCurrentVsPublishedStateIdentity;
|
|
6847
|
+
};
|
|
6848
|
+
|
|
6849
|
+
/**
|
|
6850
|
+
* You can create scheduled publication to publish records in the future
|
|
6851
|
+
*
|
|
6852
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6853
|
+
* via the `definition` "scheduled_publication".
|
|
6854
|
+
*/
|
|
6855
|
+
export type ScheduledPublication = {
|
|
6856
|
+
type: ScheduledPublicationType;
|
|
6857
|
+
id: ScheduledPublicationIdentity;
|
|
6858
|
+
attributes: ScheduledPublicationAttributes;
|
|
6859
|
+
relationships: ScheduledPublicationRelationships;
|
|
6860
|
+
};
|
|
6861
|
+
|
|
6862
|
+
/**
|
|
6863
|
+
* JSON API attributes
|
|
6864
|
+
*
|
|
6865
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6866
|
+
* via the `definition` "attributes".
|
|
6867
|
+
*/
|
|
6868
|
+
export type ScheduledPublicationAttributes = {
|
|
6869
|
+
/**
|
|
6870
|
+
* The future date for the publication
|
|
6871
|
+
*/
|
|
6872
|
+
publication_scheduled_at: string;
|
|
6873
|
+
/**
|
|
6874
|
+
* Specifies which content should be published. If null, the whole record will be published.
|
|
6875
|
+
*/
|
|
6876
|
+
selective_publication: null | {
|
|
6877
|
+
/**
|
|
6878
|
+
* List of locales whose content will be published
|
|
6879
|
+
*/
|
|
6880
|
+
content_in_locales: string[];
|
|
6881
|
+
/**
|
|
6882
|
+
* Whether the non-localized content has to be published or not
|
|
6883
|
+
*/
|
|
6884
|
+
non_localized_content: boolean;
|
|
6756
6885
|
};
|
|
6757
6886
|
};
|
|
6758
6887
|
|
|
6759
6888
|
/**
|
|
6760
|
-
*
|
|
6761
|
-
*
|
|
6889
|
+
* JSON API links
|
|
6890
|
+
*
|
|
6891
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6892
|
+
* via the `definition` "relationships".
|
|
6762
6893
|
*/
|
|
6763
|
-
export type
|
|
6764
|
-
|
|
6765
|
-
|
|
6894
|
+
export type ScheduledPublicationRelationships = {
|
|
6895
|
+
/**
|
|
6896
|
+
* Item
|
|
6897
|
+
*/
|
|
6898
|
+
item: {
|
|
6899
|
+
data: ItemData;
|
|
6900
|
+
};
|
|
6766
6901
|
};
|
|
6767
6902
|
|
|
6768
6903
|
/**
|
|
6769
|
-
* This interface was referenced by `
|
|
6770
|
-
* via the `
|
|
6904
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6905
|
+
* via the `create.schema` link.
|
|
6771
6906
|
*/
|
|
6772
|
-
export type
|
|
6907
|
+
export type ScheduledPublicationCreateSchema = {
|
|
6908
|
+
data: {
|
|
6909
|
+
type: ScheduledPublicationType;
|
|
6910
|
+
/**
|
|
6911
|
+
* JSON API attributes
|
|
6912
|
+
*/
|
|
6913
|
+
attributes: {
|
|
6914
|
+
/**
|
|
6915
|
+
* The future date for the publication
|
|
6916
|
+
*/
|
|
6917
|
+
publication_scheduled_at: string;
|
|
6918
|
+
/**
|
|
6919
|
+
* Specifies which content should be published. If null, the whole record will be published.
|
|
6920
|
+
*/
|
|
6921
|
+
selective_publication?: null | {
|
|
6922
|
+
/**
|
|
6923
|
+
* List of locales whose content will be published
|
|
6924
|
+
*/
|
|
6925
|
+
content_in_locales: string[];
|
|
6926
|
+
/**
|
|
6927
|
+
* Whether the non-localized content has to be published or not
|
|
6928
|
+
*/
|
|
6929
|
+
non_localized_content: boolean;
|
|
6930
|
+
};
|
|
6931
|
+
};
|
|
6932
|
+
};
|
|
6933
|
+
};
|
|
6934
|
+
|
|
6935
|
+
/**
|
|
6936
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6937
|
+
* via the `create.targetSchema` link.
|
|
6938
|
+
*/
|
|
6939
|
+
export type ScheduledPublicationCreateTargetSchema = {
|
|
6940
|
+
data: ScheduledPublication;
|
|
6941
|
+
included: Item[];
|
|
6942
|
+
};
|
|
6943
|
+
|
|
6944
|
+
/**
|
|
6945
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6946
|
+
* via the `destroy.targetSchema` link.
|
|
6947
|
+
*/
|
|
6948
|
+
export type ScheduledPublicationDestroyTargetSchema = {
|
|
6773
6949
|
data: Item;
|
|
6774
|
-
included?: ItemType[];
|
|
6775
6950
|
};
|
|
6776
6951
|
|
|
6777
6952
|
/**
|
|
6778
|
-
*
|
|
6779
|
-
*
|
|
6953
|
+
* You can create a scheduled unpublishing to unpublish records in the future
|
|
6954
|
+
*
|
|
6955
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6956
|
+
* via the `definition` "scheduled_unpublishing".
|
|
6780
6957
|
*/
|
|
6781
|
-
export type
|
|
6958
|
+
export type ScheduledUnpublishing = {
|
|
6959
|
+
type: ScheduledUnpublishingType;
|
|
6960
|
+
id: ScheduledUnpublishingIdentity;
|
|
6961
|
+
attributes: ScheduledUnpublishingAttributes;
|
|
6962
|
+
relationships: ScheduledUnpublishingRelationships;
|
|
6963
|
+
};
|
|
6964
|
+
|
|
6965
|
+
/**
|
|
6966
|
+
* JSON API attributes
|
|
6967
|
+
*
|
|
6968
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6969
|
+
* via the `definition` "attributes".
|
|
6970
|
+
*/
|
|
6971
|
+
export type ScheduledUnpublishingAttributes = {
|
|
6972
|
+
/**
|
|
6973
|
+
* The future date for the unpublishing
|
|
6974
|
+
*/
|
|
6975
|
+
unpublishing_scheduled_at: string;
|
|
6976
|
+
/**
|
|
6977
|
+
* List of locales whose content will be unpublished, or nil if the whole record needs to be unpublished
|
|
6978
|
+
*/
|
|
6979
|
+
content_in_locales: null | string[];
|
|
6980
|
+
};
|
|
6981
|
+
|
|
6982
|
+
/**
|
|
6983
|
+
* JSON API links
|
|
6984
|
+
*
|
|
6985
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6986
|
+
* via the `definition` "relationships".
|
|
6987
|
+
*/
|
|
6988
|
+
export type ScheduledUnpublishingRelationships = {
|
|
6989
|
+
/**
|
|
6990
|
+
* Item
|
|
6991
|
+
*/
|
|
6992
|
+
item: {
|
|
6993
|
+
data: ItemData;
|
|
6994
|
+
};
|
|
6995
|
+
};
|
|
6996
|
+
|
|
6997
|
+
/**
|
|
6998
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6999
|
+
* via the `create.schema` link.
|
|
7000
|
+
*/
|
|
7001
|
+
export type ScheduledUnpublishingCreateSchema = {
|
|
6782
7002
|
data: {
|
|
7003
|
+
type: ScheduledUnpublishingType;
|
|
6783
7004
|
/**
|
|
6784
|
-
* JSON API
|
|
7005
|
+
* JSON API attributes
|
|
6785
7006
|
*/
|
|
6786
|
-
|
|
6787
|
-
relationships: {
|
|
7007
|
+
attributes: {
|
|
6788
7008
|
/**
|
|
6789
|
-
*
|
|
7009
|
+
* The future date for the unpublishing
|
|
6790
7010
|
*/
|
|
6791
|
-
|
|
6792
|
-
|
|
6793
|
-
|
|
6794
|
-
|
|
7011
|
+
unpublishing_scheduled_at: string;
|
|
7012
|
+
/**
|
|
7013
|
+
* List of locales whose content will be unpublished, or nil if the whole record needs to be unpublished
|
|
7014
|
+
*/
|
|
7015
|
+
content_in_locales?: null | string[];
|
|
6795
7016
|
};
|
|
6796
7017
|
};
|
|
6797
7018
|
};
|
|
6798
7019
|
|
|
7020
|
+
/**
|
|
7021
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7022
|
+
* via the `create.targetSchema` link.
|
|
7023
|
+
*/
|
|
7024
|
+
export type ScheduledUnpublishingCreateTargetSchema = {
|
|
7025
|
+
data: ScheduledUnpublishing;
|
|
7026
|
+
included: Item[];
|
|
7027
|
+
};
|
|
7028
|
+
|
|
7029
|
+
/**
|
|
7030
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7031
|
+
* via the `destroy.targetSchema` link.
|
|
7032
|
+
*/
|
|
7033
|
+
export type ScheduledUnpublishingDestroyTargetSchema = {
|
|
7034
|
+
data: Item;
|
|
7035
|
+
};
|
|
7036
|
+
|
|
7037
|
+
/**
|
|
7038
|
+
* Every change to a record is stored as a separate record version in DatoCMS.
|
|
7039
|
+
*
|
|
7040
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7041
|
+
* via the `definition` "item_version".
|
|
7042
|
+
*/
|
|
7043
|
+
export type ItemVersion = {
|
|
7044
|
+
type: ItemVersionType;
|
|
7045
|
+
id: ItemVersionIdentity;
|
|
7046
|
+
attributes: ItemVersionAttributes;
|
|
7047
|
+
relationships: ItemVersionRelationships;
|
|
7048
|
+
meta: ItemVersionMeta;
|
|
7049
|
+
};
|
|
7050
|
+
|
|
7051
|
+
/**
|
|
7052
|
+
* The JSON data associated to the record version
|
|
7053
|
+
*
|
|
7054
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7055
|
+
* via the `definition` "attributes".
|
|
7056
|
+
*/
|
|
7057
|
+
export type ItemVersionAttributes = {
|
|
7058
|
+
[k: string]: unknown;
|
|
7059
|
+
};
|
|
7060
|
+
|
|
7061
|
+
/**
|
|
7062
|
+
* JSON API links
|
|
7063
|
+
*
|
|
7064
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7065
|
+
* via the `definition` "relationships".
|
|
7066
|
+
*/
|
|
7067
|
+
export type ItemVersionRelationships = {
|
|
7068
|
+
/**
|
|
7069
|
+
* The record version's model
|
|
7070
|
+
*/
|
|
7071
|
+
item_type: {
|
|
7072
|
+
data: ItemTypeData;
|
|
7073
|
+
};
|
|
7074
|
+
/**
|
|
7075
|
+
* The record this version belongs to
|
|
7076
|
+
*/
|
|
7077
|
+
item: {
|
|
7078
|
+
data: ItemData;
|
|
7079
|
+
};
|
|
7080
|
+
/**
|
|
7081
|
+
* 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.
|
|
7082
|
+
*/
|
|
7083
|
+
editor: {
|
|
7084
|
+
data:
|
|
7085
|
+
| AccountData
|
|
7086
|
+
| AccessTokenData
|
|
7087
|
+
| UserData
|
|
7088
|
+
| SsoUserData
|
|
7089
|
+
| OrganizationData;
|
|
7090
|
+
};
|
|
7091
|
+
};
|
|
7092
|
+
|
|
7093
|
+
/**
|
|
7094
|
+
* Meta information regarding the record version
|
|
7095
|
+
*
|
|
7096
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7097
|
+
* via the `definition` "meta".
|
|
7098
|
+
*/
|
|
7099
|
+
export type ItemVersionMeta = {
|
|
7100
|
+
/**
|
|
7101
|
+
* Date of record version creation
|
|
7102
|
+
*/
|
|
7103
|
+
created_at: string;
|
|
7104
|
+
/**
|
|
7105
|
+
* Whether the record version is valid or not
|
|
7106
|
+
*/
|
|
7107
|
+
is_valid: boolean;
|
|
7108
|
+
/**
|
|
7109
|
+
* Whether the record version is the published version or not
|
|
7110
|
+
*/
|
|
7111
|
+
is_published: boolean;
|
|
7112
|
+
/**
|
|
7113
|
+
* Whether the record version is the most recent version or not
|
|
7114
|
+
*/
|
|
7115
|
+
is_current: boolean;
|
|
7116
|
+
};
|
|
7117
|
+
|
|
7118
|
+
/**
|
|
7119
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7120
|
+
* via the `restore.targetSchema` link.
|
|
7121
|
+
*/
|
|
7122
|
+
export type ItemVersionRestoreTargetSchema = {
|
|
7123
|
+
data: Job;
|
|
7124
|
+
};
|
|
7125
|
+
|
|
7126
|
+
/**
|
|
7127
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7128
|
+
* via the `restore.jobSchema` link.
|
|
7129
|
+
*/
|
|
7130
|
+
export type ItemVersionRestoreJobSchema = {
|
|
7131
|
+
data: [Item, ItemVersion];
|
|
7132
|
+
};
|
|
7133
|
+
|
|
7134
|
+
/**
|
|
7135
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7136
|
+
* via the `instances.targetSchema` link.
|
|
7137
|
+
*/
|
|
7138
|
+
export type ItemVersionInstancesTargetSchema = {
|
|
7139
|
+
data: ItemVersion[];
|
|
7140
|
+
meta: {
|
|
7141
|
+
total_count: number;
|
|
7142
|
+
};
|
|
7143
|
+
};
|
|
7144
|
+
|
|
7145
|
+
/**
|
|
7146
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7147
|
+
* via the `self.targetSchema` link.
|
|
7148
|
+
*/
|
|
7149
|
+
export type ItemVersionSelfTargetSchema = {
|
|
7150
|
+
data: ItemVersion;
|
|
7151
|
+
};
|
|
7152
|
+
|
|
6799
7153
|
/**
|
|
6800
7154
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6801
|
-
* via the `
|
|
7155
|
+
* via the `destroy.targetSchema` link.
|
|
6802
7156
|
*/
|
|
6803
|
-
export type
|
|
7157
|
+
export type ItemDestroyTargetSchema = {
|
|
6804
7158
|
data: Job;
|
|
6805
7159
|
};
|
|
6806
7160
|
|
|
6807
7161
|
/**
|
|
6808
7162
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6809
|
-
* via the `
|
|
7163
|
+
* via the `destroy.jobSchema` link.
|
|
6810
7164
|
*/
|
|
6811
|
-
export type
|
|
7165
|
+
export type ItemDestroyJobSchema = {
|
|
7166
|
+
data: Item;
|
|
7167
|
+
};
|
|
7168
|
+
|
|
7169
|
+
/**
|
|
7170
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7171
|
+
* via the `batch_destroy.targetSchema` link.
|
|
7172
|
+
*/
|
|
7173
|
+
export type ItemBatchDestroyTargetSchema = {
|
|
7174
|
+
data: Job;
|
|
7175
|
+
};
|
|
7176
|
+
|
|
7177
|
+
/**
|
|
7178
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7179
|
+
* via the `batch_destroy.jobSchema` link.
|
|
7180
|
+
*/
|
|
7181
|
+
export type ItemBatchDestroyJobSchema = {
|
|
6812
7182
|
data: unknown[];
|
|
6813
7183
|
meta: {
|
|
6814
7184
|
successful: number;
|
|
@@ -6818,39 +7188,37 @@ export type ItemBulkPublishJobSchema = {
|
|
|
6818
7188
|
|
|
6819
7189
|
/**
|
|
6820
7190
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6821
|
-
* via the `
|
|
7191
|
+
* via the `batch_publish.targetSchema` link.
|
|
6822
7192
|
*/
|
|
6823
|
-
export type
|
|
6824
|
-
data:
|
|
6825
|
-
|
|
6826
|
-
|
|
6827
|
-
|
|
6828
|
-
|
|
6829
|
-
|
|
6830
|
-
|
|
6831
|
-
|
|
6832
|
-
|
|
6833
|
-
|
|
6834
|
-
|
|
6835
|
-
|
|
6836
|
-
minItems?: unknown;
|
|
6837
|
-
};
|
|
7193
|
+
export type ItemBatchPublishTargetSchema = {
|
|
7194
|
+
data: Job;
|
|
7195
|
+
};
|
|
7196
|
+
|
|
7197
|
+
/**
|
|
7198
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7199
|
+
* via the `batch_publish.jobSchema` link.
|
|
7200
|
+
*/
|
|
7201
|
+
export type ItemBatchPublishJobSchema = {
|
|
7202
|
+
data: unknown[];
|
|
7203
|
+
meta: {
|
|
7204
|
+
successful: number;
|
|
7205
|
+
failed: number;
|
|
6838
7206
|
};
|
|
6839
7207
|
};
|
|
6840
7208
|
|
|
6841
7209
|
/**
|
|
6842
7210
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6843
|
-
* via the `
|
|
7211
|
+
* via the `batch_unpublish.targetSchema` link.
|
|
6844
7212
|
*/
|
|
6845
|
-
export type
|
|
7213
|
+
export type ItemBatchUnpublishTargetSchema = {
|
|
6846
7214
|
data: Job;
|
|
6847
7215
|
};
|
|
6848
7216
|
|
|
6849
7217
|
/**
|
|
6850
7218
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6851
|
-
* via the `
|
|
7219
|
+
* via the `batch_unpublish.jobSchema` link.
|
|
6852
7220
|
*/
|
|
6853
|
-
export type
|
|
7221
|
+
export type ItemBatchUnpublishJobSchema = {
|
|
6854
7222
|
data: unknown[];
|
|
6855
7223
|
meta: {
|
|
6856
7224
|
successful: number;
|
|
@@ -6860,17 +7228,35 @@ export type ItemBulkUnpublishJobSchema = {
|
|
|
6860
7228
|
|
|
6861
7229
|
/**
|
|
6862
7230
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6863
|
-
* via the `
|
|
7231
|
+
* via the `publish.targetSchema` link.
|
|
6864
7232
|
*/
|
|
6865
|
-
export type
|
|
7233
|
+
export type ItemPublishTargetSchema = {
|
|
7234
|
+
data: Item;
|
|
7235
|
+
included?: ItemType[];
|
|
7236
|
+
};
|
|
7237
|
+
|
|
7238
|
+
/**
|
|
7239
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7240
|
+
* via the `unpublish.targetSchema` link.
|
|
7241
|
+
*/
|
|
7242
|
+
export type ItemUnpublishTargetSchema = {
|
|
7243
|
+
data: Item;
|
|
7244
|
+
included?: ItemType[];
|
|
7245
|
+
};
|
|
7246
|
+
|
|
7247
|
+
/**
|
|
7248
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7249
|
+
* via the `bulk_publish.schema` link.
|
|
7250
|
+
*/
|
|
7251
|
+
export type ItemBulkPublishSchema = {
|
|
6866
7252
|
data: {
|
|
6867
7253
|
/**
|
|
6868
7254
|
* JSON API type field
|
|
6869
7255
|
*/
|
|
6870
|
-
type: '
|
|
7256
|
+
type: 'item_bulk_publish_operation';
|
|
6871
7257
|
relationships: {
|
|
6872
7258
|
/**
|
|
6873
|
-
* Records to
|
|
7259
|
+
* Records to publish (a maximum of 200 records are allowed per request)
|
|
6874
7260
|
*/
|
|
6875
7261
|
items: {
|
|
6876
7262
|
data: ItemData[];
|
|
@@ -6882,17 +7268,17 @@ export type ItemBulkDestroySchema = {
|
|
|
6882
7268
|
|
|
6883
7269
|
/**
|
|
6884
7270
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6885
|
-
* via the `
|
|
7271
|
+
* via the `bulk_publish.targetSchema` link.
|
|
6886
7272
|
*/
|
|
6887
|
-
export type
|
|
7273
|
+
export type ItemBulkPublishTargetSchema = {
|
|
6888
7274
|
data: Job;
|
|
6889
7275
|
};
|
|
6890
7276
|
|
|
6891
7277
|
/**
|
|
6892
7278
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6893
|
-
* via the `
|
|
7279
|
+
* via the `bulk_publish.jobSchema` link.
|
|
6894
7280
|
*/
|
|
6895
|
-
export type
|
|
7281
|
+
export type ItemBulkPublishJobSchema = {
|
|
6896
7282
|
data: unknown[];
|
|
6897
7283
|
meta: {
|
|
6898
7284
|
successful: number;
|
|
@@ -6902,23 +7288,17 @@ export type ItemBulkDestroyJobSchema = {
|
|
|
6902
7288
|
|
|
6903
7289
|
/**
|
|
6904
7290
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6905
|
-
* via the `
|
|
7291
|
+
* via the `bulk_unpublish.schema` link.
|
|
6906
7292
|
*/
|
|
6907
|
-
export type
|
|
7293
|
+
export type ItemBulkUnpublishSchema = {
|
|
6908
7294
|
data: {
|
|
6909
7295
|
/**
|
|
6910
7296
|
* JSON API type field
|
|
6911
7297
|
*/
|
|
6912
|
-
type: '
|
|
6913
|
-
attributes: {
|
|
6914
|
-
/**
|
|
6915
|
-
* Stage to be moved to
|
|
6916
|
-
*/
|
|
6917
|
-
stage: string;
|
|
6918
|
-
};
|
|
7298
|
+
type: 'item_bulk_unpublish_operation';
|
|
6919
7299
|
relationships: {
|
|
6920
7300
|
/**
|
|
6921
|
-
* Records to
|
|
7301
|
+
* Records to unpublish (a maximum of 200 records are allowed per request)
|
|
6922
7302
|
*/
|
|
6923
7303
|
items: {
|
|
6924
7304
|
data: ItemData[];
|
|
@@ -6930,17 +7310,17 @@ export type ItemBulkMoveToStageSchema = {
|
|
|
6930
7310
|
|
|
6931
7311
|
/**
|
|
6932
7312
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6933
|
-
* via the `
|
|
7313
|
+
* via the `bulk_unpublish.targetSchema` link.
|
|
6934
7314
|
*/
|
|
6935
|
-
export type
|
|
7315
|
+
export type ItemBulkUnpublishTargetSchema = {
|
|
6936
7316
|
data: Job;
|
|
6937
7317
|
};
|
|
6938
7318
|
|
|
6939
7319
|
/**
|
|
6940
7320
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
6941
|
-
* via the `
|
|
7321
|
+
* via the `bulk_unpublish.jobSchema` link.
|
|
6942
7322
|
*/
|
|
6943
|
-
export type
|
|
7323
|
+
export type ItemBulkUnpublishJobSchema = {
|
|
6944
7324
|
data: unknown[];
|
|
6945
7325
|
meta: {
|
|
6946
7326
|
successful: number;
|
|
@@ -6949,132 +7329,95 @@ export type ItemBulkMoveToStageJobSchema = {
|
|
|
6949
7329
|
};
|
|
6950
7330
|
|
|
6951
7331
|
/**
|
|
6952
|
-
*
|
|
6953
|
-
*
|
|
6954
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6955
|
-
* via the `definition` "item_version".
|
|
6956
|
-
*/
|
|
6957
|
-
export type ItemVersion = {
|
|
6958
|
-
type: ItemVersionType;
|
|
6959
|
-
id: ItemVersionIdentity;
|
|
6960
|
-
attributes: ItemVersionAttributes;
|
|
6961
|
-
relationships: ItemVersionRelationships;
|
|
6962
|
-
meta: ItemVersionMeta;
|
|
6963
|
-
};
|
|
6964
|
-
|
|
6965
|
-
/**
|
|
6966
|
-
* The JSON data associated to the record version
|
|
6967
|
-
*
|
|
6968
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6969
|
-
* via the `definition` "attributes".
|
|
6970
|
-
*/
|
|
6971
|
-
export type ItemVersionAttributes = {
|
|
6972
|
-
[k: string]: unknown;
|
|
6973
|
-
};
|
|
6974
|
-
|
|
6975
|
-
/**
|
|
6976
|
-
* JSON API links
|
|
6977
|
-
*
|
|
6978
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
6979
|
-
* via the `definition` "relationships".
|
|
7332
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7333
|
+
* via the `bulk_destroy.schema` link.
|
|
6980
7334
|
*/
|
|
6981
|
-
export type
|
|
6982
|
-
|
|
6983
|
-
|
|
6984
|
-
|
|
6985
|
-
|
|
6986
|
-
|
|
6987
|
-
|
|
6988
|
-
|
|
6989
|
-
|
|
6990
|
-
|
|
6991
|
-
|
|
6992
|
-
|
|
6993
|
-
|
|
6994
|
-
|
|
6995
|
-
|
|
6996
|
-
*/
|
|
6997
|
-
editor: {
|
|
6998
|
-
data:
|
|
6999
|
-
| AccountData
|
|
7000
|
-
| AccessTokenData
|
|
7001
|
-
| UserData
|
|
7002
|
-
| SsoUserData
|
|
7003
|
-
| OrganizationData;
|
|
7335
|
+
export type ItemBulkDestroySchema = {
|
|
7336
|
+
data: {
|
|
7337
|
+
/**
|
|
7338
|
+
* JSON API type field
|
|
7339
|
+
*/
|
|
7340
|
+
type: 'item_bulk_destroy_operation';
|
|
7341
|
+
relationships: {
|
|
7342
|
+
/**
|
|
7343
|
+
* Records to delete (a maximum of 200 records are allowed per request)
|
|
7344
|
+
*/
|
|
7345
|
+
items: {
|
|
7346
|
+
data: ItemData[];
|
|
7347
|
+
};
|
|
7348
|
+
minItems?: unknown;
|
|
7349
|
+
};
|
|
7004
7350
|
};
|
|
7005
7351
|
};
|
|
7006
7352
|
|
|
7007
7353
|
/**
|
|
7008
|
-
*
|
|
7009
|
-
*
|
|
7010
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7011
|
-
* via the `definition` "meta".
|
|
7354
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7355
|
+
* via the `bulk_destroy.targetSchema` link.
|
|
7012
7356
|
*/
|
|
7013
|
-
export type
|
|
7014
|
-
|
|
7015
|
-
* Date of record version creation
|
|
7016
|
-
*/
|
|
7017
|
-
created_at: string;
|
|
7018
|
-
/**
|
|
7019
|
-
* Whether the record version is valid or not
|
|
7020
|
-
*/
|
|
7021
|
-
is_valid: boolean;
|
|
7022
|
-
/**
|
|
7023
|
-
* Whether the record version is the published version or not
|
|
7024
|
-
*/
|
|
7025
|
-
is_published: boolean;
|
|
7026
|
-
/**
|
|
7027
|
-
* Whether the record version is the most recent version or not
|
|
7028
|
-
*/
|
|
7029
|
-
is_current: boolean;
|
|
7357
|
+
export type ItemBulkDestroyTargetSchema = {
|
|
7358
|
+
data: Job;
|
|
7030
7359
|
};
|
|
7031
7360
|
|
|
7032
7361
|
/**
|
|
7033
|
-
*
|
|
7034
|
-
*
|
|
7035
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7036
|
-
* via the `definition` "data".
|
|
7362
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7363
|
+
* via the `bulk_destroy.jobSchema` link.
|
|
7037
7364
|
*/
|
|
7038
|
-
export type
|
|
7039
|
-
|
|
7040
|
-
|
|
7365
|
+
export type ItemBulkDestroyJobSchema = {
|
|
7366
|
+
data: unknown[];
|
|
7367
|
+
meta: {
|
|
7368
|
+
successful: number;
|
|
7369
|
+
failed: number;
|
|
7370
|
+
};
|
|
7041
7371
|
};
|
|
7042
7372
|
|
|
7043
7373
|
/**
|
|
7044
|
-
* This interface was referenced by `
|
|
7045
|
-
* via the `
|
|
7374
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7375
|
+
* via the `bulk_move_to_stage.schema` link.
|
|
7046
7376
|
*/
|
|
7047
|
-
export type
|
|
7048
|
-
data:
|
|
7377
|
+
export type ItemBulkMoveToStageSchema = {
|
|
7378
|
+
data: {
|
|
7379
|
+
/**
|
|
7380
|
+
* JSON API type field
|
|
7381
|
+
*/
|
|
7382
|
+
type: 'item_bulk_move_to_stage_operation';
|
|
7383
|
+
attributes: {
|
|
7384
|
+
/**
|
|
7385
|
+
* Stage to be moved to
|
|
7386
|
+
*/
|
|
7387
|
+
stage: string;
|
|
7388
|
+
};
|
|
7389
|
+
relationships: {
|
|
7390
|
+
/**
|
|
7391
|
+
* Records to move (a maximum of 200 records are allowed per request)
|
|
7392
|
+
*/
|
|
7393
|
+
items: {
|
|
7394
|
+
data: ItemData[];
|
|
7395
|
+
};
|
|
7396
|
+
minItems?: unknown;
|
|
7397
|
+
};
|
|
7398
|
+
};
|
|
7049
7399
|
};
|
|
7050
7400
|
|
|
7051
7401
|
/**
|
|
7052
|
-
* This interface was referenced by `
|
|
7053
|
-
* via the `
|
|
7402
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7403
|
+
* via the `bulk_move_to_stage.targetSchema` link.
|
|
7054
7404
|
*/
|
|
7055
|
-
export type
|
|
7056
|
-
data:
|
|
7405
|
+
export type ItemBulkMoveToStageTargetSchema = {
|
|
7406
|
+
data: Job;
|
|
7057
7407
|
};
|
|
7058
7408
|
|
|
7059
7409
|
/**
|
|
7060
|
-
* This interface was referenced by `
|
|
7061
|
-
* via the `
|
|
7410
|
+
* This interface was referenced by `Item`'s JSON-Schema
|
|
7411
|
+
* via the `bulk_move_to_stage.jobSchema` link.
|
|
7062
7412
|
*/
|
|
7063
|
-
export type
|
|
7064
|
-
data:
|
|
7413
|
+
export type ItemBulkMoveToStageJobSchema = {
|
|
7414
|
+
data: unknown[];
|
|
7065
7415
|
meta: {
|
|
7066
|
-
|
|
7416
|
+
successful: number;
|
|
7417
|
+
failed: number;
|
|
7067
7418
|
};
|
|
7068
7419
|
};
|
|
7069
7420
|
|
|
7070
|
-
/**
|
|
7071
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
7072
|
-
* via the `self.targetSchema` link.
|
|
7073
|
-
*/
|
|
7074
|
-
export type ItemVersionSelfTargetSchema = {
|
|
7075
|
-
data: ItemVersion;
|
|
7076
|
-
};
|
|
7077
|
-
|
|
7078
7421
|
/**
|
|
7079
7422
|
* Every file you upload to DatoCMS will be retrievable from this endpoint.
|
|
7080
7423
|
*
|
|
@@ -7717,166 +8060,6 @@ export type UploadRequestCreateTargetSchema = {
|
|
|
7717
8060
|
data: UploadRequest;
|
|
7718
8061
|
};
|
|
7719
8062
|
|
|
7720
|
-
/**
|
|
7721
|
-
* You can create scheduled publication to publish records in the future
|
|
7722
|
-
*
|
|
7723
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7724
|
-
* via the `definition` "scheduled_publication".
|
|
7725
|
-
*/
|
|
7726
|
-
export type ScheduledPublication = {
|
|
7727
|
-
type: ScheduledPublicationType;
|
|
7728
|
-
id: ScheduledPublicationIdentity;
|
|
7729
|
-
attributes: ScheduledPublicationAttributes;
|
|
7730
|
-
relationships: ScheduledPublicationRelationships;
|
|
7731
|
-
};
|
|
7732
|
-
|
|
7733
|
-
/**
|
|
7734
|
-
* JSON API attributes
|
|
7735
|
-
*
|
|
7736
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7737
|
-
* via the `definition` "attributes".
|
|
7738
|
-
*/
|
|
7739
|
-
export type ScheduledPublicationAttributes = {
|
|
7740
|
-
/**
|
|
7741
|
-
* The future date for the publication
|
|
7742
|
-
*/
|
|
7743
|
-
publication_scheduled_at: string;
|
|
7744
|
-
};
|
|
7745
|
-
|
|
7746
|
-
/**
|
|
7747
|
-
* JSON API links
|
|
7748
|
-
*
|
|
7749
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7750
|
-
* via the `definition` "relationships".
|
|
7751
|
-
*/
|
|
7752
|
-
export type ScheduledPublicationRelationships = {
|
|
7753
|
-
/**
|
|
7754
|
-
* Item
|
|
7755
|
-
*/
|
|
7756
|
-
item: {
|
|
7757
|
-
data: ItemData;
|
|
7758
|
-
};
|
|
7759
|
-
};
|
|
7760
|
-
|
|
7761
|
-
/**
|
|
7762
|
-
* JSON API data
|
|
7763
|
-
*
|
|
7764
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7765
|
-
* via the `definition` "data".
|
|
7766
|
-
*/
|
|
7767
|
-
export type ScheduledPublicationData = {
|
|
7768
|
-
type: ScheduledPublicationType;
|
|
7769
|
-
id: ScheduledPublicationIdentity;
|
|
7770
|
-
};
|
|
7771
|
-
|
|
7772
|
-
/**
|
|
7773
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7774
|
-
* via the `create.schema` link.
|
|
7775
|
-
*/
|
|
7776
|
-
export type ScheduledPublicationCreateSchema = {
|
|
7777
|
-
data: {
|
|
7778
|
-
type: ScheduledPublicationType;
|
|
7779
|
-
attributes: ScheduledPublicationAttributes;
|
|
7780
|
-
};
|
|
7781
|
-
};
|
|
7782
|
-
|
|
7783
|
-
/**
|
|
7784
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7785
|
-
* via the `create.targetSchema` link.
|
|
7786
|
-
*/
|
|
7787
|
-
export type ScheduledPublicationCreateTargetSchema = {
|
|
7788
|
-
data: ScheduledPublication;
|
|
7789
|
-
included: Item[];
|
|
7790
|
-
};
|
|
7791
|
-
|
|
7792
|
-
/**
|
|
7793
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
7794
|
-
* via the `destroy.targetSchema` link.
|
|
7795
|
-
*/
|
|
7796
|
-
export type ScheduledPublicationDestroyTargetSchema = {
|
|
7797
|
-
data: Item;
|
|
7798
|
-
};
|
|
7799
|
-
|
|
7800
|
-
/**
|
|
7801
|
-
* You can create a scheduled unpublishing to unpublish records in the future
|
|
7802
|
-
*
|
|
7803
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7804
|
-
* via the `definition` "scheduled_unpublishing".
|
|
7805
|
-
*/
|
|
7806
|
-
export type ScheduledUnpublishing = {
|
|
7807
|
-
type: ScheduledUnpublishingType;
|
|
7808
|
-
id: ScheduledUnpublishingIdentity;
|
|
7809
|
-
attributes: ScheduledUnpublishingAttributes;
|
|
7810
|
-
relationships: ScheduledUnpublishingRelationships;
|
|
7811
|
-
};
|
|
7812
|
-
|
|
7813
|
-
/**
|
|
7814
|
-
* JSON API attributes
|
|
7815
|
-
*
|
|
7816
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7817
|
-
* via the `definition` "attributes".
|
|
7818
|
-
*/
|
|
7819
|
-
export type ScheduledUnpublishingAttributes = {
|
|
7820
|
-
/**
|
|
7821
|
-
* The future date for the unpublishing
|
|
7822
|
-
*/
|
|
7823
|
-
unpublishing_scheduled_at: string;
|
|
7824
|
-
};
|
|
7825
|
-
|
|
7826
|
-
/**
|
|
7827
|
-
* JSON API links
|
|
7828
|
-
*
|
|
7829
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7830
|
-
* via the `definition` "relationships".
|
|
7831
|
-
*/
|
|
7832
|
-
export type ScheduledUnpublishingRelationships = {
|
|
7833
|
-
/**
|
|
7834
|
-
* Item
|
|
7835
|
-
*/
|
|
7836
|
-
item: {
|
|
7837
|
-
data: ItemData;
|
|
7838
|
-
};
|
|
7839
|
-
};
|
|
7840
|
-
|
|
7841
|
-
/**
|
|
7842
|
-
* JSON API data
|
|
7843
|
-
*
|
|
7844
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7845
|
-
* via the `definition` "data".
|
|
7846
|
-
*/
|
|
7847
|
-
export type ScheduledUnpublishingData = {
|
|
7848
|
-
type: ScheduledUnpublishingType;
|
|
7849
|
-
id: ScheduledUnpublishingIdentity;
|
|
7850
|
-
};
|
|
7851
|
-
|
|
7852
|
-
/**
|
|
7853
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7854
|
-
* via the `create.schema` link.
|
|
7855
|
-
*/
|
|
7856
|
-
export type ScheduledUnpublishingCreateSchema = {
|
|
7857
|
-
data: {
|
|
7858
|
-
type: ScheduledUnpublishingType;
|
|
7859
|
-
attributes: ScheduledUnpublishingAttributes;
|
|
7860
|
-
};
|
|
7861
|
-
};
|
|
7862
|
-
|
|
7863
|
-
/**
|
|
7864
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7865
|
-
* via the `create.targetSchema` link.
|
|
7866
|
-
*/
|
|
7867
|
-
export type ScheduledUnpublishingCreateTargetSchema = {
|
|
7868
|
-
data: ScheduledUnpublishing;
|
|
7869
|
-
included: Item[];
|
|
7870
|
-
};
|
|
7871
|
-
|
|
7872
|
-
/**
|
|
7873
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
7874
|
-
* via the `destroy.targetSchema` link.
|
|
7875
|
-
*/
|
|
7876
|
-
export type ScheduledUnpublishingDestroyTargetSchema = {
|
|
7877
|
-
data: Item;
|
|
7878
|
-
};
|
|
7879
|
-
|
|
7880
8063
|
/**
|
|
7881
8064
|
* 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.
|
|
7882
8065
|
*
|