datocms-plugin-sdk 0.6.7 → 0.6.10

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.
@@ -1,19 +1,25 @@
1
1
  /* eslint-disable camelcase */
2
2
  /* tslint:disable */
3
- /** This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT BY HAND. */
3
+ /**
4
+ * This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT
5
+ * BY HAND.
6
+ */
4
7
 
5
8
  /**
6
9
  * JSON API type field
7
10
  *
8
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "type".
11
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
12
+ * "type".
9
13
  */
10
14
  export type RoleType = 'role';
11
15
  /**
12
16
  * ID of role
13
17
  *
14
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "identity".
18
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
19
+ * "identity".
15
20
  *
16
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "id".
21
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
22
+ * "id".
17
23
  */
18
24
  export type RoleIdentity = string;
19
25
  /**
@@ -22,7 +28,8 @@ export type RoleIdentity = string;
22
28
  * This interface was referenced by `ItemType`'s JSON-Schema via the
23
29
  * `definition` "identity".
24
30
  *
25
- * This interface was referenced by `ItemType`'s JSON-Schema via the `definition` "id".
31
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
32
+ * `definition` "id".
26
33
  */
27
34
  export type ItemTypeIdentity = string;
28
35
  /**
@@ -31,7 +38,8 @@ export type ItemTypeIdentity = string;
31
38
  * This interface was referenced by `Workflow`'s JSON-Schema via the
32
39
  * `definition` "identity".
33
40
  *
34
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "id".
41
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
42
+ * `definition` "id".
35
43
  */
36
44
  export type WorkflowIdentity = string;
37
45
  /**
@@ -40,7 +48,8 @@ export type WorkflowIdentity = string;
40
48
  * This interface was referenced by `Environment`'s JSON-Schema via the
41
49
  * `definition` "identity".
42
50
  *
43
- * This interface was referenced by `Environment`'s JSON-Schema via the `definition` "id".
51
+ * This interface was referenced by `Environment`'s JSON-Schema via the
52
+ * `definition` "id".
44
53
  */
45
54
  export type EnvironmentIdentity = string;
46
55
  /**
@@ -56,23 +65,30 @@ export type BuildTriggerIdentity = string;
56
65
  /**
57
66
  * JSON API type field
58
67
  *
59
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "type".
68
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
69
+ * "type".
60
70
  */
61
71
  export type UserType = 'user';
62
72
  /**
63
73
  * ID of collaborator
64
74
  *
65
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "identity".
75
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
76
+ * "identity".
66
77
  *
67
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "id".
78
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
79
+ * "id".
68
80
  */
69
81
  export type UserIdentity = string;
