datocms-plugin-sdk 0.6.4 → 0.6.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (22) hide show
  1. package/dist/cjs/SiteApiSchema.js +4 -1
  2. package/dist/cjs/SiteApiSchema.js.map +1 -1
  3. package/dist/cjs/connect.js.map +1 -1
  4. package/dist/cjs/guards.js.map +1 -1
  5. package/dist/cjs/index.js +5 -1
  6. package/dist/cjs/index.js.map +1 -1
  7. package/dist/esm/SiteApiSchema.d.ts +650 -318
  8. package/dist/esm/SiteApiSchema.js +4 -1
  9. package/dist/esm/SiteApiSchema.js.map +1 -1
  10. package/dist/esm/connect.d.ts +10 -5
  11. package/dist/esm/connect.js.map +1 -1
  12. package/dist/esm/guards.js.map +1 -1
  13. package/dist/esm/types.d.ts +80 -22
  14. package/dist/types/SiteApiSchema.d.ts +650 -318
  15. package/dist/types/connect.d.ts +10 -5
  16. package/dist/types/types.d.ts +80 -22
  17. package/package.json +3 -3
  18. package/src/SiteApiSchema.ts +653 -321
  19. package/src/connect.ts +14 -9
  20. package/src/guards.ts +14 -18
  21. package/src/types.ts +86 -30
  22. package/types.json +12210 -5042
package/dist/esm/SiteApiSchema.d.ts CHANGED
@@ -1,16 +1,22 @@
1
- /** This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT BY HAND. */
1
+ /**
2
+ * This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT
3
+ * BY HAND.
4
+ */
2
5
  /**
3
6
  * JSON API type field
4
7
  *
5
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "type".
8
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
9
+ * "type".
6
10
  */
7
11
  export declare type RoleType = 'role';
8
12
  /**
9
13
  * ID of role
10
14
  *
11
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "identity".
15
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
16
+ * "identity".
12
17
  *
13
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "id".
18
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
19
+ * "id".
14
20
  */
15
21
  export declare type RoleIdentity = string;
16
22
  /**
@@ -19,7 +25,8 @@ export declare type RoleIdentity = string;
19
25
  * This interface was referenced by `ItemType`'s JSON-Schema via the
20
26
  * `definition` "identity".
21
27
  *
22
- * This interface was referenced by `ItemType`'s JSON-Schema via the `definition` "id".
28
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
29
+ * `definition` "id".
23
30
  */
24
31
  export declare type ItemTypeIdentity = string;
25
32
  /**
@@ -28,7 +35,8 @@ export declare type ItemTypeIdentity = string;
28
35
  * This interface was referenced by `Workflow`'s JSON-Schema via the
29
36
  * `definition` "identity".
30
37
  *
31
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "id".
38
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
39
+ * `definition` "id".
32
40
  */
33
41
  export declare type WorkflowIdentity = string;
34
42
  /**
@@ -37,7 +45,8 @@ export declare type WorkflowIdentity = string;
37
45
  * This interface was referenced by `Environment`'s JSON-Schema via the
38
46
  * `definition` "identity".
39
47
  *
40
- * This interface was referenced by `Environment`'s JSON-Schema via the `definition` "id".
48
+ * This interface was referenced by `Environment`'s JSON-Schema via the
49
+ * `definition` "id".
41
50
  */
42
51
  export declare type EnvironmentIdentity = string;
43
52
  /**
@@ -53,23 +62,30 @@ export declare type BuildTriggerIdentity = string;
53
62
  /**
54
63
  * JSON API type field
55
64
  *
56
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "type".
65
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
66
+ * "type".
57
67
  */
58
68
  export declare type UserType = 'user';
59
69
  /**
60
70
  * ID of collaborator
61
71
  *
62
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "identity".
72
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
73
+ * "identity".
63
74
  *
64
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "id".
75
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
76
+ * "id".
65
77
  */
66
78
  export declare type UserIdentity = string;
