@datocms/cma-client 5.2.0-alpha.4 → 5.2.0-alpha.5

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.
Files changed (31) hide show
  1. package/README.md +4 -0
  2. package/dist/cjs/generated/Client.js +1 -1
  3. package/dist/cjs/generated/resources/ItemType.js +12 -12
  4. package/dist/cjs/generated/resources/SearchIndex.js +10 -22
  5. package/dist/cjs/generated/resources/SearchIndex.js.map +1 -1
  6. package/dist/cjs/utilities/schemaRepository.js +131 -0
  7. package/dist/cjs/utilities/schemaRepository.js.map +1 -1
  8. package/dist/esm/generated/ApiTypes.d.ts +161 -158
  9. package/dist/esm/generated/Client.js +1 -1
  10. package/dist/esm/generated/RawApiTypes.d.ts +148 -141
  11. package/dist/esm/generated/resources/ItemType.d.ts +12 -12
  12. package/dist/esm/generated/resources/ItemType.js +12 -12
  13. package/dist/esm/generated/resources/SearchIndex.d.ts +8 -8
  14. package/dist/esm/generated/resources/SearchIndex.js +10 -22
  15. package/dist/esm/generated/resources/SearchIndex.js.map +1 -1
  16. package/dist/esm/utilities/schemaRepository.d.ts +42 -2
  17. package/dist/esm/utilities/schemaRepository.js +132 -1
  18. package/dist/esm/utilities/schemaRepository.js.map +1 -1
  19. package/dist/types/generated/ApiTypes.d.ts +161 -158
  20. package/dist/types/generated/RawApiTypes.d.ts +148 -141
  21. package/dist/types/generated/resources/ItemType.d.ts +12 -12
  22. package/dist/types/generated/resources/SearchIndex.d.ts +8 -8
  23. package/dist/types/utilities/schemaRepository.d.ts +42 -2
  24. package/package.json +3 -3
  25. package/resources.json +10 -12
  26. package/src/generated/ApiTypes.ts +161 -158
  27. package/src/generated/Client.ts +1 -1
  28. package/src/generated/RawApiTypes.ts +148 -141
  29. package/src/generated/resources/ItemType.ts +12 -12
  30. package/src/generated/resources/SearchIndex.ts +10 -22
  31. package/src/utilities/schemaRepository.ts +167 -9
@@ -898,19 +898,19 @@ export type ItemInstancesHrefSchema<D extends ItemTypeDefinition = ItemTypeDefin
898
898
  */
