@datocms/cma-client 5.2.0-alpha.1 → 5.2.0-alpha.3
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 +233 -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 +507 -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 +517 -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 +204 -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 +507 -69
- package/dist/types/generated/Client.d.ts +2 -0
- package/dist/types/generated/RawApiTypes.d.ts +517 -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 +294 -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 +526 -88
- package/src/generated/Client.ts +5 -1
- package/src/generated/RawApiTypes.ts +531 -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 +267 -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
|
@@ -107,25 +107,25 @@ export type WorkflowIdentity = string;
|
|
|
107
107
|
*/
|
|
108
108
|
export type EnvironmentIdentity = string;
|
|
109
109
|
/**
|
|
110
|
-
*
|
|
110
|
+
* ID of build_trigger
|
|
111
111
|
*
|
|
112
|
-
* This interface was referenced by `
|
|
112
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
113
113
|
* via the `definition` "identity".
|
|
114
114
|
*
|
|
115
|
-
* This interface was referenced by `
|
|
115
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
116
116
|
* via the `definition` "id".
|
|
117
117
|
*/
|
|
118
|
-
export type
|
|
118
|
+
export type BuildTriggerIdentity = string;
|
|
119
119
|
/**
|
|
120
|
-
* ID of
|
|
120
|
+
* ID of site_search_source
|
|
121
121
|
*
|
|
122
|
-
* This interface was referenced by `
|
|
122
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
123
123
|
* via the `definition` "identity".
|
|
124
124
|
*
|
|
125
|
-
* This interface was referenced by `
|
|
125
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
126
126
|
* via the `definition` "id".
|
|
127
127
|
*/
|
|
128
|
-
export type
|
|
128
|
+
export type SiteSearchSourceIdentity = string;
|
|
129
129
|
/**
|
|
130
130
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
131
131
|
* via the `instances.targetSchema` link.
|
|
@@ -485,6 +485,16 @@ export type SchemaMenuItemReorderSchema = {
|
|
|
485
485
|
* via the `reorder.jobSchema` link.
|
|
486
486
|
*/
|
|
487
487
|
export type SchemaMenuItemReorderJobSchema = SchemaMenuItem[];
|
|
488
|
+
/**
|
|
489
|
+
* RFC 4122 UUID of upload collection expressed in URL-safe base64 format
|
|
490
|
+
*
|
|
491
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
492
|
+
* via the `definition` "identity".
|
|
493
|
+
*
|
|
494
|
+
* This interface was referenced by `UploadCollection`'s JSON-Schema
|
|
495
|
+
* via the `definition` "id".
|
|
496
|
+
*/
|
|
497
|
+
export type UploadCollectionIdentity = string;
|
|
488
498
|
/**
|
|
489
499
|
* JSON API type field
|
|
490
500
|
*
|
|
@@ -612,6 +622,11 @@ export type ItemTypeDestroyHrefSchema = {
|
|
|
612
622
|
skip_menu_items_deletion?: boolean;
|
|
613
623
|
[k: string]: unknown;
|
|
614
624
|
};
|
|
625
|
+
/**
|
|
626
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
627
|
+
* via the `referencing.targetSchema` link.
|
|
628
|
+
*/
|
|
629
|
+
export type ItemTypeReferencingTargetSchema = ItemType[];
|
|
615
630
|
/**
|
|
616
631
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
617
632
|
* via the `reorder_fields_and_fieldsets.schema` link.
|
|
@@ -820,10 +835,7 @@ export type BuildEventInstancesHrefSchema = {
|
|
|
820
835
|
| 'response_success'
|
|
821
836
|
| 'response_failure'
|
|
822
837
|
| 'request_aborted'
|
|
823
|
-
| 'response_unprocessable'
|
|
824
|
-
| 'indexing_started'
|
|
825
|
-
| 'indexing_success'
|
|
826
|
-
| 'indexing_failure';
|
|
838
|
+
| 'response_unprocessable';
|
|
827
839
|
};
|
|
828
840
|
created_at?: {
|
|
829
841
|
gt?: string;
|
|
@@ -843,6 +855,90 @@ export type BuildEventInstancesHrefSchema = {
|
|
|
843
855
|
| 'event_type_desc';
|
|
844
856
|
[k: string]: unknown;
|
|
845
857
|
};
|
|
858
|
+
/**
|
|
859
|
+
* ID of site search source event
|
|
860
|
+
*
|
|
861
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
862
|
+
* via the `definition` "identity".
|
|
863
|
+
*
|
|
864
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
865
|
+
* via the `definition` "id".
|
|
866
|
+
*/
|
|
867
|
+
export type SiteSearchSourceEventIdentity = string;
|
|
868
|
+
/**
|
|
869
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
870
|
+
* via the `definition` "type".
|
|
871
|
+
*/
|
|
872
|
+
export type SiteSearchSourceEventType = 'site_search_source_event';
|
|
873
|
+
/**
|
|
874
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
875
|
+
* via the `definition` "type".
|
|
876
|
+
*/
|
|
877
|
+
export type SiteSearchSourceType = 'site_search_source';
|
|
878
|
+
/**
|
|
879
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
880
|
+
* via the `instances.targetSchema` link.
|
|
881
|
+
*/
|
|
882
|
+
export type SiteSearchSourceEventInstancesTargetSchema =
|
|
883
|
+
SiteSearchSourceEvent[];
|
|
884
|
+
/**
|
|
885
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
886
|
+
* via the `instances.hrefSchema` link.
|
|
887
|
+
*/
|
|
888
|
+
export type SiteSearchSourceEventInstancesHrefSchema = {
|
|
889
|
+
/**
|
|
890
|
+
* Parameters to control offset-based pagination
|
|
891
|
+
*/
|
|
892
|
+
page?: {
|
|
893
|
+
/**
|
|
894
|
+
* The (zero-based) offset of the first entity returned in the collection (defaults to 0)
|
|
895
|
+
*/
|
|
896
|
+
offset?: number;
|
|
897
|
+
/**
|
|
898
|
+
* The maximum number of entities to return (defaults to 30, maximum is 500)
|
|
899
|
+
*/
|
|
900
|
+
limit?: number;
|
|
901
|
+
};
|
|
902
|
+
/**
|
|
903
|
+
* Attributes to filter
|
|
904
|
+
*/
|
|
905
|
+
filter?: {
|
|
906
|
+
/**
|
|
907
|
+
* IDs to fetch, comma separated
|
|
908
|
+
*/
|
|
909
|
+
ids?: string;
|
|
910
|
+
fields?: {
|
|
911
|
+
site_search_source_id?: {
|
|
912
|
+
eq?: string;
|
|
913
|
+
};
|
|
914
|
+
event_type?: {
|
|
915
|
+
/**
|
|
916
|
+
* The type of activity
|
|
917
|
+
*/
|
|
918
|
+
eq?:
|
|
919
|
+
| 'indexing_started'
|
|
920
|
+
| 'indexing_success'
|
|
921
|
+
| 'indexing_failure'
|
|
922
|
+
| 'indexing_aborted';
|
|
923
|
+
};
|
|
924
|
+
created_at?: {
|
|
925
|
+
gt?: string;
|
|
926
|
+
lt?: string;
|
|
927
|
+
};
|
|
928
|
+
};
|
|
929
|
+
};
|
|
930
|
+
/**
|
|
931
|
+
* Fields used to order results
|
|
932
|
+
*/
|
|
933
|
+
order_by?:
|
|
934
|
+
| 'site_search_source_id_asc'
|
|
935
|
+
| 'site_search_source_id_desc'
|
|
936
|
+
| 'created_at_asc'
|
|
937
|
+
| 'created_at_desc'
|
|
938
|
+
| 'event_type_asc'
|
|
939
|
+
| 'event_type_desc';
|
|
940
|
+
[k: string]: unknown;
|
|
941
|
+
};
|
|
846
942
|
/**
|
|
847
943
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
848
944
|
* via the `instances.targetSchema` link.
|
|
@@ -1123,6 +1219,17 @@ export type ItemVersionInstancesHrefSchema = {
|
|
|
1123
1219
|
};
|
|
1124
1220
|
[k: string]: unknown;
|
|
1125
1221
|
};
|
|
1222
|
+
/**
|
|
1223
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
1224
|
+
* via the `self.hrefSchema` link.
|
|
1225
|
+
*/
|
|
1226
|
+
export type ItemVersionSelfHrefSchema = {
|
|
1227
|
+
/**
|
|
1228
|
+
* For Modular Content, Structured Text and Single Block fields, return full payload for nested blocks instead of IDs
|
|
1229
|
+
*/
|
|
1230
|
+
nested?: boolean;
|
|
1231
|
+
[k: string]: unknown;
|
|
1232
|
+
};
|
|
1126
1233
|
/**
|
|
1127
1234
|
* RFC 4122 UUID of upload expressed in URL-safe base64 format
|
|
1128
1235
|
*
|
|
@@ -1315,7 +1422,11 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
1315
1422
|
*/
|
|
1316
1423
|
query: string;
|
|
1317
1424
|
/**
|
|
1318
|
-
* The
|
|
1425
|
+
* 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.
|
|
1426
|
+
*/
|
|
1427
|
+
site_search_source_id?: string;
|
|
1428
|
+
/**
|
|
1429
|
+
* **[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.
|
|
1319
1430
|
*/
|
|
1320
1431
|
build_trigger_id?: string;
|
|
1321
1432
|
/**
|
|
@@ -1531,6 +1642,11 @@ export type WebhookCallInstancesHrefSchema = {
|
|
|
1531
1642
|
* via the `instances.targetSchema` link.
|
|
1532
1643
|
*/
|
|
1533
1644
|
export type BuildTriggerInstancesTargetSchema = BuildTrigger[];
|
|
1645
|
+
/**
|
|
1646
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
1647
|
+
* via the `instances.targetSchema` link.
|
|
1648
|
+
*/
|
|
1649
|
+
export type SiteSearchSourceInstancesTargetSchema = SiteSearchSource[];
|
|
1534
1650
|
/**
|
|
1535
1651
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
1536
1652
|
* via the `instances.targetSchema` link.
|
|
@@ -1978,6 +2094,10 @@ export type Role = {
|
|
|
1978
2094
|
* Can create/edit Build triggers
|
|
1979
2095
|
*/
|
|
1980
2096
|
can_manage_build_triggers: boolean;
|
|
2097
|
+
/**
|
|
2098
|
+
* Can create/edit Site Search Sources
|
|
2099
|
+
*/
|
|
2100
|
+
can_manage_site_search_sources: boolean;
|
|
1981
2101
|
/**
|
|
1982
2102
|
* Can create/edit webhooks
|
|
1983
2103
|
*/
|
|
@@ -2010,6 +2130,10 @@ export type Role = {
|
|
|
2010
2130
|
* Can access the build events log
|
|
2011
2131
|
*/
|
|
2012
2132
|
can_access_build_events_log: boolean;
|
|
2133
|
+
/**
|
|
2134
|
+
* Can access the site search source events log
|
|
2135
|
+
*/
|
|
2136
|
+
can_access_site_search_source_events_log: boolean;
|
|
2013
2137
|
/**
|
|
2014
2138
|
* Allowed actions on a model (or all) for a role
|
|
2015
2139
|
*/
|
|
@@ -2097,8 +2221,7 @@ export type Role = {
|
|
|
2097
2221
|
| 'create'
|
|
2098
2222
|
| 'delete'
|
|
2099
2223
|
| 'edit_creator'
|
|
2100
|
-
| 'replace_asset'
|
|
2101
|
-
| 'move';
|
|
2224
|
+
| 'replace_asset';
|
|
2102
2225
|
/**
|
|
2103
2226
|
* Permitted creator
|
|
2104
2227
|
*/
|
|
@@ -2111,8 +2234,6 @@ export type Role = {
|
|
|
2111
2234
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2112
2235
|
*/
|
|
2113
2236
|
locale?: string | null;
|
|
2114
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2115
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2116
2237
|
}[];
|
|
2117
2238
|
/**
|
|
2118
2239
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2129,8 +2250,7 @@ export type Role = {
|
|
|
2129
2250
|
| 'create'
|
|
2130
2251
|
| 'delete'
|
|
2131
2252
|
| 'edit_creator'
|
|
2132
|
-
| 'replace_asset'
|
|
2133
|
-
| 'move';
|
|
2253
|
+
| 'replace_asset';
|
|
2134
2254
|
/**
|
|
2135
2255
|
* Permitted creator
|
|
2136
2256
|
*/
|
|
@@ -2143,8 +2263,6 @@ export type Role = {
|
|
|
2143
2263
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2144
2264
|
*/
|
|
2145
2265
|
locale?: string | null;
|
|
2146
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2147
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2148
2266
|
}[];
|
|
2149
2267
|
/**
|
|
2150
2268
|
* Allowed build triggers for a role
|
|
@@ -2158,6 +2276,18 @@ export type Role = {
|
|
|
2158
2276
|
negative_build_trigger_permissions: {
|
|
2159
2277
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2160
2278
|
}[];
|
|
2279
|
+
/**
|
|
2280
|
+
* Allowed site search sources for a role
|
|
2281
|
+
*/
|
|
2282
|
+
positive_site_search_source_permissions: {
|
|
2283
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2284
|
+
}[];
|
|
2285
|
+
/**
|
|
2286
|
+
* Prohibited site search sources for a role
|
|
2287
|
+
*/
|
|
2288
|
+
negative_site_search_source_permissions: {
|
|
2289
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2290
|
+
}[];
|
|
2161
2291
|
inherits_permissions_from: RoleData[];
|
|
2162
2292
|
meta: RoleMeta;
|
|
2163
2293
|
};
|
|
@@ -2231,6 +2361,10 @@ export type RoleMeta = {
|
|
|
2231
2361
|
* Can create/edit Build triggers
|
|
2232
2362
|
*/
|
|
2233
2363
|
can_manage_build_triggers: boolean;
|
|
2364
|
+
/**
|
|
2365
|
+
* Can create/edit Site Search Sources
|
|
2366
|
+
*/
|
|
2367
|
+
can_manage_site_search_sources: boolean;
|
|
2234
2368
|
/**
|
|
2235
2369
|
* Can create/edit webhooks
|
|
2236
2370
|
*/
|
|
@@ -2263,6 +2397,10 @@ export type RoleMeta = {
|
|
|
2263
2397
|
* Can access the build events log
|
|
2264
2398
|
*/
|
|
2265
2399
|
can_access_build_events_log: boolean;
|
|
2400
|
+
/**
|
|
2401
|
+
* Can access the site search source events log
|
|
2402
|
+
*/
|
|
2403
|
+
can_access_site_search_source_events_log: boolean;
|
|
2266
2404
|
/**
|
|
2267
2405
|
* Allowed actions on a model (or all) for a role
|
|
2268
2406
|
*/
|
|
@@ -2350,8 +2488,7 @@ export type RoleMeta = {
|
|
|
2350
2488
|
| 'create'
|
|
2351
2489
|
| 'delete'
|
|
2352
2490
|
| 'edit_creator'
|
|
2353
|
-
| 'replace_asset'
|
|
2354
|
-
| 'move';
|
|
2491
|
+
| 'replace_asset';
|
|
2355
2492
|
/**
|
|
2356
2493
|
* Permitted creator
|
|
2357
2494
|
*/
|
|
@@ -2364,8 +2501,6 @@ export type RoleMeta = {
|
|
|
2364
2501
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2365
2502
|
*/
|
|
2366
2503
|
locale?: string | null;
|
|
2367
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2368
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2369
2504
|
}[];
|
|
2370
2505
|
/**
|
|
2371
2506
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2382,8 +2517,7 @@ export type RoleMeta = {
|
|
|
2382
2517
|
| 'create'
|
|
2383
2518
|
| 'delete'
|
|
2384
2519
|
| 'edit_creator'
|
|
2385
|
-
| 'replace_asset'
|
|
2386
|
-
| 'move';
|
|
2520
|
+
| 'replace_asset';
|
|
2387
2521
|
/**
|
|
2388
2522
|
* Permitted creator
|
|
2389
2523
|
*/
|
|
@@ -2396,8 +2530,6 @@ export type RoleMeta = {
|
|
|
2396
2530
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2397
2531
|
*/
|
|
2398
2532
|
locale?: string | null;
|
|
2399
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2400
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2401
2533
|
}[];
|
|
2402
2534
|
/**
|
|
2403
2535
|
* Allowed build triggers for a role
|
|
@@ -2411,6 +2543,18 @@ export type RoleMeta = {
|
|
|
2411
2543
|
negative_build_trigger_permissions: {
|
|
2412
2544
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2413
2545
|
}[];
|
|
2546
|
+
/**
|
|
2547
|
+
* Allowed site search sources for a role
|
|
2548
|
+
*/
|
|
2549
|
+
positive_site_search_source_permissions: {
|
|
2550
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2551
|
+
}[];
|
|
2552
|
+
/**
|
|
2553
|
+
* Prohibited site search sources for a role
|
|
2554
|
+
*/
|
|
2555
|
+
negative_site_search_source_permissions: {
|
|
2556
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2557
|
+
}[];
|
|
2414
2558
|
};
|
|
2415
2559
|
};
|
|
2416
2560
|
/**
|
|
@@ -2468,6 +2612,10 @@ export type RoleAttributes = {
|
|
|
2468
2612
|
* Can create/edit Build triggers
|
|
2469
2613
|
*/
|
|
2470
2614
|
can_manage_build_triggers: boolean;
|
|
2615
|
+
/**
|
|
2616
|
+
* Can create/edit Site Search Sources
|
|
2617
|
+
*/
|
|
2618
|
+
can_manage_site_search_sources: boolean;
|
|
2471
2619
|
/**
|
|
2472
2620
|
* Can create/edit webhooks
|
|
2473
2621
|
*/
|
|
@@ -2500,6 +2648,10 @@ export type RoleAttributes = {
|
|
|
2500
2648
|
* Can access the build events log
|
|
2501
2649
|
*/
|
|
2502
2650
|
can_access_build_events_log: boolean;
|
|
2651
|
+
/**
|
|
2652
|
+
* Can access the site search source events log
|
|
2653
|
+
*/
|
|
2654
|
+
can_access_site_search_source_events_log: boolean;
|
|
2503
2655
|
/**
|
|
2504
2656
|
* Allowed actions on a model (or all) for a role
|
|
2505
2657
|
*/
|
|
@@ -2587,8 +2739,7 @@ export type RoleAttributes = {
|
|
|
2587
2739
|
| 'create'
|
|
2588
2740
|
| 'delete'
|
|
2589
2741
|
| 'edit_creator'
|
|
2590
|
-
| 'replace_asset'
|
|
2591
|
-
| 'move';
|
|
2742
|
+
| 'replace_asset';
|
|
2592
2743
|
/**
|
|
2593
2744
|
* Permitted creator
|
|
2594
2745
|
*/
|
|
@@ -2601,8 +2752,6 @@ export type RoleAttributes = {
|
|
|
2601
2752
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2602
2753
|
*/
|
|
2603
2754
|
locale?: string | null;
|
|
2604
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2605
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2606
2755
|
}[];
|
|
2607
2756
|
/**
|
|
2608
2757
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2619,8 +2768,7 @@ export type RoleAttributes = {
|
|
|
2619
2768
|
| 'create'
|
|
2620
2769
|
| 'delete'
|
|
2621
2770
|
| 'edit_creator'
|
|
2622
|
-
| 'replace_asset'
|
|
2623
|
-
| 'move';
|
|
2771
|
+
| 'replace_asset';
|
|
2624
2772
|
/**
|
|
2625
2773
|
* Permitted creator
|
|
2626
2774
|
*/
|
|
@@ -2633,8 +2781,6 @@ export type RoleAttributes = {
|
|
|
2633
2781
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2634
2782
|
*/
|
|
2635
2783
|
locale?: string | null;
|
|
2636
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2637
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2638
2784
|
}[];
|
|
2639
2785
|
/**
|
|
2640
2786
|
* Allowed build triggers for a role
|
|
@@ -2648,6 +2794,18 @@ export type RoleAttributes = {
|
|
|
2648
2794
|
negative_build_trigger_permissions: {
|
|
2649
2795
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2650
2796
|
}[];
|
|
2797
|
+
/**
|
|
2798
|
+
* Allowed site search sources for a role
|
|
2799
|
+
*/
|
|
2800
|
+
positive_site_search_source_permissions: {
|
|
2801
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2802
|
+
}[];
|
|
2803
|
+
/**
|
|
2804
|
+
* Prohibited site search sources for a role
|
|
2805
|
+
*/
|
|
2806
|
+
negative_site_search_source_permissions: {
|
|
2807
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
2808
|
+
}[];
|
|
2651
2809
|
};
|
|
2652
2810
|
/**
|
|
2653
2811
|
* JSON API links
|
|
@@ -2704,6 +2862,10 @@ export type RoleCreateSchema = {
|
|
|
2704
2862
|
* Can create/edit shared filters (both for models and the media area)
|
|
2705
2863
|
*/
|
|
2706
2864
|
can_manage_shared_filters?: boolean;
|
|
2865
|
+
/**
|
|
2866
|
+
* Can create/edit Site Search Sources
|
|
2867
|
+
*/
|
|
2868
|
+
can_manage_site_search_sources?: boolean;
|
|
2707
2869
|
/**
|
|
2708
2870
|
* Can create/edit upload collections
|
|
2709
2871
|
*/
|
|
@@ -2744,6 +2906,10 @@ export type RoleCreateSchema = {
|
|
|
2744
2906
|
* Can access the build events log
|
|
2745
2907
|
*/
|
|
2746
2908
|
can_access_build_events_log?: boolean;
|
|
2909
|
+
/**
|
|
2910
|
+
* Can access the site search source events log
|
|
2911
|
+
*/
|
|
2912
|
+
can_access_site_search_source_events_log?: boolean;
|
|
2747
2913
|
/**
|
|
2748
2914
|
* Allowed actions on a model (or all) for a role
|
|
2749
2915
|
*/
|
|
@@ -2831,8 +2997,7 @@ export type RoleCreateSchema = {
|
|
|
2831
2997
|
| 'create'
|
|
2832
2998
|
| 'delete'
|
|
2833
2999
|
| 'edit_creator'
|
|
2834
|
-
| 'replace_asset'
|
|
2835
|
-
| 'move';
|
|
3000
|
+
| 'replace_asset';
|
|
2836
3001
|
/**
|
|
2837
3002
|
* Permitted creator
|
|
2838
3003
|
*/
|
|
@@ -2845,8 +3010,6 @@ export type RoleCreateSchema = {
|
|
|
2845
3010
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2846
3011
|
*/
|
|
2847
3012
|
locale?: string | null;
|
|
2848
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2849
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2850
3013
|
}[];
|
|
2851
3014
|
/**
|
|
2852
3015
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -2863,8 +3026,7 @@ export type RoleCreateSchema = {
|
|
|
2863
3026
|
| 'create'
|
|
2864
3027
|
| 'delete'
|
|
2865
3028
|
| 'edit_creator'
|
|
2866
|
-
| 'replace_asset'
|
|
2867
|
-
| 'move';
|
|
3029
|
+
| 'replace_asset';
|
|
2868
3030
|
/**
|
|
2869
3031
|
* Permitted creator
|
|
2870
3032
|
*/
|
|
@@ -2877,8 +3039,6 @@ export type RoleCreateSchema = {
|
|
|
2877
3039
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
2878
3040
|
*/
|
|
2879
3041
|
locale?: string | null;
|
|
2880
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
2881
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
2882
3042
|
}[];
|
|
2883
3043
|
/**
|
|
2884
3044
|
* Allowed build triggers for a role
|
|
@@ -2892,6 +3052,18 @@ export type RoleCreateSchema = {
|
|
|
2892
3052
|
negative_build_trigger_permissions?: {
|
|
2893
3053
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2894
3054
|
}[];
|
|
3055
|
+
/**
|
|
3056
|
+
* Allowed site search sources for a role
|
|
3057
|
+
*/
|
|
3058
|
+
positive_site_search_source_permissions?: {
|
|
3059
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
3060
|
+
}[];
|
|
3061
|
+
/**
|
|
3062
|
+
* Prohibited site search sources for a role
|
|
3063
|
+
*/
|
|
3064
|
+
negative_site_search_source_permissions?: {
|
|
3065
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
3066
|
+
}[];
|
|
2895
3067
|
inherits_permissions_from?: RoleData[];
|
|
2896
3068
|
meta?: RoleMeta;
|
|
2897
3069
|
};
|
|
@@ -2942,6 +3114,10 @@ export type RoleUpdateSchema = {
|
|
|
2942
3114
|
* Can create/edit shared filters (both for models and the media area)
|
|
2943
3115
|
*/
|
|
2944
3116
|
can_manage_shared_filters?: boolean;
|
|
3117
|
+
/**
|
|
3118
|
+
* Can create/edit Site Search Sources
|
|
3119
|
+
*/
|
|
3120
|
+
can_manage_site_search_sources?: boolean;
|
|
2945
3121
|
/**
|
|
2946
3122
|
* Can create/edit upload collections
|
|
2947
3123
|
*/
|
|
@@ -2982,6 +3158,10 @@ export type RoleUpdateSchema = {
|
|
|
2982
3158
|
* Can access the build events log
|
|
2983
3159
|
*/
|
|
2984
3160
|
can_access_build_events_log?: boolean;
|
|
3161
|
+
/**
|
|
3162
|
+
* Can access the site search source events log
|
|
3163
|
+
*/
|
|
3164
|
+
can_access_site_search_source_events_log?: boolean;
|
|
2985
3165
|
/**
|
|
2986
3166
|
* Allowed actions on a model (or all) for a role
|
|
2987
3167
|
*/
|
|
@@ -3069,8 +3249,7 @@ export type RoleUpdateSchema = {
|
|
|
3069
3249
|
| 'create'
|
|
3070
3250
|
| 'delete'
|
|
3071
3251
|
| 'edit_creator'
|
|
3072
|
-
| 'replace_asset'
|
|
3073
|
-
| 'move';
|
|
3252
|
+
| 'replace_asset';
|
|
3074
3253
|
/**
|
|
3075
3254
|
* Permitted creator
|
|
3076
3255
|
*/
|
|
@@ -3083,8 +3262,6 @@ export type RoleUpdateSchema = {
|
|
|
3083
3262
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
3084
3263
|
*/
|
|
3085
3264
|
locale?: string | null;
|
|
3086
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
3087
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
3088
3265
|
}[];
|
|
3089
3266
|
/**
|
|
3090
3267
|
* Prohibited actions on a model (or all) for a role
|
|
@@ -3101,8 +3278,7 @@ export type RoleUpdateSchema = {
|
|
|
3101
3278
|
| 'create'
|
|
3102
3279
|
| 'delete'
|
|
3103
3280
|
| 'edit_creator'
|
|
3104
|
-
| 'replace_asset'
|
|
3105
|
-
| 'move';
|
|
3281
|
+
| 'replace_asset';
|
|
3106
3282
|
/**
|
|
3107
3283
|
* Permitted creator
|
|
3108
3284
|
*/
|
|
@@ -3115,8 +3291,6 @@ export type RoleUpdateSchema = {
|
|
|
3115
3291
|
* Permitted localized content in this locale. Required when `localization_scope` is `localized`
|
|
3116
3292
|
*/
|
|
3117
3293
|
locale?: string | null;
|
|
3118
|
-
upload_collection?: UploadCollectionIdentity | null;
|
|
3119
|
-
move_to_upload_collection?: UploadCollectionIdentity | null;
|
|
3120
3294
|
}[];
|
|
3121
3295
|
/**
|
|
3122
3296
|
* Allowed build triggers for a role
|
|
@@ -3130,6 +3304,18 @@ export type RoleUpdateSchema = {
|
|
|
3130
3304
|
negative_build_trigger_permissions?: {
|
|
3131
3305
|
build_trigger?: BuildTriggerIdentity | null;
|
|
3132
3306
|
}[];
|
|
3307
|
+
/**
|
|
3308
|
+
* Allowed site search sources for a role
|
|
3309
|
+
*/
|
|
3310
|
+
positive_site_search_source_permissions?: {
|
|
3311
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
3312
|
+
}[];
|
|
3313
|
+
/**
|
|
3314
|
+
* Prohibited site search sources for a role
|
|
3315
|
+
*/
|
|
3316
|
+
negative_site_search_source_permissions?: {
|
|
3317
|
+
site_search_source?: SiteSearchSourceIdentity | null;
|
|
3318
|
+
}[];
|
|
3133
3319
|
inherits_permissions_from?: RoleData[];
|
|
3134
3320
|
meta?: RoleMeta;
|
|
3135
3321
|
};
|
|
@@ -3830,6 +4016,10 @@ export type SitePlan = {
|
|
|
3830
4016
|
* Number of build triggers
|
|
3831
4017
|
*/
|
|
3832
4018
|
build_triggers: null | number;
|
|
4019
|
+
/**
|
|
4020
|
+
* Number of site search sources
|
|
4021
|
+
*/
|
|
4022
|
+
site_search_sources: null | number;
|
|
3833
4023
|
/**
|
|
3834
4024
|
* Number of plugins
|
|
3835
4025
|
*/
|
|
@@ -3994,6 +4184,10 @@ export type SitePlan = {
|
|
|
3994
4184
|
amount_per_packet: number;
|
|
3995
4185
|
price: number;
|
|
3996
4186
|
};
|
|
4187
|
+
site_search_sources?: {
|
|
4188
|
+
amount_per_packet: number;
|
|
4189
|
+
price: number;
|
|
4190
|
+
};
|
|
3997
4191
|
access_tokens?: {
|
|
3998
4192
|
amount_per_packet: number;
|
|
3999
4193
|
price: number;
|
|
@@ -4066,6 +4260,10 @@ export type SitePlanAttributes = {
|
|
|
4066
4260
|
* Number of build triggers
|
|
4067
4261
|
*/
|
|
4068
4262
|
build_triggers: null | number;
|
|
4263
|
+
/**
|
|
4264
|
+
* Number of site search sources
|
|
4265
|
+
*/
|
|
4266
|
+
site_search_sources: null | number;
|
|
4069
4267
|
/**
|
|
4070
4268
|
* Number of plugins
|
|
4071
4269
|
*/
|
|
@@ -4230,6 +4428,10 @@ export type SitePlanAttributes = {
|
|
|
4230
4428
|
amount_per_packet: number;
|
|
4231
4429
|
price: number;
|
|
4232
4430
|
};
|
|
4431
|
+
site_search_sources?: {
|
|
4432
|
+
amount_per_packet: number;
|
|
4433
|
+
price: number;
|
|
4434
|
+
};
|
|
4233
4435
|
access_tokens?: {
|
|
4234
4436
|
amount_per_packet: number;
|
|
4235
4437
|
price: number;
|
|
@@ -5270,11 +5472,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
5270
5472
|
* <details>
|
|
5271
5473
|
* <summary>Multi-line text (<code>text</code>)</summary>
|
|
5272
5474
|
*
|
|
5273
|
-
* | Property | Value
|
|
5274
|
-
* | ------------------------------ |
|
|
5275
|
-
* | Code | `text`
|
|
5276
|
-
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea`
|
|
5277
|
-
* | Available validators | `required`, `length`, `format`, `
|
|
5475
|
+
* | Property | Value |
|
|
5476
|
+
* | ------------------------------ | ------------------------------------------------ |
|
|
5477
|
+
* | Code | `text` |
|
|
5478
|
+
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
|
|
5479
|
+
* | Available validators | `required`, `length`, `format`, `sanitized_html` |
|
|
5278
5480
|
*
|
|
5279
5481
|
* </details>
|
|
5280
5482
|
*
|
|
@@ -5380,11 +5582,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
5380
5582
|
* <details>
|
|
5381
5583
|
* <summary>Slug (<code>slug</code>)</summary>
|
|
5382
5584
|
*
|
|
5383
|
-
* | Property | Value
|
|
5384
|
-
* | ------------------------------ |
|
|
5385
|
-
* | Code | `slug`
|
|
5386
|
-
* | Built-in editors for the field | `slug`
|
|
5387
|
-
* | Available validators | `required`, `length`, `slug_format`, `slug_title_field` |
|
|
5585
|
+
* | Property | Value |
|
|
5586
|
+
* | ------------------------------ | ----------------------------------------------------------------- |
|
|
5587
|
+
* | Code | `slug` |
|
|
5588
|
+
* | Built-in editors for the field | `slug` |
|
|
5589
|
+
* | Available validators | `required`, `unique`, `length`, `slug_format`, `slug_title_field` |
|
|
5388
5590
|
*
|
|
5389
5591
|
* </details>
|
|
5390
5592
|
*
|
|
@@ -5474,12 +5676,12 @@ export type ItemTypeUpdateSchema = {
|
|
|
5474
5676
|
* <details>
|
|
5475
5677
|
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
5476
5678
|
*
|
|
5477
|
-
* | Property | Value
|
|
5478
|
-
* | ------------------------------ |
|
|
5479
|
-
* | Code | `structured_text`
|
|
5480
|
-
* | Built-in editors for the field | `structured_text`
|
|
5481
|
-
* | Required validators | `structured_text_blocks`, `structured_text_links`
|
|
5482
|
-
* | Other validators available | `length`, `structured_text_inline_blocks`
|
|
5679
|
+
* | Property | Value |
|
|
5680
|
+
* | ------------------------------ | ----------------------------------------------------- |
|
|
5681
|
+
* | Code | `structured_text` |
|
|
5682
|
+
* | Built-in editors for the field | `structured_text` |
|
|
5683
|
+
* | Required validators | `structured_text_blocks`, `structured_text_links` |
|
|
5684
|
+
* | Other validators available | `required`, `length`, `structured_text_inline_blocks` |
|
|
5483
5685
|
*
|
|
5484
5686
|
* </details>
|
|
5485
5687
|
*
|
|
@@ -5793,9 +5995,9 @@ export type ItemTypeUpdateSchema = {
|
|
|
5793
5995
|
* </details>
|
|
5794
5996
|
*
|
|
5795
5997
|
* <details>
|
|
5796
|
-
* <summary><code>
|
|
5998
|
+
* <summary><code>sanitized_html</code></summary>
|
|
5797
5999
|
*
|
|
5798
|
-
* Checks for the presence of malicious
|
|
6000
|
+
* Checks for the presence of malicious code in HTML fields: content is valid if no dangerous code is present.
|
|
5799
6001
|
*
|
|
5800
6002
|
* | Parameter | Type | Required | Description |
|
|
5801
6003
|
* | ---------------------------- | --------- | -------- | ------------------------------------------------------------ |
|
|
@@ -6022,10 +6224,10 @@ export type ItemTypeUpdateSchema = {
|
|
|
6022
6224
|
*
|
|
6023
6225
|
* Built-in editor for _seo_ fields.
|
|
6024
6226
|
*
|
|
6025
|
-
* | Parameter | Type | Required | Description
|
|
6026
|
-
* | ---------- | --------------- | -------- |
|
|
6027
|
-
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"`
|
|
6028
|
-
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"
|
|
6227
|
+
* | Parameter | Type | Required | Description |
|
|
6228
|
+
* | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
6229
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
6230
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"`, `"linkedin"` |
|
|
6029
6231
|
*
|
|
6030
6232
|
* </details>
|
|
6031
6233
|
*
|
|
@@ -6212,7 +6414,6 @@ export type FieldStableShell = {
|
|
|
6212
6414
|
};
|
|
6213
6415
|
[k: string]: unknown;
|
|
6214
6416
|
}[];
|
|
6215
|
-
[k: string]: unknown;
|
|
6216
6417
|
};
|
|
6217
6418
|
/**
|
|
6218
6419
|
* Ordering index
|
|
@@ -6339,7 +6540,6 @@ export type FieldAttributesStableShell = {
|
|
|
6339
6540
|
};
|
|
6340
6541
|
[k: string]: unknown;
|
|
6341
6542
|
}[];
|
|
6342
|
-
[k: string]: unknown;
|
|
6343
6543
|
};
|
|
6344
6544
|
/**
|
|
6345
6545
|
* Ordering index
|
|
@@ -6454,7 +6654,6 @@ export type FieldCreateSchemaStableShell = {
|
|
|
6454
6654
|
};
|
|
6455
6655
|
[k: string]: unknown;
|
|
6456
6656
|
}[];
|
|
6457
|
-
[k: string]: unknown;
|
|
6458
6657
|
};
|
|
6459
6658
|
/**
|
|
6460
6659
|
* Ordering index
|
|
@@ -6562,7 +6761,6 @@ export type FieldUpdateSchemaStableShell = {
|
|
|
6562
6761
|
};
|
|
6563
6762
|
[k: string]: unknown;
|
|
6564
6763
|
}[];
|
|
6565
|
-
[k: string]: unknown;
|
|
6566
6764
|
};
|
|
6567
6765
|
/**
|
|
6568
6766
|
* Ordering index
|
|
@@ -7238,10 +7436,7 @@ export type BuildEvent = {
|
|
|
7238
7436
|
| 'response_success'
|
|
7239
7437
|
| 'response_failure'
|
|
7240
7438
|
| 'request_aborted'
|
|
7241
|
-
| 'response_unprocessable'
|
|
7242
|
-
| 'indexing_started'
|
|
7243
|
-
| 'indexing_success'
|
|
7244
|
-
| 'indexing_failure';
|
|
7439
|
+
| 'response_unprocessable';
|
|
7245
7440
|
/**
|
|
7246
7441
|
* The moment the activity occurred
|
|
7247
7442
|
*/
|
|
@@ -7291,10 +7486,7 @@ export type BuildEventAttributes = {
|
|
|
7291
7486
|
| 'response_success'
|
|
7292
7487
|
| 'response_failure'
|
|
7293
7488
|
| 'request_aborted'
|
|
7294
|
-
| 'response_unprocessable'
|
|
7295
|
-
| 'indexing_started'
|
|
7296
|
-
| 'indexing_success'
|
|
7297
|
-
| 'indexing_failure';
|
|
7489
|
+
| 'response_unprocessable';
|
|
7298
7490
|
/**
|
|
7299
7491
|
* The moment the activity occurred
|
|
7300
7492
|
*/
|
|
@@ -7315,6 +7507,91 @@ export type BuildEventAttributes = {
|
|
|
7315
7507
|
export type BuildEventRelationships = {
|
|
7316
7508
|
build_trigger: BuildTriggerData;
|
|
7317
7509
|
};
|
|
7510
|
+
/**
|
|
7511
|
+
* Represents an event occurred during the site search indexing process.
|
|
7512
|
+
*
|
|
7513
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7514
|
+
* via the `definition` "site_search_source_event".
|
|
7515
|
+
*/
|
|
7516
|
+
export type SiteSearchSourceEvent = {
|
|
7517
|
+
id: SiteSearchSourceEventIdentity;
|
|
7518
|
+
type: SiteSearchSourceEventType;
|
|
7519
|
+
/**
|
|
7520
|
+
* The type of activity
|
|
7521
|
+
*/
|
|
7522
|
+
event_type:
|
|
7523
|
+
| 'indexing_started'
|
|
7524
|
+
| 'indexing_success'
|
|
7525
|
+
| 'indexing_failure'
|
|
7526
|
+
| 'indexing_aborted';
|
|
7527
|
+
/**
|
|
7528
|
+
* The moment the activity occurred
|
|
7529
|
+
*/
|
|
7530
|
+
created_at: string;
|
|
7531
|
+
/**
|
|
7532
|
+
* Any details regarding the event
|
|
7533
|
+
*/
|
|
7534
|
+
data: {
|
|
7535
|
+
[k: string]: unknown;
|
|
7536
|
+
};
|
|
7537
|
+
site_search_source: SiteSearchSourceData;
|
|
7538
|
+
};
|
|
7539
|
+
export type SiteSearchSourceEventSelfTargetSchema = SiteSearchSourceEvent;
|
|
7540
|
+
/**
|
|
7541
|
+
* JSON API data
|
|
7542
|
+
*
|
|
7543
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
7544
|
+
* via the `definition` "data".
|
|
7545
|
+
*/
|
|
7546
|
+
export type SiteSearchSourceData = {
|
|
7547
|
+
type: SiteSearchSourceType;
|
|
7548
|
+
id: SiteSearchSourceIdentity;
|
|
7549
|
+
};
|
|
7550
|
+
/**
|
|
7551
|
+
* JSON API data
|
|
7552
|
+
*
|
|
7553
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7554
|
+
* via the `definition` "data".
|
|
7555
|
+
*/
|
|
7556
|
+
export type SiteSearchSourceEventData = {
|
|
7557
|
+
type: SiteSearchSourceEventType;
|
|
7558
|
+
id: SiteSearchSourceEventIdentity;
|
|
7559
|
+
};
|
|
7560
|
+
/**
|
|
7561
|
+
* JSON API attributes
|
|
7562
|
+
*
|
|
7563
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7564
|
+
* via the `definition` "attributes".
|
|
7565
|
+
*/
|
|
7566
|
+
export type SiteSearchSourceEventAttributes = {
|
|
7567
|
+
/**
|
|
7568
|
+
* The type of activity
|
|
7569
|
+
*/
|
|
7570
|
+
event_type:
|
|
7571
|
+
| 'indexing_started'
|
|
7572
|
+
| 'indexing_success'
|
|
7573
|
+
| 'indexing_failure'
|
|
7574
|
+
| 'indexing_aborted';
|
|
7575
|
+
/**
|
|
7576
|
+
* The moment the activity occurred
|
|
7577
|
+
*/
|
|
7578
|
+
created_at: string;
|
|
7579
|
+
/**
|
|
7580
|
+
* Any details regarding the event
|
|
7581
|
+
*/
|
|
7582
|
+
data: {
|
|
7583
|
+
[k: string]: unknown;
|
|
7584
|
+
};
|
|
7585
|
+
};
|
|
7586
|
+
/**
|
|
7587
|
+
* JSON API links
|
|
7588
|
+
*
|
|
7589
|
+
* This interface was referenced by `SiteSearchSourceEvent`'s JSON-Schema
|
|
7590
|
+
* via the `definition` "relationships".
|
|
7591
|
+
*/
|
|
7592
|
+
export type SiteSearchSourceEventRelationships = {
|
|
7593
|
+
site_search_source: SiteSearchSourceData;
|
|
7594
|
+
};
|
|
7318
7595
|
export type ItemCreateTargetSchema<
|
|
7319
7596
|
D extends ItemTypeDefinition = ItemTypeDefinition,
|
|
7320
7597
|
NestedMode extends boolean = false,
|
|
@@ -8403,7 +8680,6 @@ export type UploadRequestCreateSchema = {
|
|
|
8403
8680
|
* The original file name
|
|
8404
8681
|
*/
|
|
8405
8682
|
filename?: string;
|
|
8406
|
-
upload_collection?: UploadCollectionData | null;
|
|
8407
8683
|
};
|
|
8408
8684
|
/**
|
|
8409
8685
|
* 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.
|
|
@@ -9501,6 +9777,10 @@ export type BuildTrigger = {
|
|
|
9501
9777
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9502
9778
|
*/
|
|
9503
9779
|
indexing_enabled: boolean;
|
|
9780
|
+
/**
|
|
9781
|
+
* Whether the build trigger is enabled or not
|
|
9782
|
+
*/
|
|
9783
|
+
enabled: boolean;
|
|
9504
9784
|
};
|
|
9505
9785
|
export type BuildTriggerSelfTargetSchema = BuildTrigger;
|
|
9506
9786
|
export type BuildTriggerCreateTargetSchema = BuildTrigger;
|
|
@@ -9559,6 +9839,10 @@ export type BuildTriggerAttributes = {
|
|
|
9559
9839
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9560
9840
|
*/
|
|
9561
9841
|
indexing_enabled: boolean;
|
|
9842
|
+
/**
|
|
9843
|
+
* Whether the build trigger is enabled or not
|
|
9844
|
+
*/
|
|
9845
|
+
enabled: boolean;
|
|
9562
9846
|
};
|
|
9563
9847
|
/**
|
|
9564
9848
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
@@ -9582,6 +9866,10 @@ export type BuildTriggerCreateSchema = {
|
|
|
9582
9866
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9583
9867
|
*/
|
|
9584
9868
|
indexing_enabled: boolean;
|
|
9869
|
+
/**
|
|
9870
|
+
* Whether the build trigger is enabled or not
|
|
9871
|
+
*/
|
|
9872
|
+
enabled?: boolean;
|
|
9585
9873
|
/**
|
|
9586
9874
|
* 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
|
|
9587
9875
|
*/
|
|
@@ -9616,6 +9904,10 @@ export type BuildTriggerUpdateSchema = {
|
|
|
9616
9904
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9617
9905
|
*/
|
|
9618
9906
|
indexing_enabled?: boolean;
|
|
9907
|
+
/**
|
|
9908
|
+
* Whether the build trigger is enabled or not
|
|
9909
|
+
*/
|
|
9910
|
+
enabled?: boolean;
|
|
9619
9911
|
/**
|
|
9620
9912
|
* 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
|
|
9621
9913
|
*/
|
|
@@ -9631,6 +9923,152 @@ export type BuildTriggerUpdateSchema = {
|
|
|
9631
9923
|
[k: string]: unknown;
|
|
9632
9924
|
};
|
|
9633
9925
|
};
|
|
9926
|
+
/**
|
|
9927
|
+
* 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.
|
|
9928
|
+
*
|
|
9929
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
9930
|
+
* via the `definition` "site_search_source".
|
|
9931
|
+
*/
|
|
9932
|
+
export type SiteSearchSource = {
|
|
9933
|
+
id: SiteSearchSourceIdentity;
|
|
9934
|
+
type: SiteSearchSourceType;
|
|
9935
|
+
/**
|
|
9936
|
+
* Name of the site search source
|
|
9937
|
+
*/
|
|
9938
|
+
name: string;
|
|
9939
|
+
/**
|
|
9940
|
+
* Whether the site search source is enabled or not
|
|
9941
|
+
*/
|
|
9942
|
+
enabled: boolean;
|
|
9943
|
+
/**
|
|
9944
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
9945
|
+
*/
|
|
9946
|
+
build_trigger_indexing_enabled: boolean;
|
|
9947
|
+
/**
|
|
9948
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9949
|
+
*/
|
|
9950
|
+
frontend_url: string | null;
|
|
9951
|
+
/**
|
|
9952
|
+
* Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
|
|
9953
|
+
*/
|
|
9954
|
+
user_agent_suffix: string | null;
|
|
9955
|
+
build_triggers: BuildTriggerData[];
|
|
9956
|
+
meta: SiteSearchSourceMeta;
|
|
9957
|
+
};
|
|
9958
|
+
export type SiteSearchSourceSelfTargetSchema = SiteSearchSource;
|
|
9959
|
+
export type SiteSearchSourceCreateTargetSchema = SiteSearchSource;
|
|
9960
|
+
export type SiteSearchSourceUpdateTargetSchema = SiteSearchSource;
|
|
9961
|
+
export type SiteSearchSourceDestroyTargetSchema = SiteSearchSource;
|
|
9962
|
+
/**
|
|
9963
|
+
* Meta information about the site search source
|
|
9964
|
+
*
|
|
9965
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
9966
|
+
* via the `definition` "meta".
|
|
9967
|
+
*/
|
|
9968
|
+
export type SiteSearchSourceMeta = {
|
|
9969
|
+
/**
|
|
9970
|
+
* Status of the site search indexing
|
|
9971
|
+
*/
|
|
9972
|
+
indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
|
|
9973
|
+
/**
|
|
9974
|
+
* Timestamp of the last completed indexing
|
|
9975
|
+
*/
|
|
9976
|
+
last_indexing_completed_at: string | null;
|
|
9977
|
+
};
|
|
9978
|
+
/**
|
|
9979
|
+
* JSON API attributes
|
|
9980
|
+
*
|
|
9981
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
9982
|
+
* via the `definition` "attributes".
|
|
9983
|
+
*/
|
|
9984
|
+
export type SiteSearchSourceAttributes = {
|
|
9985
|
+
/**
|
|
9986
|
+
* Name of the site search source
|
|
9987
|
+
*/
|
|
9988
|
+
name: string;
|
|
9989
|
+
/**
|
|
9990
|
+
* Whether the site search source is enabled or not
|
|
9991
|
+
*/
|
|
9992
|
+
enabled: boolean;
|
|
9993
|
+
/**
|
|
9994
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
9995
|
+
*/
|
|
9996
|
+
build_trigger_indexing_enabled: boolean;
|
|
9997
|
+
/**
|
|
9998
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9999
|
+
*/
|
|
10000
|
+
frontend_url: string | null;
|
|
10001
|
+
/**
|
|
10002
|
+
* Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
|
|
10003
|
+
*/
|
|
10004
|
+
user_agent_suffix: string | null;
|
|
10005
|
+
};
|
|
10006
|
+
/**
|
|
10007
|
+
* JSON API links
|
|
10008
|
+
*
|
|
10009
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10010
|
+
* via the `definition` "relationships".
|
|
10011
|
+
*/
|
|
10012
|
+
export type SiteSearchSourceRelationships = {
|
|
10013
|
+
build_triggers: BuildTriggerData[];
|
|
10014
|
+
};
|
|
10015
|
+
/**
|
|
10016
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10017
|
+
* via the `create.schema` link.
|
|
10018
|
+
*/
|
|
10019
|
+
export type SiteSearchSourceCreateSchema = {
|
|
10020
|
+
type?: SiteSearchSourceType;
|
|
10021
|
+
/**
|
|
10022
|
+
* Name of the site search source
|
|
10023
|
+
*/
|
|
10024
|
+
name: string;
|
|
10025
|
+
/**
|
|
10026
|
+
* Whether the site search source is enabled or not
|
|
10027
|
+
*/
|
|
10028
|
+
enabled: boolean;
|
|
10029
|
+
/**
|
|
10030
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
10031
|
+
*/
|
|
10032
|
+
build_trigger_indexing_enabled?: boolean;
|
|
10033
|
+
/**
|
|
10034
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10035
|
+
*/
|
|
10036
|
+
frontend_url: string | null;
|
|
10037
|
+
/**
|
|
10038
|
+
* Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
|
|
10039
|
+
*/
|
|
10040
|
+
user_agent_suffix?: string | null;
|
|
10041
|
+
build_triggers?: BuildTriggerData[];
|
|
10042
|
+
};
|
|
10043
|
+
/**
|
|
10044
|
+
* This interface was referenced by `SiteSearchSource`'s JSON-Schema
|
|
10045
|
+
* via the `update.schema` link.
|
|
10046
|
+
*/
|
|
10047
|
+
export type SiteSearchSourceUpdateSchema = {
|
|
10048
|
+
id?: SiteSearchSourceIdentity;
|
|
10049
|
+
type?: SiteSearchSourceType;
|
|
10050
|
+
/**
|
|
10051
|
+
* Name of the site search source
|
|
10052
|
+
*/
|
|
10053
|
+
name?: string;
|
|
10054
|
+
/**
|
|
10055
|
+
* Whether the site search source is enabled or not
|
|
10056
|
+
*/
|
|
10057
|
+
enabled?: boolean;
|
|
10058
|
+
/**
|
|
10059
|
+
* Whether the spidering should automatically run after associated build triggers complete
|
|
10060
|
+
*/
|
|
10061
|
+
build_trigger_indexing_enabled?: boolean;
|
|
10062
|
+
/**
|
|
10063
|
+
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10064
|
+
*/
|
|
10065
|
+
frontend_url?: string | null;
|
|
10066
|
+
/**
|
|
10067
|
+
* Optional suffix to append to the DatoCmsSearchBot user agent when indexing the website
|
|
10068
|
+
*/
|
|
10069
|
+
user_agent_suffix?: string | null;
|
|
10070
|
+
build_triggers?: BuildTriggerData[];
|
|
10071
|
+
};
|
|
9634
10072
|
/**
|
|
9635
10073
|
* In DatoCMS you can create filters to help you (and other editors) quickly search for records
|
|
9636
10074
|
*
|