@datocms/cma-client 0.1.6 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) hide show
  1. package/dist/cjs/generated/resources/Site.js +25 -3
  2. package/dist/cjs/generated/resources/Site.js.map +1 -1
  3. package/dist/cjs/generated/resources/User.js +26 -3
  4. package/dist/cjs/generated/resources/User.js.map +1 -1
  5. package/dist/esm/buildBlockRecord.d.ts +1 -1
  6. package/dist/esm/generated/SchemaTypes.d.ts +1294 -413
  7. package/dist/esm/generated/SimpleSchemaTypes.d.ts +1353 -501
  8. package/dist/esm/generated/resources/Site.d.ts +14 -2
  9. package/dist/esm/generated/resources/Site.js +25 -3
  10. package/dist/esm/generated/resources/Site.js.map +1 -1
  11. package/dist/esm/generated/resources/User.d.ts +14 -2
  12. package/dist/esm/generated/resources/User.js +26 -3
  13. package/dist/esm/generated/resources/User.js.map +1 -1
  14. package/dist/types/buildBlockRecord.d.ts +1 -1
  15. package/dist/types/generated/SchemaTypes.d.ts +1294 -413
  16. package/dist/types/generated/SimpleSchemaTypes.d.ts +1353 -501
  17. package/dist/types/generated/resources/Site.d.ts +14 -2
  18. package/dist/types/generated/resources/User.d.ts +14 -2
  19. package/package.json +6 -5
  20. package/resources.json +1278 -0
  21. package/src/generated/SchemaTypes.ts +1311 -426
  22. package/src/generated/SimpleSchemaTypes.ts +1352 -499
  23. package/src/generated/resources/Site.ts +33 -3
  24. package/src/generated/resources/User.ts +36 -3
  25. package/dist/cjs/generated/schemaInfo.js +0 -3093
  26. package/dist/cjs/generated/schemaInfo.js.map +0 -1
  27. package/dist/esm/generated/schemaInfo.d.ts +0 -940
  28. package/dist/esm/generated/schemaInfo.js +0 -3091
  29. package/dist/esm/generated/schemaInfo.js.map +0 -1
  30. package/dist/types/generated/schemaInfo.d.ts +0 -940
  31. package/src/generated/schemaInfo.ts +0 -3263
@@ -81,17 +81,13 @@ export type UserType = 'user';
81
81
  export type UserIdentity = string;
82
82
  /**
83
83
  * This interface was referenced by `User`'s JSON-Schema
84
- * via the `destroy.hrefSchema` link.
84
+ * via the `self.hrefSchema` link.
85
85
  */