67
- /** This interface was referenced by `User`'s JSON-Schema via the `self.hrefSchema` link. */
79
+ /**
80
+ * This interface was referenced by `User`'s JSON-Schema via the
81
+ * `self.hrefSchema` link.
82
+ */
68
83
  export declare type UserSelfHrefSchema = {
69
84
  /**
70
85
  * Comma-separated list of [relationship
71
86
  * paths](https://jsonapi.org/format/#fetching-includes). A relationship path
72
- * is a dot-separated list of relationship names. Allowed relationship paths: `role`.
87
+ * is a dot-separated list of relationship names. Allowed relationship paths:
88
+ * `role`.
73
89
  */
74
90
  include?: string;
75
91
  [k: string]: unknown;
@@ -77,7 +93,8 @@ export declare type UserSelfHrefSchema = {
77
93
  /**
78
94
  * JSON API type field
79
95
  *
80
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "type".
96
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
97
+ * "type".
81
98
  */
82
99
  export declare type SsoUserType = 'sso_user';
83
100
  /**
@@ -86,13 +103,15 @@ export declare type SsoUserType = 'sso_user';
86
103
  * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
87
104
  * "identity".
88
105
  *
89
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "id".
106
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
107
+ * "id".
90
108
  */
91
109
  export declare type SsoUserIdentity = string;
92
110
  /**
93
111
  * JSON API type field
94
112
  *
95
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "type".
113
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
114
+ * `definition` "type".
96
115
  */
97
116
  export declare type SsoGroupType = 'sso_group';
98
117
  /**
@@ -101,7 +120,8 @@ export declare type SsoGroupType = 'sso_group';
101
120
  * This interface was referenced by `SsoGroup`'s JSON-Schema via the
102
121
  * `definition` "identity".
103
122
  *
104
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "id".
123
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
124
+ * `definition` "id".
105
125
  */
106
126
  export declare type SsoGroupIdentity = string;
107
127
  /**
@@ -134,7 +154,8 @@ export declare type AccessTokenType = 'access_token';
134
154
  * This interface was referenced by `AccessToken`'s JSON-Schema via the
135
155
  * `definition` "identity".
136
156
  *
137
- * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "id".
157
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
158
+ * `definition` "id".
138
159
  */
139
160
  export declare type AccessTokenIdentity = string;
140
161
  /**
@@ -157,7 +178,8 @@ export declare type AccessTokenDestroyHrefSchema = {
157
178
  /**
158
179
  * JSON API type field
159
180
  *
160
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "type".
181
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
182
+ * "type".
161
183
  */
162
184
  export declare type AccountType = 'account';
163
185
  /**
@@ -166,15 +188,20 @@ export declare type AccountType = 'account';
166
188
  * This interface was referenced by `Account`'s JSON-Schema via the `definition`
167
189
  * "identity".
168
190
  *
169
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "id".
191
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
192
+ * "id".
170
193
  */
171
194
  export declare type AccountIdentity = string;
172
- /** This interface was referenced by `User`'s JSON-Schema via the `me.hrefSchema` link. */
195
+ /**
196
+ * This interface was referenced by `User`'s JSON-Schema via the `me.hrefSchema`
197
+ * link.
198
+ */
173
199
  export declare type UserMeHrefSchema = {
174
200
  /**
175
201
  * Comma-separated list of [relationship
176
202
  * paths](https://jsonapi.org/format/#fetching-includes). A relationship path
177
- * is a dot-separated list of relationship names. Allowed relationship paths: `role`.
203
+ * is a dot-separated list of relationship names. Allowed relationship paths:
204
+ * `role`.
178
205
  */
179
206
  include?: string;
180
207
  [k: string]: unknown;
@@ -216,7 +243,8 @@ export declare type AuditLogEventIdentity = string;
216
243
  /**
217
244
  * JSON API type field
218
245
  *
219
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "type".
246
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
247
+ * `definition` "type".
220
248
  */
221
249
  export declare type SitePlanType = 'site_plan';
222
250
  /**
@@ -225,13 +253,15 @@ export declare type SitePlanType = 'site_plan';
225
253
  * This interface was referenced by `SitePlan`'s JSON-Schema via the
226
254
  * `definition` "identity".
227
255
  *
228
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "id".
256
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
257
+ * `definition` "id".
229
258
  */
230
259
  export declare type SitePlanIdentity = string;
231
260
  /**
232
261
  * JSON API type field
233
262
  *
234
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "type".
263
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
264
+ * `definition` "type".
235
265
  */
236
266
  export declare type MenuItemType = 'menu_item';
237
267
  /**
@@ -240,13 +270,15 @@ export declare type MenuItemType = 'menu_item';
240
270
  * This interface was referenced by `MenuItem`'s JSON-Schema via the
241
271
  * `definition` "identity".
242
272
  *
243
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "id".
273
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
274
+ * `definition` "id".
244
275
  */
245
276
  export declare type MenuItemIdentity = string;
246
277
  /**
247
278
  * JSON API type field
248
279
  *
249
- * This interface was referenced by `ItemType`'s JSON-Schema via the `definition` "type".
280
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
281
+ * `definition` "type".
250
282
  */
251
283
  export declare type ItemTypeType = 'item_type';
252
284
  /**
@@ -262,35 +294,42 @@ export declare type MenuItemInstancesHrefSchema = {
262
294
  /**
263
295
  * JSON API type field
264
296
  *
265
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "type".
297
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
298
+ * "type".
266
299
  */
267
300
  export declare type ItemType1 = 'item';
268
301
  /**
269
302
  * ID of record
270
303
  *
271
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "identity".
304
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
305
+ * "identity".
272
306
  *
273
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "id".
307
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
308
+ * "id".
274
309
  */
275
310
  export declare type ItemIdentity = string;
276
311
  /**
277
312
  * JSON API type field
278
313
  *
279
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "type".
314
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
315
+ * "type".
280
316
  */
281
317
  export declare type FieldType = 'field';
282
318
  /**
283
319
  * ID of field
284
320
  *
285
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "identity".
321
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
322
+ * "identity".
286
323
  *
287
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "id".
324
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
325
+ * "id".
288
326
  */
289
327
  export declare type FieldIdentity = string;
290
328
  /**
291
329
  * JSON API type fieldset
292
330
  *
293
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "type".
331
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
332
+ * `definition` "type".
294
333
  */
295
334
  export declare type FieldsetType = 'fieldset';
296
335
  /**
@@ -299,33 +338,39 @@ export declare type FieldsetType = 'fieldset';
299
338
  * This interface was referenced by `Fieldset`'s JSON-Schema via the
300
339
  * `definition` "identity".
301
340
  *
302
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "id".
341
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
342
+ * `definition` "id".
303
343
  */
304
344
  export declare type FieldsetIdentity = string;
305
345
  /**
306
346
  * JSON API type field
307
347
  *
308
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "type".
348
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
349
+ * `definition` "type".
309
350
  */
310
351
  export declare type WorkflowType = 'workflow';
311
352
  /**
312
353
  * JSON API type field
313
354
  *
314
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "type".
355
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
356
+ * "type".
315
357
  */
316
358
  export declare type JobType = 'job';
317
359
  /**
318
360
  * ID of job
319
361
  *
320
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "identity".
362
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
363
+ * "identity".
321
364
  *
322
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "id".
365
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
366
+ * "id".
323
367
  */
324
368
  export declare type JobIdentity = string;
325
369
  /**
326
370
  * JSON API type field
327
371
  *
328
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "type".
372
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
373
+ * "type".
329
374
  */
330
375
  export declare type SessionType = 'session';
331
376
  /**
@@ -334,13 +379,15 @@ export declare type SessionType = 'session';
334
379
  * This interface was referenced by `Session`'s JSON-Schema via the `definition`
335
380
  * "identity".
336
381
  *
337
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "id".
382
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
383
+ * "id".
338
384
  */
339
385
  export declare type SessionIdentity = string;
340
386
  /**
341
387
  * JSON API type field
342
388
  *
343
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "type".
389
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
390
+ * "type".
344
391
  */
345
392
  export declare type PluginType = 'plugin';
346
393
  /**
@@ -349,13 +396,15 @@ export declare type PluginType = 'plugin';
349
396
  * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
350
397
  * "identity".
351
398
  *
352
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "id".
399
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
400
+ * "id".
353
401
  */
354
402
  export declare type PluginIdentity = string;
355
403
  /**
356
404
  * JSON API type field
357
405
  *
358
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "type".
406
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
407
+ * `definition` "type".
359
408
  */
360
409
  export declare type JobResultType = 'job_result';
361
410
  /**
@@ -364,7 +413,8 @@ export declare type JobResultType = 'job_result';
364
413
  * This interface was referenced by `JobResult`'s JSON-Schema via the
365
414
  * `definition` "identity".
366
415
  *
367
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "id".
416
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
417
+ * `definition` "id".
368
418
  */
369
419
  export declare type JobResultIdentity = string;
370
420
  /**
@@ -414,7 +464,8 @@ export declare type BuildEventType = 'build_event';
414
464
  * This interface was referenced by `BuildEvent`'s JSON-Schema via the
415
465
  * `definition` "identity".
416
466
  *
417
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "id".
467
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
468
+ * `definition` "id".
418
469
  */
419
470
  export declare type BuildEventIdentity = string;
420
471
  /**
@@ -438,17 +489,17 @@ export declare type ItemInstancesHrefSchema = {
438
489
  filter?: {
439
490
  /**
440
491
  * Record (or block record) IDs to fetch, comma separated. If you use this
441
- * filter, you *must not* use `filter[type]` or `filter[fields]`
492
+ * filter, you _must not_ use `filter[type]` or `filter[fields]`
442
493
  */
443
494
  ids?: string;
444
495
  /**
445
- * Model ID or `api_key` to filter. If you use this filter, you *must not*
446
- * use `filter[ids]`. Comma separated values are accepted, but you *must
447
- * not* use `filter[fields]` in this case
496
+ * Model ID or `api_key` to filter. If you use this filter, you _must not_
497
+ * use `filter[ids]`. Comma separated values are accepted, but you _must
498
+ * not_ use `filter[fields]` in this case
448
499
  */
449
500
  type?: string;
450
501
  /**
451
- * Textual query to match. You *must not* use `filter[ids]`. If `locale` is
502
+ * Textual query to match. You _must not_ use `filter[ids]`. If `locale` is
452
503
  * defined, search within that locale. Otherwise environment's main locale
453
504
  * will be used.
454
505
  */
@@ -478,9 +529,10 @@ export declare type ItemInstancesHrefSchema = {
478
529
  [k: string]: unknown;
479
530
  };
480
531
  /**
481
- * Fields used to order results. You *must* specify also `filter[type]` with
532
+ * Fields used to order results. You _must_ specify also `filter[type]` with
482
533
  * one element only to be able use this option. Format:
483
- * `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
534
+ * `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated
535
+ * rules
484
536
  */
485
537
  order_by?: string;
486
538
  /**
@@ -507,7 +559,10 @@ export declare type ItemReferencesHrefSchema = {
507
559
  version?: null | ('current' | 'published' | 'published-or-current');
508
560
  [k: string]: unknown;
509
561
  };
510
- /** This interface was referenced by `Item`'s JSON-Schema via the `self.hrefSchema` link. */
562
+ /**
563
+ * This interface was referenced by `Item`'s JSON-Schema via the
564
+ * `self.hrefSchema` link.
565
+ */
511
566
  export declare type ItemSelfHrefSchema = {
512
567
  /**
513
568
  * For Modular Content fields and Structured Text fields. If set, returns full
@@ -559,7 +614,10 @@ export declare type ItemPublishHrefSchema = {
559
614
  * `unpublish.hrefSchema` link.
560
615
  */
561
616
  export declare type ItemUnpublishHrefSchema = {
562
- /** If the record is referenced by other published records, unpublish them recursively */
617
+ /**
618
+ * If the record is referenced by other published records, unpublish them
619
+ * recursively
620
+ */
563
621
  recursive?: string;
564
622
  [k: string]: unknown;
565
623
  };
@@ -576,7 +634,8 @@ export declare type ItemVersionType = 'item_version';
576
634
  * This interface was referenced by `ItemVersion`'s JSON-Schema via the
577
635
  * `definition` "identity".
578
636
  *
579
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "id".
637
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
638
+ * `definition` "id".
580
639
  */
581
640
  export declare type ItemVersionIdentity = string;
582
641
  /**
@@ -602,7 +661,8 @@ export declare type ItemVersionInstancesHrefSchema = {
602
661
  /**
603
662
  * JSON API type upload
604
663
  *
605
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "type".
664
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
665
+ * "type".
606
666
  */
607
667
  export declare type UploadType = 'upload';
608
668
  /**
@@ -611,7 +671,8 @@ export declare type UploadType = 'upload';
611
671
  * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
612
672
  * "identity".
613
673
  *
614
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "id".
674
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
675
+ * "id".
615
676
  */
616
677
  export declare type UploadIdentity = string;
617
678
  /**
@@ -815,7 +876,8 @@ export declare type MaintenanceModeActivateHrefSchema = {
815
876
  /**
816
877
  * JSON API type field
817
878
  *
818
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "type".
879
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
880
+ * "type".
819
881
  */
820
882
  export declare type WebhookType = 'webhook';
821
883
  /**
@@ -824,7 +886,8 @@ export declare type WebhookType = 'webhook';
824
886
  * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
825
887
  * "identity".
826
888
  *
827
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "id".
889
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
890
+ * "id".
828
891
  */
829
892
  export declare type WebhookIdentity = string;
830
893
  /**
@@ -840,7 +903,8 @@ export declare type WebhookCallType = 'webhook_call';
840
903
  * This interface was referenced by `WebhookCall`'s JSON-Schema via the
841
904
  * `definition` "identity".
842
905
  *
843
- * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "id".
906
+ * This interface was referenced by `WebhookCall`'s JSON-Schema via the
907
+ * `definition` "id".
844
908
  */
845
909
  export declare type WebhookCallIdentity = string;
846
910
  /**
@@ -939,7 +1003,8 @@ export declare type SsoSettingsType = 'sso_settings';
939
1003
  * This interface was referenced by `SsoSettings`'s JSON-Schema via the
940
1004
  * `definition` "identity".
941
1005
  *
942
- * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "id".
1006
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
1007
+ * `definition` "id".
943
1008
  */
944
1009
  export declare type SsoSettingsIdentity = string;
945
1010
  /**
@@ -972,7 +1037,8 @@ export declare type PublicInfoType = 'public_info';
972
1037
  * This interface was referenced by `PublicInfo`'s JSON-Schema via the
973
1038
  * `definition` "identity".
974
1039
  *
975
- * This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "id".
1040
+ * This interface was referenced by `PublicInfo`'s JSON-Schema via the
1041
+ * `definition` "id".
976
1042
  */
977
1043
  export declare type PublicInfoIdentity = string;
978
1044
  /**
@@ -988,7 +1054,8 @@ export declare type DailyUsageType = 'daily_usage';
988
1054
  * This interface was referenced by `DailyUsage`'s JSON-Schema via the
989
1055
  * `definition` "identity".
990
1056
  *
991
- * This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "id".
1057
+ * This interface was referenced by `DailyUsage`'s JSON-Schema via the
1058
+ * `definition` "id".
992
1059
  */
993
1060
  export declare type DailyUsageIdentity = string;
994
1061
  /**
@@ -1019,7 +1086,8 @@ export declare type UsageCounterSelfHrefSchema = {
1019
1086
  /**
1020
1087
  * JSON API type field
1021
1088
  *
1022
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "type".
1089
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
1090
+ * `definition` "type".
1023
1091
  */
1024
1092
  export declare type UploadTagType = 'upload_tag';
1025
1093
  /**
@@ -1028,7 +1096,8 @@ export declare type UploadTagType = 'upload_tag';
1028
1096
  * This interface was referenced by `UploadTag`'s JSON-Schema via the
1029
1097
  * `definition` "identity".
1030
1098
  *
1031
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "id".
1099
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
1100
+ * `definition` "id".
1032
1101
  */
1033
1102
  export declare type UploadTagIdentity = string;
1034
1103
  /**
@@ -1093,18 +1162,24 @@ export declare type UploadSmartTagInstancesHrefSchema = {
1093
1162
  /**
1094
1163
  * JSON API type field
1095
1164
  *
1096
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "type".
1165
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
1166
+ * "type".
1097
1167
  */
1098
1168
  export declare type SiteType = 'site';
1099
1169
  /**
1100
1170
  * ID of site
1101
1171
  *
1102
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "identity".
1172
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
1173
+ * "identity".
1103
1174
  *
1104
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "id".
1175
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
1176
+ * "id".
1105
1177
  */
1106
1178
  export declare type SiteIdentity = string;
1107
- /** This interface was referenced by `Site`'s JSON-Schema via the `self.hrefSchema` link. */
1179
+ /**
1180
+ * This interface was referenced by `Site`'s JSON-Schema via the
1181
+ * `self.hrefSchema` link.
1182
+ */
1108
1183
  export declare type SiteSelfHrefSchema = {
1109
1184
  /**
1110
1185
  * Comma-separated list of [relationship
@@ -1167,7 +1242,8 @@ export interface DatoApi {
1167
1242
  * A Role represents a specific set of actions an editor (or an API token) can
1168
1243
  * perform on your administrative area.
1169
1244
  *
1170
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "role".
1245
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
1246
+ * "role".
1171
1247
  */
1172
1248
  export interface Role {
1173
1249
  type: RoleType;
@@ -1207,7 +1283,10 @@ export interface RoleAttributes {
1207
1283
  can_manage_build_triggers: boolean;
1208
1284
  /** Can create/edit webhooks */
1209
1285
  can_manage_webhooks: boolean;
1210
- /** Can create/delete sandbox environments and promote them to primary environment */
1286
+ /**
1287
+ * Can create/delete sandbox environments and promote them to primary
1288
+ * environment
1289
+ */
1211
1290
  can_manage_environments: boolean;
1212
1291
  /** Can manage Single Sign-On settings */
1213
1292
  can_manage_sso: boolean;
@@ -1313,7 +1392,8 @@ export interface RoleRelationships {
1313
1392
  /**
1314
1393
  * JSON API data
1315
1394
  *
1316
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "data".
1395
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
1396
+ * "data".
1317
1397
  */
1318
1398
  export interface RoleData {
1319
1399
  type: RoleType;
@@ -1322,7 +1402,8 @@ export interface RoleData {
1322
1402
  /**
1323
1403
  * Meta information regarding the record
1324
1404
  *
1325
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "meta".
1405
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
1406
+ * "meta".
1326
1407
  */
1327
1408
  export interface RoleMeta {
1328
1409
  /** The final set of permissions considering also inherited roles */
@@ -1349,7 +1430,10 @@ export interface RoleMeta {
1349
1430
  can_manage_build_triggers: boolean;
1350
1431
  /** Can create/edit webhooks */
1351
1432
  can_manage_webhooks: boolean;
1352
- /** Can create/delete sandbox environments and promote them to primary environment */
1433
+ /**
1434
+ * Can create/delete sandbox environments and promote them to primary
1435
+ * environment
1436
+ */
1353
1437
  can_manage_environments: boolean;
1354
1438
  /** Can manage Single Sign-On settings */
1355
1439
  can_manage_sso: boolean;
@@ -1441,7 +1525,10 @@ export interface RoleMeta {
1441
1525
  }[];
1442
1526
  };
1443
1527
  }
1444
- /** This interface was referenced by `Role`'s JSON-Schema via the `create.schema` link. */
1528
+ /**
1529
+ * This interface was referenced by `Role`'s JSON-Schema via the `create.schema`
1530
+ * link.
1531
+ */
1445
1532
  export interface RoleCreateSchema {
1446
1533
  data: {
1447
1534
  type: RoleType;
@@ -1471,7 +1558,10 @@ export interface RoleCreateSchema {
1471
1558
  can_manage_build_triggers?: boolean;
1472
1559
  /** Can create/edit webhooks */
1473
1560
  can_manage_webhooks?: boolean;
1474
- /** Can create/delete sandbox environments and promote them to primary environment */
1561
+ /**
1562
+ * Can create/delete sandbox environments and promote them to primary
1563
+ * environment
1564
+ */
1475
1565
  can_manage_environments?: boolean;
1476
1566
  /** Can manage Single Sign-On settings */
1477
1567
  can_manage_sso?: boolean;
@@ -1579,7 +1669,10 @@ export interface RoleCreateSchema {
1579
1669
  export interface RoleCreateTargetSchema {
1580
1670
  data: Role;
1581
1671
  }
1582
- /** This interface was referenced by `Role`'s JSON-Schema via the `update.schema` link. */
1672
+ /**
1673
+ * This interface was referenced by `Role`'s JSON-Schema via the `update.schema`
1674
+ * link.
1675
+ */
1583
1676
  export interface RoleUpdateSchema {
1584
1677
  data: {
1585
1678
  type: RoleType;
@@ -1610,7 +1703,10 @@ export interface RoleUpdateSchema {
1610
1703
  can_manage_build_triggers?: boolean;
1611
1704
  /** Can create/edit webhooks */
1612
1705
  can_manage_webhooks?: boolean;
1613
- /** Can create/delete sandbox environments and promote them to primary environment */
1706
+ /**
1707
+ * Can create/delete sandbox environments and promote them to primary
1708
+ * environment
1709
+ */
1614
1710
  can_manage_environments?: boolean;
1615
1711
  /** Can manage Single Sign-On settings */
1616
1712
  can_manage_sso?: boolean;
@@ -1725,7 +1821,10 @@ export interface RoleUpdateTargetSchema {
1725
1821
  export interface RoleInstancesTargetSchema {
1726
1822
  data: Role[];
1727
1823
  }
1728
- /** This interface was referenced by `Role`'s JSON-Schema via the `self.targetSchema` link. */
1824
+ /**
1825
+ * This interface was referenced by `Role`'s JSON-Schema via the
1826
+ * `self.targetSchema` link.
1827
+ */
1729
1828
  export interface RoleSelfTargetSchema {
1730
1829
  data: Role;
1731
1830
  }
@@ -1741,7 +1840,8 @@ export interface RoleDestroyTargetSchema {
1741
1840
  * collaborator is linked to a specific Role, which describes what actions it
1742
1841
  * will be able to perform once logged in.
1743
1842
  *
1744
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "user".
1843
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
1844
+ * "user".
1745
1845
  */
1746
1846
  export interface User {
1747
1847
  type: UserType;
@@ -1781,7 +1881,8 @@ export interface UserRelationships {
1781
1881
  /**
1782
1882
  * Meta information on the user
1783
1883
  *
1784
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "meta".
1884
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
1885
+ * "meta".
1785
1886
  */
1786
1887
  export interface UserMeta {
1787
1888
  /** Date of last reading/interaction */
@@ -1790,13 +1891,17 @@ export interface UserMeta {
1790
1891
  /**
1791
1892
  * JSON API data
1792
1893
  *
1793
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "data".
1894
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
1895
+ * "data".
1794
1896
  */
1795
1897
  export interface UserData {
1796
1898
  type: UserType;
1797
1899
  id: UserIdentity;
1798
1900
  }
1799
- /** This interface was referenced by `User`'s JSON-Schema via the `update.schema` link. */
1901
+ /**
1902
+ * This interface was referenced by `User`'s JSON-Schema via the `update.schema`
1903
+ * link.
1904
+ */
1800
1905
  export interface UserUpdateSchema {
1801
1906
  data: {
1802
1907
  type: UserType;
@@ -1827,12 +1932,18 @@ export interface UserUpdateTargetSchema {
1827
1932
  export interface UserInstancesTargetSchema {
1828
1933
  data: User[];
1829
1934
  }
1830
- /** This interface was referenced by `User`'s JSON-Schema via the `self.targetSchema` link. */
1935
+ /**
1936
+ * This interface was referenced by `User`'s JSON-Schema via the
1937
+ * `self.targetSchema` link.
1938
+ */
1831
1939
  export interface UserSelfTargetSchema {
1832
1940
  data: User;
1833
1941
  included?: Role[];
1834
1942
  }
1835
- /** This interface was referenced by `User`'s JSON-Schema via the `me.targetSchema` link. */
1943
+ /**
1944
+ * This interface was referenced by `User`'s JSON-Schema via the
1945
+ * `me.targetSchema` link.
1946
+ */
1836
1947
  export interface UserMeTargetSchema {
1837
1948
  data: User | SsoUser | AccessToken | Account;
1838
1949
  included?: Role[];
@@ -1893,7 +2004,8 @@ export interface SsoUserRelationships {
1893
2004
  /**
1894
2005
  * JSON API data
1895
2006
  *
1896
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "data".
2007
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
2008
+ * `definition` "data".
1897
2009
  */
1898
2010
  export interface SsoGroupData {
1899
2011
  type: SsoGroupType;
@@ -1902,7 +2014,8 @@ export interface SsoGroupData {
1902
2014
  /**
1903
2015
  * Meta information on the user
1904
2016
  *
1905
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "meta".
2017
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
2018
+ * "meta".
1906
2019
  */
1907
2020
  export interface SsoUserMeta {
1908
2021
  /** Date of last reading/interaction */
@@ -1911,7 +2024,8 @@ export interface SsoUserMeta {
1911
2024
  /**
1912
2025
  * JSON API data
1913
2026
  *
1914
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "data".
2027
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
2028
+ * "data".
1915
2029
  */
1916
2030
  export interface SsoUserData {
1917
2031
  type: SsoUserType;
@@ -1972,9 +2086,15 @@ export interface AccessTokenAttributes {
1972
2086
  * the token)
1973
2087
  */
1974
2088
  token?: null | string;
1975
- /** Whether this API token can access the Content Delivery API published content endpoint */
2089
+ /**
2090
+ * Whether this API token can access the Content Delivery API published
2091
+ * content endpoint
2092
+ */
1976
2093
  can_access_cda: boolean;
1977
- /** Whether this API token can access the Content Delivery API draft content endpoint */
2094
+ /**
2095
+ * Whether this API token can access the Content Delivery API draft content
2096
+ * endpoint
2097
+ */
1978
2098
  can_access_cda_preview: boolean;
1979
2099
  /** Whether this API token can access the Content Management API */
1980
2100
  can_access_cma: boolean;
@@ -2017,7 +2137,10 @@ export interface AccessTokenCreateSchema {
2017
2137
  * content endpoint
2018
2138
  */
2019
2139
  can_access_cda: boolean;
2020
- /** Whether this API token can access the Content Delivery API draft content endpoint */
2140
+ /**
2141
+ * Whether this API token can access the Content Delivery API draft
2142
+ * content endpoint
2143
+ */
2021
2144
  can_access_cda_preview: boolean;
2022
2145
  /** Whether this API token can access the Content Management API */
2023
2146
  can_access_cma: boolean;
@@ -2053,7 +2176,10 @@ export interface AccessTokenUpdateSchema {
2053
2176
  * content endpoint
2054
2177
  */
2055
2178
  can_access_cda: boolean;
2056
- /** Whether this API token can access the Content Delivery API draft content endpoint */
2179
+ /**
2180
+ * Whether this API token can access the Content Delivery API draft
2181
+ * content endpoint
2182
+ */
2057
2183
  can_access_cda_preview: boolean;
2058
2184
  /** Whether this API token can access the Content Management API */
2059
2185
  can_access_cma: boolean;
@@ -2133,7 +2259,8 @@ export interface AccountAttributes {
2133
2259
  /**
2134
2260
  * JSON API data
2135
2261
  *
2136
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "data".
2262
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
2263
+ * "data".
2137
2264
  */
2138
2265
  export interface AccountData {
2139
2266
  type: AccountType;
@@ -2171,7 +2298,10 @@ export interface AuditLogEventAttributes {
2171
2298
  action_name: string;
2172
2299
  /** The actor who performed the action */
2173
2300
  actor: {
2174
- /** The type of actor (can be `account`, `user`, `sso_user` or `access_token`) */
2301
+ /**
2302
+ * The type of actor (can be `account`, `user`, `sso_user` or
2303
+ * `access_token`)
2304
+ */
2175
2305
  type: string;
2176
2306
  /** The ID of the actor */
2177
2307
  id: string;
@@ -2192,7 +2322,10 @@ export interface AuditLogEventAttributes {
2192
2322
  environment: {
2193
2323
  /** The ID of the environment */
2194
2324
  id: string;
2195
- /** Whether the environment was the primary one at the time the action was performed */
2325
+ /**
2326
+ * Whether the environment was the primary one at the time the action was
2327
+ * performed
2328
+ */
2196
2329
  primary: boolean;
2197
2330
  };
2198
2331
  /** The actual request being performed */
@@ -2324,13 +2457,19 @@ export interface SitePlanAttributes {
2324
2457
  * Delivery API and content consumers
2325
2458
  */
2326
2459
  traffic_bytes: null | number;
2327
- /** The number of requests made to both our Content Management and Content Delivery APIs */
2460
+ /**
2461
+ * The number of requests made to both our Content Management and Content
2462
+ * Delivery APIs
2463
+ */
2328
2464
  api_calls: null | number;
2329
2465
  /** The number of streaming seconds delivered by Mux.com */
2330
2466
  mux_streaming_seconds: null | number;
2331
2467
  /** The number of available encoding seconds to Mux.com */
2332
2468
  mux_encoding_seconds: null | number;
2333
- /** The number of different API tokens you can generate, each which different permissions */
2469
+ /**
2470
+ * The number of different API tokens you can generate, each which different
2471
+ * permissions
2472
+ */
2334
2473
  access_tokens: null | number;
2335
2474
  /** Number of roles allowed */
2336
2475
  roles: null | number;
@@ -2434,7 +2573,8 @@ export interface SitePlanAttributes {
2434
2573
  /**
2435
2574
  * JSON API data
2436
2575
  *
2437
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "data".
2576
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
2577
+ * `definition` "data".
2438
2578
  */
2439
2579
  export interface SitePlanData {
2440
2580
  type: SitePlanType;
@@ -2493,7 +2633,8 @@ export interface MenuItemRelationships {
2493
2633
  /**
2494
2634
  * JSON API data
2495
2635
  *
2496
- * This interface was referenced by `ItemType`'s JSON-Schema via the `definition` "data".
2636
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
2637
+ * `definition` "data".
2497
2638
  */
2498
2639
  export interface ItemTypeData {
2499
2640
  type: ItemTypeType;
@@ -2502,13 +2643,17 @@ export interface ItemTypeData {
2502
2643
  /**
2503
2644
  * JSON API data
2504
2645
  *
2505
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "data".
2646
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2647
+ * `definition` "data".
2506
2648
  */
2507
2649
  export interface MenuItemData {
2508
2650
  type: MenuItemType;
2509
2651
  id: MenuItemIdentity;
2510
2652
  }
2511
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `create.schema` link. */
2653
+ /**
2654
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2655
+ * `create.schema` link.
2656
+ */
2512
2657
  export interface MenuItemCreateSchema {
2513
2658
  data: {
2514
2659
  type: MenuItemType;
@@ -2542,7 +2687,10 @@ export interface MenuItemCreateSchema {
2542
2687
  export interface MenuItemCreateTargetSchema {
2543
2688
  data: MenuItem;
2544
2689
  }
2545
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `update.schema` link. */
2690
+ /**
2691
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2692
+ * `update.schema` link.
2693
+ */
2546
2694
  export interface MenuItemUpdateSchema {
2547
2695
  data: {
2548
2696
  type: MenuItemType;
@@ -2655,7 +2803,10 @@ export interface ItemTypeAttributes {
2655
2803
  * already been created or not
2656
2804
  */
2657
2805
  has_singleton_item: boolean;
2658
- /** A hint shown to editors to help them understand the purpose of this model/block */
2806
+ /**
2807
+ * A hint shown to editors to help them understand the purpose of this
2808
+ * model/block
2809
+ */
2659
2810
  hint: string | null;
2660
2811
  }
2661
2812
  /**
@@ -2701,7 +2852,8 @@ export interface ItemTypeRelationships {
2701
2852
  /**
2702
2853
  * JSON API data
2703
2854
  *
2704
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "data".
2855
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
2856
+ * "data".
2705
2857
  */
2706
2858
  export interface ItemData {
2707
2859
  type: ItemType1;
@@ -2710,7 +2862,8 @@ export interface ItemData {
2710
2862
  /**
2711
2863
  * JSON API data
2712
2864
  *
2713
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "data".
2865
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
2866
+ * "data".
2714
2867
  */
2715
2868
  export interface FieldData {
2716
2869
  type: FieldType;
@@ -2719,7 +2872,8 @@ export interface FieldData {
2719
2872
  /**
2720
2873
  * JSON API data
2721
2874
  *
2722
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "data".
2875
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
2876
+ * `definition` "data".
2723
2877
  */
2724
2878
  export interface FieldsetData {
2725
2879
  type: FieldsetType;
@@ -2728,13 +2882,17 @@ export interface FieldsetData {
2728
2882
  /**
2729
2883
  * JSON API data
2730
2884
  *
2731
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "data".
2885
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
2886
+ * `definition` "data".
2732
2887
  */
2733
2888
  export interface WorkflowData {
2734
2889
  type: WorkflowType;
2735
2890
  id: WorkflowIdentity;
2736
2891
  }
2737
- /** This interface was referenced by `ItemType`'s JSON-Schema via the `create.schema` link. */
2892
+ /**
2893
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
2894
+ * `create.schema` link.
2895
+ */
2738
2896
  export interface ItemTypeCreateSchema {
2739
2897
  data: {
2740
2898
  type: ItemTypeType;
@@ -2770,7 +2928,10 @@ export interface ItemTypeCreateSchema {
2770
2928
  collection_appeareance?: 'compact' | 'table';
2771
2929
  /** The way the model collection should be presented to the editors */
2772
2930
  collection_appearance?: 'compact' | 'table';
2773
- /** A hint shown to editors to help them understand the purpose of this model/block */
2931
+ /**
2932
+ * A hint shown to editors to help them understand the purpose of this
2933
+ * model/block
2934
+ */
2774
2935
  hint?: string | null;
2775
2936
  };
2776
2937
  relationships?: {
@@ -2805,7 +2966,10 @@ export interface ItemTypeCreateTargetSchema {
2805
2966
  data: ItemType;
2806
2967
  included?: MenuItem[];
2807
2968
  }
2808
- /** This interface was referenced by `ItemType`'s JSON-Schema via the `update.schema` link. */
2969
+ /**
2970
+ * This interface was referenced by `ItemType`'s JSON-Schema via the
2971
+ * `update.schema` link.
2972
+ */
2809
2973
  export interface ItemTypeUpdateSchema {
2810
2974
  data: {
2811
2975
  type: ItemTypeType;
@@ -2847,7 +3011,10 @@ export interface ItemTypeUpdateSchema {
2847
3011
  * has already been created or not
2848
3012
  */
2849
3013
  has_singleton_item?: boolean;
2850
- /** A hint shown to editors to help them understand the purpose of this model/block */
3014
+ /**
3015
+ * A hint shown to editors to help them understand the purpose of this
3016
+ * model/block
3017
+ */
2851
3018
  hint?: string | null;
2852
3019
  };
2853
3020
  relationships?: {
@@ -2881,7 +3048,10 @@ export interface ItemTypeUpdateSchema {
2881
3048
  export interface ItemTypeUpdateTargetSchema {
2882
3049
  data: Job;
2883
3050
  }
2884
- /** This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "job". */
3051
+ /**
3052
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
3053
+ * "job".
3054
+ */
2885
3055
  export interface Job {
2886
3056
  type: JobType;
2887
3057
  id: JobIdentity;
@@ -2889,7 +3059,8 @@ export interface Job {
2889
3059
  /**
2890
3060
  * JSON API data
2891
3061
  *
2892
- * This interface was referenced by `Job`'s JSON-Schema via the `definition` "data".
3062
+ * This interface was referenced by `Job`'s JSON-Schema via the `definition`
3063
+ * "data".
2893
3064
  */
2894
3065
  export interface JobData {
2895
3066
  type: JobType;
@@ -2941,7 +3112,8 @@ export interface ItemTypeDestroyJobSchema {
2941
3112
  * DatoCMS offers a number of different fields that you can combine togheter to
2942
3113
  * create a [Model](/docs/content-management-api/resources/item-type). Using the
2943
3114
  * database metaphore, fields are like table columns, and when creating them you
2944
- * need to specify their type (`string`, `float`, etc.) and any required validation.
3115
+ * need to specify their type (`string`, `float`, etc.) and any required
3116
+ * validation.
2945
3117
  *
2946
3118
  * ### Different field types require different settings
2947
3119
  *
@@ -2950,13 +3122,13 @@ export interface ItemTypeDestroyJobSchema {
2950
3122
  *
2951
3123
  * The `validators` property expresses the set of validations to be performed
2952
3124
  * server-side on a specific field value for it to be considered valid, while
2953
- * the `appearance` property lets you specify *how* the field itself will be
3125
+ * the `appearance` property lets you specify _how_ the field itself will be
2954
3126
  * presented inside the form to the final editor.
2955
3127
  *
2956
3128
  * For both properties, the value to specify depends on the type of field
2957
3129
  * itself. For example, you can add a "Limit character count" validation to a
2958
- * *Single-line string* field, or set its appearence to "Show it as heading",
2959
- * but they won't be accepted for a ie. *Color* field, as it supports different
3130
+ * _Single-line string_ field, or set its appearence to "Show it as heading",
3131
+ * but they won't be accepted for a ie. _Color_ field, as it supports different
2960
3132
  * validations and appearance settings.
2961
3133
  *
2962
3134
  * ### Specifying validations
@@ -2966,7 +3138,7 @@ export interface ItemTypeDestroyJobSchema {
2966
3138
  * settings that the validation itself requires. If the validation doesn't have
2967
3139
  * additional settings, you just pass down an empty object.
2968
3140
  *
2969
- * This is a valid example for a *Single-line string* field:
3141
+ * This is a valid example for a _Single-line string_ field:
2970
3142
  *
2971
3143
  * ```js
2972
3144
  * {
@@ -2983,8 +3155,9 @@ export interface ItemTypeDestroyJobSchema {
2983
3155
  * type with their settings.
2984
3156
  *
2985
3157
  * Some validators are required for a specific type of field. For example, the
2986
- * *Slug* field needs to have a `slug_title_field` validator to specify the ID
2987
- * of the *Single-line string* field that will be used to generate the slug itself.
3158
+ * _Slug_ field needs to have a `slug_title_field` validator to specify the ID
3159
+ * of the _Single-line string_ field that will be used to generate the slug
3160
+ * itself.
2988
3161
  *
2989
3162
  * ### Specifying the appearance
2990
3163
  *
@@ -2997,7 +3170,7 @@ export interface ItemTypeDestroyJobSchema {
2997
3170
  * The `parameters` property is an object representing any additional settings
2998
3171
  * that the editor itself might require.
2999
3172
  *
3000
- * This is a valid example for a *Single-line string* field:
3173
+ * This is a valid example for a _Single-line string_ field:
3001
3174
  *
3002
3175
  * ```js
3003
3176
  * {
@@ -3018,7 +3191,8 @@ export interface ItemTypeDestroyJobSchema {
3018
3191
  *
3019
3192
  * If the project contains a plugin that exposes [manual field
3020
3193
  * editors](/docs/plugin-sdk/manual-field-extensions), you can also configure
3021
- * the field to be presented with it instead of using one of the build-in editors.
3194
+ * the field to be presented with it instead of using one of the build-in
3195
+ * editors.
3022
3196
  *
3023
3197
  * In this case:
3024
3198
  *
@@ -3072,125 +3246,143 @@ export interface ItemTypeDestroyJobSchema {
3072
3246
  * ### Available field types<details><summary>Single-line string (<code>string</code>)</summary>
3073
3247
  *
3074
3248
  * | Property | Value |
3075
- * | ------------------------------ | ---------------------------------------------------- | ------------------- |
3249
+ * | ------------------------------ | ---------------------------------------------------- | ------------------- | ------------------------------------------------------ |
3076
3250
  * | Code | `string` |
3077
3251
  * | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
3078
- * | Available validators | `required`, `unique`, `length`, `format`, `enum` | </details><details> |<summary>Multi-line text (<code>text</code>)</summary>
3252
+ * | Available validators | `required`, `unique`, `length`, `format`, `enum` | </details><details> | <summary>Multi-line text (<code>text</code>)</summary> |
3253
+ *
3254
+ * | Property | Value |
3079
3255
  *
3080
- * | Property | Value |
3081
3256
  * | ------------------------------ | --------------------------------- | ------------------- |
3082
- * | Code | `text` |
3257
+ * | Code | `text` |
3083
3258
  * | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
3084
- * | Available validators | `required`, `length`, `format` | </details><details> |<summary>Boolean (<code>boolean</code>)</summary>
3259
+ * | Available validators | `required`, `length`, `format` | </details><details> |<summary>Boolean (<code>boolean</code>)</summary>
3260
+ *
3261
+ * | Property | Value |
3085
3262
  *
3086
- * | Property | Value |
3087
3263
  * | ------------------------------ | -------------------------------- | ------------------- |
3088
- * | Code | `boolean` |
3264
+ * | Code | `boolean` |
3089
3265
  * | Built-in editors for the field | `boolean`, `boolean_radio_group` |
3090
- * | Available validators | no validators available | </details><details> |<summary>Integer (<code>integer</code>)</summary>
3266
+ * | Available validators | no validators available | </details><details> |<summary>Integer (<code>integer</code>)</summary>
3267
+ *
3268
+ * | Property | Value |
3091
3269
  *
3092
- * | Property | Value |
3093
3270
  * | ------------------------------ | -------------------------- | ------------------- |
3094
- * | Code | `integer` |
3095
- * | Built-in editors for the field | `integer` |
3096
- * | Available validators | `required`, `number_range` | </details><details> |<summary>Float (<code>float</code>)</summary>
3271
+ * | Code | `integer` |
3272
+ * | Built-in editors for the field | `integer` |
3273
+ * | Available validators | `required`, `number_range` | </details><details> |<summary>Float (<code>float</code>)</summary>
3274
+ *
3275
+ * | Property | Value |
3097
3276
  *
3098
- * | Property | Value |
3099
3277
  * | ------------------------------ | -------------------------- | ------------------- |
3100
- * | Code | `float` |
3101
- * | Built-in editors for the field | `float` |
3102
- * | Available validators | `required`, `number_range` | </details><details> |<summary>Date (<code>date</code>)</summary>
3278
+ * | Code | `float` |
3279
+ * | Built-in editors for the field | `float` |
3280
+ * | Available validators | `required`, `number_range` | </details><details> |<summary>Date (<code>date</code>)</summary>
3281
+ *
3282
+ * | Property | Value |
3103
3283
  *
3104
- * | Property | Value |
3105
3284
  * | ------------------------------ | ------------------------ | ------------------- |
3106
- * | Code | `date` |
3107
- * | Built-in editors for the field | `date_picker` |
3108
- * | Available validators | `required`, `date_range` | </details><details> |<summary>Date time (<code>date_time</code>)</summary>
3285
+ * | Code | `date` |
3286
+ * | Built-in editors for the field | `date_picker` |
3287
+ * | Available validators | `required`, `date_range` | </details><details> |<summary>Date time (<code>date_time</code>)</summary>
3288
+ *
3289
+ * | Property | Value |
3109
3290
  *
3110
- * | Property | Value |
3111
3291
  * | ------------------------------ | ----------------------------- | ------------------- |
3112
- * | Code | `date_time` |
3113
- * | Built-in editors for the field | `date_time_picker` |
3114
- * | Available validators | `required`, `date_time_range` | </details><details> |<summary>Color (<code>color</code>)</summary>
3292
+ * | Code | `date_time` |
3293
+ * | Built-in editors for the field | `date_time_picker` |
3294
+ * | Available validators | `required`, `date_time_range` | </details><details> |<summary>Color (<code>color</code>)</summary>
3295
+ *
3296
+ * | Property | Value |
3115
3297
  *
3116
- * | Property | Value |
3117
3298
  * | ------------------------------ | -------------- | ------------------- |
3118
- * | Code | `color` |
3299
+ * | Code | `color` |
3119
3300
  * | Built-in editors for the field | `color_picker` |
3120
- * | Available validators | `required` | </details><details> |<summary>JSON (<code>json</code>)</summary>
3301
+ * | Available validators | `required` | </details><details> |<summary>JSON (<code>json</code>)</summary>
3302
+ *
3303
+ * | Property | Value |
3121
3304
  *
3122
- * | Property | Value |
3123
3305
  * | ------------------------------ | ------------------------------------------------------ | ------------------- |
3124
- * | Code | `json` |
3306
+ * | Code | `json` |
3125
3307
  * | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
3126
- * | Available validators | `required` | </details><details> |<summary>Location (<code>lat_lon</code>)</summary>
3308
+ * | Available validators | `required` | </details><details> |<summary>Location (<code>lat_lon</code>)</summary>
3309
+ *
3310
+ * | Property | Value |
3127
3311
  *
3128
- * | Property | Value |
3129
3312
  * | ------------------------------ | ---------- | ------------------- |
3130
- * | Code | `lat_lon` |
3131
- * | Built-in editors for the field | `map` |
3132
- * | Available validators | `required` | </details><details> |<summary>SEO (<code>seo</code>)</summary>
3313
+ * | Code | `lat_lon` |
3314
+ * | Built-in editors for the field | `map` |
3315
+ * | Available validators | `required` | </details><details> |<summary>SEO (<code>seo</code>)</summary>
3316
+ *
3317
+ * | Property | Value |
3133
3318
  *
3134
- * | Property | Value |
3135
3319
  * | ------------------------------ | -------------------------------------------------------------------------------------------- | ------------------- |
3136
- * | Code | `seo` |
3137
- * | Built-in editors for the field | `seo` |
3138
- * | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` | </details><details> |<summary>Slug (<code>slug</code>)</summary>
3320
+ * | Code | `seo` |
3321
+ * | Built-in editors for the field | `seo` |
3322
+ * | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` | </details><details> |<summary>Slug (<code>slug</code>)</summary>
3323
+ *
3324
+ * | Property | Value |
3139
3325
  *
3140
- * | Property | Value |
3141
3326
  * | ------------------------------ | ----------------------------------- | ------------------- |
3142
- * | Code | `slug` |
3143
- * | Built-in editors for the field | `slug` |
3144
- * | Required validators | `slug_title_field` |
3145
- * | Other validators available | `required`, `length`, `slug_format` | </details><details> |<summary>External video (<code>video</code>)</summary>
3327
+ * | Code | `slug` |
3328
+ * | Built-in editors for the field | `slug` |
3329
+ * | Required validators | `slug_title_field` |
3330
+ * | Other validators available | `required`, `length`, `slug_format` | </details><details> |<summary>External video (<code>video</code>)</summary>
3331
+ *
3332
+ * | Property | Value |
3146
3333
  *
3147
- * | Property | Value |
3148
3334
  * | ------------------------------ | ---------- | ------------------- |
3149
- * | Code | `video` |
3150
- * | Built-in editors for the field | `video` |
3151
- * | Available validators | `required` | </details><details> |<summary>Single-asset (<code>file</code>)</summary>
3335
+ * | Code | `video` |
3336
+ * | Built-in editors for the field | `video` |
3337
+ * | Available validators | `required` | </details><details> |<summary>Single-asset (<code>file</code>)</summary>
3338
+ *
3339
+ * | Property | Value |
3152
3340
  *
3153
- * | Property | Value |
3154
3341
  * | ------------------------------ | ------------------------------------------------------------------------------ | ------------------- |
3155
- * | Code | `file` |
3156
- * | Built-in editors for the field | `file` |
3157
- * | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Asset gallery (<code>gallery</code>)</summary>
3342
+ * | Code | `file` |
3343
+ * | Built-in editors for the field | `file` |
3344
+ * | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Asset gallery (<code>gallery</code>)</summary>
3345
+ *
3346
+ * | Property | Value |
3158
3347
  *
3159
- * | Property | Value |
3160
3348
  * | ------------------------------ | -------------------------------------------------------------------------- | ------------------- |
3161
- * | Code | `gallery` |
3162
- * | Built-in editors for the field | `gallery` |
3163
- * | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Single link (<code>link</code>)</summary>
3349
+ * | Code | `gallery` |
3350
+ * | Built-in editors for the field | `gallery` |
3351
+ * | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` | </details><details> |<summary>Single link (<code>link</code>)</summary>
3352
+ *
3353
+ * | Property | Value |
3164
3354
  *
3165
- * | Property | Value |
3166
3355
  * | ------------------------------ | --------------------------- | ------------------- |
3167
- * | Code | `link` |
3356
+ * | Code | `link` |
3168
3357
  * | Built-in editors for the field | `link_select`, `link_embed` |
3169
- * | Default `editor` | `link_select` |
3170
- * | Required validators | `item_item_type` |
3171
- * | Other validators available | `required`, `unique` | </details><details> |<summary>Multiple links (<code>links</code>)</summary>
3358
+ * | Default `editor` | `link_select` |
3359
+ * | Required validators | `item_item_type` |
3360
+ * | Other validators available | `required`, `unique` | </details><details> |<summary>Multiple links (<code>links</code>)</summary>
3361
+ *
3362
+ * | Property | Value |
3172
3363
  *
3173
- * | Property | Value |
3174
3364
  * | ------------------------------ | ----------------------------- | ------------------- |
3175
- * | Code | `links` |
3365
+ * | Code | `links` |
3176
3366
  * | Built-in editors for the field | `links_select`, `links_embed` |
3177
- * | Default `editor` | `links_select` |
3178
- * | Required validators | `items_item_type` |
3179
- * | Other validators available | `size` | </details><details> |<summary>Modular content (<code>rich_text</code>)</summary>
3367
+ * | Default `editor` | `links_select` |
3368
+ * | Required validators | `items_item_type` |
3369
+ * | Other validators available | `size` | </details><details> |<summary>Modular content (<code>rich_text</code>)</summary>
3370
+ *
3371
+ * | Property | Value |
3180
3372
  *
3181
- * | Property | Value |
3182
3373
  * | ------------------------------ | ------------------ | ------------------- |
3183
- * | Code | `rich_text` |
3184
- * | Built-in editors for the field | `rich_text` |
3185
- * | Required validators | `rich_text_blocks` |
3186
- * | Other validators available | `size` | </details><details> |<summary>Structured text (<code>structured_text</code>)</summary>
3374
+ * | Code | `rich_text` |
3375
+ * | Built-in editors for the field | `rich_text` |
3376
+ * | Required validators | `rich_text_blocks` |
3377
+ * | Other validators available | `size` | </details><details> |<summary>Structured text (<code>structured_text</code>)</summary>
3378
+ *
3379
+ * | Property | Value |
3187
3380
  *
3188
- * | Property | Value |
3189
3381
  * | ------------------------------ | ------------------------------------------------- | ---------- |
3190
- * | Code | `structured_text` |
3191
- * | Built-in editors for the field | `structured_text` |
3192
- * | Required validators | `structured_text_blocks`, `structured_text_links` |
3193
- * | Other validators available | `length` | </details> |
3382
+ * | Code | `structured_text` |
3383
+ * | Built-in editors for the field | `structured_text` |
3384
+ * | Required validators | `structured_text_blocks`, `structured_text_links` |
3385
+ * | Other validators available | `length` | </details> |
3194
3386
  *
3195
3387
  * ### Validators<details><summary><code>date_range</code></summary>
3196
3388
  *
@@ -3201,7 +3393,8 @@ export interface ItemTypeDestroyJobSchema {
3201
3393
  * | `min` | ISO 8601 date | | Minimum date |
3202
3394
  * | `max` | ISO 8601 date | | Maximum date |
3203
3395
  *
3204
- * At least one of the parameters must be specified.</details><details><summary><code>date_time_range</code></summary>
3396
+ * At least one of the parameters must be
3397
+ * specified.</details><details><summary><code>date_time_range</code></summary>
3205
3398
  *
3206
3399
  * Accept date times only inside a specified date range.
3207
3400
  *
@@ -3210,13 +3403,14 @@ export interface ItemTypeDestroyJobSchema {
3210
3403
  * | `min` | ISO 8601 datetime | | Minimum datetime |
3211
3404
  * | `max` | ISO 8601 datetime | | Maximum datetime |
3212
3405
  *
3213
- * At least one of the parameters must be specified.</details><details><summary><code>enum</code></summary>
3406
+ * At least one of the parameters must be
3407
+ * specified.</details><details><summary><code>enum</code></summary>
3214
3408
  *
3215
3409
  * Only accept a specific set of values
3216
3410
  *
3217
3411
  * | Parameter | Type | Required | Description |
3218
- * | --------- | --------------- | -------- | --------------------- | ------------------- |
3219
- * | `values` | `Array<String>` | ✅ | Set of allowed values | </details><details> |<summary><code>extension</code></summary>
3412
+ * | --------- | --------------- | -------- | --------------------- | ------------------- | ----------------------------------------- |
3413
+ * | `values` | `Array<String>` | ✅ | Set of allowed values | </details><details> | <summary><code>extension</code></summary> |
3220
3414
  *
3221
3415
  * Only accept assets with specific file extensions.
3222
3416
  *
@@ -3225,7 +3419,8 @@ export interface ItemTypeDestroyJobSchema {
3225
3419
  * | `extensions` | `Array<String>` | | Set of allowed file extensions |
3226
3420
  * | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` | | Allowed file type |
3227
3421
  *
3228
- * Only one of the parameters must be specified.</details><details><summary><code>file_size</code></summary>
3422
+ * Only one of the parameters must be
3423
+ * specified.</details><details><summary><code>file_size</code></summary>
3229
3424
  *
3230
3425
  * Accept assets only inside a specified date range.
3231
3426
  *
@@ -3236,7 +3431,8 @@ export interface ItemTypeDestroyJobSchema {
3236
3431
  * | `max_value` | `Integer` | | Numeric value for maximum filesize |
3237
3432
  * | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
3238
3433
  *
3239
- * At least one couple of value/unit must be specified.</details><details><summary><code>format</code></summary>
3434
+ * At least one couple of value/unit must be
3435
+ * specified.</details><details><summary><code>format</code></summary>
3240
3436
  *
3241
3437
  * Only accept strings having a specific format.
3242
3438
  *
@@ -3245,7 +3441,8 @@ export interface ItemTypeDestroyJobSchema {
3245
3441
  * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
3246
3442
  * | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
3247
3443
  *
3248
- * Only one of the parameters must be specified.</details><details><summary><code>slug_format</code></summary>
3444
+ * Only one of the parameters must be
3445
+ * specified.</details><details><summary><code>slug_format</code></summary>
3249
3446
  *
3250
3447
  * Only accept slugs having a specific format.
3251
3448
  *
@@ -3254,7 +3451,8 @@ export interface ItemTypeDestroyJobSchema {
3254
3451
  * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
3255
3452
  * | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
3256
3453
  *
3257
- * Only one of the parameters must be specified.</details><details><summary><code>image_dimensions</code></summary>
3454
+ * Only one of the parameters must be
3455
+ * specified.</details><details><summary><code>image_dimensions</code></summary>
3258
3456
  *
3259
3457
  * Accept assets only within a specified height/width range.
3260
3458
  *
@@ -3265,7 +3463,8 @@ export interface ItemTypeDestroyJobSchema {
3265
3463
  * | `height_min_value` | `Integer` | | Numeric value for minimum width |
3266
3464
  * | `height_max_value` | `Integer` | | Numeric value for maximum height |
3267
3465
  *
3268
- * At least one parameter must be specified.</details><details><summary><code>item_item_type</code></summary>
3466
+ * At least one parameter must be
3467
+ * specified.</details><details><summary><code>item_item_type</code></summary>
3269
3468
  *
3270
3469
  * Only accept references to records of the specified models.
3271
3470
  *
@@ -3292,7 +3491,8 @@ export interface ItemTypeDestroyJobSchema {
3292
3491
  *
3293
3492
  * - `"fail"`: Fail the operation and notify the user
3294
3493
  * - `"delete_references"`: Try to remove the reference to the deleted record (if
3295
- * the field has a `required` validation it will fail)</details><details><summary><code>items_item_type</code></summary>
3494
+ * the field has a `required` validation it will
3495
+ * fail)</details><details><summary><code>items_item_type</code></summary>
3296
3496
  *
3297
3497
  * Only accept references to records of the specified models.
3298
3498
  *
@@ -3319,7 +3519,8 @@ export interface ItemTypeDestroyJobSchema {
3319
3519
  *
3320
3520
  * - `"fail"`: Fail the operation and notify the user
3321
3521
  * - `"delete_references"`: Try to remove the reference to the deleted record (if
3322
- * the field has a `required` validation it will fail)</details><details><summary><code>length</code></summary>
3522
+ * the field has a `required` validation it will
3523
+ * fail)</details><details><summary><code>length</code></summary>
3323
3524
  *
3324
3525
  * Accept strings only with a specified number of characters.
3325
3526
  *
@@ -3329,7 +3530,8 @@ export interface ItemTypeDestroyJobSchema {
3329
3530
  * | `eq` | `Integer` | | Expected length |
3330
3531
  * | `max` | `Integer` | | Maximum length |
3331
3532
  *
3332
- * At least one parameter must be specified.</details><details><summary><code>number_range</code></summary>
3533
+ * At least one parameter must be
3534
+ * specified.</details><details><summary><code>number_range</code></summary>
3333
3535
  *
3334
3536
  * Accept numbers only inside a specified range.
3335
3537
  *
@@ -3338,9 +3540,11 @@ export interface ItemTypeDestroyJobSchema {
3338
3540
  * | `min` | `Float` | | Minimum value |
3339
3541
  * | `max` | `Float` | | Maximum value |
3340
3542
  *
3341
- * At least one of the parameters must be specified.</details><details><summary><code>required</code></summary>
3543
+ * At least one of the parameters must be
3544
+ * specified.</details><details><summary><code>required</code></summary>
3342
3545
  *
3343
- * Value must be specified or it won't be valid.</details><details><summary><code>required_alt_title</code></summary>
3546
+ * Value must be specified or it won't be
3547
+ * valid.</details><details><summary><code>required_alt_title</code></summary>
3344
3548
  *
3345
3549
  * Assets contained in the field are required to specify custom title or
3346
3550
  * alternate text, or they won't be valid.
@@ -3350,7 +3554,8 @@ export interface ItemTypeDestroyJobSchema {
3350
3554
  * | `title` | `Boolean` | | Whether the title for the asset must be specified |
3351
3555
  * | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
3352
3556
  *
3353
- * At least one of the parameters must be specified.</details><details><summary><code>required_seo_fields</code></summary>
3557
+ * At least one of the parameters must be
3558
+ * specified.</details><details><summary><code>required_seo_fields</code></summary>
3354
3559
  *
3355
3560
  * SEO field is to specify one or more properties, or it won't be valid.
3356
3561
  *
@@ -3361,7 +3566,8 @@ export interface ItemTypeDestroyJobSchema {
3361
3566
  * | `image` | `Boolean` | | Whether the social sharing image must be specified |
3362
3567
  * | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
3363
3568
  *
3364
- * At least one of the parameters must be specified.</details><details><summary><code>title_length</code></summary>
3569
+ * At least one of the parameters must be
3570
+ * specified.</details><details><summary><code>title_length</code></summary>
3365
3571
  *
3366
3572
  * Limits the length of the title for a SEO field. Search engines usually
3367
3573
  * truncate title tags to 60 character so it is a good practice to keep the
@@ -3372,7 +3578,8 @@ export interface ItemTypeDestroyJobSchema {
3372
3578
  * | `min` | `Integer` | | Minimum value |
3373
3579
  * | `max` | `Integer` | | Maximum value |
3374
3580
  *
3375
- * At least one of the parameters must be specified.</details><details><summary><code>description_length</code></summary>
3581
+ * At least one of the parameters must be
3582
+ * specified.</details><details><summary><code>description_length</code></summary>
3376
3583
  *
3377
3584
  * Limits the length of the description for a SEO field. Search engines usually
3378
3585
  * truncate description tags to 160 character so it is a good practice to keep
@@ -3383,21 +3590,23 @@ export interface ItemTypeDestroyJobSchema {
3383
3590
  * | `min` | `Integer` | | Minimum value |
3384
3591
  * | `max` | `Integer` | | Maximum value |
3385
3592
  *
3386
- * At least one of the parameters must be specified.</details><details><summary><code>rich_text_blocks</code></summary>
3593
+ * At least one of the parameters must be
3594
+ * specified.</details><details><summary><code>rich_text_blocks</code></summary>
3387
3595
  *
3388
3596
  * Only accept references to block records of the specified block models.
3389
3597
  *
3390
3598
  * | Parameter | Type | Required | Description |
3391
- * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- |
3392
- * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> |<summary><code>structured_text_blocks</code></summary>
3599
+ * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- | ------------------------------------------------------ |
3600
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> | <summary><code>structured_text_blocks</code></summary> |
3393
3601
  *
3394
3602
  * Only accept references to block records of the specified block models.
3395
3603
  *
3396
3604
  * | Parameter | Type | Required | Description |
3397
- * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- |
3398
- * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> |<summary><code>structured_text_links</code></summary>
3605
+ * | ------------ | ----------------------- | -------- | ------------------------------ | ------------------- | ----------------------------------------------------- |
3606
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs | </details><details> | <summary><code>structured_text_links</code></summary> |
3399
3607
  *
3400
- * Only accept `itemLink` to `inlineItem` nodes for records of the specified models.
3608
+ * Only accept `itemLink` to `inlineItem` nodes for records of the specified
3609
+ * models.
3401
3610
  *
3402
3611
  * | Parameter | Type | Required | Description |
3403
3612
  * | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
@@ -3422,7 +3631,8 @@ export interface ItemTypeDestroyJobSchema {
3422
3631
  *
3423
3632
  * - `"fail"`: Fail the operation and notify the user
3424
3633
  * - `"delete_references"`: Try to remove the reference to the deleted record (if
3425
- * the field has a `required` validation it will fail)</details><details><summary><code>size</code></summary>
3634
+ * the field has a `required` validation it will
3635
+ * fail)</details><details><summary><code>size</code></summary>
3426
3636
  *
3427
3637
  * Only accept a number of items within the specified range.
3428
3638
  *
@@ -3433,109 +3643,114 @@ export interface ItemTypeDestroyJobSchema {
3433
3643
  * | `max` | `Integer` | | Maximum length |
3434
3644
  * | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
3435
3645
  *
3436
- * At least one parameter must be specified.</details><details><summary><code>slug_title_field</code></summary>
3646
+ * At least one parameter must be
3647
+ * specified.</details><details><summary><code>slug_title_field</code></summary>
3437
3648
  *
3438
- * Specifies the ID of the *Single-line string* field that will be used to
3649
+ * Specifies the ID of the _Single-line string_ field that will be used to
3439
3650
  * generate the slug
3440
3651
  *
3441
3652
  * | Parameter | Type | Required | Description |
3442
- * | ---------------- | ---------- | -------- | ------------------------------------------------ | ------------------- |
3443
- * | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug | </details><details> |<summary><code>unique</code></summary>
3653
+ * | ---------------- | ---------- | -------- | ------------------------------------------------ | ------------------- | -------------------------------------- |
3654
+ * | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug | </details><details> | <summary><code>unique</code></summary> |
3444
3655
  *
3445
3656
  * The value must be unique across the whole collection of records.</details>
3446
3657
  *
3447
3658
  * ### Configuration parameters for DatoCMS built-in field editors
3448
3659
  *
3449
3660
  * If a field editor is not specified in this table, just pass an empty object
3450
- * `{}` as its configuration parameters.<details><summary><code>boolean_radio_group</code></summary>
3661
+ * `{}` as its configuration
3662
+ * parameters.<details><summary><code>boolean_radio_group</code></summary>
3451
3663
  *
3452
- * Radio group input for *boolean* fields.
3664
+ * Radio group input for _boolean_ fields.
3453
3665
  *
3454
3666
  * | Parameter | Type | Required | Description |
3455
- * | ---------------- | ---------------------------------- | -------- | ----------------------------------------- | ------------------- |
3667
+ * | ---------------- | ---------------------------------- | -------- | ----------------------------------------- | ------------------- | -------------------------------------------------- |
3456
3668
  * | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
3457
- * | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) | </details><details> |<summary><code>string_radio_group</code></summary>
3669
+ * | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) | </details><details> | <summary><code>string_radio_group</code></summary> |
3458
3670
  *
3459
- * Radio group input for *string* fields.
3671
+ * Radio group input for _string_ fields.
3460
3672
  *
3461
3673
  * | Parameter | Type | Required | Description |
3462
- * | --------- | -------------------------------------------------------- | -------- | --------------------------- | ------------------- |
3463
- * | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options | </details><details> |<summary><code>string_select</code></summary>
3674
+ * | --------- | -------------------------------------------------------- | -------- | --------------------------- | ------------------- | --------------------------------------------- |
3675
+ * | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options | </details><details> | <summary><code>string_select</code></summary> |
3464
3676
  *
3465
- * Select input for *string* fields.
3677
+ * Select input for _string_ fields.
3466
3678
  *
3467
3679
  * | Parameter | Type | Required | Description |
3468
- * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- |
3469
- * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> |<summary><code>string_multi_select</code></summary>
3680
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- | --------------------------------------------------- |
3681
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> | <summary><code>string_multi_select</code></summary> |
3470
3682
  *
3471
- * Select input for *JSON* fields, to edit an array of strings.
3683
+ * Select input for _JSON_ fields, to edit an array of strings.
3472
3684
  *
3473
3685
  * | Parameter | Type | Required | Description |
3474
- * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- |
3475
- * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> |<summary><code>string_checkbox_group</code></summary>
3686
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- | ----------------------------------------------------- |
3687
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> | <summary><code>string_checkbox_group</code></summary> |
3476
3688
  *
3477
- * Multiple chechboxes input for *JSON* fields, to edit an array of strings.
3689
+ * Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
3478
3690
  *
3479
3691
  * | Parameter | Type | Required | Description |
3480
- * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- |
3481
- * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> |<summary><code>single_line</code></summary>
3692
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- | ------------------- | ------------------------------------------- |
3693
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options | </details><details> | <summary><code>single_line</code></summary> |
3482
3694
  *
3483
- * Simple textual input for *Single-line string* fields.
3695
+ * Simple textual input for _Single-line string_ fields.
3484
3696
  *
3485
3697
  * | Parameter | Type | Required | Description |
3486
- * | --------- | --------- | -------- | -------------------------------------------------------------------------------- | ------------------- |
3487
- * | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading | </details><details> |<summary><code>markdown</code></summary>
3698
+ * | --------- | --------- | -------- | -------------------------------------------------------------------------------- | ------------------- | ---------------------------------------- |
3699
+ * | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading | </details><details> | <summary><code>markdown</code></summary> |
3488
3700
  *
3489
- * Markdown editor for *Multiple-paragraph text* fields.
3701
+ * Markdown editor for _Multiple-paragraph text_ fields.
3490
3702
  *
3491
3703
  * | Parameter | Type | Required | Description |
3492
- * | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
3493
- * | `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>
3704
+ * | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | --------------------------------------- |
3705
+ * | `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> |
3494
3706
  *
3495
- * HTML editor for *Multiple-paragraph text* fields.
3707
+ * HTML editor for _Multiple-paragraph text_ fields.
3496
3708
  *
3497
3709
  * | Parameter | Type | Required | Description |
3498
- * | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
3499
- * | `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>
3710
+ * | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ---------------------------------------- |
3711
+ * | `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> |
3500
3712
  *
3501
- * Basic textarea editor for *Multiple-paragraph text* fields.</details><details><summary><code>color_picker</code></summary>
3713
+ * Basic textarea editor for _Multiple-paragraph text_
3714
+ * fields.</details><details><summary><code>color_picker</code></summary>
3502
3715
  *
3503
- * Built-in editor for *Color* fields.
3716
+ * Built-in editor for _Color_ fields.
3504
3717
  *
3505
3718
  * | Parameter | Type | Required | Description |
3506
- * | --------------- | ------------------------- | -------- | --------------------------------------------------------- | ------------------- |
3719
+ * | --------------- | ------------------------- | -------- | --------------------------------------------------------- | ------------------- | ------------------------------------ |
3507
3720
  * | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
3508
- * | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user | </details><details> |<summary><code>slug</code></summary>
3721
+ * | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user | </details><details> | <summary><code>slug</code></summary> |
3509
3722
  *
3510
- * Built-in editor for *Slug* fields.
3723
+ * Built-in editor for _Slug_ fields.
3511
3724
  *
3512
3725
  * | Parameter | Type | Required | Description |
3513
- * | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- | ------------------- |
3514
- * | `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>
3726
+ * | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- | ------------------- | ----------------------------------------- |
3727
+ * | `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> |
3515
3728
  *
3516
- * Built-in editor for *Modular content* fields.
3729
+ * Built-in editor for _Modular content_ fields.
3517
3730
  *
3518
3731
  * | Parameter | Type | Required | Description |
3519
- * | ----------------- | --------- | -------- | ---------------------------------------------------------- | ------------------- |
3520
- * | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not | </details><details> |<summary><code>structured_text</code></summary>
3732
+ * | ----------------- | --------- | -------- | ---------------------------------------------------------- | ------------------- | ----------------------------------------------- |
3733
+ * | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not | </details><details> | <summary><code>structured_text</code></summary> |
3521
3734
  *
3522
- * Built-in editor for *Structured text* fields.
3735
+ * Built-in editor for _Structured text_ fields.
3523
3736
  *
3524
3737
  * | Parameter | Type | Required | Description |
3525
- * | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
3738
+ * | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- | ------------------------------------------------------------------------- |
3526
3739
  * | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
3527
3740
  * | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
3528
3741
  * | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
3529
3742
  * | `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 |
3530
- * | `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>
3743
+ * | `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> |
3531
3744
  *
3532
3745
  * Use a select input with auto-completion to pick the records to reference
3533
- * inside the field.</details><details><summary><code>link_embed</code> and <code>links_embed</code></summary>
3746
+ * inside the field.</details><details><summary><code>link_embed</code> and
3747
+ * <code>links_embed</code></summary>
3534
3748
  *
3535
3749
  * Use an expanded view with records' image preview to pick the records to
3536
3750
  * reference inside the field.</details>
3537
3751
  *
3538
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "field".
3752
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
3753
+ * "field".
3539
3754
  */
3540
3755
  export interface Field {
3541
3756
  type: FieldType;
@@ -3630,7 +3845,10 @@ export interface FieldRelationships {
3630
3845
  data: null | FieldsetData;
3631
3846
  };
3632
3847
  }
3633
- /** This interface was referenced by `Field`'s JSON-Schema via the `create.schema` link. */
3848
+ /**
3849
+ * This interface was referenced by `Field`'s JSON-Schema via the
3850
+ * `create.schema` link.
3851
+ */
3634
3852
  export interface FieldCreateSchema {
3635
3853
  data: {
3636
3854
  type: FieldType;
@@ -3716,12 +3934,18 @@ export interface FieldCreateSchema {
3716
3934
  export interface FieldCreateTargetSchema {
3717
3935
  data: Job;
3718
3936
  }
3719
- /** This interface was referenced by `Field`'s JSON-Schema via the `create.jobSchema` link. */
3937
+ /**
3938
+ * This interface was referenced by `Field`'s JSON-Schema via the
3939
+ * `create.jobSchema` link.
3940
+ */
3720
3941
  export interface FieldCreateJobSchema {
3721
3942
  data: Field;
3722
3943
  included?: ItemType[];
3723
3944
  }
3724
- /** This interface was referenced by `Field`'s JSON-Schema via the `update.schema` link. */
3945
+ /**
3946
+ * This interface was referenced by `Field`'s JSON-Schema via the
3947
+ * `update.schema` link.
3948
+ */
3725
3949
  export interface FieldUpdateSchema {
3726
3950
  data: {
3727
3951
  type: FieldType;
@@ -3807,7 +4031,10 @@ export interface FieldUpdateSchema {
3807
4031
  export interface FieldUpdateTargetSchema {
3808
4032
  data: Job;
3809
4033
  }
3810
- /** This interface was referenced by `Field`'s JSON-Schema via the `update.jobSchema` link. */
4034
+ /**
4035
+ * This interface was referenced by `Field`'s JSON-Schema via the
4036
+ * `update.jobSchema` link.
4037
+ */
3811
4038
  export interface FieldUpdateJobSchema {
3812
4039
  data: Field;
3813
4040
  included?: (ItemType | Field)[];
@@ -3871,7 +4098,8 @@ export interface FieldDuplicateJobSchema {
3871
4098
  included: ItemType[];
3872
4099
  }
3873
4100
  /**
3874
- * Fields can be organized and grouped into fieldset to better present them to editors.
4101
+ * Fields can be organized and grouped into fieldset to better present them to
4102
+ * editors.
3875
4103
  *
3876
4104
  * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
3877
4105
  * "fieldset".
@@ -3895,7 +4123,10 @@ export interface FieldsetAttributes {
3895
4123
  hint: string | null;
3896
4124
  /** Whether the fieldset can be collapsed or not */
3897
4125
  collapsible: boolean;
3898
- /** When fieldset is collapsible, determines if the default is to start collapsed or not */
4126
+ /**
4127
+ * When fieldset is collapsible, determines if the default is to start
4128
+ * collapsed or not
4129
+ */
3899
4130
  start_collapsed: boolean;
3900
4131
  /** Ordering index */
3901
4132
  position: number;
@@ -3912,7 +4143,10 @@ export interface FieldsetRelationships {
3912
4143
  data: ItemTypeData;
3913
4144
  };
3914
4145
  }
3915
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `create.schema` link. */
4146
+ /**
4147
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
4148
+ * `create.schema` link.
4149
+ */
3916
4150
  export interface FieldsetCreateSchema {
3917
4151
  data: {
3918
4152
  type: FieldsetType;
@@ -3941,7 +4175,10 @@ export interface FieldsetCreateSchema {
3941
4175
  export interface FieldsetCreateTargetSchema {
3942
4176
  data: Fieldset;
3943
4177
  }
3944
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `update.schema` link. */
4178
+ /**
4179
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
4180
+ * `update.schema` link.
4181
+ */
3945
4182
  export interface FieldsetUpdateSchema {
3946
4183
  data: {
3947
4184
  type: FieldsetType;
@@ -4017,13 +4254,17 @@ export interface SessionRelationships {
4017
4254
  /**
4018
4255
  * JSON API data
4019
4256
  *
4020
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "data".
4257
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
4258
+ * "data".
4021
4259
  */
4022
4260
  export interface SessionData {
4023
4261
  type: SessionType;
4024
4262
  id: SessionIdentity;
4025
4263
  }
4026
- /** This interface was referenced by `Session`'s JSON-Schema via the `create.schema` link. */
4264
+ /**
4265
+ * This interface was referenced by `Session`'s JSON-Schema via the
4266
+ * `create.schema` link.
4267
+ */
4027
4268
  export interface SessionCreateSchema {
4028
4269
  data: {
4029
4270
  /** JSON API type field */
@@ -4049,9 +4290,11 @@ export interface SessionCreateTargetSchema {
4049
4290
  }
4050
4291
  /**
4051
4292
  * Plugins enable developers to replace DatoCMS field components with HTML5
4052
- * applications so the editing experiences of the DatoCMS web app can be customized.
4293
+ * applications so the editing experiences of the DatoCMS web app can be
4294
+ * customized.
4053
4295
  *
4054
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "plugin".
4296
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
4297
+ * "plugin".
4055
4298
  */
4056
4299
  export interface Plugin {
4057
4300
  type: PluginType;
@@ -4098,7 +4341,8 @@ export interface PluginAttributes {
4098
4341
  /**
4099
4342
  * JSON API meta
4100
4343
  *
4101
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "meta".
4344
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
4345
+ * "meta".
4102
4346
  */
4103
4347
  export interface PluginMeta {
4104
4348
  /** Version of the plugin. Legacy plugins are v1, new plugins are v2 */
@@ -4107,13 +4351,17 @@ export interface PluginMeta {
4107
4351
  /**
4108
4352
  * JSON API data
4109
4353
  *
4110
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "data".
4354
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
4355
+ * "data".
4111
4356
  */
4112
4357
  export interface PluginData {
4113
4358
  type: PluginType;
4114
4359
  id: PluginIdentity;
4115
4360
  }
4116
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `create.schema` link. */
4361
+ /**
4362
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
4363
+ * `create.schema` link.
4364
+ */
4117
4365
  export interface PluginCreateSchema {
4118
4366
  data: {
4119
4367
  type: PluginType;
@@ -4123,7 +4371,10 @@ export interface PluginCreateSchema {
4123
4371
  * plugins, that's the only attribute you need to pass.
4124
4372
  */
4125
4373
  package_name?: null | string;
4126
- /** The name of the plugin. Only to be passed if package name key is not specified. */
4374
+ /**
4375
+ * The name of the plugin. Only to be passed if package name key is not
4376
+ * specified.
4377
+ */
4127
4378
  name?: string;
4128
4379
  /**
4129
4380
  * A description of the plugin. Only to be passed if package name key is
@@ -4167,7 +4418,10 @@ export interface PluginCreateSchema {
4167
4418
  export interface PluginCreateTargetSchema {
4168
4419
  data: Plugin;
4169
4420
  }
4170
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `update.schema` link. */
4421
+ /**
4422
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
4423
+ * `update.schema` link.
4424
+ */
4171
4425
  export interface PluginUpdateSchema {
4172
4426
  data: {
4173
4427
  type: PluginType;
@@ -4259,7 +4513,8 @@ export interface JobResultAttributes {
4259
4513
  /**
4260
4514
  * JSON API data
4261
4515
  *
4262
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "data".
4516
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
4517
+ * `definition` "data".
4263
4518
  */
4264
4519
  export interface JobResultData {
4265
4520
  type: JobResultType;
@@ -4360,7 +4615,8 @@ export interface SubscriptionFeatureInstancesTargetSchema {
4360
4615
  data: SubscriptionFeature[];
4361
4616
  }
4362
4617
  /**
4363
- * Represents an event occurred during the deploy process of your administrative area.
4618
+ * Represents an event occurred during the deploy process of your administrative
4619
+ * area.
4364
4620
  *
4365
4621
  * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
4366
4622
  * "build_event".
@@ -4438,7 +4694,8 @@ export interface BuildEventSelfTargetSchema {
4438
4694
  * records, which are much like table rows in a database. For
4439
4695
  * backward-compatibility reasons, the API refers to records as "items".
4440
4696
  *
4441
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "item".
4697
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
4698
+ * "item".
4442
4699
  */
4443
4700
  export interface Item {
4444
4701
  type: ItemType1;
@@ -4469,7 +4726,8 @@ export interface ItemRelationships {
4469
4726
  };
4470
4727
  /**
4471
4728
  * The entity (account/collaborator/access token/sso user) who created the
4472
- * record. It must be an object with `type` (e.g. 'account') and `id` properties.
4729
+ * record. It must be an object with `type` (e.g. 'account') and `id`
4730
+ * properties.
4473
4731
  */
4474
4732
  creator?: {
4475
4733
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -4478,7 +4736,8 @@ export interface ItemRelationships {
4478
4736
  /**
4479
4737
  * Meta information regarding the record
4480
4738
  *
4481
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "meta".
4739
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
4740
+ * "meta".
4482
4741
  */
4483
4742
  export interface ItemMeta {
4484
4743
  /** Date of creation */
@@ -4531,7 +4790,8 @@ export interface ItemValidateExistingSchema {
4531
4790
  };
4532
4791
  /**
4533
4792
  * The entity (account/collaborator/access token/sso user) who created the
4534
- * record. It must be an object with `type` (e.g. 'account') and `id` properties.
4793
+ * record. It must be an object with `type` (e.g. 'account') and `id`
4794
+ * properties.
4535
4795
  */
4536
4796
  creator?: {
4537
4797
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -4558,7 +4818,10 @@ export interface ItemValidateNewSchema {
4558
4818
  };
4559
4819
  };
4560
4820
  }
4561
- /** This interface was referenced by `Item`'s JSON-Schema via the `create.schema` link. */
4821
+ /**
4822
+ * This interface was referenced by `Item`'s JSON-Schema via the `create.schema`
4823
+ * link.
4824
+ */
4562
4825
  export interface ItemCreateSchema {
4563
4826
  data: {
4564
4827
  type: ItemType1;
@@ -4616,7 +4879,10 @@ export interface ItemDuplicateJobSchema {
4616
4879
  data: Item;
4617
4880
  included: ItemType[];
4618
4881
  }
4619
- /** This interface was referenced by `Item`'s JSON-Schema via the `update.schema` link. */
4882
+ /**
4883
+ * This interface was referenced by `Item`'s JSON-Schema via the `update.schema`
4884
+ * link.
4885
+ */
4620
4886
  export interface ItemUpdateSchema {
4621
4887
  data: {
4622
4888
  type: ItemType1;
@@ -4643,7 +4909,10 @@ export interface ItemUpdateSchema {
4643
4909
  status?: null | ('draft' | 'updated' | 'published');
4644
4910
  /** Whether the current record is valid or not */
4645
4911
  is_valid?: boolean;
4646
- /** The ID of the current record version (for optimistic locking, see the example) */
4912
+ /**
4913
+ * The ID of the current record version (for optimistic locking, see the
4914
+ * example)
4915
+ */
4647
4916
  current_version?: string;
4648
4917
  /** The new stage to move the record to */
4649
4918
  stage?: string | null;
@@ -4655,7 +4924,8 @@ export interface ItemUpdateSchema {
4655
4924
  };
4656
4925
  /**
4657
4926
  * The entity (account/collaborator/access token/sso user) who created the
4658
- * record. It must be an object with `type` (e.g. 'account') and `id` properties.
4927
+ * record. It must be an object with `type` (e.g. 'account') and `id`
4928
+ * properties.
4659
4929
  */
4660
4930
  creator?: {
4661
4931
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -4678,7 +4948,10 @@ export interface ItemUpdateTargetSchema {
4678
4948
  export interface ItemReferencesTargetSchema {
4679
4949
  data: Item[];
4680
4950
  }
4681
- /** This interface was referenced by `Item`'s JSON-Schema via the `self.targetSchema` link. */
4951
+ /**
4952
+ * This interface was referenced by `Item`'s JSON-Schema via the
4953
+ * `self.targetSchema` link.
4954
+ */
4682
4955
  export interface ItemSelfTargetSchema {
4683
4956
  data: Item;
4684
4957
  }
@@ -4689,7 +4962,10 @@ export interface ItemSelfTargetSchema {
4689
4962
  export interface ItemDestroyTargetSchema {
4690
4963
  data: Job;
4691
4964
  }
4692
- /** This interface was referenced by `Item`'s JSON-Schema via the `destroy.jobSchema` link. */
4965
+ /**
4966
+ * This interface was referenced by `Item`'s JSON-Schema via the
4967
+ * `destroy.jobSchema` link.
4968
+ */
4693
4969
  export interface ItemDestroyJobSchema {
4694
4970
  data: Item;
4695
4971
  }
@@ -5013,7 +5289,8 @@ export interface ItemVersionSelfTargetSchema {
5013
5289
  /**
5014
5290
  * Every file you upload to DatoCMS will be retrievable from this endpoint.
5015
5291
  *
5016
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "upload".
5292
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
5293
+ * "upload".
5017
5294
  */
5018
5295
  export interface Upload {
5019
5296
  type: UploadType;
@@ -5072,7 +5349,8 @@ export interface UploadAttributes {
5072
5349
  default_field_metadata: {
5073
5350
  /**
5074
5351
  * This interface was referenced by `undefined`'s JSON-Schema definition via
5075
- * the `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
5352
+ * the `patternProperty`
5353
+ * "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
5076
5354
  */
5077
5355
  [k: string]: {
5078
5356
  /** Alternate text for the asset */
@@ -5138,13 +5416,17 @@ export interface UploadRelationships {
5138
5416
  /**
5139
5417
  * JSON API data
5140
5418
  *
5141
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "data".
5419
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
5420
+ * "data".
5142
5421
  */
5143
5422
  export interface UploadData {
5144
5423
  type: UploadType;
5145
5424
  id: UploadIdentity;
5146
5425
  }
5147
- /** This interface was referenced by `Upload`'s JSON-Schema via the `create.schema` link. */
5426
+ /**
5427
+ * This interface was referenced by `Upload`'s JSON-Schema via the
5428
+ * `create.schema` link.
5429
+ */
5148
5430
  export interface UploadCreateSchema {
5149
5431
  data: {
5150
5432
  type: UploadType;
@@ -5229,7 +5511,10 @@ export interface UploadSelfTargetSchema {
5229
5511
  export interface UploadDestroyTargetSchema {
5230
5512
  data: Upload;
5231
5513
  }
5232
- /** This interface was referenced by `Upload`'s JSON-Schema via the `update.schema` link. */
5514
+ /**
5515
+ * This interface was referenced by `Upload`'s JSON-Schema via the
5516
+ * `update.schema` link.
5517
+ */
5233
5518
  export interface UploadUpdateSchema {
5234
5519
  data: {
5235
5520
  type: UploadType;
@@ -5358,7 +5643,10 @@ export interface UploadBatchDestroyJobSchema {
5358
5643
  export interface UploadReferencesTargetSchema {
5359
5644
  data: Item[];
5360
5645
  }
5361
- /** This interface was referenced by `Upload`'s JSON-Schema via the `bulk_tag.schema` link. */
5646
+ /**
5647
+ * This interface was referenced by `Upload`'s JSON-Schema via the
5648
+ * `bulk_tag.schema` link.
5649
+ */
5362
5650
  export interface UploadBulkTagSchema {
5363
5651
  data: {
5364
5652
  /** JSON API type field */
@@ -5879,21 +6167,31 @@ export interface WebhookAttributes {
5879
6167
  };
5880
6168
  /** All the events you will be notified for */
5881
6169
  events: unknown[];
5882
- /** Specifies which API version to use when serializing entities in the webhook payload */
6170
+ /**
6171
+ * Specifies which API version to use when serializing entities in the webhook
6172
+ * payload
6173
+ */
5883
6174
  payload_api_version: string;
5884
- /** Whether the you want records present in the payload to show blocks expanded or not */
6175
+ /**
6176
+ * Whether the you want records present in the payload to show blocks expanded
6177
+ * or not
6178
+ */
5885
6179
  nested_items_in_payload: boolean;
5886
6180
  }
5887
6181
  /**
5888
6182
  * JSON API data
5889
6183
  *
5890
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "data".
6184
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
6185
+ * "data".
5891
6186
  */
5892
6187
  export interface WebhookData {
5893
6188
  type: WebhookType;
5894
6189
  id: WebhookIdentity;
5895
6190
  }
5896
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `create.schema` link. */
6191
+ /**
6192
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
6193
+ * `create.schema` link.
6194
+ */
5897
6195
  export interface WebhookCreateSchema {
5898
6196
  data: {
5899
6197
  type: WebhookType;
@@ -5936,7 +6234,10 @@ export interface WebhookCreateSchema {
5936
6234
  export interface WebhookCreateTargetSchema {
5937
6235
  data: Webhook;
5938
6236
  }
5939
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `update.schema` link. */
6237
+ /**
6238
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
6239
+ * `update.schema` link.
6240
+ */
5940
6241
  export interface WebhookUpdateSchema {
5941
6242
  data: {
5942
6243
  type: WebhookType;
@@ -6744,7 +7045,10 @@ export interface SsoGroupInstancesTargetSchema {
6744
7045
  export interface SsoGroupCopyRolesTargetSchema {
6745
7046
  data: SsoGroup;
6746
7047
  }
6747
- /** This interface was referenced by `SsoGroup`'s JSON-Schema via the `update.schema` link. */
7048
+ /**
7049
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
7050
+ * `update.schema` link.
7051
+ */
6748
7052
  export interface SsoGroupUpdateSchema {
6749
7053
  data: {
6750
7054
  type: SsoGroupType;
@@ -6870,7 +7174,10 @@ export interface SsoSettingsUpdateSchema {
6870
7174
  idp_saml_metadata_url: null | string;
6871
7175
  };
6872
7176
  relationships: {
6873
- /** The default role assigned to SSO users that do not belong to any SSO group */
7177
+ /**
7178
+ * The default role assigned to SSO users that do not belong to any SSO
7179
+ * group
7180
+ */
6874
7181
  default_role: {
6875
7182
  data: RoleData;
6876
7183
  };
@@ -6975,7 +7282,10 @@ export interface PublicInfoAttributes {
6975
7282
  logo_url: null | string;
6976
7283
  /** Specifies whether the project is in white-label mode */
6977
7284
  white_label: boolean;
6978
- /** Template URL to download specific I18n messages (for white-label projects only) */
7285
+ /**
7286
+ * Template URL to download specific I18n messages (for white-label projects
7287
+ * only)
7288
+ */
6979
7289
  custom_i18n_messages_template_url: null | string;
6980
7290
  /** Specifies the color-scheme for the project */
6981
7291
  theme: {
@@ -7152,7 +7462,8 @@ export interface UploadTagAttributes {
7152
7462
  /**
7153
7463
  * JSON API data
7154
7464
  *
7155
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "data".
7465
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
7466
+ * `definition` "data".
7156
7467
  */
7157
7468
  export interface UploadTagData {
7158
7469
  type: UploadTagType;
@@ -7232,7 +7543,8 @@ export interface UploadSmartTagInstancesTargetSchema {
7232
7543
  /**
7233
7544
  * A site represents a specific DatoCMS administrative area
7234
7545
  *
7235
- * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition` "site".
7546
+ * This interface was referenced by `DatoApi`'s JSON-Schema via the `definition`
7547
+ * "site".
7236
7548
  */
7237
7549
  export interface Site {
7238
7550
  type: SiteType;
@@ -7349,7 +7661,8 @@ export interface SiteRelationships {
7349
7661
  /**
7350
7662
  * Meta attributes
7351
7663
  *
7352
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "meta".
7664
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
7665
+ * "meta".
7353
7666
  */
7354
7667
  export interface SiteMeta {
7355
7668
  /** Whether the Improved API Timezone Management option is active or not */
@@ -7358,18 +7671,25 @@ export interface SiteMeta {
7358
7671
  /**
7359
7672
  * JSON API data
7360
7673
  *
7361
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "data".
7674
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
7675
+ * "data".
7362
7676
  */
7363
7677
  export interface SiteData {
7364
7678
  type: SiteType;
7365
7679
  id: SiteIdentity;
7366
7680
  }
7367
- /** This interface was referenced by `Site`'s JSON-Schema via the `self.targetSchema` link. */
7681
+ /**
7682
+ * This interface was referenced by `Site`'s JSON-Schema via the
7683
+ * `self.targetSchema` link.
7684
+ */
7368
7685
  export interface SiteSelfTargetSchema {
7369
7686
  data: Site;
7370
7687
  included?: (ItemType | Field | Upload | Fieldset | Item | Account)[];
7371
7688
  }
7372
- /** This interface was referenced by `Site`'s JSON-Schema via the `update.schema` link. */
7689
+ /**
7690
+ * This interface was referenced by `Site`'s JSON-Schema via the `update.schema`
7691
+ * link.
7692
+ */
7373
7693
  export interface SiteUpdateSchema {
7374
7694
  data: {
7375
7695
  type: SiteType;
@@ -7445,7 +7765,10 @@ export interface SiteUpdateSchema {
7445
7765
  * two-factor authentication
7446
7766
  */
7447
7767
  require_2fa?: boolean;
7448
- /** Specifies whether you want IPs to be tracked in the Project usages section */
7768
+ /**
7769
+ * Specifies whether you want IPs to be tracked in the Project usages
7770
+ * section
7771
+ */
7449
7772
  ip_tracking_enabled?: boolean;
7450
7773
  };
7451
7774
  meta?: {
@@ -7466,7 +7789,10 @@ export interface SiteUpdateSchema {
7466
7789
  export interface SiteUpdateTargetSchema {
7467
7790
  data: Job;
7468
7791
  }
7469
- /** This interface was referenced by `Site`'s JSON-Schema via the `update.jobSchema` link. */
7792
+ /**
7793
+ * This interface was referenced by `Site`'s JSON-Schema via the
7794
+ * `update.jobSchema` link.
7795
+ */
7470
7796
  export interface SiteUpdateJobSchema {
7471
7797
  data: Site;
7472
7798
  }
@@ -7530,7 +7856,10 @@ export interface WorkflowAttributes {
7530
7856
  }[]
7531
7857
  ];
7532
7858
  }
7533
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `create.schema` link. */
7859
+ /**
7860
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
7861
+ * `create.schema` link.
7862
+ */
7534
7863
  export interface WorkflowCreateSchema {
7535
7864
  data: {
7536
7865
  type: WorkflowType;
@@ -7572,7 +7901,10 @@ export interface WorkflowCreateSchema {
7572
7901
  export interface WorkflowCreateTargetSchema {
7573
7902
  data: Workflow;
7574
7903
  }
7575
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `update.schema` link. */
7904
+ /**
7905
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
7906
+ * `update.schema` link.
7907
+ */
7576
7908
  export interface WorkflowUpdateSchema {
7577
7909
  data: {
7578
7910
  type: WorkflowType;