@datocms/cma-client 5.2.0-alpha.1 → 5.2.0-alpha.2
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/fieldTypes/single_block.js.map +1 -1
- package/dist/cjs/fieldTypes/slug.js.map +1 -1
- package/dist/cjs/fieldTypes/structured_text.js.map +1 -1
- package/dist/cjs/fieldTypes/validators/index.js +2 -2
- package/dist/cjs/fieldTypes/validators/index.js.map +1 -1
- package/dist/cjs/fieldTypes/validators/{sanitization.js → sanitized_html.js} +1 -1
- package/dist/cjs/fieldTypes/validators/sanitized_html.js.map +1 -0
- package/dist/cjs/generated/Client.js +3 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/BuildTrigger.js +2 -0
- package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/cjs/generated/resources/Field.js +2 -6
- package/dist/cjs/generated/resources/Field.js.map +1 -1
- package/dist/cjs/generated/resources/ItemType.js +25 -0
- package/dist/cjs/generated/resources/ItemType.js.map +1 -1
- package/dist/cjs/generated/resources/ItemVersion.js +4 -3
- package/dist/cjs/generated/resources/ItemVersion.js.map +1 -1
- package/dist/cjs/generated/resources/Role.js +8 -0
- package/dist/cjs/generated/resources/Role.js.map +1 -1
- package/dist/cjs/generated/resources/SiteSearchSource.js +231 -0
- package/dist/cjs/generated/resources/SiteSearchSource.js.map +1 -0
- package/dist/cjs/generated/resources/SiteSearchSourceEvent.js +153 -0
- package/dist/cjs/generated/resources/SiteSearchSourceEvent.js.map +1 -0
- package/dist/cjs/generated/resources/UploadRequest.js +1 -1
- package/dist/cjs/generated/resources/UploadRequest.js.map +1 -1
- package/dist/cjs/generated/resources/index.js +5 -1
- package/dist/cjs/generated/resources/index.js.map +1 -1
- package/dist/cjs/utilities/buildBlockRecord.js.map +1 -1
- package/dist/cjs/utilities/duplicateBlockRecord.js +6 -2
- package/dist/cjs/utilities/duplicateBlockRecord.js.map +1 -1
- package/dist/esm/fieldTypes/appearance/seo.d.ts +1 -1
- package/dist/esm/fieldTypes/single_block.d.ts +0 -1
- package/dist/esm/fieldTypes/single_block.js.map +1 -1
- package/dist/esm/fieldTypes/slug.d.ts +3 -0
- package/dist/esm/fieldTypes/slug.js.map +1 -1
- package/dist/esm/fieldTypes/structured_text.d.ts +3 -0
- package/dist/esm/fieldTypes/structured_text.js.map +1 -1
- package/dist/esm/fieldTypes/text.d.ts +2 -2
- package/dist/esm/fieldTypes/validators/index.d.ts +2 -2
- package/dist/esm/fieldTypes/validators/index.js +2 -2
- package/dist/esm/fieldTypes/validators/index.js.map +1 -1
- package/dist/{types/fieldTypes/validators/sanitization.d.ts → esm/fieldTypes/validators/sanitized_html.d.ts} +1 -1
- package/dist/esm/fieldTypes/validators/sanitized_html.js +2 -0
- package/dist/esm/fieldTypes/validators/sanitized_html.js.map +1 -0
- package/dist/esm/generated/ApiTypes.d.ts +491 -69
- package/dist/esm/generated/Client.d.ts +2 -0
- package/dist/esm/generated/Client.js +3 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/RawApiTypes.d.ts +505 -68
- package/dist/esm/generated/resources/BuildTrigger.js +2 -0
- package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/esm/generated/resources/Field.d.ts +2 -206
- package/dist/esm/generated/resources/Field.js +2 -6
- package/dist/esm/generated/resources/Field.js.map +1 -1
- package/dist/esm/generated/resources/ItemType.d.ts +18 -0
- package/dist/esm/generated/resources/ItemType.js +25 -0
- package/dist/esm/generated/resources/ItemType.js.map +1 -1
- package/dist/esm/generated/resources/ItemVersion.d.ts +2 -2
- package/dist/esm/generated/resources/ItemVersion.js +4 -3
- package/dist/esm/generated/resources/ItemVersion.js.map +1 -1
- package/dist/esm/generated/resources/Role.js +8 -0
- package/dist/esm/generated/resources/Role.js.map +1 -1
- package/dist/esm/generated/resources/SiteSearchSource.d.ts +132 -0
- package/dist/esm/generated/resources/SiteSearchSource.js +202 -0
- package/dist/esm/generated/resources/SiteSearchSource.js.map +1 -0
- package/dist/esm/generated/resources/SiteSearchSourceEvent.d.ts +61 -0
- package/dist/esm/generated/resources/SiteSearchSourceEvent.js +124 -0
- package/dist/esm/generated/resources/SiteSearchSourceEvent.js.map +1 -0
- package/dist/esm/generated/resources/UploadRequest.js +1 -1
- package/dist/esm/generated/resources/UploadRequest.js.map +1 -1
- package/dist/esm/generated/resources/index.d.ts +2 -0
- package/dist/esm/generated/resources/index.js +2 -0
- package/dist/esm/generated/resources/index.js.map +1 -1
- package/dist/esm/utilities/buildBlockRecord.d.ts +10 -3
- package/dist/esm/utilities/buildBlockRecord.js.map +1 -1
- package/dist/esm/utilities/duplicateBlockRecord.js +6 -2
- package/dist/esm/utilities/duplicateBlockRecord.js.map +1 -1
- package/dist/types/fieldTypes/appearance/seo.d.ts +1 -1
- package/dist/types/fieldTypes/single_block.d.ts +0 -1
- package/dist/types/fieldTypes/slug.d.ts +3 -0
- package/dist/types/fieldTypes/structured_text.d.ts +3 -0
- package/dist/types/fieldTypes/text.d.ts +2 -2
- package/dist/types/fieldTypes/validators/index.d.ts +2 -2
- package/dist/{esm/fieldTypes/validators/sanitization.d.ts → types/fieldTypes/validators/sanitized_html.d.ts} +1 -1
- package/dist/types/generated/ApiTypes.d.ts +491 -69
- package/dist/types/generated/Client.d.ts +2 -0
- package/dist/types/generated/RawApiTypes.d.ts +505 -68
- package/dist/types/generated/resources/Field.d.ts +2 -206
- package/dist/types/generated/resources/ItemType.d.ts +18 -0
- package/dist/types/generated/resources/ItemVersion.d.ts +2 -2
- package/dist/types/generated/resources/SiteSearchSource.d.ts +132 -0
- package/dist/types/generated/resources/SiteSearchSourceEvent.d.ts +61 -0
- package/dist/types/generated/resources/index.d.ts +2 -0
- package/dist/types/utilities/buildBlockRecord.d.ts +10 -3
- package/package.json +3 -3
- package/resources.json +292 -193
- package/src/fieldTypes/appearance/seo.ts +1 -1
- package/src/fieldTypes/single_block.ts +0 -1
- package/src/fieldTypes/slug.ts +3 -0
- package/src/fieldTypes/structured_text.ts +3 -0
- package/src/fieldTypes/text.ts +2 -2
- package/src/fieldTypes/validators/index.ts +2 -2
- package/src/fieldTypes/validators/{sanitization.ts → sanitized_html.ts} +1 -1
- package/src/generated/ApiTypes.ts +510 -88
- package/src/generated/Client.ts +5 -1
- package/src/generated/RawApiTypes.ts +519 -82
- package/src/generated/resources/BuildTrigger.ts +2 -0
- package/src/generated/resources/Field.ts +2 -6
- package/src/generated/resources/ItemType.ts +33 -0
- package/src/generated/resources/ItemVersion.ts +7 -2
- package/src/generated/resources/Role.ts +8 -0
- package/src/generated/resources/SiteSearchSource.ts +265 -0
- package/src/generated/resources/SiteSearchSourceEvent.ts +134 -0
- package/src/generated/resources/UploadRequest.ts +1 -1
- package/src/generated/resources/index.ts +2 -0
- package/src/utilities/buildBlockRecord.ts +15 -3
- package/src/utilities/duplicateBlockRecord.ts +7 -2
- package/dist/cjs/fieldTypes/validators/sanitization.js.map +0 -1
- package/dist/esm/fieldTypes/validators/sanitization.js +0 -2
- package/dist/esm/fieldTypes/validators/sanitization.js.map +0 -1
|
@@ -109,25 +109,25 @@ export type WorkflowIdentity = string;
|
|
|
109
109
|
*/
|
|
110
110
|
export type EnvironmentIdentity = string;
|
|
111
111
|
/**
|
|
112
|
-
*
|
|
112
|
+
* ID of build_trigger
|
|
113
113
|
*
|
|
114
|
-
* This interface was referenced by `
|
|
114
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
115
115
|
* via the `definition` "identity".
|
|
116
116
|
*
|
|
117
|
-
* This interface was referenced by `
|
|
117
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
118
118
|
* via the `definition` "id".
|
|
119
119
|
*/
|
|
120
|
-
export type
|
|
120
|
+
export type BuildTriggerIdentity = string;
|
|
121
121
|
/**
|
|
122
|
-
* ID of
|
|
122
|
+
* ID of site_search_source
|
|
123
123
|
*
|
|
124
|
-
* This interface was referenced by `
|
|
124
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
125
125
|
* via the `definition` "identity".
|
|
126
126
|
*
|
|
127
|
-
* This interface was referenced by `
|
|
127
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
128
128
|
* via the `definition` "id".
|
|
129
129
|
*/
|
|
130
|
-
export type
|
|
130
|
+
export type SiteSearchSourceIdentity = string;
|
|
131
131
|
/**
|
|
132
132
|
* This interface was referenced by `User`'s JSON-Schema
|
|
133
133
|
* via the `definition` "type".
|
|
@@ -413,6 +413,16 @@ export type SchemaMenuItemInstancesHrefSchema = {
|
|
|
413
413
|
* via the `definition` "type".
|
|
414
414
|
*/
|
|
415
415
|
export type UploadCollectionType = 'upload_collection';
|
|
416
|
+
/**
|
|
417
|
+
* RFC 4122 UUID of upload collection expressed in URL-safe base64 format
|
|
418
|
+
*
|
|
419
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
420
|
+
* via the `definition` "identity".
|
|
421
|
+
*
|
|
422
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
423
|
+
* via the `definition` "id".
|
|
424
|
+
*/
|
|
425
|
+
export type UploadCollectionIdentity = string;
|
|
416
426
|
/**
|
|
417
427
|
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
418
428
|
* via the `instances.hrefSchema` link.
|
|
@@ -640,10 +650,7 @@ export type BuildEventInstancesHrefSchema = {
|
|
|
640
650
|
| 'response_success'
|
|
641
651
|
| 'response_failure'
|
|
642
652
|
| 'request_aborted'
|
|
643
|
-
| 'response_unprocessable'
|
|
644
|
-
| 'indexing_started'
|
|
645
|
-
| 'indexing_success'
|
|
646
|
-
| 'indexing_failure';
|
|
653
|
+
| 'response_unprocessable';
|
|
647
654
|
};
|
|
648
655
|
created_at?: {
|
|
649
656
|
gt?: string;
|
|
@@ -663,6 +670,84 @@ export type BuildEventInstancesHrefSchema = {
|
|
|
663
670
|
| 'event_type_desc';
|
|
664
671
|
[k: string]: unknown;
|
|
665
672
|
};
|
|
673
|
+
/**
|
|
674
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
675
|
+
* via the `definition` "type".
|
|
676
|
+
*/
|
|
677
|
+
export type SiteSearchSourceEventType = 'site_search_source_event';
|
|
678
|
+
/**
|
|
679
|
+
* ID of site search source event
|
|
680
|
+
*
|
|
681
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
682
|
+
* via the `definition` "identity".
|
|
683
|
+
*
|
|
684
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
685
|
+
* via the `definition` "id".
|
|
686
|
+
*/
|
|
687
|
+
export type SiteSearchSourceEventIdentity = string;
|
|
688
|
+
/**
|
|
689
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
690
|
+
* via the `definition` "type".
|
|
691
|
+
*/
|
|
692
|
+
export type SiteSearchSourceType = 'site_search_source';
|
|
693
|
+
/**
|
|
694
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
695
|
+
* via the `instances.hrefSchema` link.
|
|
696
|
+
*/
|
|
697
|
+
export type SiteSearchSourceEventInstancesHrefSchema = {
|
|
698
|
+
/**
|
|
699
|
+
* Parameters to control offset-based pagination
|
|
700
|
+
*/
|
|
701
|
+
page?: {
|
|
702
|
+
/**
|
|
703
|
+
* The (zero-based) offset of the first entity returned in the collection (defaults to 0)
|
|
704
|
+
*/
|
|
705
|
+
offset?: number;
|
|
706
|
+
/**
|
|
707
|
+
* The maximum number of entities to return (defaults to 30, maximum is 500)
|
|
708
|
+
*/
|
|
709
|
+
limit?: number;
|
|
710
|
+
};
|
|
711
|
+
/**
|
|
712
|
+
* Attributes to filter
|
|
713
|
+
*/
|
|
714
|
+
filter?: {
|
|
715
|
+
/**
|
|
716
|
+
* IDs to fetch, comma separated
|
|
717
|
+
*/
|
|
718
|
+
ids?: string;
|
|
719
|
+
fields?: {
|
|
720
|
+
site_search_source_id?: {
|
|
721
|
+
eq?: string;
|
|
722
|
+
};
|
|
723
|
+
event_type?: {
|
|
724
|
+
/**
|
|
725
|
+
* The type of activity
|
|
726
|
+
*/
|
|
727
|
+
eq?:
|
|
728
|
+
| 'indexing_started'
|
|
729
|
+
| 'indexing_success'
|
|
730
|
+
| 'indexing_failure'
|
|
731
|
+
| 'indexing_aborted';
|
|
732
|
+
};
|
|
733
|
+
created_at?: {
|
|
734
|
+
gt?: string;
|
|
735
|
+
lt?: string;
|
|
736
|
+
};
|
|
737
|
+
};
|
|
738
|
+
};
|
|
739
|
+
/**
|
|
740
|
+
* Fields used to order results
|
|
741
|
+
*/
|
|
742
|
+
order_by?:
|
|
743
|
+
| 'site_search_source_id_asc'
|
|
744
|
+
| 'site_search_source_id_desc'
|
|
745
|
+
| 'created_at_asc'
|
|
746
|
+
| 'created_at_desc'
|
|
747
|
+
| 'event_type_asc'
|
|
748
|
+
| 'event_type_desc';
|
|
749
|
+
[k: string]: unknown;
|
|
750
|
+
};
|
|
666
751
|
/**
|
|
667
752
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
668
753
|
* via the `instances.hrefSchema` link.
|
|
@@ -841,6 +926,17 @@ export type ItemVersionInstancesHrefSchema = {
|
|
|
841
926
|
};
|
|
842
927
|
[k: string]: unknown;
|
|
843
928
|
};
|
|
929
|
+
/**
|
|
930
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
931
|
+
* via the `self.hrefSchema` link.
|
|
932
|
+
*/
|
|
933
|
+
export type ItemVersionSelfHrefSchema = {
|
|
934
|
+
/**
|
|
935
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
936
|
+
*/
|
|
937
|
+
nested?: boolean;
|
|
938
|
+
[k: string]: unknown;
|
|
939
|
+
};
|
|
844
940
|
/**
|
|
845
941
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
846
942
|
* via the `publish.schema` link.
|
|
@@ -1054,7 +1150,11 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
1054
1150
|
*/
|
|
1055
1151
|
query: string;
|
|
1056
1152
|
/**
|
|
1057
|
-
* The
|
|
1153
|
+
* The site search source ID or name on which the search will be performed. If not provided, the first enabled site search source will be used.
|
|
1154
|
+
*/
|
|
1155
|
+
site_search_source_id?: string;
|
|
1156
|
+
/**
|
|
1157
|
+
* **[Deprecated]** Use `site_search_source_id` instead. The build trigger ID or name on which the search will be performed. This parameter is only supported for backward compatibility and will return an error if the build trigger has multiple site search sources associated.
|
|
1058
1158
|
*/
|
|
1059
1159
|
build_trigger_id?: string;
|
|
1060
1160
|
/**
|
|
@@ -1614,6 +1714,10 @@ export type RoleAttributes = {
|
|
|
1614
1714
|
* Can create/edit Build triggers
|
|
1615
1715
|
*/
|
|
1616
1716
|
can_manage_build_triggers: boolean;
|
|
1717
|
+
/**
|
|
1718
|
+
* Can create/edit Site Search Sources
|
|
1719
|
+
*/
|
|
1720
|
+
can_manage_site_search_sources: boolean;
|
|
1617
1721
|
/**
|
|
1618
1722
|
* Can create/edit webhooks
|
|
1619
1723
|
*/
|
|
@@ -1646,6 +1750,10 @@ export type RoleAttributes = {
|
|
|
1646
1750
|
* Can access the build events log
|
|
1647
1751
|
*/
|
|
1648
1752
|
can_access_build_events_log: boolean;
|
|
1753
|
+
/**
|
|
1754
|
+
* Can access the site search source events log
|
|
1755
|
+
*/
|
|
1756
|
+
can_access_site_search_source_events_log: boolean;
|
|
1649
1757
|
/**
|
|
1650
1758
|
* Allowed actions on a model (or all) for a role
|
|
1651
1759
|
*/
|
|
@@ -1733,8 +1841,7 @@ export type RoleAttributes = {
|
|
|
1733
1841
|
| 'create'
|
|
1734
1842
|
| 'delete'
|
|
1735
1843
|
| 'edit_creator'
|
|
1736
|
-
| 'replace_asset'
|
|
1737
|
-
| 'move';
|
|
1844
|
+
| 'replace_asset';
|
|
1738
1845
|
/**
|
|
1739
1846
|
* Permitted creator
|
|
1740
1847
|
*/
|
|
@@ -1747,8 +1854,6 @@ export type RoleAttributes = {
|
|
|
1747
1854
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
1748
1855
|
*/
|
|
1749
1856
|
locale?: string | null;
|
|
1750
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
1751
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
1752
1857
|
}[];
|
|
1753
1858
|
/**
|
|
1754
1859
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -1765,8 +1870,7 @@ export type RoleAttributes = {
|
|
|
1765
1870
|
| 'create'
|
|
1766
1871
|
| 'delete'
|
|
1767
1872
|
| 'edit_creator'
|
|
1768
|
-
| 'replace_asset'
|
|
1769
|
-
| 'move';
|
|
1873
|
+
| 'replace_asset';
|
|
1770
1874
|
/**
|
|
1771
1875
|
* Permitted creator
|
|
1772
1876
|
*/
|
|
@@ -1779,8 +1883,6 @@ export type RoleAttributes = {
|
|
|
1779
1883
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
1780
1884
|
*/
|
|
1781
1885
|
locale?: string | null;
|
|
1782
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
1783
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
1784
1886
|
}[];
|
|
1785
1887
|
/**
|
|
1786
1888
|
* Allowed build triggers for a role
|
|
@@ -1794,6 +1896,18 @@ export type RoleAttributes = {
|
|
|
1794
1896
|
negative_build_trigger_permissions: {
|
|
1795
1897
|
build_trigger?: BuildTriggerIdentity | null;
|
|
1796
1898
|
}[];
|
|
1899
|
+
/**
|
|
1900
|
+
* Allowed site search sources for a role
|
|
1901
|
+
*/
|
|
1902
|
+
positive_site_search_source_permissions: {
|
|
1903
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
1904
|
+
}[];
|
|
1905
|
+
/**
|
|
1906
|
+
* Prohibited site search sources for a role
|
|
1907
|
+
*/
|
|
1908
|
+
negative_site_search_source_permissions: {
|
|
1909
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
1910
|
+
}[];
|
|
1797
1911
|
};
|
|
1798
1912
|
/**
|
|
1799
1913
|
* JSON API links
|
|
@@ -1874,6 +1988,10 @@ export type RoleMeta = {
|
|
|
1874
1988
|
* Can create/edit Build triggers
|
|
1875
1989
|
*/
|
|
1876
1990
|
can_manage_build_triggers: boolean;
|
|
1991
|
+
/**
|
|
1992
|
+
* Can create/edit Site Search Sources
|
|
1993
|
+
*/
|
|
1994
|
+
can_manage_site_search_sources: boolean;
|
|
1877
1995
|
/**
|
|
1878
1996
|
* Can create/edit webhooks
|
|
1879
1997
|
*/
|
|
@@ -1906,6 +2024,10 @@ export type RoleMeta = {
|
|
|
1906
2024
|
* Can access the build events log
|
|
1907
2025
|
*/
|
|
1908
2026
|
can_access_build_events_log: boolean;
|
|
2027
|
+
/**
|
|
2028
|
+
* Can access the site search source events log
|
|
2029
|
+
*/
|
|
2030
|
+
can_access_site_search_source_events_log: boolean;
|
|
1909
2031
|
/**
|
|
1910
2032
|
* Allowed actions on a model (or all) for a role
|
|
1911
2033
|
*/
|
|
@@ -1993,8 +2115,7 @@ export type RoleMeta = {
|
|
|
1993
2115
|
| 'create'
|
|
1994
2116
|
| 'delete'
|
|
1995
2117
|
| 'edit_creator'
|
|
1996
|
-
| 'replace_asset'
|
|
1997
|
-
| 'move';
|
|
2118
|
+
| 'replace_asset';
|
|
1998
2119
|
/**
|
|
1999
2120
|
* Permitted creator
|
|
2000
2121
|
*/
|
|
@@ -2007,8 +2128,6 @@ export type RoleMeta = {
|
|
|
2007
2128
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2008
2129
|
*/
|
|
2009
2130
|
locale?: string | null;
|
|
2010
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2011
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2012
2131
|
}[];
|
|
2013
2132
|
/**
|
|
2014
2133
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2025,8 +2144,7 @@ export type RoleMeta = {
|
|
|
2025
2144
|
| 'create'
|
|
2026
2145
|
| 'delete'
|
|
2027
2146
|
| 'edit_creator'
|
|
2028
|
-
| 'replace_asset'
|
|
2029
|
-
| 'move';
|
|
2147
|
+
| 'replace_asset';
|
|
2030
2148
|
/**
|
|
2031
2149
|
* Permitted creator
|
|
2032
2150
|
*/
|
|
@@ -2039,8 +2157,6 @@ export type RoleMeta = {
|
|
|
2039
2157
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2040
2158
|
*/
|
|
2041
2159
|
locale?: string | null;
|
|
2042
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2043
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2044
2160
|
}[];
|
|
2045
2161
|
/**
|
|
2046
2162
|
* Allowed build triggers for a role
|
|
@@ -2054,6 +2170,18 @@ export type RoleMeta = {
|
|
|
2054
2170
|
negative_build_trigger_permissions: {
|
|
2055
2171
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2056
2172
|
}[];
|
|
2173
|
+
/**
|
|
2174
|
+
* Allowed site search sources for a role
|
|
2175
|
+
*/
|
|
2176
|
+
positive_site_search_source_permissions: {
|
|
2177
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2178
|
+
}[];
|
|
2179
|
+
/**
|
|
2180
|
+
* Prohibited site search sources for a role
|
|
2181
|
+
*/
|
|
2182
|
+
negative_site_search_source_permissions: {
|
|
2183
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2184
|
+
}[];
|
|
2057
2185
|
};
|
|
2058
2186
|
};
|
|
2059
2187
|
/**
|
|
@@ -2107,6 +2235,10 @@ export type RoleCreateSchema = {
|
|
|
2107
2235
|
* Can create/edit shared filters (both for models and the media area)
|
|
2108
2236
|
*/
|
|
2109
2237
|
can_manage_shared_filters?: boolean;
|
|
2238
|
+
/**
|
|
2239
|
+
* Can create/edit Site Search Sources
|
|
2240
|
+
*/
|
|
2241
|
+
can_manage_site_search_sources?: boolean;
|
|
2110
2242
|
/**
|
|
2111
2243
|
* Can create/edit upload collections
|
|
2112
2244
|
*/
|
|
@@ -2147,6 +2279,10 @@ export type RoleCreateSchema = {
|
|
|
2147
2279
|
* Can access the build events log
|
|
2148
2280
|
*/
|
|
2149
2281
|
can_access_build_events_log?: boolean;
|
|
2282
|
+
/**
|
|
2283
|
+
* Can access the site search source events log
|
|
2284
|
+
*/
|
|
2285
|
+
can_access_site_search_source_events_log?: boolean;
|
|
2150
2286
|
/**
|
|
2151
2287
|
* Allowed actions on a model (or all) for a role
|
|
2152
2288
|
*/
|
|
@@ -2234,8 +2370,7 @@ export type RoleCreateSchema = {
|
|
|
2234
2370
|
| 'create'
|
|
2235
2371
|
| 'delete'
|
|
2236
2372
|
| 'edit_creator'
|
|
2237
|
-
| 'replace_asset'
|
|
2238
|
-
| 'move';
|
|
2373
|
+
| 'replace_asset';
|
|
2239
2374
|
/**
|
|
2240
2375
|
* Permitted creator
|
|
2241
2376
|
*/
|
|
@@ -2248,8 +2383,6 @@ export type RoleCreateSchema = {
|
|
|
2248
2383
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2249
2384
|
*/
|
|
2250
2385
|
locale?: string | null;
|
|
2251
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2252
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2253
2386
|
}[];
|
|
2254
2387
|
/**
|
|
2255
2388
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2266,8 +2399,7 @@ export type RoleCreateSchema = {
|
|
|
2266
2399
|
| 'create'
|
|
2267
2400
|
| 'delete'
|
|
2268
2401
|
| 'edit_creator'
|
|
2269
|
-
| 'replace_asset'
|
|
2270
|
-
| 'move';
|
|
2402
|
+
| 'replace_asset';
|
|
2271
2403
|
/**
|
|
2272
2404
|
* Permitted creator
|
|
2273
2405
|
*/
|
|
@@ -2280,8 +2412,6 @@ export type RoleCreateSchema = {
|
|
|
2280
2412
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2281
2413
|
*/
|
|
2282
2414
|
locale?: string | null;
|
|
2283
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2284
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2285
2415
|
}[];
|
|
2286
2416
|
/**
|
|
2287
2417
|
* Allowed build triggers for a role
|
|
@@ -2295,6 +2425,18 @@ export type RoleCreateSchema = {
|
|
|
2295
2425
|
negative_build_trigger_permissions?: {
|
|
2296
2426
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2297
2427
|
}[];
|
|
2428
|
+
/**
|
|
2429
|
+
* Allowed site search sources for a role
|
|
2430
|
+
*/
|
|
2431
|
+
positive_site_search_source_permissions?: {
|
|
2432
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2433
|
+
}[];
|
|
2434
|
+
/**
|
|
2435
|
+
* Prohibited site search sources for a role
|
|
2436
|
+
*/
|
|
2437
|
+
negative_site_search_source_permissions?: {
|
|
2438
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2439
|
+
}[];
|
|
2298
2440
|
};
|
|
2299
2441
|
/**
|
|
2300
2442
|
* JSON API links
|
|
@@ -2369,6 +2511,10 @@ export type RoleUpdateSchema = {
|
|
|
2369
2511
|
* Can create/edit shared filters (both for models and the media area)
|
|
2370
2512
|
*/
|
|
2371
2513
|
can_manage_shared_filters?: boolean;
|
|
2514
|
+
/**
|
|
2515
|
+
* Can create/edit Site Search Sources
|
|
2516
|
+
*/
|
|
2517
|
+
can_manage_site_search_sources?: boolean;
|
|
2372
2518
|
/**
|
|
2373
2519
|
* Can create/edit upload collections
|
|
2374
2520
|
*/
|
|
@@ -2409,6 +2555,10 @@ export type RoleUpdateSchema = {
|
|
|
2409
2555
|
* Can access the build events log
|
|
2410
2556
|
*/
|
|
2411
2557
|
can_access_build_events_log?: boolean;
|
|
2558
|
+
/**
|
|
2559
|
+
* Can access the site search source events log
|
|
2560
|
+
*/
|
|
2561
|
+
can_access_site_search_source_events_log?: boolean;
|
|
2412
2562
|
/**
|
|
2413
2563
|
* Allowed actions on a model (or all) for a role
|
|
2414
2564
|
*/
|
|
@@ -2496,8 +2646,7 @@ export type RoleUpdateSchema = {
|
|
|
2496
2646
|
| 'create'
|
|
2497
2647
|
| 'delete'
|
|
2498
2648
|
| 'edit_creator'
|
|
2499
|
-
| 'replace_asset'
|
|
2500
|
-
| 'move';
|
|
2649
|
+
| 'replace_asset';
|
|
2501
2650
|
/**
|
|
2502
2651
|
* Permitted creator
|
|
2503
2652
|
*/
|
|
@@ -2510,8 +2659,6 @@ export type RoleUpdateSchema = {
|
|
|
2510
2659
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2511
2660
|
*/
|
|
2512
2661
|
locale?: string | null;
|
|
2513
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2514
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2515
2662
|
}[];
|
|
2516
2663
|
/**
|
|
2517
2664
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2528,8 +2675,7 @@ export type RoleUpdateSchema = {
|
|
|
2528
2675
|
| 'create'
|
|
2529
2676
|
| 'delete'
|
|
2530
2677
|
| 'edit_creator'
|
|
2531
|
-
| 'replace_asset'
|
|
2532
|
-
| 'move';
|
|
2678
|
+
| 'replace_asset';
|
|
2533
2679
|
/**
|
|
2534
2680
|
* Permitted creator
|
|
2535
2681
|
*/
|
|
@@ -2542,8 +2688,6 @@ export type RoleUpdateSchema = {
|
|
|
2542
2688
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2543
2689
|
*/
|
|
2544
2690
|
locale?: string | null;
|
|
2545
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2546
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2547
2691
|
}[];
|
|
2548
2692
|
/**
|
|
2549
2693
|
* Allowed build triggers for a role
|
|
@@ -2557,6 +2701,18 @@ export type RoleUpdateSchema = {
|
|
|
2557
2701
|
negative_build_trigger_permissions?: {
|
|
2558
2702
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2559
2703
|
}[];
|
|
2704
|
+
/**
|
|
2705
|
+
* Allowed site search sources for a role
|
|
2706
|
+
*/
|
|
2707
|
+
positive_site_search_source_permissions?: {
|
|
2708
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2709
|
+
}[];
|
|
2710
|
+
/**
|
|
2711
|
+
* Prohibited site search sources for a role
|
|
2712
|
+
*/
|
|
2713
|
+
negative_site_search_source_permissions?: {
|
|
2714
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2715
|
+
}[];
|
|
2560
2716
|
};
|
|
2561
2717
|
/**
|
|
2562
2718
|
* JSON API links
|
|
@@ -3323,6 +3479,10 @@ export type SitePlanAttributes = {
|
|
|
3323
3479
|
* Number of build triggers
|
|
3324
3480
|
*/
|
|
3325
3481
|
build_triggers: null | number;
|
|
3482
|
+
/**
|
|
3483
|
+
* Number of site search sources
|
|
3484
|
+
*/
|
|
3485
|
+
site_search_sources: null | number;
|
|
3326
3486
|
/**
|
|
3327
3487
|
* Number of plugins
|
|
3328
3488
|
*/
|
|
@@ -3487,6 +3647,10 @@ export type SitePlanAttributes = {
|
|
|
3487
3647
|
amount_per_packet: number;
|
|
3488
3648
|
price: number;
|
|
3489
3649
|
};
|
|
3650
|
+
site_search_sources?: {
|
|
3651
|
+
amount_per_packet: number;
|
|
3652
|
+
price: number;
|
|
3653
|
+
};
|
|
3490
3654
|
access_tokens?: {
|
|
3491
3655
|
amount_per_packet: number;
|
|
3492
3656
|
price: number;
|
|
@@ -4771,6 +4935,13 @@ export type ItemTypeDestroyTargetSchema = {
|
|
|
4771
4935
|
export type ItemTypeDestroyJobSchema = {
|
|
4772
4936
|
data: ItemType;
|
|
4773
4937
|
};
|
|
4938
|
+
/**
|
|
4939
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4940
|
+
* via the `referencing.targetSchema` link.
|
|
4941
|
+
*/
|
|
4942
|
+
export type ItemTypeReferencingTargetSchema = {
|
|
4943
|
+
data: ItemType[];
|
|
4944
|
+
};
|
|
4774
4945
|
/**
|
|
4775
4946
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4776
4947
|
* via the `reorder_fields_and_fieldsets.schema` link.
|
|
@@ -4944,11 +5115,11 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
|
|
|
4944
5115
|
* <details>
|
|
4945
5116
|
* <summary>Multi-line text (<code>text</code>)</summary>
|
|
4946
5117
|
*
|
|
4947
|
-
* | Property | Value
|
|
4948
|
-
* | ------------------------------ |
|
|
4949
|
-
* | Code | `text`
|
|
4950
|
-
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea`
|
|
4951
|
-
* | Available validators | `required`, `length`, `format`, `
|
|
5118
|
+
* | Property | Value |
|
|
5119
|
+
* | ------------------------------ | ------------------------------------------------ |
|
|
5120
|
+
* | Code | `text` |
|
|
5121
|
+
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
|
|
5122
|
+
* | Available validators | `required`, `length`, `format`, `sanitized_html` |
|
|
4952
5123
|
*
|
|
4953
5124
|
* </details>
|
|
4954
5125
|
*
|
|
@@ -5054,11 +5225,11 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
|
|
|
5054
5225
|
* <details>
|
|
5055
5226
|
* <summary>Slug (<code>slug</code>)</summary>
|
|
5056
5227
|
*
|
|
5057
|
-
* | Property | Value
|
|
5058
|
-
* | ------------------------------ |
|
|
5059
|
-
* | Code | `slug`
|
|
5060
|
-
* | Built-in editors for the field | `slug`
|
|
5061
|
-
* | Available validators | `required`, `length`, `slug_format`, `slug_title_field` |
|
|
5228
|
+
* | Property | Value |
|
|
5229
|
+
* | ------------------------------ | ----------------------------------------------------------------- |
|
|
5230
|
+
* | Code | `slug` |
|
|
5231
|
+
* | Built-in editors for the field | `slug` |
|
|
5232
|
+
* | Available validators | `required`, `unique`, `length`, `slug_format`, `slug_title_field` |
|
|
5062
5233
|
*
|
|
5063
5234
|
* </details>
|
|
5064
5235
|
*
|
|
@@ -5148,12 +5319,12 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
|
|
|
5148
5319
|
* <details>
|
|
5149
5320
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
5150
5321
|
*
|
|
5151
|
-
* | Property | Value
|
|
5152
|
-
* | ------------------------------ |
|
|
5153
|
-
* | Code | `structured_text`
|
|
5154
|
-
* | Built-in editors for the field | `structured_text`
|
|
5155
|
-
* | Required validators | `structured_text_blocks`, `structured_text_links`
|
|
5156
|
-
* | Other validators available | `length`, `structured_text_inline_blocks`
|
|
5322
|
+
* | Property | Value |
|
|
5323
|
+
* | ------------------------------ | ----------------------------------------------------- |
|
|
5324
|
+
* | Code | `structured_text` |
|
|
5325
|
+
* | Built-in editors for the field | `structured_text` |
|
|
5326
|
+
* | Required validators | `structured_text_blocks`, `structured_text_links` |
|
|
5327
|
+
* | Other validators available | `required`, `length`, `structured_text_inline_blocks` |
|
|
5157
5328
|
*
|
|
5158
5329
|
* </details>
|
|
5159
5330
|
*
|
|
@@ -5467,9 +5638,9 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
|
|
|
5467
5638
|
* </details>
|
|
5468
5639
|
*
|
|
5469
5640
|
* <details>
|
|
5470
|
-
* <summary><code>
|
|
5641
|
+
* <summary><code>sanitized_html</code></summary>
|
|
5471
5642
|
*
|
|
5472
|
-
* Checks for the presence of malicious
|
|
5643
|
+
* Checks for the presence of malicious code in HTML fields: content is valid if no dangerous code is present.
|
|
5473
5644
|
*
|
|
5474
5645
|
* | Parameter | Type | Required | Description |
|
|
5475
5646
|
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
@@ -5696,10 +5867,10 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
|
|
|
5696
5867
|
*
|
|
5697
5868
|
* Built-in editor for _seo_ fields.
|
|
5698
5869
|
*
|
|
5699
|
-
* | Parameter | Type | Required | Description
|
|
5700
|
-
* | ---------- | --------------- | -------- |
|
|
5701
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
5702
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"
|
|
5870
|
+
* | Parameter | Type | Required | Description |
|
|
5871
|
+
* | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5872
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5873
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
5703
5874
|
*
|
|
5704
5875
|
* </details>
|
|
5705
5876
|
*
|
|
@@ -5896,7 +6067,6 @@ export type FieldAttributesStableShell = {
|
|
|
5896
6067
|
};
|
|
5897
6068
|
[k: string]: unknown;
|
|
5898
6069
|
}[];
|
|
5899
|
-
[k: string]: unknown;
|
|
5900
6070
|
};
|
|
5901
6071
|
/**
|
|
5902
6072
|
* Ordering index
|
|
@@ -6026,7 +6196,6 @@ export type FieldCreateSchemaStableShell = {
|
|
|
6026
6196
|
};
|
|
6027
6197
|
[k: string]: unknown;
|
|
6028
6198
|
}[];
|
|
6029
|
-
[k: string]: unknown;
|
|
6030
6199
|
};
|
|
6031
6200
|
/**
|
|
6032
6201
|
* Ordering index
|
|
@@ -6163,7 +6332,6 @@ export type FieldUpdateSchemaStableShell = {
|
|
|
6163
6332
|
};
|
|
6164
6333
|
[k: string]: unknown;
|
|
6165
6334
|
}[];
|
|
6166
|
-
[k: string]: unknown;
|
|
6167
6335
|
};
|
|
6168
6336
|
/**
|
|
6169
6337
|
* Ordering index
|
|
@@ -6953,10 +7121,7 @@ export type BuildEventAttributes = {
|
|
|
6953
7121
|
| 'response_success'
|
|
6954
7122
|
| 'response_failure'
|
|
6955
7123
|
| 'request_aborted'
|
|
6956
|
-
| 'response_unprocessable'
|
|
6957
|
-
| 'indexing_started'
|
|
6958
|
-
| 'indexing_success'
|
|
6959
|
-
| 'indexing_failure';
|
|
7124
|
+
| 'response_unprocessable';
|
|
6960
7125
|
/**
|
|
6961
7126
|
* The moment the activity occurred
|
|
6962
7127
|
*/
|
|
@@ -7019,6 +7184,95 @@ export type BuildEventInstancesTargetSchema = {
|
|
|
7019
7184
|
export type BuildEventSelfTargetSchema = {
|
|
7020
7185
|
data: BuildEvent;
|
|
7021
7186
|
};
|
|
7187
|
+
/**
|
|
7188
|
+
* Represents an event occurred during the site search indexing process.
|
|
7189
|
+
*
|
|
7190
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7191
|
+
* via the `definition` "site_search_source_event".
|
|
7192
|
+
*/
|
|
7193
|
+
export type SiteSearchSourceEvent = {
|
|
7194
|
+
type: SiteSearchSourceEventType;
|
|
7195
|
+
id: SiteSearchSourceEventIdentity;
|
|
7196
|
+
attributes: SiteSearchSourceEventAttributes;
|
|
7197
|
+
relationships: SiteSearchSourceEventRelationships;
|
|
7198
|
+
};
|
|
7199
|
+
/**
|
|
7200
|
+
* JSON API attributes
|
|
7201
|
+
*
|
|
7202
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7203
|
+
* via the `definition` "attributes".
|
|
7204
|
+
*/
|
|
7205
|
+
export type SiteSearchSourceEventAttributes = {
|
|
7206
|
+
/**
|
|
7207
|
+
* The type of activity
|
|
7208
|
+
*/
|
|
7209
|
+
event_type:
|
|
7210
|
+
| 'indexing_started'
|
|
7211
|
+
| 'indexing_success'
|
|
7212
|
+
| 'indexing_failure'
|
|
7213
|
+
| 'indexing_aborted';
|
|
7214
|
+
/**
|
|
7215
|
+
* The moment the activity occurred
|
|
7216
|
+
*/
|
|
7217
|
+
created_at: string;
|
|
7218
|
+
/**
|
|
7219
|
+
* Any details regarding the event
|
|
7220
|
+
*/
|
|
7221
|
+
data: {
|
|
7222
|
+
[k: string]: unknown;
|
|
7223
|
+
};
|
|
7224
|
+
};
|
|
7225
|
+
/**
|
|
7226
|
+
* JSON API links
|
|
7227
|
+
*
|
|
7228
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7229
|
+
* via the `definition` "relationships".
|
|
7230
|
+
*/
|
|
7231
|
+
export type SiteSearchSourceEventRelationships = {
|
|
7232
|
+
/**
|
|
7233
|
+
* Source site search source
|
|
7234
|
+
*/
|
|
7235
|
+
site_search_source: {
|
|
7236
|
+
data: SiteSearchSourceData;
|
|
7237
|
+
};
|
|
7238
|
+
};
|
|
7239
|
+
/**
|
|
7240
|
+
* JSON API data
|
|
7241
|
+
*
|
|
7242
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
7243
|
+
* via the `definition` "data".
|
|
7244
|
+
*/
|
|
7245
|
+
export type SiteSearchSourceData = {
|
|
7246
|
+
type: SiteSearchSourceType;
|
|
7247
|
+
id: SiteSearchSourceIdentity;
|
|
7248
|
+
};
|
|
7249
|
+
/**
|
|
7250
|
+
* JSON API data
|
|
7251
|
+
*
|
|
7252
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7253
|
+
* via the `definition` "data".
|
|
7254
|
+
*/
|
|
7255
|
+
export type SiteSearchSourceEventData = {
|
|
7256
|
+
type: SiteSearchSourceEventType;
|
|
7257
|
+
id: SiteSearchSourceEventIdentity;
|
|
7258
|
+
};
|
|
7259
|
+
/**
|
|
7260
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7261
|
+
* via the `instances.targetSchema` link.
|
|
7262
|
+
*/
|
|
7263
|
+
export type SiteSearchSourceEventInstancesTargetSchema = {
|
|
7264
|
+
data: SiteSearchSourceEvent[];
|
|
7265
|
+
meta: {
|
|
7266
|
+
total_count: number;
|
|
7267
|
+
};
|
|
7268
|
+
};
|
|
7269
|
+
/**
|
|
7270
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7271
|
+
* via the `self.targetSchema` link.
|
|
7272
|
+
*/
|
|
7273
|
+
export type SiteSearchSourceEventSelfTargetSchema = {
|
|
7274
|
+
data: SiteSearchSourceEvent;
|
|
7275
|
+
};
|
|
7022
7276
|
/**
|
|
7023
7277
|
* JSON API links
|
|
7024
7278
|
*
|
|
@@ -8686,14 +8940,6 @@ export type UploadRequestCreateSchema = {
|
|
|
8686
8940
|
filename?: string;
|
|
8687
8941
|
[k: string]: unknown;
|
|
8688
8942
|
};
|
|
8689
|
-
relationships?: {
|
|
8690
|
-
/**
|
|
8691
|
-
* Upload collection to which the asset belongs
|
|
8692
|
-
*/
|
|
8693
|
-
upload_collection?: {
|
|
8694
|
-
data: UploadCollectionData | null;
|
|
8695
|
-
};
|
|
8696
|
-
};
|
|
8697
8943
|
};
|
|
8698
8944
|
};
|
|
8699
8945
|
/**
|
|
@@ -9666,6 +9912,10 @@ export type BuildTriggerAttributes = {
|
|
|
9666
9912
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9667
9913
|
*/
|
|
9668
9914
|
indexing_enabled: boolean;
|
|
9915
|
+
/**
|
|
9916
|
+
* Whether the build trigger is enabled or not
|
|
9917
|
+
*/
|
|
9918
|
+
enabled: boolean;
|
|
9669
9919
|
};
|
|
9670
9920
|
/**
|
|
9671
9921
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
@@ -9711,6 +9961,10 @@ export type BuildTriggerCreateSchema = {
|
|
|
9711
9961
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9712
9962
|
*/
|
|
9713
9963
|
indexing_enabled: boolean;
|
|
9964
|
+
/**
|
|
9965
|
+
* Whether the build trigger is enabled or not
|
|
9966
|
+
*/
|
|
9967
|
+
enabled?: boolean;
|
|
9714
9968
|
/**
|
|
9715
9969
|
* The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
|
|
9716
9970
|
*/
|
|
@@ -9762,6 +10016,10 @@ export type BuildTriggerUpdateSchema = {
|
|
|
9762
10016
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9763
10017
|
*/
|
|
9764
10018
|
indexing_enabled?: boolean;
|
|
10019
|
+
/**
|
|
10020
|
+
* Whether the build trigger is enabled or not
|
|
10021
|
+
*/
|
|
10022
|
+
enabled?: boolean;
|
|
9765
10023
|
/**
|
|
9766
10024
|
* The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
|
|
9767
10025
|
*/
|
|
@@ -9793,6 +10051,185 @@ export type BuildTriggerUpdateTargetSchema = {
|
|
|
9793
10051
|
export type BuildTriggerDestroyTargetSchema = {
|
|
9794
10052
|
data: BuildTrigger;
|
|
9795
10053
|
};
|
|
10054
|
+
/**
|
|
10055
|
+
* A Site Search Source represents a website that should be indexed by DatoCMS Site Search. When enabled, DatoCMS will periodically spider the website to update the search index.
|
|
10056
|
+
*
|
|
10057
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
10058
|
+
* via the `definition` "site_search_source".
|
|
10059
|
+
*/
|
|
10060
|
+
export type SiteSearchSource = {
|
|
10061
|
+
type: SiteSearchSourceType;
|
|
10062
|
+
id: SiteSearchSourceIdentity;
|
|
10063
|
+
attributes: SiteSearchSourceAttributes;
|
|
10064
|
+
relationships: SiteSearchSourceRelationships;
|
|
10065
|
+
meta: SiteSearchSourceMeta;
|
|
10066
|
+
};
|
|
10067
|
+
/**
|
|
10068
|
+
* JSON API attributes
|
|
10069
|
+
*
|
|
10070
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10071
|
+
* via the `definition` "attributes".
|
|
10072
|
+
*/
|
|
10073
|
+
export type SiteSearchSourceAttributes = {
|
|
10074
|
+
/**
|
|
10075
|
+
* Name of the site search source
|
|
10076
|
+
*/
|
|
10077
|
+
name: string;
|
|
10078
|
+
/**
|
|
10079
|
+
* Whether the site search source is enabled or not
|
|
10080
|
+
*/
|
|
10081
|
+
enabled: boolean;
|
|
10082
|
+
/**
|
|
10083
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
10084
|
+
*/
|
|
10085
|
+
build_trigger_indexing_enabled: boolean;
|
|
10086
|
+
/**
|
|
10087
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10088
|
+
*/
|
|
10089
|
+
frontend_url: string | null;
|
|
10090
|
+
};
|
|
10091
|
+
/**
|
|
10092
|
+
* JSON API links
|
|
10093
|
+
*
|
|
10094
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10095
|
+
* via the `definition` "relationships".
|
|
10096
|
+
*/
|
|
10097
|
+
export type SiteSearchSourceRelationships = {
|
|
10098
|
+
/**
|
|
10099
|
+
* The build triggers connected to this site search source
|
|
10100
|
+
*/
|
|
10101
|
+
build_triggers: {
|
|
10102
|
+
data: BuildTriggerData[];
|
|
10103
|
+
};
|
|
10104
|
+
};
|
|
10105
|
+
/**
|
|
10106
|
+
* Meta information about the site search source
|
|
10107
|
+
*
|
|
10108
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10109
|
+
* via the `definition` "meta".
|
|
10110
|
+
*/
|
|
10111
|
+
export type SiteSearchSourceMeta = {
|
|
10112
|
+
/**
|
|
10113
|
+
* Status of the site search indexing
|
|
10114
|
+
*/
|
|
10115
|
+
indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
|
|
10116
|
+
/**
|
|
10117
|
+
* Timestamp of the last completed indexing
|
|
10118
|
+
*/
|
|
10119
|
+
last_indexing_completed_at: string | null;
|
|
10120
|
+
};
|
|
10121
|
+
/**
|
|
10122
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10123
|
+
* via the `instances.targetSchema` link.
|
|
10124
|
+
*/
|
|
10125
|
+
export type SiteSearchSourceInstancesTargetSchema = {
|
|
10126
|
+
data: SiteSearchSource[];
|
|
10127
|
+
};
|
|
10128
|
+
/**
|
|
10129
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10130
|
+
* via the `self.targetSchema` link.
|
|
10131
|
+
*/
|
|
10132
|
+
export type SiteSearchSourceSelfTargetSchema = {
|
|
10133
|
+
data: SiteSearchSource;
|
|
10134
|
+
};
|
|
10135
|
+
/**
|
|
10136
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10137
|
+
* via the `create.schema` link.
|
|
10138
|
+
*/
|
|
10139
|
+
export type SiteSearchSourceCreateSchema = {
|
|
10140
|
+
data: {
|
|
10141
|
+
type: SiteSearchSourceType;
|
|
10142
|
+
attributes: {
|
|
10143
|
+
/**
|
|
10144
|
+
* Name of the site search source
|
|
10145
|
+
*/
|
|
10146
|
+
name: string;
|
|
10147
|
+
/**
|
|
10148
|
+
* Whether the site search source is enabled or not
|
|
10149
|
+
*/
|
|
10150
|
+
enabled: boolean;
|
|
10151
|
+
/**
|
|
10152
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
10153
|
+
*/
|
|
10154
|
+
build_trigger_indexing_enabled?: boolean;
|
|
10155
|
+
/**
|
|
10156
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10157
|
+
*/
|
|
10158
|
+
frontend_url: string | null;
|
|
10159
|
+
};
|
|
10160
|
+
/**
|
|
10161
|
+
* JSON API links
|
|
10162
|
+
*/
|
|
10163
|
+
relationships?: {
|
|
10164
|
+
/**
|
|
10165
|
+
* The build triggers connected to this site search source
|
|
10166
|
+
*/
|
|
10167
|
+
build_triggers?: {
|
|
10168
|
+
data: BuildTriggerData[];
|
|
10169
|
+
};
|
|
10170
|
+
};
|
|
10171
|
+
};
|
|
10172
|
+
};
|
|
10173
|
+
/**
|
|
10174
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10175
|
+
* via the `create.targetSchema` link.
|
|
10176
|
+
*/
|
|
10177
|
+
export type SiteSearchSourceCreateTargetSchema = {
|
|
10178
|
+
data: SiteSearchSource;
|
|
10179
|
+
};
|
|
10180
|
+
/**
|
|
10181
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10182
|
+
* via the `update.schema` link.
|
|
10183
|
+
*/
|
|
10184
|
+
export type SiteSearchSourceUpdateSchema = {
|
|
10185
|
+
data: {
|
|
10186
|
+
type: SiteSearchSourceType;
|
|
10187
|
+
id: SiteSearchSourceIdentity;
|
|
10188
|
+
attributes: {
|
|
10189
|
+
/**
|
|
10190
|
+
* Name of the site search source
|
|
10191
|
+
*/
|
|
10192
|
+
name?: string;
|
|
10193
|
+
/**
|
|
10194
|
+
* Whether the site search source is enabled or not
|
|
10195
|
+
*/
|
|
10196
|
+
enabled?: boolean;
|
|
10197
|
+
/**
|
|
10198
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
10199
|
+
*/
|
|
10200
|
+
build_trigger_indexing_enabled?: boolean;
|
|
10201
|
+
/**
|
|
10202
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10203
|
+
*/
|
|
10204
|
+
frontend_url?: string | null;
|
|
10205
|
+
};
|
|
10206
|
+
/**
|
|
10207
|
+
* JSON API links
|
|
10208
|
+
*/
|
|
10209
|
+
relationships?: {
|
|
10210
|
+
/**
|
|
10211
|
+
* The build triggers connected to this site search source
|
|
10212
|
+
*/
|
|
10213
|
+
build_triggers?: {
|
|
10214
|
+
data: BuildTriggerData[];
|
|
10215
|
+
};
|
|
10216
|
+
};
|
|
10217
|
+
};
|
|
10218
|
+
};
|
|
10219
|
+
/**
|
|
10220
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10221
|
+
* via the `update.targetSchema` link.
|
|
10222
|
+
*/
|
|
10223
|
+
export type SiteSearchSourceUpdateTargetSchema = {
|
|
10224
|
+
data: SiteSearchSource;
|
|
10225
|
+
};
|
|
10226
|
+
/**
|
|
10227
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10228
|
+
* via the `destroy.targetSchema` link.
|
|
10229
|
+
*/
|
|
10230
|
+
export type SiteSearchSourceDestroyTargetSchema = {
|
|
10231
|
+
data: SiteSearchSource;
|
|
10232
|
+
};
|
|
9796
10233
|
/**
|
|
9797
10234
|
* In DatoCMS you can create filters to help you (and other editors) quickly search for records
|
|
9798
10235
|
*
|