@datocms/cma-client 5.2.0-alpha.4 → 5.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/cjs/generated/Client.js +1 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/ItemType.js +12 -12
- package/dist/cjs/generated/resources/SearchIndex.js +10 -22
- package/dist/cjs/generated/resources/SearchIndex.js.map +1 -1
- package/dist/cjs/utilities/schemaRepository.js +132 -1
- package/dist/cjs/utilities/schemaRepository.js.map +1 -1
- package/dist/esm/generated/ApiTypes.d.ts +177 -158
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/RawApiTypes.d.ts +156 -141
- package/dist/esm/generated/resources/ItemType.d.ts +12 -12
- package/dist/esm/generated/resources/ItemType.js +12 -12
- package/dist/esm/generated/resources/SearchIndex.d.ts +8 -8
- package/dist/esm/generated/resources/SearchIndex.js +10 -22
- package/dist/esm/generated/resources/SearchIndex.js.map +1 -1
- package/dist/esm/utilities/schemaRepository.d.ts +42 -2
- package/dist/esm/utilities/schemaRepository.js +133 -2
- package/dist/esm/utilities/schemaRepository.js.map +1 -1
- package/dist/types/generated/ApiTypes.d.ts +177 -158
- package/dist/types/generated/RawApiTypes.d.ts +156 -141
- package/dist/types/generated/resources/ItemType.d.ts +12 -12
- package/dist/types/generated/resources/SearchIndex.d.ts +8 -8
- package/dist/types/utilities/schemaRepository.d.ts +42 -2
- package/package.json +3 -3
- package/resources.json +10 -12
- package/src/generated/ApiTypes.ts +177 -158
- package/src/generated/Client.ts +1 -1
- package/src/generated/RawApiTypes.ts +156 -141
- package/src/generated/resources/ItemType.ts +12 -12
- package/src/generated/resources/SearchIndex.ts +10 -22
- package/src/utilities/schemaRepository.ts +168 -10
|
@@ -764,19 +764,19 @@ export type ItemInstancesHrefSchema<
|
|
|
764
764
|
*/
|
|
765
765
|
filter?: {
|
|
766
766
|
/**
|
|
767
|
-
* Record (or block record) IDs to fetch, comma separated. If you use this filter, you _must not_ use `filter[type]`
|
|
767
|
+
* Record (or block record) IDs to fetch, comma separated. If you use this filter, you _must not_ use `filter[type]`. You can combine it with meta fields (like `_published_at`, `_status`), but _must not_ use model-specific fields
|
|
768
768
|
*/
|
|
769
769
|
ids?: string;
|
|
770
770
|
/**
|
|
771
|
-
* Model ID or `api_key` to filter. If you use this filter, you _must not_ use `filter[ids]`.
|
|
771
|
+
* Model/Block model ID or `api_key` to filter. If you use this filter, you _must not_ use `filter[ids]`. When passing a single element, you can use both meta fields and model-specific fields (note: model-specific fields only work with models, not block models). When passing multiple comma-separated values, you can use meta fields but _must not_ use model-specific fields
|
|
772
772
|
*/
|
|
773
773
|
type?: string;
|
|
774
774
|
/**
|
|
775
|
-
* Textual query to match.
|
|
775
|
+
* Textual query to match. Can be combined with other filters. When used, only records (not blocks) are returned. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
|
|
776
776
|
*/
|
|
777
777
|
query?: string;
|
|
778
778
|
/**
|
|
779
|
-
*
|
|
779
|
+
* Filter by record fields. Meta fields (like `_published_at`, `_status`) can be used in most cases. Model-specific fields (like `title`, `name`) require `filter[type]` to specify a single model, and only work with models (not block models). Same syntax as [GraphQL API records filters](/docs/content-delivery-api/filtering-records): use square brackets to indicate nesting levels. E.g. `filter[fields][parent][eq]=<ID_VALUE>`. Use snake_case for field names. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
|
|
780
780
|
*/
|
|
781
781
|
fields?: ToItemHrefSchemaField<D>;
|
|
782
782
|
/**
|
|
@@ -837,7 +837,7 @@ export type ItemSelfHrefSchema = {
|
|
|
837
837
|
*/
|
|
838
838
|
nested?: boolean;
|
|
839
839
|
/**
|
|
840
|
-
* Whether you want the currently published versions (`published
|
|
840
|
+
* Whether you want the currently published versions (`published`) of your records, or the latest available (`current`, default)
|
|
841
841
|
*/
|
|
842
842
|
version?: string;
|
|
843
843
|
[k: string]: unknown;
|
|
@@ -1150,11 +1150,11 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
1150
1150
|
*/
|
|
1151
1151
|
query: string;
|
|
1152
1152
|
/**
|
|
1153
|
-
* The search index ID
|
|
1153
|
+
* The search index ID on which the search will be performed. If not provided, the first enabled search index will be used.
|
|
1154
1154
|
*/
|
|
1155
1155
|
search_index_id?: string;
|
|
1156
1156
|
/**
|
|
1157
|
-
*
|
|
1157
|
+
* The build trigger ID or name on which the search will be performed.
|
|
1158
1158
|
*/
|
|
1159
1159
|
build_trigger_id?: string;
|
|
1160
1160
|
/**
|
|
@@ -1679,7 +1679,7 @@ export type RoleAttributes = {
|
|
|
1679
1679
|
*/
|
|
1680
1680
|
can_edit_site: boolean;
|
|
1681
1681
|
/**
|
|
1682
|
-
* Can create
|
|
1682
|
+
* Can create and edit models and plugins
|
|
1683
1683
|
*/
|
|
1684
1684
|
can_edit_schema: boolean;
|
|
1685
1685
|
/**
|
|
@@ -1699,31 +1699,31 @@ export type RoleAttributes = {
|
|
|
1699
1699
|
*/
|
|
1700
1700
|
environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
1701
1701
|
/**
|
|
1702
|
-
* Can create
|
|
1702
|
+
* Can create and edit roles and invite/remove collaborators
|
|
1703
1703
|
*/
|
|
1704
1704
|
can_manage_users: boolean;
|
|
1705
1705
|
/**
|
|
1706
|
-
* Can create
|
|
1706
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
1707
1707
|
*/
|
|
1708
1708
|
can_manage_shared_filters: boolean;
|
|
1709
1709
|
/**
|
|
1710
|
-
* Can create
|
|
1710
|
+
* Can create and edit upload collections
|
|
1711
1711
|
*/
|
|
1712
1712
|
can_manage_upload_collections: boolean;
|
|
1713
1713
|
/**
|
|
1714
|
-
* Can create
|
|
1714
|
+
* Can create and edit build triggers
|
|
1715
1715
|
*/
|
|
1716
1716
|
can_manage_build_triggers: boolean;
|
|
1717
1717
|
/**
|
|
1718
|
-
* Can create
|
|
1718
|
+
* Can create and edit search indexes
|
|
1719
1719
|
*/
|
|
1720
1720
|
can_manage_search_indexes: boolean;
|
|
1721
1721
|
/**
|
|
1722
|
-
* Can create
|
|
1722
|
+
* Can create and edit webhooks
|
|
1723
1723
|
*/
|
|
1724
1724
|
can_manage_webhooks: boolean;
|
|
1725
1725
|
/**
|
|
1726
|
-
* Can create
|
|
1726
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
1727
1727
|
*/
|
|
1728
1728
|
can_manage_environments: boolean;
|
|
1729
1729
|
/**
|
|
@@ -1735,7 +1735,7 @@ export type RoleAttributes = {
|
|
|
1735
1735
|
*/
|
|
1736
1736
|
can_access_audit_log: boolean;
|
|
1737
1737
|
/**
|
|
1738
|
-
* Can create
|
|
1738
|
+
* Can create and edit workflows
|
|
1739
1739
|
*/
|
|
1740
1740
|
can_manage_workflows: boolean;
|
|
1741
1741
|
/**
|
|
@@ -1897,13 +1897,13 @@ export type RoleAttributes = {
|
|
|
1897
1897
|
build_trigger?: BuildTriggerIdentity | null;
|
|
1898
1898
|
}[];
|
|
1899
1899
|
/**
|
|
1900
|
-
*
|
|
1900
|
+
* Search indexes that can be triggered by a role
|
|
1901
1901
|
*/
|
|
1902
1902
|
positive_search_index_permissions: {
|
|
1903
1903
|
search_index?: SearchIndexIdentity | null;
|
|
1904
1904
|
}[];
|
|
1905
1905
|
/**
|
|
1906
|
-
*
|
|
1906
|
+
* Search indexes that can't be triggered by a role
|
|
1907
1907
|
*/
|
|
1908
1908
|
negative_search_index_permissions: {
|
|
1909
1909
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -1953,7 +1953,7 @@ export type RoleMeta = {
|
|
|
1953
1953
|
*/
|
|
1954
1954
|
can_edit_site: boolean;
|
|
1955
1955
|
/**
|
|
1956
|
-
* Can create
|
|
1956
|
+
* Can create and edit models and plugins
|
|
1957
1957
|
*/
|
|
1958
1958
|
can_edit_schema: boolean;
|
|
1959
1959
|
/**
|
|
@@ -1973,31 +1973,31 @@ export type RoleMeta = {
|
|
|
1973
1973
|
*/
|
|
1974
1974
|
environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
1975
1975
|
/**
|
|
1976
|
-
* Can create
|
|
1976
|
+
* Can create and edit roles and invite/remove collaborators
|
|
1977
1977
|
*/
|
|
1978
1978
|
can_manage_users: boolean;
|
|
1979
1979
|
/**
|
|
1980
|
-
* Can create
|
|
1980
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
1981
1981
|
*/
|
|
1982
1982
|
can_manage_shared_filters: boolean;
|
|
1983
1983
|
/**
|
|
1984
|
-
* Can create
|
|
1984
|
+
* Can create and edit upload collections
|
|
1985
1985
|
*/
|
|
1986
1986
|
can_manage_upload_collections: boolean;
|
|
1987
1987
|
/**
|
|
1988
|
-
* Can create
|
|
1988
|
+
* Can create and edit build triggers
|
|
1989
1989
|
*/
|
|
1990
1990
|
can_manage_build_triggers: boolean;
|
|
1991
1991
|
/**
|
|
1992
|
-
* Can create
|
|
1992
|
+
* Can create and edit search indexes
|
|
1993
1993
|
*/
|
|
1994
1994
|
can_manage_search_indexes: boolean;
|
|
1995
1995
|
/**
|
|
1996
|
-
* Can create
|
|
1996
|
+
* Can create and edit webhooks
|
|
1997
1997
|
*/
|
|
1998
1998
|
can_manage_webhooks: boolean;
|
|
1999
1999
|
/**
|
|
2000
|
-
* Can create
|
|
2000
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2001
2001
|
*/
|
|
2002
2002
|
can_manage_environments: boolean;
|
|
2003
2003
|
/**
|
|
@@ -2009,7 +2009,7 @@ export type RoleMeta = {
|
|
|
2009
2009
|
*/
|
|
2010
2010
|
can_access_audit_log: boolean;
|
|
2011
2011
|
/**
|
|
2012
|
-
* Can create
|
|
2012
|
+
* Can create and edit workflows
|
|
2013
2013
|
*/
|
|
2014
2014
|
can_manage_workflows: boolean;
|
|
2015
2015
|
/**
|
|
@@ -2171,13 +2171,13 @@ export type RoleMeta = {
|
|
|
2171
2171
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2172
2172
|
}[];
|
|
2173
2173
|
/**
|
|
2174
|
-
*
|
|
2174
|
+
* Search indexes that can be triggered by a role
|
|
2175
2175
|
*/
|
|
2176
2176
|
positive_search_index_permissions: {
|
|
2177
2177
|
search_index?: SearchIndexIdentity | null;
|
|
2178
2178
|
}[];
|
|
2179
2179
|
/**
|
|
2180
|
-
*
|
|
2180
|
+
* Search indexes that can't be triggered by a role
|
|
2181
2181
|
*/
|
|
2182
2182
|
negative_search_index_permissions: {
|
|
2183
2183
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -2208,7 +2208,7 @@ export type RoleCreateSchema = {
|
|
|
2208
2208
|
*/
|
|
2209
2209
|
can_edit_site?: boolean;
|
|
2210
2210
|
/**
|
|
2211
|
-
* Can create
|
|
2211
|
+
* Can create and edit models and plugins
|
|
2212
2212
|
*/
|
|
2213
2213
|
can_edit_schema?: boolean;
|
|
2214
2214
|
/**
|
|
@@ -2228,31 +2228,31 @@ export type RoleCreateSchema = {
|
|
|
2228
2228
|
*/
|
|
2229
2229
|
environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2230
2230
|
/**
|
|
2231
|
-
* Can create
|
|
2231
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2232
2232
|
*/
|
|
2233
2233
|
can_manage_users?: boolean;
|
|
2234
2234
|
/**
|
|
2235
|
-
* Can create
|
|
2235
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2236
2236
|
*/
|
|
2237
2237
|
can_manage_shared_filters?: boolean;
|
|
2238
2238
|
/**
|
|
2239
|
-
* Can create
|
|
2239
|
+
* Can create and edit search indexes
|
|
2240
2240
|
*/
|
|
2241
2241
|
can_manage_search_indexes?: boolean;
|
|
2242
2242
|
/**
|
|
2243
|
-
* Can create
|
|
2243
|
+
* Can create and edit upload collections
|
|
2244
2244
|
*/
|
|
2245
2245
|
can_manage_upload_collections?: boolean;
|
|
2246
2246
|
/**
|
|
2247
|
-
* Can create
|
|
2247
|
+
* Can create and edit build triggers
|
|
2248
2248
|
*/
|
|
2249
2249
|
can_manage_build_triggers?: boolean;
|
|
2250
2250
|
/**
|
|
2251
|
-
* Can create
|
|
2251
|
+
* Can create and edit webhooks
|
|
2252
2252
|
*/
|
|
2253
2253
|
can_manage_webhooks?: boolean;
|
|
2254
2254
|
/**
|
|
2255
|
-
* Can create
|
|
2255
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2256
2256
|
*/
|
|
2257
2257
|
can_manage_environments?: boolean;
|
|
2258
2258
|
/**
|
|
@@ -2264,7 +2264,7 @@ export type RoleCreateSchema = {
|
|
|
2264
2264
|
*/
|
|
2265
2265
|
can_access_audit_log?: boolean;
|
|
2266
2266
|
/**
|
|
2267
|
-
* Can create
|
|
2267
|
+
* Can create and edit workflows
|
|
2268
2268
|
*/
|
|
2269
2269
|
can_manage_workflows?: boolean;
|
|
2270
2270
|
/**
|
|
@@ -2426,13 +2426,13 @@ export type RoleCreateSchema = {
|
|
|
2426
2426
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2427
2427
|
}[];
|
|
2428
2428
|
/**
|
|
2429
|
-
*
|
|
2429
|
+
* Search indexes that can be triggered by a role
|
|
2430
2430
|
*/
|
|
2431
2431
|
positive_search_index_permissions?: {
|
|
2432
2432
|
search_index?: SearchIndexIdentity | null;
|
|
2433
2433
|
}[];
|
|
2434
2434
|
/**
|
|
2435
|
-
*
|
|
2435
|
+
* Search indexes that can't be triggered by a role
|
|
2436
2436
|
*/
|
|
2437
2437
|
negative_search_index_permissions?: {
|
|
2438
2438
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -2484,7 +2484,7 @@ export type RoleUpdateSchema = {
|
|
|
2484
2484
|
*/
|
|
2485
2485
|
can_edit_site?: boolean;
|
|
2486
2486
|
/**
|
|
2487
|
-
* Can create
|
|
2487
|
+
* Can create and edit models and plugins
|
|
2488
2488
|
*/
|
|
2489
2489
|
can_edit_schema?: boolean;
|
|
2490
2490
|
/**
|
|
@@ -2504,31 +2504,31 @@ export type RoleUpdateSchema = {
|
|
|
2504
2504
|
*/
|
|
2505
2505
|
environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2506
2506
|
/**
|
|
2507
|
-
* Can create
|
|
2507
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2508
2508
|
*/
|
|
2509
2509
|
can_manage_users?: boolean;
|
|
2510
2510
|
/**
|
|
2511
|
-
* Can create
|
|
2511
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2512
2512
|
*/
|
|
2513
2513
|
can_manage_shared_filters?: boolean;
|
|
2514
2514
|
/**
|
|
2515
|
-
* Can create
|
|
2515
|
+
* Can create and edit search indexes
|
|
2516
2516
|
*/
|
|
2517
2517
|
can_manage_search_indexes?: boolean;
|
|
2518
2518
|
/**
|
|
2519
|
-
* Can create
|
|
2519
|
+
* Can create and edit upload collections
|
|
2520
2520
|
*/
|
|
2521
2521
|
can_manage_upload_collections?: boolean;
|
|
2522
2522
|
/**
|
|
2523
|
-
* Can create
|
|
2523
|
+
* Can create and edit build triggers
|
|
2524
2524
|
*/
|
|
2525
2525
|
can_manage_build_triggers?: boolean;
|
|
2526
2526
|
/**
|
|
2527
|
-
* Can create
|
|
2527
|
+
* Can create and edit webhooks
|
|
2528
2528
|
*/
|
|
2529
2529
|
can_manage_webhooks?: boolean;
|
|
2530
2530
|
/**
|
|
2531
|
-
* Can create
|
|
2531
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2532
2532
|
*/
|
|
2533
2533
|
can_manage_environments?: boolean;
|
|
2534
2534
|
/**
|
|
@@ -2540,7 +2540,7 @@ export type RoleUpdateSchema = {
|
|
|
2540
2540
|
*/
|
|
2541
2541
|
can_access_audit_log?: boolean;
|
|
2542
2542
|
/**
|
|
2543
|
-
* Can create
|
|
2543
|
+
* Can create and edit workflows
|
|
2544
2544
|
*/
|
|
2545
2545
|
can_manage_workflows?: boolean;
|
|
2546
2546
|
/**
|
|
@@ -2702,13 +2702,13 @@ export type RoleUpdateSchema = {
|
|
|
2702
2702
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2703
2703
|
}[];
|
|
2704
2704
|
/**
|
|
2705
|
-
*
|
|
2705
|
+
* Search indexes that can be triggered by a role
|
|
2706
2706
|
*/
|
|
2707
2707
|
positive_search_index_permissions?: {
|
|
2708
2708
|
search_index?: SearchIndexIdentity | null;
|
|
2709
2709
|
}[];
|
|
2710
2710
|
/**
|
|
2711
|
-
*
|
|
2711
|
+
* Search indexes that can't be triggered by a role
|
|
2712
2712
|
*/
|
|
2713
2713
|
negative_search_index_permissions?: {
|
|
2714
2714
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -3523,6 +3523,10 @@ export type SitePlanAttributes = {
|
|
|
3523
3523
|
* The number of available encoding seconds to Mux.com
|
|
3524
3524
|
*/
|
|
3525
3525
|
mux_encoding_seconds: null | number;
|
|
3526
|
+
/**
|
|
3527
|
+
* The number of images you can analyze for smart tags detections
|
|
3528
|
+
*/
|
|
3529
|
+
smart_tags_detections: null | number;
|
|
3526
3530
|
/**
|
|
3527
3531
|
* The number of different API tokens you can generate, each which different permissions
|
|
3528
3532
|
*/
|
|
@@ -4411,7 +4415,26 @@ export type UploadCollectionReorderJobSchema = {
|
|
|
4411
4415
|
data: UploadCollection[];
|
|
4412
4416
|
};
|
|
4413
4417
|
/**
|
|
4414
|
-
* The way you define the kind of content you can edit inside
|
|
4418
|
+
* The way you define the kind of content you can edit inside a DatoCMS project passes through the concept of **models** and **block models**. For backward-compatibility reasons, the API refers to both as "item types".
|
|
4419
|
+
*
|
|
4420
|
+
* ## Models
|
|
4421
|
+
*
|
|
4422
|
+
* Models are much like database tables — they define the structure of your main content types (e.g., blog posts, products, landing pages). Each model is composed of fields with custom validations. Records created from models exist independently and can be referenced by other records through link fields.
|
|
4423
|
+
*
|
|
4424
|
+
* ## Block Models
|
|
4425
|
+
*
|
|
4426
|
+
* Block models define complex and repeatable structures that can be embedded inside records. They are the foundation behind features like [Modular Content](/docs/content-modelling/modular-content.md) and [Structured Text](/docs/content-modelling/structured-text.md).
|
|
4427
|
+
*
|
|
4428
|
+
* ### Key differences:
|
|
4429
|
+
*
|
|
4430
|
+
* - **Models** create standalone records that can be referenced and have independent value
|
|
4431
|
+
* - **Block models** create blocks that only exist within parent records and cannot be referenced via link fields
|
|
4432
|
+
* - Block models defined in the library can be reused across different models
|
|
4433
|
+
* - When a record gets deleted, all the blocks it contains are deleted with it
|
|
4434
|
+
* - Blocks do not count towards your plan's records limit
|
|
4435
|
+
*
|
|
4436
|
+
* You can distinguish between models and block models using the `modular_block` attribute: `true` indicates a block model, `false` indicates a regular model.
|
|
4437
|
+
*
|
|
4415
4438
|
*
|
|
4416
4439
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4417
4440
|
* via the `definition` "item_type".
|
|
@@ -4431,11 +4454,11 @@ export type ItemType = {
|
|
|
4431
4454
|
*/
|
|
4432
4455
|
export type ItemTypeAttributes = {
|
|
4433
4456
|
/**
|
|
4434
|
-
* Name of the model
|
|
4457
|
+
* Name of the model/block model
|
|
4435
4458
|
*/
|
|
4436
4459
|
name: string;
|
|
4437
4460
|
/**
|
|
4438
|
-
* API key of the model
|
|
4461
|
+
* API key of the model/block model
|
|
4439
4462
|
*/
|
|
4440
4463
|
api_key: string;
|
|
4441
4464
|
/**
|
|
@@ -4443,11 +4466,11 @@ export type ItemTypeAttributes = {
|
|
|
4443
4466
|
*/
|
|
4444
4467
|
collection_appeareance?: 'compact' | 'table';
|
|
4445
4468
|
/**
|
|
4446
|
-
* The way the model collection should be presented to the editors
|
|
4469
|
+
* The way the model/block model collection should be presented to the editors
|
|
4447
4470
|
*/
|
|
4448
4471
|
collection_appearance: 'compact' | 'table';
|
|
4449
4472
|
/**
|
|
4450
|
-
* Whether the model is single-instance or not
|
|
4473
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4451
4474
|
*/
|
|
4452
4475
|
singleton: boolean;
|
|
4453
4476
|
/**
|
|
@@ -4455,31 +4478,31 @@ export type ItemTypeAttributes = {
|
|
|
4455
4478
|
*/
|
|
4456
4479
|
all_locales_required: boolean;
|
|
4457
4480
|
/**
|
|
4458
|
-
* Whether editors can sort records via drag & drop or not
|
|
4481
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4459
4482
|
*/
|
|
4460
4483
|
sortable: boolean;
|
|
4461
4484
|
/**
|
|
4462
|
-
* Whether this
|
|
4485
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4463
4486
|
*/
|
|
4464
4487
|
modular_block: boolean;
|
|
4465
4488
|
/**
|
|
4466
|
-
* Whether draft/published mode is active or not
|
|
4489
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4467
4490
|
*/
|
|
4468
4491
|
draft_mode_active: boolean;
|
|
4469
4492
|
/**
|
|
4470
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4493
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4471
4494
|
*/
|
|
4472
4495
|
draft_saving_active: boolean;
|
|
4473
4496
|
/**
|
|
4474
|
-
* Whether editors can organize records in a tree or not
|
|
4497
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4475
4498
|
*/
|
|
4476
4499
|
tree: boolean;
|
|
4477
4500
|
/**
|
|
4478
|
-
* If an ordering field is set, this
|
|
4501
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4479
4502
|
*/
|
|
4480
4503
|
ordering_direction: null | 'asc' | 'desc';
|
|
4481
4504
|
/**
|
|
4482
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4505
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4483
4506
|
*/
|
|
4484
4507
|
ordering_meta:
|
|
4485
4508
|
| null
|
|
@@ -4488,15 +4511,15 @@ export type ItemTypeAttributes = {
|
|
|
4488
4511
|
| 'first_published_at'
|
|
4489
4512
|
| 'published_at';
|
|
4490
4513
|
/**
|
|
4491
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4514
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
4492
4515
|
*/
|
|
4493
4516
|
has_singleton_item: boolean;
|
|
4494
4517
|
/**
|
|
4495
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4518
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4496
4519
|
*/
|
|
4497
4520
|
hint: string | null;
|
|
4498
4521
|
/**
|
|
4499
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4522
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4500
4523
|
*/
|
|
4501
4524
|
inverse_relationships_enabled: boolean;
|
|
4502
4525
|
};
|
|
@@ -4508,19 +4531,19 @@ export type ItemTypeAttributes = {
|
|
|
4508
4531
|
*/
|
|
4509
4532
|
export type ItemTypeRelationships = {
|
|
4510
4533
|
/**
|
|
4511
|
-
* The
|
|
4534
|
+
* The record instance related to this model. This relationship only applies to single-instance models, not block models
|
|
4512
4535
|
*/
|
|
4513
4536
|
singleton_item: {
|
|
4514
4537
|
data: ItemData | null;
|
|
4515
4538
|
};
|
|
4516
4539
|
/**
|
|
4517
|
-
* The list of
|
|
4540
|
+
* The list of fields for this model/block model
|
|
4518
4541
|
*/
|
|
4519
4542
|
fields: {
|
|
4520
4543
|
data: FieldData[];
|
|
4521
4544
|
};
|
|
4522
4545
|
/**
|
|
4523
|
-
* The list of
|
|
4546
|
+
* The list of fieldsets for this model/block model
|
|
4524
4547
|
*/
|
|
4525
4548
|
fieldsets: {
|
|
4526
4549
|
data: FieldsetData[];
|
|
@@ -4538,25 +4561,25 @@ export type ItemTypeRelationships = {
|
|
|
4538
4561
|
data: FieldData | null;
|
|
4539
4562
|
};
|
|
4540
4563
|
/**
|
|
4541
|
-
* The field to use as fallback title for SEO purposes
|
|
4564
|
+
* The field to use as fallback title for SEO purposes. This relationship does not apply to block models
|
|
4542
4565
|
*/
|
|
4543
4566
|
title_field: {
|
|
4544
4567
|
data: FieldData | null;
|
|
4545
4568
|
};
|
|
4546
4569
|
/**
|
|
4547
|
-
* The field to use as fallback image for SEO purposes
|
|
4570
|
+
* The field to use as fallback image for SEO purposes. This relationship does not apply to block models
|
|
4548
4571
|
*/
|
|
4549
4572
|
image_preview_field: {
|
|
4550
4573
|
data: FieldData | null;
|
|
4551
4574
|
};
|
|
4552
4575
|
/**
|
|
4553
|
-
* The field to use as fallback description for SEO purposes
|
|
4576
|
+
* The field to use as fallback description for SEO purposes. This relationship does not apply to block models
|
|
4554
4577
|
*/
|
|
4555
4578
|
excerpt_field: {
|
|
4556
4579
|
data: FieldData | null;
|
|
4557
4580
|
};
|
|
4558
4581
|
/**
|
|
4559
|
-
* The field upon which the collection is sorted
|
|
4582
|
+
* The field upon which the collection is sorted. This relationship does not apply to block models
|
|
4560
4583
|
*/
|
|
4561
4584
|
ordering_field: {
|
|
4562
4585
|
data: FieldData | null;
|
|
@@ -4609,14 +4632,14 @@ export type WorkflowData = {
|
|
|
4609
4632
|
id: WorkflowIdentity;
|
|
4610
4633
|
};
|
|
4611
4634
|
/**
|
|
4612
|
-
* Meta information regarding the
|
|
4635
|
+
* Meta information regarding the model/block model
|
|
4613
4636
|
*
|
|
4614
4637
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4615
4638
|
* via the `definition` "meta".
|
|
4616
4639
|
*/
|
|
4617
4640
|
export type ItemTypeMeta = {
|
|
4618
4641
|
/**
|
|
4619
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4642
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
4620
4643
|
*/
|
|
4621
4644
|
has_singleton_item: boolean;
|
|
4622
4645
|
};
|
|
@@ -4633,15 +4656,15 @@ export type ItemTypeCreateSchema = {
|
|
|
4633
4656
|
*/
|
|
4634
4657
|
attributes: {
|
|
4635
4658
|
/**
|
|
4636
|
-
* Name of the model
|
|
4659
|
+
* Name of the model/block model
|
|
4637
4660
|
*/
|
|
4638
4661
|
name: string;
|
|
4639
4662
|
/**
|
|
4640
|
-
* API key of the model
|
|
4663
|
+
* API key of the model/block model
|
|
4641
4664
|
*/
|
|
4642
4665
|
api_key: string;
|
|
4643
4666
|
/**
|
|
4644
|
-
* Whether the model is single-instance or not
|
|
4667
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4645
4668
|
*/
|
|
4646
4669
|
singleton?: boolean;
|
|
4647
4670
|
/**
|
|
@@ -4649,31 +4672,31 @@ export type ItemTypeCreateSchema = {
|
|
|
4649
4672
|
*/
|
|
4650
4673
|
all_locales_required?: boolean;
|
|
4651
4674
|
/**
|
|
4652
|
-
* Whether editors can sort records via drag & drop or not
|
|
4675
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4653
4676
|
*/
|
|
4654
4677
|
sortable?: boolean;
|
|
4655
4678
|
/**
|
|
4656
|
-
* Whether this
|
|
4679
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4657
4680
|
*/
|
|
4658
4681
|
modular_block?: boolean;
|
|
4659
4682
|
/**
|
|
4660
|
-
* Whether draft/published mode is active or not
|
|
4683
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4661
4684
|
*/
|
|
4662
4685
|
draft_mode_active?: boolean;
|
|
4663
4686
|
/**
|
|
4664
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4687
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4665
4688
|
*/
|
|
4666
4689
|
draft_saving_active?: boolean;
|
|
4667
4690
|
/**
|
|
4668
|
-
* Whether editors can organize records in a tree or not
|
|
4691
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4669
4692
|
*/
|
|
4670
4693
|
tree?: boolean;
|
|
4671
4694
|
/**
|
|
4672
|
-
* If an ordering field is set, this
|
|
4695
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4673
4696
|
*/
|
|
4674
4697
|
ordering_direction?: null | 'asc' | 'desc';
|
|
4675
4698
|
/**
|
|
4676
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4699
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4677
4700
|
*/
|
|
4678
4701
|
ordering_meta?:
|
|
4679
4702
|
| null
|
|
@@ -4686,21 +4709,21 @@ export type ItemTypeCreateSchema = {
|
|
|
4686
4709
|
*/
|
|
4687
4710
|
collection_appeareance?: 'compact' | 'table';
|
|
4688
4711
|
/**
|
|
4689
|
-
* The way the model collection should be presented to the editors
|
|
4712
|
+
* The way the model/block model collection should be presented to the editors
|
|
4690
4713
|
*/
|
|
4691
4714
|
collection_appearance?: 'compact' | 'table';
|
|
4692
4715
|
/**
|
|
4693
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4716
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4694
4717
|
*/
|
|
4695
4718
|
hint?: string | null;
|
|
4696
4719
|
/**
|
|
4697
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4720
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4698
4721
|
*/
|
|
4699
4722
|
inverse_relationships_enabled?: boolean;
|
|
4700
4723
|
};
|
|
4701
4724
|
relationships?: {
|
|
4702
4725
|
/**
|
|
4703
|
-
* The field upon which the collection is sorted
|
|
4726
|
+
* The field upon which the collection is sorted. This relationship does not apply to block models
|
|
4704
4727
|
*/
|
|
4705
4728
|
ordering_field?: {
|
|
4706
4729
|
data: FieldData | null;
|
|
@@ -4718,19 +4741,19 @@ export type ItemTypeCreateSchema = {
|
|
|
4718
4741
|
data: FieldData | null;
|
|
4719
4742
|
};
|
|
4720
4743
|
/**
|
|
4721
|
-
* The field to use as fallback title for SEO purposes
|
|
4744
|
+
* The field to use as fallback title for SEO purposes. This relationship does not apply to block models
|
|
4722
4745
|
*/
|
|
4723
4746
|
title_field?: {
|
|
4724
4747
|
data: FieldData | null;
|
|
4725
4748
|
};
|
|
4726
4749
|
/**
|
|
4727
|
-
* The field to use as fallback image for SEO purposes
|
|
4750
|
+
* The field to use as fallback image for SEO purposes. This relationship does not apply to block models
|
|
4728
4751
|
*/
|
|
4729
4752
|
image_preview_field?: {
|
|
4730
4753
|
data: FieldData | null;
|
|
4731
4754
|
};
|
|
4732
4755
|
/**
|
|
4733
|
-
* The field to use as fallback description for SEO purposes
|
|
4756
|
+
* The field to use as fallback description for SEO purposes. This relationship does not apply to block models
|
|
4734
4757
|
*/
|
|
4735
4758
|
excerpt_field?: {
|
|
4736
4759
|
data: FieldData | null;
|
|
@@ -4765,11 +4788,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
4765
4788
|
*/
|
|
4766
4789
|
attributes?: {
|
|
4767
4790
|
/**
|
|
4768
|
-
* Name of the model
|
|
4791
|
+
* Name of the model/block model
|
|
4769
4792
|
*/
|
|
4770
4793
|
name?: string;
|
|
4771
4794
|
/**
|
|
4772
|
-
* API key of the model
|
|
4795
|
+
* API key of the model/block model
|
|
4773
4796
|
*/
|
|
4774
4797
|
api_key?: string;
|
|
4775
4798
|
/**
|
|
@@ -4777,11 +4800,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
4777
4800
|
*/
|
|
4778
4801
|
collection_appeareance?: 'compact' | 'table';
|
|
4779
4802
|
/**
|
|
4780
|
-
* The way the model collection should be presented to the editors
|
|
4803
|
+
* The way the model/block model collection should be presented to the editors
|
|
4781
4804
|
*/
|
|
4782
4805
|
collection_appearance?: 'compact' | 'table';
|
|
4783
4806
|
/**
|
|
4784
|
-
* Whether the model is single-instance or not
|
|
4807
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4785
4808
|
*/
|
|
4786
4809
|
singleton?: boolean;
|
|
4787
4810
|
/**
|
|
@@ -4789,31 +4812,31 @@ export type ItemTypeUpdateSchema = {
|
|
|
4789
4812
|
*/
|
|
4790
4813
|
all_locales_required?: boolean;
|
|
4791
4814
|
/**
|
|
4792
|
-
* Whether editors can sort records via drag & drop or not
|
|
4815
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4793
4816
|
*/
|
|
4794
4817
|
sortable?: boolean;
|
|
4795
4818
|
/**
|
|
4796
|
-
* Whether this
|
|
4819
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4797
4820
|
*/
|
|
4798
4821
|
modular_block?: boolean;
|
|
4799
4822
|
/**
|
|
4800
|
-
* Whether draft/published mode is active or not
|
|
4823
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4801
4824
|
*/
|
|
4802
4825
|
draft_mode_active?: boolean;
|
|
4803
4826
|
/**
|
|
4804
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4827
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4805
4828
|
*/
|
|
4806
4829
|
draft_saving_active?: boolean;
|
|
4807
4830
|
/**
|
|
4808
|
-
* Whether editors can organize records in a tree or not
|
|
4831
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4809
4832
|
*/
|
|
4810
4833
|
tree?: boolean;
|
|
4811
4834
|
/**
|
|
4812
|
-
* If an ordering field is set, this
|
|
4835
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4813
4836
|
*/
|
|
4814
4837
|
ordering_direction?: null | 'asc' | 'desc';
|
|
4815
4838
|
/**
|
|
4816
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4839
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4817
4840
|
*/
|
|
4818
4841
|
ordering_meta?:
|
|
4819
4842
|
| null
|
|
@@ -4822,21 +4845,21 @@ export type ItemTypeUpdateSchema = {
|
|
|
4822
4845
|
| 'first_published_at'
|
|
4823
4846
|
| 'published_at';
|
|
4824
4847
|
/**
|
|
4825
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4848
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
4826
4849
|
*/
|
|
4827
4850
|
has_singleton_item?: boolean;
|
|
4828
4851
|
/**
|
|
4829
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4852
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4830
4853
|
*/
|
|
4831
4854
|
hint?: string | null;
|
|
4832
4855
|
/**
|
|
4833
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4856
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4834
4857
|
*/
|
|
4835
4858
|
inverse_relationships_enabled?: boolean;
|
|
4836
4859
|
};
|
|
4837
4860
|
relationships?: {
|
|
4838
4861
|
/**
|
|
4839
|
-
* The field upon which the collection is sorted
|
|
4862
|
+
* The field upon which the collection is sorted. This relationship does not apply to block models
|
|
4840
4863
|
*/
|
|
4841
4864
|
ordering_field?: {
|
|
4842
4865
|
data: FieldData | null;
|
|
@@ -4854,19 +4877,19 @@ export type ItemTypeUpdateSchema = {
|
|
|
4854
4877
|
data: FieldData | null;
|
|
4855
4878
|
};
|
|
4856
4879
|
/**
|
|
4857
|
-
* The field to use as fallback title for SEO purposes
|
|
4880
|
+
* The field to use as fallback title for SEO purposes. This relationship does not apply to block models
|
|
4858
4881
|
*/
|
|
4859
4882
|
title_field?: {
|
|
4860
4883
|
data: FieldData | null;
|
|
4861
4884
|
};
|
|
4862
4885
|
/**
|
|
4863
|
-
* The field to use as fallback image for SEO purposes
|
|
4886
|
+
* The field to use as fallback image for SEO purposes. This relationship does not apply to block models
|
|
4864
4887
|
*/
|
|
4865
4888
|
image_preview_field?: {
|
|
4866
4889
|
data: FieldData | null;
|
|
4867
4890
|
};
|
|
4868
4891
|
/**
|
|
4869
|
-
* The field to use as fallback description for SEO purposes
|
|
4892
|
+
* The field to use as fallback description for SEO purposes. This relationship does not apply to block models
|
|
4870
4893
|
*/
|
|
4871
4894
|
excerpt_field?: {
|
|
4872
4895
|
data: FieldData | null;
|
|
@@ -4880,7 +4903,7 @@ export type ItemTypeUpdateSchema = {
|
|
|
4880
4903
|
};
|
|
4881
4904
|
meta?: {
|
|
4882
4905
|
/**
|
|
4883
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4906
|
+
* If this model is single-instance, this tells whether the single-instance record has already been created or not. This property only applies to models, not block models
|
|
4884
4907
|
*/
|
|
4885
4908
|
has_singleton_item?: boolean;
|
|
4886
4909
|
};
|
|
@@ -7094,7 +7117,7 @@ export type SubscriptionFeatureInstancesTargetSchema = {
|
|
|
7094
7117
|
data: SubscriptionFeature[];
|
|
7095
7118
|
};
|
|
7096
7119
|
/**
|
|
7097
|
-
* Represents an event occurred during the deploy process of
|
|
7120
|
+
* Represents an event occurred during the deploy process of a build trigger.
|
|
7098
7121
|
*
|
|
7099
7122
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7100
7123
|
* via the `definition` "build_event".
|
|
@@ -7185,7 +7208,7 @@ export type BuildEventSelfTargetSchema = {
|
|
|
7185
7208
|
data: BuildEvent;
|
|
7186
7209
|
};
|
|
7187
7210
|
/**
|
|
7188
|
-
* Represents an event occurred during the
|
|
7211
|
+
* Represents an event occurred during the indexing process via search indexes.
|
|
7189
7212
|
*
|
|
7190
7213
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7191
7214
|
* via the `definition` "search_index_event".
|
|
@@ -9870,6 +9893,10 @@ export type BuildTriggerAttributes = {
|
|
|
9870
9893
|
* Name of the build trigger
|
|
9871
9894
|
*/
|
|
9872
9895
|
name: string;
|
|
9896
|
+
/**
|
|
9897
|
+
* Whether the build trigger is enabled or not
|
|
9898
|
+
*/
|
|
9899
|
+
enabled: boolean;
|
|
9873
9900
|
/**
|
|
9874
9901
|
* The type of build trigger
|
|
9875
9902
|
*/
|
|
@@ -9901,7 +9928,7 @@ export type BuildTriggerAttributes = {
|
|
|
9901
9928
|
*/
|
|
9902
9929
|
indexing_status: string;
|
|
9903
9930
|
/**
|
|
9904
|
-
* The public URL of the frontend.
|
|
9931
|
+
* The public URL of the frontend.
|
|
9905
9932
|
*/
|
|
9906
9933
|
frontend_url: string | null;
|
|
9907
9934
|
/**
|
|
@@ -9912,10 +9939,6 @@ export type BuildTriggerAttributes = {
|
|
|
9912
9939
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9913
9940
|
*/
|
|
9914
9941
|
indexing_enabled: boolean;
|
|
9915
|
-
/**
|
|
9916
|
-
* Whether the build trigger is enabled or not
|
|
9917
|
-
*/
|
|
9918
|
-
enabled: boolean;
|
|
9919
9942
|
};
|
|
9920
9943
|
/**
|
|
9921
9944
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
@@ -9960,13 +9983,13 @@ export type BuildTriggerCreateSchema = {
|
|
|
9960
9983
|
/**
|
|
9961
9984
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9962
9985
|
*/
|
|
9963
|
-
indexing_enabled
|
|
9986
|
+
indexing_enabled?: boolean;
|
|
9964
9987
|
/**
|
|
9965
9988
|
* Whether the build trigger is enabled or not
|
|
9966
9989
|
*/
|
|
9967
9990
|
enabled?: boolean;
|
|
9968
9991
|
/**
|
|
9969
|
-
* The public URL of the frontend.
|
|
9992
|
+
* The public URL of the frontend.
|
|
9970
9993
|
*/
|
|
9971
9994
|
frontend_url: string | null;
|
|
9972
9995
|
/**
|
|
@@ -10021,7 +10044,7 @@ export type BuildTriggerUpdateSchema = {
|
|
|
10021
10044
|
*/
|
|
10022
10045
|
enabled?: boolean;
|
|
10023
10046
|
/**
|
|
10024
|
-
* The public URL of the frontend.
|
|
10047
|
+
* The public URL of the frontend.
|
|
10025
10048
|
*/
|
|
10026
10049
|
frontend_url?: string | null;
|
|
10027
10050
|
/**
|
|
@@ -10052,7 +10075,7 @@ export type BuildTriggerDestroyTargetSchema = {
|
|
|
10052
10075
|
data: BuildTrigger;
|
|
10053
10076
|
};
|
|
10054
10077
|
/**
|
|
10055
|
-
* A Search Index
|
|
10078
|
+
* A Search Index is used to index a website to provide DatoCMS Site Search functionality.
|
|
10056
10079
|
*
|
|
10057
10080
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
10058
10081
|
* via the `definition` "search_index".
|
|
@@ -10080,11 +10103,7 @@ export type SearchIndexAttributes = {
|
|
|
10080
10103
|
*/
|
|
10081
10104
|
enabled: boolean;
|
|
10082
10105
|
/**
|
|
10083
|
-
*
|
|
10084
|
-
*/
|
|
10085
|
-
build_trigger_indexing_enabled: boolean;
|
|
10086
|
-
/**
|
|
10087
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10106
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
10088
10107
|
*/
|
|
10089
10108
|
frontend_url: string | null;
|
|
10090
10109
|
/**
|
|
@@ -10100,7 +10119,7 @@ export type SearchIndexAttributes = {
|
|
|
10100
10119
|
*/
|
|
10101
10120
|
export type SearchIndexRelationships = {
|
|
10102
10121
|
/**
|
|
10103
|
-
* The build triggers
|
|
10122
|
+
* The build triggers that can trigger this search index
|
|
10104
10123
|
*/
|
|
10105
10124
|
build_triggers: {
|
|
10106
10125
|
data: BuildTriggerData[];
|
|
@@ -10114,7 +10133,7 @@ export type SearchIndexRelationships = {
|
|
|
10114
10133
|
*/
|
|
10115
10134
|
export type SearchIndexMeta = {
|
|
10116
10135
|
/**
|
|
10117
|
-
* Status of the
|
|
10136
|
+
* Status of the search indexing
|
|
10118
10137
|
*/
|
|
10119
10138
|
indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
|
|
10120
10139
|
/**
|
|
@@ -10153,11 +10172,7 @@ export type SearchIndexCreateSchema = {
|
|
|
10153
10172
|
*/
|
|
10154
10173
|
enabled: boolean;
|
|
10155
10174
|
/**
|
|
10156
|
-
*
|
|
10157
|
-
*/
|
|
10158
|
-
build_trigger_indexing_enabled?: boolean;
|
|
10159
|
-
/**
|
|
10160
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10175
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
10161
10176
|
*/
|
|
10162
10177
|
frontend_url: string | null;
|
|
10163
10178
|
/**
|
|
@@ -10170,7 +10185,7 @@ export type SearchIndexCreateSchema = {
|
|
|
10170
10185
|
*/
|
|
10171
10186
|
relationships?: {
|
|
10172
10187
|
/**
|
|
10173
|
-
* The build triggers
|
|
10188
|
+
* The build triggers that can trigger this search index
|
|
10174
10189
|
*/
|
|
10175
10190
|
build_triggers?: {
|
|
10176
10191
|
data: BuildTriggerData[];
|
|
@@ -10203,11 +10218,7 @@ export type SearchIndexUpdateSchema = {
|
|
|
10203
10218
|
*/
|
|
10204
10219
|
enabled?: boolean;
|
|
10205
10220
|
/**
|
|
10206
|
-
*
|
|
10207
|
-
*/
|
|
10208
|
-
build_trigger_indexing_enabled?: boolean;
|
|
10209
|
-
/**
|
|
10210
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
10221
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
10211
10222
|
*/
|
|
10212
10223
|
frontend_url?: string | null;
|
|
10213
10224
|
/**
|
|
@@ -10220,7 +10231,7 @@ export type SearchIndexUpdateSchema = {
|
|
|
10220
10231
|
*/
|
|
10221
10232
|
relationships?: {
|
|
10222
10233
|
/**
|
|
10223
|
-
* The build triggers
|
|
10234
|
+
* The build triggers that can trigger this search index
|
|
10224
10235
|
*/
|
|
10225
10236
|
build_triggers?: {
|
|
10226
10237
|
data: BuildTriggerData[];
|
|
@@ -11452,6 +11463,10 @@ export type DailyUsageAttributes = {
|
|
|
11452
11463
|
* Video encoding seconds
|
|
11453
11464
|
*/
|
|
11454
11465
|
mux_encoded_seconds: number;
|
|
11466
|
+
/**
|
|
11467
|
+
* Number of images analyzed for smart tags
|
|
11468
|
+
*/
|
|
11469
|
+
smart_tags_detections: number;
|
|
11455
11470
|
};
|
|
11456
11471
|
/**
|
|
11457
11472
|
* JSON API data
|