@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
@@ -962,19 +962,19 @@ export type ItemInstancesHrefSchema<
962
962
  */
963
963
  filter?: {
964
964
  /**
965
- * Record (or block record) IDs to fetch, comma separated. If you use this filter, you _must not_ use `filter[type]` or `filter[fields]`
965
+ * 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
966
966
  */
967
967
  ids?: string;
968
968
  /**
969
- * 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
969
+ * 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
970
970
  */
971
971
  type?: string;
972
972
  /**
973
- * 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.
973
+ * 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.
974
974
  */
975
975
  query?: string;
976
976
  /**
977
- * 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.
977
+ * 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.
978
978
  */
979
979
  fields?: ToItemHrefSchemaField<D>;
980
980
  /**
@@ -1043,7 +1043,7 @@ export type ItemSelfHrefSchema = {
1043
1043
  */
1044
1044
  nested?: boolean;
1045
1045
  /**
1046
- * Whether you want the currently published versions (`published`, default) of your records, or the latest available (`current`)
1046
+ * Whether you want the currently published versions (`published`) of your records, or the latest available (`current`, default)
1047
1047
  */
1048
1048
  version?: string;
1049
1049
  [k: string]: unknown;
@@ -1421,11 +1421,11 @@ export type SearchResultInstancesHrefSchema = {
1421
1421
  */
1422
1422
  query: string;
1423
1423
  /**
1424
- * The search index ID or name on which the search will be performed. If not provided, the first enabled search index will be used.
1424
+ * The search index ID on which the search will be performed. If not provided, the first enabled search index will be used.
1425
1425
  */
1426
1426
  search_index_id?: string;
1427
1427
  /**
1428
- * **[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.
1428
+ * The build trigger ID or name on which the search will be performed.
1429
1429
  */
1430
1430
  build_trigger_id?: string;
1431
1431
  /**
@@ -2058,7 +2058,7 @@ export type Role = {
2058
2058
  */
2059
2059
  can_edit_site: boolean;
2060
2060
  /**
2061
- * Can create/edit models and plugins
2061
+ * Can create and edit models and plugins
2062
2062
  */
2063
2063
  can_edit_schema: boolean;
2064
2064
  /**
@@ -2078,31 +2078,31 @@ export type Role = {
2078
2078
  */
2079
2079
  environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2080
2080
  /**
2081
- * Can create/edit roles and invite/remove collaborators
2081
+ * Can create and edit roles and invite/remove collaborators
2082
2082
  */
2083
2083
  can_manage_users: boolean;
2084
2084
  /**
2085
- * Can create/edit shared filters (both for models and the media area)
2085
+ * Can create and edit shared filters (both for models and the media area)
2086
2086
  */
2087
2087
  can_manage_shared_filters: boolean;
2088
2088
  /**
2089
- * Can create/edit upload collections
2089
+ * Can create and edit upload collections
2090
2090
  */
2091
2091
  can_manage_upload_collections: boolean;
2092
2092
  /**
2093
- * Can create/edit Build triggers
2093
+ * Can create and edit build triggers
2094
2094
  */
2095
2095
  can_manage_build_triggers: boolean;
2096
2096
  /**
2097
- * Can create/edit Search Indexes
2097
+ * Can create and edit search indexes
2098
2098
  */
2099
2099
  can_manage_search_indexes: boolean;
2100
2100
  /**
2101
- * Can create/edit webhooks
2101
+ * Can create and edit webhooks
2102
2102
  */
2103
2103
  can_manage_webhooks: boolean;
2104
2104
  /**
2105
- * Can create/delete sandbox environments and promote them to primary environment
2105
+ * Can create and delete sandbox environments and promote them to primary environment
2106
2106
  */
2107
2107
  can_manage_environments: boolean;
2108
2108
  /**
@@ -2114,7 +2114,7 @@ export type Role = {
2114
2114
  */
2115
2115
  can_access_audit_log: boolean;
2116
2116
  /**
2117
- * Can create/edit workflows
2117
+ * Can create and edit workflows
2118
2118
  */
2119
2119
  can_manage_workflows: boolean;
2120
2120
  /**
@@ -2276,13 +2276,13 @@ export type Role = {
2276
2276
  build_trigger?: BuildTriggerIdentity | null;
2277
2277
  }[];
2278
2278
  /**
2279
- * Allowed search indexes for a role
2279
+ * Search indexes that can be triggered by a role
2280
2280
  */
2281
2281
  positive_search_index_permissions: {
2282
2282
  search_index?: SearchIndexIdentity | null;
2283
2283
  }[];
2284
2284
  /**
2285
- * Prohibited search indexes for a role
2285
+ * Search indexes that can't be triggered by a role
2286
2286
  */
2287
2287
  negative_search_index_permissions: {
2288
2288
  search_index?: SearchIndexIdentity | null;
@@ -2325,7 +2325,7 @@ export type RoleMeta = {
2325
2325
  */
2326
2326
  can_edit_site: boolean;
2327
2327
  /**
2328
- * Can create/edit models and plugins
2328
+ * Can create and edit models and plugins
2329
2329
  */
2330
2330
  can_edit_schema: boolean;
2331
2331
  /**
@@ -2345,31 +2345,31 @@ export type RoleMeta = {
2345
2345
  */
2346
2346
  environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2347
2347
  /**
2348
- * Can create/edit roles and invite/remove collaborators
2348
+ * Can create and edit roles and invite/remove collaborators
2349
2349
  */
2350
2350
  can_manage_users: boolean;
2351
2351
  /**
2352
- * Can create/edit shared filters (both for models and the media area)
2352
+ * Can create and edit shared filters (both for models and the media area)
2353
2353
  */
2354
2354
  can_manage_shared_filters: boolean;
2355
2355
  /**
2356
- * Can create/edit upload collections
2356
+ * Can create and edit upload collections
2357
2357
  */
2358
2358
  can_manage_upload_collections: boolean;
2359
2359
  /**
2360
- * Can create/edit Build triggers
2360
+ * Can create and edit build triggers
2361
2361
  */
2362
2362
  can_manage_build_triggers: boolean;
2363
2363
  /**
2364
- * Can create/edit Search Indexes
2364
+ * Can create and edit search indexes
2365
2365
  */
2366
2366
  can_manage_search_indexes: boolean;
2367
2367
  /**
2368
- * Can create/edit webhooks
2368
+ * Can create and edit webhooks
2369
2369
  */
2370
2370
  can_manage_webhooks: boolean;
2371
2371
  /**
2372
- * Can create/delete sandbox environments and promote them to primary environment
2372
+ * Can create and delete sandbox environments and promote them to primary environment
2373
2373
  */
2374
2374
  can_manage_environments: boolean;
2375
2375
  /**
@@ -2381,7 +2381,7 @@ export type RoleMeta = {
2381
2381
  */
2382
2382
  can_access_audit_log: boolean;
2383
2383
  /**
2384
- * Can create/edit workflows
2384
+ * Can create and edit workflows
2385
2385
  */
2386
2386
  can_manage_workflows: boolean;
2387
2387
  /**
@@ -2543,13 +2543,13 @@ export type RoleMeta = {
2543
2543
  build_trigger?: BuildTriggerIdentity | null;
2544
2544
  }[];
2545
2545
  /**
2546
- * Allowed search indexes for a role
2546
+ * Search indexes that can be triggered by a role
2547
2547
  */
2548
2548
  positive_search_index_permissions: {
2549
2549
  search_index?: SearchIndexIdentity | null;
2550
2550
  }[];
2551
2551
  /**
2552
- * Prohibited search indexes for a role
2552
+ * Search indexes that can't be triggered by a role
2553
2553
  */
2554
2554
  negative_search_index_permissions: {
2555
2555
  search_index?: SearchIndexIdentity | null;
@@ -2576,7 +2576,7 @@ export type RoleAttributes = {
2576
2576
  */
2577
2577
  can_edit_site: boolean;
2578
2578
  /**
2579
- * Can create/edit models and plugins
2579
+ * Can create and edit models and plugins
2580
2580
  */
2581
2581
  can_edit_schema: boolean;
2582
2582
  /**
@@ -2596,31 +2596,31 @@ export type RoleAttributes = {
2596
2596
  */
2597
2597
  environments_access: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2598
2598
  /**
2599
- * Can create/edit roles and invite/remove collaborators
2599
+ * Can create and edit roles and invite/remove collaborators
2600
2600
  */
2601
2601
  can_manage_users: boolean;
2602
2602
  /**
2603
- * Can create/edit shared filters (both for models and the media area)
2603
+ * Can create and edit shared filters (both for models and the media area)
2604
2604
  */
2605
2605
  can_manage_shared_filters: boolean;
2606
2606
  /**
2607
- * Can create/edit upload collections
2607
+ * Can create and edit upload collections
2608
2608
  */
2609
2609
  can_manage_upload_collections: boolean;
2610
2610
  /**
2611
- * Can create/edit Build triggers
2611
+ * Can create and edit build triggers
2612
2612
  */
2613
2613
  can_manage_build_triggers: boolean;
2614
2614
  /**
2615
- * Can create/edit Search Indexes
2615
+ * Can create and edit search indexes
2616
2616
  */
2617
2617
  can_manage_search_indexes: boolean;
2618
2618
  /**
2619
- * Can create/edit webhooks
2619
+ * Can create and edit webhooks
2620
2620
  */
2621
2621
  can_manage_webhooks: boolean;
2622
2622
  /**
2623
- * Can create/delete sandbox environments and promote them to primary environment
2623
+ * Can create and delete sandbox environments and promote them to primary environment
2624
2624
  */
2625
2625
  can_manage_environments: boolean;
2626
2626
  /**
@@ -2632,7 +2632,7 @@ export type RoleAttributes = {
2632
2632
  */
2633
2633
  can_access_audit_log: boolean;
2634
2634
  /**
2635
- * Can create/edit workflows
2635
+ * Can create and edit workflows
2636
2636
  */
2637
2637
  can_manage_workflows: boolean;
2638
2638
  /**
@@ -2794,13 +2794,13 @@ export type RoleAttributes = {
2794
2794
  build_trigger?: BuildTriggerIdentity | null;
2795
2795
  }[];
2796
2796
  /**
2797
- * Allowed search indexes for a role
2797
+ * Search indexes that can be triggered by a role
2798
2798
  */
2799
2799
  positive_search_index_permissions: {
2800
2800
  search_index?: SearchIndexIdentity | null;
2801
2801
  }[];
2802
2802
  /**
2803
- * Prohibited search indexes for a role
2803
+ * Search indexes that can't be triggered by a role
2804
2804
  */
2805
2805
  negative_search_index_permissions: {
2806
2806
  search_index?: SearchIndexIdentity | null;
@@ -2834,7 +2834,7 @@ export type RoleCreateSchema = {
2834
2834
  */
2835
2835
  can_edit_site?: boolean;
2836
2836
  /**
2837
- * Can create/edit models and plugins
2837
+ * Can create and edit models and plugins
2838
2838
  */
2839
2839
  can_edit_schema?: boolean;
2840
2840
  /**
@@ -2854,31 +2854,31 @@ export type RoleCreateSchema = {
2854
2854
  */
2855
2855
  environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
2856
2856
  /**
2857
- * Can create/edit roles and invite/remove collaborators
2857
+ * Can create and edit roles and invite/remove collaborators
2858
2858
  */
2859
2859
  can_manage_users?: boolean;
2860
2860
  /**
2861
- * Can create/edit shared filters (both for models and the media area)
2861
+ * Can create and edit shared filters (both for models and the media area)
2862
2862
  */
2863
2863
  can_manage_shared_filters?: boolean;
2864
2864
  /**
2865
- * Can create/edit Search Indexes
2865
+ * Can create and edit search indexes
2866
2866
  */
2867
2867
  can_manage_search_indexes?: boolean;
2868
2868
  /**
2869
- * Can create/edit upload collections
2869
+ * Can create and edit upload collections
2870
2870
  */
2871
2871
  can_manage_upload_collections?: boolean;
2872
2872
  /**
2873
- * Can create/edit Build triggers
2873
+ * Can create and edit build triggers
2874
2874
  */
2875
2875
  can_manage_build_triggers?: boolean;
2876
2876
  /**
2877
- * Can create/edit webhooks
2877
+ * Can create and edit webhooks
2878
2878
  */
2879
2879
  can_manage_webhooks?: boolean;
2880
2880
  /**
2881
- * Can create/delete sandbox environments and promote them to primary environment
2881
+ * Can create and delete sandbox environments and promote them to primary environment
2882
2882
  */
2883
2883
  can_manage_environments?: boolean;
2884
2884
  /**
@@ -2890,7 +2890,7 @@ export type RoleCreateSchema = {
2890
2890
  */
2891
2891
  can_access_audit_log?: boolean;
2892
2892
  /**
2893
- * Can create/edit workflows
2893
+ * Can create and edit workflows
2894
2894
  */
2895
2895
  can_manage_workflows?: boolean;
2896
2896
  /**
@@ -3052,13 +3052,13 @@ export type RoleCreateSchema = {
3052
3052
  build_trigger?: BuildTriggerIdentity | null;
3053
3053
  }[];
3054
3054
  /**
3055
- * Allowed search indexes for a role
3055
+ * Search indexes that can be triggered by a role
3056
3056
  */
3057
3057
  positive_search_index_permissions?: {
3058
3058
  search_index?: SearchIndexIdentity | null;
3059
3059
  }[];
3060
3060
  /**
3061
- * Prohibited search indexes for a role
3061
+ * Search indexes that can't be triggered by a role
3062
3062
  */
3063
3063
  negative_search_index_permissions?: {
3064
3064
  search_index?: SearchIndexIdentity | null;
@@ -3086,7 +3086,7 @@ export type RoleUpdateSchema = {
3086
3086
  */
3087
3087
  can_edit_site?: boolean;
3088
3088
  /**
3089
- * Can create/edit models and plugins
3089
+ * Can create and edit models and plugins
3090
3090
  */
3091
3091
  can_edit_schema?: boolean;
3092
3092
  /**
@@ -3106,31 +3106,31 @@ export type RoleUpdateSchema = {
3106
3106
  */
3107
3107
  environments_access?: 'all' | 'primary_only' | 'sandbox_only' | 'none';
3108
3108
  /**
3109
- * Can create/edit roles and invite/remove collaborators
3109
+ * Can create and edit roles and invite/remove collaborators
3110
3110
  */
3111
3111
  can_manage_users?: boolean;
3112
3112
  /**
3113
- * Can create/edit shared filters (both for models and the media area)
3113
+ * Can create and edit shared filters (both for models and the media area)
3114
3114
  */
3115
3115
  can_manage_shared_filters?: boolean;
3116
3116
  /**
3117
- * Can create/edit Search Indexes
3117
+ * Can create and edit search indexes
3118
3118
  */
3119
3119
  can_manage_search_indexes?: boolean;
3120
3120
  /**
3121
- * Can create/edit upload collections
3121
+ * Can create and edit upload collections
3122
3122
  */
3123
3123
  can_manage_upload_collections?: boolean;
3124
3124
  /**
3125
- * Can create/edit Build triggers
3125
+ * Can create and edit build triggers
3126
3126
  */
3127
3127
  can_manage_build_triggers?: boolean;
3128
3128
  /**
3129
- * Can create/edit webhooks
3129
+ * Can create and edit webhooks
3130
3130
  */
3131
3131
  can_manage_webhooks?: boolean;
3132
3132
  /**
3133
- * Can create/delete sandbox environments and promote them to primary environment
3133
+ * Can create and delete sandbox environments and promote them to primary environment
3134
3134
  */
3135
3135
  can_manage_environments?: boolean;
3136
3136
  /**
@@ -3142,7 +3142,7 @@ export type RoleUpdateSchema = {
3142
3142
  */
3143
3143
  can_access_audit_log?: boolean;
3144
3144
  /**
3145
- * Can create/edit workflows
3145
+ * Can create and edit workflows
3146
3146
  */
3147
3147
  can_manage_workflows?: boolean;
3148
3148
  /**
@@ -3304,13 +3304,13 @@ export type RoleUpdateSchema = {
3304
3304
  build_trigger?: BuildTriggerIdentity | null;
3305
3305
  }[];
3306
3306
  /**
3307
- * Allowed search indexes for a role
3307
+ * Search indexes that can be triggered by a role
3308
3308
  */
3309
3309
  positive_search_index_permissions?: {
3310
3310
  search_index?: SearchIndexIdentity | null;
3311
3311
  }[];
3312
3312
  /**
3313
- * Prohibited search indexes for a role
3313
+ * Search indexes that can't be triggered by a role
3314
3314
  */
3315
3315
  negative_search_index_permissions?: {
3316
3316
  search_index?: SearchIndexIdentity | null;
@@ -4059,6 +4059,10 @@ export type SitePlan = {
4059
4059
  * The number of available encoding seconds to Mux.com
4060
4060
  */
4061
4061
  mux_encoding_seconds: null | number;
4062
+ /**
4063
+ * The number of images you can analyze for smart tags detections
4064
+ */
4065
+ smart_tags_detections: null | number;
4062
4066
  /**
4063
4067
  * The number of different API tokens you can generate, each which different permissions
4064
4068
  */
@@ -4303,6 +4307,10 @@ export type SitePlanAttributes = {
4303
4307
  * The number of available encoding seconds to Mux.com
4304
4308
  */
4305
4309
  mux_encoding_seconds: null | number;
4310
+ /**
4311
+ * The number of images you can analyze for smart tags detections
4312
+ */
4313
+ smart_tags_detections: null | number;
4306
4314
  /**
4307
4315
  * The number of different API tokens you can generate, each which different permissions
4308
4316
  */
@@ -4943,7 +4951,26 @@ export type UploadCollectionUpdateSchema = {
4943
4951
  children?: UploadCollectionData[];
4944
4952
  };
4945
4953
  /**
4946
- * 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".
4954
+ * 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".
4955
+ *
4956
+ * ## Models
4957
+ *
4958
+ * 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.
4959
+ *
4960
+ * ## Block Models
4961
+ *
4962
+ * 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).
4963
+ *
4964
+ * ### Key differences:
4965
+ *
4966
+ * - **Models** create standalone records that can be referenced and have independent value
4967
+ * - **Block models** create blocks that only exist within parent records and cannot be referenced via link fields
4968
+ * - Block models defined in the library can be reused across different models
4969
+ * - When a record gets deleted, all the blocks it contains are deleted with it
4970
+ * - Blocks do not count towards your plan's records limit
4971
+ *
4972
+ * You can distinguish between models and block models using the `modular_block` attribute: `true` indicates a block model, `false` indicates a regular model.
4973
+ *
4947
4974
  *
4948
4975
  * This interface was referenced by `DatoApi`'s JSON-Schema
4949
4976
  * via the `definition` "item_type".
@@ -4952,11 +4979,11 @@ export type ItemType = {
4952
4979
  id: ItemTypeIdentity;
4953
4980
  type: ItemTypeType;
4954
4981
  /**
4955
- * Name of the model
4982
+ * Name of the model/block model
4956
4983
  */
4957
4984
  name: string;
4958
4985
  /**
4959
- * API key of the model
4986
+ * API key of the model/block model
4960
4987
  */
4961
4988
  api_key: string;
4962
4989
  /**
@@ -4964,11 +4991,11 @@ export type ItemType = {
4964
4991
  */
4965
4992
  collection_appeareance?: 'compact' | 'table';
4966
4993
  /**
4967
- * 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
4968
4995
  */
4969
4996
  collection_appearance: 'compact' | 'table';
4970
4997
  /**
4971
- * 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
4972
4999
  */
4973
5000
  singleton: boolean;
4974
5001
  /**
@@ -4976,31 +5003,31 @@ export type ItemType = {
4976
5003
  */
4977
5004
  all_locales_required: boolean;
4978
5005
  /**
4979
- * 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
4980
5007
  */
4981
5008
  sortable: boolean;
4982
5009
  /**
4983
- * 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
4984
5011
  */
4985
5012
  modular_block: boolean;
4986
5013
  /**
4987
- * Whether draft/published mode is active or not
5014
+ * Whether draft/published mode is active or not. Must be false for block models
4988
5015
  */
4989
5016
  draft_mode_active: boolean;
4990
5017
  /**
4991
- * 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
4992
5019
  */
4993
5020
  draft_saving_active: boolean;
4994
5021
  /**
4995
- * 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
4996
5023
  */
4997
5024
  tree: boolean;
4998
5025
  /**
4999
- * 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
5000
5027
  */
5001
5028
  ordering_direction: null | 'asc' | 'desc';
5002
5029
  /**
5003
- * 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
5004
5031
  */
5005
5032
  ordering_meta:
5006
5033
  | null
@@ -5009,15 +5036,15 @@ export type ItemType = {
5009
5036
  | 'first_published_at'
5010
5037
  | 'published_at';
5011
5038
  /**
5012
- * If this model is single-instance, this tells the single-instance record has already been created or not
5039
+ * 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
5013
5040
  */
5014
5041
  has_singleton_item: boolean;
5015
5042
  /**
5016
- * A hint shown to editors to help them understand the purpose of this model/block
5043
+ * A hint shown to editors to help them understand the purpose of this model/block model
5017
5044
  */
5018
5045
  hint: string | null;
5019
5046
  /**
5020
- * Whether inverse relationships fields are expressed in GraphQL or not
5047
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
5021
5048
  */
5022
5049
  inverse_relationships_enabled: boolean;
5023
5050
  singleton_item: ItemData | null;
@@ -5078,14 +5105,14 @@ export type WorkflowData = {
5078
5105
  id: WorkflowIdentity;
5079
5106
  };
5080
5107
  /**
5081
- * Meta information regarding the item type
5108
+ * Meta information regarding the model/block model
5082
5109
  *
5083
5110
  * This interface was referenced by `ItemType`'s JSON-Schema
5084
5111
  * via the `definition` "meta".
5085
5112
  */
5086
5113
  export type ItemTypeMeta = {
5087
5114
  /**
5088
- * If this model is single-instance, this tells the single-instance record has already been created or not
5115
+ * 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
5089
5116
  */
5090
5117
  has_singleton_item: boolean;
5091
5118
  };
@@ -5097,11 +5124,11 @@ export type ItemTypeMeta = {
5097
5124
  */
5098
5125
  export type ItemTypeAttributes = {
5099
5126
  /**
5100
- * Name of the model
5127
+ * Name of the model/block model
5101
5128
  */
5102
5129
  name: string;
5103
5130
  /**
5104
- * API key of the model
5131
+ * API key of the model/block model
5105
5132
  */
5106
5133
  api_key: string;
5107
5134
  /**
@@ -5109,11 +5136,11 @@ export type ItemTypeAttributes = {
5109
5136
  */
5110
5137
  collection_appeareance?: 'compact' | 'table';
5111
5138
  /**
5112
- * The way the model collection should be presented to the editors
5139
+ * The way the model/block model collection should be presented to the editors
5113
5140
  */
5114
5141
  collection_appearance: 'compact' | 'table';
5115
5142
  /**
5116
- * Whether the model is single-instance or not
5143
+ * Whether the model is single-instance or not. This property only applies to models, not block models
5117
5144
  */
5118
5145
  singleton: boolean;
5119
5146
  /**
@@ -5121,31 +5148,31 @@ export type ItemTypeAttributes = {
5121
5148
  */
5122
5149
  all_locales_required: boolean;
5123
5150
  /**
5124
- * Whether editors can sort records via drag & drop or not
5151
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
5125
5152
  */
5126
5153
  sortable: boolean;
5127
5154
  /**
5128
- * Whether this model is a modular content block or not
5155
+ * Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
5129
5156
  */
5130
5157
  modular_block: boolean;
5131
5158
  /**
5132
- * Whether draft/published mode is active or not
5159
+ * Whether draft/published mode is active or not. Must be false for block models
5133
5160
  */
5134
5161
  draft_mode_active: boolean;
5135
5162
  /**
5136
- * Whether draft records can be saved without satisfying the validations or not
5163
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
5137
5164
  */
5138
5165
  draft_saving_active: boolean;
5139
5166
  /**
5140
- * Whether editors can organize records in a tree or not
5167
+ * Whether editors can organize records in a tree or not. Must be false for block models
5141
5168
  */
5142
5169
  tree: boolean;
5143
5170
  /**
5144
- * If an ordering field is set, this fields specify the sorting direction
5171
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
5145
5172
  */
5146
5173
  ordering_direction: null | 'asc' | 'desc';
5147
5174
  /**
5148
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
5175
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
5149
5176
  */
5150
5177
  ordering_meta:
5151
5178
  | null
@@ -5154,15 +5181,15 @@ export type ItemTypeAttributes = {
5154
5181
  | 'first_published_at'
5155
5182
  | 'published_at';
5156
5183
  /**
5157
- * If this model is single-instance, this tells the single-instance record has already been created or not
5184
+ * 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
5158
5185
  */
5159
5186
  has_singleton_item: boolean;
5160
5187
  /**
5161
- * A hint shown to editors to help them understand the purpose of this model/block
5188
+ * A hint shown to editors to help them understand the purpose of this model/block model
5162
5189
  */
5163
5190
  hint: string | null;
5164
5191
  /**
5165
- * Whether inverse relationships fields are expressed in GraphQL or not
5192
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
5166
5193
  */
5167
5194
  inverse_relationships_enabled: boolean;
5168
5195
  };
@@ -5192,15 +5219,15 @@ export type ItemTypeCreateSchema = {
5192
5219
  id?: ItemTypeIdentity;
5193
5220
  type?: ItemTypeType;
5194
5221
  /**
5195
- * Name of the model
5222
+ * Name of the model/block model
5196
5223
  */
5197
5224
  name: string;
5198
5225
  /**
5199
- * API key of the model
5226
+ * API key of the model/block model
5200
5227
  */
5201
5228
  api_key: string;
5202
5229
  /**
5203
- * Whether the model is single-instance or not
5230
+ * Whether the model is single-instance or not. This property only applies to models, not block models
5204
5231
  */
5205
5232
  singleton?: boolean;
5206
5233
  /**
@@ -5208,31 +5235,31 @@ export type ItemTypeCreateSchema = {
5208
5235
  */
5209
5236
  all_locales_required?: boolean;
5210
5237
  /**
5211
- * Whether editors can sort records via drag & drop or not
5238
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
5212
5239
  */
5213
5240
  sortable?: boolean;
5214
5241
  /**
5215
- * Whether this model is a modular content block or not
5242
+ * Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
5216
5243
  */
5217
5244
  modular_block?: boolean;
5218
5245
  /**
5219
- * Whether draft/published mode is active or not
5246
+ * Whether draft/published mode is active or not. Must be false for block models
5220
5247
  */
5221
5248
  draft_mode_active?: boolean;
5222
5249
  /**
5223
- * Whether draft records can be saved without satisfying the validations or not
5250
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
5224
5251
  */
5225
5252
  draft_saving_active?: boolean;
5226
5253
  /**
5227
- * Whether editors can organize records in a tree or not
5254
+ * Whether editors can organize records in a tree or not. Must be false for block models
5228
5255
  */
5229
5256
  tree?: boolean;
5230
5257
  /**
5231
- * If an ordering field is set, this fields specify the sorting direction
5258
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
5232
5259
  */
5233
5260
  ordering_direction?: null | 'asc' | 'desc';
5234
5261
  /**
5235
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
5262
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
5236
5263
  */
5237
5264
  ordering_meta?:
5238
5265
  | null
@@ -5245,15 +5272,15 @@ export type ItemTypeCreateSchema = {
5245
5272
  */
5246
5273
  collection_appeareance?: 'compact' | 'table';
5247
5274
  /**
5248
- * The way the model collection should be presented to the editors
5275
+ * The way the model/block model collection should be presented to the editors
5249
5276
  */
5250
5277
  collection_appearance?: 'compact' | 'table';
5251
5278
  /**
5252
- * A hint shown to editors to help them understand the purpose of this model/block
5279
+ * A hint shown to editors to help them understand the purpose of this model/block model
5253
5280
  */
5254
5281
  hint?: string | null;
5255
5282
  /**
5256
- * Whether inverse relationships fields are expressed in GraphQL or not
5283
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
5257
5284
  */
5258
5285
  inverse_relationships_enabled?: boolean;
5259
5286
  ordering_field?: FieldData | null;
@@ -5272,11 +5299,11 @@ export type ItemTypeUpdateSchema = {
5272
5299
  id?: ItemTypeIdentity;
5273
5300
  type?: ItemTypeType;
5274
5301
  /**
5275
- * Name of the model
5302
+ * Name of the model/block model
5276
5303
  */
5277
5304
  name?: string;
5278
5305
  /**
5279
- * API key of the model
5306
+ * API key of the model/block model
5280
5307
  */
5281
5308
  api_key?: string;
5282
5309
  /**
@@ -5284,11 +5311,11 @@ export type ItemTypeUpdateSchema = {
5284
5311
  */
5285
5312
  collection_appeareance?: 'compact' | 'table';
5286
5313
  /**
5287
- * The way the model collection should be presented to the editors
5314
+ * The way the model/block model collection should be presented to the editors
5288
5315
  */
5289
5316
  collection_appearance?: 'compact' | 'table';
5290
5317
  /**
5291
- * Whether the model is single-instance or not
5318
+ * Whether the model is single-instance or not. This property only applies to models, not block models
5292
5319
  */
5293
5320
  singleton?: boolean;
5294
5321
  /**
@@ -5296,31 +5323,31 @@ export type ItemTypeUpdateSchema = {
5296
5323
  */
5297
5324
  all_locales_required?: boolean;
5298
5325
  /**
5299
- * Whether editors can sort records via drag & drop or not
5326
+ * Whether editors can sort records via drag & drop or not. Must be false for block models
5300
5327
  */
5301
5328
  sortable?: boolean;
5302
5329
  /**
5303
- * Whether this model is a modular content block or not
5330
+ * Whether this is a block model or not. Block models define structures that can be embedded inside records, while regular models create standalone records
5304
5331
  */
5305
5332
  modular_block?: boolean;
5306
5333
  /**
5307
- * Whether draft/published mode is active or not
5334
+ * Whether draft/published mode is active or not. Must be false for block models
5308
5335
  */
5309
5336
  draft_mode_active?: boolean;
5310
5337
  /**
5311
- * Whether draft records can be saved without satisfying the validations or not
5338
+ * Whether draft records can be saved without satisfying the validations or not. Must be false for block models
5312
5339
  */
5313
5340
  draft_saving_active?: boolean;
5314
5341
  /**
5315
- * Whether editors can organize records in a tree or not
5342
+ * Whether editors can organize records in a tree or not. Must be false for block models
5316
5343
  */
5317
5344
  tree?: boolean;
5318
5345
  /**
5319
- * If an ordering field is set, this fields specify the sorting direction
5346
+ * If an ordering field is set, this field specifies the sorting direction. This property does not apply to block models
5320
5347
  */
5321
5348
  ordering_direction?: null | 'asc' | 'desc';
5322
5349
  /**
5323
- * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field
5350
+ * Specifies the model's sorting method. Cannot be set in concurrency with ordering_field. This property does not apply to block models
5324
5351
  */
5325
5352
  ordering_meta?:
5326
5353
  | null
@@ -5329,15 +5356,15 @@ export type ItemTypeUpdateSchema = {
5329
5356
  | 'first_published_at'
5330
5357
  | 'published_at';
5331
5358
  /**
5332
- * If this model is single-instance, this tells the single-instance record has already been created or not
5359
+ * 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
5333
5360
  */
5334
5361
  has_singleton_item?: boolean;
5335
5362
  /**
5336
- * A hint shown to editors to help them understand the purpose of this model/block
5363
+ * A hint shown to editors to help them understand the purpose of this model/block model
5337
5364
  */
5338
5365
  hint?: string | null;
5339
5366
  /**
5340
- * Whether inverse relationships fields are expressed in GraphQL or not
5367
+ * Whether inverse relationships fields are expressed in GraphQL or not. Must be false for block models
5341
5368
  */
5342
5369
  inverse_relationships_enabled?: boolean;
5343
5370
  ordering_field?: FieldData | null;
@@ -5349,7 +5376,7 @@ export type ItemTypeUpdateSchema = {
5349
5376
  workflow?: WorkflowData | null;
5350
5377
  meta?: {
5351
5378
  /**
5352
- * If this model is single-instance, this tells the single-instance record has already been created or not
5379
+ * 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
5353
5380
  */
5354
5381
  has_singleton_item?: boolean;
5355
5382
  };
@@ -7418,7 +7445,7 @@ export type SubscriptionFeatureAttributes = {
7418
7445
  enabled: boolean;
7419
7446
  };
7420
7447
  /**
7421
- * Represents an event occurred during the deploy process of your administrative area.
7448
+ * Represents an event occurred during the deploy process of a build trigger.
7422
7449
  *
7423
7450
  * This interface was referenced by `DatoApi`'s JSON-Schema
7424
7451
  * via the `definition` "build_event".
@@ -7507,7 +7534,7 @@ export type BuildEventRelationships = {
7507
7534
  build_trigger: BuildTriggerData;
7508
7535
  };
7509
7536
  /**
7510
- * Represents an event occurred during the search indexing process.
7537
+ * Represents an event occurred during the indexing process via search indexes.
7511
7538
  *
7512
7539
  * This interface was referenced by `DatoApi`'s JSON-Schema
7513
7540
  * via the `definition` "search_index_event".
@@ -9734,6 +9761,10 @@ export type BuildTrigger = {
9734
9761
  * Name of the build trigger
9735
9762
  */
9736
9763
  name: string;
9764
+ /**
9765
+ * Whether the build trigger is enabled or not
9766
+ */
9767
+ enabled: boolean;
9737
9768
  /**
9738
9769
  * The type of build trigger
9739
9770
  */
@@ -9765,7 +9796,7 @@ export type BuildTrigger = {
9765
9796
  */
9766
9797
  indexing_status: string;
9767
9798
  /**
9768
- * 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
9799
+ * The public URL of the frontend.
9769
9800
  */
9770
9801
  frontend_url: string | null;
9771
9802
  /**
@@ -9776,10 +9807,6 @@ export type BuildTrigger = {
9776
9807
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9777
9808
  */
9778
9809
  indexing_enabled: boolean;
9779
- /**
9780
- * Whether the build trigger is enabled or not
9781
- */
9782
- enabled: boolean;
9783
9810
  };
9784
9811
  export type BuildTriggerSelfTargetSchema = BuildTrigger;
9785
9812
  export type BuildTriggerCreateTargetSchema = BuildTrigger;
@@ -9796,6 +9823,10 @@ export type BuildTriggerAttributes = {
9796
9823
  * Name of the build trigger
9797
9824
  */
9798
9825
  name: string;
9826
+ /**
9827
+ * Whether the build trigger is enabled or not
9828
+ */
9829
+ enabled: boolean;
9799
9830
  /**
9800
9831
  * The type of build trigger
9801
9832
  */
@@ -9827,7 +9858,7 @@ export type BuildTriggerAttributes = {
9827
9858
  */
9828
9859
  indexing_status: string;
9829
9860
  /**
9830
- * 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
9861
+ * The public URL of the frontend.
9831
9862
  */
9832
9863
  frontend_url: string | null;
9833
9864
  /**
@@ -9838,10 +9869,6 @@ export type BuildTriggerAttributes = {
9838
9869
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9839
9870
  */
9840
9871
  indexing_enabled: boolean;
9841
- /**
9842
- * Whether the build trigger is enabled or not
9843
- */
9844
- enabled: boolean;
9845
9872
  };
9846
9873
  /**
9847
9874
  * This interface was referenced by `BuildTrigger`'s JSON-Schema
@@ -9864,13 +9891,13 @@ export type BuildTriggerCreateSchema = {
9864
9891
  /**
9865
9892
  * Wether Site Search is enabled or not. With Site Search, everytime the website is built, DatoCMS will respider it to get updated content
9866
9893
  */
9867
- indexing_enabled: boolean;
9894
+ indexing_enabled?: boolean;
9868
9895
  /**
9869
9896
  * Whether the build trigger is enabled or not
9870
9897
  */
9871
9898
  enabled?: boolean;
9872
9899
  /**
9873
- * 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
9900
+ * The public URL of the frontend.
9874
9901
  */
9875
9902
  frontend_url: string | null;
9876
9903
  /**
@@ -9908,7 +9935,7 @@ export type BuildTriggerUpdateSchema = {
9908
9935
  */
9909
9936
  enabled?: boolean;
9910
9937
  /**
9911
- * 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
9938
+ * The public URL of the frontend.
9912
9939
  */
9913
9940
  frontend_url?: string | null;
9914
9941
  /**
@@ -9923,7 +9950,7 @@ export type BuildTriggerUpdateSchema = {
9923
9950
  };
9924
9951
  };
9925
9952
  /**
9926
- * 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.
9953
+ * A Search Index is used to index a website to provide DatoCMS Site Search functionality.
9927
9954
  *
9928
9955
  * This interface was referenced by `DatoApi`'s JSON-Schema
9929
9956
  * via the `definition` "search_index".
@@ -9940,11 +9967,7 @@ export type SearchIndex = {
9940
9967
  */
9941
9968
  enabled: boolean;
9942
9969
  /**
9943
- * Whether the spidering should automatically run after associated build triggers complete
9944
- */
9945
- build_trigger_indexing_enabled: boolean;
9946
- /**
9947
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
9970
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9948
9971
  */
9949
9972
  frontend_url: string | null;
9950
9973
  /**
@@ -9966,7 +9989,7 @@ export type SearchIndexDestroyTargetSchema = SearchIndex;
9966
9989
  */
9967
9990
  export type SearchIndexMeta = {
9968
9991
  /**
9969
- * Status of the site search indexing
9992
+ * Status of the search indexing
9970
9993
  */
9971
9994
  indexing_status: 'unstarted' | 'pending' | 'success' | 'failed';
9972
9995
  /**
@@ -9990,11 +10013,7 @@ export type SearchIndexAttributes = {
9990
10013
  */
9991
10014
  enabled: boolean;
9992
10015
  /**
9993
- * Whether the spidering should automatically run after associated build triggers complete
9994
- */
9995
- build_trigger_indexing_enabled: boolean;
9996
- /**
9997
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
10016
+ * The public URL of the website. This is the starting point from which the website's spidering will start
9998
10017
  */
9999
10018
  frontend_url: string | null;
10000
10019
  /**
@@ -10026,11 +10045,7 @@ export type SearchIndexCreateSchema = {
10026
10045
  */
10027
10046
  enabled: boolean;
10028
10047
  /**
10029
- * Whether the spidering should automatically run after associated build triggers complete
10030
- */
10031
- build_trigger_indexing_enabled?: boolean;
10032
- /**
10033
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
10048
+ * The public URL of the website. This is the starting point from which the website's spidering will start
10034
10049
  */
10035
10050
  frontend_url: string | null;
10036
10051
  /**
@@ -10055,11 +10070,7 @@ export type SearchIndexUpdateSchema = {
10055
10070
  */
10056
10071
  enabled?: boolean;
10057
10072
  /**
10058
- * Whether the spidering should automatically run after associated build triggers complete
10059
- */
10060
- build_trigger_indexing_enabled?: boolean;
10061
- /**
10062
- * The public URL of the frontend. This is the starting point from which the website's spidering will start
10073
+ * The public URL of the website. This is the starting point from which the website's spidering will start
10063
10074
  */
10064
10075
  frontend_url?: string | null;
10065
10076
  /**
@@ -11080,6 +11091,10 @@ export type DailyUsage = {
11080
11091
  * Video encoding seconds
11081
11092
  */
11082
11093
  mux_encoded_seconds: number;
11094
+ /**
11095
+ * Number of images analyzed for smart tags
11096
+ */
11097
+ smart_tags_detections: number;
11083
11098
  };
11084
11099
  /**
11085
11100
  * JSON API data
@@ -11134,6 +11149,10 @@ export type DailyUsageAttributes = {
11134
11149
  * Video encoding seconds
11135
11150
  */
11136
11151
  mux_encoded_seconds: number;
11152
+ /**
11153
+ * Number of images analyzed for smart tags
11154
+ */
11155
+ smart_tags_detections: number;
11137
11156
  };
11138
11157
  /**
11139
11158
  * 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.