@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.
Files changed (33) hide show
  1. package/README.md +4 -0
  2. package/dist/cjs/generated/Client.js +1 -1
  3. package/dist/cjs/generated/Client.js.map +1 -1
  4. package/dist/cjs/generated/resources/ItemType.js +12 -12
  5. package/dist/cjs/generated/resources/SearchIndex.js +10 -22
  6. package/dist/cjs/generated/resources/SearchIndex.js.map +1 -1
  7. package/dist/cjs/utilities/schemaRepository.js +132 -1
  8. package/dist/cjs/utilities/schemaRepository.js.map +1 -1
  9. package/dist/esm/generated/ApiTypes.d.ts +177 -158
  10. package/dist/esm/generated/Client.js +1 -1
  11. package/dist/esm/generated/Client.js.map +1 -1
  12. package/dist/esm/generated/RawApiTypes.d.ts +156 -141
  13. package/dist/esm/generated/resources/ItemType.d.ts +12 -12
  14. package/dist/esm/generated/resources/ItemType.js +12 -12
  15. package/dist/esm/generated/resources/SearchIndex.d.ts +8 -8
  16. package/dist/esm/generated/resources/SearchIndex.js +10 -22
  17. package/dist/esm/generated/resources/SearchIndex.js.map +1 -1
  18. package/dist/esm/utilities/schemaRepository.d.ts +42 -2
  19. package/dist/esm/utilities/schemaRepository.js +133 -2
  20. package/dist/esm/utilities/schemaRepository.js.map +1 -1
  21. package/dist/types/generated/ApiTypes.d.ts +177 -158
  22. package/dist/types/generated/RawApiTypes.d.ts +156 -141
  23. package/dist/types/generated/resources/ItemType.d.ts +12 -12
  24. package/dist/types/generated/resources/SearchIndex.d.ts +8 -8
  25. package/dist/types/utilities/schemaRepository.d.ts +42 -2
  26. package/package.json +3 -3
  27. package/resources.json +10 -12
  28. package/src/generated/ApiTypes.ts +177 -158
  29. package/src/generated/Client.ts +1 -1
  30. package/src/generated/RawApiTypes.ts +156 -141
  31. package/src/generated/resources/ItemType.ts +12 -12
  32. package/src/generated/resources/SearchIndex.ts +10 -22
  33. package/src/utilities/schemaRepository.ts +168 -10