899
899
  filter?: {
900
900
  /**
901
- * Record (or block record) IDs to fetch, comma separated. If you use this filter, you _must not_ use `filter[type]` or `filter[fields]`
901
+ * 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
902
902
  */
903
903
  ids?: string;
904
904
  /**
905
- * Model ID or `api_key` to filter. If you use this filter, you _must not_ use `filter[ids]`. Comma separated values are accepted, but you _must not_ use `filter[fields]` in this case
905
+ * 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
906
906
  */
907
907
  type?: string;
908
908
  /**
909
- * Textual query to match. You _must not_ use `filter[ids]`. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
909
+ * 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.
910
910
  */
911
911
  query?: string;
912
912
  /**
913
- * Same as [GraphQL API records filters](/docs/content-delivery-api/filtering-records): you must use square brackets to indicate nesting levels. E.g. if you wanna [filter by parent record](/docs/content-delivery-api/filtering-records#parent) in a tree of records, you must use `filter[fields][parent][eq]=<ID_VALUE>`. Use snake_case for fields names. If `locale` is defined, search within that locale. Otherwise environment's main locale will be used.
913
+ * 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.
914
914
  */
915
915
  fields?: ToItemHrefSchemaField<D>;
916
916
  /**
@@ -976,7 +976,7 @@ export type ItemSelfHrefSchema = {
976
976
  */
977
977
  nested?: boolean;
978
978
  /**
979
- * Whether you want the currently published versions (`published`, default) of your records, or the latest available (`current`)
979
+ * Whether you want the currently published versions (`published`) of your records, or the latest available (`current`, default)
980
980
  */
981
981
  version?: string;
982
982
  [k: string]: unknown;
@@ -1346,11 +1346,11 @@ export type SearchResultInstancesHrefSchema = {
1346
1346
  */
1347
1347
  query: string;
1348
1348
  /**
1349
- * The search index ID or name on which the search will be performed. If not provided, the first enabled search index will be used.
1349
+ * The search index ID on which the search will be performed. If not provided, the first enabled search index will be used.
1350
1350
  */
1351
1351
  search_index_id?: string;
1352
1352
  /**
1353
- * **[Deprecated]** Use `search_index_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 search indexes associated.
1353
+ * The build trigger ID or name on which the search will be performed.
1354
1354
  */
1355
1355
  build_trigger_id?: string;
1356
1356
  /**
@@ -1931,7 +1931,7 @@ export type Role = {
1931
1931
  */
1932
1932
  can_edit_site: boolean;
1933
1933
  /**
1934
- * Can create/edit models and plugins
1934
+ * Can create and edit models and plugins
1935
1935
  */
1936
1936
  can_edit_schema: boolean;
1937
1937
  /**
@@ -1951,31 +1951,31 @@ export type Role = {
1951
1951
  */
1952
1952
  environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
1953
1953
  /**
1954
- * Can create/edit roles and invite/remove collaborators
1954
+ * Can create and edit roles and invite/remove collaborators
1955
1955
  */
1956
1956
  can_manage_users: boolean;
1957
1957
  /**
1958
- * Can create/edit shared filters (both for models and the media area)
1958
+ * Can create and edit shared filters (both for models and the media area)
1959
1959
  */
1960
1960
  can_manage_shared_filters: boolean;
1961
1961
  /**
1962
- * Can create/edit upload collections
1962
+ * Can create and edit upload collections
1963
1963
  */
1964
1964
  can_manage_upload_collections: boolean;
1965
1965
  /**
1966
- * Can create/edit Build triggers
1966
+ * Can create and edit build triggers
1967
1967
  */
1968
1968
  can_manage_build_triggers: boolean;
1969
1969
  /**
1970
- * Can create/edit Search Indexes
1970
+ * Can create and edit search indexes
1971
1971
  */
1972
1972
  can_manage_search_indexes: boolean;
1973
1973
  /**
1974
- * Can create/edit webhooks
1974
+ * Can create and edit webhooks
1975
1975
  */
1976
1976
  can_manage_webhooks: boolean;
1977
1977
  /**
1978
- * Can create/delete sandbox environments and promote them to primary environment
1978
+ * Can create and delete sandbox environments and promote them to primary environment
1979
1979
  */
1980
1980
  can_manage_environments: boolean;
1981
1981
  /**
@@ -1987,7 +1987,7 @@ export type Role = {
1987
1987
  */
1988
1988
  can_access_audit_log: boolean;
1989
1989
  /**
1990
- * Can create/edit workflows
1990
+ * Can create and edit workflows
1991
1991
  */
1992
1992
  can_manage_workflows: boolean;
1993
1993
  /**
@@ -2115,13 +2115,13 @@ export type Role = {
2115
2115
  build_trigger?: BuildTriggerIdentity | null;
2116
2116
  }[];
2117
2117
  /**
2118
- * Allowed search indexes for a role
2118
+ * Search indexes that can be triggered by a role
2119
2119
  */
2120
2120
  positive_search_index_permissions: {
2121
2121
  search_index?: SearchIndexIdentity | null;
2122
2122
  }[];
2123
2123
  /**
2124
- * Prohibited search indexes for a role
2124
+ * Search indexes that can't be triggered by a role
2125
2125
  */
2126
2126
  negative_search_index_permissions: {
2127
2127
  search_index?: SearchIndexIdentity | null;
@@ -2164,7 +2164,7 @@ export type RoleMeta = {
2164
2164
  */
2165
2165
  can_edit_site: boolean;
2166
2166
  /**
2167
- * Can create/edit models and plugins
2167
+ * Can create and edit models and plugins
2168
2168
  */
2169
2169
  can_edit_schema: boolean;
2170
2170
  /**
@@ -2184,31 +2184,31 @@ export type RoleMeta = {
2184
2184
  */
2185
2185
  environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2186
2186
  /**
2187
- * Can create/edit roles and invite/remove collaborators
2187
+ * Can create and edit roles and invite/remove collaborators
2188
2188
  */
2189
2189
  can_manage_users: boolean;
2190
2190
  /**
2191
- * Can create/edit shared filters (both for models and the media area)
2191
+ * Can create and edit shared filters (both for models and the media area)
2192
2192
  */
2193
2193
  can_manage_shared_filters: boolean;
2194
2194
  /**
2195
- * Can create/edit upload collections
2195
+ * Can create and edit upload collections
2196
2196
  */
2197
2197
  can_manage_upload_collections: boolean;
2198
2198
  /**
2199
- * Can create/edit Build triggers
2199
+ * Can create and edit build triggers
2200
2200
  */
2201
2201
  can_manage_build_triggers: boolean;
2202
2202
  /**
2203
- * Can create/edit Search Indexes
2203
+ * Can create and edit search indexes
2204
2204
  */
2205
2205
  can_manage_search_indexes: boolean;
2206
2206
  /**
2207
- * Can create/edit webhooks
2207
+ * Can create and edit webhooks
2208
2208
  */
2209
2209
  can_manage_webhooks: boolean;
2210
2210
  /**
2211
- * Can create/delete sandbox environments and promote them to primary environment
2211
+ * Can create and delete sandbox environments and promote them to primary environment
2212
2212
  */
2213
2213
  can_manage_environments: boolean;
2214
2214
  /**
@@ -2220,7 +2220,7 @@ export type RoleMeta = {
2220
2220
  */
2221
2221
  can_access_audit_log: boolean;
2222
2222
  /**
2223
- * Can create/edit workflows
2223
+ * Can create and edit workflows
2224
2224
  */
2225
2225
  can_manage_workflows: boolean;
2226
2226
  /**
@@ -2348,13 +2348,13 @@ export type RoleMeta = {
2348
2348
  build_trigger?: BuildTriggerIdentity | null;
2349
2349
  }[];
2350
2350
  /**
2351
- * Allowed search indexes for a role
2351
+ * Search indexes that can be triggered by a role
2352
2352
  */
2353
2353
  positive_search_index_permissions: {
2354
2354
  search_index?: SearchIndexIdentity | null;
2355
2355
  }[];
2356
2356
  /**
2357
- * Prohibited search indexes for a role
2357
+ * Search indexes that can't be triggered by a role
2358
2358
  */
2359
2359
  negative_search_index_permissions: {
2360
2360
  search_index?: SearchIndexIdentity | null;
@@ -2381,7 +2381,7 @@ export type RoleAttributes = {
2381
2381
  */
2382
2382
  can_edit_site: boolean;
2383
2383
  /**
2384
- * Can create/edit models and plugins
2384
+ * Can create and edit models and plugins
2385
2385
  */
2386
2386
  can_edit_schema: boolean;
2387
2387
  /**
@@ -2401,31 +2401,31 @@ export type RoleAttributes = {
2401
2401
  */
2402
2402
  environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2403
2403
  /**
2404
- * Can create/edit roles and invite/remove collaborators
2404
+ * Can create and edit roles and invite/remove collaborators
2405
2405
  */
2406
2406
  can_manage_users: boolean;
2407
2407
  /**
2408
- * Can create/edit shared filters (both for models and the media area)
2408
+ * Can create and edit shared filters (both for models and the media area)
2409
2409
  */
2410
2410
  can_manage_shared_filters: boolean;
2411
2411
  /**
2412
- * Can create/edit upload collections
2412
+ * Can create and edit upload collections
2413
2413
  */
2414
2414
  can_manage_upload_collections: boolean;
2415
2415
  /**
2416
- * Can create/edit Build triggers
2416
+ * Can create and edit build triggers
2417
2417
  */
2418
2418
  can_manage_build_triggers: boolean;
2419
2419
  /**
2420
- * Can create/edit Search Indexes
2420
+ * Can create and edit search indexes
2421
2421
  */
2422
2422
  can_manage_search_indexes: boolean;
2423
2423
  /**
2424
- * Can create/edit webhooks
2424
+ * Can create and edit webhooks
2425
2425
  */
2426
2426
  can_manage_webhooks: boolean;
2427
2427
  /**
2428
- * Can create/delete sandbox environments and promote them to primary environment
2428
+ * Can create and delete sandbox environments and promote them to primary environment
2429
2429
  */
2430
2430
  can_manage_environments: boolean;
2431
2431
  /**
@@ -2437,7 +2437,7 @@ export type RoleAttributes = {
2437
2437
  */
2438
2438
  can_access_audit_log: boolean;
2439
2439
  /**
2440
- * Can create/edit workflows
2440
+ * Can create and edit workflows
2441
2441
  */
2442
2442
  can_manage_workflows: boolean;
2443
2443
  /**
@@ -2565,13 +2565,13 @@ export type RoleAttributes = {
2565
2565
  build_trigger?: BuildTriggerIdentity | null;
2566
2566
  }[];
2567
2567
  /**
2568
- * Allowed search indexes for a role
2568
+ * Search indexes that can be triggered by a role
2569
2569
  */
2570
2570
  positive_search_index_permissions: {
2571
2571
  search_index?: SearchIndexIdentity | null;
2572
2572
  }[];
2573
2573
  /**
2574
- * Prohibited search indexes for a role
2574
+ * Search indexes that can't be triggered by a role
2575
2575
  */
2576
2576
  negative_search_index_permissions: {
2577
2577
  search_index?: SearchIndexIdentity | null;
@@ -2605,7 +2605,7 @@ export type RoleCreateSchema = {
2605
2605
  */
2606
2606
  can_edit_site?: boolean;
2607
2607
  /**
2608
- * Can create/edit models and plugins
2608
+ * Can create and edit models and plugins
2609
2609
  */
2610
2610
  can_edit_schema?: boolean;
2611
2611
  /**
@@ -2625,31 +2625,31 @@ export type RoleCreateSchema = {
2625
2625
  */
2626
2626
  environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2627
2627
  /**
2628
- * Can create/edit roles and invite/remove collaborators
2628
+ * Can create and edit roles and invite/remove collaborators
2629
2629
  */
2630
2630
  can_manage_users?: boolean;
2631
2631
  /**
2632
- * Can create/edit shared filters (both for models and the media area)
2632
+ * Can create and edit shared filters (both for models and the media area)
2633
2633
  */
2634
2634
  can_manage_shared_filters?: boolean;
2635
2635
  /**
2636
- * Can create/edit Search Indexes
2636
+ * Can create and edit search indexes
2637
2637
  */
2638
2638
  can_manage_search_indexes?: boolean;
2639
2639
  /**
2640
- * Can create/edit upload collections
2640
+ * Can create and edit upload collections
2641
2641
  */
2642
2642
  can_manage_upload_collections?: boolean;
2643
2643
  /**
2644
- * Can create/edit Build triggers
2644
+ * Can create and edit build triggers
2645
2645
  */
2646
2646
  can_manage_build_triggers?: boolean;
2647
2647
  /**
2648
- * Can create/edit webhooks
2648
+ * Can create and edit webhooks
2649
2649
  */
2650
2650
  can_manage_webhooks?: boolean;
2651
2651
  /**
2652
- * Can create/delete sandbox environments and promote them to primary environment
2652
+ * Can create and delete sandbox environments and promote them to primary environment
2653
2653
  */
2654
2654
  can_manage_environments?: boolean;
2655
2655
  /**
@@ -2661,7 +2661,7 @@ export type RoleCreateSchema = {
2661
2661
  */
2662
2662
  can_access_audit_log?: boolean;
2663
2663
  /**
2664
- * Can create/edit workflows
2664
+ * Can create and edit workflows
2665
2665
  */
2666
2666
  can_manage_workflows?: boolean;
2667
2667
  /**
@@ -2789,13 +2789,13 @@ export type RoleCreateSchema = {
2789
2789
  build_trigger?: BuildTriggerIdentity | null;
2790
2790
  }[];
2791
2791
  /**
2792
- * Allowed search indexes for a role
2792
+ * Search indexes that can be triggered by a role
2793
2793
  */
2794
2794
  positive_search_index_permissions?: {
2795
2795
  search_index?: SearchIndexIdentity | null;
2796
2796
  }[];
2797
2797
  /**
2798
- * Prohibited search indexes for a role
2798
+ * Search indexes that can't be triggered by a role
2799
2799
  */
2800
2800
  negative_search_index_permissions?: {
2801
2801
  search_index?: SearchIndexIdentity | null;
@@ -2823,7 +2823,7 @@ export type RoleUpdateSchema = {
2823
2823
  */
2824
2824
  can_edit_site?: boolean;
2825
2825
  /**
2826
- * Can create/edit models and plugins
2826
+ * Can create and edit models and plugins
2827
2827
  */
2828
2828
  can_edit_schema?: boolean;
2829
2829
  /**
@@ -2843,31 +2843,31 @@ export type RoleUpdateSchema = {
2843
2843
  */
2844
2844
  environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2845
2845
  /**
2846
- * Can create/edit roles and invite/remove collaborators
2846
+ * Can create and edit roles and invite/remove collaborators
2847
2847
  */
2848
2848
  can_manage_users?: boolean;
2849
2849
  /**
2850
- * Can create/edit shared filters (both for models and the media area)
2850
+ * Can create and edit shared filters (both for models and the media area)
2851
2851
  */
2852
2852
  can_manage_shared_filters?: boolean;
2853
2853
  /**
2854
- * Can create/edit Search Indexes
2854
+ * Can create and edit search indexes
2855
2855
  */
2856
2856
  can_manage_search_indexes?: boolean;
2857
2857
  /**
2858
- * Can create/edit upload collections
2858
+ * Can create and edit upload collections
2859
2859
  */
2860
2860
  can_manage_upload_collections?: boolean;
2861
2861
  /**
2862
- * Can create/edit Build triggers
2862
+ * Can create and edit build triggers
2863
2863
  */
2864
2864
  can_manage_build_triggers?: boolean;
2865
2865
  /**
2866
- * Can create/edit webhooks
2866
+ * Can create and edit webhooks
2867
2867
  */
2868
2868
  can_manage_webhooks?: boolean;
2869
2869
  /**
2870
- * Can create/delete sandbox environments and promote them to primary environment
2870
+ * Can create and delete sandbox environments and promote them to primary environment
2871
2871
  */
2872
2872
  can_manage_environments?: boolean;
2873
2873
  /**
@@ -2879,7 +2879,7 @@ export type RoleUpdateSchema = {
2879
2879
  */
2880
2880
  can_access_audit_log?: boolean;
2881
2881
  /**
2882
- * Can create/edit workflows
2882
+ * Can create and edit workflows
2883
2883
  */
2884
2884
  can_manage_workflows?: boolean;
2885
2885
  /**
@@ -3007,13 +3007,13 @@ export type RoleUpdateSchema = {
3007
3007
  build_trigger?: BuildTriggerIdentity | null;
3008
3008
  }[];
3009
3009
  /**
3010
- * Allowed search indexes for a role
3010
+ * Search indexes that can be triggered by a role
3011
3011
  */
3012
3012
  positive_search_index_permissions?: {
3013
3013
  search_index?: SearchIndexIdentity | null;
3014
3014
  }[];
3015
3015
  /**
3016
- * Prohibited search indexes for a role
3016
+ * Search indexes that can't be triggered by a role
3017
3017
  */
3018
3018
  negative_search_index_permissions?: {
3019
3019
  search_index?: SearchIndexIdentity | null;
@@ -4646,7 +4646,26 @@ export type UploadCollectionUpdateSchema = {
4646
4646
  children?: UploadCollectionData[];
4647
4647
  };
4648
4648
  /**
4649
- * The way you define the kind of content you can edit inside your administrative area passes through the concept of Models, which are much like database tables. For backward-compatibility reasons, the API refers to models as "item types".
4649
+ * 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".
4650
+ *
4651
+ * ## Models
4652
+ *
4653
+ * 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.
4654
+ *
4655
+ * ## Block Models
4656
+ *
4657
+ * 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).
4658
+ *
4659
+ * ### Key differences:
4660
+ *
4661
+ * - **Models** create standalone records that can be referenced and have independent value
4662
+ * - **Block models** create blocks that only exist within parent records and cannot be referenced via link fields
4663
+ * - Block models defined in the library can be reused across different models
4664
+ * - When a record gets deleted, all the blocks it contains are deleted with it
4665
+ * - Blocks do not count towards your plan's records limit
4666
+ *
4667
+ * You can distinguish between models and block models using the `modular_block` attribute: `true` indicates a block model, `false` indicates a regular model.
4668
+ *
4650
4669
  *
4651
4670
  * This interface was referenced by `DatoApi`'s JSON-Schema
4652
4671
  * via the `definition` "item_type".
@@ -4655,11 +4674,11 @@ export type ItemType = {
4655
4674
  id: ItemTypeIdentity;
4656
4675
  type: ItemTypeType;
4657
4676
  /**
4658
- * Name of the model
4677
+ * Name of the model/block model
4659
4678
  */
4660
4679
  name: string;
4661
4680
  /**
4662
- * API key of the model
4681
+ * API key of the model/block model
4663
4682
  */
4664
4683
  api_key: string;
4665
4684
  /**
@@ -4667,11 +4686,11 @@ export type ItemType = {
4667
4686
  */
4668
4687
  collection_appeareance?: 'compact' | 'table';
4669
4688
  /**
4670
- * The way the model collection should be presented to the editors
4689
+ * The way the model/block model collection should be presented to the editors
4671
4690
  */
4672
4691
  collection_appearance: 'compact' | 'table';
4673
4692
  /**
4674
- * Whether the model is single-instance or not
4693
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4675
4694
  */
4676
4695
  singleton: boolean;
4677
4696
  /**
@@ -4679,43 +4698,43 @@ export type ItemType = {
4679
4698
  */
4680
4699
  all_locales_required: boolean;
4681
4700
  /**
4682
- * Whether editors can sort records via drag & drop or not
4701
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4683
4702
  */
4684
4703
  sortable: boolean;
4685
4704
  /**
4686
- * Whether this model is a modular content block or not
4705
+ * Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
4687
4706
  */
4688
4707
  modular_block: boolean;
4689
4708
  /**
4690
- * Whether draft/published mode is active or not
4709
+ * Whether draft/published mode is active or not. Must be false for block models
4691
4710
  */
4692
4711
  draft_mode_active: boolean;
4693
4712
  /**
4694
- * Whether draft records can be saved without satisfying the validations or not
4713
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
4695
4714
  */
4696
4715
  draft_saving_active: boolean;
4697
4716
  /**
4698
- * Whether editors can organize records in a tree or not
4717
+ * Whether editors can organize records in a tree or not. Must be false for block models
4699
4718
  */
4700
4719
  tree: boolean;
4701
4720
  /**
4702
- * If an ordering field is set, this fields specify the sorting direction
4721
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
4703
4722
  */
4704
4723
  ordering_direction: null | 'asc' | 'desc';
4705
4724
  /**
4706
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
4725
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
4707
4726
  */
4708
4727
  ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
4709
4728
  /**
4710
- * If this model is single-instance, this tells the single-instance record has already been created or not
4729
+ * 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
4711
4730
  */
4712
4731
  has_singleton_item: boolean;
4713
4732
  /**
4714
- * A hint shown to editors to help them understand the purpose of this model/block
4733
+ * A hint shown to editors to help them understand the purpose of this model/block model
4715
4734
  */
4716
4735
  hint: string | null;
4717
4736
  /**
4718
- * Whether inverse relationships fields are expressed in GraphQL or not
4737
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
4719
4738
  */
4720
4739
  inverse_relationships_enabled: boolean;
4721
4740
  singleton_item: ItemData | null;
@@ -4776,14 +4795,14 @@ export type WorkflowData = {
4776
4795
  id: WorkflowIdentity;
4777
4796
  };
4778
4797
  /**
4779
- * Meta information regarding the item type
4798
+ * Meta information regarding the model/block model
4780
4799
  *
4781
4800
  * This interface was referenced by `ItemType`'s JSON-Schema
4782
4801
  * via the `definition` "meta".
4783
4802
  */
4784
4803
  export type ItemTypeMeta = {
4785
4804
  /**
4786
- * If this model is single-instance, this tells the single-instance record has already been created or not
4805
+ * 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
4787
4806
  */
4788
4807
  has_singleton_item: boolean;
4789
4808
  };
@@ -4795,11 +4814,11 @@ export type ItemTypeMeta = {
4795
4814
  */
4796
4815
  export type ItemTypeAttributes = {
4797
4816
  /**
4798
- * Name of the model
4817
+ * Name of the model/block model
4799
4818
  */
4800
4819
  name: string;
4801
4820
  /**
4802
- * API key of the model
4821
+ * API key of the model/block model
4803
4822
  */
4804
4823
  api_key: string;
4805
4824
  /**
@@ -4807,11 +4826,11 @@ export type ItemTypeAttributes = {
4807
4826
  */
4808
4827
  collection_appeareance?: 'compact' | 'table';
4809
4828
  /**
4810
- * The way the model collection should be presented to the editors
4829
+ * The way the model/block model collection should be presented to the editors
4811
4830
  */
4812
4831
  collection_appearance: 'compact' | 'table';
4813
4832
  /**
4814
- * Whether the model is single-instance or not
4833
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4815
4834
  */
4816
4835
  singleton: boolean;
4817
4836
  /**
@@ -4819,43 +4838,43 @@ export type ItemTypeAttributes = {
4819
4838
  */
4820
4839
  all_locales_required: boolean;
4821
4840
  /**
4822
- * Whether editors can sort records via drag & drop or not
4841
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4823
4842
  */
4824
4843
  sortable: boolean;
4825
4844
  /**
4826
- * Whether this model is a modular content block or not
4845
+ * Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
4827
4846
  */
4828
4847
  modular_block: boolean;
4829
4848
  /**
4830
- * Whether draft/published mode is active or not
4849
+ * Whether draft/published mode is active or not. Must be false for block models
4831
4850
  */
4832
4851
  draft_mode_active: boolean;
4833
4852
  /**
4834
- * Whether draft records can be saved without satisfying the validations or not
4853
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
4835
4854
  */
4836
4855
  draft_saving_active: boolean;
4837
4856
  /**
4838
- * Whether editors can organize records in a tree or not
4857
+ * Whether editors can organize records in a tree or not. Must be false for block models
4839
4858
  */
4840
4859
  tree: boolean;
4841
4860
  /**
4842
- * If an ordering field is set, this fields specify the sorting direction
4861
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
4843
4862
  */
4844
4863
  ordering_direction: null | 'asc' | 'desc';
4845
4864
  /**
4846
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
4865
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
4847
4866
  */
4848
4867
  ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
4849
4868
  /**
4850
- * If this model is single-instance, this tells the single-instance record has already been created or not
4869
+ * 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
4851
4870
  */
4852
4871
  has_singleton_item: boolean;
4853
4872
  /**
4854
- * A hint shown to editors to help them understand the purpose of this model/block
4873
+ * A hint shown to editors to help them understand the purpose of this model/block model
4855
4874
  */
4856
4875
  hint: string | null;
4857
4876
  /**
4858
- * Whether inverse relationships fields are expressed in GraphQL or not
4877
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
4859
4878
  */
4860
4879
  inverse_relationships_enabled: boolean;
4861
4880
  };
@@ -4885,15 +4904,15 @@ export type ItemTypeCreateSchema = {
4885
4904
  id?: ItemTypeIdentity;
4886
4905
  type?: ItemTypeType;
4887
4906
  /**
4888
- * Name of the model
4907
+ * Name of the model/block model
4889
4908
  */
4890
4909
  name: string;
4891
4910
  /**
4892
- * API key of the model
4911
+ * API key of the model/block model
4893
4912
  */
4894
4913
  api_key: string;
4895
4914
  /**
4896
- * Whether the model is single-instance or not
4915
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4897
4916
  */
4898
4917
  singleton?: boolean;
4899
4918
  /**
@@ -4901,31 +4920,31 @@ export type ItemTypeCreateSchema = {
4901
4920
  */
4902
4921
  all_locales_required?: boolean;
4903
4922
  /**
4904
- * Whether editors can sort records via drag & drop or not
4923
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4905
4924
  */
4906
4925
  sortable?: boolean;
4907
4926
  /**
4908
- * Whether this model is a modular content block or not
4927
+ * Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
4909
4928
  */
4910
4929
  modular_block?: boolean;
4911
4930
  /**
4912
- * Whether draft/published mode is active or not
4931
+ * Whether draft/published mode is active or not. Must be false for block models
4913
4932
  */
4914
4933
  draft_mode_active?: boolean;
4915
4934
  /**
4916
- * Whether draft records can be saved without satisfying the validations or not
4935
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
4917
4936
  */
4918
4937
  draft_saving_active?: boolean;
4919
4938
  /**
4920
- * Whether editors can organize records in a tree or not
4939
+ * Whether editors can organize records in a tree or not. Must be false for block models
4921
4940
  */
4922
4941
  tree?: boolean;
4923
4942
  /**
4924
- * If an ordering field is set, this fields specify the sorting direction
4943
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
4925
4944
  */
4926
4945
  ordering_direction?: null | 'asc' | 'desc';
4927
4946
  /**
4928
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
4947
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
4929
4948
  */
4930
4949
  ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
4931
4950
  /**
@@ -4933,15 +4952,15 @@ export type ItemTypeCreateSchema = {
4933
4952
  */
4934
4953
  collection_appeareance?: 'compact' | 'table';
4935
4954
  /**
4936
- * The way the model collection should be presented to the editors
4955
+ * The way the model/block model collection should be presented to the editors
4937
4956
  */
4938
4957
  collection_appearance?: 'compact' | 'table';
4939
4958
  /**
4940
- * A hint shown to editors to help them understand the purpose of this model/block
4959
+ * A hint shown to editors to help them understand the purpose of this model/block model
4941
4960
  */
4942
4961
  hint?: string | null;
4943
4962
  /**
4944
- * Whether inverse relationships fields are expressed in GraphQL or not
4963
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
4945
4964
  */
4946
4965
  inverse_relationships_enabled?: boolean;
4947
4966
  ordering_field?: FieldData | null;
@@ -4960,11 +4979,11 @@ export type ItemTypeUpdateSchema = {
4960
4979
  id?: ItemTypeIdentity;
4961
4980
  type?: ItemTypeType;
4962
4981
  /**
4963
- * Name of the model
4982
+ * Name of the model/block model
4964
4983
  */
4965
4984
  name?: string;
4966
4985
  /**
4967
- * API key of the model
4986
+ * API key of the model/block model
4968
4987
  */
4969
4988
  api_key?: string;
4970
4989
  /**
@@ -4972,11 +4991,11 @@ export type ItemTypeUpdateSchema = {
4972
4991
  */
4973
4992
  collection_appeareance?: 'compact' | 'table';
4974
4993
  /**
4975
- * The way the model collection should be presented to the editors
4994
+ * The way the model/block model collection should be presented to the editors
4976
4995
  */
4977
4996
  collection_appearance?: 'compact' | 'table';
4978
4997
  /**
4979
- * Whether the model is single-instance or not
4998
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4980
4999
  */
4981
5000
  singleton?: boolean;
4982
5001
  /**
@@ -4984,43 +5003,43 @@ export type ItemTypeUpdateSchema = {
4984
5003
  */
4985
5004
  all_locales_required?: boolean;
4986
5005
  /**
4987
- * Whether editors can sort records via drag & drop or not
5006
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4988
5007
  */
4989
5008
  sortable?: boolean;
4990
5009
  /**
4991
- * Whether this model is a modular content block or not
5010
+ * Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
4992
5011
  */
4993
5012
  modular_block?: boolean;
4994
5013
  /**
4995
- * Whether draft/published mode is active or not
5014
+ * Whether draft/published mode is active or not. Must be false for block models
4996
5015
  */
4997
5016
  draft_mode_active?: boolean;
4998
5017
  /**
4999
- * Whether draft records can be saved without satisfying the validations or not
5018
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
5000
5019
  */
5001
5020
  draft_saving_active?: boolean;
5002
5021
  /**
5003
- * Whether editors can organize records in a tree or not
5022
+ * Whether editors can organize records in a tree or not. Must be false for block models
5004
5023
  */
5005
5024
  tree?: boolean;
5006
5025
  /**
5007
- * If an ordering field is set, this fields specify the sorting direction
5026
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
5008
5027
  */
5009
5028
  ordering_direction?: null | 'asc' | 'desc';
5010
5029
  /**
5011
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
5030
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
5012
5031
  */
5013
5032
  ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
5014
5033
  /**
5015
- * If this model is single-instance, this tells the single-instance record has already been created or not
5034
+ * 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
5016
5035
  */
5017
5036
  has_singleton_item?: boolean;
5018
5037
  /**
5019
- * A hint shown to editors to help them understand the purpose of this model/block
5038
+ * A hint shown to editors to help them understand the purpose of this model/block model
5020
5039
  */
5021
5040
  hint?: string | null;
5022
5041
  /**
5023
- * Whether inverse relationships fields are expressed in GraphQL or not
5042
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
5024
5043
  */
5025
5044
  inverse_relationships_enabled?: boolean;
5026
5045
  ordering_field?: FieldData | null;
@@ -5032,7 +5051,7 @@ export type ItemTypeUpdateSchema = {
5032
5051
  workflow?: WorkflowData | null;
5033
5052
  meta?: {
5034
5053
  /**
5035
- * If this model is single-instance, this tells the single-instance record has already been created or not
5054
+ * 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
5036
5055
  */
5037
5056
  has_singleton_item?: boolean;
5038
5057
  };
@@ -6930,7 +6949,7 @@ export type SubscriptionFeatureAttributes = {
6930
6949
  enabled: boolean;
6931
6950
  };
6932
6951
  /**
6933
- * Represents an event occurred during the deploy process of your administrative area.
6952
+ * Represents an event occurred during the deploy process of a build trigger.
6934
6953
  *
6935
6954
  * This interface was referenced by `DatoApi`'s JSON-Schema
6936
6955
  * via the `definition` "build_event".
@@ -7007,7 +7026,7 @@ export type BuildEventRelationships = {
7007
7026
  build_trigger: BuildTriggerData;
7008
7027
  };
7009
7028
  /**
7010
- * Represents an event occurred during the search indexing process.
7029
+ * Represents an event occurred during the indexing process via search indexes.
7011
7030
  *
7012
7031
  * This interface was referenced by `DatoApi`'s JSON-Schema
7013
7032
  * via the `definition` "search_index_event".
@@ -8992,6 +9011,10 @@ export type BuildTrigger = {
8992
9011
  * Name of the build trigger
8993
9012
  */
8994
9013
  name: string;
9014
+ /**
9015
+ * Whether the build trigger is enabled or not
9016
+ */
9017
+ enabled: boolean;
8995
9018
  /**
8996
9019
  * The type of build trigger
8997
9020
  */
@@ -9023,7 +9046,7 @@ export type BuildTrigger = {
9023
9046
  */
9024
9047
  indexing_status: string;
9025
9048
  /**
9026
- * 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
9049
+ * The public URL of the frontend.
9027
9050
  */
9028
9051
  frontend_url: string | null;
9029
9052
  /**
@@ -9034,10 +9057,6 @@ export type BuildTrigger = {
9034
9057
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9035
9058
  */
9036
9059
  indexing_enabled: boolean;
9037
- /**
9038
- * Whether the build trigger is enabled or not
9039
- */
9040
- enabled: boolean;
9041
9060
  };
9042
9061
  export type BuildTriggerSelfTargetSchema = BuildTrigger;
9043
9062
  export type BuildTriggerCreateTargetSchema = BuildTrigger;
@@ -9054,6 +9073,10 @@ export type BuildTriggerAttributes = {
9054
9073
  * Name of the build trigger
9055
9074
  */
9056
9075
  name: string;
9076
+ /**
9077
+ * Whether the build trigger is enabled or not
9078
+ */
9079
+ enabled: boolean;
9057
9080
  /**
9058
9081
  * The type of build trigger
9059
9082
  */
@@ -9085,7 +9108,7 @@ export type BuildTriggerAttributes = {
9085
9108
  */
9086
9109
  indexing_status: string;
9087
9110
  /**
9088
- * 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
9111
+ * The public URL of the frontend.
9089
9112
  */
9090
9113
  frontend_url: string | null;
9091
9114
  /**
@@ -9096,10 +9119,6 @@ export type BuildTriggerAttributes = {
9096
9119
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9097
9120
  */
9098
9121
  indexing_enabled: boolean;
9099
- /**
9100
- * Whether the build trigger is enabled or not
9101
- */
9102
- enabled: boolean;
9103
9122
  };
9104
9123
  /**
9105
9124
  * This interface was referenced by `BuildTrigger`'s JSON-Schema
@@ -9122,13 +9141,13 @@ export type BuildTriggerCreateSchema = {
9122
9141
  /**
9123
9142
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9124
9143
  */
9125
- indexing_enabled: boolean;
9144
+ indexing_enabled?: boolean;
9126
9145
  /**
9127
9146
  * Whether the build trigger is enabled or not
9128
9147
  */
9129
9148
  enabled?: boolean;
9130
9149
  /**
9131
- * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
9150
+ * The public URL of the frontend.
9132
9151
  */
9133
9152
  frontend_url: string | null;
9134
9153
  /**
@@ -9166,7 +9185,7 @@ export type BuildTriggerUpdateSchema = {
9166
9185
  */
9167
9186
  enabled?: boolean;
9168
9187
  /**
9169
- * The public URL of the frontend. If Site Search is enabled (indicated by `indexing_enabled`), this is the starting point from which the website's spidering will start
9188
+ * The public URL of the frontend.
9170
9189
  */
9171
9190
  frontend_url?: string | null;
9172
9191
  /**
@@ -9181,7 +9200,7 @@ export type BuildTriggerUpdateSchema = {
9181
9200
  };
9182
9201
  };
9183
9202
  /**
9184
- * A Search Index represents a website that should be indexed by DatoCMS Site Search. When enabled, DatoCMS will periodically spider the website to update the search index.
9203
+ * A Search Index is used to index a website to provide DatoCMS Site Search functionality.
9185
9204
  *
9186
9205
  * This interface was referenced by `DatoApi`'s JSON-Schema
9187
9206
  * via the `definition` "search_index".
@@ -9198,11 +9217,7 @@ export type SearchIndex = {
9198
9217
  */
9199
9218
  enabled: boolean;
9200
9219
  /**
9201
- * Whether the spidering should automatically run after associated build triggers complete
9202
- */
9203
- build_trigger_indexing_enabled: boolean;
9204
- /**
9205
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
9220
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9206
9221
  */
9207
9222
  frontend_url: string | null;
9208
9223
  /**
@@ -9224,7 +9239,7 @@ export type SearchIndexDestroyTargetSchema = SearchIndex;
9224
9239
  */
9225
9240
  export type SearchIndexMeta = {
9226
9241
  /**
9227
- * Status of the site search indexing
9242
+ * Status of the search indexing
9228
9243
  */
9229
9244
  indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
9230
9245
  /**
@@ -9248,11 +9263,7 @@ export type SearchIndexAttributes = {
9248
9263
  */
9249
9264
  enabled: boolean;
9250
9265
  /**
9251
- * Whether the spidering should automatically run after associated build triggers complete
9252
- */
9253
- build_trigger_indexing_enabled: boolean;
9254
- /**
9255
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
9266
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9256
9267
  */
9257
9268
  frontend_url: string | null;
9258
9269
  /**
@@ -9284,11 +9295,7 @@ export type SearchIndexCreateSchema = {
9284
9295
  */
9285
9296
  enabled: boolean;
9286
9297
  /**
9287
- * Whether the spidering should automatically run after associated build triggers complete
9288
- */
9289
- build_trigger_indexing_enabled?: boolean;
9290
- /**
9291
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
9298
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9292
9299
  */
9293
9300
  frontend_url: string | null;
9294
9301
  /**
@@ -9313,11 +9320,7 @@ export type SearchIndexUpdateSchema = {
9313
9320
  */
9314
9321
  enabled?: boolean;
9315
9322
  /**
9316
- * Whether the spidering should automatically run after associated build triggers complete
9317
- */
9318
- build_trigger_indexing_enabled?: boolean;
9319
- /**
9320
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
9323
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9321
9324
  */
9322
9325
  frontend_url?: string | null;
9323
9326
  /**