@datocms/cma-client 5.2.0-alpha.0 → 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/index.d.ts +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/index.d.ts +1 -1
- 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/index.ts +1 -1
- 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
|
@@ -73,25 +73,25 @@ export type WorkflowIdentity = string;
|
|
|
73
73
|
*/
|
|
74
74
|
export type EnvironmentIdentity = string;
|
|
75
75
|
/**
|
|
76
|
-
*
|
|
76
|
+
* ID of build_trigger
|
|
77
77
|
*
|
|
78
|
-
* This interface was referenced by `
|
|
78
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
79
79
|
* via the `definition` "identity".
|
|
80
80
|
*
|
|
81
|
-
* This interface was referenced by `
|
|
81
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
82
82
|
* via the `definition` "id".
|
|
83
83
|
*/
|
|
84
|
-
export type
|
|
84
|
+
export type BuildTriggerIdentity = string;
|
|
85
85
|
/**
|
|
86
|
-
* ID of
|
|
86
|
+
* ID of site_search_source
|
|
87
87
|
*
|
|
88
|
-
* This interface was referenced by `
|
|
88
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
89
89
|
* via the `definition` "identity".
|
|
90
90
|
*
|
|
91
|
-
* This interface was referenced by `
|
|
91
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
92
92
|
* via the `definition` "id".
|
|
93
93
|
*/
|
|
94
|
-
export type
|
|
94
|
+
export type SiteSearchSourceIdentity = string;
|
|
95
95
|
/**
|
|
96
96
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
97
97
|
* via the `instances.targetSchema` link.
|
|
@@ -451,6 +451,16 @@ export type SchemaMenuItemReorderSchema = {
|
|
|
451
451
|
* via the `reorder.jobSchema` link.
|
|
452
452
|
*/
|
|
453
453
|
export type SchemaMenuItemReorderJobSchema = SchemaMenuItem[];
|
|
454
|
+
/**
|
|
455
|
+
* RFC 4122 UUID of upload collection expressed in URL-safe base64 format
|
|
456
|
+
*
|
|
457
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
458
|
+
* via the `definition` "identity".
|
|
459
|
+
*
|
|
460
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
461
|
+
* via the `definition` "id".
|
|
462
|
+
*/
|
|
463
|
+
export type UploadCollectionIdentity = string;
|
|
454
464
|
/**
|
|
455
465
|
* JSON API type field
|
|
456
466
|
*
|
|
@@ -578,6 +588,11 @@ export type ItemTypeDestroyHrefSchema = {
|
|
|
578
588
|
skip_menu_items_deletion?: boolean;
|
|
579
589
|
[k: string]: unknown;
|
|
580
590
|
};
|
|
591
|
+
/**
|
|
592
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
593
|
+
* via the `referencing.targetSchema` link.
|
|
594
|
+
*/
|
|
595
|
+
export type ItemTypeReferencingTargetSchema = ItemType[];
|
|
581
596
|
/**
|
|
582
597
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
583
598
|
* via the `reorder_fields_and_fieldsets.schema` link.
|
|
@@ -777,7 +792,7 @@ export type BuildEventInstancesHrefSchema = {
|
|
|
777
792
|
/**
|
|
778
793
|
* The type of activity
|
|
779
794
|
*/
|
|
780
|
-
eq?: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable'
|
|
795
|
+
eq?: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable';
|
|
781
796
|
};
|
|
782
797
|
created_at?: {
|
|
783
798
|
gt?: string;
|
|
@@ -791,6 +806,79 @@ export type BuildEventInstancesHrefSchema = {
|
|
|
791
806
|
order_by?: 'build_trigger_id_asc' | 'build_trigger_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
|
|
792
807
|
[k: string]: unknown;
|
|
793
808
|
};
|
|
809
|
+
/**
|
|
810
|
+
* ID of site search source event
|
|
811
|
+
*
|
|
812
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
813
|
+
* via the `definition` "identity".
|
|
814
|
+
*
|
|
815
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
816
|
+
* via the `definition` "id".
|
|
817
|
+
*/
|
|
818
|
+
export type SiteSearchSourceEventIdentity = string;
|
|
819
|
+
/**
|
|
820
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
821
|
+
* via the `definition` "type".
|
|
822
|
+
*/
|
|
823
|
+
export type SiteSearchSourceEventType = 'site_search_source_event';
|
|
824
|
+
/**
|
|
825
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
826
|
+
* via the `definition` "type".
|
|
827
|
+
*/
|
|
828
|
+
export type SiteSearchSourceType = 'site_search_source';
|
|
829
|
+
/**
|
|
830
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
831
|
+
* via the `instances.targetSchema` link.
|
|
832
|
+
*/
|
|
833
|
+
export type SiteSearchSourceEventInstancesTargetSchema = SiteSearchSourceEvent[];
|
|
834
|
+
/**
|
|
835
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
836
|
+
* via the `instances.hrefSchema` link.
|
|
837
|
+
*/
|
|
838
|
+
export type SiteSearchSourceEventInstancesHrefSchema = {
|
|
839
|
+
/**
|
|
840
|
+
* Parameters to control offset-based pagination
|
|
841
|
+
*/
|
|
842
|
+
page?: {
|
|
843
|
+
/**
|
|
844
|
+
* The (zero-based) offset of the first entity returned in the collection (defaults to 0)
|
|
845
|
+
*/
|
|
846
|
+
offset?: number;
|
|
847
|
+
/**
|
|
848
|
+
* The maximum number of entities to return (defaults to 30, maximum is 500)
|
|
849
|
+
*/
|
|
850
|
+
limit?: number;
|
|
851
|
+
};
|
|
852
|
+
/**
|
|
853
|
+
* Attributes to filter
|
|
854
|
+
*/
|
|
855
|
+
filter?: {
|
|
856
|
+
/**
|
|
857
|
+
* IDs to fetch, comma separated
|
|
858
|
+
*/
|
|
859
|
+
ids?: string;
|
|
860
|
+
fields?: {
|
|
861
|
+
site_search_source_id?: {
|
|
862
|
+
eq?: string;
|
|
863
|
+
};
|
|
864
|
+
event_type?: {
|
|
865
|
+
/**
|
|
866
|
+
* The type of activity
|
|
867
|
+
*/
|
|
868
|
+
eq?: 'indexing_started' | 'indexing_success' | 'indexing_failure' | 'indexing_aborted';
|
|
869
|
+
};
|
|
870
|
+
created_at?: {
|
|
871
|
+
gt?: string;
|
|
872
|
+
lt?: string;
|
|
873
|
+
};
|
|
874
|
+
};
|
|
875
|
+
};
|
|
876
|
+
/**
|
|
877
|
+
* Fields used to order results
|
|
878
|
+
*/
|
|
879
|
+
order_by?: 'site_search_source_id_asc' | 'site_search_source_id_desc' | 'created_at_asc' | 'created_at_desc' | 'event_type_asc' | 'event_type_desc';
|
|
880
|
+
[k: string]: unknown;
|
|
881
|
+
};
|
|
794
882
|
/**
|
|
795
883
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
796
884
|
* via the `instances.targetSchema` link.
|
|
@@ -1058,6 +1146,17 @@ export type ItemVersionInstancesHrefSchema = {
|
|
|
1058
1146
|
};
|
|
1059
1147
|
[k: string]: unknown;
|
|
1060
1148
|
};
|
|
1149
|
+
/**
|
|
1150
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
1151
|
+
* via the `self.hrefSchema` link.
|
|
1152
|
+
*/
|
|
1153
|
+
export type ItemVersionSelfHrefSchema = {
|
|
1154
|
+
/**
|
|
1155
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
1156
|
+
*/
|
|
1157
|
+
nested?: boolean;
|
|
1158
|
+
[k: string]: unknown;
|
|
1159
|
+
};
|
|
1061
1160
|
/**
|
|
1062
1161
|
* RFC 4122 UUID of upload expressed in URL-safe base64 format
|
|
1063
1162
|
*
|
|
@@ -1247,7 +1346,11 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
1247
1346
|
*/
|
|
1248
1347
|
query: string;
|
|
1249
1348
|
/**
|
|
1250
|
-
* The
|
|
1349
|
+
* 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.
|
|
1350
|
+
*/
|
|
1351
|
+
site_search_source_id?: string;
|
|
1352
|
+
/**
|
|
1353
|
+
* **[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.
|
|
1251
1354
|
*/
|
|
1252
1355
|
build_trigger_id?: string;
|
|
1253
1356
|
/**
|
|
@@ -1436,6 +1539,11 @@ export type WebhookCallInstancesHrefSchema = {
|
|
|
1436
1539
|
* via the `instances.targetSchema` link.
|
|
1437
1540
|
*/
|
|
1438
1541
|
export type BuildTriggerInstancesTargetSchema = BuildTrigger[];
|
|
1542
|
+
/**
|
|
1543
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
1544
|
+
* via the `instances.targetSchema` link.
|
|
1545
|
+
*/
|
|
1546
|
+
export type SiteSearchSourceInstancesTargetSchema = SiteSearchSource[];
|
|
1439
1547
|
/**
|
|
1440
1548
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
1441
1549
|
* via the `instances.targetSchema` link.
|
|
@@ -1858,6 +1966,10 @@ export type Role = {
|
|
|
1858
1966
|
* Can create/edit Build triggers
|
|
1859
1967
|
*/
|
|
1860
1968
|
can_manage_build_triggers: boolean;
|
|
1969
|
+
/**
|
|
1970
|
+
* Can create/edit Site Search Sources
|
|
1971
|
+
*/
|
|
1972
|
+
can_manage_site_search_sources: boolean;
|
|
1861
1973
|
/**
|
|
1862
1974
|
* Can create/edit webhooks
|
|
1863
1975
|
*/
|
|
@@ -1890,6 +2002,10 @@ export type Role = {
|
|
|
1890
2002
|
* Can access the build events log
|
|
1891
2003
|
*/
|
|
1892
2004
|
can_access_build_events_log: boolean;
|
|
2005
|
+
/**
|
|
2006
|
+
* Can access the site search source events log
|
|
2007
|
+
*/
|
|
2008
|
+
can_access_site_search_source_events_log: boolean;
|
|
1893
2009
|
/**
|
|
1894
2010
|
* Allowed actions on a model (or all) for a role
|
|
1895
2011
|
*/
|
|
@@ -1950,7 +2066,7 @@ export type Role = {
|
|
|
1950
2066
|
/**
|
|
1951
2067
|
* Permitted action
|
|
1952
2068
|
*/
|
|
1953
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2069
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
1954
2070
|
/**
|
|
1955
2071
|
* Permitted creator
|
|
1956
2072
|
*/
|
|
@@ -1963,8 +2079,6 @@ export type Role = {
|
|
|
1963
2079
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
1964
2080
|
*/
|
|
1965
2081
|
locale?: string | null;
|
|
1966
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
1967
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
1968
2082
|
}[];
|
|
1969
2083
|
/**
|
|
1970
2084
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -1974,7 +2088,7 @@ export type Role = {
|
|
|
1974
2088
|
/**
|
|
1975
2089
|
* Permitted action
|
|
1976
2090
|
*/
|
|
1977
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2091
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
1978
2092
|
/**
|
|
1979
2093
|
* Permitted creator
|
|
1980
2094
|
*/
|
|
@@ -1987,8 +2101,6 @@ export type Role = {
|
|
|
1987
2101
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
1988
2102
|
*/
|
|
1989
2103
|
locale?: string | null;
|
|
1990
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
1991
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
1992
2104
|
}[];
|
|
1993
2105
|
/**
|
|
1994
2106
|
* Allowed build triggers for a role
|
|
@@ -2002,6 +2114,18 @@ export type Role = {
|
|
|
2002
2114
|
negative_build_trigger_permissions: {
|
|
2003
2115
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2004
2116
|
}[];
|
|
2117
|
+
/**
|
|
2118
|
+
* Allowed site search sources for a role
|
|
2119
|
+
*/
|
|
2120
|
+
positive_site_search_source_permissions: {
|
|
2121
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2122
|
+
}[];
|
|
2123
|
+
/**
|
|
2124
|
+
* Prohibited site search sources for a role
|
|
2125
|
+
*/
|
|
2126
|
+
negative_site_search_source_permissions: {
|
|
2127
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2128
|
+
}[];
|
|
2005
2129
|
inherits_permissions_from: RoleData[];
|
|
2006
2130
|
meta: RoleMeta;
|
|
2007
2131
|
};
|
|
@@ -2075,6 +2199,10 @@ export type RoleMeta = {
|
|
|
2075
2199
|
* Can create/edit Build triggers
|
|
2076
2200
|
*/
|
|
2077
2201
|
can_manage_build_triggers: boolean;
|
|
2202
|
+
/**
|
|
2203
|
+
* Can create/edit Site Search Sources
|
|
2204
|
+
*/
|
|
2205
|
+
can_manage_site_search_sources: boolean;
|
|
2078
2206
|
/**
|
|
2079
2207
|
* Can create/edit webhooks
|
|
2080
2208
|
*/
|
|
@@ -2107,6 +2235,10 @@ export type RoleMeta = {
|
|
|
2107
2235
|
* Can access the build events log
|
|
2108
2236
|
*/
|
|
2109
2237
|
can_access_build_events_log: boolean;
|
|
2238
|
+
/**
|
|
2239
|
+
* Can access the site search source events log
|
|
2240
|
+
*/
|
|
2241
|
+
can_access_site_search_source_events_log: boolean;
|
|
2110
2242
|
/**
|
|
2111
2243
|
* Allowed actions on a model (or all) for a role
|
|
2112
2244
|
*/
|
|
@@ -2167,7 +2299,7 @@ export type RoleMeta = {
|
|
|
2167
2299
|
/**
|
|
2168
2300
|
* Permitted action
|
|
2169
2301
|
*/
|
|
2170
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2302
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2171
2303
|
/**
|
|
2172
2304
|
* Permitted creator
|
|
2173
2305
|
*/
|
|
@@ -2180,8 +2312,6 @@ export type RoleMeta = {
|
|
|
2180
2312
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2181
2313
|
*/
|
|
2182
2314
|
locale?: string | null;
|
|
2183
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2184
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2185
2315
|
}[];
|
|
2186
2316
|
/**
|
|
2187
2317
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2191,7 +2321,7 @@ export type RoleMeta = {
|
|
|
2191
2321
|
/**
|
|
2192
2322
|
* Permitted action
|
|
2193
2323
|
*/
|
|
2194
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2324
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2195
2325
|
/**
|
|
2196
2326
|
* Permitted creator
|
|
2197
2327
|
*/
|
|
@@ -2204,8 +2334,6 @@ export type RoleMeta = {
|
|
|
2204
2334
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2205
2335
|
*/
|
|
2206
2336
|
locale?: string | null;
|
|
2207
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2208
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2209
2337
|
}[];
|
|
2210
2338
|
/**
|
|
2211
2339
|
* Allowed build triggers for a role
|
|
@@ -2219,6 +2347,18 @@ export type RoleMeta = {
|
|
|
2219
2347
|
negative_build_trigger_permissions: {
|
|
2220
2348
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2221
2349
|
}[];
|
|
2350
|
+
/**
|
|
2351
|
+
* Allowed site search sources for a role
|
|
2352
|
+
*/
|
|
2353
|
+
positive_site_search_source_permissions: {
|
|
2354
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2355
|
+
}[];
|
|
2356
|
+
/**
|
|
2357
|
+
* Prohibited site search sources for a role
|
|
2358
|
+
*/
|
|
2359
|
+
negative_site_search_source_permissions: {
|
|
2360
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2361
|
+
}[];
|
|
2222
2362
|
};
|
|
2223
2363
|
};
|
|
2224
2364
|
/**
|
|
@@ -2276,6 +2416,10 @@ export type RoleAttributes = {
|
|
|
2276
2416
|
* Can create/edit Build triggers
|
|
2277
2417
|
*/
|
|
2278
2418
|
can_manage_build_triggers: boolean;
|
|
2419
|
+
/**
|
|
2420
|
+
* Can create/edit Site Search Sources
|
|
2421
|
+
*/
|
|
2422
|
+
can_manage_site_search_sources: boolean;
|
|
2279
2423
|
/**
|
|
2280
2424
|
* Can create/edit webhooks
|
|
2281
2425
|
*/
|
|
@@ -2308,6 +2452,10 @@ export type RoleAttributes = {
|
|
|
2308
2452
|
* Can access the build events log
|
|
2309
2453
|
*/
|
|
2310
2454
|
can_access_build_events_log: boolean;
|
|
2455
|
+
/**
|
|
2456
|
+
* Can access the site search source events log
|
|
2457
|
+
*/
|
|
2458
|
+
can_access_site_search_source_events_log: boolean;
|
|
2311
2459
|
/**
|
|
2312
2460
|
* Allowed actions on a model (or all) for a role
|
|
2313
2461
|
*/
|
|
@@ -2368,7 +2516,7 @@ export type RoleAttributes = {
|
|
|
2368
2516
|
/**
|
|
2369
2517
|
* Permitted action
|
|
2370
2518
|
*/
|
|
2371
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2519
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2372
2520
|
/**
|
|
2373
2521
|
* Permitted creator
|
|
2374
2522
|
*/
|
|
@@ -2381,8 +2529,6 @@ export type RoleAttributes = {
|
|
|
2381
2529
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2382
2530
|
*/
|
|
2383
2531
|
locale?: string | null;
|
|
2384
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2385
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2386
2532
|
}[];
|
|
2387
2533
|
/**
|
|
2388
2534
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2392,7 +2538,7 @@ export type RoleAttributes = {
|
|
|
2392
2538
|
/**
|
|
2393
2539
|
* Permitted action
|
|
2394
2540
|
*/
|
|
2395
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2541
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2396
2542
|
/**
|
|
2397
2543
|
* Permitted creator
|
|
2398
2544
|
*/
|
|
@@ -2405,8 +2551,6 @@ export type RoleAttributes = {
|
|
|
2405
2551
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2406
2552
|
*/
|
|
2407
2553
|
locale?: string | null;
|
|
2408
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2409
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2410
2554
|
}[];
|
|
2411
2555
|
/**
|
|
2412
2556
|
* Allowed build triggers for a role
|
|
@@ -2420,6 +2564,18 @@ export type RoleAttributes = {
|
|
|
2420
2564
|
negative_build_trigger_permissions: {
|
|
2421
2565
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2422
2566
|
}[];
|
|
2567
|
+
/**
|
|
2568
|
+
* Allowed site search sources for a role
|
|
2569
|
+
*/
|
|
2570
|
+
positive_site_search_source_permissions: {
|
|
2571
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2572
|
+
}[];
|
|
2573
|
+
/**
|
|
2574
|
+
* Prohibited site search sources for a role
|
|
2575
|
+
*/
|
|
2576
|
+
negative_site_search_source_permissions: {
|
|
2577
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2578
|
+
}[];
|
|
2423
2579
|
};
|
|
2424
2580
|
/**
|
|
2425
2581
|
* JSON API links
|
|
@@ -2476,6 +2632,10 @@ export type RoleCreateSchema = {
|
|
|
2476
2632
|
* Can create/edit shared filters (both for models and the media area)
|
|
2477
2633
|
*/
|
|
2478
2634
|
can_manage_shared_filters?: boolean;
|
|
2635
|
+
/**
|
|
2636
|
+
* Can create/edit Site Search Sources
|
|
2637
|
+
*/
|
|
2638
|
+
can_manage_site_search_sources?: boolean;
|
|
2479
2639
|
/**
|
|
2480
2640
|
* Can create/edit upload collections
|
|
2481
2641
|
*/
|
|
@@ -2516,6 +2676,10 @@ export type RoleCreateSchema = {
|
|
|
2516
2676
|
* Can access the build events log
|
|
2517
2677
|
*/
|
|
2518
2678
|
can_access_build_events_log?: boolean;
|
|
2679
|
+
/**
|
|
2680
|
+
* Can access the site search source events log
|
|
2681
|
+
*/
|
|
2682
|
+
can_access_site_search_source_events_log?: boolean;
|
|
2519
2683
|
/**
|
|
2520
2684
|
* Allowed actions on a model (or all) for a role
|
|
2521
2685
|
*/
|
|
@@ -2576,7 +2740,7 @@ export type RoleCreateSchema = {
|
|
|
2576
2740
|
/**
|
|
2577
2741
|
* Permitted action
|
|
2578
2742
|
*/
|
|
2579
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2743
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2580
2744
|
/**
|
|
2581
2745
|
* Permitted creator
|
|
2582
2746
|
*/
|
|
@@ -2589,8 +2753,6 @@ export type RoleCreateSchema = {
|
|
|
2589
2753
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2590
2754
|
*/
|
|
2591
2755
|
locale?: string | null;
|
|
2592
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2593
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2594
2756
|
}[];
|
|
2595
2757
|
/**
|
|
2596
2758
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2600,7 +2762,7 @@ export type RoleCreateSchema = {
|
|
|
2600
2762
|
/**
|
|
2601
2763
|
* Permitted action
|
|
2602
2764
|
*/
|
|
2603
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2765
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2604
2766
|
/**
|
|
2605
2767
|
* Permitted creator
|
|
2606
2768
|
*/
|
|
@@ -2613,8 +2775,6 @@ export type RoleCreateSchema = {
|
|
|
2613
2775
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2614
2776
|
*/
|
|
2615
2777
|
locale?: string | null;
|
|
2616
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2617
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2618
2778
|
}[];
|
|
2619
2779
|
/**
|
|
2620
2780
|
* Allowed build triggers for a role
|
|
@@ -2628,6 +2788,18 @@ export type RoleCreateSchema = {
|
|
|
2628
2788
|
negative_build_trigger_permissions?: {
|
|
2629
2789
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2630
2790
|
}[];
|
|
2791
|
+
/**
|
|
2792
|
+
* Allowed site search sources for a role
|
|
2793
|
+
*/
|
|
2794
|
+
positive_site_search_source_permissions?: {
|
|
2795
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2796
|
+
}[];
|
|
2797
|
+
/**
|
|
2798
|
+
* Prohibited site search sources for a role
|
|
2799
|
+
*/
|
|
2800
|
+
negative_site_search_source_permissions?: {
|
|
2801
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2802
|
+
}[];
|
|
2631
2803
|
inherits_permissions_from?: RoleData[];
|
|
2632
2804
|
meta?: RoleMeta;
|
|
2633
2805
|
};
|
|
@@ -2678,6 +2850,10 @@ export type RoleUpdateSchema = {
|
|
|
2678
2850
|
* Can create/edit shared filters (both for models and the media area)
|
|
2679
2851
|
*/
|
|
2680
2852
|
can_manage_shared_filters?: boolean;
|
|
2853
|
+
/**
|
|
2854
|
+
* Can create/edit Site Search Sources
|
|
2855
|
+
*/
|
|
2856
|
+
can_manage_site_search_sources?: boolean;
|
|
2681
2857
|
/**
|
|
2682
2858
|
* Can create/edit upload collections
|
|
2683
2859
|
*/
|
|
@@ -2718,6 +2894,10 @@ export type RoleUpdateSchema = {
|
|
|
2718
2894
|
* Can access the build events log
|
|
2719
2895
|
*/
|
|
2720
2896
|
can_access_build_events_log?: boolean;
|
|
2897
|
+
/**
|
|
2898
|
+
* Can access the site search source events log
|
|
2899
|
+
*/
|
|
2900
|
+
can_access_site_search_source_events_log?: boolean;
|
|
2721
2901
|
/**
|
|
2722
2902
|
* Allowed actions on a model (or all) for a role
|
|
2723
2903
|
*/
|
|
@@ -2778,7 +2958,7 @@ export type RoleUpdateSchema = {
|
|
|
2778
2958
|
/**
|
|
2779
2959
|
* Permitted action
|
|
2780
2960
|
*/
|
|
2781
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2961
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2782
2962
|
/**
|
|
2783
2963
|
* Permitted creator
|
|
2784
2964
|
*/
|
|
@@ -2791,8 +2971,6 @@ export type RoleUpdateSchema = {
|
|
|
2791
2971
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2792
2972
|
*/
|
|
2793
2973
|
locale?: string | null;
|
|
2794
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2795
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2796
2974
|
}[];
|
|
2797
2975
|
/**
|
|
2798
2976
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2802,7 +2980,7 @@ export type RoleUpdateSchema = {
|
|
|
2802
2980
|
/**
|
|
2803
2981
|
* Permitted action
|
|
2804
2982
|
*/
|
|
2805
|
-
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset'
|
|
2983
|
+
action: 'all' | 'read' | 'update' | 'create' | 'delete' | 'edit_creator' | 'replace_asset';
|
|
2806
2984
|
/**
|
|
2807
2985
|
* Permitted creator
|
|
2808
2986
|
*/
|
|
@@ -2815,8 +2993,6 @@ export type RoleUpdateSchema = {
|
|
|
2815
2993
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2816
2994
|
*/
|
|
2817
2995
|
locale?: string | null;
|
|
2818
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2819
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2820
2996
|
}[];
|
|
2821
2997
|
/**
|
|
2822
2998
|
* Allowed build triggers for a role
|
|
@@ -2830,6 +3006,18 @@ export type RoleUpdateSchema = {
|
|
|
2830
3006
|
negative_build_trigger_permissions?: {
|
|
2831
3007
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2832
3008
|
}[];
|
|
3009
|
+
/**
|
|
3010
|
+
* Allowed site search sources for a role
|
|
3011
|
+
*/
|
|
3012
|
+
positive_site_search_source_permissions?: {
|
|
3013
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
3014
|
+
}[];
|
|
3015
|
+
/**
|
|
3016
|
+
* Prohibited site search sources for a role
|
|
3017
|
+
*/
|
|
3018
|
+
negative_site_search_source_permissions?: {
|
|
3019
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
3020
|
+
}[];
|
|
2833
3021
|
inherits_permissions_from?: RoleData[];
|
|
2834
3022
|
meta?: RoleMeta;
|
|
2835
3023
|
};
|
|
@@ -3530,6 +3718,10 @@ export type SitePlan = {
|
|
|
3530
3718
|
* Number of build triggers
|
|
3531
3719
|
*/
|
|
3532
3720
|
build_triggers: null | number;
|
|
3721
|
+
/**
|
|
3722
|
+
* Number of site search sources
|
|
3723
|
+
*/
|
|
3724
|
+
site_search_sources: null | number;
|
|
3533
3725
|
/**
|
|
3534
3726
|
* Number of plugins
|
|
3535
3727
|
*/
|
|
@@ -3694,6 +3886,10 @@ export type SitePlan = {
|
|
|
3694
3886
|
amount_per_packet: number;
|
|
3695
3887
|
price: number;
|
|
3696
3888
|
};
|
|
3889
|
+
site_search_sources?: {
|
|
3890
|
+
amount_per_packet: number;
|
|
3891
|
+
price: number;
|
|
3892
|
+
};
|
|
3697
3893
|
access_tokens?: {
|
|
3698
3894
|
amount_per_packet: number;
|
|
3699
3895
|
price: number;
|
|
@@ -3766,6 +3962,10 @@ export type SitePlanAttributes = {
|
|
|
3766
3962
|
* Number of build triggers
|
|
3767
3963
|
*/
|
|
3768
3964
|
build_triggers: null | number;
|
|
3965
|
+
/**
|
|
3966
|
+
* Number of site search sources
|
|
3967
|
+
*/
|
|
3968
|
+
site_search_sources: null | number;
|
|
3769
3969
|
/**
|
|
3770
3970
|
* Number of plugins
|
|
3771
3971
|
*/
|
|
@@ -3930,6 +4130,10 @@ export type SitePlanAttributes = {
|
|
|
3930
4130
|
amount_per_packet: number;
|
|
3931
4131
|
price: number;
|
|
3932
4132
|
};
|
|
4133
|
+
site_search_sources?: {
|
|
4134
|
+
amount_per_packet: number;
|
|
4135
|
+
price: number;
|
|
4136
|
+
};
|
|
3933
4137
|
access_tokens?: {
|
|
3934
4138
|
amount_per_packet: number;
|
|
3935
4139
|
price: number;
|
|
@@ -4950,11 +5154,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
4950
5154
|
* <details>
|
|
4951
5155
|
* <summary>Multi-line text (<code>text</code>)</summary>
|
|
4952
5156
|
*
|
|
4953
|
-
* | Property | Value
|
|
4954
|
-
* | ------------------------------ |
|
|
4955
|
-
* | Code | `text`
|
|
4956
|
-
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea`
|
|
4957
|
-
* | Available validators | `required`, `length`, `format`, `
|
|
5157
|
+
* | Property | Value |
|
|
5158
|
+
* | ------------------------------ | ------------------------------------------------ |
|
|
5159
|
+
* | Code | `text` |
|
|
5160
|
+
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
|
|
5161
|
+
* | Available validators | `required`, `length`, `format`, `sanitized_html` |
|
|
4958
5162
|
*
|
|
4959
5163
|
* </details>
|
|
4960
5164
|
*
|
|
@@ -5060,11 +5264,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
5060
5264
|
* <details>
|
|
5061
5265
|
* <summary>Slug (<code>slug</code>)</summary>
|
|
5062
5266
|
*
|
|
5063
|
-
* | Property | Value
|
|
5064
|
-
* | ------------------------------ |
|
|
5065
|
-
* | Code | `slug`
|
|
5066
|
-
* | Built-in editors for the field | `slug`
|
|
5067
|
-
* | Available validators | `required`, `length`, `slug_format`, `slug_title_field` |
|
|
5267
|
+
* | Property | Value |
|
|
5268
|
+
* | ------------------------------ | ----------------------------------------------------------------- |
|
|
5269
|
+
* | Code | `slug` |
|
|
5270
|
+
* | Built-in editors for the field | `slug` |
|
|
5271
|
+
* | Available validators | `required`, `unique`, `length`, `slug_format`, `slug_title_field` |
|
|
5068
5272
|
*
|
|
5069
5273
|
* </details>
|
|
5070
5274
|
*
|
|
@@ -5154,12 +5358,12 @@ export type ItemTypeUpdateSchema = {
|
|
|
5154
5358
|
* <details>
|
|
5155
5359
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
5156
5360
|
*
|
|
5157
|
-
* | Property | Value
|
|
5158
|
-
* | ------------------------------ |
|
|
5159
|
-
* | Code | `structured_text`
|
|
5160
|
-
* | Built-in editors for the field | `structured_text`
|
|
5161
|
-
* | Required validators | `structured_text_blocks`, `structured_text_links`
|
|
5162
|
-
* | Other validators available | `length`, `structured_text_inline_blocks`
|
|
5361
|
+
* | Property | Value |
|
|
5362
|
+
* | ------------------------------ | ----------------------------------------------------- |
|
|
5363
|
+
* | Code | `structured_text` |
|
|
5364
|
+
* | Built-in editors for the field | `structured_text` |
|
|
5365
|
+
* | Required validators | `structured_text_blocks`, `structured_text_links` |
|
|
5366
|
+
* | Other validators available | `required`, `length`, `structured_text_inline_blocks` |
|
|
5163
5367
|
*
|
|
5164
5368
|
* </details>
|
|
5165
5369
|
*
|
|
@@ -5473,9 +5677,9 @@ export type ItemTypeUpdateSchema = {
|
|
|
5473
5677
|
* </details>
|
|
5474
5678
|
*
|
|
5475
5679
|
* <details>
|
|
5476
|
-
* <summary><code>
|
|
5680
|
+
* <summary><code>sanitized_html</code></summary>
|
|
5477
5681
|
*
|
|
5478
|
-
* Checks for the presence of malicious
|
|
5682
|
+
* Checks for the presence of malicious code in HTML fields: content is valid if no dangerous code is present.
|
|
5479
5683
|
*
|
|
5480
5684
|
* | Parameter | Type | Required | Description |
|
|
5481
5685
|
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
@@ -5702,10 +5906,10 @@ export type ItemTypeUpdateSchema = {
|
|
|
5702
5906
|
*
|
|
5703
5907
|
* Built-in editor for _seo_ fields.
|
|
5704
5908
|
*
|
|
5705
|
-
* | Parameter | Type | Required | Description
|
|
5706
|
-
* | ---------- | --------------- | -------- |
|
|
5707
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
5708
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"
|
|
5909
|
+
* | Parameter | Type | Required | Description |
|
|
5910
|
+
* | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5911
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5912
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
5709
5913
|
*
|
|
5710
5914
|
* </details>
|
|
5711
5915
|
*
|
|
@@ -5867,7 +6071,6 @@ export type FieldStableShell = {
|
|
|
5867
6071
|
};
|
|
5868
6072
|
[k: string]: unknown;
|
|
5869
6073
|
}[];
|
|
5870
|
-
[k: string]: unknown;
|
|
5871
6074
|
};
|
|
5872
6075
|
/**
|
|
5873
6076
|
* Ordering index
|
|
@@ -5969,7 +6172,6 @@ export type FieldAttributesStableShell = {
|
|
|
5969
6172
|
};
|
|
5970
6173
|
[k: string]: unknown;
|
|
5971
6174
|
}[];
|
|
5972
|
-
[k: string]: unknown;
|
|
5973
6175
|
};
|
|
5974
6176
|
/**
|
|
5975
6177
|
* Ordering index
|
|
@@ -6064,7 +6266,6 @@ export type FieldCreateSchemaStableShell = {
|
|
|
6064
6266
|
};
|
|
6065
6267
|
[k: string]: unknown;
|
|
6066
6268
|
}[];
|
|
6067
|
-
[k: string]: unknown;
|
|
6068
6269
|
};
|
|
6069
6270
|
/**
|
|
6070
6271
|
* Ordering index
|
|
@@ -6162,7 +6363,6 @@ export type FieldUpdateSchemaStableShell = {
|
|
|
6162
6363
|
};
|
|
6163
6364
|
[k: string]: unknown;
|
|
6164
6365
|
}[];
|
|
6165
|
-
[k: string]: unknown;
|
|
6166
6366
|
};
|
|
6167
6367
|
/**
|
|
6168
6368
|
* Ordering index
|
|
@@ -6741,7 +6941,7 @@ export type BuildEvent = {
|
|
|
6741
6941
|
/**
|
|
6742
6942
|
* The type of activity
|
|
6743
6943
|
*/
|
|
6744
|
-
event_type: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable'
|
|
6944
|
+
event_type: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable';
|
|
6745
6945
|
/**
|
|
6746
6946
|
* The moment the activity occurred
|
|
6747
6947
|
*/
|
|
@@ -6785,7 +6985,7 @@ export type BuildEventAttributes = {
|
|
|
6785
6985
|
/**
|
|
6786
6986
|
* The type of activity
|
|
6787
6987
|
*/
|
|
6788
|
-
event_type: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable'
|
|
6988
|
+
event_type: 'request_success' | 'request_failure' | 'response_success' | 'response_failure' | 'request_aborted' | 'response_unprocessable';
|
|
6789
6989
|
/**
|
|
6790
6990
|
* The moment the activity occurred
|
|
6791
6991
|
*/
|
|
@@ -6806,6 +7006,83 @@ export type BuildEventAttributes = {
|
|
|
6806
7006
|
export type BuildEventRelationships = {
|
|
6807
7007
|
build_trigger: BuildTriggerData;
|
|
6808
7008
|
};
|
|
7009
|
+
/**
|
|
7010
|
+
* Represents an event occurred during the site search indexing process.
|
|
7011
|
+
*
|
|
7012
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7013
|
+
* via the `definition` "site_search_source_event".
|
|
7014
|
+
*/
|
|
7015
|
+
export type SiteSearchSourceEvent = {
|
|
7016
|
+
id: SiteSearchSourceEventIdentity;
|
|
7017
|
+
type: SiteSearchSourceEventType;
|
|
7018
|
+
/**
|
|
7019
|
+
* The type of activity
|
|
7020
|
+
*/
|
|
7021
|
+
event_type: 'indexing_started' | 'indexing_success' | 'indexing_failure' | 'indexing_aborted';
|
|
7022
|
+
/**
|
|
7023
|
+
* The moment the activity occurred
|
|
7024
|
+
*/
|
|
7025
|
+
created_at: string;
|
|
7026
|
+
/**
|
|
7027
|
+
* Any details regarding the event
|
|
7028
|
+
*/
|
|
7029
|
+
data: {
|
|
7030
|
+
[k: string]: unknown;
|
|
7031
|
+
};
|
|
7032
|
+
site_search_source: SiteSearchSourceData;
|
|
7033
|
+
};
|
|
7034
|
+
export type SiteSearchSourceEventSelfTargetSchema = SiteSearchSourceEvent;
|
|
7035
|
+
/**
|
|
7036
|
+
* JSON API data
|
|
7037
|
+
*
|
|
7038
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
7039
|
+
* via the `definition` "data".
|
|
7040
|
+
*/
|
|
7041
|
+
export type SiteSearchSourceData = {
|
|
7042
|
+
type: SiteSearchSourceType;
|
|
7043
|
+
id: SiteSearchSourceIdentity;
|
|
7044
|
+
};
|
|
7045
|
+
/**
|
|
7046
|
+
* JSON API data
|
|
7047
|
+
*
|
|
7048
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7049
|
+
* via the `definition` "data".
|
|
7050
|
+
*/
|
|
7051
|
+
export type SiteSearchSourceEventData = {
|
|
7052
|
+
type: SiteSearchSourceEventType;
|
|
7053
|
+
id: SiteSearchSourceEventIdentity;
|
|
7054
|
+
};
|
|
7055
|
+
/**
|
|
7056
|
+
* JSON API attributes
|
|
7057
|
+
*
|
|
7058
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7059
|
+
* via the `definition` "attributes".
|
|
7060
|
+
*/
|
|
7061
|
+
export type SiteSearchSourceEventAttributes = {
|
|
7062
|
+
/**
|
|
7063
|
+
* The type of activity
|
|
7064
|
+
*/
|
|
7065
|
+
event_type: 'indexing_started' | 'indexing_success' | 'indexing_failure' | 'indexing_aborted';
|
|
7066
|
+
/**
|
|
7067
|
+
* The moment the activity occurred
|
|
7068
|
+
*/
|
|
7069
|
+
created_at: string;
|
|
7070
|
+
/**
|
|
7071
|
+
* Any details regarding the event
|
|
7072
|
+
*/
|
|
7073
|
+
data: {
|
|
7074
|
+
[k: string]: unknown;
|
|
7075
|
+
};
|
|
7076
|
+
};
|
|
7077
|
+
/**
|
|
7078
|
+
* JSON API links
|
|
7079
|
+
*
|
|
7080
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7081
|
+
* via the `definition` "relationships".
|
|
7082
|
+
*/
|
|
7083
|
+
export type SiteSearchSourceEventRelationships = {
|
|
7084
|
+
site_search_source: SiteSearchSourceData;
|
|
7085
|
+
};
|
|
6809
7086
|
export type ItemCreateTargetSchema<D extends ItemTypeDefinition = ItemTypeDefinition, NestedMode extends boolean = false> = NestedMode extends false ? Item<D> : ItemInNestedResponse<D>;
|
|
6810
7087
|
export type ItemDuplicateJobSchema<D extends ItemTypeDefinition = ItemTypeDefinition, NestedMode extends boolean = false> = NestedMode extends false ? Item<D> : ItemInNestedResponse<D>;
|
|
6811
7088
|
export type ItemUpdateTargetSchema<D extends ItemTypeDefinition = ItemTypeDefinition, NestedMode extends boolean = false> = NestedMode extends false ? Item<D> : ItemInNestedResponse<D>;
|
|
@@ -7806,7 +8083,6 @@ export type UploadRequestCreateSchema = {
|
|
|
7806
8083
|
* The original file name
|
|
7807
8084
|
*/
|
|
7808
8085
|
filename?: string;
|
|
7809
|
-
upload_collection?: UploadCollectionData | null;
|
|
7810
8086
|
};
|
|
7811
8087
|
/**
|
|
7812
8088
|
* If the asset linked to an Upload entity is a video file, you have the option to include additional audio tracks and subtitle tracks to it.
|
|
@@ -8758,6 +9034,10 @@ export type BuildTrigger = {
|
|
|
8758
9034
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
8759
9035
|
*/
|
|
8760
9036
|
indexing_enabled: boolean;
|
|
9037
|
+
/**
|
|
9038
|
+
* Whether the build trigger is enabled or not
|
|
9039
|
+
*/
|
|
9040
|
+
enabled: boolean;
|
|
8761
9041
|
};
|
|
8762
9042
|
export type BuildTriggerSelfTargetSchema = BuildTrigger;
|
|
8763
9043
|
export type BuildTriggerCreateTargetSchema = BuildTrigger;
|
|
@@ -8816,6 +9096,10 @@ export type BuildTriggerAttributes = {
|
|
|
8816
9096
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
8817
9097
|
*/
|
|
8818
9098
|
indexing_enabled: boolean;
|
|
9099
|
+
/**
|
|
9100
|
+
* Whether the build trigger is enabled or not
|
|
9101
|
+
*/
|
|
9102
|
+
enabled: boolean;
|
|
8819
9103
|
};
|
|
8820
9104
|
/**
|
|
8821
9105
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
@@ -8839,6 +9123,10 @@ export type BuildTriggerCreateSchema = {
|
|
|
8839
9123
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
8840
9124
|
*/
|
|
8841
9125
|
indexing_enabled: boolean;
|
|
9126
|
+
/**
|
|
9127
|
+
* Whether the build trigger is enabled or not
|
|
9128
|
+
*/
|
|
9129
|
+
enabled?: boolean;
|
|
8842
9130
|
/**
|
|
8843
9131
|
* 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
|
|
8844
9132
|
*/
|
|
@@ -8873,6 +9161,10 @@ export type BuildTriggerUpdateSchema = {
|
|
|
8873
9161
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
8874
9162
|
*/
|
|
8875
9163
|
indexing_enabled?: boolean;
|
|
9164
|
+
/**
|
|
9165
|
+
* Whether the build trigger is enabled or not
|
|
9166
|
+
*/
|
|
9167
|
+
enabled?: boolean;
|
|
8876
9168
|
/**
|
|
8877
9169
|
* 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
|
|
8878
9170
|
*/
|
|
@@ -8888,6 +9180,136 @@ export type BuildTriggerUpdateSchema = {
|
|
|
8888
9180
|
[k: string]: unknown;
|
|
8889
9181
|
};
|
|
8890
9182
|
};
|
|
9183
|
+
/**
|
|
9184
|
+
* 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.
|
|
9185
|
+
*
|
|
9186
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
9187
|
+
* via the `definition` "site_search_source".
|
|
9188
|
+
*/
|
|
9189
|
+
export type SiteSearchSource = {
|
|
9190
|
+
id: SiteSearchSourceIdentity;
|
|
9191
|
+
type: SiteSearchSourceType;
|
|
9192
|
+
/**
|
|
9193
|
+
* Name of the site search source
|
|
9194
|
+
*/
|
|
9195
|
+
name: string;
|
|
9196
|
+
/**
|
|
9197
|
+
* Whether the site search source is enabled or not
|
|
9198
|
+
*/
|
|
9199
|
+
enabled: boolean;
|
|
9200
|
+
/**
|
|
9201
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
9202
|
+
*/
|
|
9203
|
+
build_trigger_indexing_enabled: boolean;
|
|
9204
|
+
/**
|
|
9205
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9206
|
+
*/
|
|
9207
|
+
frontend_url: string | null;
|
|
9208
|
+
build_triggers: BuildTriggerData[];
|
|
9209
|
+
meta: SiteSearchSourceMeta;
|
|
9210
|
+
};
|
|
9211
|
+
export type SiteSearchSourceSelfTargetSchema = SiteSearchSource;
|
|
9212
|
+
export type SiteSearchSourceCreateTargetSchema = SiteSearchSource;
|
|
9213
|
+
export type SiteSearchSourceUpdateTargetSchema = SiteSearchSource;
|
|
9214
|
+
export type SiteSearchSourceDestroyTargetSchema = SiteSearchSource;
|
|
9215
|
+
/**
|
|
9216
|
+
* Meta information about the site search source
|
|
9217
|
+
*
|
|
9218
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
9219
|
+
* via the `definition` "meta".
|
|
9220
|
+
*/
|
|
9221
|
+
export type SiteSearchSourceMeta = {
|
|
9222
|
+
/**
|
|
9223
|
+
* Status of the site search indexing
|
|
9224
|
+
*/
|
|
9225
|
+
indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
|
|
9226
|
+
/**
|
|
9227
|
+
* Timestamp of the last completed indexing
|
|
9228
|
+
*/
|
|
9229
|
+
last_indexing_completed_at: string | null;
|
|
9230
|
+
};
|
|
9231
|
+
/**
|
|
9232
|
+
* JSON API attributes
|
|
9233
|
+
*
|
|
9234
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
9235
|
+
* via the `definition` "attributes".
|
|
9236
|
+
*/
|
|
9237
|
+
export type SiteSearchSourceAttributes = {
|
|
9238
|
+
/**
|
|
9239
|
+
* Name of the site search source
|
|
9240
|
+
*/
|
|
9241
|
+
name: string;
|
|
9242
|
+
/**
|
|
9243
|
+
* Whether the site search source is enabled or not
|
|
9244
|
+
*/
|
|
9245
|
+
enabled: boolean;
|
|
9246
|
+
/**
|
|
9247
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
9248
|
+
*/
|
|
9249
|
+
build_trigger_indexing_enabled: boolean;
|
|
9250
|
+
/**
|
|
9251
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9252
|
+
*/
|
|
9253
|
+
frontend_url: string | null;
|
|
9254
|
+
};
|
|
9255
|
+
/**
|
|
9256
|
+
* JSON API links
|
|
9257
|
+
*
|
|
9258
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
9259
|
+
* via the `definition` "relationships".
|
|
9260
|
+
*/
|
|
9261
|
+
export type SiteSearchSourceRelationships = {
|
|
9262
|
+
build_triggers: BuildTriggerData[];
|
|
9263
|
+
};
|
|
9264
|
+
/**
|
|
9265
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
9266
|
+
* via the `create.schema` link.
|
|
9267
|
+
*/
|
|
9268
|
+
export type SiteSearchSourceCreateSchema = {
|
|
9269
|
+
type?: SiteSearchSourceType;
|
|
9270
|
+
/**
|
|
9271
|
+
* Name of the site search source
|
|
9272
|
+
*/
|
|
9273
|
+
name: string;
|
|
9274
|
+
/**
|
|
9275
|
+
* Whether the site search source is enabled or not
|
|
9276
|
+
*/
|
|
9277
|
+
enabled: boolean;
|
|
9278
|
+
/**
|
|
9279
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
9280
|
+
*/
|
|
9281
|
+
build_trigger_indexing_enabled?: boolean;
|
|
9282
|
+
/**
|
|
9283
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9284
|
+
*/
|
|
9285
|
+
frontend_url: string | null;
|
|
9286
|
+
build_triggers?: BuildTriggerData[];
|
|
9287
|
+
};
|
|
9288
|
+
/**
|
|
9289
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
9290
|
+
* via the `update.schema` link.
|
|
9291
|
+
*/
|
|
9292
|
+
export type SiteSearchSourceUpdateSchema = {
|
|
9293
|
+
id?: SiteSearchSourceIdentity;
|
|
9294
|
+
type?: SiteSearchSourceType;
|
|
9295
|
+
/**
|
|
9296
|
+
* Name of the site search source
|
|
9297
|
+
*/
|
|
9298
|
+
name?: string;
|
|
9299
|
+
/**
|
|
9300
|
+
* Whether the site search source is enabled or not
|
|
9301
|
+
*/
|
|
9302
|
+
enabled?: boolean;
|
|
9303
|
+
/**
|
|
9304
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
9305
|
+
*/
|
|
9306
|
+
build_trigger_indexing_enabled?: boolean;
|
|
9307
|
+
/**
|
|
9308
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9309
|
+
*/
|
|
9310
|
+
frontend_url?: string | null;
|
|
9311
|
+
build_triggers?: BuildTriggerData[];
|
|
9312
|
+
};
|
|
8891
9313
|
/**
|
|
8892
9314
|
* In DatoCMS you can create filters to help you (and other editors) quickly search for records
|
|
8893
9315
|
*
|