70
- /** This interface was referenced by `User`'s JSON-Schema via the `self.hrefSchema` link. */
82
+ /**
83
+ * This interface was referenced by `User`'s JSON-Schema via the
84
+ * `self.hrefSchema` link.
85
+ */
71
86
  export type UserSelfHrefSchema = {
72
87
  /**
73
88
  * Comma-separated list of [relationship
74
89
  * paths](https://jsonapi.org/format/#fetching-includes). A relationship path
75
- * is a dot-separated list of relationship names. Allowed relationship paths: `role`.
90
+ * is a dot-separated list of relationship names. Allowed relationship paths:
91
+ * `role`.
76
92
  */
77
93
  include?: string;
78
94
  [k: string]: unknown;
@@ -80,7 +96,8 @@ export type UserSelfHrefSchema = {
80
96
  /**
81
97
  * JSON API type field
82
98
  *
83
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "type".
99
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
100
+ * "type".
84
101
  */
85
102
  export type SsoUserType = 'sso_user';
86
103
  /**
@@ -89,13 +106,15 @@ export type SsoUserType = 'sso_user';
89
106
  * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
90
107
  * "identity".
91
108
  *
92
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "id".
109
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
110
+ * "id".
93
111
  */
94
112
  export type SsoUserIdentity = string;
95
113
  /**
96
114
  * JSON API type field
97
115
  *
98
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "type".
116
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
117
+ * `definition` "type".
99
118
  */
100
119
  export type SsoGroupType = 'sso_group';
101
120
  /**
@@ -104,7 +123,8 @@ export type SsoGroupType = 'sso_group';
104
123
  * This interface was referenced by `SsoGroup`'s JSON-Schema via the
105
124
  * `definition` "identity".
106
125
  *
107
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "id".
126
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
127
+ * `definition` "id".
108
128
  */
109
129
  export type SsoGroupIdentity = string;
110
130
  /**
@@ -137,7 +157,8 @@ export type AccessTokenType = 'access_token';
137
157
  * This interface was referenced by `AccessToken`'s JSON-Schema via the
138
158
  * `definition` "identity".
139
159
  *
140
- * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "id".
160
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
161
+ * `definition` "id".
141
162
  */
142
163
  export type AccessTokenIdentity = string;
143
164
  /**
@@ -160,7 +181,8 @@ export type AccessTokenDestroyHrefSchema = {
160
181
  /**
161
182
  * JSON API type field
162
183
  *
163
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "type".
184
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
185
+ * "type".
164
186
  */
165
187
  export type AccountType = 'account';
166
188
  /**
@@ -169,15 +191,20 @@ export type AccountType = 'account';
169
191
  * This interface was referenced by `Account`'s JSON-Schema via the `definition`
170
192
  * "identity".
171
193
  *
172
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "id".
194
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
195
+ * "id".
173
196
  */
174
197
  export type AccountIdentity = string;
175
- /** This interface was referenced by `User`'s JSON-Schema via the `me.hrefSchema` link. */
198
+ /**
199
+ * This interface was referenced by `User`'s JSON-Schema via the `me.hrefSchema`
200
+ * link.
201
+ */
176
202
  export type UserMeHrefSchema = {
177
203
  /**
178
204
  * Comma-separated list of [relationship
179
205
  * paths](https://jsonapi.org/format/#fetching-includes). A relationship path
180
- * is a dot-separated list of relationship names. Allowed relationship paths: `role`.
206
+ * is a dot-separated list of relationship names. Allowed relationship paths:
207
+ * `role`.
181
208
  */
182
209
  include?: string;
183
210
  [k: string]: unknown;
@@ -219,7 +246,8 @@ export type AuditLogEventIdentity = string;
219
246
  /**
220
247
  * JSON API type field
221
248
  *
222
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "type".
249
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
250
+ * `definition` "type".
223
251
  */
224
252
  export type SitePlanType = 'site_plan';
225
253
  /**
@@ -228,13 +256,15 @@ export type SitePlanType = 'site_plan';
228
256
  * This interface was referenced by `SitePlan`'s JSON-Schema via the
229
257
  * `definition` "identity".
230
258
  *
231
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "id".
259
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
260
+ * `definition` "id".
232
261
  */
233
262
  export type SitePlanIdentity = string;
234
263
  /**
235
264
  * JSON API type field
236
265
  *
237
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "type".
266
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
267
+ * `definition` "type".
238
268
  */
239
269
  export type MenuItemType = 'menu_item';
240
270
  /**
@@ -243,13 +273,15 @@ export type MenuItemType = 'menu_item';
243
273
  * This interface was referenced by `MenuItem`'s JSON-Schema via the
244
274
  * `definition` "identity".
245
275
  *
246
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "id".
276
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
277
+ * `definition` "id".
247
278
  */
248
279
  export type MenuItemIdentity = string;
249
280
  /**
250
281
  * JSON API type field
251
282
  *
252
- * This interface was referenced by `ItemType`'s JSON-Schema via the `definition` "type".
283
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
284
+ * `definition` "type".
253
285
  */
254
286
  export type ItemTypeType = 'item_type';
255
287
  /**
@@ -265,35 +297,42 @@ export type MenuItemInstancesHrefSchema = {
265
297
  /**
266
298
  * JSON API type field
267
299
  *
268
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "type".
300
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
301
+ * "type".
269
302
  */
270
303
  export type ItemType1 = 'item';
271
304
  /**
272
305
  * ID of record
273
306
  *
274
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "identity".
307
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
308
+ * "identity".
275
309
  *
276
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "id".
310
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
311
+ * "id".
277
312
  */
278
313
  export type ItemIdentity = string;
279
314
  /**
280
315
  * JSON API type field
281
316
  *
282
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "type".
317
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
318
+ * "type".
283
319
  */
284
320
  export type FieldType = 'field';
285
321
  /**
286
322
  * ID of field
287
323
  *
288
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "identity".
324
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
325
+ * "identity".
289
326
  *
290
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "id".
327
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
328
+ * "id".
291
329
  */
292
330
  export type FieldIdentity = string;
293
331
  /**
294
332
  * JSON API type fieldset
295
333
  *
296
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "type".
334
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
335
+ * `definition` "type".
297
336
  */
298
337
  export type FieldsetType = 'fieldset';
299
338
  /**
@@ -302,33 +341,39 @@ export type FieldsetType = 'fieldset';
302
341
  * This interface was referenced by `Fieldset`'s JSON-Schema via the
303
342
  * `definition` "identity".
304
343
  *
305
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "id".
344
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
345
+ * `definition` "id".
306
346
  */
307
347
  export type FieldsetIdentity = string;
308
348
  /**
309
349
  * JSON API type field
310
350
  *
311
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "type".
351
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
352
+ * `definition` "type".
312
353
  */
313
354
  export type WorkflowType = 'workflow';
314
355
  /**
315
356
  * JSON API type field
316
357
  *
317
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "type".
358
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
359
+ * "type".
318
360
  */
319
361
  export type JobType = 'job';
320
362
  /**
321
363
  * ID of job
322
364
  *
323
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "identity".
365
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
366
+ * "identity".
324
367
  *
325
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "id".
368
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
369
+ * "id".
326
370
  */
327
371
  export type JobIdentity = string;
328
372
  /**
329
373
  * JSON API type field
330
374
  *
331
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "type".
375
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
376
+ * "type".
332
377
  */
333
378
  export type SessionType = 'session';
334
379
  /**
@@ -337,13 +382,15 @@ export type SessionType = 'session';
337
382
  * This interface was referenced by `Session`'s JSON-Schema via the `definition`
338
383
  * "identity".
339
384
  *
340
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "id".
385
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
386
+ * "id".
341
387
  */
342
388
  export type SessionIdentity = string;
343
389
  /**
344
390
  * JSON API type field
345
391
  *
346
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "type".
392
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
393
+ * "type".
347
394
  */
348
395
  export type PluginType = 'plugin';
349
396
  /**
@@ -352,13 +399,15 @@ export type PluginType = 'plugin';
352
399
  * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
353
400
  * "identity".
354
401
  *
355
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "id".
402
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
403
+ * "id".
356
404
  */
357
405
  export type PluginIdentity = string;
358
406
  /**
359
407
  * JSON API type field
360
408
  *
361
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "type".
409
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
410
+ * `definition` "type".
362
411
  */
363
412
  export type JobResultType = 'job_result';
364
413
  /**
@@ -367,7 +416,8 @@ export type JobResultType = 'job_result';
367
416
  * This interface was referenced by `JobResult`'s JSON-Schema via the
368
417
  * `definition` "identity".
369
418
  *
370
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "id".
419
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
420
+ * `definition` "id".
371
421
  */
372
422
  export type JobResultIdentity = string;
373
423
  /**
@@ -417,7 +467,8 @@ export type BuildEventType = 'build_event';
417
467
  * This interface was referenced by `BuildEvent`'s JSON-Schema via the
418
468
  * `definition` "identity".
419
469
  *
420
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "id".
470
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
471
+ * `definition` "id".
421
472
  */
422
473
  export type BuildEventIdentity = string;
423
474
  /**
@@ -441,17 +492,17 @@ export type ItemInstancesHrefSchema = {
441
492
  filter?: {
442
493
  /**
443
494
  * Record (or block record) IDs to fetch, comma separated. If you use this
444
- * filter, you *must not* use `filter[type]` or `filter[fields]`
495
+ * filter, you _must not_ use `filter[type]` or `filter[fields]`
445
496
  */
446
497
  ids?: string;
447
498
  /**
448
- * Model ID or `api_key` to filter. If you use this filter, you *must not*
449
- * use `filter[ids]`. Comma separated values are accepted, but you *must
450
- * not* use `filter[fields]` in this case
499
+ * Model ID or `api_key` to filter. If you use this filter, you _must not_
500
+ * use `filter[ids]`. Comma separated values are accepted, but you _must
501
+ * not_ use `filter[fields]` in this case
451
502
  */
452
503
  type?: string;
453
504
  /**
454
- * Textual query to match. You *must not* use `filter[ids]`. If `locale` is
505
+ * Textual query to match. You _must not_ use `filter[ids]`. If `locale` is
455
506
  * defined, search within that locale. Otherwise environment's main locale
456
507
  * will be used.
457
508
  */
@@ -481,9 +532,10 @@ export type ItemInstancesHrefSchema = {
481
532
  [k: string]: unknown;
482
533
  };
483
534
  /**
484
- * Fields used to order results. You *must* specify also `filter[type]` with
535
+ * Fields used to order results. You _must_ specify also `filter[type]` with
485
536
  * one element only to be able use this option. Format:
486
- * `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
537
+ * `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated
538
+ * rules
487
539
  */
488
540
  order_by?: string;
489
541
  /**
@@ -510,7 +562,10 @@ export type ItemReferencesHrefSchema = {
510
562
  version?: null | ('current' | 'published' | 'published-or-current');
511
563
  [k: string]: unknown;
512
564
  };
513
- /** This interface was referenced by `Item`'s JSON-Schema via the `self.hrefSchema` link. */
565
+ /**
566
+ * This interface was referenced by `Item`'s JSON-Schema via the
567
+ * `self.hrefSchema` link.
568
+ */
514
569
  export type ItemSelfHrefSchema = {
515
570
  /**
516
571
  * For Modular Content fields and Structured Text fields. If set, returns full
@@ -562,7 +617,10 @@ export type ItemPublishHrefSchema = {
562
617
  * `unpublish.hrefSchema` link.
563
618
  */
564
619
  export type ItemUnpublishHrefSchema = {
565
- /** If the record is referenced by other published records, unpublish them recursively */
620
+ /**
621
+ * If the record is referenced by other published records, unpublish them
622
+ * recursively
623
+ */
566
624
  recursive?: string;
567
625
  [k: string]: unknown;
568
626
  };
@@ -579,7 +637,8 @@ export type ItemVersionType = 'item_version';
579
637
  * This interface was referenced by `ItemVersion`'s JSON-Schema via the
580
638
  * `definition` "identity".
581
639
  *
582
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "id".
640
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
641
+ * `definition` "id".
583
642
  */
584
643
  export type ItemVersionIdentity = string;
585
644
  /**
@@ -605,7 +664,8 @@ export type ItemVersionInstancesHrefSchema = {
605
664
  /**
606
665
  * JSON API type upload
607
666
  *
608
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "type".
667
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
668
+ * "type".
609
669
  */
610
670
  export type UploadType = 'upload';
611
671
  /**
@@ -614,7 +674,8 @@ export type UploadType = 'upload';
614
674
  * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
615
675
  * "identity".
616
676
  *
617
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "id".
677
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
678
+ * "id".
618
679
  */
619
680
  export type UploadIdentity = string;
620
681
  /**
@@ -818,7 +879,8 @@ export type MaintenanceModeActivateHrefSchema = {
818
879
  /**
819
880
  * JSON API type field
820
881
  *
821
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "type".
882
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
883
+ * "type".
822
884
  */
823
885
  export type WebhookType = 'webhook';
824
886
  /**
@@ -827,7 +889,8 @@ export type WebhookType = 'webhook';
827
889
  * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
828
890
  * "identity".
829
891
  *
830
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "id".
892
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
893
+ * "id".
831
894
  */
832
895
  export type WebhookIdentity = string;
833
896
  /**
@@ -843,7 +906,8 @@ export type WebhookCallType = 'webhook_call';
843
906
  * This interface was referenced by `WebhookCall`'s JSON-Schema via the
844
907
  * `definition` "identity".
845
908
  *
846
- * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "id".
909
+ * This interface was referenced by `WebhookCall`'s JSON-Schema via the
910
+ * `definition` "id".
847
911
  */
848
912
  export type WebhookCallIdentity = string;
849
913
  /**
@@ -942,7 +1006,8 @@ export type SsoSettingsType = 'sso_settings';
942
1006
  * This interface was referenced by `SsoSettings`'s JSON-Schema via the
943
1007
  * `definition` "identity".
944
1008
  *
945
- * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "id".
1009
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
1010
+ * `definition` "id".
946
1011
  */
947
1012
  export type SsoSettingsIdentity = string;
948
1013
  /**
@@ -975,7 +1040,8 @@ export type PublicInfoType = 'public_info';
975
1040
  * This interface was referenced by `PublicInfo`'s JSON-Schema via the
976
1041
  * `definition` "identity".
977
1042
  *
978
- * This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "id".
1043
+ * This interface was referenced by `PublicInfo`'s JSON-Schema via the
1044
+ * `definition` "id".
979
1045
  */
980
1046
  export type PublicInfoIdentity = string;
981
1047
  /**
@@ -991,7 +1057,8 @@ export type DailyUsageType = 'daily_usage';
991
1057
  * This interface was referenced by `DailyUsage`'s JSON-Schema via the
992
1058
  * `definition` "identity".
993
1059
  *
994
- * This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "id".
1060
+ * This interface was referenced by `DailyUsage`'s JSON-Schema via the
1061
+ * `definition` "id".
995
1062
  */
996
1063
  export type DailyUsageIdentity = string;
997
1064
  /**
@@ -1041,7 +1108,8 @@ export type UsageCounterSelfHrefSchema = {
1041
1108
  /**
1042
1109
  * JSON API type field
1043
1110
  *
1044
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "type".
1111
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
1112
+ * `definition` "type".
1045
1113
  */
1046
1114
  export type UploadTagType = 'upload_tag';
1047
1115
  /**
@@ -1050,7 +1118,8 @@ export type UploadTagType = 'upload_tag';
1050
1118
  * This interface was referenced by `UploadTag`'s JSON-Schema via the
1051
1119
  * `definition` "identity".
1052
1120
  *
1053
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "id".
1121
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
1122
+ * `definition` "id".
1054
1123
  */
1055
1124
  export type UploadTagIdentity = string;
1056
1125
  /**
@@ -1115,18 +1184,24 @@ export type UploadSmartTagInstancesHrefSchema = {
1115
1184
  /**
1116
1185
  * JSON API type field
1117
1186
  *
1118
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "type".
1187
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
1188
+ * "type".
1119
1189
  */
1120
1190
  export type SiteType = 'site';
1121
1191
  /**
1122
1192
  * ID of site
1123
1193
  *
1124
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "identity".
1194
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
1195
+ * "identity".
1125
1196
  *
1126
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "id".
1197
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
1198
+ * "id".
1127
1199
  */
1128
1200
  export type SiteIdentity = string;
1129
- /** This interface was referenced by `Site`'s JSON-Schema via the `self.hrefSchema` link. */
1201
+ /**
1202
+ * This interface was referenced by `Site`'s JSON-Schema via the
1203
+ * `self.hrefSchema` link.
1204
+ */
1130
1205
  export type SiteSelfHrefSchema = {
1131
1206
  /**
1132
1207
  * Comma-separated list of [relationship
@@ -1191,7 +1266,8 @@ export interface DatoApi {
1191
1266
  * A Role represents a specific set of actions an editor (or an API token) can
1192
1267
  * perform on your administrative area.
1193
1268
  *
1194
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "role".
1269
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
1270
+ * "role".
1195
1271
  */
1196
1272
  export interface Role {
1197
1273
  type: RoleType;
@@ -1232,7 +1308,10 @@ export interface RoleAttributes {
1232
1308
  can_manage_build_triggers: boolean;
1233
1309
  /** Can create/edit webhooks */
1234
1310
  can_manage_webhooks: boolean;
1235
- /** Can create/delete sandbox environments and promote them to primary environment */
1311
+ /**
1312
+ * Can create/delete sandbox environments and promote them to primary
1313
+ * environment
1314
+ */
1236
1315
  can_manage_environments: boolean;
1237
1316
  /** Can manage Single Sign-On settings */
1238
1317
  can_manage_sso: boolean;
@@ -1374,7 +1453,8 @@ export interface RoleRelationships {
1374
1453
  /**
1375
1454
  * JSON API data
1376
1455
  *
1377
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "data".
1456
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
1457
+ * "data".
1378
1458
  */
1379
1459
  export interface RoleData {
1380
1460
  type: RoleType;
@@ -1384,7 +1464,8 @@ export interface RoleData {
1384
1464
  /**
1385
1465
  * Meta information regarding the record
1386
1466
  *
1387
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "meta".
1467
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
1468
+ * "meta".
1388
1469
  */
1389
1470
  export interface RoleMeta {
1390
1471
  /** The final set of permissions considering also inherited roles */
@@ -1411,7 +1492,10 @@ export interface RoleMeta {
1411
1492
  can_manage_build_triggers: boolean;
1412
1493
  /** Can create/edit webhooks */
1413
1494
  can_manage_webhooks: boolean;
1414
- /** Can create/delete sandbox environments and promote them to primary environment */
1495
+ /**
1496
+ * Can create/delete sandbox environments and promote them to primary
1497
+ * environment
1498
+ */
1415
1499
  can_manage_environments: boolean;
1416
1500
  /** Can manage Single Sign-On settings */
1417
1501
  can_manage_sso: boolean;
@@ -1538,7 +1622,10 @@ export interface RoleMeta {
1538
1622
  };
1539
1623
  }
1540
1624
 
1541
- /** This interface was referenced by `Role`'s JSON-Schema via the `create.schema` link. */
1625
+ /**
1626
+ * This interface was referenced by `Role`'s JSON-Schema via the `create.schema`
1627
+ * link.
1628
+ */
1542
1629
  export interface RoleCreateSchema {
1543
1630
  data: {
1544
1631
  type: RoleType;
@@ -1568,7 +1655,10 @@ export interface RoleCreateSchema {
1568
1655
  can_manage_build_triggers?: boolean;
1569
1656
  /** Can create/edit webhooks */
1570
1657
  can_manage_webhooks?: boolean;
1571
- /** Can create/delete sandbox environments and promote them to primary environment */
1658
+ /**
1659
+ * Can create/delete sandbox environments and promote them to primary
1660
+ * environment
1661
+ */
1572
1662
  can_manage_environments?: boolean;
1573
1663
  /** Can manage Single Sign-On settings */
1574
1664
  can_manage_sso?: boolean;
@@ -1712,7 +1802,10 @@ export interface RoleCreateTargetSchema {
1712
1802
  data: Role;
1713
1803
  }
1714
1804
 
1715
- /** This interface was referenced by `Role`'s JSON-Schema via the `update.schema` link. */
1805
+ /**
1806
+ * This interface was referenced by `Role`'s JSON-Schema via the `update.schema`
1807
+ * link.
1808
+ */
1716
1809
  export interface RoleUpdateSchema {
1717
1810
  data: {
1718
1811
  type: RoleType;
@@ -1743,7 +1836,10 @@ export interface RoleUpdateSchema {
1743
1836
  can_manage_build_triggers?: boolean;
1744
1837
  /** Can create/edit webhooks */
1745
1838
  can_manage_webhooks?: boolean;
1746
- /** Can create/delete sandbox environments and promote them to primary environment */
1839
+ /**
1840
+ * Can create/delete sandbox environments and promote them to primary
1841
+ * environment
1842
+ */
1747
1843
  can_manage_environments?: boolean;
1748
1844
  /** Can manage Single Sign-On settings */
1749
1845
  can_manage_sso?: boolean;
@@ -1895,7 +1991,10 @@ export interface RoleInstancesTargetSchema {
1895
1991
  data: Role[];
1896
1992
  }
1897
1993
 
1898
- /** This interface was referenced by `Role`'s JSON-Schema via the `self.targetSchema` link. */
1994
+ /**
1995
+ * This interface was referenced by `Role`'s JSON-Schema via the
1996
+ * `self.targetSchema` link.
1997
+ */
1899
1998
  export interface RoleSelfTargetSchema {
1900
1999
  data: Role;
1901
2000
  }
@@ -1913,7 +2012,8 @@ export interface RoleDestroyTargetSchema {
1913
2012
  * collaborator is linked to a specific Role, which describes what actions it
1914
2013
  * will be able to perform once logged in.
1915
2014
  *
1916
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "user".
2015
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
2016
+ * "user".
1917
2017
  */
1918
2018
  export interface User {
1919
2019
  type: UserType;
@@ -1956,7 +2056,8 @@ export interface UserRelationships {
1956
2056
  /**
1957
2057
  * Meta information on the user
1958
2058
  *
1959
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "meta".
2059
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
2060
+ * "meta".
1960
2061
  */
1961
2062
  export interface UserMeta {
1962
2063
  /** Date of last reading/interaction */
@@ -1966,14 +2067,18 @@ export interface UserMeta {
1966
2067
  /**
1967
2068
  * JSON API data
1968
2069
  *
1969
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "data".
2070
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
2071
+ * "data".
1970
2072
  */
1971
2073
  export interface UserData {
1972
2074
  type: UserType;
1973
2075
  id: UserIdentity;
1974
2076
  }
1975
2077
 
1976
- /** This interface was referenced by `User`'s JSON-Schema via the `update.schema` link. */
2078
+ /**
2079
+ * This interface was referenced by `User`'s JSON-Schema via the `update.schema`
2080
+ * link.
2081
+ */
1977
2082
  export interface UserUpdateSchema {
1978
2083
  data: {
1979
2084
  type: UserType;
@@ -2007,13 +2112,19 @@ export interface UserInstancesTargetSchema {
2007
2112
  data: User[];
2008
2113
  }
2009
2114
 
2010
- /** This interface was referenced by `User`'s JSON-Schema via the `self.targetSchema` link. */
2115
+ /**
2116
+ * This interface was referenced by `User`'s JSON-Schema via the
2117
+ * `self.targetSchema` link.
2118
+ */
2011
2119
  export interface UserSelfTargetSchema {
2012
2120
  data: User;
2013
2121
  included?: Role[];
2014
2122
  }
2015
2123
 
2016
- /** This interface was referenced by `User`'s JSON-Schema via the `me.targetSchema` link. */
2124
+ /**
2125
+ * This interface was referenced by `User`'s JSON-Schema via the
2126
+ * `me.targetSchema` link.
2127
+ */
2017
2128
  export interface UserMeTargetSchema {
2018
2129
  data: User | SsoUser | AccessToken | Account;
2019
2130
  included?: Role[];
@@ -2078,7 +2189,8 @@ export interface SsoUserRelationships {
2078
2189
  /**
2079
2190
  * JSON API data
2080
2191
  *
2081
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "data".
2192
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
2193
+ * `definition` "data".
2082
2194
  */
2083
2195
  export interface SsoGroupData {
2084
2196
  type: SsoGroupType;
@@ -2088,7 +2200,8 @@ export interface SsoGroupData {
2088
2200
  /**
2089
2201
  * Meta information on the user
2090
2202
  *
2091
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "meta".
2203
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
2204
+ * "meta".
2092
2205
  */
2093
2206
  export interface SsoUserMeta {
2094
2207
  /** Date of last reading/interaction */
@@ -2098,7 +2211,8 @@ export interface SsoUserMeta {
2098
2211
  /**
2099
2212
  * JSON API data
2100
2213
  *
2101
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "data".
2214
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
2215
+ * "data".
2102
2216
  */
2103
2217
  export interface SsoUserData {
2104
2218
  type: SsoUserType;
@@ -2165,9 +2279,15 @@ export interface AccessTokenAttributes {
2165
2279
  * the token)
2166
2280
  */
2167
2281
  token?: null | string;
2168
- /** Whether this API token can access the Content Delivery API published content endpoint */
2282
+ /**
2283
+ * Whether this API token can access the Content Delivery API published
2284
+ * content endpoint
2285
+ */
2169
2286
  can_access_cda: boolean;
2170
- /** Whether this API token can access the Content Delivery API draft content endpoint */
2287
+ /**
2288
+ * Whether this API token can access the Content Delivery API draft content
2289
+ * endpoint
2290
+ */
2171
2291
  can_access_cda_preview: boolean;
2172
2292
  /** Whether this API token can access the Content Management API */
2173
2293
  can_access_cma: boolean;
@@ -2213,7 +2333,10 @@ export interface AccessTokenCreateSchema {
2213
2333
  * content endpoint
2214
2334
  */
2215
2335
  can_access_cda: boolean;
2216
- /** Whether this API token can access the Content Delivery API draft content endpoint */
2336
+ /**
2337
+ * Whether this API token can access the Content Delivery API draft
2338
+ * content endpoint
2339
+ */
2217
2340
  can_access_cda_preview: boolean;
2218
2341
  /** Whether this API token can access the Content Management API */
2219
2342
  can_access_cma: boolean;
@@ -2251,7 +2374,10 @@ export interface AccessTokenUpdateSchema {
2251
2374
  * content endpoint
2252
2375
  */
2253
2376
  can_access_cda: boolean;
2254
- /** Whether this API token can access the Content Delivery API draft content endpoint */
2377
+ /**
2378
+ * Whether this API token can access the Content Delivery API draft
2379
+ * content endpoint
2380
+ */
2255
2381
  can_access_cda_preview: boolean;
2256
2382
  /** Whether this API token can access the Content Management API */
2257
2383
  can_access_cma: boolean;
@@ -2339,7 +2465,8 @@ export interface AccountAttributes {
2339
2465
  /**
2340
2466
  * JSON API data
2341
2467
  *
2342
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "data".
2468
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
2469
+ * "data".
2343
2470
  */
2344
2471
  export interface AccountData {
2345
2472
  type: AccountType;
@@ -2380,7 +2507,10 @@ export interface AuditLogEventAttributes {
2380
2507
  action_name: string;
2381
2508
  /** The actor who performed the action */
2382
2509
  actor: {
2383
- /** The type of actor (can be `account`, `user`, `sso_user` or `access_token`) */
2510
+ /**
2511
+ * The type of actor (can be `account`, `user`, `sso_user` or
2512
+ * `access_token`)
2513
+ */
2384
2514
  type: string;
2385
2515
  /** The ID of the actor */
2386
2516
  id: string;
@@ -2401,7 +2531,10 @@ export interface AuditLogEventAttributes {
2401
2531
  environment: {
2402
2532
  /** The ID of the environment */
2403
2533
  id: string;
2404
- /** Whether the environment was the primary one at the time the action was performed */
2534
+ /**
2535
+ * Whether the environment was the primary one at the time the action was
2536
+ * performed
2537
+ */
2405
2538
  primary: boolean;
2406
2539
  };
2407
2540
  /** The actual request being performed */
@@ -2539,13 +2672,19 @@ export interface SitePlanAttributes {
2539
2672
  * Delivery API and content consumers
2540
2673
  */
2541
2674
  traffic_bytes: null | number;
2542
- /** The number of requests made to both our Content Management and Content Delivery APIs */
2675
+ /**
2676
+ * The number of requests made to both our Content Management and Content
2677
+ * Delivery APIs
2678
+ */
2543
2679
  api_calls: null | number;
2544
2680
  /** The number of streaming seconds delivered by Mux.com */
2545
2681
  mux_streaming_seconds: null | number;
2546
2682
  /** The number of available encoding seconds to Mux.com */
2547
2683
  mux_encoding_seconds: null | number;
2548
- /** The number of different API tokens you can generate, each which different permissions */
2684
+ /**
2685
+ * The number of different API tokens you can generate, each which different
2686
+ * permissions
2687
+ */
2549
2688
  access_tokens: null | number;
2550
2689
  /** Number of roles allowed */
2551
2690
  roles: null | number;
@@ -2650,7 +2789,8 @@ export interface SitePlanAttributes {
2650
2789
  /**
2651
2790
  * JSON API data
2652
2791
  *
2653
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "data".
2792
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
2793
+ * `definition` "data".
2654
2794
  */
2655
2795
  export interface SitePlanData {
2656
2796
  type: SitePlanType;
@@ -2713,7 +2853,8 @@ export interface MenuItemRelationships {
2713
2853
  /**
2714
2854
  * JSON API data
2715
2855
  *
2716
- * This interface was referenced by `ItemType`'s JSON-Schema via the `definition` "data".
2856
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
2857
+ * `definition` "data".
2717
2858
  */
2718
2859
  export interface ItemTypeData {
2719
2860
  type: ItemTypeType;
@@ -2723,14 +2864,18 @@ export interface ItemTypeData {
2723
2864
  /**
2724
2865
  * JSON API data
2725
2866
  *
2726
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "data".
2867
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2868
+ * `definition` "data".
2727
2869
  */
2728
2870
  export interface MenuItemData {
2729
2871
  type: MenuItemType;
2730
2872
  id: MenuItemIdentity;
2731
2873
  }
2732
2874
 
2733
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `create.schema` link. */
2875
+ /**
2876
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2877
+ * `create.schema` link.
2878
+ */
2734
2879
  export interface MenuItemCreateSchema {
2735
2880
  data: {
2736
2881
  type: MenuItemType;
@@ -2766,7 +2911,10 @@ export interface MenuItemCreateTargetSchema {
2766
2911
  data: MenuItem;
2767
2912
  }
2768
2913
 
2769
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `update.schema` link. */
2914
+ /**
2915
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2916
+ * `update.schema` link.
2917
+ */
2770
2918
  export interface MenuItemUpdateSchema {
2771
2919
  data: {
2772
2920
  type: MenuItemType;
@@ -2890,7 +3038,10 @@ export interface ItemTypeAttributes {
2890
3038
  * already been created or not
2891
3039
  */
2892
3040
  has_singleton_item: boolean;
2893
- /** A hint shown to editors to help them understand the purpose of this model/block */
3041
+ /**
3042
+ * A hint shown to editors to help them understand the purpose of this
3043
+ * model/block
3044
+ */
2894
3045
  hint: string | null;
2895
3046
  }
2896
3047
 
@@ -2938,7 +3089,8 @@ export interface ItemTypeRelationships {
2938
3089
  /**
2939
3090
  * JSON API data
2940
3091
  *
2941
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "data".
3092
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
3093
+ * "data".
2942
3094
  */
2943
3095
  export interface ItemData {
2944
3096
  type: ItemType1;
@@ -2948,7 +3100,8 @@ export interface ItemData {
2948
3100
  /**
2949
3101
  * JSON API data
2950
3102
  *
2951
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "data".
3103
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
3104
+ * "data".
2952
3105
  */
2953
3106
  export interface FieldData {
2954
3107
  type: FieldType;
@@ -2958,7 +3111,8 @@ export interface FieldData {
2958
3111
  /**
2959
3112
  * JSON API data
2960
3113
  *
2961
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "data".
3114
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
3115
+ * `definition` "data".
2962
3116
  */
2963
3117
  export interface FieldsetData {
2964
3118
  type: FieldsetType;
@@ -2968,14 +3122,18 @@ export interface FieldsetData {
2968
3122
  /**
2969
3123
  * JSON API data
2970
3124
  *
2971
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "data".
3125
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
3126
+ * `definition` "data".
2972
3127
  */
2973
3128
  export interface WorkflowData {
2974
3129
  type: WorkflowType;
2975
3130
  id: WorkflowIdentity;
2976
3131
  }
2977
3132
 
2978
- /** This interface was referenced by `ItemType`'s JSON-Schema via the `create.schema` link. */
3133
+ /**
3134
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
3135
+ * `create.schema` link.
3136
+ */
2979
3137
  export interface ItemTypeCreateSchema {
2980
3138
  data: {
2981
3139
  type: ItemTypeType;
@@ -3016,7 +3174,10 @@ export interface ItemTypeCreateSchema {
3016
3174
  collection_appeareance?: 'compact' | 'table';
3017
3175
  /** The way the model collection should be presented to the editors */
3018
3176
  collection_appearance?: 'compact' | 'table';
3019
- /** A hint shown to editors to help them understand the purpose of this model/block */
3177
+ /**
3178
+ * A hint shown to editors to help them understand the purpose of this
3179
+ * model/block
3180
+ */
3020
3181
  hint?: string | null;
3021
3182
  };
3022
3183
  relationships?: {
@@ -3053,7 +3214,10 @@ export interface ItemTypeCreateTargetSchema {
3053
3214
  included?: MenuItem[];
3054
3215
  }
3055
3216
 
3056
- /** This interface was referenced by `ItemType`'s JSON-Schema via the `update.schema` link. */
3217
+ /**
3218
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
3219
+ * `update.schema` link.
3220
+ */
3057
3221
  export interface ItemTypeUpdateSchema {
3058
3222
  data: {
3059
3223
  type: ItemTypeType;
@@ -3100,7 +3264,10 @@ export interface ItemTypeUpdateSchema {
3100
3264
  * has already been created or not
3101
3265
  */
3102
3266
  has_singleton_item?: boolean;
3103
- /** A hint shown to editors to help them understand the purpose of this model/block */
3267
+ /**
3268
+ * A hint shown to editors to help them understand the purpose of this
3269
+ * model/block
3270
+ */
3104
3271
  hint?: string | null;
3105
3272
  };
3106
3273
  relationships?: {
@@ -3136,7 +3303,10 @@ export interface ItemTypeUpdateTargetSchema {
3136
3303
  data: Job;
3137
3304
  }
3138
3305
 
3139
- /** This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "job". */
3306
+ /**
3307
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
3308
+ * "job".
3309
+ */
3140
3310
  export interface Job {
3141
3311
  type: JobType;
3142
3312
  id: JobIdentity;
@@ -3145,7 +3315,8 @@ export interface Job {
3145
3315
  /**
3146
3316
  * JSON API data
3147
3317
  *
3148
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "data".
3318
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
3319
+ * "data".
3149
3320
  */
3150
3321
  export interface JobData {
3151
3322
  type: JobType;
@@ -3204,7 +3375,8 @@ export interface ItemTypeDestroyJobSchema {
3204
3375
  * DatoCMS offers a number of different fields that you can combine togheter to
3205
3376
  * create a [Model](/docs/content-management-api/resources/item-type). Using the
3206
3377
  * database metaphore, fields are like table columns, and when creating them you
3207
- * need to specify their type (`string`, `float`, etc.) and any required validation.
3378
+ * need to specify their type (`string`, `float`, etc.) and any required
3379
+ * validation.
3208
3380
  *
3209
3381
  * ### Different field types require different settings
3210
3382
  *
@@ -3213,13 +3385,13 @@ export interface ItemTypeDestroyJobSchema {
3213
3385
  *
3214
3386
  * The `validators` property expresses the set of validations to be performed
3215
3387
  * server-side on a specific field value for it to be considered valid, while
3216
- * the `appearance` property lets you specify *how* the field itself will be
3388
+ * the `appearance` property lets you specify _how_ the field itself will be
3217
3389
  * presented inside the form to the final editor.
3218
3390
  *
3219
3391
  * For both properties, the value to specify depends on the type of field
3220
3392
  * itself. For example, you can add a "Limit character count" validation to a
3221
- * *Single-line string* field, or set its appearence to "Show it as heading",
3222
- * but they won't be accepted for a ie. *Color* field, as it supports different
3393
+ * _Single-line string_ field, or set its appearence to "Show it as heading",
3394
+ * but they won't be accepted for a ie. _Color_ field, as it supports different
3223
3395
  * validations and appearance settings.
3224
3396
  *
3225
3397
  * ### Specifying validations
@@ -3229,7 +3401,7 @@ export interface ItemTypeDestroyJobSchema {
3229
3401
  * settings that the validation itself requires. If the validation doesn't have
3230
3402
  * additional settings, you just pass down an empty object.
3231
3403
  *
3232
- * This is a valid example for a *Single-line string* field:
3404
+ * This is a valid example for a _Single-line string_ field:
3233
3405
  *
3234
3406
  * ```js
3235
3407
  * {
@@ -3246,8 +3418,9 @@ export interface ItemTypeDestroyJobSchema {
3246
3418
  * type with their settings.
3247
3419
  *
3248
3420
  * Some validators are required for a specific type of field. For example, the
3249
- * *Slug* field needs to have a `slug_title_field` validator to specify the ID
3250
- * of the *Single-line string* field that will be used to generate the slug itself.
3421
+ * _Slug_ field needs to have a `slug_title_field` validator to specify the ID
3422
+ * of the _Single-line string_ field that will be used to generate the slug
3423
+ * itself.
3251
3424
  *
3252
3425
  * ### Specifying the appearance
3253
3426
  *
@@ -3260,7 +3433,7 @@ export interface ItemTypeDestroyJobSchema {
3260
3433
  * The `parameters` property is an object representing any additional settings
3261
3434
  * that the editor itself might require.
3262
3435
  *
3263
- * This is a valid example for a *Single-line string* field:
3436
+ * This is a valid example for a _Single-line string_ field:
3264
3437
  *
3265
3438
  * ```js
3266
3439
  * {
@@ -3281,7 +3454,8 @@ export interface ItemTypeDestroyJobSchema {
3281
3454
  *
3282
3455
  * If the project contains a plugin that exposes [manual field
3283
3456
  * editors](/docs/plugin-sdk/manual-field-extensions), you can also configure
3284
- * the field to be presented with it instead of using one of the build-in editors.
3457
+ * the field to be presented with it instead of using one of the build-in
3458
+ * editors.
3285
3459
  *
3286
3460
  * In this case:
3287
3461
  *
@@ -3335,125 +3509,143 @@ export interface ItemTypeDestroyJobSchema {
3335
3509
  * ### Available field types<details><summary>Single-line string (<code>string</code>)</summary>
3336
3510
  *
3337
3511
  * | Property | Value |
3338
- * | ------------------------------ | ---------------------------------------------------- | ------------------- |
3512
+ * | ------------------------------ | ---------------------------------------------------- | ------------------- | ------------------------------------------------------ |
3339
3513
  * | Code | `string` |
3340
3514
  * | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
3341
- * | Available validators | `required`, `unique`, `length`, `format`, `enum` | </details><details> |<summary>Multi-line text (<code>text</code>)</summary>
3515
+ * | Available validators | `required`, `unique`, `length`, `format`, `enum` | </details><details> | <summary>Multi-line text (<code>text</code>)</summary> |
3516
+ *
3517
+ * | Property | Value |
3342
3518
  *
3343
- * | Property | Value |
3344
3519
  * | ------------------------------ | --------------------------------- | ------------------- |
3345
- * | Code | `text` |
3520
+ * | Code | `text` |
3346
3521
  * | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
3347
- * | Available validators | `required`, `length`, `format` | </details><details> |<summary>Boolean (<code>boolean</code>)</summary>
3522
+ * | Available validators | `required`, `length`, `format` | </details><details> |<summary>Boolean (<code>boolean</code>)</summary>
3523
+ *
3524
+ * | Property | Value |
3348
3525
  *
3349
- * | Property | Value |
3350
3526
  * | ------------------------------ | -------------------------------- | ------------------- |
3351
- * | Code | `boolean` |
3527
+ * | Code | `boolean` |
3352
3528
  * | Built-in editors for the field | `boolean`, `boolean_radio_group` |
3353
- * | Available validators | no validators available | </details><details> |<summary>Integer (<code>integer</code>)</summary>
3529
+ * | Available validators | no validators available | </details><details> |<summary>Integer (<code>integer</code>)</summary>
3530
+ *
3531
+ * | Property | Value |
3354
3532
  *
3355
- * | Property | Value |
3356
3533
  * | ------------------------------ | -------------------------- | ------------------- |
3357
- * | Code | `integer` |
3358
- * | Built-in editors for the field | `integer` |
3359
- * | Available validators | `required`, `number_range` | </details><details> |<summary>Float (<code>float</code>)</summary>
3534
+ * | Code | `integer` |
3535
+ * | Built-in editors for the field | `integer` |
3536
+ * | Available validators | `required`, `number_range` | </details><details> |<summary>Float (<code>float</code>)</summary>
3537
+ *
3538
+ * | Property | Value |
3360
3539
  *
3361
- * | Property | Value |
3362
3540
  * | ------------------------------ | -------------------------- | ------------------- |
3363
- * | Code | `float` |
3364
- * | Built-in editors for the field | `float` |
3365
- * | Available validators | `required`, `number_range` | </details><details> |<summary>Date (<code>date</code>)</summary>
3541
+ * | Code | `float` |
3542
+ * | Built-in editors for the field | `float` |
3543
+ * | Available validators | `required`, `number_range` | </details><details> |<summary>Date (<code>date</code>)</summary>
3544
+ *
3545
+ * | Property | Value |
3366
3546
  *
3367
- * | Property | Value |
3368
3547
  * | ------------------------------ | ------------------------ | ------------------- |
3369
- * | Code | `date` |
3370
- * | Built-in editors for the field | `date_picker` |
3371
- * | Available validators | `required`, `date_range` | </details><details> |<summary>Date time (<code>date_time</code>)</summary>
3548
+ * | Code | `date` |
3549
+ * | Built-in editors for the field | `date_picker` |
3550
+ * | Available validators | `required`, `date_range` | </details><details> |<summary>Date time (<code>date_time</code>)</summary>
3551
+ *
3552
+ * | Property | Value |
3372
3553
  *
3373
- * | Property | Value |
3374
3554
  * | ------------------------------ | ----------------------------- | ------------------- |
3375
- * | Code | `date_time` |
3376
- * | Built-in editors for the field | `date_time_picker` |
3377
- * | Available validators | `required`, `date_time_range` | </details><details> |<summary>Color (<code>color</code>)</summary>
3555
+ * | Code | `date_time` |
3556
+ * | Built-in editors for the field | `date_time_picker` |
3557
+ * | Available validators | `required`, `date_time_range` | </details><details> |<summary>Color (<code>color</code>)</summary>
3558
+ *
3559
+ * | Property | Value |
3378
3560
  *
3379
- * | Property | Value |
3380
3561
  * | ------------------------------ | -------------- | ------------------- |
3381
- * | Code | `color` |
3562
+ * | Code | `color` |
3382
3563
  * | Built-in editors for the field | `color_picker` |
3383
- * | Available validators | `required` | </details><details> |<summary>JSON (<code>json</code>)</summary>
3564
+ * | Available validators | `required` | </details><details> |<summary>JSON (<code>json</code>)</summary>
3565
+ *
3566
+ * | Property | Value |
3384
3567
  *
3385
- * | Property | Value |
3386
3568
  * | ------------------------------ | ------------------------------------------------------ | ------------------- |
3387
- * | Code | `json` |
3569
+ * | Code | `json` |
3388
3570
  * | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
3389
- * | Available validators | `required` | </details><details> |<summary>Location (<code>lat_lon</code>)</summary>
3571
+ * | Available validators | `required` | </details><details> |<summary>Location (<code>lat_lon</code>)</summary>
3572
+ *
3573
+ * | Property | Value |
3390
3574
  *
3391
- * | Property | Value |
3392
3575
  * | ------------------------------ | ---------- | ------------------- |
3393
- * | Code | `lat_lon` |
3394
- * | Built-in editors for the field | `map` |
3395
- * | Available validators | `required` | </details><details> |<summary>SEO (<code>seo</code>)</summary>
3576
+ * | Code | `lat_lon` |
3577
+ * | Built-in editors for the field | `map` |
3578
+ * | Available validators | `required` | </details><details> |<summary>SEO (<code>seo</code>)</summary>
3579
+ *
3580
+ * | Property | Value |
3396
3581
  *
3397
- * | Property | Value |
3398
3582
  * | ------------------------------ | -------------------------------------------------------------------------------------------- | ------------------- |
3399
- * | Code | `seo` |
3400
- * | Built-in editors for the field | `seo` |
3401
- * | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` | </details><details> |<summary>Slug (<code>slug</code>)</summary>
3583
+ * | Code | `seo` |
3584
+ * | Built-in editors for the field | `seo` |
3585
+ * | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` | </details><details> |<summary>Slug (<code>slug</code>)</summary>
3586
+ *
3587
+ * | Property | Value |
3402
3588
  *
3403
- * | Property | Value |
3404
3589
  * | ------------------------------ | ----------------------------------- | ------------------- |
3405
- * | Code | `slug` |
3406
- * | Built-in editors for the field | `slug` |
3407
- * | Required validators | `slug_title_field` |
3408
- * | Other validators available | `required`, `length`, `slug_format` | </details><details> |<summary>External video (<code>video</code>)</summary>
3590
+ * | Code | `slug` |
3591
+ * | Built-in editors for the field | `slug` |
3592
+ * | Required validators | `slug_title_field` |
3593
+ * | Other validators available | `required`, `length`, `slug_format` | </details><details> |<summary>External video (<code>video</code>)</summary>
3594
+ *
3595
+ * | Property | Value |
3409
3596
  *
3410
- * | Property | Value |
3411
3597
  * | ------------------------------ | ---------- | ------------------- |
3412
- * | Code | `video` |
3413
- * | Built-in editors for the field | `video` |
3414
- * | Available validators | `required` | </details><details> |<summary>Single-asset (<code>file</code>)</summary>
3598
+ * | Code | `video` |
3599
+ * | Built-in editors for the field | `video` |
3600
+ * | Available validators | `required` | </details><details> |<summary>Single-asset (<code>file</code>)</summary>
3601
+ *
3602
+ * | Property | Value |
3415
3603
  *
3416
- * | Property | Value |
3417
3604
  * | ------------------------------ | ------------------------------------------------------------------------------ | ------------------- |
3418
- * | Code | `file` |
3419
- * | Built-in editors for the field | `file` |
3420
- * | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Asset gallery (<code>gallery</code>)</summary>
3605
+ * | Code | `file` |
3606
+ * | Built-in editors for the field | `file` |
3607
+ * | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Asset gallery (<code>gallery</code>)</summary>
3608
+ *
3609
+ * | Property | Value |
3421
3610
  *
3422
- * | Property | Value |
3423
3611
  * | ------------------------------ | -------------------------------------------------------------------------- | ------------------- |
3424
- * | Code | `gallery` |
3425
- * | Built-in editors for the field | `gallery` |
3426
- * | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Single link (<code>link</code>)</summary>
3612
+ * | Code | `gallery` |
3613
+ * | Built-in editors for the field | `gallery` |
3614
+ * | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Single link (<code>link</code>)</summary>
3615
+ *
3616
+ * | Property | Value |
3427
3617
  *
3428
- * | Property | Value |
3429
3618
  * | ------------------------------ | --------------------------- | ------------------- |
3430
- * | Code | `link` |
3619
+ * | Code | `link` |
3431
3620
  * | Built-in editors for the field | `link_select`, `link_embed` |
3432
- * | Default `editor` | `link_select` |
3433
- * | Required validators | `item_item_type` |
3434
- * | Other validators available | `required`, `unique` | </details><details> |<summary>Multiple links (<code>links</code>)</summary>
3621
+ * | Default `editor` | `link_select` |
3622
+ * | Required validators | `item_item_type` |
3623
+ * | Other validators available | `required`, `unique` | </details><details> |<summary>Multiple links (<code>links</code>)</summary>
3624
+ *
3625
+ * | Property | Value |
3435
3626
  *
3436
- * | Property | Value |
3437
3627
  * | ------------------------------ | ----------------------------- | ------------------- |
3438
- * | Code | `links` |
3628
+ * | Code | `links` |
3439
3629
  * | Built-in editors for the field | `links_select`, `links_embed` |
3440
- * | Default `editor` | `links_select` |
3441
- * | Required validators | `items_item_type` |
3442
- * | Other validators available | `size` | </details><details> |<summary>Modular content (<code>rich_text</code>)</summary>
3630
+ * | Default `editor` | `links_select` |
3631
+ * | Required validators | `items_item_type` |
3632
+ * | Other validators available | `size` | </details><details> |<summary>Modular content (<code>rich_text</code>)</summary>
3633
+ *
3634
+ * | Property | Value |
3443
3635
  *
3444
- * | Property | Value |
3445
3636
  * | ------------------------------ | ------------------ | ------------------- |
3446
- * | Code | `rich_text` |
3447
- * | Built-in editors for the field | `rich_text` |
3448
- * | Required validators | `rich_text_blocks` |
3449
- * | Other validators available | `size` | </details><details> |<summary>Structured text (<code>structured_text</code>)</summary>
3637
+ * | Code | `rich_text` |
3638
+ * | Built-in editors for the field | `rich_text` |
3639
+ * | Required validators | `rich_text_blocks` |
3640
+ * | Other validators available | `size` | </details><details> |<summary>Structured text (<code>structured_text</code>)</summary>
3641
+ *
3642
+ * | Property | Value |
3450
3643
  *
3451
- * | Property | Value |
3452
3644
  * | ------------------------------ | ------------------------------------------------- | ---------- |
3453
- * | Code | `structured_text` |
3454
- * | Built-in editors for the field | `structured_text` |
3455
- * | Required validators | `structured_text_blocks`, `structured_text_links` |
3456
- * | Other validators available | `length` | </details> |
3645
+ * | Code | `structured_text` |
3646
+ * | Built-in editors for the field | `structured_text` |
3647
+ * | Required validators | `structured_text_blocks`, `structured_text_links` |
3648
+ * | Other validators available | `length` | </details> |
3457
3649
  *
3458
3650
  * ### Validators<details><summary><code>date_range</code></summary>
3459
3651
  *
@@ -3464,7 +3656,8 @@ export interface ItemTypeDestroyJobSchema {
3464
3656
  * | `min` | ISO 8601 date | | Minimum date |
3465
3657
  * | `max` | ISO 8601 date | | Maximum date |
3466
3658
  *
3467
- * At least one of the parameters must be specified.</details><details><summary><code>date_time_range</code></summary>
3659
+ * At least one of the parameters must be
3660
+ * specified.</details><details><summary><code>date_time_range</code></summary>
3468
3661
  *
3469
3662
  * Accept date times only inside a specified date range.
3470
3663
  *
@@ -3473,13 +3666,14 @@ export interface ItemTypeDestroyJobSchema {
3473
3666
  * | `min` | ISO 8601 datetime | | Minimum datetime |
3474
3667
  * | `max` | ISO 8601 datetime | | Maximum datetime |
3475
3668
  *
3476
- * At least one of the parameters must be specified.</details><details><summary><code>enum</code></summary>
3669
+ * At least one of the parameters must be
3670
+ * specified.</details><details><summary><code>enum</code></summary>
3477
3671
  *
3478
3672
  * Only accept a specific set of values
3479
3673
  *
3480
3674
  * | Parameter | Type | Required | Description |
3481
- * | --------- | --------------- | -------- | --------------------- | ------------------- |
3482
- * | `values` | `Array<String>` | ✅ | Set of allowed values | </details><details> |<summary><code>extension</code></summary>
3675
+ * | --------- | --------------- | -------- | --------------------- | ------------------- | ----------------------------------------- |
3676
+ * | `values` | `Array<String>` | ✅ | Set of allowed values | </details><details> | <summary><code>extension</code></summary> |
3483
3677
  *
3484
3678
  * Only accept assets with specific file extensions.
3485
3679
  *
@@ -3488,7 +3682,8 @@ export interface ItemTypeDestroyJobSchema {
3488
3682
  * | `extensions` | `Array<String>` | | Set of allowed file extensions |
3489
3683
  * | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` | | Allowed file type |
3490
3684
  *
3491
- * Only one of the parameters must be specified.</details><details><summary><code>file_size</code></summary>
3685
+ * Only one of the parameters must be
3686
+ * specified.</details><details><summary><code>file_size</code></summary>
3492
3687
  *
3493
3688
  * Accept assets only inside a specified date range.
3494
3689
  *
@@ -3499,7 +3694,8 @@ export interface ItemTypeDestroyJobSchema {
3499
3694
  * | `max_value` | `Integer` | | Numeric value for maximum filesize |
3500
3695
  * | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
3501
3696
  *
3502
- * At least one couple of value/unit must be specified.</details><details><summary><code>format</code></summary>
3697
+ * At least one couple of value/unit must be
3698
+ * specified.</details><details><summary><code>format</code></summary>
3503
3699
  *
3504
3700
  * Only accept strings having a specific format.
3505
3701
  *
@@ -3508,7 +3704,8 @@ export interface ItemTypeDestroyJobSchema {
3508
3704
  * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
3509
3705
  * | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
3510
3706
  *
3511
- * Only one of the parameters must be specified.</details><details><summary><code>slug_format</code></summary>
3707
+ * Only one of the parameters must be
3708
+ * specified.</details><details><summary><code>slug_format</code></summary>
3512
3709
  *
3513
3710
  * Only accept slugs having a specific format.
3514
3711
  *
@@ -3517,7 +3714,8 @@ export interface ItemTypeDestroyJobSchema {
3517
3714
  * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
3518
3715
  * | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
3519
3716
  *
3520
- * Only one of the parameters must be specified.</details><details><summary><code>image_dimensions</code></summary>
3717
+ * Only one of the parameters must be
3718
+ * specified.</details><details><summary><code>image_dimensions</code></summary>
3521
3719
  *
3522
3720
  * Accept assets only within a specified height/width range.
3523
3721
  *
@@ -3528,7 +3726,8 @@ export interface ItemTypeDestroyJobSchema {
3528
3726
  * | `height_min_value` | `Integer` | | Numeric value for minimum width |
3529
3727
  * | `height_max_value` | `Integer` | | Numeric value for maximum height |
3530
3728
  *
3531
- * At least one parameter must be specified.</details><details><summary><code>item_item_type</code></summary>
3729
+ * At least one parameter must be
3730
+ * specified.</details><details><summary><code>item_item_type</code></summary>
3532
3731
  *
3533
3732
  * Only accept references to records of the specified models.
3534
3733
  *
@@ -3555,7 +3754,8 @@ export interface ItemTypeDestroyJobSchema {
3555
3754
  *
3556
3755
  * - `"fail"`: Fail the operation and notify the user
3557
3756
  * - `"delete_references"`: Try to remove the reference to the deleted record (if
3558
- * the field has a `required` validation it will fail)</details><details><summary><code>items_item_type</code></summary>
3757
+ * the field has a `required` validation it will
3758
+ * fail)</details><details><summary><code>items_item_type</code></summary>
3559
3759
  *
3560
3760
  * Only accept references to records of the specified models.
3561
3761
  *
@@ -3582,7 +3782,8 @@ export interface ItemTypeDestroyJobSchema {
3582
3782
  *
3583
3783
  * - `"fail"`: Fail the operation and notify the user
3584
3784
  * - `"delete_references"`: Try to remove the reference to the deleted record (if
3585
- * the field has a `required` validation it will fail)</details><details><summary><code>length</code></summary>
3785
+ * the field has a `required` validation it will
3786
+ * fail)</details><details><summary><code>length</code></summary>
3586
3787
  *
3587
3788
  * Accept strings only with a specified number of characters.
3588
3789
  *
@@ -3592,7 +3793,8 @@ export interface ItemTypeDestroyJobSchema {
3592
3793
  * | `eq` | `Integer` | | Expected length |
3593
3794
  * | `max` | `Integer` | | Maximum length |
3594
3795
  *
3595
- * At least one parameter must be specified.</details><details><summary><code>number_range</code></summary>
3796
+ * At least one parameter must be
3797
+ * specified.</details><details><summary><code>number_range</code></summary>
3596
3798
  *
3597
3799
  * Accept numbers only inside a specified range.
3598
3800
  *
@@ -3601,9 +3803,11 @@ export interface ItemTypeDestroyJobSchema {
3601
3803
  * | `min` | `Float` | | Minimum value |
3602
3804
  * | `max` | `Float` | | Maximum value |
3603
3805
  *
3604
- * At least one of the parameters must be specified.</details><details><summary><code>required</code></summary>
3806
+ * At least one of the parameters must be
3807
+ * specified.</details><details><summary><code>required</code></summary>
3605
3808
  *
3606
- * Value must be specified or it won't be valid.</details><details><summary><code>required_alt_title</code></summary>
3809
+ * Value must be specified or it won't be
3810
+ * valid.</details><details><summary><code>required_alt_title</code></summary>
3607
3811
  *
3608
3812
  * Assets contained in the field are required to specify custom title or
3609
3813
  * alternate text, or they won't be valid.
@@ -3613,7 +3817,8 @@ export interface ItemTypeDestroyJobSchema {
3613
3817
  * | `title` | `Boolean` | | Whether the title for the asset must be specified |
3614
3818
  * | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
3615
3819
  *
3616
- * At least one of the parameters must be specified.</details><details><summary><code>required_seo_fields</code></summary>
3820
+ * At least one of the parameters must be
3821
+ * specified.</details><details><summary><code>required_seo_fields</code></summary>
3617
3822
  *
3618
3823
  * SEO field is to specify one or more properties, or it won't be valid.
3619
3824
  *
@@ -3624,7 +3829,8 @@ export interface ItemTypeDestroyJobSchema {
3624
3829
  * | `image` | `Boolean` | | Whether the social sharing image must be specified |
3625
3830
  * | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
3626
3831
  *
3627
- * At least one of the parameters must be specified.</details><details><summary><code>title_length</code></summary>
3832
+ * At least one of the parameters must be
3833
+ * specified.</details><details><summary><code>title_length</code></summary>
3628
3834
  *
3629
3835
  * Limits the length of the title for a SEO field. Search engines usually
3630
3836
  * truncate title tags to 60 character so it is a good practice to keep the
@@ -3635,7 +3841,8 @@ export interface ItemTypeDestroyJobSchema {
3635
3841
  * | `min` | `Integer` | | Minimum value |
3636
3842
  * | `max` | `Integer` | | Maximum value |
3637
3843
  *
3638
- * At least one of the parameters must be specified.</details><details><summary><code>description_length</code></summary>
3844
+ * At least one of the parameters must be
3845
+ * specified.</details><details><summary><code>description_length</code></summary>
3639
3846
  *
3640
3847
  * Limits the length of the description for a SEO field. Search engines usually
3641
3848
  * truncate description tags to 160 character so it is a good practice to keep
@@ -3646,21 +3853,23 @@ export interface ItemTypeDestroyJobSchema {
3646
3853
  * | `min` | `Integer` | | Minimum value |
3647
3854
  * | `max` | `Integer` | | Maximum value |
3648
3855
  *
3649
- * At least one of the parameters must be specified.</details><details><summary><code>rich_text_blocks</code></summary>
3856
+ * At least one of the parameters must be
3857
+ * specified.</details><details><summary><code>rich_text_blocks</code></summary>
3650
3858
  *
3651
3859
  * Only accept references to block records of the specified block models.
3652
3860
  *
3653
3861
  * | Parameter | Type | Required | Description |
3654
- * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- |
3655
- * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> |<summary><code>structured_text_blocks</code></summary>
3862
+ * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- | ------------------------------------------------------ |
3863
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> | <summary><code>structured_text_blocks</code></summary> |
3656
3864
  *
3657
3865
  * Only accept references to block records of the specified block models.
3658
3866
  *
3659
3867
  * | Parameter | Type | Required | Description |
3660
- * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- |
3661
- * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> |<summary><code>structured_text_links</code></summary>
3868
+ * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- | ----------------------------------------------------- |
3869
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> | <summary><code>structured_text_links</code></summary> |
3662
3870
  *
3663
- * Only accept `itemLink` to `inlineItem` nodes for records of the specified models.
3871
+ * Only accept `itemLink` to `inlineItem` nodes for records of the specified
3872
+ * models.
3664
3873
  *
3665
3874
  * | Parameter | Type | Required | Description |
3666
3875
  * | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
@@ -3685,7 +3894,8 @@ export interface ItemTypeDestroyJobSchema {
3685
3894
  *
3686
3895
  * - `"fail"`: Fail the operation and notify the user
3687
3896
  * - `"delete_references"`: Try to remove the reference to the deleted record (if
3688
- * the field has a `required` validation it will fail)</details><details><summary><code>size</code></summary>
3897
+ * the field has a `required` validation it will
3898
+ * fail)</details><details><summary><code>size</code></summary>
3689
3899
  *
3690
3900
  * Only accept a number of items within the specified range.
3691
3901
  *
@@ -3696,109 +3906,114 @@ export interface ItemTypeDestroyJobSchema {
3696
3906
  * | `max` | `Integer` | | Maximum length |
3697
3907
  * | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
3698
3908
  *
3699
- * At least one parameter must be specified.</details><details><summary><code>slug_title_field</code></summary>
3909
+ * At least one parameter must be
3910
+ * specified.</details><details><summary><code>slug_title_field</code></summary>
3700
3911
  *
3701
- * Specifies the ID of the *Single-line string* field that will be used to
3912
+ * Specifies the ID of the _Single-line string_ field that will be used to
3702
3913
  * generate the slug
3703
3914
  *
3704
3915
  * | Parameter | Type | Required | Description |
3705
- * | ---------------- | ---------- | -------- | ------------------------------------------------ | ------------------- |
3706
- * | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug | </details><details> |<summary><code>unique</code></summary>
3916
+ * | ---------------- | ---------- | -------- | ------------------------------------------------ | ------------------- | -------------------------------------- |
3917
+ * | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug | </details><details> | <summary><code>unique</code></summary> |
3707
3918
  *
3708
3919
  * The value must be unique across the whole collection of records.</details>
3709
3920
  *
3710
3921
  * ### Configuration parameters for DatoCMS built-in field editors
3711
3922
  *
3712
3923
  * If a field editor is not specified in this table, just pass an empty object
3713
- * `{}` as its configuration parameters.<details><summary><code>boolean_radio_group</code></summary>
3924
+ * `{}` as its configuration
3925
+ * parameters.<details><summary><code>boolean_radio_group</code></summary>
3714
3926
  *
3715
- * Radio group input for *boolean* fields.
3927
+ * Radio group input for _boolean_ fields.
3716
3928
  *
3717
3929
  * | Parameter | Type | Required | Description |
3718
- * | ---------------- | ---------------------------------- | -------- | ----------------------------------------- | ------------------- |
3930
+ * | ---------------- | ---------------------------------- | -------- | ----------------------------------------- | ------------------- | -------------------------------------------------- |
3719
3931
  * | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
3720
- * | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) | </details><details> |<summary><code>string_radio_group</code></summary>
3932
+ * | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) | </details><details> | <summary><code>string_radio_group</code></summary> |
3721
3933
  *
3722
- * Radio group input for *string* fields.
3934
+ * Radio group input for _string_ fields.
3723
3935
  *
3724
3936
  * | Parameter | Type | Required | Description |
3725
- * | --------- | -------------------------------------------------------- | -------- | --------------------------- | ------------------- |
3726
- * | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options | </details><details> |<summary><code>string_select</code></summary>
3937
+ * | --------- | -------------------------------------------------------- | -------- | --------------------------- | ------------------- | --------------------------------------------- |
3938
+ * | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options | </details><details> | <summary><code>string_select</code></summary> |
3727
3939
  *
3728
- * Select input for *string* fields.
3940
+ * Select input for _string_ fields.
3729
3941
  *
3730
3942
  * | Parameter | Type | Required | Description |
3731
- * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- |
3732
- * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> |<summary><code>string_multi_select</code></summary>
3943
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- | --------------------------------------------------- |
3944
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> | <summary><code>string_multi_select</code></summary> |
3733
3945
  *
3734
- * Select input for *JSON* fields, to edit an array of strings.
3946
+ * Select input for _JSON_ fields, to edit an array of strings.
3735
3947
  *
3736
3948
  * | Parameter | Type | Required | Description |
3737
- * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- |
3738
- * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> |<summary><code>string_checkbox_group</code></summary>
3949
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- | ----------------------------------------------------- |
3950
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> | <summary><code>string_checkbox_group</code></summary> |
3739
3951
  *
3740
- * Multiple chechboxes input for *JSON* fields, to edit an array of strings.
3952
+ * Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
3741
3953
  *
3742
3954
  * | Parameter | Type | Required | Description |
3743
- * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- |
3744
- * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> |<summary><code>single_line</code></summary>
3955
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- | ------------------------------------------- |
3956
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> | <summary><code>single_line</code></summary> |
3745
3957
  *
3746
- * Simple textual input for *Single-line string* fields.
3958
+ * Simple textual input for _Single-line string_ fields.
3747
3959
  *
3748
3960
  * | Parameter | Type | Required | Description |
3749
- * | --------- | --------- | -------- | -------------------------------------------------------------------------------- | ------------------- |
3750
- * | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading | </details><details> |<summary><code>markdown</code></summary>
3961
+ * | --------- | --------- | -------- | -------------------------------------------------------------------------------- | ------------------- | ---------------------------------------- |
3962
+ * | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading | </details><details> | <summary><code>markdown</code></summary> |
3751
3963
  *
3752
- * Markdown editor for *Multiple-paragraph text* fields.
3964
+ * Markdown editor for _Multiple-paragraph text_ fields.
3753
3965
  *
3754
3966
  * | Parameter | Type | Required | Description |
3755
- * | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
3756
- * | `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"` | </details><details> |<summary><code>wysiwyg</code></summary>
3967
+ * | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | --------------------------------------- |
3968
+ * | `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"` | </details><details> | <summary><code>wysiwyg</code></summary> |
3757
3969
  *
3758
- * HTML editor for *Multiple-paragraph text* fields.
3970
+ * HTML editor for _Multiple-paragraph text_ fields.
3759
3971
  *
3760
3972
  * | Parameter | Type | Required | Description |
3761
- * | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
3762
- * | `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"` | </details><details> |<summary><code>textarea</code></summary>
3973
+ * | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ---------------------------------------- |
3974
+ * | `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"` | </details><details> | <summary><code>textarea</code></summary> |
3763
3975
  *
3764
- * Basic textarea editor for *Multiple-paragraph text* fields.</details><details><summary><code>color_picker</code></summary>
3976
+ * Basic textarea editor for _Multiple-paragraph text_
3977
+ * fields.</details><details><summary><code>color_picker</code></summary>
3765
3978
  *
3766
- * Built-in editor for *Color* fields.
3979
+ * Built-in editor for _Color_ fields.
3767
3980
  *
3768
3981
  * | Parameter | Type | Required | Description |
3769
- * | --------------- | ------------------------- | -------- | --------------------------------------------------------- | ------------------- |
3982
+ * | --------------- | ------------------------- | -------- | --------------------------------------------------------- | ------------------- | ------------------------------------ |
3770
3983
  * | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
3771
- * | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user | </details><details> |<summary><code>slug</code></summary>
3984
+ * | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user | </details><details> | <summary><code>slug</code></summary> |
3772
3985
  *
3773
- * Built-in editor for *Slug* fields.
3986
+ * Built-in editor for _Slug_ fields.
3774
3987
  *
3775
3988
  * | Parameter | Type | Required | Description |
3776
- * | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- | ------------------- |
3777
- * | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. | </details><details> |<summary><code>rich_text</code></summary>
3989
+ * | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- | ------------------- | ----------------------------------------- |
3990
+ * | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. | </details><details> | <summary><code>rich_text</code></summary> |
3778
3991
  *
3779
- * Built-in editor for *Modular content* fields.
3992
+ * Built-in editor for _Modular content_ fields.
3780
3993
  *
3781
3994
  * | Parameter | Type | Required | Description |
3782
- * | ----------------- | --------- | -------- | ---------------------------------------------------------- | ------------------- |
3783
- * | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not | </details><details> |<summary><code>structured_text</code></summary>
3995
+ * | ----------------- | --------- | -------- | ---------------------------------------------------------- | ------------------- | ----------------------------------------------- |
3996
+ * | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not | </details><details> | <summary><code>structured_text</code></summary> |
3784
3997
  *
3785
- * Built-in editor for *Structured text* fields.
3998
+ * Built-in editor for _Structured text_ fields.
3786
3999
  *
3787
4000
  * | Parameter | Type | Required | Description |
3788
- * | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
4001
+ * | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------- |
3789
4002
  * | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
3790
4003
  * | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
3791
4004
  * | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
3792
4005
  * | `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 |
3793
- * | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links | </details><details> |<summary><code>link_select</code> and <code>links_select</code></summary>
4006
+ * | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links | </details><details> | <summary><code>link_select</code> and <code>links_select</code></summary> |
3794
4007
  *
3795
4008
  * Use a select input with auto-completion to pick the records to reference
3796
- * inside the field.</details><details><summary><code>link_embed</code> and <code>links_embed</code></summary>
4009
+ * inside the field.</details><details><summary><code>link_embed</code> and
4010
+ * <code>links_embed</code></summary>
3797
4011
  *
3798
4012
  * Use an expanded view with records' image preview to pick the records to
3799
4013
  * reference inside the field.</details>
3800
4014
  *
3801
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "field".
4015
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
4016
+ * "field".
3802
4017
  */
3803
4018
  export interface Field {
3804
4019
  type: FieldType;
@@ -3901,7 +4116,10 @@ export interface FieldRelationships {
3901
4116
  };
3902
4117
  }
3903
4118
 
3904
- /** This interface was referenced by `Field`'s JSON-Schema via the `create.schema` link. */
4119
+ /**
4120
+ * This interface was referenced by `Field`'s JSON-Schema via the
4121
+ * `create.schema` link.
4122
+ */
3905
4123
  export interface FieldCreateSchema {
3906
4124
  data: {
3907
4125
  type: FieldType;
@@ -3994,13 +4212,19 @@ export interface FieldCreateTargetSchema {
3994
4212
  data: Job;
3995
4213
  }
3996
4214
 
3997
- /** This interface was referenced by `Field`'s JSON-Schema via the `create.jobSchema` link. */
4215
+ /**
4216
+ * This interface was referenced by `Field`'s JSON-Schema via the
4217
+ * `create.jobSchema` link.
4218
+ */
3998
4219
  export interface FieldCreateJobSchema {
3999
4220
  data: Field;
4000
4221
  included?: ItemType[];
4001
4222
  }
4002
4223
 
4003
- /** This interface was referenced by `Field`'s JSON-Schema via the `update.schema` link. */
4224
+ /**
4225
+ * This interface was referenced by `Field`'s JSON-Schema via the
4226
+ * `update.schema` link.
4227
+ */
4004
4228
  export interface FieldUpdateSchema {
4005
4229
  data: {
4006
4230
  type: FieldType;
@@ -4093,7 +4317,10 @@ export interface FieldUpdateTargetSchema {
4093
4317
  data: Job;
4094
4318
  }
4095
4319
 
4096
- /** This interface was referenced by `Field`'s JSON-Schema via the `update.jobSchema` link. */
4320
+ /**
4321
+ * This interface was referenced by `Field`'s JSON-Schema via the
4322
+ * `update.jobSchema` link.
4323
+ */
4097
4324
  export interface FieldUpdateJobSchema {
4098
4325
  data: Field;
4099
4326
  included?: (ItemType | Field)[];
@@ -4166,7 +4393,8 @@ export interface FieldDuplicateJobSchema {
4166
4393
  }
4167
4394
 
4168
4395
  /**
4169
- * Fields can be organized and grouped into fieldset to better present them to editors.
4396
+ * Fields can be organized and grouped into fieldset to better present them to
4397
+ * editors.
4170
4398
  *
4171
4399
  * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
4172
4400
  * "fieldset".
@@ -4191,7 +4419,10 @@ export interface FieldsetAttributes {
4191
4419
  hint: string | null;
4192
4420
  /** Whether the fieldset can be collapsed or not */
4193
4421
  collapsible: boolean;
4194
- /** When fieldset is collapsible, determines if the default is to start collapsed or not */
4422
+ /**
4423
+ * When fieldset is collapsible, determines if the default is to start
4424
+ * collapsed or not
4425
+ */
4195
4426
  start_collapsed: boolean;
4196
4427
  /** Ordering index */
4197
4428
  position: number;
@@ -4210,7 +4441,10 @@ export interface FieldsetRelationships {
4210
4441
  };
4211
4442
  }
4212
4443
 
4213
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `create.schema` link. */
4444
+ /**
4445
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
4446
+ * `create.schema` link.
4447
+ */
4214
4448
  export interface FieldsetCreateSchema {
4215
4449
  data: {
4216
4450
  type: FieldsetType;
@@ -4241,7 +4475,10 @@ export interface FieldsetCreateTargetSchema {
4241
4475
  data: Fieldset;
4242
4476
  }
4243
4477
 
4244
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `update.schema` link. */
4478
+ /**
4479
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
4480
+ * `update.schema` link.
4481
+ */
4245
4482
  export interface FieldsetUpdateSchema {
4246
4483
  data: {
4247
4484
  type: FieldsetType;
@@ -4324,14 +4561,18 @@ export interface SessionRelationships {
4324
4561
  /**
4325
4562
  * JSON API data
4326
4563
  *
4327
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "data".
4564
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
4565
+ * "data".
4328
4566
  */
4329
4567
  export interface SessionData {
4330
4568
  type: SessionType;
4331
4569
  id: SessionIdentity;
4332
4570
  }
4333
4571
 
4334
- /** This interface was referenced by `Session`'s JSON-Schema via the `create.schema` link. */
4572
+ /**
4573
+ * This interface was referenced by `Session`'s JSON-Schema via the
4574
+ * `create.schema` link.
4575
+ */
4335
4576
  export interface SessionCreateSchema {
4336
4577
  data: {
4337
4578
  /** JSON API type field */
@@ -4359,9 +4600,11 @@ export interface SessionCreateTargetSchema {
4359
4600
 
4360
4601
  /**
4361
4602
  * Plugins enable developers to replace DatoCMS field components with HTML5
4362
- * applications so the editing experiences of the DatoCMS web app can be customized.
4603
+ * applications so the editing experiences of the DatoCMS web app can be
4604
+ * customized.
4363
4605
  *
4364
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "plugin".
4606
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
4607
+ * "plugin".
4365
4608
  */
4366
4609
  export interface Plugin {
4367
4610
  type: PluginType;
@@ -4431,7 +4674,8 @@ export interface PluginAttributes {
4431
4674
  /**
4432
4675
  * JSON API meta
4433
4676
  *
4434
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "meta".
4677
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
4678
+ * "meta".
4435
4679
  */
4436
4680
  export interface PluginMeta {
4437
4681
  /** Version of the plugin. Legacy plugins are v1, new plugins are v2 */
@@ -4441,14 +4685,18 @@ export interface PluginMeta {
4441
4685
  /**
4442
4686
  * JSON API data
4443
4687
  *
4444
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "data".
4688
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
4689
+ * "data".
4445
4690
  */
4446
4691
  export interface PluginData {
4447
4692
  type: PluginType;
4448
4693
  id: PluginIdentity;
4449
4694
  }
4450
4695
 
4451
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `create.schema` link. */
4696
+ /**
4697
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
4698
+ * `create.schema` link.
4699
+ */
4452
4700
  export interface PluginCreateSchema {
4453
4701
  data: {
4454
4702
  type: PluginType;
@@ -4458,7 +4706,10 @@ export interface PluginCreateSchema {
4458
4706
  * plugins, that's the only attribute you need to pass.
4459
4707
  */
4460
4708
  package_name?: null | string;
4461
- /** The name of the plugin. Only to be passed if package name key is not specified. */
4709
+ /**
4710
+ * The name of the plugin. Only to be passed if package name key is not
4711
+ * specified.
4712
+ */
4462
4713
  name?: string;
4463
4714
  /**
4464
4715
  * A description of the plugin. Only to be passed if package name key is
@@ -4523,7 +4774,10 @@ export interface PluginCreateTargetSchema {
4523
4774
  data: Plugin;
4524
4775
  }
4525
4776
 
4526
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `update.schema` link. */
4777
+ /**
4778
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
4779
+ * `update.schema` link.
4780
+ */
4527
4781
  export interface PluginUpdateSchema {
4528
4782
  data: {
4529
4783
  type: PluginType;
@@ -4623,7 +4877,8 @@ export interface JobResultAttributes {
4623
4877
  /**
4624
4878
  * JSON API data
4625
4879
  *
4626
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "data".
4880
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
4881
+ * `definition` "data".
4627
4882
  */
4628
4883
  export interface JobResultData {
4629
4884
  type: JobResultType;
@@ -4735,7 +4990,8 @@ export interface SubscriptionFeatureInstancesTargetSchema {
4735
4990
  }
4736
4991
 
4737
4992
  /**
4738
- * Represents an event occurred during the deploy process of your administrative area.
4993
+ * Represents an event occurred during the deploy process of your administrative
4994
+ * area.
4739
4995
  *
4740
4996
  * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
4741
4997
  * "build_event".
@@ -4829,7 +5085,8 @@ export interface BuildEventSelfTargetSchema {
4829
5085
  * records, which are much like table rows in a database. For
4830
5086
  * backward-compatibility reasons, the API refers to records as "items".
4831
5087
  *
4832
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "item".
5088
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
5089
+ * "item".
4833
5090
  */
4834
5091
  export interface Item {
4835
5092
  type: ItemType1;
@@ -4862,7 +5119,8 @@ export interface ItemRelationships {
4862
5119
  };
4863
5120
  /**
4864
5121
  * The entity (account/collaborator/access token/sso user) who created the
4865
- * record. It must be an object with `type` (e.g. 'account') and `id` properties.
5122
+ * record. It must be an object with `type` (e.g. 'account') and `id`
5123
+ * properties.
4866
5124
  */
4867
5125
  creator?: {
4868
5126
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -4872,7 +5130,8 @@ export interface ItemRelationships {
4872
5130
  /**
4873
5131
  * Meta information regarding the record
4874
5132
  *
4875
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "meta".
5133
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
5134
+ * "meta".
4876
5135
  */
4877
5136
  export interface ItemMeta {
4878
5137
  /** Date of creation */
@@ -4927,7 +5186,8 @@ export interface ItemValidateExistingSchema {
4927
5186
  };
4928
5187
  /**
4929
5188
  * The entity (account/collaborator/access token/sso user) who created the
4930
- * record. It must be an object with `type` (e.g. 'account') and `id` properties.
5189
+ * record. It must be an object with `type` (e.g. 'account') and `id`
5190
+ * properties.
4931
5191
  */
4932
5192
  creator?: {
4933
5193
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -4956,7 +5216,10 @@ export interface ItemValidateNewSchema {
4956
5216
  };
4957
5217
  }
4958
5218
 
4959
- /** This interface was referenced by `Item`'s JSON-Schema via the `create.schema` link. */
5219
+ /**
5220
+ * This interface was referenced by `Item`'s JSON-Schema via the `create.schema`
5221
+ * link.
5222
+ */
4960
5223
  export interface ItemCreateSchema {
4961
5224
  data: {
4962
5225
  type: ItemType1;
@@ -5018,7 +5281,10 @@ export interface ItemDuplicateJobSchema {
5018
5281
  included: ItemType[];
5019
5282
  }
5020
5283
 
5021
- /** This interface was referenced by `Item`'s JSON-Schema via the `update.schema` link. */
5284
+ /**
5285
+ * This interface was referenced by `Item`'s JSON-Schema via the `update.schema`
5286
+ * link.
5287
+ */
5022
5288
  export interface ItemUpdateSchema {
5023
5289
  data: {
5024
5290
  type: ItemType1;
@@ -5045,7 +5311,10 @@ export interface ItemUpdateSchema {
5045
5311
  status?: null | ('draft' | 'updated' | 'published');
5046
5312
  /** Whether the current record is valid or not */
5047
5313
  is_valid?: boolean;
5048
- /** The ID of the current record version (for optimistic locking, see the example) */
5314
+ /**
5315
+ * The ID of the current record version (for optimistic locking, see the
5316
+ * example)
5317
+ */
5049
5318
  current_version?: string;
5050
5319
  /** The new stage to move the record to */
5051
5320
  stage?: string | null;
@@ -5057,7 +5326,8 @@ export interface ItemUpdateSchema {
5057
5326
  };
5058
5327
  /**
5059
5328
  * The entity (account/collaborator/access token/sso user) who created the
5060
- * record. It must be an object with `type` (e.g. 'account') and `id` properties.
5329
+ * record. It must be an object with `type` (e.g. 'account') and `id`
5330
+ * properties.
5061
5331
  */
5062
5332
  creator?: {
5063
5333
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -5083,7 +5353,10 @@ export interface ItemReferencesTargetSchema {
5083
5353
  data: Item[];
5084
5354
  }
5085
5355
 
5086
- /** This interface was referenced by `Item`'s JSON-Schema via the `self.targetSchema` link. */
5356
+ /**
5357
+ * This interface was referenced by `Item`'s JSON-Schema via the
5358
+ * `self.targetSchema` link.
5359
+ */
5087
5360
  export interface ItemSelfTargetSchema {
5088
5361
  data: Item;
5089
5362
  }
@@ -5096,7 +5369,10 @@ export interface ItemDestroyTargetSchema {
5096
5369
  data: Job;
5097
5370
  }
5098
5371
 
5099
- /** This interface was referenced by `Item`'s JSON-Schema via the `destroy.jobSchema` link. */
5372
+ /**
5373
+ * This interface was referenced by `Item`'s JSON-Schema via the
5374
+ * `destroy.jobSchema` link.
5375
+ */
5100
5376
  export interface ItemDestroyJobSchema {
5101
5377
  data: Item;
5102
5378
  }
@@ -5450,7 +5726,8 @@ export interface ItemVersionSelfTargetSchema {
5450
5726
  /**
5451
5727
  * Every file you upload to DatoCMS will be retrievable from this endpoint.
5452
5728
  *
5453
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "upload".
5729
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
5730
+ * "upload".
5454
5731
  */
5455
5732
  export interface Upload {
5456
5733
  type: UploadType;
@@ -5510,7 +5787,8 @@ export interface UploadAttributes {
5510
5787
  default_field_metadata: {
5511
5788
  /**
5512
5789
  * This interface was referenced by `undefined`'s JSON-Schema definition via
5513
- * the `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
5790
+ * the `patternProperty`
5791
+ * "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
5514
5792
  */
5515
5793
  [k: string]: {
5516
5794
  /** Alternate text for the asset */
@@ -5578,14 +5856,18 @@ export interface UploadRelationships {
5578
5856
  /**
5579
5857
  * JSON API data
5580
5858
  *
5581
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "data".
5859
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
5860
+ * "data".
5582
5861
  */
5583
5862
  export interface UploadData {
5584
5863
  type: UploadType;
5585
5864
  id: UploadIdentity;
5586
5865
  }
5587
5866
 
5588
- /** This interface was referenced by `Upload`'s JSON-Schema via the `create.schema` link. */
5867
+ /**
5868
+ * This interface was referenced by `Upload`'s JSON-Schema via the
5869
+ * `create.schema` link.
5870
+ */
5589
5871
  export interface UploadCreateSchema {
5590
5872
  data: {
5591
5873
  type: UploadType;
@@ -5676,7 +5958,10 @@ export interface UploadDestroyTargetSchema {
5676
5958
  data: Upload;
5677
5959
  }
5678
5960
 
5679
- /** This interface was referenced by `Upload`'s JSON-Schema via the `update.schema` link. */
5961
+ /**
5962
+ * This interface was referenced by `Upload`'s JSON-Schema via the
5963
+ * `update.schema` link.
5964
+ */
5680
5965
  export interface UploadUpdateSchema {
5681
5966
  data: {
5682
5967
  type: UploadType;
@@ -5814,7 +6099,10 @@ export interface UploadReferencesTargetSchema {
5814
6099
  data: Item[];
5815
6100
  }
5816
6101
 
5817
- /** This interface was referenced by `Upload`'s JSON-Schema via the `bulk_tag.schema` link. */
6102
+ /**
6103
+ * This interface was referenced by `Upload`'s JSON-Schema via the
6104
+ * `bulk_tag.schema` link.
6105
+ */
5818
6106
  export interface UploadBulkTagSchema {
5819
6107
  data: {
5820
6108
  /** JSON API type field */
@@ -6381,23 +6669,33 @@ export interface WebhookAttributes {
6381
6669
  };
6382
6670
  /** All the events you will be notified for */
6383
6671
  events: unknown[];
6384
- /** Specifies which API version to use when serializing entities in the webhook payload */
6672
+ /**
6673
+ * Specifies which API version to use when serializing entities in the webhook
6674
+ * payload
6675
+ */
6385
6676
  payload_api_version: string;
6386
- /** Whether the you want records present in the payload to show blocks expanded or not */
6677
+ /**
6678
+ * Whether the you want records present in the payload to show blocks expanded
6679
+ * or not
6680
+ */
6387
6681
  nested_items_in_payload: boolean;
6388
6682
  }
6389
6683
 
6390
6684
  /**
6391
6685
  * JSON API data
6392
6686
  *
6393
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "data".
6687
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
6688
+ * "data".
6394
6689
  */
6395
6690
  export interface WebhookData {
6396
6691
  type: WebhookType;
6397
6692
  id: WebhookIdentity;
6398
6693
  }
6399
6694
 
6400
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `create.schema` link. */
6695
+ /**
6696
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
6697
+ * `create.schema` link.
6698
+ */
6401
6699
  export interface WebhookCreateSchema {
6402
6700
  data: {
6403
6701
  type: WebhookType;
@@ -6442,7 +6740,10 @@ export interface WebhookCreateTargetSchema {
6442
6740
  data: Webhook;
6443
6741
  }
6444
6742
 
6445
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `update.schema` link. */
6743
+ /**
6744
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
6745
+ * `update.schema` link.
6746
+ */
6446
6747
  export interface WebhookUpdateSchema {
6447
6748
  data: {
6448
6749
  type: WebhookType;
@@ -7318,7 +7619,10 @@ export interface SsoGroupCopyRolesTargetSchema {
7318
7619
  data: SsoGroup;
7319
7620
  }
7320
7621
 
7321
- /** This interface was referenced by `SsoGroup`'s JSON-Schema via the `update.schema` link. */
7622
+ /**
7623
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
7624
+ * `update.schema` link.
7625
+ */
7322
7626
  export interface SsoGroupUpdateSchema {
7323
7627
  data: {
7324
7628
  type: SsoGroupType;
@@ -7453,7 +7757,10 @@ export interface SsoSettingsUpdateSchema {
7453
7757
  idp_saml_metadata_url: null | string;
7454
7758
  };
7455
7759
  relationships: {
7456
- /** The default role assigned to SSO users that do not belong to any SSO group */
7760
+ /**
7761
+ * The default role assigned to SSO users that do not belong to any SSO
7762
+ * group
7763
+ */
7457
7764
  default_role: {
7458
7765
  data: RoleData;
7459
7766
  };
@@ -7567,7 +7874,10 @@ export interface PublicInfoAttributes {
7567
7874
  logo_url: null | string;
7568
7875
  /** Specifies whether the project is in white-label mode */
7569
7876
  white_label: boolean;
7570
- /** Template URL to download specific I18n messages (for white-label projects only) */
7877
+ /**
7878
+ * Template URL to download specific I18n messages (for white-label projects
7879
+ * only)
7880
+ */
7571
7881
  custom_i18n_messages_template_url: null | string;
7572
7882
  /** Specifies the color-scheme for the project */
7573
7883
  theme: {
@@ -7757,7 +8067,8 @@ export interface UploadTagAttributes {
7757
8067
  /**
7758
8068
  * JSON API data
7759
8069
  *
7760
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "data".
8070
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
8071
+ * `definition` "data".
7761
8072
  */
7762
8073
  export interface UploadTagData {
7763
8074
  type: UploadTagType;
@@ -7845,7 +8156,8 @@ export interface UploadSmartTagInstancesTargetSchema {
7845
8156
  /**
7846
8157
  * A site represents a specific DatoCMS administrative area
7847
8158
  *
7848
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "site".
8159
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
8160
+ * "site".
7849
8161
  */
7850
8162
  export interface Site {
7851
8163
  type: SiteType;
@@ -7965,7 +8277,8 @@ export interface SiteRelationships {
7965
8277
  /**
7966
8278
  * Meta attributes
7967
8279
  *
7968
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "meta".
8280
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
8281
+ * "meta".
7969
8282
  */
7970
8283
  export interface SiteMeta {
7971
8284
  /** Whether the Improved API Timezone Management option is active or not */
@@ -7975,20 +8288,27 @@ export interface SiteMeta {
7975
8288
  /**
7976
8289
  * JSON API data
7977
8290
  *
7978
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "data".
8291
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
8292
+ * "data".
7979
8293
  */
7980
8294
  export interface SiteData {
7981
8295
  type: SiteType;
7982
8296
  id: SiteIdentity;
7983
8297
  }
7984
8298
 
7985
- /** This interface was referenced by `Site`'s JSON-Schema via the `self.targetSchema` link. */
8299
+ /**
8300
+ * This interface was referenced by `Site`'s JSON-Schema via the
8301
+ * `self.targetSchema` link.
8302
+ */
7986
8303
  export interface SiteSelfTargetSchema {
7987
8304
  data: Site;
7988
8305
  included?: (ItemType | Field | Upload | Fieldset | Item | Account)[];
7989
8306
  }
7990
8307
 
7991
- /** This interface was referenced by `Site`'s JSON-Schema via the `update.schema` link. */
8308
+ /**
8309
+ * This interface was referenced by `Site`'s JSON-Schema via the `update.schema`
8310
+ * link.
8311
+ */
7992
8312
  export interface SiteUpdateSchema {
7993
8313
  data: {
7994
8314
  type: SiteType;
@@ -8064,7 +8384,10 @@ export interface SiteUpdateSchema {
8064
8384
  * two-factor authentication
8065
8385
  */
8066
8386
  require_2fa?: boolean;
8067
- /** Specifies whether you want IPs to be tracked in the Project usages section */
8387
+ /**
8388
+ * Specifies whether you want IPs to be tracked in the Project usages
8389
+ * section
8390
+ */
8068
8391
  ip_tracking_enabled?: boolean;
8069
8392
  };
8070
8393
  meta?: {
@@ -8087,7 +8410,10 @@ export interface SiteUpdateTargetSchema {
8087
8410
  data: Job;
8088
8411
  }
8089
8412
 
8090
- /** This interface was referenced by `Site`'s JSON-Schema via the `update.jobSchema` link. */
8413
+ /**
8414
+ * This interface was referenced by `Site`'s JSON-Schema via the
8415
+ * `update.jobSchema` link.
8416
+ */
8091
8417
  export interface SiteUpdateJobSchema {
8092
8418
  data: Site;
8093
8419
  }
@@ -8152,11 +8478,14 @@ export interface WorkflowAttributes {
8152
8478
  description?: string | null;
8153
8479
  /** Whether this is the initial stage or not */
8154
8480
  initial?: boolean;
8155
- }[]
8481
+ }[],
8156
8482
  ];
8157
8483
  }
8158
8484
 
8159
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `create.schema` link. */
8485
+ /**
8486
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
8487
+ * `create.schema` link.
8488
+ */
8160
8489
  export interface WorkflowCreateSchema {
8161
8490
  data: {
8162
8491
  type: WorkflowType;
@@ -8186,7 +8515,7 @@ export interface WorkflowCreateSchema {
8186
8515
  description?: string | null;
8187
8516
  /** Whether this is the initial stage or not */
8188
8517
  initial?: boolean;
8189
- }[]
8518
+ }[],
8190
8519
  ];
8191
8520
  };
8192
8521
  };
@@ -8200,7 +8529,10 @@ export interface WorkflowCreateTargetSchema {
8200
8529
  data: Workflow;
8201
8530
  }
8202
8531
 
8203
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `update.schema` link. */
8532
+ /**
8533
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
8534
+ * `update.schema` link.
8535
+ */
8204
8536
  export interface WorkflowUpdateSchema {
8205
8537
  data: {
8206
8538
  type: WorkflowType;
@@ -8230,7 +8562,7 @@ export interface WorkflowUpdateSchema {
8230
8562
  description?: string | null;
8231
8563
  /** Whether this is the initial stage or not */
8232
8564
  initial?: boolean;
8233
- }[]
8565
+ }[],
8234
8566
  ];
8235
8567
  };
8236
8568
  };