@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
|
@@ -712,19 +712,19 @@ export type ItemInstancesHrefSchema<D extends ItemTypeDefinition = ItemTypeDefin
|
|
|
712
712
|
*/
|
|
713
713
|
filter?: {
|
|
714
714
|
/**
|
|
715
|
-
* Record (or block record) IDs to fetch, comma separated. If you use this filter, you _must not_ use `filter[type]`
|
|
715
|
+
* 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
|
|
716
716
|
*/
|
|
717
717
|
ids?: string;
|
|
718
718
|
/**
|
|
719
|
-
* Model ID or `api_key` to filter. If you use this filter, you _must not_ use `filter[ids]`.
|
|
719
|
+
* 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
|
|
720
720
|
*/
|
|
721
721
|
type?: string;
|
|
722
722
|
/**
|
|
723
|
-
* Textual query to match.
|
|
723
|
+
* 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.
|
|
724
724
|
*/
|
|
725
725
|
query?: string;
|
|
726
726
|
/**
|
|
727
|
-
*
|
|
727
|
+
* 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.
|
|
728
728
|
*/
|
|
729
729
|
fields?: ToItemHrefSchemaField<D>;
|
|
730
730
|
/**
|
|
@@ -785,7 +785,7 @@ export type ItemSelfHrefSchema = {
|
|
|
785
785
|
*/
|
|
786
786
|
nested?: boolean;
|
|
787
787
|
/**
|
|
788
|
-
* Whether you want the currently published versions (`published
|
|
788
|
+
* Whether you want the currently published versions (`published`) of your records, or the latest available (`current`, default)
|
|
789
789
|
*/
|
|
790
790
|
version?: string;
|
|
791
791
|
[k: string]: unknown;
|
|
@@ -1098,11 +1098,11 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
1098
1098
|
*/
|
|
1099
1099
|
query: string;
|
|
1100
1100
|
/**
|
|
1101
|
-
* The search index ID
|
|
1101
|
+
* The search index ID on which the search will be performed. If not provided, the first enabled search index will be used.
|
|
1102
1102
|
*/
|
|
1103
1103
|
search_index_id?: string;
|
|
1104
1104
|
/**
|
|
1105
|
-
*
|
|
1105
|
+
* The build trigger ID or name on which the search will be performed.
|
|
1106
1106
|
*/
|
|
1107
1107
|
build_trigger_id?: string;
|
|
1108
1108
|
/**
|
|
@@ -1581,7 +1581,7 @@ export type RoleAttributes = {
|
|
|
1581
1581
|
*/
|
|
1582
1582
|
can_edit_site: boolean;
|
|
1583
1583
|
/**
|
|
1584
|
-
* Can create
|
|
1584
|
+
* Can create and edit models and plugins
|
|
1585
1585
|
*/
|
|
1586
1586
|
can_edit_schema: boolean;
|
|
1587
1587
|
/**
|
|
@@ -1601,31 +1601,31 @@ export type RoleAttributes = {
|
|
|
1601
1601
|
*/
|
|
1602
1602
|
environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
1603
1603
|
/**
|
|
1604
|
-
* Can create
|
|
1604
|
+
* Can create and edit roles and invite/remove collaborators
|
|
1605
1605
|
*/
|
|
1606
1606
|
can_manage_users: boolean;
|
|
1607
1607
|
/**
|
|
1608
|
-
* Can create
|
|
1608
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
1609
1609
|
*/
|
|
1610
1610
|
can_manage_shared_filters: boolean;
|
|
1611
1611
|
/**
|
|
1612
|
-
* Can create
|
|
1612
|
+
* Can create and edit upload collections
|
|
1613
1613
|
*/
|
|
1614
1614
|
can_manage_upload_collections: boolean;
|
|
1615
1615
|
/**
|
|
1616
|
-
* Can create
|
|
1616
|
+
* Can create and edit build triggers
|
|
1617
1617
|
*/
|
|
1618
1618
|
can_manage_build_triggers: boolean;
|
|
1619
1619
|
/**
|
|
1620
|
-
* Can create
|
|
1620
|
+
* Can create and edit search indexes
|
|
1621
1621
|
*/
|
|
1622
1622
|
can_manage_search_indexes: boolean;
|
|
1623
1623
|
/**
|
|
1624
|
-
* Can create
|
|
1624
|
+
* Can create and edit webhooks
|
|
1625
1625
|
*/
|
|
1626
1626
|
can_manage_webhooks: boolean;
|
|
1627
1627
|
/**
|
|
1628
|
-
* Can create
|
|
1628
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
1629
1629
|
*/
|
|
1630
1630
|
can_manage_environments: boolean;
|
|
1631
1631
|
/**
|
|
@@ -1637,7 +1637,7 @@ export type RoleAttributes = {
|
|
|
1637
1637
|
*/
|
|
1638
1638
|
can_access_audit_log: boolean;
|
|
1639
1639
|
/**
|
|
1640
|
-
* Can create
|
|
1640
|
+
* Can create and edit workflows
|
|
1641
1641
|
*/
|
|
1642
1642
|
can_manage_workflows: boolean;
|
|
1643
1643
|
/**
|
|
@@ -1765,13 +1765,13 @@ export type RoleAttributes = {
|
|
|
1765
1765
|
build_trigger?: BuildTriggerIdentity | null;
|
|
1766
1766
|
}[];
|
|
1767
1767
|
/**
|
|
1768
|
-
*
|
|
1768
|
+
* Search indexes that can be triggered by a role
|
|
1769
1769
|
*/
|
|
1770
1770
|
positive_search_index_permissions: {
|
|
1771
1771
|
search_index?: SearchIndexIdentity | null;
|
|
1772
1772
|
}[];
|
|
1773
1773
|
/**
|
|
1774
|
-
*
|
|
1774
|
+
* Search indexes that can't be triggered by a role
|
|
1775
1775
|
*/
|
|
1776
1776
|
negative_search_index_permissions: {
|
|
1777
1777
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -1821,7 +1821,7 @@ export type RoleMeta = {
|
|
|
1821
1821
|
*/
|
|
1822
1822
|
can_edit_site: boolean;
|
|
1823
1823
|
/**
|
|
1824
|
-
* Can create
|
|
1824
|
+
* Can create and edit models and plugins
|
|
1825
1825
|
*/
|
|
1826
1826
|
can_edit_schema: boolean;
|
|
1827
1827
|
/**
|
|
@@ -1841,31 +1841,31 @@ export type RoleMeta = {
|
|
|
1841
1841
|
*/
|
|
1842
1842
|
environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
1843
1843
|
/**
|
|
1844
|
-
* Can create
|
|
1844
|
+
* Can create and edit roles and invite/remove collaborators
|
|
1845
1845
|
*/
|
|
1846
1846
|
can_manage_users: boolean;
|
|
1847
1847
|
/**
|
|
1848
|
-
* Can create
|
|
1848
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
1849
1849
|
*/
|
|
1850
1850
|
can_manage_shared_filters: boolean;
|
|
1851
1851
|
/**
|
|
1852
|
-
* Can create
|
|
1852
|
+
* Can create and edit upload collections
|
|
1853
1853
|
*/
|
|
1854
1854
|
can_manage_upload_collections: boolean;
|
|
1855
1855
|
/**
|
|
1856
|
-
* Can create
|
|
1856
|
+
* Can create and edit build triggers
|
|
1857
1857
|
*/
|
|
1858
1858
|
can_manage_build_triggers: boolean;
|
|
1859
1859
|
/**
|
|
1860
|
-
* Can create
|
|
1860
|
+
* Can create and edit search indexes
|
|
1861
1861
|
*/
|
|
1862
1862
|
can_manage_search_indexes: boolean;
|
|
1863
1863
|
/**
|
|
1864
|
-
* Can create
|
|
1864
|
+
* Can create and edit webhooks
|
|
1865
1865
|
*/
|
|
1866
1866
|
can_manage_webhooks: boolean;
|
|
1867
1867
|
/**
|
|
1868
|
-
* Can create
|
|
1868
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
1869
1869
|
*/
|
|
1870
1870
|
can_manage_environments: boolean;
|
|
1871
1871
|
/**
|
|
@@ -1877,7 +1877,7 @@ export type RoleMeta = {
|
|
|
1877
1877
|
*/
|
|
1878
1878
|
can_access_audit_log: boolean;
|
|
1879
1879
|
/**
|
|
1880
|
-
* Can create
|
|
1880
|
+
* Can create and edit workflows
|
|
1881
1881
|
*/
|
|
1882
1882
|
can_manage_workflows: boolean;
|
|
1883
1883
|
/**
|
|
@@ -2005,13 +2005,13 @@ export type RoleMeta = {
|
|
|
2005
2005
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2006
2006
|
}[];
|
|
2007
2007
|
/**
|
|
2008
|
-
*
|
|
2008
|
+
* Search indexes that can be triggered by a role
|
|
2009
2009
|
*/
|
|
2010
2010
|
positive_search_index_permissions: {
|
|
2011
2011
|
search_index?: SearchIndexIdentity | null;
|
|
2012
2012
|
}[];
|
|
2013
2013
|
/**
|
|
2014
|
-
*
|
|
2014
|
+
* Search indexes that can't be triggered by a role
|
|
2015
2015
|
*/
|
|
2016
2016
|
negative_search_index_permissions: {
|
|
2017
2017
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -2042,7 +2042,7 @@ export type RoleCreateSchema = {
|
|
|
2042
2042
|
*/
|
|
2043
2043
|
can_edit_site?: boolean;
|
|
2044
2044
|
/**
|
|
2045
|
-
* Can create
|
|
2045
|
+
* Can create and edit models and plugins
|
|
2046
2046
|
*/
|
|
2047
2047
|
can_edit_schema?: boolean;
|
|
2048
2048
|
/**
|
|
@@ -2062,31 +2062,31 @@ export type RoleCreateSchema = {
|
|
|
2062
2062
|
*/
|
|
2063
2063
|
environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2064
2064
|
/**
|
|
2065
|
-
* Can create
|
|
2065
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2066
2066
|
*/
|
|
2067
2067
|
can_manage_users?: boolean;
|
|
2068
2068
|
/**
|
|
2069
|
-
* Can create
|
|
2069
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2070
2070
|
*/
|
|
2071
2071
|
can_manage_shared_filters?: boolean;
|
|
2072
2072
|
/**
|
|
2073
|
-
* Can create
|
|
2073
|
+
* Can create and edit search indexes
|
|
2074
2074
|
*/
|
|
2075
2075
|
can_manage_search_indexes?: boolean;
|
|
2076
2076
|
/**
|
|
2077
|
-
* Can create
|
|
2077
|
+
* Can create and edit upload collections
|
|
2078
2078
|
*/
|
|
2079
2079
|
can_manage_upload_collections?: boolean;
|
|
2080
2080
|
/**
|
|
2081
|
-
* Can create
|
|
2081
|
+
* Can create and edit build triggers
|
|
2082
2082
|
*/
|
|
2083
2083
|
can_manage_build_triggers?: boolean;
|
|
2084
2084
|
/**
|
|
2085
|
-
* Can create
|
|
2085
|
+
* Can create and edit webhooks
|
|
2086
2086
|
*/
|
|
2087
2087
|
can_manage_webhooks?: boolean;
|
|
2088
2088
|
/**
|
|
2089
|
-
* Can create
|
|
2089
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2090
2090
|
*/
|
|
2091
2091
|
can_manage_environments?: boolean;
|
|
2092
2092
|
/**
|
|
@@ -2098,7 +2098,7 @@ export type RoleCreateSchema = {
|
|
|
2098
2098
|
*/
|
|
2099
2099
|
can_access_audit_log?: boolean;
|
|
2100
2100
|
/**
|
|
2101
|
-
* Can create
|
|
2101
|
+
* Can create and edit workflows
|
|
2102
2102
|
*/
|
|
2103
2103
|
can_manage_workflows?: boolean;
|
|
2104
2104
|
/**
|
|
@@ -2226,13 +2226,13 @@ export type RoleCreateSchema = {
|
|
|
2226
2226
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2227
2227
|
}[];
|
|
2228
2228
|
/**
|
|
2229
|
-
*
|
|
2229
|
+
* Search indexes that can be triggered by a role
|
|
2230
2230
|
*/
|
|
2231
2231
|
positive_search_index_permissions?: {
|
|
2232
2232
|
search_index?: SearchIndexIdentity | null;
|
|
2233
2233
|
}[];
|
|
2234
2234
|
/**
|
|
2235
|
-
*
|
|
2235
|
+
* Search indexes that can't be triggered by a role
|
|
2236
2236
|
*/
|
|
2237
2237
|
negative_search_index_permissions?: {
|
|
2238
2238
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -2284,7 +2284,7 @@ export type RoleUpdateSchema = {
|
|
|
2284
2284
|
*/
|
|
2285
2285
|
can_edit_site?: boolean;
|
|
2286
2286
|
/**
|
|
2287
|
-
* Can create
|
|
2287
|
+
* Can create and edit models and plugins
|
|
2288
2288
|
*/
|
|
2289
2289
|
can_edit_schema?: boolean;
|
|
2290
2290
|
/**
|
|
@@ -2304,31 +2304,31 @@ export type RoleUpdateSchema = {
|
|
|
2304
2304
|
*/
|
|
2305
2305
|
environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
|
|
2306
2306
|
/**
|
|
2307
|
-
* Can create
|
|
2307
|
+
* Can create and edit roles and invite/remove collaborators
|
|
2308
2308
|
*/
|
|
2309
2309
|
can_manage_users?: boolean;
|
|
2310
2310
|
/**
|
|
2311
|
-
* Can create
|
|
2311
|
+
* Can create and edit shared filters (both for models and the media area)
|
|
2312
2312
|
*/
|
|
2313
2313
|
can_manage_shared_filters?: boolean;
|
|
2314
2314
|
/**
|
|
2315
|
-
* Can create
|
|
2315
|
+
* Can create and edit search indexes
|
|
2316
2316
|
*/
|
|
2317
2317
|
can_manage_search_indexes?: boolean;
|
|
2318
2318
|
/**
|
|
2319
|
-
* Can create
|
|
2319
|
+
* Can create and edit upload collections
|
|
2320
2320
|
*/
|
|
2321
2321
|
can_manage_upload_collections?: boolean;
|
|
2322
2322
|
/**
|
|
2323
|
-
* Can create
|
|
2323
|
+
* Can create and edit build triggers
|
|
2324
2324
|
*/
|
|
2325
2325
|
can_manage_build_triggers?: boolean;
|
|
2326
2326
|
/**
|
|
2327
|
-
* Can create
|
|
2327
|
+
* Can create and edit webhooks
|
|
2328
2328
|
*/
|
|
2329
2329
|
can_manage_webhooks?: boolean;
|
|
2330
2330
|
/**
|
|
2331
|
-
* Can create
|
|
2331
|
+
* Can create and delete sandbox environments and promote them to primary environment
|
|
2332
2332
|
*/
|
|
2333
2333
|
can_manage_environments?: boolean;
|
|
2334
2334
|
/**
|
|
@@ -2340,7 +2340,7 @@ export type RoleUpdateSchema = {
|
|
|
2340
2340
|
*/
|
|
2341
2341
|
can_access_audit_log?: boolean;
|
|
2342
2342
|
/**
|
|
2343
|
-
* Can create
|
|
2343
|
+
* Can create and edit workflows
|
|
2344
2344
|
*/
|
|
2345
2345
|
can_manage_workflows?: boolean;
|
|
2346
2346
|
/**
|
|
@@ -2468,13 +2468,13 @@ export type RoleUpdateSchema = {
|
|
|
2468
2468
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2469
2469
|
}[];
|
|
2470
2470
|
/**
|
|
2471
|
-
*
|
|
2471
|
+
* Search indexes that can be triggered by a role
|
|
2472
2472
|
*/
|
|
2473
2473
|
positive_search_index_permissions?: {
|
|
2474
2474
|
search_index?: SearchIndexIdentity | null;
|
|
2475
2475
|
}[];
|
|
2476
2476
|
/**
|
|
2477
|
-
*
|
|
2477
|
+
* Search indexes that can't be triggered by a role
|
|
2478
2478
|
*/
|
|
2479
2479
|
negative_search_index_permissions?: {
|
|
2480
2480
|
search_index?: SearchIndexIdentity | null;
|
|
@@ -3289,6 +3289,10 @@ export type SitePlanAttributes = {
|
|
|
3289
3289
|
* The number of available encoding seconds to Mux.com
|
|
3290
3290
|
*/
|
|
3291
3291
|
mux_encoding_seconds: null | number;
|
|
3292
|
+
/**
|
|
3293
|
+
* The number of images you can analyze for smart tags detections
|
|
3294
|
+
*/
|
|
3295
|
+
smart_tags_detections: null | number;
|
|
3292
3296
|
/**
|
|
3293
3297
|
* The number of different API tokens you can generate, each which different permissions
|
|
3294
3298
|
*/
|
|
@@ -4177,7 +4181,26 @@ export type UploadCollectionReorderJobSchema = {
|
|
|
4177
4181
|
data: UploadCollection[];
|
|
4178
4182
|
};
|
|
4179
4183
|
/**
|
|
4180
|
-
* The way you define the kind of content you can edit inside
|
|
4184
|
+
* 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".
|
|
4185
|
+
*
|
|
4186
|
+
* ## Models
|
|
4187
|
+
*
|
|
4188
|
+
* 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.
|
|
4189
|
+
*
|
|
4190
|
+
* ## Block Models
|
|
4191
|
+
*
|
|
4192
|
+
* 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).
|
|
4193
|
+
*
|
|
4194
|
+
* ### Key differences:
|
|
4195
|
+
*
|
|
4196
|
+
* - **Models** create standalone records that can be referenced and have independent value
|
|
4197
|
+
* - **Block models** create blocks that only exist within parent records and cannot be referenced via link fields
|
|
4198
|
+
* - Block models defined in the library can be reused across different models
|
|
4199
|
+
* - When a record gets deleted, all the blocks it contains are deleted with it
|
|
4200
|
+
* - Blocks do not count towards your plan's records limit
|
|
4201
|
+
*
|
|
4202
|
+
* You can distinguish between models and block models using the `modular_block` attribute: `true` indicates a block model, `false` indicates a regular model.
|
|
4203
|
+
*
|
|
4181
4204
|
*
|
|
4182
4205
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4183
4206
|
* via the `definition` "item_type".
|
|
@@ -4197,11 +4220,11 @@ export type ItemType = {
|
|
|
4197
4220
|
*/
|
|
4198
4221
|
export type ItemTypeAttributes = {
|
|
4199
4222
|
/**
|
|
4200
|
-
* Name of the model
|
|
4223
|
+
* Name of the model/block model
|
|
4201
4224
|
*/
|
|
4202
4225
|
name: string;
|
|
4203
4226
|
/**
|
|
4204
|
-
* API key of the model
|
|
4227
|
+
* API key of the model/block model
|
|
4205
4228
|
*/
|
|
4206
4229
|
api_key: string;
|
|
4207
4230
|
/**
|
|
@@ -4209,11 +4232,11 @@ export type ItemTypeAttributes = {
|
|
|
4209
4232
|
*/
|
|
4210
4233
|
collection_appeareance?: 'compact' | 'table';
|
|
4211
4234
|
/**
|
|
4212
|
-
* The way the model collection should be presented to the editors
|
|
4235
|
+
* The way the model/block model collection should be presented to the editors
|
|
4213
4236
|
*/
|
|
4214
4237
|
collection_appearance: 'compact' | 'table';
|
|
4215
4238
|
/**
|
|
4216
|
-
* Whether the model is single-instance or not
|
|
4239
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4217
4240
|
*/
|
|
4218
4241
|
singleton: boolean;
|
|
4219
4242
|
/**
|
|
@@ -4221,43 +4244,43 @@ export type ItemTypeAttributes = {
|
|
|
4221
4244
|
*/
|
|
4222
4245
|
all_locales_required: boolean;
|
|
4223
4246
|
/**
|
|
4224
|
-
* Whether editors can sort records via drag & drop or not
|
|
4247
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4225
4248
|
*/
|
|
4226
4249
|
sortable: boolean;
|
|
4227
4250
|
/**
|
|
4228
|
-
* Whether this
|
|
4251
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4229
4252
|
*/
|
|
4230
4253
|
modular_block: boolean;
|
|
4231
4254
|
/**
|
|
4232
|
-
* Whether draft/published mode is active or not
|
|
4255
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4233
4256
|
*/
|
|
4234
4257
|
draft_mode_active: boolean;
|
|
4235
4258
|
/**
|
|
4236
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4259
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4237
4260
|
*/
|
|
4238
4261
|
draft_saving_active: boolean;
|
|
4239
4262
|
/**
|
|
4240
|
-
* Whether editors can organize records in a tree or not
|
|
4263
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4241
4264
|
*/
|
|
4242
4265
|
tree: boolean;
|
|
4243
4266
|
/**
|
|
4244
|
-
* If an ordering field is set, this
|
|
4267
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4245
4268
|
*/
|
|
4246
4269
|
ordering_direction: null | 'asc' | 'desc';
|
|
4247
4270
|
/**
|
|
4248
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4271
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4249
4272
|
*/
|
|
4250
4273
|
ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
|
|
4251
4274
|
/**
|
|
4252
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4275
|
+
* 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
|
|
4253
4276
|
*/
|
|
4254
4277
|
has_singleton_item: boolean;
|
|
4255
4278
|
/**
|
|
4256
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4279
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4257
4280
|
*/
|
|
4258
4281
|
hint: string | null;
|
|
4259
4282
|
/**
|
|
4260
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4283
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4261
4284
|
*/
|
|
4262
4285
|
inverse_relationships_enabled: boolean;
|
|
4263
4286
|
};
|
|
@@ -4269,19 +4292,19 @@ export type ItemTypeAttributes = {
|
|
|
4269
4292
|
*/
|
|
4270
4293
|
export type ItemTypeRelationships = {
|
|
4271
4294
|
/**
|
|
4272
|
-
* The
|
|
4295
|
+
* The record instance related to this model. This relationship only applies to single-instance models, not block models
|
|
4273
4296
|
*/
|
|
4274
4297
|
singleton_item: {
|
|
4275
4298
|
data: ItemData | null;
|
|
4276
4299
|
};
|
|
4277
4300
|
/**
|
|
4278
|
-
* The list of
|
|
4301
|
+
* The list of fields for this model/block model
|
|
4279
4302
|
*/
|
|
4280
4303
|
fields: {
|
|
4281
4304
|
data: FieldData[];
|
|
4282
4305
|
};
|
|
4283
4306
|
/**
|
|
4284
|
-
* The list of
|
|
4307
|
+
* The list of fieldsets for this model/block model
|
|
4285
4308
|
*/
|
|
4286
4309
|
fieldsets: {
|
|
4287
4310
|
data: FieldsetData[];
|
|
@@ -4299,25 +4322,25 @@ export type ItemTypeRelationships = {
|
|
|
4299
4322
|
data: FieldData | null;
|
|
4300
4323
|
};
|
|
4301
4324
|
/**
|
|
4302
|
-
* The field to use as fallback title for SEO purposes
|
|
4325
|
+
* The field to use as fallback title for SEO purposes. This relationship does not apply to block models
|
|
4303
4326
|
*/
|
|
4304
4327
|
title_field: {
|
|
4305
4328
|
data: FieldData | null;
|
|
4306
4329
|
};
|
|
4307
4330
|
/**
|
|
4308
|
-
* The field to use as fallback image for SEO purposes
|
|
4331
|
+
* The field to use as fallback image for SEO purposes. This relationship does not apply to block models
|
|
4309
4332
|
*/
|
|
4310
4333
|
image_preview_field: {
|
|
4311
4334
|
data: FieldData | null;
|
|
4312
4335
|
};
|
|
4313
4336
|
/**
|
|
4314
|
-
* The field to use as fallback description for SEO purposes
|
|
4337
|
+
* The field to use as fallback description for SEO purposes. This relationship does not apply to block models
|
|
4315
4338
|
*/
|
|
4316
4339
|
excerpt_field: {
|
|
4317
4340
|
data: FieldData | null;
|
|
4318
4341
|
};
|
|
4319
4342
|
/**
|
|
4320
|
-
* The field upon which the collection is sorted
|
|
4343
|
+
* The field upon which the collection is sorted. This relationship does not apply to block models
|
|
4321
4344
|
*/
|
|
4322
4345
|
ordering_field: {
|
|
4323
4346
|
data: FieldData | null;
|
|
@@ -4370,14 +4393,14 @@ export type WorkflowData = {
|
|
|
4370
4393
|
id: WorkflowIdentity;
|
|
4371
4394
|
};
|
|
4372
4395
|
/**
|
|
4373
|
-
* Meta information regarding the
|
|
4396
|
+
* Meta information regarding the model/block model
|
|
4374
4397
|
*
|
|
4375
4398
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
4376
4399
|
* via the `definition` "meta".
|
|
4377
4400
|
*/
|
|
4378
4401
|
export type ItemTypeMeta = {
|
|
4379
4402
|
/**
|
|
4380
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4403
|
+
* 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
|
|
4381
4404
|
*/
|
|
4382
4405
|
has_singleton_item: boolean;
|
|
4383
4406
|
};
|
|
@@ -4394,15 +4417,15 @@ export type ItemTypeCreateSchema = {
|
|
|
4394
4417
|
*/
|
|
4395
4418
|
attributes: {
|
|
4396
4419
|
/**
|
|
4397
|
-
* Name of the model
|
|
4420
|
+
* Name of the model/block model
|
|
4398
4421
|
*/
|
|
4399
4422
|
name: string;
|
|
4400
4423
|
/**
|
|
4401
|
-
* API key of the model
|
|
4424
|
+
* API key of the model/block model
|
|
4402
4425
|
*/
|
|
4403
4426
|
api_key: string;
|
|
4404
4427
|
/**
|
|
4405
|
-
* Whether the model is single-instance or not
|
|
4428
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4406
4429
|
*/
|
|
4407
4430
|
singleton?: boolean;
|
|
4408
4431
|
/**
|
|
@@ -4410,31 +4433,31 @@ export type ItemTypeCreateSchema = {
|
|
|
4410
4433
|
*/
|
|
4411
4434
|
all_locales_required?: boolean;
|
|
4412
4435
|
/**
|
|
4413
|
-
* Whether editors can sort records via drag & drop or not
|
|
4436
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4414
4437
|
*/
|
|
4415
4438
|
sortable?: boolean;
|
|
4416
4439
|
/**
|
|
4417
|
-
* Whether this
|
|
4440
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4418
4441
|
*/
|
|
4419
4442
|
modular_block?: boolean;
|
|
4420
4443
|
/**
|
|
4421
|
-
* Whether draft/published mode is active or not
|
|
4444
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4422
4445
|
*/
|
|
4423
4446
|
draft_mode_active?: boolean;
|
|
4424
4447
|
/**
|
|
4425
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4448
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4426
4449
|
*/
|
|
4427
4450
|
draft_saving_active?: boolean;
|
|
4428
4451
|
/**
|
|
4429
|
-
* Whether editors can organize records in a tree or not
|
|
4452
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4430
4453
|
*/
|
|
4431
4454
|
tree?: boolean;
|
|
4432
4455
|
/**
|
|
4433
|
-
* If an ordering field is set, this
|
|
4456
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4434
4457
|
*/
|
|
4435
4458
|
ordering_direction?: null | 'asc' | 'desc';
|
|
4436
4459
|
/**
|
|
4437
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4460
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4438
4461
|
*/
|
|
4439
4462
|
ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
|
|
4440
4463
|
/**
|
|
@@ -4442,21 +4465,21 @@ export type ItemTypeCreateSchema = {
|
|
|
4442
4465
|
*/
|
|
4443
4466
|
collection_appeareance?: 'compact' | 'table';
|
|
4444
4467
|
/**
|
|
4445
|
-
* The way the model collection should be presented to the editors
|
|
4468
|
+
* The way the model/block model collection should be presented to the editors
|
|
4446
4469
|
*/
|
|
4447
4470
|
collection_appearance?: 'compact' | 'table';
|
|
4448
4471
|
/**
|
|
4449
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4472
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4450
4473
|
*/
|
|
4451
4474
|
hint?: string | null;
|
|
4452
4475
|
/**
|
|
4453
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4476
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4454
4477
|
*/
|
|
4455
4478
|
inverse_relationships_enabled?: boolean;
|
|
4456
4479
|
};
|
|
4457
4480
|
relationships?: {
|
|
4458
4481
|
/**
|
|
4459
|
-
* The field upon which the collection is sorted
|
|
4482
|
+
* The field upon which the collection is sorted. This relationship does not apply to block models
|
|
4460
4483
|
*/
|
|
4461
4484
|
ordering_field?: {
|
|
4462
4485
|
data: FieldData | null;
|
|
@@ -4474,19 +4497,19 @@ export type ItemTypeCreateSchema = {
|
|
|
4474
4497
|
data: FieldData | null;
|
|
4475
4498
|
};
|
|
4476
4499
|
/**
|
|
4477
|
-
* The field to use as fallback title for SEO purposes
|
|
4500
|
+
* The field to use as fallback title for SEO purposes. This relationship does not apply to block models
|
|
4478
4501
|
*/
|
|
4479
4502
|
title_field?: {
|
|
4480
4503
|
data: FieldData | null;
|
|
4481
4504
|
};
|
|
4482
4505
|
/**
|
|
4483
|
-
* The field to use as fallback image for SEO purposes
|
|
4506
|
+
* The field to use as fallback image for SEO purposes. This relationship does not apply to block models
|
|
4484
4507
|
*/
|
|
4485
4508
|
image_preview_field?: {
|
|
4486
4509
|
data: FieldData | null;
|
|
4487
4510
|
};
|
|
4488
4511
|
/**
|
|
4489
|
-
* The field to use as fallback description for SEO purposes
|
|
4512
|
+
* The field to use as fallback description for SEO purposes. This relationship does not apply to block models
|
|
4490
4513
|
*/
|
|
4491
4514
|
excerpt_field?: {
|
|
4492
4515
|
data: FieldData | null;
|
|
@@ -4521,11 +4544,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
4521
4544
|
*/
|
|
4522
4545
|
attributes?: {
|
|
4523
4546
|
/**
|
|
4524
|
-
* Name of the model
|
|
4547
|
+
* Name of the model/block model
|
|
4525
4548
|
*/
|
|
4526
4549
|
name?: string;
|
|
4527
4550
|
/**
|
|
4528
|
-
* API key of the model
|
|
4551
|
+
* API key of the model/block model
|
|
4529
4552
|
*/
|
|
4530
4553
|
api_key?: string;
|
|
4531
4554
|
/**
|
|
@@ -4533,11 +4556,11 @@ export type ItemTypeUpdateSchema = {
|
|
|
4533
4556
|
*/
|
|
4534
4557
|
collection_appeareance?: 'compact' | 'table';
|
|
4535
4558
|
/**
|
|
4536
|
-
* The way the model collection should be presented to the editors
|
|
4559
|
+
* The way the model/block model collection should be presented to the editors
|
|
4537
4560
|
*/
|
|
4538
4561
|
collection_appearance?: 'compact' | 'table';
|
|
4539
4562
|
/**
|
|
4540
|
-
* Whether the model is single-instance or not
|
|
4563
|
+
* Whether the model is single-instance or not. This property only applies to models, not block models
|
|
4541
4564
|
*/
|
|
4542
4565
|
singleton?: boolean;
|
|
4543
4566
|
/**
|
|
@@ -4545,49 +4568,49 @@ export type ItemTypeUpdateSchema = {
|
|
|
4545
4568
|
*/
|
|
4546
4569
|
all_locales_required?: boolean;
|
|
4547
4570
|
/**
|
|
4548
|
-
* Whether editors can sort records via drag & drop or not
|
|
4571
|
+
* Whether editors can sort records via drag & drop or not. Must be false for block models
|
|
4549
4572
|
*/
|
|
4550
4573
|
sortable?: boolean;
|
|
4551
4574
|
/**
|
|
4552
|
-
* Whether this
|
|
4575
|
+
* Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
|
|
4553
4576
|
*/
|
|
4554
4577
|
modular_block?: boolean;
|
|
4555
4578
|
/**
|
|
4556
|
-
* Whether draft/published mode is active or not
|
|
4579
|
+
* Whether draft/published mode is active or not. Must be false for block models
|
|
4557
4580
|
*/
|
|
4558
4581
|
draft_mode_active?: boolean;
|
|
4559
4582
|
/**
|
|
4560
|
-
* Whether draft records can be saved without satisfying the validations or not
|
|
4583
|
+
* Whether draft records can be saved without satisfying the validations or not. Must be false for block models
|
|
4561
4584
|
*/
|
|
4562
4585
|
draft_saving_active?: boolean;
|
|
4563
4586
|
/**
|
|
4564
|
-
* Whether editors can organize records in a tree or not
|
|
4587
|
+
* Whether editors can organize records in a tree or not. Must be false for block models
|
|
4565
4588
|
*/
|
|
4566
4589
|
tree?: boolean;
|
|
4567
4590
|
/**
|
|
4568
|
-
* If an ordering field is set, this
|
|
4591
|
+
* If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
|
|
4569
4592
|
*/
|
|
4570
4593
|
ordering_direction?: null | 'asc' | 'desc';
|
|
4571
4594
|
/**
|
|
4572
|
-
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
|
|
4595
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
|
|
4573
4596
|
*/
|
|
4574
4597
|
ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
|
|
4575
4598
|
/**
|
|
4576
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4599
|
+
* 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
|
|
4577
4600
|
*/
|
|
4578
4601
|
has_singleton_item?: boolean;
|
|
4579
4602
|
/**
|
|
4580
|
-
* A hint shown to editors to help them understand the purpose of this model/block
|
|
4603
|
+
* A hint shown to editors to help them understand the purpose of this model/block model
|
|
4581
4604
|
*/
|
|
4582
4605
|
hint?: string | null;
|
|
4583
4606
|
/**
|
|
4584
|
-
* Whether inverse relationships fields are expressed in GraphQL or not
|
|
4607
|
+
* Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
|
|
4585
4608
|
*/
|
|
4586
4609
|
inverse_relationships_enabled?: boolean;
|
|
4587
4610
|
};
|
|
4588
4611
|
relationships?: {
|
|
4589
4612
|
/**
|
|
4590
|
-
* The field upon which the collection is sorted
|
|
4613
|
+
* The field upon which the collection is sorted. This relationship does not apply to block models
|
|
4591
4614
|
*/
|
|
4592
4615
|
ordering_field?: {
|
|
4593
4616
|
data: FieldData | null;
|
|
@@ -4605,19 +4628,19 @@ export type ItemTypeUpdateSchema = {
|
|
|
4605
4628
|
data: FieldData | null;
|
|
4606
4629
|
};
|
|
4607
4630
|
/**
|
|
4608
|
-
* The field to use as fallback title for SEO purposes
|
|
4631
|
+
* The field to use as fallback title for SEO purposes. This relationship does not apply to block models
|
|
4609
4632
|
*/
|
|
4610
4633
|
title_field?: {
|
|
4611
4634
|
data: FieldData | null;
|
|
4612
4635
|
};
|
|
4613
4636
|
/**
|
|
4614
|
-
* The field to use as fallback image for SEO purposes
|
|
4637
|
+
* The field to use as fallback image for SEO purposes. This relationship does not apply to block models
|
|
4615
4638
|
*/
|
|
4616
4639
|
image_preview_field?: {
|
|
4617
4640
|
data: FieldData | null;
|
|
4618
4641
|
};
|
|
4619
4642
|
/**
|
|
4620
|
-
* The field to use as fallback description for SEO purposes
|
|
4643
|
+
* The field to use as fallback description for SEO purposes. This relationship does not apply to block models
|
|
4621
4644
|
*/
|
|
4622
4645
|
excerpt_field?: {
|
|
4623
4646
|
data: FieldData | null;
|
|
@@ -4631,7 +4654,7 @@ export type ItemTypeUpdateSchema = {
|
|
|
4631
4654
|
};
|
|
4632
4655
|
meta?: {
|
|
4633
4656
|
/**
|
|
4634
|
-
* If this model is single-instance, this tells the single-instance record has already been created or not
|
|
4657
|
+
* 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
|
|
4635
4658
|
*/
|
|
4636
4659
|
has_singleton_item?: boolean;
|
|
4637
4660
|
};
|
|
@@ -6722,7 +6745,7 @@ export type SubscriptionFeatureInstancesTargetSchema = {
|
|
|
6722
6745
|
data: SubscriptionFeature[];
|
|
6723
6746
|
};
|
|
6724
6747
|
/**
|
|
6725
|
-
* Represents an event occurred during the deploy process of
|
|
6748
|
+
* Represents an event occurred during the deploy process of a build trigger.
|
|
6726
6749
|
*
|
|
6727
6750
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6728
6751
|
* via the `definition` "build_event".
|
|
@@ -6807,7 +6830,7 @@ export type BuildEventSelfTargetSchema = {
|
|
|
6807
6830
|
data: BuildEvent;
|
|
6808
6831
|
};
|
|
6809
6832
|
/**
|
|
6810
|
-
* Represents an event occurred during the
|
|
6833
|
+
* Represents an event occurred during the indexing process via search indexes.
|
|
6811
6834
|
*
|
|
6812
6835
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6813
6836
|
* via the `definition` "search_index_event".
|
|
@@ -9273,6 +9296,10 @@ export type BuildTriggerAttributes = {
|
|
|
9273
9296
|
* Name of the build trigger
|
|
9274
9297
|
*/
|
|
9275
9298
|
name: string;
|
|
9299
|
+
/**
|
|
9300
|
+
* Whether the build trigger is enabled or not
|
|
9301
|
+
*/
|
|
9302
|
+
enabled: boolean;
|
|
9276
9303
|
/**
|
|
9277
9304
|
* The type of build trigger
|
|
9278
9305
|
*/
|
|
@@ -9304,7 +9331,7 @@ export type BuildTriggerAttributes = {
|
|
|
9304
9331
|
*/
|
|
9305
9332
|
indexing_status: string;
|
|
9306
9333
|
/**
|
|
9307
|
-
* The public URL of the frontend.
|
|
9334
|
+
* The public URL of the frontend.
|
|
9308
9335
|
*/
|
|
9309
9336
|
frontend_url: string | null;
|
|
9310
9337
|
/**
|
|
@@ -9315,10 +9342,6 @@ export type BuildTriggerAttributes = {
|
|
|
9315
9342
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9316
9343
|
*/
|
|
9317
9344
|
indexing_enabled: boolean;
|
|
9318
|
-
/**
|
|
9319
|
-
* Whether the build trigger is enabled or not
|
|
9320
|
-
*/
|
|
9321
|
-
enabled: boolean;
|
|
9322
9345
|
};
|
|
9323
9346
|
/**
|
|
9324
9347
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
@@ -9357,13 +9380,13 @@ export type BuildTriggerCreateSchema = {
|
|
|
9357
9380
|
/**
|
|
9358
9381
|
* Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
|
|
9359
9382
|
*/
|
|
9360
|
-
indexing_enabled
|
|
9383
|
+
indexing_enabled?: boolean;
|
|
9361
9384
|
/**
|
|
9362
9385
|
* Whether the build trigger is enabled or not
|
|
9363
9386
|
*/
|
|
9364
9387
|
enabled?: boolean;
|
|
9365
9388
|
/**
|
|
9366
|
-
* The public URL of the frontend.
|
|
9389
|
+
* The public URL of the frontend.
|
|
9367
9390
|
*/
|
|
9368
9391
|
frontend_url: string | null;
|
|
9369
9392
|
/**
|
|
@@ -9412,7 +9435,7 @@ export type BuildTriggerUpdateSchema = {
|
|
|
9412
9435
|
*/
|
|
9413
9436
|
enabled?: boolean;
|
|
9414
9437
|
/**
|
|
9415
|
-
* The public URL of the frontend.
|
|
9438
|
+
* The public URL of the frontend.
|
|
9416
9439
|
*/
|
|
9417
9440
|
frontend_url?: string | null;
|
|
9418
9441
|
/**
|
|
@@ -9443,7 +9466,7 @@ export type BuildTriggerDestroyTargetSchema = {
|
|
|
9443
9466
|
data: BuildTrigger;
|
|
9444
9467
|
};
|
|
9445
9468
|
/**
|
|
9446
|
-
* A Search Index
|
|
9469
|
+
* A Search Index is used to index a website to provide DatoCMS Site Search functionality.
|
|
9447
9470
|
*
|
|
9448
9471
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
9449
9472
|
* via the `definition` "search_index".
|
|
@@ -9471,11 +9494,7 @@ export type SearchIndexAttributes = {
|
|
|
9471
9494
|
*/
|
|
9472
9495
|
enabled: boolean;
|
|
9473
9496
|
/**
|
|
9474
|
-
*
|
|
9475
|
-
*/
|
|
9476
|
-
build_trigger_indexing_enabled: boolean;
|
|
9477
|
-
/**
|
|
9478
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9497
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
9479
9498
|
*/
|
|
9480
9499
|
frontend_url: string | null;
|
|
9481
9500
|
/**
|
|
@@ -9491,7 +9510,7 @@ export type SearchIndexAttributes = {
|
|
|
9491
9510
|
*/
|
|
9492
9511
|
export type SearchIndexRelationships = {
|
|
9493
9512
|
/**
|
|
9494
|
-
* The build triggers
|
|
9513
|
+
* The build triggers that can trigger this search index
|
|
9495
9514
|
*/
|
|
9496
9515
|
build_triggers: {
|
|
9497
9516
|
data: BuildTriggerData[];
|
|
@@ -9505,7 +9524,7 @@ export type SearchIndexRelationships = {
|
|
|
9505
9524
|
*/
|
|
9506
9525
|
export type SearchIndexMeta = {
|
|
9507
9526
|
/**
|
|
9508
|
-
* Status of the
|
|
9527
|
+
* Status of the search indexing
|
|
9509
9528
|
*/
|
|
9510
9529
|
indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
|
|
9511
9530
|
/**
|
|
@@ -9544,11 +9563,7 @@ export type SearchIndexCreateSchema = {
|
|
|
9544
9563
|
*/
|
|
9545
9564
|
enabled: boolean;
|
|
9546
9565
|
/**
|
|
9547
|
-
*
|
|
9548
|
-
*/
|
|
9549
|
-
build_trigger_indexing_enabled?: boolean;
|
|
9550
|
-
/**
|
|
9551
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9566
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
9552
9567
|
*/
|
|
9553
9568
|
frontend_url: string | null;
|
|
9554
9569
|
/**
|
|
@@ -9561,7 +9576,7 @@ export type SearchIndexCreateSchema = {
|
|
|
9561
9576
|
*/
|
|
9562
9577
|
relationships?: {
|
|
9563
9578
|
/**
|
|
9564
|
-
* The build triggers
|
|
9579
|
+
* The build triggers that can trigger this search index
|
|
9565
9580
|
*/
|
|
9566
9581
|
build_triggers?: {
|
|
9567
9582
|
data: BuildTriggerData[];
|
|
@@ -9594,11 +9609,7 @@ export type SearchIndexUpdateSchema = {
|
|
|
9594
9609
|
*/
|
|
9595
9610
|
enabled?: boolean;
|
|
9596
9611
|
/**
|
|
9597
|
-
*
|
|
9598
|
-
*/
|
|
9599
|
-
build_trigger_indexing_enabled?: boolean;
|
|
9600
|
-
/**
|
|
9601
|
-
* The public URL of the frontend. This is the starting point from which the website's spidering will start
|
|
9612
|
+
* The public URL of the website. This is the starting point from which the website's spidering will start
|
|
9602
9613
|
*/
|
|
9603
9614
|
frontend_url?: string | null;
|
|
9604
9615
|
/**
|
|
@@ -9611,7 +9622,7 @@ export type SearchIndexUpdateSchema = {
|
|
|
9611
9622
|
*/
|
|
9612
9623
|
relationships?: {
|
|
9613
9624
|
/**
|
|
9614
|
-
* The build triggers
|
|
9625
|
+
* The build triggers that can trigger this search index
|
|
9615
9626
|
*/
|
|
9616
9627
|
build_triggers?: {
|
|
9617
9628
|
data: BuildTriggerData[];
|
|
@@ -10828,6 +10839,10 @@ export type DailyUsageAttributes = {
|
|
|
10828
10839
|
* Video encoding seconds
|
|
10829
10840
|
*/
|
|
10830
10841
|
mux_encoded_seconds: number;
|
|
10842
|
+
/**
|
|
10843
|
+
* Number of images analyzed for smart tags
|
|
10844
|
+
*/
|
|
10845
|
+
smart_tags_detections: number;
|
|
10831
10846
|
};
|
|
10832
10847
|
/**
|
|
10833
10848
|
* JSON API data
|