86
- export type UserDestroyHrefSchema = {
87
- /**
88
- * New owner for resources previously owned by the deleted user. This argument specifies the new owner type.
89
- */
90
- destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
86
+ export type UserSelfHrefSchema = {
91
87
  /**
92
- * New owner for resources previously owned by the deleted user. This argument specifies the new owner ID.
88
+ * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `role`.
93
89
  */
94
- destination_user_id?: string;
90
+ include?: string;
95
91
  [k: string]: unknown;
96
92
  };
97
93
  /**
@@ -146,20 +142,35 @@ export type SsoUserDestroyHrefSchema = {
146
142
  /**
147
143
  * JSON API type field
148
144
  *
149
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
145
+ * This interface was referenced by `AccessToken`'s JSON-Schema
150
146
  * via the `definition` "type".
151
147
  */
152
- export type AuditLogEventType = 'audit_log_event';
148
+ export type AccessTokenType = 'access_token';
153
149
  /**
154
- * ULID of event (https://github.com/ulid/spec)
150
+ * ID of access_token
155
151
  *
156
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
152
+ * This interface was referenced by `AccessToken`'s JSON-Schema
157
153
  * via the `definition` "identity".
158
154
  *
159
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
155
+ * This interface was referenced by `AccessToken`'s JSON-Schema
160
156
  * via the `definition` "id".
161
157
  */
162
- export type AuditLogEventIdentity = string;
158
+ export type AccessTokenIdentity = string;
159
+ /**
160
+ * This interface was referenced by `AccessToken`'s JSON-Schema
161
+ * via the `destroy.hrefSchema` link.
162
+ */
163
+ export type AccessTokenDestroyHrefSchema = {
164
+ /**
165
+ * New owner for resources previously owned by the deleted access token. This argument specifies the new owner type.
166
+ */
167
+ destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
168
+ /**
169
+ * New owner for resources previously owned by the deleted access token. This argument specifies the new owner ID.
170
+ */
171
+ destination_user_id?: string;
172
+ [k: string]: unknown;
173
+ };
163
174
  /**
164
175
  * JSON API type field
165
176
  *
@@ -177,6 +188,49 @@ export type AccountType = 'account';
177
188
  * via the `definition` "id".
178
189
  */
179
190
  export type AccountIdentity = string;
191
+ /**
192
+ * This interface was referenced by `User`'s JSON-Schema
193
+ * via the `me.hrefSchema` link.
194
+ */
195
+ export type UserMeHrefSchema = {
196
+ /**
197
+ * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `role`.
198
+ */
199
+ include?: string;
200
+ [k: string]: unknown;
201
+ };
202
+ /**
203
+ * This interface was referenced by `User`'s JSON-Schema
204
+ * via the `destroy.hrefSchema` link.
205
+ */
206
+ export type UserDestroyHrefSchema = {
207
+ /**
208
+ * New owner for resources previously owned by the deleted user. This argument specifies the new owner type.
209
+ */
210
+ destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
211
+ /**
212
+ * New owner for resources previously owned by the deleted user. This argument specifies the new owner ID.
213
+ */
214
+ destination_user_id?: string;
215
+ [k: string]: unknown;
216
+ };
217
+ /**
218
+ * JSON API type field
219
+ *
220
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
221
+ * via the `definition` "type".
222
+ */
223
+ export type AuditLogEventType = 'audit_log_event';
224
+ /**
225
+ * ULID of event (https://github.com/ulid/spec)
226
+ *
227
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
228
+ * via the `definition` "identity".
229
+ *
230
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
231
+ * via the `definition` "id".
232
+ */
233
+ export type AuditLogEventIdentity = string;
180
234
  /**
181
235
  * JSON API type field
182
236
  *
@@ -264,6 +318,23 @@ export type FieldType = 'field';
264
318
  * via the `definition` "id".
265
319
  */
266
320
  export type FieldIdentity = string;
321
+ /**
322
+ * JSON API type fieldset
323
+ *
324
+ * This interface was referenced by `Fieldset`'s JSON-Schema
325
+ * via the `definition` "type".
326
+ */
327
+ export type FieldsetType = 'fieldset';
328
+ /**
329
+ * ID of fieldset
330
+ *
331
+ * This interface was referenced by `Fieldset`'s JSON-Schema
332
+ * via the `definition` "identity".
333
+ *
334
+ * This interface was referenced by `Fieldset`'s JSON-Schema
335
+ * via the `definition` "id".
336
+ */
337
+ export type FieldsetIdentity = string;
267
338
  /**
268
339
  * JSON API type field
269
340
  *
@@ -288,23 +359,6 @@ export type JobType = 'job';
288
359
  * via the `definition` "id".
289
360
  */
290
361
  export type JobIdentity = string;
291
- /**
292
- * JSON API type fieldset
293
- *
294
- * This interface was referenced by `Fieldset`'s JSON-Schema
295
- * via the `definition` "type".
296
- */
297
- export type FieldsetType = 'fieldset';
298
- /**
299
- * ID of fieldset
300
- *
301
- * This interface was referenced by `Fieldset`'s JSON-Schema
302
- * via the `definition` "identity".
303
- *
304
- * This interface was referenced by `Fieldset`'s JSON-Schema
305
- * via the `definition` "id".
306
- */
307
- export type FieldsetIdentity = string;
308
362
  /**
309
363
  * JSON API type field
310
364
  *
@@ -322,38 +376,6 @@ export type SessionType = 'session';
322
376
  * via the `definition` "id".
323
377
  */
324
378
  export type SessionIdentity = string;
325
- /**
326
- * JSON API type field
327
- *
328
- * This interface was referenced by `AccessToken`'s JSON-Schema
329
- * via the `definition` "type".
330
- */
331
- export type AccessTokenType = 'access_token';
332
- /**
333
- * ID of access_token
334
- *
335
- * This interface was referenced by `AccessToken`'s JSON-Schema
336
- * via the `definition` "identity".
337
- *
338
- * This interface was referenced by `AccessToken`'s JSON-Schema
339
- * via the `definition` "id".
340
- */
341
- export type AccessTokenIdentity = string;
342
- /**
343
- * This interface was referenced by `AccessToken`'s JSON-Schema
344
- * via the `destroy.hrefSchema` link.
345
- */
346
- export type AccessTokenDestroyHrefSchema = {
347
- /**
348
- * New owner for resources previously owned by the deleted access token. This argument specifies the new owner type.
349
- */
350
- destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
351
- /**
352
- * New owner for resources previously owned by the deleted access token. This argument specifies the new owner ID.
353
- */
354
- destination_user_id?: string;
355
- [k: string]: unknown;
356
- };
357
379
  /**
358
380
  * JSON API type field
359
381
  *
@@ -1214,6 +1236,17 @@ export type SiteType = 'site';
1214
1236
  * via the `definition` "id".
1215
1237
  */
1216
1238
  export type SiteIdentity = string;
1239
+ /**
1240
+ * This interface was referenced by `Site`'s JSON-Schema
1241
+ * via the `self.hrefSchema` link.
1242
+ */
1243
+ export type SiteSelfHrefSchema = {
1244
+ /**
1245
+ * Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
1246
+ */
1247
+ include?: string;
1248
+ [k: string]: unknown;
1249
+ };
1217
1250
 
1218
1251
  export type DatoApi = {
1219
1252
  role?: Role;
@@ -2414,14 +2447,16 @@ export type UserInstancesTargetSchema = {
2414
2447
  */
2415
2448
  export type UserSelfTargetSchema = {
2416
2449
  data: User;
2450
+ included?: Role[];
2417
2451
  };
2418
2452
 
2419
2453
  /**
2420
2454
  * This interface was referenced by `User`'s JSON-Schema
2421
- * via the `destroy.targetSchema` link.
2455
+ * via the `me.targetSchema` link.
2422
2456
  */
2423
- export type UserDestroyTargetSchema = {
2424
- data: User;
2457
+ export type UserMeTargetSchema = {
2458
+ data: User | SsoUser | AccessToken | Account;
2459
+ included?: Role[];
2425
2460
  };
2426
2461
 
2427
2462
  /**
@@ -2556,177 +2591,195 @@ export type SsoUserDestroyTargetSchema = {
2556
2591
  };
2557
2592
 
2558
2593
  /**
2559
- * If the Audit log functionality is enabled in a project, logged events can be queried using SQL-like language and fetched in full detail so that they can be exported or analyzed.
2594
+ * An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
2560
2595
  *
2561
2596
  * This interface was referenced by `DatoApi`'s JSON-Schema
2562
- * via the `definition` "audit_log_event".
2597
+ * via the `definition` "access_token".
2563
2598
  */
2564
- export type AuditLogEvent = {
2565
- type: AuditLogEventType;
2566
- id: AuditLogEventIdentity;
2567
- attributes: AuditLogEventAttributes;
2568
- meta: AuditLogEventMeta;
2599
+ export type AccessToken = {
2600
+ type: AccessTokenType;
2601
+ id: AccessTokenIdentity;
2602
+ attributes: AccessTokenAttributes;
2603
+ relationships: AccessTokenRelationships;
2569
2604
  };
2570
2605
 
2571
2606
  /**
2572
2607
  * JSON API attributes
2573
2608
  *
2574
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2609
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2575
2610
  * via the `definition` "attributes".
2576
2611
  */
2577
- export type AuditLogEventAttributes = {
2578
- /**
2579
- * The actual action performed
2580
- */
2581
- action_name: string;
2612
+ export type AccessTokenAttributes = {
2582
2613
  /**
2583
- * The actor who performed the action
2614
+ * Name of API token
2584
2615
  */
2585
- actor: {
2586
- /**
2587
- * The type of actor (can be `account`, `user`, `sso_user` or `access_token`)
2588
- */
2589
- type: string;
2590
- /**
2591
- * The ID of the actor
2592
- */
2593
- id: string;
2594
- /**
2595
- * An human representation of the actor (name/email/username depending on the type of actor)
2596
- */
2597
- name: string;
2598
- };
2616
+ name: string;
2599
2617
  /**
2600
- * The role of the actor at the time the action was performed
2618
+ * The actual API token (or null if the current user has no permission to read the token)
2601
2619
  */
2602
- role: null | {
2603
- /**
2604
- * The name of the role
2605
- */
2606
- name: string;
2607
- /**
2608
- * The ID of the role
2609
- */
2610
- id: string;
2611
- };
2620
+ token?: null | string;
2612
2621
  /**
2613
- * The environment inside of which the action was performed
2622
+ * Whether this API token can access the Content Delivery API published content endpoint
2614
2623
  */
2615
- environment: {
2616
- /**
2617
- * The ID of the environment
2618
- */
2619
- id: string;
2620
- /**
2621
- * Whether the environment was the primary one at the time the action was performed
2622
- */
2623
- primary: boolean;
2624
- };
2624
+ can_access_cda: boolean;
2625
2625
  /**
2626
- * The actual request being performed
2626
+ * Whether this API token can access the Content Delivery API draft content endpoint
2627
2627
  */
2628
- request: {
2629
- /**
2630
- * The full path of the request
2631
- */
2632
- path: string;
2633
- /**
2634
- * The HTTP method of the request
2635
- */
2636
- method: string;
2637
- /**
2638
- * The X-Request-ID header of the request
2639
- */
2640
- id?: string;
2641
- /**
2642
- * The full HTTP body of the request
2643
- */
2644
- payload?: null | {
2645
- [k: string]: unknown;
2646
- };
2647
- };
2628
+ can_access_cda_preview: boolean;
2648
2629
  /**
2649
- * The actual response being returned by DatoCMS
2630
+ * Whether this API token can access the Content Management API
2650
2631
  */
2651
- response: null | {
2652
- /**
2653
- * The HTTP status code of the response
2654
- */
2655
- status: number;
2656
- /**
2657
- * The full HTTP body of the response
2658
- */
2659
- payload: {
2660
- [k: string]: unknown;
2661
- };
2662
- };
2632
+ can_access_cma: boolean;
2633
+ hardcoded_type: null | string;
2663
2634
  };
2664
2635
 
2665
2636
  /**
2666
- * JSON API meta
2637
+ * JSON API links
2667
2638
  *
2668
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2669
- * via the `definition` "meta".
2639
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2640
+ * via the `definition` "relationships".
2670
2641
  */
2671
- export type AuditLogEventMeta = {
2642
+ export type AccessTokenRelationships = {
2672
2643
  /**
2673
- * The date of the event
2644
+ * Role
2674
2645
  */
2675
- occurred_at: string;
2646
+ role: {
2647
+ data: RoleData | null;
2648
+ };
2676
2649
  };
2677
2650
 
2678
2651
  /**
2679
2652
  * JSON API data
2680
2653
  *
2681
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2654
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2682
2655
  * via the `definition` "data".
2683
2656
  */
2684
- export type AuditLogEventData = {
2685
- type: AuditLogEventType;
2686
- id: AuditLogEventIdentity;
2657
+ export type AccessTokenData = {
2658
+ type: AccessTokenType;
2659
+ id: AccessTokenIdentity;
2687
2660
  };
2688
2661
 
2689
2662
  /**
2690
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2691
- * via the `query.schema` link.
2663
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2664
+ * via the `create.schema` link.
2692
2665
  */
2693
- export type AuditLogEventQuerySchema = {
2666
+ export type AccessTokenCreateSchema = {
2694
2667
  data: {
2695
- /**
2696
- * JSON API type field
2697
- */
2698
- type: 'audit_log_query';
2668
+ type: AccessTokenType;
2699
2669
  attributes: {
2700
2670
  /**
2701
- * An SQL-like expression to filter the events
2671
+ * Name of API token
2702
2672
  */
2703
- filter?: string;
2673
+ name: string;
2704
2674
  /**
2705
- * Set this value to get remaining results, if a meta.next_token was returned in the previous query response
2675
+ * Whether this API token can access the Content Delivery API published content endpoint
2706
2676
  */
2707
- next_token?: string;
2677
+ can_access_cda: boolean;
2708
2678
  /**
2709
- * Whether a detailed log complete with full request and response payload must be returned or not
2679
+ * Whether this API token can access the Content Delivery API draft content endpoint
2710
2680
  */
2711
- detailed_log?: boolean;
2681
+ can_access_cda_preview: boolean;
2682
+ /**
2683
+ * Whether this API token can access the Content Management API
2684
+ */
2685
+ can_access_cma: boolean;
2686
+ };
2687
+ relationships: {
2688
+ /**
2689
+ * Role
2690
+ */
2691
+ role: {
2692
+ data: RoleData | null;
2693
+ };
2712
2694
  };
2713
2695
  };
2714
2696
  };
2715
2697
 
2716
2698
  /**
2717
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2718
- * via the `query.targetSchema` link.
2699
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2700
+ * via the `create.targetSchema` link.
2719
2701
  */
2720
- export type AuditLogEventQueryTargetSchema = {
2721
- data: AuditLogEvent[];
2722
- meta: {
2723
- /**
2724
- * If the response request exceeds the response payload limit DatoCMS will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results
2725
- */
2726
- next_token: null | string;
2702
+ export type AccessTokenCreateTargetSchema = {
2703
+ data: AccessToken;
2704
+ };
2705
+
2706
+ /**
2707
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2708
+ * via the `update.schema` link.
2709
+ */
2710
+ export type AccessTokenUpdateSchema = {
2711
+ data: {
2712
+ type: AccessTokenType;
2713
+ id: AccessTokenIdentity;
2714
+ attributes: {
2715
+ /**
2716
+ * Name of API token
2717
+ */
2718
+ name: string;
2719
+ /**
2720
+ * Whether this API token can access the Content Delivery API published content endpoint
2721
+ */
2722
+ can_access_cda: boolean;
2723
+ /**
2724
+ * Whether this API token can access the Content Delivery API draft content endpoint
2725
+ */
2726
+ can_access_cda_preview: boolean;
2727
+ /**
2728
+ * Whether this API token can access the Content Management API
2729
+ */
2730
+ can_access_cma: boolean;
2731
+ };
2732
+ relationships: {
2733
+ /**
2734
+ * Role
2735
+ */
2736
+ role: {
2737
+ data: RoleData | null;
2738
+ };
2739
+ };
2727
2740
  };
2728
2741
  };
2729
2742
 
2743
+ /**
2744
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2745
+ * via the `update.targetSchema` link.
2746
+ */
2747
+ export type AccessTokenUpdateTargetSchema = {
2748
+ data: AccessToken;
2749
+ };
2750
+
2751
+ /**
2752
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2753
+ * via the `instances.targetSchema` link.
2754
+ */
2755
+ export type AccessTokenInstancesTargetSchema = {
2756
+ data: AccessToken[];
2757
+ };
2758
+
2759
+ /**
2760
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2761
+ * via the `self.targetSchema` link.
2762
+ */
2763
+ export type AccessTokenSelfTargetSchema = {
2764
+ data: AccessToken;
2765
+ };
2766
+
2767
+ /**
2768
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2769
+ * via the `regenerate_token.targetSchema` link.
2770
+ */
2771
+ export type AccessTokenRegenerateTokenTargetSchema = {
2772
+ data: AccessToken;
2773
+ };
2774
+
2775
+ /**
2776
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2777
+ * via the `destroy.targetSchema` link.
2778
+ */
2779
+ export type AccessTokenDestroyTargetSchema = {
2780
+ data: AccessToken;
2781
+ };
2782
+
2730
2783
  /**
2731
2784
  * DatoCMS account
2732
2785
  *
@@ -2779,6 +2832,186 @@ export type AccountData = {
2779
2832
  id: AccountIdentity;
2780
2833
  };
2781
2834
 
2835
+ /**
2836
+ * This interface was referenced by `User`'s JSON-Schema
2837
+ * via the `destroy.targetSchema` link.
2838
+ */
2839
+ export type UserDestroyTargetSchema = {
2840
+ data: User;
2841
+ };
2842
+
2843
+ /**
2844
+ * If the Audit log functionality is enabled in a project, logged events can be queried using SQL-like language and fetched in full detail so that they can be exported or analyzed.
2845
+ *
2846
+ * This interface was referenced by `DatoApi`'s JSON-Schema
2847
+ * via the `definition` "audit_log_event".
2848
+ */
2849
+ export type AuditLogEvent = {
2850
+ type: AuditLogEventType;
2851
+ id: AuditLogEventIdentity;
2852
+ attributes: AuditLogEventAttributes;
2853
+ meta: AuditLogEventMeta;
2854
+ };
2855
+
2856
+ /**
2857
+ * JSON API attributes
2858
+ *
2859
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2860
+ * via the `definition` "attributes".
2861
+ */
2862
+ export type AuditLogEventAttributes = {
2863
+ /**
2864
+ * The actual action performed
2865
+ */
2866
+ action_name: string;
2867
+ /**
2868
+ * The actor who performed the action
2869
+ */
2870
+ actor: {
2871
+ /**
2872
+ * The type of actor (can be `account`, `user`, `sso_user` or `access_token`)
2873
+ */
2874
+ type: string;
2875
+ /**
2876
+ * The ID of the actor
2877
+ */
2878
+ id: string;
2879
+ /**
2880
+ * An human representation of the actor (name/email/username depending on the type of actor)
2881
+ */
2882
+ name: string;
2883
+ };
2884
+ /**
2885
+ * The role of the actor at the time the action was performed
2886
+ */
2887
+ role: null | {
2888
+ /**
2889
+ * The name of the role
2890
+ */
2891
+ name: string;
2892
+ /**
2893
+ * The ID of the role
2894
+ */
2895
+ id: string;
2896
+ };
2897
+ /**
2898
+ * The environment inside of which the action was performed
2899
+ */
2900
+ environment: {
2901
+ /**
2902
+ * The ID of the environment
2903
+ */
2904
+ id: string;
2905
+ /**
2906
+ * Whether the environment was the primary one at the time the action was performed
2907
+ */
2908
+ primary: boolean;
2909
+ };
2910
+ /**
2911
+ * The actual request being performed
2912
+ */
2913
+ request: {
2914
+ /**
2915
+ * The full path of the request
2916
+ */
2917
+ path: string;
2918
+ /**
2919
+ * The HTTP method of the request
2920
+ */
2921
+ method: string;
2922
+ /**
2923
+ * The X-Request-ID header of the request
2924
+ */
2925
+ id?: string;
2926
+ /**
2927
+ * The full HTTP body of the request
2928
+ */
2929
+ payload?: null | {
2930
+ [k: string]: unknown;
2931
+ };
2932
+ };
2933
+ /**
2934
+ * The actual response being returned by DatoCMS
2935
+ */
2936
+ response: null | {
2937
+ /**
2938
+ * The HTTP status code of the response
2939
+ */
2940
+ status: number;
2941
+ /**
2942
+ * The full HTTP body of the response
2943
+ */
2944
+ payload: {
2945
+ [k: string]: unknown;
2946
+ };
2947
+ };
2948
+ };
2949
+
2950
+ /**
2951
+ * JSON API meta
2952
+ *
2953
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2954
+ * via the `definition` "meta".
2955
+ */
2956
+ export type AuditLogEventMeta = {
2957
+ /**
2958
+ * The date of the event
2959
+ */
2960
+ occurred_at: string;
2961
+ };
2962
+
2963
+ /**
2964
+ * JSON API data
2965
+ *
2966
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2967
+ * via the `definition` "data".
2968
+ */
2969
+ export type AuditLogEventData = {
2970
+ type: AuditLogEventType;
2971
+ id: AuditLogEventIdentity;
2972
+ };
2973
+
2974
+ /**
2975
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2976
+ * via the `query.schema` link.
2977
+ */
2978
+ export type AuditLogEventQuerySchema = {
2979
+ data: {
2980
+ /**
2981
+ * JSON API type field
2982
+ */
2983
+ type: 'audit_log_query';
2984
+ attributes: {
2985
+ /**
2986
+ * An SQL-like expression to filter the events
2987
+ */
2988
+ filter?: string;
2989
+ /**
2990
+ * Set this value to get remaining results, if a meta.next_token was returned in the previous query response
2991
+ */
2992
+ next_token?: string;
2993
+ /**
2994
+ * Whether a detailed log complete with full request and response payload must be returned or not
2995
+ */
2996
+ detailed_log?: boolean;
2997
+ };
2998
+ };
2999
+ };
3000
+
3001
+ /**
3002
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
3003
+ * via the `query.targetSchema` link.
3004
+ */
3005
+ export type AuditLogEventQueryTargetSchema = {
3006
+ data: AuditLogEvent[];
3007
+ meta: {
3008
+ /**
3009
+ * If the response request exceeds the response payload limit DatoCMS will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results
3010
+ */
3011
+ next_token: null | string;
3012
+ };
3013
+ };
3014
+
2782
3015
  /**
2783
3016
  * Stores the information regarding the current plan for the project.
2784
3017
  *
@@ -2942,6 +3175,10 @@ export type SitePlanAttributes = {
2942
3175
  * Whether translator roles are enabled or not
2943
3176
  */
2944
3177
  translator_roles: boolean;
3178
+ /**
3179
+ * Whether or not use a static IP when sending webhooks
3180
+ */
3181
+ static_webhooks_ip: boolean;
2945
3182
  /**
2946
3183
  * Available extra packets
2947
3184
  */
@@ -3329,6 +3566,12 @@ export type ItemTypeRelationships = {
3329
3566
  fields: {
3330
3567
  data: FieldData[];
3331
3568
  };
3569
+ /**
3570
+ * The list of item type fieldsets
3571
+ */
3572
+ fieldsets: {
3573
+ data: FieldsetData[];
3574
+ };
3332
3575
  /**
3333
3576
  * The field to use as display title
3334
3577
  */
@@ -3383,6 +3626,17 @@ export type FieldData = {
3383
3626
  id: FieldIdentity;
3384
3627
  };
3385
3628
 
3629
+ /**
3630
+ * JSON API data
3631
+ *
3632
+ * This interface was referenced by `Fieldset`'s JSON-Schema
3633
+ * via the `definition` "data".
3634
+ */
3635
+ export type FieldsetData = {
3636
+ type: FieldsetType;
3637
+ id: FieldsetIdentity;
3638
+ };
3639
+
3386
3640
  /**
3387
3641
  * JSON API data
3388
3642
  *
@@ -3693,7 +3947,839 @@ export type ItemTypeDestroyJobSchema = {
3693
3947
  };
3694
3948
 
3695
3949
  /**
3696
- * Each Model consists of a set of fields. Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `file`, `float`, etc.) and any required validation.
3950
+ * DatoCMS offers a number of different fields that you can combine togheter to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
3951
+ *
3952
+ * ### Different field types require different settings
3953
+ *
3954
+ * When looking at a field resource, you have to pay attention to two particular properties, `validators` and `appearance`.
3955
+ *
3956
+ * The `validators` property expresses the set of validations to be performed server-side on a specific field value for it to be considered valid, while the `appearance` property lets you specify _how_ the field itself will be presented inside the form to the final editor.
3957
+ *
3958
+ * For both properties, the value to specify depends on the type of field itself. For example, you can add a "Limit character count" validation to a _Single-line string_ field, or set its appearence to "Show it as heading", but they won't be accepted for a ie. _Color_ field, as it supports different validations and appearance settings.
3959
+ *
3960
+ * ### Specifying validations
3961
+ *
3962
+ * The `validators` property requires an object whose keys are the validations that you want to be enforced, and the values are objects representing any settings that the validation itself requires. If the validation doesn't have additional settings, you just pass down an empty object.
3963
+ *
3964
+ * This is a valid example for a _Single-line string_ field:
3965
+ *
3966
+ * ```js
3967
+ * {
3968
+ * "validators": {
3969
+ * // "required" validator has no settings
3970
+ * "required": {},
3971
+ * // "length" validator requires "min" and/or "max" properties
3972
+ * "length": { "min": 80 }
3973
+ * }
3974
+ * }
3975
+ * ```
3976
+ *
3977
+ * Below you'll find a summary of all the validators available for each field type with their settings.
3978
+ *
3979
+ * Some validators are required for a specific type of field. For example, the _Slug_ field needs to have a `slug_title_field` validator to specify the ID of the _Single-line string_ field that will be used to generate the slug itself.
3980
+ *
3981
+ * ### Specifying the appearance
3982
+ *
3983
+ * The `appearance` property requires an object with three specific properties: `editor`, `parameters` and `addons`.
3984
+ *
3985
+ * The `editor` represents the type of editor that the users will see inside the form to change the value of this specific field. Depending on the type of field, DatoCMS offers a number of different editors for you to choose from. The `parameters` property is an object representing any additional settings that the editor itself might require.
3986
+ *
3987
+ * This is a valid example for a _Single-line string_ field:
3988
+ *
3989
+ * ```js
3990
+ * {
3991
+ * "appearance": {
3992
+ * // single_line is a DatoCMS built-in editor that you can use with single-line string fields
3993
+ * "editor": "single_line",
3994
+ * // each built-in editor has specific settings
3995
+ * "parameters": { "heading": true },
3996
+ * "addons": []
3997
+ * },
3998
+ * }
3999
+ * ```
4000
+ *
4001
+ * Following you'll find a summary of all the editors available for each field type with their settings.
4002
+ *
4003
+ * #### Setting the appearance to a field editor provided by a plugin
4004
+ *
4005
+ * If the project contains a plugin that exposes [manual field editors](/docs/plugin-sdk/manual-field-extensions), you can also configure the field to be presented with it instead of using one of the build-in editors.
4006
+ *
4007
+ * In this case:
4008
+ *
4009
+ * - the `editor` property must be the ID of the plugin;
4010
+ * - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes;
4011
+ * - the `parameters` property must provide a configuration object compatible with the [config screen of the manual field extension](/docs/plugin-sdk/manual-field-extensions#add-per-field-config-screens-to-manual-field-extensions), or an empty object if it doesn't require any configuration.
4012
+ *
4013
+ * ```js
4014
+ * {
4015
+ * "appearance": {
4016
+ * // "2132" is a the ID of a plugin exposing a manual field editor
4017
+ * "editor": "2134",
4018
+ * // "starRating" is a manual field editor exposed by the plugin
4019
+ * "field_extension": "starRating",
4020
+ * // this is a valid configuration for the "starRating" field editor
4021
+ * "parameters": { "maxRating": 5, "starsColor": "#ff0000" },
4022
+ * "addons": []
4023
+ * },
4024
+ * }
4025
+ * ```
4026
+ *
4027
+ * #### Configuring manual field addons
4028
+ *
4029
+ * If the project contains plugins that expose [manual field addons](/docs/plugin-sdk/manual-field-extensions), you can also add them to the field via the `addons` property.
4030
+ *
4031
+ * ```js
4032
+ * {
4033
+ * "appearance": {
4034
+ * "editor": "single_line",
4035
+ * "parameters": { "heading": true },
4036
+ * "addons": [
4037
+ * {
4038
+ * // "2138" is a the ID of a plugin exposing a manual addon editor
4039
+ * "id": "2138",
4040
+ * // "loremIpsumGenerator" is a manual field addon exposed by the plugin
4041
+ * "field_extension": "loremIpsumGenerator",
4042
+ * // this is a valid configuration for the "loremIpsumGenerator" field addon
4043
+ * "parameters": { "sentences": 2 },
4044
+ * }
4045
+ * ]
4046
+ * },
4047
+ * }
4048
+ * ```
4049
+ *
4050
+ * ### Available field types
4051
+ *
4052
+ * <details>
4053
+ * <summary>Single-line string (<code>string</code>)</summary>
4054
+ *
4055
+ * | Property | Value |
4056
+ * | ------------------------------ | ---------------------------------------------------- |
4057
+ * | Code | `string` |
4058
+ * | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
4059
+ * | Available validators | `required`, `unique`, `length`, `format`, `enum` |
4060
+ *
4061
+ * </details>
4062
+ *
4063
+ * <details>
4064
+ * <summary>Multi-line text (<code>text</code>)</summary>
4065
+ *
4066
+ * | Property | Value |
4067
+ * | ------------------------------ | --------------------------------- |
4068
+ * | Code | `text` |
4069
+ * | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
4070
+ * | Available validators | `required`, `length`, `format` |
4071
+ *
4072
+ * </details>
4073
+ *
4074
+ * <details>
4075
+ * <summary>Boolean (<code>boolean</code>)</summary>
4076
+ *
4077
+ * | Property | Value |
4078
+ * | ------------------------------ | -------------------------------- |
4079
+ * | Code | `boolean` |
4080
+ * | Built-in editors for the field | `boolean`, `boolean_radio_group` |
4081
+ * | Available validators | no validators available |
4082
+ *
4083
+ * </details>
4084
+ *
4085
+ * <details>
4086
+ * <summary>Integer (<code>integer</code>)</summary>
4087
+ *
4088
+ * | Property | Value |
4089
+ * | ------------------------------ | -------------------------- |
4090
+ * | Code | `integer` |
4091
+ * | Built-in editors for the field | `integer` |
4092
+ * | Available validators | `required`, `number_range` |
4093
+ *
4094
+ * </details>
4095
+ *
4096
+ * <details>
4097
+ * <summary>Float (<code>float</code>)</summary>
4098
+ *
4099
+ * | Property | Value |
4100
+ * | ------------------------------ | -------------------------- |
4101
+ * | Code | `float` |
4102
+ * | Built-in editors for the field | `float` |
4103
+ * | Available validators | `required`, `number_range` |
4104
+ *
4105
+ * </details>
4106
+ *
4107
+ * <details>
4108
+ * <summary>Date (<code>date</code>)</summary>
4109
+ *
4110
+ * | Property | Value |
4111
+ * | ------------------------------ | ------------------------ |
4112
+ * | Code | `date` |
4113
+ * | Built-in editors for the field | `date_picker` |
4114
+ * | Available validators | `required`, `date_range` |
4115
+ *
4116
+ * </details>
4117
+ *
4118
+ * <details>
4119
+ * <summary>Date time (<code>date_time</code>)</summary>
4120
+ *
4121
+ * | Property | Value |
4122
+ * | ------------------------------ | ----------------------------- |
4123
+ * | Code | `date_time` |
4124
+ * | Built-in editors for the field | `date_time_picker` |
4125
+ * | Available validators | `required`, `date_time_range` |
4126
+ *
4127
+ * </details>
4128
+ *
4129
+ * <details>
4130
+ * <summary>Color (<code>color</code>)</summary>
4131
+ *
4132
+ * | Property | Value |
4133
+ * | ------------------------------ | -------------- |
4134
+ * | Code | `color` |
4135
+ * | Built-in editors for the field | `color_picker` |
4136
+ * | Available validators | `required` |
4137
+ *
4138
+ * </details>
4139
+ *
4140
+ * <details>
4141
+ * <summary>JSON (<code>json</code>)</summary>
4142
+ *
4143
+ * | Property | Value |
4144
+ * | ------------------------------ | ------------------------------------------------------ |
4145
+ * | Code | `json` |
4146
+ * | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
4147
+ * | Available validators | `required` |
4148
+ *
4149
+ * </details>
4150
+ *
4151
+ * <details>
4152
+ * <summary>Location (<code>lat_lon</code>)</summary>
4153
+ *
4154
+ * | Property | Value |
4155
+ * | ------------------------------ | ---------- |
4156
+ * | Code | `lat_lon` |
4157
+ * | Built-in editors for the field | `map` |
4158
+ * | Available validators | `required` |
4159
+ *
4160
+ * </details>
4161
+ *
4162
+ * <details>
4163
+ * <summary>SEO (<code>seo</code>)</summary>
4164
+ *
4165
+ * | Property | Value |
4166
+ * | ------------------------------ | -------------------------------------------------------------------------------------------- |
4167
+ * | Code | `seo` |
4168
+ * | Built-in editors for the field | `seo` |
4169
+ * | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
4170
+ *
4171
+ * </details>
4172
+ *
4173
+ * <details>
4174
+ * <summary>Slug (<code>slug</code>)</summary>
4175
+ *
4176
+ * | Property | Value |
4177
+ * | ------------------------------ | ----------------------------------- |
4178
+ * | Code | `slug` |
4179
+ * | Built-in editors for the field | `slug` |
4180
+ * | Required validators | `slug_title_field` |
4181
+ * | Other validators available | `required`, `length`, `slug_format` |
4182
+ *
4183
+ * </details>
4184
+ *
4185
+ * <details>
4186
+ * <summary>External video (<code>video</code>)</summary>
4187
+ *
4188
+ * | Property | Value |
4189
+ * | ------------------------------ | ---------- |
4190
+ * | Code | `video` |
4191
+ * | Built-in editors for the field | `video` |
4192
+ * | Available validators | `required` |
4193
+ *
4194
+ * </details>
4195
+ *
4196
+ * <details>
4197
+ * <summary>Single-asset (<code>file</code>)</summary>
4198
+ *
4199
+ * | Property | Value |
4200
+ * | ------------------------------ | ------------------------------------------------------------------------------ |
4201
+ * | Code | `file` |
4202
+ * | Built-in editors for the field | `file` |
4203
+ * | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
4204
+ *
4205
+ * </details>
4206
+ *
4207
+ * <details>
4208
+ * <summary>Asset gallery (<code>gallery</code>)</summary>
4209
+ *
4210
+ * | Property | Value |
4211
+ * | ------------------------------ | -------------------------------------------------------------------------- |
4212
+ * | Code | `gallery` |
4213
+ * | Built-in editors for the field | `gallery` |
4214
+ * | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
4215
+ *
4216
+ * </details>
4217
+ *
4218
+ * <details>
4219
+ * <summary>Single link (<code>link</code>)</summary>
4220
+ *
4221
+ * | Property | Value |
4222
+ * | ------------------------------ | --------------------------- |
4223
+ * | Code | `link` |
4224
+ * | Built-in editors for the field | `link_select`, `link_embed` |
4225
+ * | Default `editor` | `link_select` |
4226
+ * | Required validators | `item_item_type` |
4227
+ * | Other validators available | `required`, `unique` |
4228
+ *
4229
+ * </details>
4230
+ *
4231
+ * <details>
4232
+ * <summary>Multiple links (<code>links</code>)</summary>
4233
+ *
4234
+ * | Property | Value |
4235
+ * | ------------------------------ | ----------------------------- |
4236
+ * | Code | `links` |
4237
+ * | Built-in editors for the field | `links_select`, `links_embed` |
4238
+ * | Default `editor` | `links_select` |
4239
+ * | Required validators | `items_item_type` |
4240
+ * | Other validators available | `size` |
4241
+ *
4242
+ * </details>
4243
+ *
4244
+ * <details>
4245
+ * <summary>Modular content (<code>rich_text</code>)</summary>
4246
+ *
4247
+ * | Property | Value |
4248
+ * | ------------------------------ | ------------------ |
4249
+ * | Code | `rich_text` |
4250
+ * | Built-in editors for the field | `rich_text` |
4251
+ * | Required validators | `rich_text_blocks` |
4252
+ * | Other validators available | `size` |
4253
+ *
4254
+ * </details>
4255
+ *
4256
+ * <details>
4257
+ * <summary>Structured text (<code>structured_text</code>)</summary>
4258
+ *
4259
+ * | Property | Value |
4260
+ * | ------------------------------ | ------------------------------------------------- |
4261
+ * | Code | `structured_text` |
4262
+ * | Built-in editors for the field | `structured_text` |
4263
+ * | Required validators | `structured_text_blocks`, `structured_text_links` |
4264
+ * | Other validators available | `length` |
4265
+ *
4266
+ * </details>
4267
+ *
4268
+ * ### Validators
4269
+ *
4270
+ * <details>
4271
+ * <summary><code>date_range</code></summary>
4272
+ *
4273
+ * Accept dates only inside a specified date range.
4274
+ *
4275
+ * | Parameter | Type | Required | Description |
4276
+ * | --------- | ------------- | -------- | ------------ |
4277
+ * | `min` | ISO 8601 date | | Minimum date |
4278
+ * | `max` | ISO 8601 date | | Maximum date |
4279
+ *
4280
+ * At least one of the parameters must be specified.
4281
+ *
4282
+ * </details>
4283
+ *
4284
+ * <details>
4285
+ * <summary><code>date_time_range</code></summary>
4286
+ *
4287
+ * Accept date times only inside a specified date range.
4288
+ *
4289
+ * | Parameter | Type | Required | Description |
4290
+ * | --------- | ----------------- | -------- | ---------------- |
4291
+ * | `min` | ISO 8601 datetime | | Minimum datetime |
4292
+ * | `max` | ISO 8601 datetime | | Maximum datetime |
4293
+ *
4294
+ * At least one of the parameters must be specified.
4295
+ *
4296
+ * </details>
4297
+ *
4298
+ * <details>
4299
+ * <summary><code>enum</code></summary>
4300
+ *
4301
+ * Only accept a specific set of values
4302
+ *
4303
+ * | Parameter | Type | Required | Description |
4304
+ * | --------- | --------------- | -------- | --------------------- |
4305
+ * | `values` | `Array<String>` | ✅ | Set of allowed values |
4306
+ *
4307
+ * </details>
4308
+ *
4309
+ * <details>
4310
+ * <summary><code>extension</code></summary>
4311
+ *
4312
+ * Only accept assets with specific file extensions.
4313
+ *
4314
+ * | Parameter | Type | Required | Description |
4315
+ * | ----------------- | ----------------------------------------- | -------- | ------------------------------ |
4316
+ * | `extensions` | `Array<String>` | | Set of allowed file extensions |
4317
+ * | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` | | Allowed file type |
4318
+ *
4319
+ * Only one of the parameters must be specified.
4320
+ *
4321
+ * </details>
4322
+ *
4323
+ * <details>
4324
+ * <summary><code>file_size</code></summary>
4325
+ *
4326
+ * Accept assets only inside a specified date range.
4327
+ *
4328
+ * | Parameter | Type | Required | Description |
4329
+ * | ----------- | ---------------------------- | -------- | ---------------------------------- |
4330
+ * | `min_value` | `Integer` | | Numeric value for minimum filesize |
4331
+ * | `min_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for minimum filesize |
4332
+ * | `max_value` | `Integer` | | Numeric value for maximum filesize |
4333
+ * | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
4334
+ *
4335
+ * At least one couple of value/unit must be specified.
4336
+ *
4337
+ * </details>
4338
+ *
4339
+ * <details>
4340
+ * <summary><code>format</code></summary>
4341
+ *
4342
+ * Only accept strings having a specific format.
4343
+ *
4344
+ * | Parameter | Type | Required | Description |
4345
+ * | -------------------- | ------------------------- | -------- | ---------------------------------- |
4346
+ * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
4347
+ * | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
4348
+ *
4349
+ * Only one of the parameters must be specified.
4350
+ *
4351
+ * </details>
4352
+ *
4353
+ * <details>
4354
+ * <summary><code>slug_format</code></summary>
4355
+ *
4356
+ * Only accept slugs having a specific format.
4357
+ *
4358
+ * | Parameter | Type | Required | Description |
4359
+ * | -------------------- | ---------------- | -------- | ---------------------------------- |
4360
+ * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
4361
+ * | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
4362
+ *
4363
+ * Only one of the parameters must be specified.
4364
+ *
4365
+ * </details>
4366
+ *
4367
+ * <details>
4368
+ * <summary><code>image_dimensions</code></summary>
4369
+ *
4370
+ * Accept assets only within a specified height/width range.
4371
+ *
4372
+ * | Parameter | Type | Required | Description |
4373
+ * | ------------------ | --------- | -------- | -------------------------------- |
4374
+ * | `width_min_value` | `Integer` | | Numeric value for minimum width |
4375
+ * | `width_max_value` | `Integer` | | Numeric value for maximum height |
4376
+ * | `height_min_value` | `Integer` | | Numeric value for minimum width |
4377
+ * | `height_max_value` | `Integer` | | Numeric value for maximum height |
4378
+ *
4379
+ * At least one parameter must be specified.
4380
+ *
4381
+ * </details>
4382
+ *
4383
+ * <details>
4384
+ * <summary><code>item_item_type</code></summary>
4385
+ *
4386
+ * Only accept references to records of the specified models.
4387
+ *
4388
+ * | Parameter | Type | Required | Description |
4389
+ * | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
4390
+ * | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
4391
+ * | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
4392
+ * | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
4393
+ * | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
4394
+ *
4395
+ * Possible values for `on_publish_with_unpublished_references_strategy`:
4396
+ *
4397
+ * - `"fail"`: Fail the operation and notify the user
4398
+ * - `"publish_references"`: Publish also the referenced records
4399
+ *
4400
+ * Possible values for `on_reference_unpublish_strategy`:
4401
+ *
4402
+ * - `"fail"`: Fail the operation and notify the user
4403
+ * - `"unpublish"`: Unpublish also this record
4404
+ * - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
4405
+ *
4406
+ * Possible values for `on_reference_delete_strategy`:
4407
+ *
4408
+ * - `"fail"`: Fail the operation and notify the user
4409
+ * - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
4410
+ * </details>
4411
+ *
4412
+ * <details>
4413
+ * <summary><code>items_item_type</code></summary>
4414
+ *
4415
+ * Only accept references to records of the specified models.
4416
+ *
4417
+ * | Parameter | Type | Required | Description |
4418
+ * | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
4419
+ * | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
4420
+ * | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
4421
+ * | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
4422
+ * | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
4423
+ *
4424
+ * Possible values for `on_publish_with_unpublished_references_strategy`:
4425
+ *
4426
+ * - `"fail"`: Fail the operation and notify the user
4427
+ * - `"publish_references"`: Publish also the referenced records
4428
+ *
4429
+ * Possible values for `on_reference_unpublish_strategy`:
4430
+ *
4431
+ * - `"fail"`: Fail the operation and notify the user
4432
+ * - `"unpublish"`: Unpublish also this record
4433
+ * - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
4434
+ *
4435
+ * Possible values for `on_reference_delete_strategy`:
4436
+ *
4437
+ * - `"fail"`: Fail the operation and notify the user
4438
+ * - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
4439
+ * </details>
4440
+ *
4441
+ * <details>
4442
+ * <summary><code>length</code></summary>
4443
+ *
4444
+ * Accept strings only with a specified number of characters.
4445
+ *
4446
+ * | Parameter | Type | Required | Description |
4447
+ * | --------- | --------- | -------- | --------------- |
4448
+ * | `min` | `Integer` | | Minimum length |
4449
+ * | `eq` | `Integer` | | Expected length |
4450
+ * | `max` | `Integer` | | Maximum length |
4451
+ *
4452
+ * At least one parameter must be specified.
4453
+ *
4454
+ * </details>
4455
+ *
4456
+ * <details>
4457
+ * <summary><code>number_range</code></summary>
4458
+ *
4459
+ * Accept numbers only inside a specified range.
4460
+ *
4461
+ * | Parameter | Type | Required | Description |
4462
+ * | --------- | ------- | -------- | ------------- |
4463
+ * | `min` | `Float` | | Minimum value |
4464
+ * | `max` | `Float` | | Maximum value |
4465
+ *
4466
+ * At least one of the parameters must be specified.
4467
+ *
4468
+ * </details>
4469
+ *
4470
+ * <details>
4471
+ * <summary><code>required</code></summary>
4472
+ *
4473
+ * Value must be specified or it won't be valid.
4474
+ *
4475
+ * </details>
4476
+ *
4477
+ * <details>
4478
+ * <summary><code>required_alt_title</code></summary>
4479
+ *
4480
+ * Assets contained in the field are required to specify custom title or alternate text, or they won't be valid.
4481
+ *
4482
+ * | Parameter | Type | Required | Description |
4483
+ * | --------- | --------- | -------- | ---------------------------------------------------------- |
4484
+ * | `title` | `Boolean` | | Whether the title for the asset must be specified |
4485
+ * | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
4486
+ *
4487
+ * At least one of the parameters must be specified.
4488
+ *
4489
+ * </details>
4490
+ *
4491
+ * <details>
4492
+ * <summary><code>required_seo_fields</code></summary>
4493
+ *
4494
+ * SEO field is to specify one or more properties, or it won't be valid.
4495
+ *
4496
+ * | Parameter | Type | Required | Description |
4497
+ * | -------------- | --------- | -------- | -------------------------------------------------- |
4498
+ * | `title` | `Boolean` | | Whether the meta title must be specified |
4499
+ * | `description` | `Boolean` | | Whether the meta description must be specified |
4500
+ * | `image` | `Boolean` | | Whether the social sharing image must be specified |
4501
+ * | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
4502
+ *
4503
+ * At least one of the parameters must be specified.
4504
+ *
4505
+ * </details>
4506
+ *
4507
+ * <details>
4508
+ * <summary><code>title_length</code></summary>
4509
+ *
4510
+ * Limits the length of the title for a SEO field. Search engines usually truncate title tags to 60 character so it is a good practice to keep the title around this length.
4511
+ *
4512
+ * | Parameter | Type | Required | Description |
4513
+ * | --------- | --------- | -------- | ------------- |
4514
+ * | `min` | `Integer` | | Minimum value |
4515
+ * | `max` | `Integer` | | Maximum value |
4516
+ *
4517
+ * At least one of the parameters must be specified.
4518
+ *
4519
+ * </details>
4520
+ *
4521
+ * <details>
4522
+ * <summary><code>description_length</code></summary>
4523
+ *
4524
+ * Limits the length of the description for a SEO field. Search engines usually truncate description tags to 160 character so it is a good practice to keep the description around this length.
4525
+ *
4526
+ * | Parameter | Type | Required | Description |
4527
+ * | --------- | --------- | -------- | ------------- |
4528
+ * | `min` | `Integer` | | Minimum value |
4529
+ * | `max` | `Integer` | | Maximum value |
4530
+ *
4531
+ * At least one of the parameters must be specified.
4532
+ *
4533
+ * </details>
4534
+ *
4535
+ * <details>
4536
+ * <summary><code>rich_text_blocks</code></summary>
4537
+ *
4538
+ * Only accept references to block records of the specified block models.
4539
+ *
4540
+ * | Parameter | Type | Required | Description |
4541
+ * | ------------ | ----------------------- | -------- | ------------------------------ |
4542
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
4543
+ *
4544
+ * </details>
4545
+ *
4546
+ * <details>
4547
+ * <summary><code>structured_text_blocks</code></summary>
4548
+ *
4549
+ * Only accept references to block records of the specified block models.
4550
+ *
4551
+ * | Parameter | Type | Required | Description |
4552
+ * | ------------ | ----------------------- | -------- | ------------------------------ |
4553
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
4554
+ *
4555
+ * </details>
4556
+ *
4557
+ * <details>
4558
+ * <summary><code>structured_text_links</code></summary>
4559
+ *
4560
+ * Only accept `itemLink` to `inlineItem` nodes for records of the specified models.
4561
+ *
4562
+ * | Parameter | Type | Required | Description |
4563
+ * | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
4564
+ * | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
4565
+ * | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
4566
+ * | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
4567
+ * | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
4568
+ *
4569
+ * Possible values for `on_publish_with_unpublished_references_strategy`:
4570
+ *
4571
+ * - `"fail"`: Fail the operation and notify the user
4572
+ * - `"publish_references"`: Publish also the referenced records
4573
+ *
4574
+ * Possible values for `on_reference_unpublish_strategy`:
4575
+ *
4576
+ * - `"fail"`: Fail the operation and notify the user
4577
+ * - `"unpublish"`: Unpublish also this record
4578
+ * - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
4579
+ *
4580
+ * Possible values for `on_reference_delete_strategy`:
4581
+ *
4582
+ * - `"fail"`: Fail the operation and notify the user
4583
+ * - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
4584
+ * </details>
4585
+ *
4586
+ * <details>
4587
+ * <summary><code>size</code></summary>
4588
+ *
4589
+ * Only accept a number of items within the specified range.
4590
+ *
4591
+ * | Parameter | Type | Required | Description |
4592
+ * | ------------- | --------- | -------- | -------------------------------------------------- |
4593
+ * | `min` | `Integer` | | Minimum length |
4594
+ * | `eq` | `Integer` | | Expected length |
4595
+ * | `max` | `Integer` | | Maximum length |
4596
+ * | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
4597
+ *
4598
+ * At least one parameter must be specified.
4599
+ *
4600
+ * </details>
4601
+ *
4602
+ * <details>
4603
+ * <summary><code>slug_title_field</code></summary>
4604
+ *
4605
+ * Specifies the ID of the _Single-line string_ field that will be used to generate the slug
4606
+ *
4607
+ * | Parameter | Type | Required | Description |
4608
+ * | ---------------- | ---------- | -------- | ------------------------------------------------ |
4609
+ * | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
4610
+ *
4611
+ * </details>
4612
+ *
4613
+ * <details>
4614
+ * <summary><code>unique</code></summary>
4615
+ *
4616
+ * The value must be unique across the whole collection of records.
4617
+ *
4618
+ * </details>
4619
+ *
4620
+ * ### Configuration parameters for DatoCMS built-in field editors
4621
+ *
4622
+ * If a field editor is not specified in this table, just pass an empty object `{}` as its configuration parameters.
4623
+ *
4624
+ * <details>
4625
+ * <summary><code>boolean_radio_group</code></summary>
4626
+ *
4627
+ * Radio group input for _boolean_ fields.
4628
+ *
4629
+ * | Parameter | Type | Required | Description |
4630
+ * | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
4631
+ * | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
4632
+ * | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
4633
+ *
4634
+ * </details>
4635
+ *
4636
+ * <details>
4637
+ * <summary><code>string_radio_group</code></summary>
4638
+ *
4639
+ * Radio group input for _string_ fields.
4640
+ *
4641
+ * | Parameter | Type | Required | Description |
4642
+ * | --------- | -------------------------------------------------------- | -------- | --------------------------- |
4643
+ * | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
4644
+ *
4645
+ * </details>
4646
+ *
4647
+ * <details>
4648
+ * <summary><code>string_select</code></summary>
4649
+ *
4650
+ * Select input for _string_ fields.
4651
+ *
4652
+ * | Parameter | Type | Required | Description |
4653
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
4654
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
4655
+ *
4656
+ * </details>
4657
+ *
4658
+ * <details>
4659
+ * <summary><code>string_multi_select</code></summary>
4660
+ *
4661
+ * Select input for _JSON_ fields, to edit an array of strings.
4662
+ *
4663
+ * | Parameter | Type | Required | Description |
4664
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
4665
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
4666
+ *
4667
+ * </details>
4668
+ *
4669
+ * <details>
4670
+ * <summary><code>string_checkbox_group</code></summary>
4671
+ *
4672
+ * Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
4673
+ *
4674
+ * | Parameter | Type | Required | Description |
4675
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
4676
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
4677
+ *
4678
+ * </details>
4679
+ *
4680
+ * <details>
4681
+ * <summary><code>single_line</code></summary>
4682
+ *
4683
+ * Simple textual input for _Single-line string_ fields.
4684
+ *
4685
+ * | Parameter | Type | Required | Description |
4686
+ * | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
4687
+ * | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
4688
+ *
4689
+ * </details>
4690
+ *
4691
+ * <details>
4692
+ * <summary><code>markdown</code></summary>
4693
+ *
4694
+ * Markdown editor for _Multiple-paragraph text_ fields.
4695
+ *
4696
+ * | Parameter | Type | Required | Description |
4697
+ * | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4698
+ * | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"heading"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"unordered_list"`, `"ordered_list"`, `"quote"`, `"link"`, `"image"`, `"fullscreen"` |
4699
+ *
4700
+ * </details>
4701
+ *
4702
+ * <details>
4703
+ * <summary><code>wysiwyg</code></summary>
4704
+ *
4705
+ * HTML editor for _Multiple-paragraph text_ fields.
4706
+ *
4707
+ * | Parameter | Type | Required | Description |
4708
+ * | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4709
+ * | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"format"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"ordered_list"`, `"unordered_list"`, `"quote"`, `"table"`, `"link"`, `"image"`, `"show_source"`, `"undo"`, `"redo"`, `"align_left"`, `"align_center"`, `"align_right"`, `"align_justify"`, `"outdent"`, `"indent"`, `"fullscreen"` |
4710
+ *
4711
+ * </details>
4712
+ *
4713
+ * <details>
4714
+ * <summary><code>textarea</code></summary>
4715
+ *
4716
+ * Basic textarea editor for _Multiple-paragraph text_ fields.
4717
+ *
4718
+ * </details>
4719
+ *
4720
+ * <details>
4721
+ * <summary><code>color_picker</code></summary>
4722
+ *
4723
+ * Built-in editor for _Color_ fields.
4724
+ *
4725
+ * | Parameter | Type | Required | Description |
4726
+ * | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
4727
+ * | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
4728
+ * | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
4729
+ *
4730
+ * </details>
4731
+ *
4732
+ * <details>
4733
+ * <summary><code>slug</code></summary>
4734
+ *
4735
+ * Built-in editor for _Slug_ fields.
4736
+ *
4737
+ * | Parameter | Type | Required | Description |
4738
+ * | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
4739
+ * | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. |
4740
+ *
4741
+ * </details>
4742
+ *
4743
+ * <details>
4744
+ * <summary><code>rich_text</code></summary>
4745
+ *
4746
+ * Built-in editor for _Modular content_ fields.
4747
+ *
4748
+ * | Parameter | Type | Required | Description |
4749
+ * | ----------------- | --------- | -------- | ---------------------------------------------------------- |
4750
+ * | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not |
4751
+ *
4752
+ * </details>
4753
+ *
4754
+ * <details>
4755
+ * <summary><code>structured_text</code></summary>
4756
+ *
4757
+ * Built-in editor for _Structured text_ fields.
4758
+ *
4759
+ * | Parameter | Type | Required | Description |
4760
+ * | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
4761
+ * | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
4762
+ * | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
4763
+ * | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
4764
+ * | `show_links_target_blank` | `Boolean` | | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links |
4765
+ * | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
4766
+ *
4767
+ * </details>
4768
+ *
4769
+ * <details>
4770
+ * <summary><code>link_select</code> and <code>links_select</code></summary>
4771
+ *
4772
+ * Use a select input with auto-completion to pick the records to reference inside the field.
4773
+ *
4774
+ * </details>
4775
+ *
4776
+ * <details>
4777
+ * <summary><code>link_embed</code> and <code>links_embed</code></summary>
4778
+ *
4779
+ * Use an expanded view with records' image preview to pick the records to reference inside the field.
4780
+ *
4781
+ * </details>
4782
+ *
3697
4783
  *
3698
4784
  * This interface was referenced by `DatoApi`'s JSON-Schema
3699
4785
  * via the `definition` "field".
@@ -3823,17 +4909,6 @@ export type FieldRelationships = {
3823
4909
  };
3824
4910
  };
3825
4911
 
3826
- /**
3827
- * JSON API data
3828
- *
3829
- * This interface was referenced by `Fieldset`'s JSON-Schema
3830
- * via the `definition` "data".
3831
- */
3832
- export type FieldsetData = {
3833
- type: FieldsetType;
3834
- id: FieldsetIdentity;
3835
- };
3836
-
3837
4912
  /**
3838
4913
  * This interface was referenced by `Field`'s JSON-Schema
3839
4914
  * via the `create.schema` link.
@@ -4402,196 +5477,6 @@ export type SessionCreateTargetSchema = {
4402
5477
  included: User[];
4403
5478
  };
4404
5479
 
4405
- /**
4406
- * An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
4407
- *
4408
- * This interface was referenced by `DatoApi`'s JSON-Schema
4409
- * via the `definition` "access_token".
4410
- */
4411
- export type AccessToken = {
4412
- type: AccessTokenType;
4413
- id: AccessTokenIdentity;
4414
- attributes: AccessTokenAttributes;
4415
- relationships: AccessTokenRelationships;
4416
- };
4417
-
4418
- /**
4419
- * JSON API attributes
4420
- *
4421
- * This interface was referenced by `AccessToken`'s JSON-Schema
4422
- * via the `definition` "attributes".
4423
- */
4424
- export type AccessTokenAttributes = {
4425
- /**
4426
- * Name of API token
4427
- */
4428
- name: string;
4429
- /**
4430
- * The actual API token
4431
- */
4432
- token?: string;
4433
- /**
4434
- * Whether this API token can access the Content Delivery API published content endpoint
4435
- */
4436
- can_access_cda: boolean;
4437
- /**
4438
- * Whether this API token can access the Content Delivery API draft content endpoint
4439
- */
4440
- can_access_cda_preview: boolean;
4441
- /**
4442
- * Whether this API token can access the Content Management API
4443
- */
4444
- can_access_cma: boolean;
4445
- hardcoded_type: null | string;
4446
- };
4447
-
4448
- /**
4449
- * JSON API links
4450
- *
4451
- * This interface was referenced by `AccessToken`'s JSON-Schema
4452
- * via the `definition` "relationships".
4453
- */
4454
- export type AccessTokenRelationships = {
4455
- /**
4456
- * Role
4457
- */
4458
- role: {
4459
- data: RoleData | null;
4460
- };
4461
- };
4462
-
4463
- /**
4464
- * JSON API data
4465
- *
4466
- * This interface was referenced by `AccessToken`'s JSON-Schema
4467
- * via the `definition` "data".
4468
- */
4469
- export type AccessTokenData = {
4470
- type: AccessTokenType;
4471
- id: AccessTokenIdentity;
4472
- };
4473
-
4474
- /**
4475
- * This interface was referenced by `AccessToken`'s JSON-Schema
4476
- * via the `create.schema` link.
4477
- */
4478
- export type AccessTokenCreateSchema = {
4479
- data: {
4480
- type: AccessTokenType;
4481
- attributes: {
4482
- /**
4483
- * Name of API token
4484
- */
4485
- name: string;
4486
- /**
4487
- * Whether this API token can access the Content Delivery API published content endpoint
4488
- */
4489
- can_access_cda: boolean;
4490
- /**
4491
- * Whether this API token can access the Content Delivery API draft content endpoint
4492
- */
4493
- can_access_cda_preview: boolean;
4494
- /**
4495
- * Whether this API token can access the Content Management API
4496
- */
4497
- can_access_cma: boolean;
4498
- };
4499
- relationships: {
4500
- /**
4501
- * Role
4502
- */
4503
- role: {
4504
- data: RoleData | null;
4505
- };
4506
- };
4507
- };
4508
- };
4509
-
4510
- /**
4511
- * This interface was referenced by `AccessToken`'s JSON-Schema
4512
- * via the `create.targetSchema` link.
4513
- */
4514
- export type AccessTokenCreateTargetSchema = {
4515
- data: AccessToken;
4516
- };
4517
-
4518
- /**
4519
- * This interface was referenced by `AccessToken`'s JSON-Schema
4520
- * via the `update.schema` link.
4521
- */
4522
- export type AccessTokenUpdateSchema = {
4523
- data: {
4524
- type: AccessTokenType;
4525
- id: AccessTokenIdentity;
4526
- attributes: {
4527
- /**
4528
- * Name of API token
4529
- */
4530
- name: string;
4531
- /**
4532
- * Whether this API token can access the Content Delivery API published content endpoint
4533
- */
4534
- can_access_cda: boolean;
4535
- /**
4536
- * Whether this API token can access the Content Delivery API draft content endpoint
4537
- */
4538
- can_access_cda_preview: boolean;
4539
- /**
4540
- * Whether this API token can access the Content Management API
4541
- */
4542
- can_access_cma: boolean;
4543
- };
4544
- relationships: {
4545
- /**
4546
- * Role
4547
- */
4548
- role: {
4549
- data: RoleData | null;
4550
- };
4551
- };
4552
- };
4553
- };
4554
-
4555
- /**
4556
- * This interface was referenced by `AccessToken`'s JSON-Schema
4557
- * via the `update.targetSchema` link.
4558
- */
4559
- export type AccessTokenUpdateTargetSchema = {
4560
- data: AccessToken;
4561
- };
4562
-
4563
- /**
4564
- * This interface was referenced by `AccessToken`'s JSON-Schema
4565
- * via the `instances.targetSchema` link.
4566
- */
4567
- export type AccessTokenInstancesTargetSchema = {
4568
- data: AccessToken[];
4569
- };
4570
-
4571
- /**
4572
- * This interface was referenced by `AccessToken`'s JSON-Schema
4573
- * via the `self.targetSchema` link.
4574
- */
4575
- export type AccessTokenSelfTargetSchema = {
4576
- data: AccessToken;
4577
- };
4578
-
4579
- /**
4580
- * This interface was referenced by `AccessToken`'s JSON-Schema
4581
- * via the `regenerate_token.targetSchema` link.
4582
- */
4583
- export type AccessTokenRegenerateTokenTargetSchema = {
4584
- data: AccessToken;
4585
- };
4586
-
4587
- /**
4588
- * This interface was referenced by `AccessToken`'s JSON-Schema
4589
- * via the `destroy.targetSchema` link.
4590
- */
4591
- export type AccessTokenDestroyTargetSchema = {
4592
- data: AccessToken;
4593
- };
4594
-
4595
5480
  /**
4596
5481
  * Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.
4597
5482
  *
@@ -6761,6 +7646,10 @@ export type EnvironmentMeta = {
6761
7646
  * Is this environment the primary for the project?
6762
7647
  */
6763
7648
  primary: boolean;
7649
+ /**
7650
+ * ID of the environment that's been forked to generate this one
7651
+ */
7652
+ forked_from?: string | null;
6764
7653
  };
6765
7654
 
6766
7655
  /**
@@ -8675,6 +9564,7 @@ export type Site = {
8675
9564
  id: SiteIdentity;
8676
9565
  attributes: SiteAttributes;
8677
9566
  relationships: SiteRelationships;
9567
+ meta: SiteMeta;
8678
9568
  };
8679
9569
 
8680
9570
  /**
@@ -8724,10 +9614,6 @@ export type SiteAttributes = {
8724
9614
  * Specifies the last time when a change of data occurred
8725
9615
  */
8726
9616
  last_data_change_at: null | string;
8727
- /**
8728
- * Frontend website url
8729
- */
8730
- frontend_url: string | null;
8731
9617
  /**
8732
9618
  * Specifies whether all users of this site need to authenticate using two-factor authentication
8733
9619
  */
@@ -8821,48 +9707,25 @@ export type SiteRelationships = {
8821
9707
  account: {
8822
9708
  data: AccountData;
8823
9709
  };
8824
- build_triggers?: {
8825
- /**
8826
- * The list of build trigger
8827
- */
8828
- data: BuildTriggerData[];
8829
- };
8830
- menu_items: {
8831
- /**
8832
- * The list of site menu items
8833
- */
8834
- data: MenuItemData[];
8835
- };
8836
- sso_users: {
8837
- /**
8838
- * The list of site SSO users
8839
- */
8840
- data: SsoUserData[];
8841
- };
8842
- users: {
8843
- /**
8844
- * The list of site users
8845
- */
8846
- data: UserData[];
8847
- };
8848
9710
  item_types: {
8849
9711
  /**
8850
- * The list of site item types
9712
+ * The list item types for the site
8851
9713
  */
8852
9714
  data: ItemTypeData[];
8853
9715
  };
8854
- sso_default_role?: {
8855
- /**
8856
- * Specifies the default role for newly created identity providers users
8857
- */
8858
- data: RoleData[];
8859
- };
8860
- roles: {
8861
- /**
8862
- * The list of site roles
8863
- */
8864
- data: RoleData[];
8865
- };
9716
+ };
9717
+
9718
+ /**
9719
+ * Meta attributes
9720
+ *
9721
+ * This interface was referenced by `Site`'s JSON-Schema
9722
+ * via the `definition` "meta".
9723
+ */
9724
+ export type SiteMeta = {
9725
+ /**
9726
+ * Whether the Improved API Timezone Management option is active or not
9727
+ */
9728
+ improved_timezone_management: boolean;
8866
9729
  };
8867
9730
 
8868
9731
  /**
@@ -8882,7 +9745,7 @@ export type SiteData = {
8882
9745
  */
8883
9746
  export type SiteSelfTargetSchema = {
8884
9747
  data: Site;
8885
- included?: (MenuItem | User | ItemType | Role | Field | Upload | SsoUser)[];
9748
+ included?: (ItemType | Field | Upload | Fieldset | Item | Account)[];
8886
9749
  };
8887
9750
 
8888
9751
  /**
@@ -8996,6 +9859,12 @@ export type SiteUpdateSchema = {
8996
9859
  */
8997
9860
  ip_tracking_enabled?: boolean;
8998
9861
  };
9862
+ meta?: {
9863
+ /**
9864
+ * Whether the Improved API Timezone Management option is active or not
9865
+ */
9866
+ improved_timezone_management?: boolean;
9867
+ };
8999
9868
  relationships?: {
9000
9869
  sso_default_role?: {
9001
9870
  data: RoleData;
@@ -9020,6 +9889,22 @@ export type SiteUpdateJobSchema = {
9020
9889
  data: Site;
9021
9890
  };
9022
9891
 
9892
+ /**
9893
+ * This interface was referenced by `Site`'s JSON-Schema
9894
+ * via the `activate_improved_timezone_management.targetSchema` link.
9895
+ */
9896
+ export type SiteActivateImprovedTimezoneManagementTargetSchema = {
9897
+ data: Job;
9898
+ };
9899
+
9900
+ /**
9901
+ * This interface was referenced by `Site`'s JSON-Schema
9902
+ * via the `activate_improved_timezone_management.jobSchema` link.
9903
+ */
9904
+ export type SiteActivateImprovedTimezoneManagementJobSchema = {
9905
+ data: Site;
9906
+ };
9907
+
9023
9908
  /**
9024
9909
  * Through workflows it is possible to set up a precise state machine able to bring a draft content up to the final publication (and beyond), through a series of intermediate, fully customizable approval steps.
9025
9910
  *