@@ -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;
@@ -3762,6 +3762,10 @@ export type SitePlan = {
3762
3762
  * The number of available encoding seconds to Mux.com
3763
3763
  */
3764
3764
  mux_encoding_seconds: null | number;
3765
+ /**
3766
+ * The number of images you can analyze for smart tags detections
3767
+ */
3768
+ smart_tags_detections: null | number;
3765
3769
  /**
3766
3770
  * The number of different API tokens you can generate, each which different permissions
3767
3771
  */
@@ -4006,6 +4010,10 @@ export type SitePlanAttributes = {
4006
4010
  * The number of available encoding seconds to Mux.com
4007
4011
  */
4008
4012
  mux_encoding_seconds: null | number;
4013
+ /**
4014
+ * The number of images you can analyze for smart tags detections
4015
+ */
4016
+ smart_tags_detections: null | number;
4009
4017
  /**
4010
4018
  * The number of different API tokens you can generate, each which different permissions
4011
4019
  */
@@ -4646,7 +4654,26 @@ export type UploadCollectionUpdateSchema = {
4646
4654
  children?: UploadCollectionData[];
4647
4655
  };
4648
4656
  /**
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".
4657
+ * 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".
4658
+ *
4659
+ * ## Models
4660
+ *
4661
+ * 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.
4662
+ *
4663
+ * ## Block Models
4664
+ *
4665
+ * 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).
4666
+ *
4667
+ * ### Key differences:
4668
+ *
4669
+ * - **Models** create standalone records that can be referenced and have independent value
4670
+ * - **Block models** create blocks that only exist within parent records and cannot be referenced via link fields
4671
+ * - Block models defined in the library can be reused across different models
4672
+ * - When a record gets deleted, all the blocks it contains are deleted with it
4673
+ * - Blocks do not count towards your plan's records limit
4674
+ *
4675
+ * You can distinguish between models and block models using the `modular_block` attribute: `true` indicates a block model, `false` indicates a regular model.
4676
+ *
4650
4677
  *
4651
4678
  * This interface was referenced by `DatoApi`'s JSON-Schema
4652
4679
  * via the `definition` "item_type".
@@ -4655,11 +4682,11 @@ export type ItemType = {
4655
4682
  id: ItemTypeIdentity;
4656
4683
  type: ItemTypeType;
4657
4684
  /**
4658
- * Name of the model
4685
+ * Name of the model/block model
4659
4686
  */
4660
4687
  name: string;
4661
4688
  /**
4662
- * API key of the model
4689
+ * API key of the model/block model
4663
4690
  */
4664
4691
  api_key: string;
4665
4692
  /**
@@ -4667,11 +4694,11 @@ export type ItemType = {
4667
4694
  */
4668
4695
  collection_appeareance?: 'compact' | 'table';
4669
4696
  /**
4670
- * The way the model collection should be presented to the editors
4697
+ * The way the model/block model collection should be presented to the editors
4671
4698
  */
4672
4699
  collection_appearance: 'compact' | 'table';
4673
4700
  /**
4674
- * Whether the model is single-instance or not
4701
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4675
4702
  */
4676
4703
  singleton: boolean;
4677
4704
  /**
@@ -4679,43 +4706,43 @@ export type ItemType = {
4679
4706
  */
4680
4707
  all_locales_required: boolean;
4681
4708
  /**
4682
- * Whether editors can sort records via drag & drop or not
4709
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4683
4710
  */
4684
4711
  sortable: boolean;
4685
4712
  /**
4686
- * Whether this model is a modular content block or not
4713
+ * 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
4714
  */
4688
4715
  modular_block: boolean;
4689
4716
  /**
4690
- * Whether draft/published mode is active or not
4717
+ * Whether draft/published mode is active or not. Must be false for block models
4691
4718
  */
4692
4719
  draft_mode_active: boolean;
4693
4720
  /**
4694
- * Whether draft records can be saved without satisfying the validations or not
4721
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
4695
4722
  */
4696
4723
  draft_saving_active: boolean;
4697
4724
  /**
4698
- * Whether editors can organize records in a tree or not
4725
+ * Whether editors can organize records in a tree or not. Must be false for block models
4699
4726
  */
4700
4727
  tree: boolean;
4701
4728
  /**
4702
- * If an ordering field is set, this fields specify the sorting direction
4729
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
4703
4730
  */
4704
4731
  ordering_direction: null | 'asc' | 'desc';
4705
4732
  /**
4706
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
4733
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
4707
4734
  */
4708
4735
  ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
4709
4736
  /**
4710
- * If this model is single-instance, this tells the single-instance record has already been created or not
4737
+ * 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
4738
  */
4712
4739
  has_singleton_item: boolean;
4713
4740
  /**
4714
- * A hint shown to editors to help them understand the purpose of this model/block
4741
+ * A hint shown to editors to help them understand the purpose of this model/block model
4715
4742
  */
4716
4743
  hint: string | null;
4717
4744
  /**
4718
- * Whether inverse relationships fields are expressed in GraphQL or not
4745
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
4719
4746
  */
4720
4747
  inverse_relationships_enabled: boolean;
4721
4748
  singleton_item: ItemData | null;
@@ -4776,14 +4803,14 @@ export type WorkflowData = {
4776
4803
  id: WorkflowIdentity;
4777
4804
  };
4778
4805
  /**
4779
- * Meta information regarding the item type
4806
+ * Meta information regarding the model/block model
4780
4807
  *
4781
4808
  * This interface was referenced by `ItemType`'s JSON-Schema
4782
4809
  * via the `definition` "meta".
4783
4810
  */
4784
4811
  export type ItemTypeMeta = {
4785
4812
  /**
4786
- * If this model is single-instance, this tells the single-instance record has already been created or not
4813
+ * 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
4814
  */
4788
4815
  has_singleton_item: boolean;
4789
4816
  };
@@ -4795,11 +4822,11 @@ export type ItemTypeMeta = {
4795
4822
  */
4796
4823
  export type ItemTypeAttributes = {
4797
4824
  /**
4798
- * Name of the model
4825
+ * Name of the model/block model
4799
4826
  */
4800
4827
  name: string;
4801
4828
  /**
4802
- * API key of the model
4829
+ * API key of the model/block model
4803
4830
  */
4804
4831
  api_key: string;
4805
4832
  /**
@@ -4807,11 +4834,11 @@ export type ItemTypeAttributes = {
4807
4834
  */
4808
4835
  collection_appeareance?: 'compact' | 'table';
4809
4836
  /**
4810
- * The way the model collection should be presented to the editors
4837
+ * The way the model/block model collection should be presented to the editors
4811
4838
  */
4812
4839
  collection_appearance: 'compact' | 'table';
4813
4840
  /**
4814
- * Whether the model is single-instance or not
4841
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4815
4842
  */
4816
4843
  singleton: boolean;
4817
4844
  /**
@@ -4819,43 +4846,43 @@ export type ItemTypeAttributes = {
4819
4846
  */
4820
4847
  all_locales_required: boolean;
4821
4848
  /**
4822
- * Whether editors can sort records via drag & drop or not
4849
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4823
4850
  */
4824
4851
  sortable: boolean;
4825
4852
  /**
4826
- * Whether this model is a modular content block or not
4853
+ * 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
4854
  */
4828
4855
  modular_block: boolean;
4829
4856
  /**
4830
- * Whether draft/published mode is active or not
4857
+ * Whether draft/published mode is active or not. Must be false for block models
4831
4858
  */
4832
4859
  draft_mode_active: boolean;
4833
4860
  /**
4834
- * Whether draft records can be saved without satisfying the validations or not
4861
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
4835
4862
  */
4836
4863
  draft_saving_active: boolean;
4837
4864
  /**
4838
- * Whether editors can organize records in a tree or not
4865
+ * Whether editors can organize records in a tree or not. Must be false for block models
4839
4866
  */
4840
4867
  tree: boolean;
4841
4868
  /**
4842
- * If an ordering field is set, this fields specify the sorting direction
4869
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
4843
4870
  */
4844
4871
  ordering_direction: null | 'asc' | 'desc';
4845
4872
  /**
4846
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
4873
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
4847
4874
  */
4848
4875
  ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
4849
4876
  /**
4850
- * If this model is single-instance, this tells the single-instance record has already been created or not
4877
+ * 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
4878
  */
4852
4879
  has_singleton_item: boolean;
4853
4880
  /**
4854
- * A hint shown to editors to help them understand the purpose of this model/block
4881
+ * A hint shown to editors to help them understand the purpose of this model/block model
4855
4882
  */
4856
4883
  hint: string | null;
4857
4884
  /**
4858
- * Whether inverse relationships fields are expressed in GraphQL or not
4885
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
4859
4886
  */
4860
4887
  inverse_relationships_enabled: boolean;
4861
4888
  };
@@ -4885,15 +4912,15 @@ export type ItemTypeCreateSchema = {
4885
4912
  id?: ItemTypeIdentity;
4886
4913
  type?: ItemTypeType;
4887
4914
  /**
4888
- * Name of the model
4915
+ * Name of the model/block model
4889
4916
  */
4890
4917
  name: string;
4891
4918
  /**
4892
- * API key of the model
4919
+ * API key of the model/block model
4893
4920
  */
4894
4921
  api_key: string;
4895
4922
  /**
4896
- * Whether the model is single-instance or not
4923
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4897
4924
  */
4898
4925
  singleton?: boolean;
4899
4926
  /**
@@ -4901,31 +4928,31 @@ export type ItemTypeCreateSchema = {
4901
4928
  */
4902
4929
  all_locales_required?: boolean;
4903
4930
  /**
4904
- * Whether editors can sort records via drag & drop or not
4931
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4905
4932
  */
4906
4933
  sortable?: boolean;
4907
4934
  /**
4908
- * Whether this model is a modular content block or not
4935
+ * 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
4936
  */
4910
4937
  modular_block?: boolean;
4911
4938
  /**
4912
- * Whether draft/published mode is active or not
4939
+ * Whether draft/published mode is active or not. Must be false for block models
4913
4940
  */
4914
4941
  draft_mode_active?: boolean;
4915
4942
  /**
4916
- * Whether draft records can be saved without satisfying the validations or not
4943
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
4917
4944
  */
4918
4945
  draft_saving_active?: boolean;
4919
4946
  /**
4920
- * Whether editors can organize records in a tree or not
4947
+ * Whether editors can organize records in a tree or not. Must be false for block models
4921
4948
  */
4922
4949
  tree?: boolean;
4923
4950
  /**
4924
- * If an ordering field is set, this fields specify the sorting direction
4951
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
4925
4952
  */
4926
4953
  ordering_direction?: null | 'asc' | 'desc';
4927
4954
  /**
4928
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
4955
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
4929
4956
  */
4930
4957
  ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
4931
4958
  /**
@@ -4933,15 +4960,15 @@ export type ItemTypeCreateSchema = {
4933
4960
  */
4934
4961
  collection_appeareance?: 'compact' | 'table';
4935
4962
  /**
4936
- * The way the model collection should be presented to the editors
4963
+ * The way the model/block model collection should be presented to the editors
4937
4964
  */
4938
4965
  collection_appearance?: 'compact' | 'table';
4939
4966
  /**
4940
- * A hint shown to editors to help them understand the purpose of this model/block
4967
+ * A hint shown to editors to help them understand the purpose of this model/block model
4941
4968
  */
4942
4969
  hint?: string | null;
4943
4970
  /**
4944
- * Whether inverse relationships fields are expressed in GraphQL or not
4971
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
4945
4972
  */
4946
4973
  inverse_relationships_enabled?: boolean;
4947
4974
  ordering_field?: FieldData | null;
@@ -4960,11 +4987,11 @@ export type ItemTypeUpdateSchema = {
4960
4987
  id?: ItemTypeIdentity;
4961
4988
  type?: ItemTypeType;
4962
4989
  /**
4963
- * Name of the model
4990
+ * Name of the model/block model
4964
4991
  */
4965
4992
  name?: string;
4966
4993
  /**
4967
- * API key of the model
4994
+ * API key of the model/block model
4968
4995
  */
4969
4996
  api_key?: string;
4970
4997
  /**
@@ -4972,11 +4999,11 @@ export type ItemTypeUpdateSchema = {
4972
4999
  */
4973
5000
  collection_appeareance?: 'compact' | 'table';
4974
5001
  /**
4975
- * The way the model collection should be presented to the editors
5002
+ * The way the model/block model collection should be presented to the editors
4976
5003
  */
4977
5004
  collection_appearance?: 'compact' | 'table';
4978
5005
  /**
4979
- * Whether the model is single-instance or not
5006
+ * Whether the model is single-instance or not. This property only applies to models, not block models
4980
5007
  */
4981
5008
  singleton?: boolean;
4982
5009
  /**
@@ -4984,43 +5011,43 @@ export type ItemTypeUpdateSchema = {
4984
5011
  */
4985
5012
  all_locales_required?: boolean;
4986
5013
  /**
4987
- * Whether editors can sort records via drag & drop or not
5014
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
4988
5015
  */
4989
5016
  sortable?: boolean;
4990
5017
  /**
4991
- * Whether this model is a modular content block or not
5018
+ * 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
5019
  */
4993
5020
  modular_block?: boolean;
4994
5021
  /**
4995
- * Whether draft/published mode is active or not
5022
+ * Whether draft/published mode is active or not. Must be false for block models
4996
5023
  */
4997
5024
  draft_mode_active?: boolean;
4998
5025
  /**
4999
- * Whether draft records can be saved without satisfying the validations or not
5026
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
5000
5027
  */
5001
5028
  draft_saving_active?: boolean;
5002
5029
  /**
5003
- * Whether editors can organize records in a tree or not
5030
+ * Whether editors can organize records in a tree or not. Must be false for block models
5004
5031
  */
5005
5032
  tree?: boolean;
5006
5033
  /**
5007
- * If an ordering field is set, this fields specify the sorting direction
5034
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
5008
5035
  */
5009
5036
  ordering_direction?: null | 'asc' | 'desc';
5010
5037
  /**
5011
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
5038
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
5012
5039
  */
5013
5040
  ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
5014
5041
  /**
5015
- * If this model is single-instance, this tells the single-instance record has already been created or not
5042
+ * 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
5043
  */
5017
5044
  has_singleton_item?: boolean;
5018
5045
  /**
5019
- * A hint shown to editors to help them understand the purpose of this model/block
5046
+ * A hint shown to editors to help them understand the purpose of this model/block model
5020
5047
  */
5021
5048
  hint?: string | null;
5022
5049
  /**
5023
- * Whether inverse relationships fields are expressed in GraphQL or not
5050
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
5024
5051
  */
5025
5052
  inverse_relationships_enabled?: boolean;
5026
5053
  ordering_field?: FieldData | null;
@@ -5032,7 +5059,7 @@ export type ItemTypeUpdateSchema = {
5032
5059
  workflow?: WorkflowData | null;
5033
5060
  meta?: {
5034
5061
  /**
5035
- * If this model is single-instance, this tells the single-instance record has already been created or not
5062
+ * 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
5063
  */
5037
5064
  has_singleton_item?: boolean;
5038
5065
  };
@@ -6930,7 +6957,7 @@ export type SubscriptionFeatureAttributes = {
6930
6957
  enabled: boolean;
6931
6958
  };
6932
6959
  /**
6933
- * Represents an event occurred during the deploy process of your administrative area.
6960
+ * Represents an event occurred during the deploy process of a build trigger.
6934
6961
  *
6935
6962
  * This interface was referenced by `DatoApi`'s JSON-Schema
6936
6963
  * via the `definition` "build_event".
@@ -7007,7 +7034,7 @@ export type BuildEventRelationships = {
7007
7034
  build_trigger: BuildTriggerData;
7008
7035
  };
7009
7036
  /**
7010
- * Represents an event occurred during the search indexing process.
7037
+ * Represents an event occurred during the indexing process via search indexes.
7011
7038
  *
7012
7039
  * This interface was referenced by `DatoApi`'s JSON-Schema
7013
7040
  * via the `definition` "search_index_event".
@@ -8992,6 +9019,10 @@ export type BuildTrigger = {
8992
9019
  * Name of the build trigger
8993
9020
  */
8994
9021
  name: string;
9022
+ /**
9023
+ * Whether the build trigger is enabled or not
9024
+ */
9025
+ enabled: boolean;
8995
9026
  /**
8996
9027
  * The type of build trigger
8997
9028
  */
@@ -9023,7 +9054,7 @@ export type BuildTrigger = {
9023
9054
  */
9024
9055
  indexing_status: string;
9025
9056
  /**
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
9057
+ * The public URL of the frontend.
9027
9058
  */
9028
9059
  frontend_url: string | null;
9029
9060
  /**
@@ -9034,10 +9065,6 @@ export type BuildTrigger = {
9034
9065
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9035
9066
  */
9036
9067
  indexing_enabled: boolean;
9037
- /**
9038
- * Whether the build trigger is enabled or not
9039
- */
9040
- enabled: boolean;
9041
9068
  };
9042
9069
  export type BuildTriggerSelfTargetSchema = BuildTrigger;
9043
9070
  export type BuildTriggerCreateTargetSchema = BuildTrigger;
@@ -9054,6 +9081,10 @@ export type BuildTriggerAttributes = {
9054
9081
  * Name of the build trigger
9055
9082
  */
9056
9083
  name: string;
9084
+ /**
9085
+ * Whether the build trigger is enabled or not
9086
+ */
9087
+ enabled: boolean;
9057
9088
  /**
9058
9089
  * The type of build trigger
9059
9090
  */
@@ -9085,7 +9116,7 @@ export type BuildTriggerAttributes = {
9085
9116
  */
9086
9117
  indexing_status: string;
9087
9118
  /**
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
9119
+ * The public URL of the frontend.
9089
9120
  */
9090
9121
  frontend_url: string | null;
9091
9122
  /**
@@ -9096,10 +9127,6 @@ export type BuildTriggerAttributes = {
9096
9127
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9097
9128
  */
9098
9129
  indexing_enabled: boolean;
9099
- /**
9100
- * Whether the build trigger is enabled or not
9101
- */
9102
- enabled: boolean;
9103
9130
  };
9104
9131
  /**
9105
9132
  * This interface was referenced by `BuildTrigger`'s JSON-Schema
@@ -9122,13 +9149,13 @@ export type BuildTriggerCreateSchema = {
9122
9149
  /**
9123
9150
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9124
9151
  */
9125
- indexing_enabled: boolean;
9152
+ indexing_enabled?: boolean;
9126
9153
  /**
9127
9154
  * Whether the build trigger is enabled or not
9128
9155
  */
9129
9156
  enabled?: boolean;
9130
9157
  /**
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
9158
+ * The public URL of the frontend.
9132
9159
  */
9133
9160
  frontend_url: string | null;
9134
9161
  /**
@@ -9166,7 +9193,7 @@ export type BuildTriggerUpdateSchema = {
9166
9193
  */
9167
9194
  enabled?: boolean;
9168
9195
  /**
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
9196
+ * The public URL of the frontend.
9170
9197
  */
9171
9198
  frontend_url?: string | null;
9172
9199
  /**
@@ -9181,7 +9208,7 @@ export type BuildTriggerUpdateSchema = {
9181
9208
  };
9182
9209
  };
9183
9210
  /**
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.
9211
+ * A Search Index is used to index a website to provide DatoCMS Site Search functionality.
9185
9212
  *
9186
9213
  * This interface was referenced by `DatoApi`'s JSON-Schema
9187
9214
  * via the `definition` "search_index".
@@ -9198,11 +9225,7 @@ export type SearchIndex = {
9198
9225
  */
9199
9226
  enabled: boolean;
9200
9227
  /**
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
9228
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9206
9229
  */
9207
9230
  frontend_url: string | null;
9208
9231
  /**
@@ -9224,7 +9247,7 @@ export type SearchIndexDestroyTargetSchema = SearchIndex;
9224
9247
  */
9225
9248
  export type SearchIndexMeta = {
9226
9249
  /**
9227
- * Status of the site search indexing
9250
+ * Status of the search indexing
9228
9251
  */
9229
9252
  indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
9230
9253
  /**
@@ -9248,11 +9271,7 @@ export type SearchIndexAttributes = {
9248
9271
  */
9249
9272
  enabled: boolean;
9250
9273
  /**
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
9274
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9256
9275
  */
9257
9276
  frontend_url: string | null;
9258
9277
  /**
@@ -9284,11 +9303,7 @@ export type SearchIndexCreateSchema = {
9284
9303
  */
9285
9304
  enabled: boolean;
9286
9305
  /**
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
9306
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9292
9307
  */
9293
9308
  frontend_url: string | null;
9294
9309
  /**
@@ -9313,11 +9328,7 @@ export type SearchIndexUpdateSchema = {
9313
9328
  */
9314
9329
  enabled?: boolean;
9315
9330
  /**
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
9331
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9321
9332
  */
9322
9333
  frontend_url?: string | null;
9323
9334
  /**
@@ -10320,6 +10331,10 @@ export type DailyUsage = {
10320
10331
  * Video encoding seconds
10321
10332
  */
10322
10333
  mux_encoded_seconds: number;
10334
+ /**
10335
+ * Number of images analyzed for smart tags
10336
+ */
10337
+ smart_tags_detections: number;
10323
10338
  };
10324
10339
  /**
10325
10340
  * JSON API data
@@ -10374,6 +10389,10 @@ export type DailyUsageAttributes = {
10374
10389
  * Video encoding seconds
10375
10390
  */
10376
10391
  mux_encoded_seconds: number;
10392
+ /**
10393
+ * Number of images analyzed for smart tags
10394
+ */
10395
+ smart_tags_detections: number;
10377
10396
  };
10378
10397
  /**
10379
10398
  * You can use counters to analyze your project's data consumption over a period of time. Counters are especially useful if your project is exceeding its API calls/traffic quota limits, to better understand where and how requests are originating. Counters are updated every minute, so you can debug in real-time the results of your changes.