datocms-plugin-sdk 0.5.2 → 0.5.3

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.
@@ -16,7 +16,8 @@ export declare type RoleIdentity = string;
16
16
  /**
17
17
  * ID of item type
18
18
  *
19
- * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition` "identity".
19
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
20
+ * `definition` "identity".
20
21
  *
21
22
  * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition` "id".
22
23
  */
@@ -24,7 +25,8 @@ export declare type ItemTypeIdentity = string;
24
25
  /**
25
26
  * ID of workflow
26
27
  *
27
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "identity".
28
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
29
+ * `definition` "identity".
28
30
  *
29
31
  * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "id".
30
32
  */
@@ -32,7 +34,8 @@ export declare type WorkflowIdentity = string;
32
34
  /**
33
35
  * ID of environment. Can only contain lowercase letters, numbers and dashes
34
36
  *
35
- * This interface was referenced by `Environment`'s JSON-Schema via the `definition` "identity".
37
+ * This interface was referenced by `Environment`'s JSON-Schema via the
38
+ * `definition` "identity".
36
39
  *
37
40
  * This interface was referenced by `Environment`'s JSON-Schema via the `definition` "id".
38
41
  */
@@ -40,9 +43,11 @@ export declare type EnvironmentIdentity = string;
40
43
  /**
41
44
  * ID of build_trigger
42
45
  *
43
- * This interface was referenced by `BuildTrigger`'s JSON-Schema via the `definition` "identity".
46
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
47
+ * `definition` "identity".
44
48
  *
45
- * This interface was referenced by `BuildTrigger`'s JSON-Schema via the `definition` "id".
49
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
50
+ * `definition` "id".
46
51
  */
47
52
  export declare type BuildTriggerIdentity = string;
48
53
  /**
@@ -68,7 +73,8 @@ export declare type SsoUserType = 'sso_user';
68
73
  /**
69
74
  * ID of user
70
75
  *
71
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "identity".
76
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
77
+ * "identity".
72
78
  *
73
79
  * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "id".
74
80
  */
@@ -82,7 +88,8 @@ export declare type SsoGroupType = 'sso_group';
82
88
  /**
83
89
  * ID of group
84
90
  *
85
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "identity".
91
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
92
+ * `definition` "identity".
86
93
  *
87
94
  * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "id".
88
95
  */
@@ -90,15 +97,18 @@ export declare type SsoGroupIdentity = string;
90
97
  /**
91
98
  * JSON API type field
92
99
  *
93
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition` "type".
100
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
101
+ * `definition` "type".
94
102
  */
95
103
  export declare type AuditLogEventType = 'audit_log_event';
96
104
  /**
97
105
  * ULID of event (https://github.com/ulid/spec)
98
106
  *
99
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition` "identity".
107
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
108
+ * `definition` "identity".
100
109
  *
101
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition` "id".
110
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
111
+ * `definition` "id".
102
112
  */
103
113
  export declare type AuditLogEventIdentity = string;
104
114
  /**
@@ -110,7 +120,8 @@ export declare type AccountType = 'account';
110
120
  /**
111
121
  * ID of account
112
122
  *
113
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "identity".
123
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
124
+ * "identity".
114
125
  *
115
126
  * This interface was referenced by `Account`'s JSON-Schema via the `definition` "id".
116
127
  */
@@ -124,7 +135,8 @@ export declare type SitePlanType = 'site_plan';
124
135
  /**
125
136
  * ID of plan
126
137
  *
127
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "identity".
138
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
139
+ * `definition` "identity".
128
140
  *
129
141
  * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "id".
130
142
  */
@@ -138,7 +150,8 @@ export declare type MenuItemType = 'menu_item';
138
150
  /**
139
151
  * ID of menu item
140
152
  *
141
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "identity".
153
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
154
+ * `definition` "identity".
142
155
  *
143
156
  * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "id".
144
157
  */
@@ -146,10 +159,14 @@ export declare type MenuItemIdentity = string;
146
159
  /**
147
160
  * JSON API type field
148
161
  *
149
- * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition` "type".
162
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
163
+ * `definition` "type".
150
164
  */
151
165
  export declare type ItemTypeType = 'item_type';
152
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `instances.hrefSchema` link. */
166
+ /**
167
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
168
+ * `instances.hrefSchema` link.
169
+ */
153
170
  export declare type MenuItemInstancesHrefSchema = {
154
171
  filter?: {
155
172
  /** IDs to fetch, comma separated */
@@ -213,7 +230,8 @@ export declare type FieldsetType = 'fieldset';
213
230
  /**
214
231
  * ID of fieldset
215
232
  *
216
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "identity".
233
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
234
+ * `definition` "identity".
217
235
  *
218
236
  * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "id".
219
237
  */
@@ -227,7 +245,8 @@ export declare type SessionType = 'session';
227
245
  /**
228
246
  * JSON web token for the session
229
247
  *
230
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "identity".
248
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
249
+ * "identity".
231
250
  *
232
251
  * This interface was referenced by `Session`'s JSON-Schema via the `definition` "id".
233
252
  */
@@ -235,13 +254,15 @@ export declare type SessionIdentity = string;
235
254
  /**
236
255
  * JSON API type field
237
256
  *
238
- * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "type".
257
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
258
+ * `definition` "type".
239
259
  */
240
260
  export declare type AccessTokenType = 'access_token';
241
261
  /**
242
262
  * ID of access_token
243
263
  *
244
- * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "identity".
264
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
265
+ * `definition` "identity".
245
266
  *
246
267
  * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "id".
247
268
  */
@@ -255,7 +276,8 @@ export declare type PluginType = 'plugin';
255
276
  /**
256
277
  * ID of plugin
257
278
  *
258
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "identity".
279
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
280
+ * "identity".
259
281
  *
260
282
  * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "id".
261
283
  */
@@ -269,7 +291,8 @@ export declare type JobResultType = 'job_result';
269
291
  /**
270
292
  * ID of job result
271
293
  *
272
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "identity".
294
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
295
+ * `definition` "identity".
273
296
  *
274
297
  * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "id".
275
298
  */
@@ -277,7 +300,8 @@ export declare type JobResultIdentity = string;
277
300
  /**
278
301
  * JSON API type field
279
302
  *
280
- * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the `definition` "type".
303
+ * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
304
+ * `definition` "type".
281
305
  */
282
306
  export declare type SubscriptionLimitType = 'subscription_limit';
283
307
  /**
@@ -286,7 +310,8 @@ export declare type SubscriptionLimitType = 'subscription_limit';
286
310
  * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
287
311
  * `definition` "identity".
288
312
  *
289
- * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the `definition` "id".
313
+ * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
314
+ * `definition` "id".
290
315
  */
291
316
  export declare type SubscriptionLimitIdentity = string;
292
317
  /**
@@ -302,19 +327,22 @@ export declare type SubscriptionFeatureType = 'subscription_feature';
302
327
  * This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
303
328
  * `definition` "identity".
304
329
  *
305
- * This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the `definition` "id".
330
+ * This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
331
+ * `definition` "id".
306
332
  */
307
333
  export declare type SubscriptionFeatureIdentity = string;
308
334
  /**
309
335
  * JSON API type field
310
336
  *
311
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "type".
337
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
338
+ * `definition` "type".
312
339
  */
313
340
  export declare type BuildEventType = 'build_event';
314
341
  /**
315
342
  * ID of menu item
316
343
  *
317
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "identity".
344
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
345
+ * `definition` "identity".
318
346
  *
319
347
  * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "id".
320
348
  */
@@ -322,39 +350,44 @@ export declare type BuildEventIdentity = string;
322
350
  /**
323
351
  * JSON API type field
324
352
  *
325
- * This interface was referenced by `BuildTrigger`'s JSON-Schema via the `definition` "type".
353
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
354
+ * `definition` "type".
326
355
  */
327
356
  export declare type BuildTriggerType = 'build_trigger';
328
- /** This interface was referenced by `Item`'s JSON-Schema via the `instances.hrefSchema` link. */
357
+ /**
358
+ * This interface was referenced by `Item`'s JSON-Schema via the
359
+ * `instances.hrefSchema` link.
360
+ */
329
361
  export declare type ItemInstancesHrefSchema = {
330
362
  /**
331
- * For Modular Content fields and Structured Text fields. If set, returns full payload
332
- * for nested blocks instead of IDs
363
+ * For Modular Content fields and Structured Text fields. If set, returns full
364
+ * payload for nested blocks instead of IDs
333
365
  */
334
366
  nested?: string;
335
367
  /** Attributes to filter records */
336
368
  filter?: {
337
369
  /**
338
- * Record (or block record) IDs to fetch, comma separated. If you use this filter,
339
- * you *must not* use `filter[type]` or `filter[fields]`
370
+ * Record (or block record) IDs to fetch, comma separated. If you use this
371
+ * filter, you *must not* use `filter[type]` or `filter[fields]`
340
372
  */
341
373
  ids?: string;
342
374
  /**
343
- * Model ID or `api_key` to filter. If you use this filter, you *must not* use
344
- * `filter[ids]`. Comma separated values are accepted, but you *must not* use
345
- * `filter[fields]` in this case
375
+ * Model ID or `api_key` to filter. If you use this filter, you *must not*
376
+ * use `filter[ids]`. Comma separated values are accepted, but you *must
377
+ * not* use `filter[fields]` in this case
346
378
  */
347
379
  type?: string;
348
380
  /**
349
- * Textual query to match. You *must not* use `filter[ids]`. If `locale` is defined,
350
- * search within that locale. Otherwise environment's main locale will be used.
381
+ * Textual query to match. You *must not* use `filter[ids]`. If `locale` is
382
+ * defined, search within that locale. Otherwise environment's main locale
383
+ * will be used.
351
384
  */
352
385
  query?: string;
353
386
  /**
354
387
  * Same as [GraphQL API records
355
- * filters](/docs/content-delivery-api/filtering-records). Use snake_case for fields
356
- * names. If `locale` is defined, search within that locale. Otherwise environment's
357
- * main locale will be used.
388
+ * filters](/docs/content-delivery-api/filtering-records). Use snake_case
389
+ * for fields names. If `locale` is defined, search within that locale.
390
+ * Otherwise environment's main locale will be used.
358
391
  */
359
392
  fields?: {
360
393
  [k: string]: unknown;
@@ -362,8 +395,8 @@ export declare type ItemInstancesHrefSchema = {
362
395
  [k: string]: unknown;
363
396
  };
364
397
  /**
365
- * When `filter[query]` or `field[fields]` is defined, filter by this locale. Default:
366
- * environment's main locale
398
+ * When `filter[query]` or `field[fields]` is defined, filter by this locale.
399
+ * Default: environment's main locale
367
400
  */
368
401
  locale?: string;
369
402
  /** Attributes to manage results pagination */
@@ -375,28 +408,31 @@ export declare type ItemInstancesHrefSchema = {
375
408
  [k: string]: unknown;
376
409
  };
377
410
  /**
378
- * Fields used to order results. You *must* specify also `filter[type]` with one
379
- * element only to be able use this option. Format:
411
+ * Fields used to order results. You *must* specify also `filter[type]` with
412
+ * one element only to be able use this option. Format:
380
413
  * `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
381
414
  */
382
415
  order_by?: string;
383
416
  /**
384
- * Whether you want the currently published versions (`published`, default) of your
385
- * records, or the latest available (`current`)
417
+ * Whether you want the currently published versions (`published`, default) of
418
+ * your records, or the latest available (`current`)
386
419
  */
387
420
  version?: string;
388
421
  [k: string]: unknown;
389
422
  };
390
- /** This interface was referenced by `Item`'s JSON-Schema via the `references.hrefSchema` link. */
423
+ /**
424
+ * This interface was referenced by `Item`'s JSON-Schema via the
425
+ * `references.hrefSchema` link.
426
+ */
391
427
  export declare type ItemReferencesHrefSchema = {
392
428
  /**
393
- * For Modular Content fields and Structured Text fields, return full payload for
394
- * nested blocks instead of IDs
429
+ * For Modular Content fields and Structured Text fields, return full payload
430
+ * for nested blocks instead of IDs
395
431
  */
396
432
  nested?: 'true';
397
433
  /**
398
- * Retrieve only the selected type of version that is linked to the record; current,
399
- * published or both
434
+ * Retrieve only the selected type of version that is linked to the record;
435
+ * current, published or both
400
436
  */
401
437
  version?: null | ('current' | 'published' | 'published-or-current');
402
438
  [k: string]: unknown;
@@ -404,39 +440,54 @@ export declare type ItemReferencesHrefSchema = {
404
440
  /** This interface was referenced by `Item`'s JSON-Schema via the `self.hrefSchema` link. */
405
441
  export declare type ItemSelfHrefSchema = {
406
442
  /**
407
- * For Modular Content fields and Structured Text fields. If set, returns full payload
408
- * for nested blocks instead of IDs
443
+ * For Modular Content fields and Structured Text fields. If set, returns full
444
+ * payload for nested blocks instead of IDs
409
445
  */
410
446
  nested?: string;
411
447
  /**
412
- * Whether you want the currently published versions (`published`, default) of your
413
- * records, or the latest available (`current`)
448
+ * Whether you want the currently published versions (`published`, default) of
449
+ * your records, or the latest available (`current`)
414
450
  */
415
451
  version?: string;
416
452
  [k: string]: unknown;
417
453
  };
418
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_destroy.hrefSchema` link. */
454
+ /**
455
+ * This interface was referenced by `Item`'s JSON-Schema via the
456
+ * `batch_destroy.hrefSchema` link.
457
+ */
419
458
  export declare type ItemBatchDestroyHrefSchema = {
420
459
  /** IDs of records to delete, comma separated */
421
460
  'filter[ids]': string;
422
461
  };
423
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_publish.hrefSchema` link. */
462
+ /**
463
+ * This interface was referenced by `Item`'s JSON-Schema via the
464
+ * `batch_publish.hrefSchema` link.
465
+ */
424
466
  export declare type ItemBatchPublishHrefSchema = {
425
467
  /** IDs of records to publish, comma separated */
426
468
  'filter[ids]': string;
427
469
  };
428
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_unpublish.hrefSchema` link. */
470
+ /**
471
+ * This interface was referenced by `Item`'s JSON-Schema via the
472
+ * `batch_unpublish.hrefSchema` link.
473
+ */
429
474
  export declare type ItemBatchUnpublishHrefSchema = {
430
475
  /** IDs of records to unpublish, comma separated */
431
476
  'filter[ids]': string;
432
477
  };
433
- /** This interface was referenced by `Item`'s JSON-Schema via the `publish.hrefSchema` link. */
478
+ /**
479
+ * This interface was referenced by `Item`'s JSON-Schema via the
480
+ * `publish.hrefSchema` link.
481
+ */
434
482
  export declare type ItemPublishHrefSchema = {
435
483
  /** If the record references other draft records, force a recursive publication */
436
484
  recursive?: string;
437
485
  [k: string]: unknown;
438
486
  };
439
- /** This interface was referenced by `Item`'s JSON-Schema via the `unpublish.hrefSchema` link. */
487
+ /**
488
+ * This interface was referenced by `Item`'s JSON-Schema via the
489
+ * `unpublish.hrefSchema` link.
490
+ */
440
491
  export declare type ItemUnpublishHrefSchema = {
441
492
  /** If the record is referenced by other published records, unpublish them recursively */
442
493
  recursive?: string;
@@ -445,13 +496,15 @@ export declare type ItemUnpublishHrefSchema = {
445
496
  /**
446
497
  * JSON API type field
447
498
  *
448
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "type".
499
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
500
+ * `definition` "type".
449
501
  */
450
502
  export declare type ItemVersionType = 'item_version';
451
503
  /**
452
504
  * ID of record version
453
505
  *
454
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "identity".
506
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
507
+ * `definition` "identity".
455
508
  *
456
509
  * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "id".
457
510
  */
@@ -465,27 +518,31 @@ export declare type UploadType = 'upload';
465
518
  /**
466
519
  * ID of upload
467
520
  *
468
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "identity".
521
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
522
+ * "identity".
469
523
  *
470
524
  * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "id".
471
525
  */
472
526
  export declare type UploadIdentity = string;
473
- /** This interface was referenced by `Upload`'s JSON-Schema via the `instances.hrefSchema` link. */
527
+ /**
528
+ * This interface was referenced by `Upload`'s JSON-Schema via the
529
+ * `instances.hrefSchema` link.
530
+ */
474
531
  export declare type UploadInstancesHrefSchema = {
475
532
  /** Attributes to filter uploads */
476
533
  filter?: {
477
534
  /** IDs to fetch, comma separated */
478
535
  ids?: string;
479
536
  /**
480
- * Textual query to match. If `locale` is defined, search within that locale.
481
- * Otherwise environment's main locale will be used.
537
+ * Textual query to match. If `locale` is defined, search within that
538
+ * locale. Otherwise environment's main locale will be used.
482
539
  */
483
540
  query?: string;
484
541
  /**
485
542
  * Same as [GraphQL API uploads
486
- * filters](/docs/content-delivery-api/filtering-uploads). Use snake_case for fields
487
- * names. If `locale` is defined, search within that locale. Otherwise environment's
488
- * main locale will be used.
543
+ * filters](/docs/content-delivery-api/filtering-uploads). Use snake_case
544
+ * for fields names. If `locale` is defined, search within that locale.
545
+ * Otherwise environment's main locale will be used.
489
546
  */
490
547
  fields?: {
491
548
  [k: string]: unknown;
@@ -493,13 +550,13 @@ export declare type UploadInstancesHrefSchema = {
493
550
  [k: string]: unknown;
494
551
  };
495
552
  /**
496
- * When `filter[query]` or `field[fields]` is defined, filter by this locale. Default:
497
- * environment's main locale
553
+ * When `filter[query]` or `field[fields]` is defined, filter by this locale.
554
+ * Default: environment's main locale
498
555
  */
499
556
  locale?: string;
500
557
  /**
501
- * Fields used to order results. Format: `<field_name>_<DIRECTION(ASC|DESC)>`. You can
502
- * pass multiple comma separated rules.
558
+ * Fields used to order results. Format: `<field_name>_<DIRECTION(ASC|DESC)>`.
559
+ * You can pass multiple comma separated rules.
503
560
  */
504
561
  order_by?: string;
505
562
  /** Attributes to manage results pagination */
@@ -521,22 +578,28 @@ export declare type UploadBatchAddTagsHrefSchema = {
521
578
  'filter[ids]'?: string;
522
579
  [k: string]: unknown;
523
580
  };
524
- /** This interface was referenced by `Upload`'s JSON-Schema via the `batch_destroy.hrefSchema` link. */
581
+ /**
582
+ * This interface was referenced by `Upload`'s JSON-Schema via the
583
+ * `batch_destroy.hrefSchema` link.
584
+ */
525
585
  export declare type UploadBatchDestroyHrefSchema = {
526
586
  /** IDs to destroy, comma separated */
527
587
  'filter[ids]'?: string;
528
588
  [k: string]: unknown;
529
589
  };
530
- /** This interface was referenced by `Upload`'s JSON-Schema via the `references.hrefSchema` link. */
590
+ /**
591
+ * This interface was referenced by `Upload`'s JSON-Schema via the
592
+ * `references.hrefSchema` link.
593
+ */
531
594
  export declare type UploadReferencesHrefSchema = {
532
595
  /**
533
- * For Modular Content fields and Structured Text fields, return full payload for
534
- * nested blocks instead of IDs
596
+ * For Modular Content fields and Structured Text fields, return full payload
597
+ * for nested blocks instead of IDs
535
598
  */
536
599
  nested?: string;
537
600
  /**
538
- * Retrieve only the selected type of version that is linked to the upload; current,
539
- * published or both
601
+ * Retrieve only the selected type of version that is linked to the upload;
602
+ * current, published or both
540
603
  */
541
604
  version?: null | ('current' | 'published' | 'published-or-current');
542
605
  [k: string]: unknown;
@@ -544,15 +607,18 @@ export declare type UploadReferencesHrefSchema = {
544
607
  /**
545
608
  * JSON API type field
546
609
  *
547
- * This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition` "type".
610
+ * This interface was referenced by `UploadRequest`'s JSON-Schema via the
611
+ * `definition` "type".
548
612
  */
549
613
  export declare type UploadRequestType = 'upload_request';
550
614
  /**
551
615
  * The S3 path where the file will be stored
552
616
  *
553
- * This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition` "identity".
617
+ * This interface was referenced by `UploadRequest`'s JSON-Schema via the
618
+ * `definition` "identity".
554
619
  *
555
- * This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition` "id".
620
+ * This interface was referenced by `UploadRequest`'s JSON-Schema via the
621
+ * `definition` "id".
556
622
  */
557
623
  export declare type UploadRequestIdentity = string;
558
624
  /**
@@ -568,38 +634,42 @@ export declare type ScheduledPublicationType = 'scheduled_publication';
568
634
  * This interface was referenced by `ScheduledPublication`'s JSON-Schema via the
569
635
  * `definition` "identity".
570
636
  *
571
- * This interface was referenced by `ScheduledPublication`'s JSON-Schema via the `definition` "id".
637
+ * This interface was referenced by `ScheduledPublication`'s JSON-Schema via the
638
+ * `definition` "id".
572
639
  */
573
640
  export declare type ScheduledPublicationIdentity = string;
574
641
  /**
575
642
  * JSON API type field
576
643
  *
577
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
578
- * `definition` "type".
644
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
645
+ * the `definition` "type".
579
646
  */
580
647
  export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
581
648
  /**
582
649
  * ID of scheduled_unpublishing
583
650
  *
584
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
585
- * `definition` "identity".
651
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
652
+ * the `definition` "identity".
586
653
  *
587
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
588
- * `definition` "id".
654
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
655
+ * the `definition` "id".
589
656
  */
590
657
  export declare type ScheduledUnpublishingIdentity = string;
591
658
  /**
592
659
  * JSON API type field
593
660
  *
594
- * This interface was referenced by `SearchResult`'s JSON-Schema via the `definition` "type".
661
+ * This interface was referenced by `SearchResult`'s JSON-Schema via the
662
+ * `definition` "type".
595
663
  */
596
664
  export declare type SearchResultType = 'search_result';
597
665
  /**
598
666
  * ID of result
599
667
  *
600
- * This interface was referenced by `SearchResult`'s JSON-Schema via the `definition` "identity".
668
+ * This interface was referenced by `SearchResult`'s JSON-Schema via the
669
+ * `definition` "identity".
601
670
  *
602
- * This interface was referenced by `SearchResult`'s JSON-Schema via the `definition` "id".
671
+ * This interface was referenced by `SearchResult`'s JSON-Schema via the
672
+ * `definition` "id".
603
673
  */
604
674
  export declare type SearchResultIdentity = string;
605
675
  /**
@@ -622,22 +692,25 @@ export declare type SearchResultInstancesHrefSchema = {
622
692
  /**
623
693
  * JSON API type field
624
694
  *
625
- * This interface was referenced by `Environment`'s JSON-Schema via the `definition` "type".
695
+ * This interface was referenced by `Environment`'s JSON-Schema via the
696
+ * `definition` "type".
626
697
  */
627
698
  export declare type EnvironmentType = 'environment';
628
699
  /**
629
700
  * JSON API type field
630
701
  *
631
- * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition` "type".
702
+ * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
703
+ * `definition` "type".
632
704
  */
633
705
  export declare type MaintenanceModeType = 'maintenance_mode';
634
706
  /**
635
707
  * ID of maintenance_mode
636
708
  *
637
- * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition`
638
- * "identity".
709
+ * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
710
+ * `definition` "identity".
639
711
  *
640
- * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition` "id".
712
+ * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
713
+ * `definition` "id".
641
714
  */
642
715
  export declare type MaintenanceModeIdentity = string;
643
716
  /**
@@ -658,7 +731,8 @@ export declare type WebhookType = 'webhook';
658
731
  /**
659
732
  * ID of webhook
660
733
  *
661
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "identity".
734
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
735
+ * "identity".
662
736
  *
663
737
  * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "id".
664
738
  */
@@ -666,13 +740,15 @@ export declare type WebhookIdentity = string;
666
740
  /**
667
741
  * JSON API type field
668
742
  *
669
- * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "type".
743
+ * This interface was referenced by `WebhookCall`'s JSON-Schema via the
744
+ * `definition` "type".
670
745
  */
671
746
  export declare type WebhookCallType = 'webhook_call';
672
747
  /**
673
748
  * ID of webhook call
674
749
  *
675
- * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "identity".
750
+ * This interface was referenced by `WebhookCall`'s JSON-Schema via the
751
+ * `definition` "identity".
676
752
  *
677
753
  * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "id".
678
754
  */
@@ -680,69 +756,83 @@ export declare type WebhookCallIdentity = string;
680
756
  /**
681
757
  * JSON API type field
682
758
  *
683
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `definition` "type".
759
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
760
+ * `definition` "type".
684
761
  */
685
762
  export declare type ItemTypeFilterType = 'item_type_filter';
686
763
  /**
687
764
  * ID of filter
688
765
  *
689
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `definition` "identity".
766
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
767
+ * `definition` "identity".
690
768
  *
691
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `definition` "id".
769
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
770
+ * `definition` "id".
692
771
  */
693
772
  export declare type ItemTypeFilterIdentity = string;
694
773
  /**
695
774
  * JSON API type field
696
775
  *
697
- * This interface was referenced by `UploadFilter`'s JSON-Schema via the `definition` "type".
776
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
777
+ * `definition` "type".
698
778
  */
699
779
  export declare type UploadFilterType = 'upload_filter';
700
780
  /**
701
781
  * ID of filter
702
782
  *
703
- * This interface was referenced by `UploadFilter`'s JSON-Schema via the `definition` "identity".
783
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
784
+ * `definition` "identity".
704
785
  *
705
- * This interface was referenced by `UploadFilter`'s JSON-Schema via the `definition` "id".
786
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
787
+ * `definition` "id".
706
788
  */
707
789
  export declare type UploadFilterIdentity = string;
708
790
  /**
709
791
  * JSON API type field
710
792
  *
711
- * This interface was referenced by `SiteInvitation`'s JSON-Schema via the `definition` "type".
793
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
794
+ * `definition` "type".
712
795
  */
713
796
  export declare type SiteInvitationType = 'site_invitation';
714
797
  /**
715
798
  * ID of invitation
716
799
  *
717
- * This interface was referenced by `SiteInvitation`'s JSON-Schema via the `definition` "identity".
800
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
801
+ * `definition` "identity".
718
802
  *
719
- * This interface was referenced by `SiteInvitation`'s JSON-Schema via the `definition` "id".
803
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
804
+ * `definition` "id".
720
805
  */
721
806
  export declare type SiteInvitationIdentity = string;
722
807
  /**
723
808
  * JSON API type field
724
809
  *
725
- * This interface was referenced by `EditingSession`'s JSON-Schema via the `definition` "type".
810
+ * This interface was referenced by `EditingSession`'s JSON-Schema via the
811
+ * `definition` "type".
726
812
  */
727
813
  export declare type EditingSessionType = 'editing_session';
728
814
  /**
729
815
  * UUID of presence
730
816
  *
731
- * This interface was referenced by `EditingSession`'s JSON-Schema via the `definition` "identity".
817
+ * This interface was referenced by `EditingSession`'s JSON-Schema via the
818
+ * `definition` "identity".
732
819
  *
733
- * This interface was referenced by `EditingSession`'s JSON-Schema via the `definition` "id".
820
+ * This interface was referenced by `EditingSession`'s JSON-Schema via the
821
+ * `definition` "id".
734
822
  */
735
823
  export declare type EditingSessionIdentity = string;
736
824
  /**
737
825
  * JSON API type field
738
826
  *
739
- * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "type".
827
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
828
+ * `definition` "type".
740
829
  */
741
830
  export declare type SsoSettingsType = 'sso_settings';
742
831
  /**
743
832
  * ID
744
833
  *
745
- * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "identity".
834
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
835
+ * `definition` "identity".
746
836
  *
747
837
  * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "id".
748
838
  */
@@ -750,7 +840,8 @@ export declare type SsoSettingsIdentity = string;
750
840
  /**
751
841
  * JSON API type field
752
842
  *
753
- * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the `definition` "type".
843
+ * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
844
+ * `definition` "type".
754
845
  */
755
846
  export declare type WhiteLabelSettingsType = 'white_label_settings';
756
847
  /**
@@ -759,19 +850,22 @@ export declare type WhiteLabelSettingsType = 'white_label_settings';
759
850
  * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
760
851
  * `definition` "identity".
761
852
  *
762
- * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the `definition` "id".
853
+ * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
854
+ * `definition` "id".
763
855
  */
764
856
  export declare type WhiteLabelSettingsIdentity = string;
765
857
  /**
766
858
  * JSON API type field
767
859
  *
768
- * This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "type".
860
+ * This interface was referenced by `PublicInfo`'s JSON-Schema via the
861
+ * `definition` "type".
769
862
  */
770
863
  export declare type PublicInfoType = 'public_info';
771
864
  /**
772
865
  * ID of site
773
866
  *
774
- * This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "identity".
867
+ * This interface was referenced by `PublicInfo`'s JSON-Schema via the
868
+ * `definition` "identity".
775
869
  *
776
870
  * This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "id".
777
871
  */
@@ -779,13 +873,15 @@ export declare type PublicInfoIdentity = string;
779
873
  /**
780
874
  * JSON API type field
781
875
  *
782
- * This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "type".
876
+ * This interface was referenced by `DailyUsage`'s JSON-Schema via the
877
+ * `definition` "type".
783
878
  */
784
879
  export declare type DailyUsageType = 'daily_usage';
785
880
  /**
786
881
  * ID of site
787
882
  *
788
- * This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "identity".
883
+ * This interface was referenced by `DailyUsage`'s JSON-Schema via the
884
+ * `definition` "identity".
789
885
  *
790
886
  * This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "id".
791
887
  */
@@ -793,18 +889,24 @@ export declare type DailyUsageIdentity = string;
793
889
  /**
794
890
  * JSON API type field
795
891
  *
796
- * This interface was referenced by `UsageCounter`'s JSON-Schema via the `definition` "type".
892
+ * This interface was referenced by `UsageCounter`'s JSON-Schema via the
893
+ * `definition` "type".
797
894
  */
798
895
  export declare type UsageCounterType = 'usage_counter';
799
896
  /**
800
897
  * Name of the counter
801
898
  *
802
- * This interface was referenced by `UsageCounter`'s JSON-Schema via the `definition` "identity".
899
+ * This interface was referenced by `UsageCounter`'s JSON-Schema via the
900
+ * `definition` "identity".
803
901
  *
804
- * This interface was referenced by `UsageCounter`'s JSON-Schema via the `definition` "id".
902
+ * This interface was referenced by `UsageCounter`'s JSON-Schema via the
903
+ * `definition` "id".
805
904
  */
806
905
  export declare type UsageCounterIdentity = 'assets_path_bytes' | 'assets_referrer_bytes' | 'assets_ip_bytes' | 'cda_access_token_id_bytes' | 'cda_access_token_id_requests' | 'cda_referrer_bytes' | 'cda_referrer_requests' | 'cda_ip_bytes' | 'cda_ip_requests' | 'cma_endpoint_bytes' | 'cma_endpoint_requests' | 'cma_user_bytes' | 'cma_user_requests' | 'cma_ip_bytes' | 'cma_ip_requests' | 'video_path_seconds';
807
- /** This interface was referenced by `UsageCounter`'s JSON-Schema via the `self.hrefSchema` link. */
906
+ /**
907
+ * This interface was referenced by `UsageCounter`'s JSON-Schema via the
908
+ * `self.hrefSchema` link.
909
+ */
808
910
  export declare type UsageCounterSelfHrefSchema = {
809
911
  /** The time period upon which counters will be returned */
810
912
  period?: 'today' | 'current_month' | 'last_month';
@@ -818,7 +920,8 @@ export declare type UploadTagType = 'upload_tag';
818
920
  /**
819
921
  * ID of upload tag
820
922
  *
821
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "identity".
923
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
924
+ * `definition` "identity".
822
925
  *
823
926
  * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "id".
824
927
  */
@@ -826,15 +929,18 @@ export declare type UploadTagIdentity = string;
826
929
  /**
827
930
  * JSON API type field
828
931
  *
829
- * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the `definition` "type".
932
+ * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
933
+ * `definition` "type".
830
934
  */
831
935
  export declare type UploadSmartTagType = 'upload_smart_tag';
832
936
  /**
833
937
  * ID of upload tag
834
938
  *
835
- * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the `definition` "identity".
939
+ * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
940
+ * `definition` "identity".
836
941
  *
837
- * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the `definition` "id".
942
+ * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
943
+ * `definition` "id".
838
944
  */
839
945
  export declare type UploadSmartTagIdentity = string;
840
946
  /**
@@ -899,10 +1005,11 @@ export interface DatoCMSSiteAPI {
899
1005
  [k: string]: unknown;
900
1006
  }
901
1007
  /**
902
- * A Role represents a specific set of actions an editor (or an API token) can perform on
903
- * your administrative area.
1008
+ * A Role represents a specific set of actions an editor (or an API token) can
1009
+ * perform on your administrative area.
904
1010
  *
905
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "role".
1011
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
1012
+ * `definition` "role".
906
1013
  */
907
1014
  export interface Role {
908
1015
  type: RoleType;
@@ -914,7 +1021,8 @@ export interface Role {
914
1021
  /**
915
1022
  * JSON API attributes
916
1023
  *
917
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "attributes".
1024
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
1025
+ * "attributes".
918
1026
  */
919
1027
  export interface RoleAttributes {
920
1028
  /** The name of the role */
@@ -969,8 +1077,8 @@ export interface RoleAttributes {
969
1077
  /** Permitted content scope */
970
1078
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
971
1079
  /**
972
- * Permitted localized content in this locale. Required when `localization_scope` is
973
- * `localized`
1080
+ * Permitted localized content in this locale. Required when
1081
+ * `localization_scope` is `localized`
974
1082
  */
975
1083
  locale?: string | null;
976
1084
  }[];
@@ -988,8 +1096,8 @@ export interface RoleAttributes {
988
1096
  /** Permitted content scope */
989
1097
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
990
1098
  /**
991
- * Permitted localized content in this locale. Required when `localization_scope` is
992
- * `localized`
1099
+ * Permitted localized content in this locale. Required when
1100
+ * `localization_scope` is `localized`
993
1101
  */
994
1102
  locale?: string | null;
995
1103
  }[];
@@ -1003,8 +1111,8 @@ export interface RoleAttributes {
1003
1111
  /** Permitted content scope */
1004
1112
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1005
1113
  /**
1006
- * Permitted localized content in this locale. Required when `localization_scope` is
1007
- * `localized`
1114
+ * Permitted localized content in this locale. Required when
1115
+ * `localization_scope` is `localized`
1008
1116
  */
1009
1117
  locale?: string | null;
1010
1118
  }[];
@@ -1018,8 +1126,8 @@ export interface RoleAttributes {
1018
1126
  /** Permitted content scope */
1019
1127
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1020
1128
  /**
1021
- * Permitted localized content in this locale. Required when `localization_scope` is
1022
- * `localized`
1129
+ * Permitted localized content in this locale. Required when
1130
+ * `localization_scope` is `localized`
1023
1131
  */
1024
1132
  locale?: string | null;
1025
1133
  }[];
@@ -1035,7 +1143,8 @@ export interface RoleAttributes {
1035
1143
  /**
1036
1144
  * JSON API links
1037
1145
  *
1038
- * This interface was referenced by `Role`'s JSON-Schema via the `definition` "relationships".
1146
+ * This interface was referenced by `Role`'s JSON-Schema via the `definition`
1147
+ * "relationships".
1039
1148
  */
1040
1149
  export interface RoleRelationships {
1041
1150
  /** The roles from which this role inherits permissions */
@@ -1110,8 +1219,8 @@ export interface RoleMeta {
1110
1219
  /** Permitted content scope */
1111
1220
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1112
1221
  /**
1113
- * Permitted localized content in this locale. Required when `localization_scope`
1114
- * is `localized`
1222
+ * Permitted localized content in this locale. Required when
1223
+ * `localization_scope` is `localized`
1115
1224
  */
1116
1225
  locale?: string | null;
1117
1226
  }[];
@@ -1129,8 +1238,8 @@ export interface RoleMeta {
1129
1238
  /** Permitted content scope */
1130
1239
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1131
1240
  /**
1132
- * Permitted localized content in this locale. Required when `localization_scope`
1133
- * is `localized`
1241
+ * Permitted localized content in this locale. Required when
1242
+ * `localization_scope` is `localized`
1134
1243
  */
1135
1244
  locale?: string | null;
1136
1245
  }[];
@@ -1144,8 +1253,8 @@ export interface RoleMeta {
1144
1253
  /** Permitted content scope */
1145
1254
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1146
1255
  /**
1147
- * Permitted localized content in this locale. Required when `localization_scope`
1148
- * is `localized`
1256
+ * Permitted localized content in this locale. Required when
1257
+ * `localization_scope` is `localized`
1149
1258
  */
1150
1259
  locale?: string | null;
1151
1260
  }[];
@@ -1159,8 +1268,8 @@ export interface RoleMeta {
1159
1268
  /** Permitted content scope */
1160
1269
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1161
1270
  /**
1162
- * Permitted localized content in this locale. Required when `localization_scope`
1163
- * is `localized`
1271
+ * Permitted localized content in this locale. Required when
1272
+ * `localization_scope` is `localized`
1164
1273
  */
1165
1274
  locale?: string | null;
1166
1275
  }[];
@@ -1232,8 +1341,8 @@ export interface RoleCreateSchema {
1232
1341
  /** Permitted content scope */
1233
1342
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1234
1343
  /**
1235
- * Permitted localized content in this locale. Required when `localization_scope`
1236
- * is `localized`
1344
+ * Permitted localized content in this locale. Required when
1345
+ * `localization_scope` is `localized`
1237
1346
  */
1238
1347
  locale?: string | null;
1239
1348
  }[];
@@ -1251,8 +1360,8 @@ export interface RoleCreateSchema {
1251
1360
  /** Permitted content scope */
1252
1361
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1253
1362
  /**
1254
- * Permitted localized content in this locale. Required when `localization_scope`
1255
- * is `localized`
1363
+ * Permitted localized content in this locale. Required when
1364
+ * `localization_scope` is `localized`
1256
1365
  */
1257
1366
  locale?: string | null;
1258
1367
  }[];
@@ -1266,8 +1375,8 @@ export interface RoleCreateSchema {
1266
1375
  /** Permitted content scope */
1267
1376
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1268
1377
  /**
1269
- * Permitted localized content in this locale. Required when `localization_scope`
1270
- * is `localized`
1378
+ * Permitted localized content in this locale. Required when
1379
+ * `localization_scope` is `localized`
1271
1380
  */
1272
1381
  locale?: string | null;
1273
1382
  }[];
@@ -1281,8 +1390,8 @@ export interface RoleCreateSchema {
1281
1390
  /** Permitted content scope */
1282
1391
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1283
1392
  /**
1284
- * Permitted localized content in this locale. Required when `localization_scope`
1285
- * is `localized`
1393
+ * Permitted localized content in this locale. Required when
1394
+ * `localization_scope` is `localized`
1286
1395
  */
1287
1396
  locale?: string | null;
1288
1397
  }[];
@@ -1305,7 +1414,10 @@ export interface RoleCreateSchema {
1305
1414
  meta?: RoleMeta;
1306
1415
  };
1307
1416
  }
1308
- /** This interface was referenced by `Role`'s JSON-Schema via the `create.targetSchema` link. */
1417
+ /**
1418
+ * This interface was referenced by `Role`'s JSON-Schema via the
1419
+ * `create.targetSchema` link.
1420
+ */
1309
1421
  export interface RoleCreateTargetSchema {
1310
1422
  data: Role;
1311
1423
  }
@@ -1368,8 +1480,8 @@ export interface RoleUpdateSchema {
1368
1480
  /** Permitted content scope */
1369
1481
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1370
1482
  /**
1371
- * Permitted localized content in this locale. Required when `localization_scope`
1372
- * is `localized`
1483
+ * Permitted localized content in this locale. Required when
1484
+ * `localization_scope` is `localized`
1373
1485
  */
1374
1486
  locale?: string | null;
1375
1487
  }[];
@@ -1387,8 +1499,8 @@ export interface RoleUpdateSchema {
1387
1499
  /** Permitted content scope */
1388
1500
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1389
1501
  /**
1390
- * Permitted localized content in this locale. Required when `localization_scope`
1391
- * is `localized`
1502
+ * Permitted localized content in this locale. Required when
1503
+ * `localization_scope` is `localized`
1392
1504
  */
1393
1505
  locale?: string | null;
1394
1506
  }[];
@@ -1402,8 +1514,8 @@ export interface RoleUpdateSchema {
1402
1514
  /** Permitted content scope */
1403
1515
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1404
1516
  /**
1405
- * Permitted localized content in this locale. Required when `localization_scope`
1406
- * is `localized`
1517
+ * Permitted localized content in this locale. Required when
1518
+ * `localization_scope` is `localized`
1407
1519
  */
1408
1520
  locale?: string | null;
1409
1521
  }[];
@@ -1417,8 +1529,8 @@ export interface RoleUpdateSchema {
1417
1529
  /** Permitted content scope */
1418
1530
  localization_scope?: 'all' | 'localized' | 'not_localized' | null;
1419
1531
  /**
1420
- * Permitted localized content in this locale. Required when `localization_scope`
1421
- * is `localized`
1532
+ * Permitted localized content in this locale. Required when
1533
+ * `localization_scope` is `localized`
1422
1534
  */
1423
1535
  locale?: string | null;
1424
1536
  }[];
@@ -1441,11 +1553,17 @@ export interface RoleUpdateSchema {
1441
1553
  meta?: RoleMeta;
1442
1554
  };
1443
1555
  }
1444
- /** This interface was referenced by `Role`'s JSON-Schema via the `update.targetSchema` link. */
1556
+ /**
1557
+ * This interface was referenced by `Role`'s JSON-Schema via the
1558
+ * `update.targetSchema` link.
1559
+ */
1445
1560
  export interface RoleUpdateTargetSchema {
1446
1561
  data: Role;
1447
1562
  }
1448
- /** This interface was referenced by `Role`'s JSON-Schema via the `instances.targetSchema` link. */
1563
+ /**
1564
+ * This interface was referenced by `Role`'s JSON-Schema via the
1565
+ * `instances.targetSchema` link.
1566
+ */
1449
1567
  export interface RoleInstancesTargetSchema {
1450
1568
  data: Role[];
1451
1569
  }
@@ -1453,16 +1571,20 @@ export interface RoleInstancesTargetSchema {
1453
1571
  export interface RoleSelfTargetSchema {
1454
1572
  data: Role;
1455
1573
  }
1456
- /** This interface was referenced by `Role`'s JSON-Schema via the `destroy.targetSchema` link. */
1574
+ /**
1575
+ * This interface was referenced by `Role`'s JSON-Schema via the
1576
+ * `destroy.targetSchema` link.
1577
+ */
1457
1578
  export interface RoleDestroyTargetSchema {
1458
1579
  data: Role;
1459
1580
  }
1460
1581
  /**
1461
- * A DatoCMS administrative area can be accessed by multiple people. Every collaborator
1462
- * is linked to a specific Role, which describes what actions it will be able to perform
1463
- * once logged in.
1582
+ * A DatoCMS administrative area can be accessed by multiple people. Every
1583
+ * collaborator is linked to a specific Role, which describes what actions it
1584
+ * will be able to perform once logged in.
1464
1585
  *
1465
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "user".
1586
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
1587
+ * `definition` "user".
1466
1588
  */
1467
1589
  export interface User {
1468
1590
  type: UserType;
@@ -1474,7 +1596,8 @@ export interface User {
1474
1596
  /**
1475
1597
  * JSON API attributes
1476
1598
  *
1477
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "attributes".
1599
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
1600
+ * "attributes".
1478
1601
  */
1479
1602
  export interface UserAttributes {
1480
1603
  /** Email */
@@ -1489,7 +1612,8 @@ export interface UserAttributes {
1489
1612
  /**
1490
1613
  * JSON API links
1491
1614
  *
1492
- * This interface was referenced by `User`'s JSON-Schema via the `definition` "relationships".
1615
+ * This interface was referenced by `User`'s JSON-Schema via the `definition`
1616
+ * "relationships".
1493
1617
  */
1494
1618
  export interface UserRelationships {
1495
1619
  /** Role */
@@ -1532,11 +1656,17 @@ export interface UserUpdateSchema {
1532
1656
  };
1533
1657
  };
1534
1658
  }
1535
- /** This interface was referenced by `User`'s JSON-Schema via the `update.targetSchema` link. */
1659
+ /**
1660
+ * This interface was referenced by `User`'s JSON-Schema via the
1661
+ * `update.targetSchema` link.
1662
+ */
1536
1663
  export interface UserUpdateTargetSchema {
1537
1664
  data: User;
1538
1665
  }
1539
- /** This interface was referenced by `User`'s JSON-Schema via the `instances.targetSchema` link. */
1666
+ /**
1667
+ * This interface was referenced by `User`'s JSON-Schema via the
1668
+ * `instances.targetSchema` link.
1669
+ */
1540
1670
  export interface UserInstancesTargetSchema {
1541
1671
  data: User[];
1542
1672
  }
@@ -1544,16 +1674,21 @@ export interface UserInstancesTargetSchema {
1544
1674
  export interface UserSelfTargetSchema {
1545
1675
  data: User;
1546
1676
  }
1547
- /** This interface was referenced by `User`'s JSON-Schema via the `destroy.targetSchema` link. */
1677
+ /**
1678
+ * This interface was referenced by `User`'s JSON-Schema via the
1679
+ * `destroy.targetSchema` link.
1680
+ */
1548
1681
  export interface UserDestroyTargetSchema {
1549
1682
  data: User;
1550
1683
  }
1551
1684
  /**
1552
- * A Single Sign-On user exists when a DatoCMS project is connected to an external
1553
- * Identity Provider. An SSO user will not use the standard login procedure but has to go
1554
- * through SAML authentication. It can also be linked to one or more IdP groups.
1685
+ * A Single Sign-On user exists when a DatoCMS project is connected to an
1686
+ * external Identity Provider. An SSO user will not use the standard login
1687
+ * procedure but has to go through SAML authentication. It can also be linked to
1688
+ * one or more IdP groups.
1555
1689
  *
1556
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "sso_user".
1690
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
1691
+ * `definition` "sso_user".
1557
1692
  */
1558
1693
  export interface SsoUser {
1559
1694
  type: SsoUserType;
@@ -1565,7 +1700,8 @@ export interface SsoUser {
1565
1700
  /**
1566
1701
  * JSON API attributes
1567
1702
  *
1568
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "attributes".
1703
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
1704
+ * "attributes".
1569
1705
  */
1570
1706
  export interface SsoUserAttributes {
1571
1707
  /** Email */
@@ -1573,8 +1709,8 @@ export interface SsoUserAttributes {
1573
1709
  /** Identity provider ID */
1574
1710
  external_id: string | null;
1575
1711
  /**
1576
- * Whether this user is active on the identity provider. De-activated users won't be
1577
- * able to login.
1712
+ * Whether this user is active on the identity provider. De-activated users
1713
+ * won't be able to login.
1578
1714
  */
1579
1715
  is_active: boolean;
1580
1716
  /** First name */
@@ -1585,7 +1721,8 @@ export interface SsoUserAttributes {
1585
1721
  /**
1586
1722
  * JSON API links
1587
1723
  *
1588
- * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "relationships".
1724
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
1725
+ * "relationships".
1589
1726
  */
1590
1727
  export interface SsoUserRelationships {
1591
1728
  /** All the users's groups */
@@ -1624,28 +1761,41 @@ export interface SsoUserData {
1624
1761
  type: SsoUserType;
1625
1762
  id: SsoUserIdentity;
1626
1763
  }
1627
- /** This interface was referenced by `SsoUser`'s JSON-Schema via the `instances.targetSchema` link. */
1764
+ /**
1765
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the
1766
+ * `instances.targetSchema` link.
1767
+ */
1628
1768
  export interface SsoUserInstancesTargetSchema {
1629
1769
  data: SsoUser[];
1630
1770
  }
1631
- /** This interface was referenced by `SsoUser`'s JSON-Schema via the `self.targetSchema` link. */
1771
+ /**
1772
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the
1773
+ * `self.targetSchema` link.
1774
+ */
1632
1775
  export interface SsoUserSelfTargetSchema {
1633
1776
  data: SsoUser;
1634
1777
  }
1635
- /** This interface was referenced by `SsoUser`'s JSON-Schema via the `copy_users.targetSchema` link. */
1778
+ /**
1779
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the
1780
+ * `copy_users.targetSchema` link.
1781
+ */
1636
1782
  export interface SsoUserCopyUsersTargetSchema {
1637
1783
  data: SsoUser[];
1638
1784
  }
1639
- /** This interface was referenced by `SsoUser`'s JSON-Schema via the `destroy.targetSchema` link. */
1785
+ /**
1786
+ * This interface was referenced by `SsoUser`'s JSON-Schema via the
1787
+ * `destroy.targetSchema` link.
1788
+ */
1640
1789
  export interface SsoUserDestroyTargetSchema {
1641
1790
  data: SsoUser;
1642
1791
  }
1643
1792
  /**
1644
- * If the Audit log functionality is enabled in a project, logged events can be queried
1645
- * using SQL-like language and fetched in full detail so that they can be exported or analyzed.
1793
+ * If the Audit log functionality is enabled in a project, logged events can be
1794
+ * queried using SQL-like language and fetched in full detail so that they can
1795
+ * be exported or analyzed.
1646
1796
  *
1647
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
1648
- * "audit_log_event".
1797
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
1798
+ * `definition` "audit_log_event".
1649
1799
  */
1650
1800
  export interface AuditLogEvent {
1651
1801
  type: AuditLogEventType;
@@ -1656,8 +1806,8 @@ export interface AuditLogEvent {
1656
1806
  /**
1657
1807
  * JSON API attributes
1658
1808
  *
1659
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition`
1660
- * "attributes".
1809
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
1810
+ * `definition` "attributes".
1661
1811
  */
1662
1812
  export interface AuditLogEventAttributes {
1663
1813
  /** The actual action performed */
@@ -1668,7 +1818,10 @@ export interface AuditLogEventAttributes {
1668
1818
  type: string;
1669
1819
  /** The ID of the actor */
1670
1820
  id: string;
1671
- /** An human representation of the actor (name/email/username depending on the type of actor) */
1821
+ /**
1822
+ * An human representation of the actor (name/email/username depending on
1823
+ * the type of actor)
1824
+ */
1672
1825
  name: string;
1673
1826
  };
1674
1827
  /** The role of the actor at the time the action was performed */
@@ -1711,7 +1864,8 @@ export interface AuditLogEventAttributes {
1711
1864
  /**
1712
1865
  * JSON API meta
1713
1866
  *
1714
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition` "meta".
1867
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
1868
+ * `definition` "meta".
1715
1869
  */
1716
1870
  export interface AuditLogEventMeta {
1717
1871
  /** The date of the event */
@@ -1720,13 +1874,17 @@ export interface AuditLogEventMeta {
1720
1874
  /**
1721
1875
  * JSON API data
1722
1876
  *
1723
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition` "data".
1877
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
1878
+ * `definition` "data".
1724
1879
  */
1725
1880
  export interface AuditLogEventData {
1726
1881
  type: AuditLogEventType;
1727
1882
  id: AuditLogEventIdentity;
1728
1883
  }
1729
- /** This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `query.schema` link. */
1884
+ /**
1885
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
1886
+ * `query.schema` link.
1887
+ */
1730
1888
  export interface AuditLogEventQuerySchema {
1731
1889
  data: {
1732
1890
  /** JSON API type field */
@@ -1735,13 +1893,13 @@ export interface AuditLogEventQuerySchema {
1735
1893
  /** An SQL-like expression to filter the events */
1736
1894
  filter?: string;
1737
1895
  /**
1738
- * Set this value to get remaining results, if a meta.next_token was returned in
1739
- * the previous query response
1896
+ * Set this value to get remaining results, if a meta.next_token was
1897
+ * returned in the previous query response
1740
1898
  */
1741
1899
  next_token?: string;
1742
1900
  /**
1743
- * Whether a detailed log complete with full request and response payload must be
1744
- * returned or not
1901
+ * Whether a detailed log complete with full request and response payload
1902
+ * must be returned or not
1745
1903
  */
1746
1904
  detailed_log?: boolean;
1747
1905
  };
@@ -1755,9 +1913,9 @@ export interface AuditLogEventQueryTargetSchema {
1755
1913
  data: AuditLogEvent[];
1756
1914
  meta: {
1757
1915
  /**
1758
- * If the response request exceeds the response payload limit DatoCMS will set this
1759
- * value in the response. If set, you can use that this value in the subsequent
1760
- * request to get the remaining results
1916
+ * If the response request exceeds the response payload limit DatoCMS will
1917
+ * set this value in the response. If set, you can use that this value in
1918
+ * the subsequent request to get the remaining results
1761
1919
  */
1762
1920
  next_token: null | string;
1763
1921
  };
@@ -1765,7 +1923,8 @@ export interface AuditLogEventQueryTargetSchema {
1765
1923
  /**
1766
1924
  * DatoCMS account
1767
1925
  *
1768
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "account".
1926
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
1927
+ * `definition` "account".
1769
1928
  */
1770
1929
  export interface Account {
1771
1930
  type: AccountType;
@@ -1775,7 +1934,8 @@ export interface Account {
1775
1934
  /**
1776
1935
  * JSON API attributes
1777
1936
  *
1778
- * This interface was referenced by `Account`'s JSON-Schema via the `definition` "attributes".
1937
+ * This interface was referenced by `Account`'s JSON-Schema via the `definition`
1938
+ * "attributes".
1779
1939
  */
1780
1940
  export interface AccountAttributes {
1781
1941
  /** Email */
@@ -1801,8 +1961,8 @@ export interface AccountData {
1801
1961
  /**
1802
1962
  * Stores the information regarding the current plan for the project.
1803
1963
  *
1804
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
1805
- * "site_plan".
1964
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
1965
+ * `definition` "site_plan".
1806
1966
  */
1807
1967
  export interface SitePlan {
1808
1968
  type: SitePlanType;
@@ -1812,7 +1972,8 @@ export interface SitePlan {
1812
1972
  /**
1813
1973
  * JSON API attributes
1814
1974
  *
1815
- * This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "attributes".
1975
+ * This interface was referenced by `SitePlan`'s JSON-Schema via the
1976
+ * `definition` "attributes".
1816
1977
  */
1817
1978
  export interface SitePlanAttributes {
1818
1979
  /** The name of the plan */
@@ -1840,8 +2001,8 @@ export interface SitePlanAttributes {
1840
2001
  /** Uploadable bytes */
1841
2002
  uploadable_bytes: null | number;
1842
2003
  /**
1843
- * Amount of asset data transferred between our Asset CDN and GraphQL Content Delivery
1844
- * API and content consumers
2004
+ * Amount of asset data transferred between our Asset CDN and GraphQL Content
2005
+ * Delivery API and content consumers
1845
2006
  */
1846
2007
  traffic_bytes: null | number;
1847
2008
  /** The number of requests made to both our Content Management and Content Delivery APIs */
@@ -1877,8 +2038,8 @@ export interface SitePlanAttributes {
1877
2038
  /** Days of version history retention */
1878
2039
  history_retention_days: number | null;
1879
2040
  /**
1880
- * Period (in minutes) in which bursts of changes made to the same record by the same
1881
- * user (or API token) will be grouped into a single one
2041
+ * Period (in minutes) in which bursts of changes made to the same record by
2042
+ * the same user (or API token) will be grouped into a single one
1882
2043
  */
1883
2044
  history_resolution_minutes: number;
1884
2045
  /** Whether two-factor authentication can be enabled or not */
@@ -1952,11 +2113,12 @@ export interface SitePlanData {
1952
2113
  id: SitePlanIdentity;
1953
2114
  }
1954
2115
  /**
1955
- * In DatoCMS you can organize the different Models present in your administrative area
1956
- * reordering and grouping them, so that their purpose will be more clear to the final editor.
2116
+ * In DatoCMS you can organize the different Models present in your
2117
+ * administrative area reordering and grouping them, so that their purpose will
2118
+ * be more clear to the final editor.
1957
2119
  *
1958
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
1959
- * "menu_item".
2120
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
2121
+ * `definition` "menu_item".
1960
2122
  */
1961
2123
  export interface MenuItem {
1962
2124
  type: MenuItemType;
@@ -1967,7 +2129,8 @@ export interface MenuItem {
1967
2129
  /**
1968
2130
  * JSON API attributes
1969
2131
  *
1970
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "attributes".
2132
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2133
+ * `definition` "attributes".
1971
2134
  */
1972
2135
  export interface MenuItemAttributes {
1973
2136
  /** The label of the menu item */
@@ -1982,7 +2145,8 @@ export interface MenuItemAttributes {
1982
2145
  /**
1983
2146
  * JSON API links
1984
2147
  *
1985
- * This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "relationships".
2148
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2149
+ * `definition` "relationships".
1986
2150
  */
1987
2151
  export interface MenuItemRelationships {
1988
2152
  /** Item type associated with the menu item */
@@ -2001,7 +2165,8 @@ export interface MenuItemRelationships {
2001
2165
  /**
2002
2166
  * JSON API data
2003
2167
  *
2004
- * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition` "data".
2168
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2169
+ * `definition` "data".
2005
2170
  */
2006
2171
  export interface ItemTypeData {
2007
2172
  type: ItemTypeType;
@@ -2043,7 +2208,10 @@ export interface MenuItemCreateSchema {
2043
2208
  };
2044
2209
  };
2045
2210
  }
2046
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `create.targetSchema` link. */
2211
+ /**
2212
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2213
+ * `create.targetSchema` link.
2214
+ */
2047
2215
  export interface MenuItemCreateTargetSchema {
2048
2216
  data: MenuItem;
2049
2217
  }
@@ -2075,29 +2243,42 @@ export interface MenuItemUpdateSchema {
2075
2243
  };
2076
2244
  };
2077
2245
  }
2078
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `update.targetSchema` link. */
2246
+ /**
2247
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2248
+ * `update.targetSchema` link.
2249
+ */
2079
2250
  export interface MenuItemUpdateTargetSchema {
2080
2251
  data: MenuItem;
2081
2252
  }
2082
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `instances.targetSchema` link. */
2253
+ /**
2254
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2255
+ * `instances.targetSchema` link.
2256
+ */
2083
2257
  export interface MenuItemInstancesTargetSchema {
2084
2258
  data: MenuItem[];
2085
2259
  }
2086
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `self.targetSchema` link. */
2260
+ /**
2261
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2262
+ * `self.targetSchema` link.
2263
+ */
2087
2264
  export interface MenuItemSelfTargetSchema {
2088
2265
  data: MenuItem;
2089
2266
  }
2090
- /** This interface was referenced by `MenuItem`'s JSON-Schema via the `destroy.targetSchema` link. */
2267
+ /**
2268
+ * This interface was referenced by `MenuItem`'s JSON-Schema via the
2269
+ * `destroy.targetSchema` link.
2270
+ */
2091
2271
  export interface MenuItemDestroyTargetSchema {
2092
2272
  data: MenuItem;
2093
2273
  }
2094
2274
  /**
2095
- * The way you define the kind of content you can edit inside your administrative area
2096
- * passes through the concept of Models, which are much like database tables. For
2097
- * backward-compatibility reasons, the API refers to models as "item types".
2275
+ * The way you define the kind of content you can edit inside your
2276
+ * administrative area passes through the concept of Models, which are much like
2277
+ * database tables. For backward-compatibility reasons, the API refers to models
2278
+ * as "item types".
2098
2279
  *
2099
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
2100
- * "item_type".
2280
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
2281
+ * `definition` "item_type".
2101
2282
  */
2102
2283
  export interface ModelBlock {
2103
2284
  type: ItemTypeType;
@@ -2108,7 +2289,8 @@ export interface ModelBlock {
2108
2289
  /**
2109
2290
  * JSON API attributes
2110
2291
  *
2111
- * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition` "attributes".
2292
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2293
+ * `definition` "attributes".
2112
2294
  */
2113
2295
  export interface ItemTypeAttributes {
2114
2296
  /** Name of the model */
@@ -2121,7 +2303,10 @@ export interface ItemTypeAttributes {
2121
2303
  collection_appearance: 'compact' | 'table';
2122
2304
  /** Whether the model is single-instance or not */
2123
2305
  singleton: boolean;
2124
- /** Whether we require all the project locales to be present for each localized field or not */
2306
+ /**
2307
+ * Whether we require all the project locales to be present for each localized
2308
+ * field or not
2309
+ */
2125
2310
  all_locales_required: boolean;
2126
2311
  /** Whether editors can sort records via drag & drop or not */
2127
2312
  sortable: boolean;
@@ -2133,11 +2318,14 @@ export interface ItemTypeAttributes {
2133
2318
  tree: boolean;
2134
2319
  /** If an ordering field is set, this fields specify the sorting direction */
2135
2320
  ordering_direction: null | 'asc' | 'desc';
2136
- /** Specifies the model's sorting method. Cannot be set in concurrency with ordering_field */
2321
+ /**
2322
+ * Specifies the model's sorting method. Cannot be set in concurrency with
2323
+ * ordering_field
2324
+ */
2137
2325
  ordering_meta: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
2138
2326
  /**
2139
- * If this model is single-instance, this tells the single-instance record has already
2140
- * been created or not
2327
+ * If this model is single-instance, this tells the single-instance record has
2328
+ * already been created or not
2141
2329
  */
2142
2330
  has_singleton_item: boolean;
2143
2331
  /** A hint shown to editors to help them understand the purpose of this model/block */
@@ -2146,8 +2334,8 @@ export interface ItemTypeAttributes {
2146
2334
  /**
2147
2335
  * JSON API links
2148
2336
  *
2149
- * This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition`
2150
- * "relationships".
2337
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2338
+ * `definition` "relationships".
2151
2339
  */
2152
2340
  export interface ItemTypeRelationships {
2153
2341
  /** The item instance related to this item type */
@@ -2198,7 +2386,10 @@ export interface WorkflowData {
2198
2386
  type: WorkflowType;
2199
2387
  id: WorkflowIdentity;
2200
2388
  }
2201
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `create.schema` link. */
2389
+ /**
2390
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2391
+ * `create.schema` link.
2392
+ */
2202
2393
  export interface ItemTypeCreateSchema {
2203
2394
  data: {
2204
2395
  type: ItemTypeType;
@@ -2210,8 +2401,11 @@ export interface ItemTypeCreateSchema {
2210
2401
  api_key: string;
2211
2402
  /** Whether the model is single-instance or not */
2212
2403
  singleton?: boolean;
2213
- /** Whether we require all the project locales to be present for each localized field or not */
2214
- all_locales_required?: boolean;
2404
+ /**
2405
+ * Whether we require all the project locales to be present for each
2406
+ * localized field or not
2407
+ */
2408
+ all_locales_required?: boolean;
2215
2409
  /** Whether editors can sort records via drag & drop or not */
2216
2410
  sortable?: boolean;
2217
2411
  /** Whether this model is a modular content block or not */
@@ -2222,7 +2416,10 @@ export interface ItemTypeCreateSchema {
2222
2416
  tree?: boolean;
2223
2417
  /** If an ordering field is set, this fields specify the sorting direction */
2224
2418
  ordering_direction?: null | 'asc' | 'desc';
2225
- /** Specifies the model's sorting method. Cannot be set in concurrency with ordering_field */
2419
+ /**
2420
+ * Specifies the model's sorting method. Cannot be set in concurrency with
2421
+ * ordering_field
2422
+ */
2226
2423
  ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
2227
2424
  /** The way the model collection should be presented to the editors */
2228
2425
  collection_appeareance?: 'compact' | 'table';
@@ -2247,12 +2444,18 @@ export interface ItemTypeCreateSchema {
2247
2444
  };
2248
2445
  };
2249
2446
  }
2250
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `create.targetSchema` link. */
2447
+ /**
2448
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2449
+ * `create.targetSchema` link.
2450
+ */
2251
2451
  export interface ItemTypeCreateTargetSchema {
2252
2452
  data: ModelBlock;
2253
2453
  included?: MenuItem[];
2254
2454
  }
2255
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `update.schema` link. */
2455
+ /**
2456
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2457
+ * `update.schema` link.
2458
+ */
2256
2459
  export interface ItemTypeUpdateSchema {
2257
2460
  data: {
2258
2461
  type: ItemTypeType;
@@ -2269,7 +2472,10 @@ export interface ItemTypeUpdateSchema {
2269
2472
  collection_appearance?: 'compact' | 'table';
2270
2473
  /** Whether the model is single-instance or not */
2271
2474
  singleton?: boolean;
2272
- /** Whether we require all the project locales to be present for each localized field or not */
2475
+ /**
2476
+ * Whether we require all the project locales to be present for each
2477
+ * localized field or not
2478
+ */
2273
2479
  all_locales_required?: boolean;
2274
2480
  /** Whether editors can sort records via drag & drop or not */
2275
2481
  sortable?: boolean;
@@ -2281,11 +2487,14 @@ export interface ItemTypeUpdateSchema {
2281
2487
  tree?: boolean;
2282
2488
  /** If an ordering field is set, this fields specify the sorting direction */
2283
2489
  ordering_direction?: null | 'asc' | 'desc';
2284
- /** Specifies the model's sorting method. Cannot be set in concurrency with ordering_field */
2490
+ /**
2491
+ * Specifies the model's sorting method. Cannot be set in concurrency with
2492
+ * ordering_field
2493
+ */
2285
2494
  ordering_meta?: null | 'created_at' | 'updated_at' | 'first_published_at' | 'published_at';
2286
2495
  /**
2287
- * If this model is single-instance, this tells the single-instance record has
2288
- * already been created or not
2496
+ * If this model is single-instance, this tells the single-instance record
2497
+ * has already been created or not
2289
2498
  */
2290
2499
  has_singleton_item?: boolean;
2291
2500
  /** A hint shown to editors to help them understand the purpose of this model/block */
@@ -2307,11 +2516,17 @@ export interface ItemTypeUpdateSchema {
2307
2516
  };
2308
2517
  };
2309
2518
  }
2310
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `update.targetSchema` link. */
2519
+ /**
2520
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2521
+ * `update.targetSchema` link.
2522
+ */
2311
2523
  export interface ItemTypeUpdateTargetSchema {
2312
2524
  data: Job;
2313
2525
  }
2314
- /** This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "job". */
2526
+ /**
2527
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
2528
+ * `definition` "job".
2529
+ */
2315
2530
  export interface Job {
2316
2531
  type: TargetSchemaPropertiesDataType;
2317
2532
  id: TargetSchemaPropertiesDataIdentity;
@@ -2325,7 +2540,10 @@ export interface TargetSchemaPropertiesDataData {
2325
2540
  type: TargetSchemaPropertiesDataType;
2326
2541
  id: TargetSchemaPropertiesDataIdentity;
2327
2542
  }
2328
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `update.jobSchema` link. */
2543
+ /**
2544
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2545
+ * `update.jobSchema` link.
2546
+ */
2329
2547
  export interface ItemTypeUpdateJobSchema {
2330
2548
  data: ModelBlock;
2331
2549
  }
@@ -2336,7 +2554,10 @@ export interface ItemTypeUpdateJobSchema {
2336
2554
  export interface ItemTypeInstancesTargetSchema {
2337
2555
  data: ModelBlock[];
2338
2556
  }
2339
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `self.targetSchema` link. */
2557
+ /**
2558
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2559
+ * `self.targetSchema` link.
2560
+ */
2340
2561
  export interface ItemTypeSelfTargetSchema {
2341
2562
  data: ModelBlock;
2342
2563
  }
@@ -2347,20 +2568,27 @@ export interface ItemTypeSelfTargetSchema {
2347
2568
  export interface ItemTypeDuplicateTargetSchema {
2348
2569
  data: ModelBlock;
2349
2570
  }
2350
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `destroy.targetSchema` link. */
2571
+ /**
2572
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2573
+ * `destroy.targetSchema` link.
2574
+ */
2351
2575
  export interface ItemTypeDestroyTargetSchema {
2352
2576
  data: Job;
2353
2577
  }
2354
- /** This interface was referenced by `ModelBlock`'s JSON-Schema via the `destroy.jobSchema` link. */
2578
+ /**
2579
+ * This interface was referenced by `ModelBlock`'s JSON-Schema via the
2580
+ * `destroy.jobSchema` link.
2581
+ */
2355
2582
  export interface ItemTypeDestroyJobSchema {
2356
2583
  data: ModelBlock;
2357
2584
  }
2358
2585
  /**
2359
- * Each Model consists of a set of fields. Using the database metaphore, fields are like
2360
- * table columns, and when creating them you need to specify their type (`string`,
2361
- * `file`, `float`, etc.) and any required validation.
2586
+ * Each Model consists of a set of fields. Using the database metaphore, fields
2587
+ * are like table columns, and when creating them you need to specify their type
2588
+ * (`string`, `file`, `float`, etc.) and any required validation.
2362
2589
  *
2363
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "field".
2590
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
2591
+ * `definition` "field".
2364
2592
  */
2365
2593
  export interface Field {
2366
2594
  type: FieldType;
@@ -2371,7 +2599,8 @@ export interface Field {
2371
2599
  /**
2372
2600
  * JSON API attributes
2373
2601
  *
2374
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "attributes".
2602
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
2603
+ * "attributes".
2375
2604
  */
2376
2605
  export interface FieldAttributes {
2377
2606
  /** The label of the field */
@@ -2381,8 +2610,8 @@ export interface FieldAttributes {
2381
2610
  /** Whether the field needs to be multilanguage or not */
2382
2611
  localized: boolean;
2383
2612
  /**
2384
- * Default value for Field. When field is localized accepts an object of default values
2385
- * with site locales as keys
2613
+ * Default value for Field. When field is localized accepts an object of
2614
+ * default values with site locales as keys
2386
2615
  */
2387
2616
  default_value: boolean | null | string | number | {
2388
2617
  [k: string]: unknown;
@@ -2406,11 +2635,14 @@ export interface FieldAttributes {
2406
2635
  /** Field appearance details, plugin configuration and field add-ons */
2407
2636
  appearance: {
2408
2637
  /**
2409
- * A valid editor can be a DatoCMS default field editor type (ie. `"single_line"`),
2410
- * or a plugin ID offering a custom field editor
2638
+ * A valid editor can be a DatoCMS default field editor type (ie.
2639
+ * `"single_line"`), or a plugin ID offering a custom field editor
2411
2640
  */
2412
2641
  editor: string;
2413
- /** The specific field extension to use for the field (only if the editor is a modern plugin) */
2642
+ /**
2643
+ * The specific field extension to use for the field (only if the editor is
2644
+ * a modern plugin)
2645
+ */
2414
2646
  field_extension?: string;
2415
2647
  /** The editor plugin's parameters */
2416
2648
  parameters: {
@@ -2420,7 +2652,10 @@ export interface FieldAttributes {
2420
2652
  addons: {
2421
2653
  /** The ID of a plugin offering a field addon */
2422
2654
  id: string;
2423
- /** The specific field extension to use for the field (only if the editor is a modern plugin) */
2655
+ /**
2656
+ * The specific field extension to use for the field (only if the editor
2657
+ * is a modern plugin)
2658
+ */
2424
2659
  field_extension?: string;
2425
2660
  parameters: {
2426
2661
  [k: string]: unknown;
@@ -2435,7 +2670,8 @@ export interface FieldAttributes {
2435
2670
  /**
2436
2671
  * JSON API links
2437
2672
  *
2438
- * This interface was referenced by `Field`'s JSON-Schema via the `definition` "relationships".
2673
+ * This interface was referenced by `Field`'s JSON-Schema via the `definition`
2674
+ * "relationships".
2439
2675
  */
2440
2676
  export interface FieldRelationships {
2441
2677
  /** Field item type */
@@ -2490,8 +2726,8 @@ export interface FieldCreateSchema {
2490
2726
  */
2491
2727
  editor: string;
2492
2728
  /**
2493
- * The specific field extension to use for the field (only if the editor is a
2494
- * modern plugin)
2729
+ * The specific field extension to use for the field (only if the editor
2730
+ * is a modern plugin)
2495
2731
  */
2496
2732
  field_extension?: string;
2497
2733
  /** The editor plugin's parameters */
@@ -2503,8 +2739,8 @@ export interface FieldCreateSchema {
2503
2739
  /** The ID of a plugin offering a field addon */
2504
2740
  id: string;
2505
2741
  /**
2506
- * The specific field extension to use for the field (only if the editor is a
2507
- * modern plugin)
2742
+ * The specific field extension to use for the field (only if the
2743
+ * editor is a modern plugin)
2508
2744
  */
2509
2745
  field_extension?: string;
2510
2746
  parameters: {
@@ -2519,8 +2755,8 @@ export interface FieldCreateSchema {
2519
2755
  /** Field hint */
2520
2756
  hint?: string | null;
2521
2757
  /**
2522
- * Default value for Field. When field is localized accepts an object of default
2523
- * values with site locales as keys
2758
+ * Default value for Field. When field is localized accepts an object of
2759
+ * default values with site locales as keys
2524
2760
  */
2525
2761
  default_value?: boolean | null | string | number | {
2526
2762
  [k: string]: unknown;
@@ -2535,7 +2771,10 @@ export interface FieldCreateSchema {
2535
2771
  };
2536
2772
  };
2537
2773
  }
2538
- /** This interface was referenced by `Field`'s JSON-Schema via the `create.targetSchema` link. */
2774
+ /**
2775
+ * This interface was referenced by `Field`'s JSON-Schema via the
2776
+ * `create.targetSchema` link.
2777
+ */
2539
2778
  export interface FieldCreateTargetSchema {
2540
2779
  data: Job;
2541
2780
  }
@@ -2551,8 +2790,8 @@ export interface FieldUpdateSchema {
2551
2790
  id: FieldIdentity;
2552
2791
  attributes: {
2553
2792
  /**
2554
- * Default value for Field. When field is localized accepts an object of default
2555
- * values with site locales as keys
2793
+ * Default value for Field. When field is localized accepts an object of
2794
+ * default values with site locales as keys
2556
2795
  */
2557
2796
  default_value?: boolean | null | string | number | {
2558
2797
  [k: string]: unknown;
@@ -2583,8 +2822,8 @@ export interface FieldUpdateSchema {
2583
2822
  */
2584
2823
  editor: string;
2585
2824
  /**
2586
- * The specific field extension to use for the field (only if the editor is a
2587
- * modern plugin)
2825
+ * The specific field extension to use for the field (only if the editor
2826
+ * is a modern plugin)
2588
2827
  */
2589
2828
  field_extension?: string;
2590
2829
  /** The editor plugin's parameters */
@@ -2596,8 +2835,8 @@ export interface FieldUpdateSchema {
2596
2835
  /** The ID of a plugin offering a field addon */
2597
2836
  id: string;
2598
2837
  /**
2599
- * The specific field extension to use for the field (only if the editor is a
2600
- * modern plugin)
2838
+ * The specific field extension to use for the field (only if the
2839
+ * editor is a modern plugin)
2601
2840
  */
2602
2841
  field_extension?: string;
2603
2842
  parameters: {
@@ -2623,7 +2862,10 @@ export interface FieldUpdateSchema {
2623
2862
  };
2624
2863
  };
2625
2864
  }
2626
- /** This interface was referenced by `Field`'s JSON-Schema via the `update.targetSchema` link. */
2865
+ /**
2866
+ * This interface was referenced by `Field`'s JSON-Schema via the
2867
+ * `update.targetSchema` link.
2868
+ */
2627
2869
  export interface FieldUpdateTargetSchema {
2628
2870
  data: Job;
2629
2871
  }
@@ -2632,36 +2874,60 @@ export interface FieldUpdateJobSchema {
2632
2874
  data: Field;
2633
2875
  included?: (ModelBlock | Field)[];
2634
2876
  }
2635
- /** This interface was referenced by `Field`'s JSON-Schema via the `instances.targetSchema` link. */
2877
+ /**
2878
+ * This interface was referenced by `Field`'s JSON-Schema via the
2879
+ * `instances.targetSchema` link.
2880
+ */
2636
2881
  export interface FieldInstancesTargetSchema {
2637
2882
  data: Field[];
2638
2883
  }
2639
- /** This interface was referenced by `Field`'s JSON-Schema via the `referencing.targetSchema` link. */
2884
+ /**
2885
+ * This interface was referenced by `Field`'s JSON-Schema via the
2886
+ * `referencing.targetSchema` link.
2887
+ */
2640
2888
  export interface FieldReferencingTargetSchema {
2641
2889
  data: Field[];
2642
2890
  }
2643
- /** This interface was referenced by `Field`'s JSON-Schema via the `related.targetSchema` link. */
2891
+ /**
2892
+ * This interface was referenced by `Field`'s JSON-Schema via the
2893
+ * `related.targetSchema` link.
2894
+ */
2644
2895
  export interface FieldRelatedTargetSchema {
2645
2896
  data: Field[];
2646
2897
  }
2647
- /** This interface was referenced by `Field`'s JSON-Schema via the `self.targetSchema` link. */
2898
+ /**
2899
+ * This interface was referenced by `Field`'s JSON-Schema via the
2900
+ * `self.targetSchema` link.
2901
+ */
2648
2902
  export interface FieldSelfTargetSchema {
2649
2903
  data: Field;
2650
2904
  }
2651
- /** This interface was referenced by `Field`'s JSON-Schema via the `destroy.targetSchema` link. */
2905
+ /**
2906
+ * This interface was referenced by `Field`'s JSON-Schema via the
2907
+ * `destroy.targetSchema` link.
2908
+ */
2652
2909
  export interface FieldDestroyTargetSchema {
2653
2910
  data: Job;
2654
2911
  }
2655
- /** This interface was referenced by `Field`'s JSON-Schema via the `destroy.jobSchema` link. */
2912
+ /**
2913
+ * This interface was referenced by `Field`'s JSON-Schema via the
2914
+ * `destroy.jobSchema` link.
2915
+ */
2656
2916
  export interface FieldDestroyJobSchema {
2657
2917
  data: Field;
2658
2918
  included?: ModelBlock[];
2659
2919
  }
2660
- /** This interface was referenced by `Field`'s JSON-Schema via the `duplicate.targetSchema` link. */
2920
+ /**
2921
+ * This interface was referenced by `Field`'s JSON-Schema via the
2922
+ * `duplicate.targetSchema` link.
2923
+ */
2661
2924
  export interface FieldDuplicateTargetSchema {
2662
2925
  data: Job;
2663
2926
  }
2664
- /** This interface was referenced by `Field`'s JSON-Schema via the `duplicate.jobSchema` link. */
2927
+ /**
2928
+ * This interface was referenced by `Field`'s JSON-Schema via the
2929
+ * `duplicate.jobSchema` link.
2930
+ */
2665
2931
  export interface FieldDuplicateJobSchema {
2666
2932
  data: Field;
2667
2933
  included: ModelBlock[];
@@ -2669,7 +2935,8 @@ export interface FieldDuplicateJobSchema {
2669
2935
  /**
2670
2936
  * Fields can be organized and grouped into fieldset to better present them to editors.
2671
2937
  *
2672
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "fieldset".
2938
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
2939
+ * `definition` "fieldset".
2673
2940
  */
2674
2941
  export interface Fieldset {
2675
2942
  type: FieldsetType;
@@ -2680,7 +2947,8 @@ export interface Fieldset {
2680
2947
  /**
2681
2948
  * JSON API attributes
2682
2949
  *
2683
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "attributes".
2950
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
2951
+ * `definition` "attributes".
2684
2952
  */
2685
2953
  export interface FieldsetAttributes {
2686
2954
  /** The title of the fieldset */
@@ -2697,7 +2965,8 @@ export interface FieldsetAttributes {
2697
2965
  /**
2698
2966
  * JSON API links
2699
2967
  *
2700
- * This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "relationships".
2968
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
2969
+ * `definition` "relationships".
2701
2970
  */
2702
2971
  export interface FieldsetRelationships {
2703
2972
  /** Fieldset item type */
@@ -2719,12 +2988,18 @@ export interface FieldsetCreateSchema {
2719
2988
  position?: number;
2720
2989
  /** Whether the fieldset can be collapsed or not */
2721
2990
  collapsible?: boolean;
2722
- /** When fieldset is collapsible, determines if the default is to start collapsed or not */
2991
+ /**
2992
+ * When fieldset is collapsible, determines if the default is to start
2993
+ * collapsed or not
2994
+ */
2723
2995
  start_collapsed?: boolean;
2724
2996
  };
2725
2997
  };
2726
2998
  }
2727
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `create.targetSchema` link. */
2999
+ /**
3000
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
3001
+ * `create.targetSchema` link.
3002
+ */
2728
3003
  export interface FieldsetCreateTargetSchema {
2729
3004
  data: Fieldset;
2730
3005
  }
@@ -2742,31 +3017,47 @@ export interface FieldsetUpdateSchema {
2742
3017
  position?: number;
2743
3018
  /** Whether the fieldset can be collapsed or not */
2744
3019
  collapsible?: boolean;
2745
- /** When fieldset is collapsible, determines if the default is to start collapsed or not */
3020
+ /**
3021
+ * When fieldset is collapsible, determines if the default is to start
3022
+ * collapsed or not
3023
+ */
2746
3024
  start_collapsed?: boolean;
2747
3025
  };
2748
3026
  };
2749
3027
  }
2750
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `update.targetSchema` link. */
3028
+ /**
3029
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
3030
+ * `update.targetSchema` link.
3031
+ */
2751
3032
  export interface FieldsetUpdateTargetSchema {
2752
3033
  data: Fieldset;
2753
3034
  }
2754
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `instances.targetSchema` link. */
3035
+ /**
3036
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
3037
+ * `instances.targetSchema` link.
3038
+ */
2755
3039
  export interface FieldsetInstancesTargetSchema {
2756
3040
  data: Fieldset[];
2757
3041
  }
2758
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `self.targetSchema` link. */
3042
+ /**
3043
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
3044
+ * `self.targetSchema` link.
3045
+ */
2759
3046
  export interface FieldsetSelfTargetSchema {
2760
3047
  data: Fieldset;
2761
3048
  }
2762
- /** This interface was referenced by `Fieldset`'s JSON-Schema via the `destroy.targetSchema` link. */
3049
+ /**
3050
+ * This interface was referenced by `Fieldset`'s JSON-Schema via the
3051
+ * `destroy.targetSchema` link.
3052
+ */
2763
3053
  export interface FieldsetDestroyTargetSchema {
2764
3054
  data: Fieldset;
2765
3055
  }
2766
3056
  /**
2767
3057
  * A session is required to access to read-and-write API endpoints
2768
3058
  *
2769
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "session".
3059
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3060
+ * `definition` "session".
2770
3061
  */
2771
3062
  export interface Session {
2772
3063
  type: SessionType;
@@ -2776,7 +3067,8 @@ export interface Session {
2776
3067
  /**
2777
3068
  * JSON API links
2778
3069
  *
2779
- * This interface was referenced by `Session`'s JSON-Schema via the `definition` "relationships".
3070
+ * This interface was referenced by `Session`'s JSON-Schema via the `definition`
3071
+ * "relationships".
2780
3072
  */
2781
3073
  export interface SessionRelationships {
2782
3074
  /** The user associated with the session */
@@ -2829,17 +3121,20 @@ export interface SessionCreateSchema {
2829
3121
  };
2830
3122
  };
2831
3123
  }
2832
- /** This interface was referenced by `Session`'s JSON-Schema via the `create.targetSchema` link. */
3124
+ /**
3125
+ * This interface was referenced by `Session`'s JSON-Schema via the
3126
+ * `create.targetSchema` link.
3127
+ */
2833
3128
  export interface SessionCreateTargetSchema {
2834
3129
  data: Session;
2835
3130
  included: User[];
2836
3131
  }
2837
3132
  /**
2838
- * An API token allows access to our API. It is linked to a Role, which describes what
2839
- * actions can be performed.
3133
+ * An API token allows access to our API. It is linked to a Role, which
3134
+ * describes what actions can be performed.
2840
3135
  *
2841
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
2842
- * "access_token".
3136
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3137
+ * `definition` "access_token".
2843
3138
  */
2844
3139
  export interface AccessToken {
2845
3140
  type: AccessTokenType;
@@ -2850,7 +3145,8 @@ export interface AccessToken {
2850
3145
  /**
2851
3146
  * JSON API attributes
2852
3147
  *
2853
- * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "attributes".
3148
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3149
+ * `definition` "attributes".
2854
3150
  */
2855
3151
  export interface AccessTokenAttributes {
2856
3152
  /** Name of API token */
@@ -2868,8 +3164,8 @@ export interface AccessTokenAttributes {
2868
3164
  /**
2869
3165
  * JSON API links
2870
3166
  *
2871
- * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition`
2872
- * "relationships".
3167
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3168
+ * `definition` "relationships".
2873
3169
  */
2874
3170
  export interface AccessTokenRelationships {
2875
3171
  /** Role */
@@ -2880,20 +3176,27 @@ export interface AccessTokenRelationships {
2880
3176
  /**
2881
3177
  * JSON API data
2882
3178
  *
2883
- * This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "data".
3179
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3180
+ * `definition` "data".
2884
3181
  */
2885
3182
  export interface AccessTokenData {
2886
3183
  type: AccessTokenType;
2887
3184
  id: AccessTokenIdentity;
2888
3185
  }
2889
- /** This interface was referenced by `AccessToken`'s JSON-Schema via the `create.schema` link. */
3186
+ /**
3187
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3188
+ * `create.schema` link.
3189
+ */
2890
3190
  export interface AccessTokenCreateSchema {
2891
3191
  data: {
2892
3192
  type: AccessTokenType;
2893
3193
  attributes: {
2894
3194
  /** Name of API token */
2895
3195
  name: string;
2896
- /** Whether this API token can access the Content Delivery API published content endpoint */
3196
+ /**
3197
+ * Whether this API token can access the Content Delivery API published
3198
+ * content endpoint
3199
+ */
2897
3200
  can_access_cda: boolean;
2898
3201
  /** Whether this API token can access the Content Delivery API draft content endpoint */
2899
3202
  can_access_cda_preview: boolean;
@@ -2908,11 +3211,17 @@ export interface AccessTokenCreateSchema {
2908
3211
  };
2909
3212
  };
2910
3213
  }
2911
- /** This interface was referenced by `AccessToken`'s JSON-Schema via the `create.targetSchema` link. */
3214
+ /**
3215
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3216
+ * `create.targetSchema` link.
3217
+ */
2912
3218
  export interface AccessTokenCreateTargetSchema {
2913
3219
  data: AccessToken;
2914
3220
  }
2915
- /** This interface was referenced by `AccessToken`'s JSON-Schema via the `update.schema` link. */
3221
+ /**
3222
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3223
+ * `update.schema` link.
3224
+ */
2916
3225
  export interface AccessTokenUpdateSchema {
2917
3226
  data: {
2918
3227
  type: AccessTokenType;
@@ -2920,7 +3229,10 @@ export interface AccessTokenUpdateSchema {
2920
3229
  attributes: {
2921
3230
  /** Name of API token */
2922
3231
  name: string;
2923
- /** Whether this API token can access the Content Delivery API published content endpoint */
3232
+ /**
3233
+ * Whether this API token can access the Content Delivery API published
3234
+ * content endpoint
3235
+ */
2924
3236
  can_access_cda: boolean;
2925
3237
  /** Whether this API token can access the Content Delivery API draft content endpoint */
2926
3238
  can_access_cda_preview: boolean;
@@ -2935,7 +3247,10 @@ export interface AccessTokenUpdateSchema {
2935
3247
  };
2936
3248
  };
2937
3249
  }
2938
- /** This interface was referenced by `AccessToken`'s JSON-Schema via the `update.targetSchema` link. */
3250
+ /**
3251
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3252
+ * `update.targetSchema` link.
3253
+ */
2939
3254
  export interface AccessTokenUpdateTargetSchema {
2940
3255
  data: AccessToken;
2941
3256
  }
@@ -2946,7 +3261,10 @@ export interface AccessTokenUpdateTargetSchema {
2946
3261
  export interface AccessTokenInstancesTargetSchema {
2947
3262
  data: AccessToken[];
2948
3263
  }
2949
- /** This interface was referenced by `AccessToken`'s JSON-Schema via the `self.targetSchema` link. */
3264
+ /**
3265
+ * This interface was referenced by `AccessToken`'s JSON-Schema via the
3266
+ * `self.targetSchema` link.
3267
+ */
2950
3268
  export interface AccessTokenSelfTargetSchema {
2951
3269
  data: AccessToken;
2952
3270
  }
@@ -2965,10 +3283,11 @@ export interface AccessTokenDestroyTargetSchema {
2965
3283
  data: AccessToken;
2966
3284
  }
2967
3285
  /**
2968
- * Plugins enable developers to replace DatoCMS field components with HTML5 applications
2969
- * so the editing experiences of the DatoCMS web app can be customized.
3286
+ * Plugins enable developers to replace DatoCMS field components with HTML5
3287
+ * applications so the editing experiences of the DatoCMS web app can be customized.
2970
3288
  *
2971
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "plugin".
3289
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3290
+ * `definition` "plugin".
2972
3291
  */
2973
3292
  export interface Plugin {
2974
3293
  type: PluginType;
@@ -2979,7 +3298,8 @@ export interface Plugin {
2979
3298
  /**
2980
3299
  * JSON API attributes
2981
3300
  *
2982
- * This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "attributes".
3301
+ * This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
3302
+ * "attributes".
2983
3303
  */
2984
3304
  export interface PluginAttributes {
2985
3305
  /** The name of the plugin */
@@ -2993,8 +3313,8 @@ export interface PluginAttributes {
2993
3313
  /** The entry point URL of the plugin */
2994
3314
  url: string;
2995
3315
  /**
2996
- * Global plugin configuration. Plugins can persist whatever information they want in
2997
- * this object to reuse it later.
3316
+ * Global plugin configuration. Plugins can persist whatever information they
3317
+ * want in this object to reuse it later.
2998
3318
  */
2999
3319
  parameters: {
3000
3320
  [k: string]: unknown;
@@ -3035,29 +3355,35 @@ export interface PluginCreateSchema {
3035
3355
  type: PluginType;
3036
3356
  attributes: {
3037
3357
  /**
3038
- * NPM package name of the public plugin you want to install. For public plugins,
3039
- * that's the only attribute you need to pass.
3358
+ * NPM package name of the public plugin you want to install. For public
3359
+ * plugins, that's the only attribute you need to pass.
3040
3360
  */
3041
3361
  package_name?: string;
3042
3362
  /** The name of the plugin. Only to be passed if package name key is not specified. */
3043
3363
  name?: string;
3044
- /** A description of the plugin. Only to be passed if package name key is not specified. */
3364
+ /**
3365
+ * A description of the plugin. Only to be passed if package name key is
3366
+ * not specified.
3367
+ */
3045
3368
  description?: string;
3046
- /** The entry point URL of the plugin. Only to be passed if package name key is not specified. */
3369
+ /**
3370
+ * The entry point URL of the plugin. Only to be passed if package name
3371
+ * key is not specified.
3372
+ */
3047
3373
  url?: string;
3048
3374
  /**
3049
- * Permissions granted to this plugin. Only to be passed if package name key is not
3050
- * specified.
3375
+ * Permissions granted to this plugin. Only to be passed if package name
3376
+ * key is not specified.
3051
3377
  */
3052
3378
  permissions?: 'currentUserAccessToken'[];
3053
3379
  /**
3054
- * The type of field extension this legacy plugin implements. Only to be passed if
3055
- * package name key is not specified.
3380
+ * The type of field extension this legacy plugin implements. Only to be
3381
+ * passed if package name key is not specified.
3056
3382
  */
3057
3383
  plugin_type?: 'field_editor' | 'sidebar' | 'field_addon';
3058
3384
  /**
3059
- * On which types of field in which this legacy plugin can be used. Only to be
3060
- * passed if package name key is not specified.
3385
+ * On which types of field in which this legacy plugin can be used. Only
3386
+ * to be passed if package name key is not specified.
3061
3387
  */
3062
3388
  field_types?: ('boolean' | 'date' | 'date_time' | 'float' | 'integer' | 'string' | 'text' | 'lat_lon' | 'json' | 'seo' | 'link' | 'links' | 'video' | 'color' | 'slug' | 'rich_text' | 'file' | 'gallery')[];
3063
3389
  /** The schema for the parameters this legacy plugin can persist */
@@ -3070,7 +3396,10 @@ export interface PluginCreateSchema {
3070
3396
  };
3071
3397
  };
3072
3398
  }
3073
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `create.targetSchema` link. */
3399
+ /**
3400
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
3401
+ * `create.targetSchema` link.
3402
+ */
3074
3403
  export interface PluginCreateTargetSchema {
3075
3404
  data: Plugin;
3076
3405
  }
@@ -3087,8 +3416,8 @@ export interface PluginUpdateSchema {
3087
3416
  /** The entry point URL of the plugin */
3088
3417
  url?: string;
3089
3418
  /**
3090
- * Global plugin configuration. Plugins can persist whatever information they want
3091
- * in this object to reuse it later.
3419
+ * Global plugin configuration. Plugins can persist whatever information
3420
+ * they want in this object to reuse it later.
3092
3421
  */
3093
3422
  parameters?: {
3094
3423
  [k: string]: unknown;
@@ -3101,31 +3430,46 @@ export interface PluginUpdateSchema {
3101
3430
  };
3102
3431
  };
3103
3432
  }
3104
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `update.targetSchema` link. */
3433
+ /**
3434
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
3435
+ * `update.targetSchema` link.
3436
+ */
3105
3437
  export interface PluginUpdateTargetSchema {
3106
3438
  data: Plugin;
3107
3439
  }
3108
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `instances.targetSchema` link. */
3440
+ /**
3441
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
3442
+ * `instances.targetSchema` link.
3443
+ */
3109
3444
  export interface PluginInstancesTargetSchema {
3110
3445
  data: Plugin[];
3111
3446
  }
3112
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `self.targetSchema` link. */
3447
+ /**
3448
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
3449
+ * `self.targetSchema` link.
3450
+ */
3113
3451
  export interface PluginSelfTargetSchema {
3114
3452
  data: Plugin;
3115
3453
  }
3116
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `destroy.targetSchema` link. */
3454
+ /**
3455
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
3456
+ * `destroy.targetSchema` link.
3457
+ */
3117
3458
  export interface PluginDestroyTargetSchema {
3118
3459
  data: Plugin;
3119
3460
  }
3120
- /** This interface was referenced by `Plugin`'s JSON-Schema via the `fields.targetSchema` link. */
3461
+ /**
3462
+ * This interface was referenced by `Plugin`'s JSON-Schema via the
3463
+ * `fields.targetSchema` link.
3464
+ */
3121
3465
  export interface PluginFieldsTargetSchema {
3122
3466
  data: Field[];
3123
3467
  }
3124
3468
  /**
3125
3469
  * Some API endpoint give results asynchronously, returning the ID of a job.
3126
3470
  *
3127
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
3128
- * "job_result".
3471
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3472
+ * `definition` "job_result".
3129
3473
  */
3130
3474
  export interface JobResult {
3131
3475
  type: JobResultType;
@@ -3135,7 +3479,8 @@ export interface JobResult {
3135
3479
  /**
3136
3480
  * JSON API attributes
3137
3481
  *
3138
- * This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "attributes".
3482
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
3483
+ * `definition` "attributes".
3139
3484
  */
3140
3485
  export interface JobResultAttributes {
3141
3486
  /** Status of delayed HTTP response */
@@ -3154,13 +3499,16 @@ export interface JobResultData {
3154
3499
  type: JobResultType;
3155
3500
  id: JobResultIdentity;
3156
3501
  }
3157
- /** This interface was referenced by `JobResult`'s JSON-Schema via the `self.targetSchema` link. */
3502
+ /**
3503
+ * This interface was referenced by `JobResult`'s JSON-Schema via the
3504
+ * `self.targetSchema` link.
3505
+ */
3158
3506
  export interface JobResultSelfTargetSchema {
3159
3507
  data: JobResult;
3160
3508
  }
3161
3509
  /**
3162
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
3163
- * "subscription_limit".
3510
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3511
+ * `definition` "subscription_limit".
3164
3512
  */
3165
3513
  export interface SubscriptionLimit {
3166
3514
  type: SubscriptionLimitType;
@@ -3184,7 +3532,8 @@ export interface SubscriptionLimitAttributes {
3184
3532
  /**
3185
3533
  * JSON API data
3186
3534
  *
3187
- * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the `definition` "data".
3535
+ * This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
3536
+ * `definition` "data".
3188
3537
  */
3189
3538
  export interface SubscriptionLimitData {
3190
3539
  type: SubscriptionLimitType;
@@ -3205,8 +3554,8 @@ export interface SubscriptionLimitSelfTargetSchema {
3205
3554
  data: SubscriptionLimit;
3206
3555
  }
3207
3556
  /**
3208
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
3209
- * "subscription_feature".
3557
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3558
+ * `definition` "subscription_feature".
3210
3559
  */
3211
3560
  export interface SubscriptionFeature {
3212
3561
  type: SubscriptionFeatureType;
@@ -3247,8 +3596,8 @@ export interface SubscriptionFeatureInstancesTargetSchema {
3247
3596
  /**
3248
3597
  * Represents an event occurred during the deploy process of your administrative area.
3249
3598
  *
3250
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
3251
- * "build_event".
3599
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3600
+ * `definition` "build_event".
3252
3601
  */
3253
3602
  export interface BuildEvent {
3254
3603
  type: BuildEventType;
@@ -3259,7 +3608,8 @@ export interface BuildEvent {
3259
3608
  /**
3260
3609
  * JSON API attributes
3261
3610
  *
3262
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "attributes".
3611
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
3612
+ * `definition` "attributes".
3263
3613
  */
3264
3614
  export interface BuildEventAttributes {
3265
3615
  /** The type of activity */
@@ -3274,8 +3624,8 @@ export interface BuildEventAttributes {
3274
3624
  /**
3275
3625
  * JSON API links
3276
3626
  *
3277
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition`
3278
- * "relationships".
3627
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
3628
+ * `definition` "relationships".
3279
3629
  */
3280
3630
  export interface BuildEventRelationships {
3281
3631
  /** Source build trigger */
@@ -3286,7 +3636,8 @@ export interface BuildEventRelationships {
3286
3636
  /**
3287
3637
  * JSON API data
3288
3638
  *
3289
- * This interface was referenced by `BuildTrigger`'s JSON-Schema via the `definition` "data".
3639
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
3640
+ * `definition` "data".
3290
3641
  */
3291
3642
  export interface BuildTriggerData {
3292
3643
  type: BuildTriggerType;
@@ -3295,7 +3646,8 @@ export interface BuildTriggerData {
3295
3646
  /**
3296
3647
  * JSON API data
3297
3648
  *
3298
- * This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "data".
3649
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
3650
+ * `definition` "data".
3299
3651
  */
3300
3652
  export interface BuildEventData {
3301
3653
  type: BuildEventType;
@@ -3308,16 +3660,20 @@ export interface BuildEventData {
3308
3660
  export interface BuildEventInstancesTargetSchema {
3309
3661
  data: BuildEvent[];
3310
3662
  }
3311
- /** This interface was referenced by `BuildEvent`'s JSON-Schema via the `self.targetSchema` link. */
3663
+ /**
3664
+ * This interface was referenced by `BuildEvent`'s JSON-Schema via the
3665
+ * `self.targetSchema` link.
3666
+ */
3312
3667
  export interface BuildEventSelfTargetSchema {
3313
3668
  data: BuildEvent;
3314
3669
  }
3315
3670
  /**
3316
- * DatoCMS stores the individual pieces of content you create from a model as records,
3317
- * which are much like table rows in a database. For backward-compatibility reasons, the
3318
- * API refers to records as "items".
3671
+ * DatoCMS stores the individual pieces of content you create from a model as
3672
+ * records, which are much like table rows in a database. For
3673
+ * backward-compatibility reasons, the API refers to records as "items".
3319
3674
  *
3320
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "item".
3675
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
3676
+ * `definition` "item".
3321
3677
  */
3322
3678
  export interface Item {
3323
3679
  type: ItemType;
@@ -3329,7 +3685,8 @@ export interface Item {
3329
3685
  /**
3330
3686
  * The JSON data associated to the record
3331
3687
  *
3332
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "attributes".
3688
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
3689
+ * "attributes".
3333
3690
  */
3334
3691
  export interface ItemAttributes {
3335
3692
  [k: string]: unknown;
@@ -3337,7 +3694,8 @@ export interface ItemAttributes {
3337
3694
  /**
3338
3695
  * JSON API links
3339
3696
  *
3340
- * This interface was referenced by `Item`'s JSON-Schema via the `definition` "relationships".
3697
+ * This interface was referenced by `Item`'s JSON-Schema via the `definition`
3698
+ * "relationships".
3341
3699
  */
3342
3700
  export interface ItemRelationships {
3343
3701
  /** The record's model */
@@ -3345,8 +3703,8 @@ export interface ItemRelationships {
3345
3703
  data: ItemTypeData;
3346
3704
  };
3347
3705
  /**
3348
- * The entity (account/collaborator/access token/sso user) who created the record. It
3349
- * must be an object with `type` (e.g. 'account') and `id` properties.
3706
+ * The entity (account/collaborator/access token/sso user) who created the
3707
+ * record. It must be an object with `type` (e.g. 'account') and `id` properties.
3350
3708
  */
3351
3709
  creator?: {
3352
3710
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -3379,14 +3737,20 @@ export interface ItemMeta {
3379
3737
  /** Workflow stage in which the item is */
3380
3738
  stage: null | string;
3381
3739
  }
3382
- /** This interface was referenced by `Item`'s JSON-Schema via the `instances.targetSchema` link. */
3740
+ /**
3741
+ * This interface was referenced by `Item`'s JSON-Schema via the
3742
+ * `instances.targetSchema` link.
3743
+ */
3383
3744
  export interface ItemInstancesTargetSchema {
3384
3745
  data: Item[];
3385
3746
  meta: {
3386
3747
  total_count: number;
3387
3748
  };
3388
3749
  }
3389
- /** This interface was referenced by `Item`'s JSON-Schema via the `validate_existing.schema` link. */
3750
+ /**
3751
+ * This interface was referenced by `Item`'s JSON-Schema via the
3752
+ * `validate_existing.schema` link.
3753
+ */
3390
3754
  export interface ItemValidateExistingSchema {
3391
3755
  data: {
3392
3756
  id: ItemIdentity;
@@ -3400,8 +3764,8 @@ export interface ItemValidateExistingSchema {
3400
3764
  data: ItemTypeData;
3401
3765
  };
3402
3766
  /**
3403
- * The entity (account/collaborator/access token/sso user) who created the record.
3404
- * It must be an object with `type` (e.g. 'account') and `id` properties.
3767
+ * The entity (account/collaborator/access token/sso user) who created the
3768
+ * record. It must be an object with `type` (e.g. 'account') and `id` properties.
3405
3769
  */
3406
3770
  creator?: {
3407
3771
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -3409,7 +3773,10 @@ export interface ItemValidateExistingSchema {
3409
3773
  };
3410
3774
  };
3411
3775
  }
3412
- /** This interface was referenced by `Item`'s JSON-Schema via the `validate_new.schema` link. */
3776
+ /**
3777
+ * This interface was referenced by `Item`'s JSON-Schema via the
3778
+ * `validate_new.schema` link.
3779
+ */
3413
3780
  export interface ItemValidateNewSchema {
3414
3781
  data: {
3415
3782
  type: ItemType;
@@ -3459,16 +3826,25 @@ export interface ItemCreateSchema {
3459
3826
  };
3460
3827
  };
3461
3828
  }
3462
- /** This interface was referenced by `Item`'s JSON-Schema via the `create.targetSchema` link. */
3829
+ /**
3830
+ * This interface was referenced by `Item`'s JSON-Schema via the
3831
+ * `create.targetSchema` link.
3832
+ */
3463
3833
  export interface ItemCreateTargetSchema {
3464
3834
  data: Item;
3465
3835
  included: (ModelBlock | Item)[];
3466
3836
  }
3467
- /** This interface was referenced by `Item`'s JSON-Schema via the `duplicate.targetSchema` link. */
3837
+ /**
3838
+ * This interface was referenced by `Item`'s JSON-Schema via the
3839
+ * `duplicate.targetSchema` link.
3840
+ */
3468
3841
  export interface ItemDuplicateTargetSchema {
3469
3842
  data: Job;
3470
3843
  }
3471
- /** This interface was referenced by `Item`'s JSON-Schema via the `duplicate.jobSchema` link. */
3844
+ /**
3845
+ * This interface was referenced by `Item`'s JSON-Schema via the
3846
+ * `duplicate.jobSchema` link.
3847
+ */
3472
3848
  export interface ItemDuplicateJobSchema {
3473
3849
  data: Item;
3474
3850
  included: ModelBlock[];
@@ -3512,12 +3888,18 @@ export interface ItemUpdateSchema {
3512
3888
  };
3513
3889
  };
3514
3890
  }
3515
- /** This interface was referenced by `Item`'s JSON-Schema via the `update.targetSchema` link. */
3891
+ /**
3892
+ * This interface was referenced by `Item`'s JSON-Schema via the
3893
+ * `update.targetSchema` link.
3894
+ */
3516
3895
  export interface ItemUpdateTargetSchema {
3517
3896
  data: Item;
3518
3897
  included?: (ModelBlock | Item)[];
3519
3898
  }
3520
- /** This interface was referenced by `Item`'s JSON-Schema via the `references.targetSchema` link. */
3899
+ /**
3900
+ * This interface was referenced by `Item`'s JSON-Schema via the
3901
+ * `references.targetSchema` link.
3902
+ */
3521
3903
  export interface ItemReferencesTargetSchema {
3522
3904
  data: Item[];
3523
3905
  }
@@ -3525,7 +3907,10 @@ export interface ItemReferencesTargetSchema {
3525
3907
  export interface ItemSelfTargetSchema {
3526
3908
  data: Item;
3527
3909
  }
3528
- /** This interface was referenced by `Item`'s JSON-Schema via the `destroy.targetSchema` link. */
3910
+ /**
3911
+ * This interface was referenced by `Item`'s JSON-Schema via the
3912
+ * `destroy.targetSchema` link.
3913
+ */
3529
3914
  export interface ItemDestroyTargetSchema {
3530
3915
  data: Job;
3531
3916
  }
@@ -3533,11 +3918,17 @@ export interface ItemDestroyTargetSchema {
3533
3918
  export interface ItemDestroyJobSchema {
3534
3919
  data: Item;
3535
3920
  }
3536
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_destroy.targetSchema` link. */
3921
+ /**
3922
+ * This interface was referenced by `Item`'s JSON-Schema via the
3923
+ * `batch_destroy.targetSchema` link.
3924
+ */
3537
3925
  export interface ItemBatchDestroyTargetSchema {
3538
3926
  data: Job;
3539
3927
  }
3540
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_destroy.jobSchema` link. */
3928
+ /**
3929
+ * This interface was referenced by `Item`'s JSON-Schema via the
3930
+ * `batch_destroy.jobSchema` link.
3931
+ */
3541
3932
  export interface ItemBatchDestroyJobSchema {
3542
3933
  data: unknown[];
3543
3934
  meta: {
@@ -3545,11 +3936,17 @@ export interface ItemBatchDestroyJobSchema {
3545
3936
  failed: number;
3546
3937
  };
3547
3938
  }
3548
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_publish.targetSchema` link. */
3939
+ /**
3940
+ * This interface was referenced by `Item`'s JSON-Schema via the
3941
+ * `batch_publish.targetSchema` link.
3942
+ */
3549
3943
  export interface ItemBatchPublishTargetSchema {
3550
3944
  data: Job;
3551
3945
  }
3552
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_publish.jobSchema` link. */
3946
+ /**
3947
+ * This interface was referenced by `Item`'s JSON-Schema via the
3948
+ * `batch_publish.jobSchema` link.
3949
+ */
3553
3950
  export interface ItemBatchPublishJobSchema {
3554
3951
  data: unknown[];
3555
3952
  meta: {
@@ -3564,7 +3961,10 @@ export interface ItemBatchPublishJobSchema {
3564
3961
  export interface ItemBatchUnpublishTargetSchema {
3565
3962
  data: Job;
3566
3963
  }
3567
- /** This interface was referenced by `Item`'s JSON-Schema via the `batch_unpublish.jobSchema` link. */
3964
+ /**
3965
+ * This interface was referenced by `Item`'s JSON-Schema via the
3966
+ * `batch_unpublish.jobSchema` link.
3967
+ */
3568
3968
  export interface ItemBatchUnpublishJobSchema {
3569
3969
  data: unknown[];
3570
3970
  meta: {
@@ -3572,17 +3972,26 @@ export interface ItemBatchUnpublishJobSchema {
3572
3972
  failed: number;
3573
3973
  };
3574
3974
  }
3575
- /** This interface was referenced by `Item`'s JSON-Schema via the `publish.targetSchema` link. */
3975
+ /**
3976
+ * This interface was referenced by `Item`'s JSON-Schema via the
3977
+ * `publish.targetSchema` link.
3978
+ */
3576
3979
  export interface ItemPublishTargetSchema {
3577
3980
  data: Item;
3578
3981
  included?: ModelBlock[];
3579
3982
  }
3580
- /** This interface was referenced by `Item`'s JSON-Schema via the `unpublish.targetSchema` link. */
3983
+ /**
3984
+ * This interface was referenced by `Item`'s JSON-Schema via the
3985
+ * `unpublish.targetSchema` link.
3986
+ */
3581
3987
  export interface ItemUnpublishTargetSchema {
3582
3988
  data: Item;
3583
3989
  included?: ModelBlock[];
3584
3990
  }
3585
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_publish.schema` link. */
3991
+ /**
3992
+ * This interface was referenced by `Item`'s JSON-Schema via the
3993
+ * `bulk_publish.schema` link.
3994
+ */
3586
3995
  export interface ItemBulkPublishSchema {
3587
3996
  data: {
3588
3997
  /** JSON API type field */
@@ -3596,11 +4005,17 @@ export interface ItemBulkPublishSchema {
3596
4005
  };
3597
4006
  };
3598
4007
  }
3599
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_publish.targetSchema` link. */
4008
+ /**
4009
+ * This interface was referenced by `Item`'s JSON-Schema via the
4010
+ * `bulk_publish.targetSchema` link.
4011
+ */
3600
4012
  export interface ItemBulkPublishTargetSchema {
3601
4013
  data: Job;
3602
4014
  }
3603
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_publish.jobSchema` link. */
4015
+ /**
4016
+ * This interface was referenced by `Item`'s JSON-Schema via the
4017
+ * `bulk_publish.jobSchema` link.
4018
+ */
3604
4019
  export interface ItemBulkPublishJobSchema {
3605
4020
  data: unknown[];
3606
4021
  meta: {
@@ -3608,7 +4023,10 @@ export interface ItemBulkPublishJobSchema {
3608
4023
  failed: number;
3609
4024
  };
3610
4025
  }
3611
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_unpublish.schema` link. */
4026
+ /**
4027
+ * This interface was referenced by `Item`'s JSON-Schema via the
4028
+ * `bulk_unpublish.schema` link.
4029
+ */
3612
4030
  export interface ItemBulkUnpublishSchema {
3613
4031
  data: {
3614
4032
  /** JSON API type field */
@@ -3629,7 +4047,10 @@ export interface ItemBulkUnpublishSchema {
3629
4047
  export interface ItemBulkUnpublishTargetSchema {
3630
4048
  data: Job;
3631
4049
  }
3632
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_unpublish.jobSchema` link. */
4050
+ /**
4051
+ * This interface was referenced by `Item`'s JSON-Schema via the
4052
+ * `bulk_unpublish.jobSchema` link.
4053
+ */
3633
4054
  export interface ItemBulkUnpublishJobSchema {
3634
4055
  data: unknown[];
3635
4056
  meta: {
@@ -3637,7 +4058,10 @@ export interface ItemBulkUnpublishJobSchema {
3637
4058
  failed: number;
3638
4059
  };
3639
4060
  }
3640
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_destroy.schema` link. */
4061
+ /**
4062
+ * This interface was referenced by `Item`'s JSON-Schema via the
4063
+ * `bulk_destroy.schema` link.
4064
+ */
3641
4065
  export interface ItemBulkDestroySchema {
3642
4066
  data: {
3643
4067
  /** JSON API type field */
@@ -3651,11 +4075,17 @@ export interface ItemBulkDestroySchema {
3651
4075
  };
3652
4076
  };
3653
4077
  }
3654
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_destroy.targetSchema` link. */
4078
+ /**
4079
+ * This interface was referenced by `Item`'s JSON-Schema via the
4080
+ * `bulk_destroy.targetSchema` link.
4081
+ */
3655
4082
  export interface ItemBulkDestroyTargetSchema {
3656
4083
  data: Job;
3657
4084
  }
3658
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_destroy.jobSchema` link. */
4085
+ /**
4086
+ * This interface was referenced by `Item`'s JSON-Schema via the
4087
+ * `bulk_destroy.jobSchema` link.
4088
+ */
3659
4089
  export interface ItemBulkDestroyJobSchema {
3660
4090
  data: unknown[];
3661
4091
  meta: {
@@ -3663,7 +4093,10 @@ export interface ItemBulkDestroyJobSchema {
3663
4093
  failed: number;
3664
4094
  };
3665
4095
  }
3666
- /** This interface was referenced by `Item`'s JSON-Schema via the `bulk_move_to_stage.schema` link. */
4096
+ /**
4097
+ * This interface was referenced by `Item`'s JSON-Schema via the
4098
+ * `bulk_move_to_stage.schema` link.
4099
+ */
3667
4100
  export interface ItemBulkMoveToStageSchema {
3668
4101
  data: {
3669
4102
  /** JSON API type field */
@@ -3702,8 +4135,8 @@ export interface ItemBulkMoveToStageJobSchema {
3702
4135
  /**
3703
4136
  * Every change to a record is stored as a separate record version in DatoCMS.
3704
4137
  *
3705
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
3706
- * "item_version".
4138
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
4139
+ * `definition` "item_version".
3707
4140
  */
3708
4141
  export interface ItemVersion {
3709
4142
  type: ItemVersionType;
@@ -3715,7 +4148,8 @@ export interface ItemVersion {
3715
4148
  /**
3716
4149
  * The JSON data associated to the record version
3717
4150
  *
3718
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "attributes".
4151
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
4152
+ * `definition` "attributes".
3719
4153
  */
3720
4154
  export interface ItemVersionAttributes {
3721
4155
  [k: string]: unknown;
@@ -3723,8 +4157,8 @@ export interface ItemVersionAttributes {
3723
4157
  /**
3724
4158
  * JSON API links
3725
4159
  *
3726
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition`
3727
- * "relationships".
4160
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
4161
+ * `definition` "relationships".
3728
4162
  */
3729
4163
  export interface ItemVersionRelationships {
3730
4164
  /** The record version's model */
@@ -3736,8 +4170,9 @@ export interface ItemVersionRelationships {
3736
4170
  data: ItemData;
3737
4171
  };
3738
4172
  /**
3739
- * The entity (account/collaborator/access token/sso user) who made this change to the
3740
- * record. It must be an object with `type` (e.g. 'account') and `id` properties.
4173
+ * The entity (account/collaborator/access token/sso user) who made this
4174
+ * change to the record. It must be an object with `type` (e.g. 'account') and
4175
+ * `id` properties.
3741
4176
  */
3742
4177
  editor: {
3743
4178
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -3746,7 +4181,8 @@ export interface ItemVersionRelationships {
3746
4181
  /**
3747
4182
  * Meta information regarding the record version
3748
4183
  *
3749
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "meta".
4184
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
4185
+ * `definition` "meta".
3750
4186
  */
3751
4187
  export interface ItemVersionMeta {
3752
4188
  /** Date of record version creation */
@@ -3761,7 +4197,8 @@ export interface ItemVersionMeta {
3761
4197
  /**
3762
4198
  * JSON API data
3763
4199
  *
3764
- * This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "data".
4200
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
4201
+ * `definition` "data".
3765
4202
  */
3766
4203
  export interface ItemVersionData {
3767
4204
  type: ItemVersionType;
@@ -3774,7 +4211,10 @@ export interface ItemVersionData {
3774
4211
  export interface ItemVersionRestoreTargetSchema {
3775
4212
  data: Job;
3776
4213
  }
3777
- /** This interface was referenced by `ItemVersion`'s JSON-Schema via the `restore.jobSchema` link. */
4214
+ /**
4215
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
4216
+ * `restore.jobSchema` link.
4217
+ */
3778
4218
  export interface ItemVersionRestoreJobSchema {
3779
4219
  data: [Item, ItemVersion];
3780
4220
  }
@@ -3788,7 +4228,10 @@ export interface ItemVersionInstancesTargetSchema {
3788
4228
  [k: string]: unknown;
3789
4229
  };
3790
4230
  }
3791
- /** This interface was referenced by `ItemVersion`'s JSON-Schema via the `self.targetSchema` link. */
4231
+ /**
4232
+ * This interface was referenced by `ItemVersion`'s JSON-Schema via the
4233
+ * `self.targetSchema` link.
4234
+ */
3792
4235
  export interface ItemVersionSelfTargetSchema {
3793
4236
  data: ItemVersion;
3794
4237
  meta?: {
@@ -3798,7 +4241,8 @@ export interface ItemVersionSelfTargetSchema {
3798
4241
  /**
3799
4242
  * Every file you upload to DatoCMS will be retrievable from this endpoint.
3800
4243
  *
3801
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "upload".
4244
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
4245
+ * `definition` "upload".
3802
4246
  */
3803
4247
  export interface Upload {
3804
4248
  type: UploadType;
@@ -3809,7 +4253,8 @@ export interface Upload {
3809
4253
  /**
3810
4254
  * JSON API attributes
3811
4255
  *
3812
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "attributes".
4256
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
4257
+ * "attributes".
3813
4258
  */
3814
4259
  export interface UploadAttributes {
3815
4260
  /** Size of the upload */
@@ -3842,18 +4287,21 @@ export interface UploadAttributes {
3842
4287
  frame_rate: number | null;
3843
4288
  /** Blurhash for the asset */
3844
4289
  blurhash: string | null;
3845
- /** Public Mux playback ID. Used with stream.mux.com to create the source URL for a video player. */
4290
+ /**
4291
+ * Public Mux playback ID. Used with stream.mux.com to create the source URL
4292
+ * for a video player.
4293
+ */
3846
4294
  mux_playback_id: string | null;
3847
4295
  /** Maximum quality of MP4 rendition available */
3848
4296
  mux_mp4_highest_res: null | 'high' | 'medium' | 'low';
3849
4297
  /**
3850
- * For each of the project's locales, the default metadata to apply if nothing is
3851
- * specified at record's level.
4298
+ * For each of the project's locales, the default metadata to apply if nothing
4299
+ * is specified at record's level.
3852
4300
  */
3853
4301
  default_field_metadata: {
3854
4302
  /**
3855
- * This interface was referenced by `undefined`'s JSON-Schema definition via the
3856
- * `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
4303
+ * This interface was referenced by `undefined`'s JSON-Schema definition via
4304
+ * the `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
3857
4305
  */
3858
4306
  [k: string]: {
3859
4307
  /** Alternate text for the asset */
@@ -3904,12 +4352,13 @@ export interface UploadAttributes {
3904
4352
  /**
3905
4353
  * JSON API links
3906
4354
  *
3907
- * This interface was referenced by `Upload`'s JSON-Schema via the `definition` "relationships".
4355
+ * This interface was referenced by `Upload`'s JSON-Schema via the `definition`
4356
+ * "relationships".
3908
4357
  */
3909
4358
  export interface UploadRelationships {
3910
4359
  /**
3911
- * The entity (account/collaborator/access token) who created the asset. It must be an
3912
- * object with `type` (e.g. 'account') and `id` properties.
4360
+ * The entity (account/collaborator/access token) who created the asset. It
4361
+ * must be an object with `type` (e.g. 'account') and `id` properties.
3913
4362
  */
3914
4363
  creator: {
3915
4364
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -3938,13 +4387,14 @@ export interface UploadCreateSchema {
3938
4387
  /** Notes */
3939
4388
  notes?: string | null;
3940
4389
  /**
3941
- * For each of the project's locales, the default metadata to apply if nothing is
3942
- * specified at record's level.
4390
+ * For each of the project's locales, the default metadata to apply if
4391
+ * nothing is specified at record's level.
3943
4392
  */
3944
4393
  default_field_metadata?: {
3945
4394
  /**
3946
- * This interface was referenced by `undefined`'s JSON-Schema definition via the
3947
- * `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
4395
+ * This interface was referenced by `undefined`'s JSON-Schema definition
4396
+ * via the `patternProperty`
4397
+ * "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
3948
4398
  */
3949
4399
  [k: string]: {
3950
4400
  /** Alternate text for the asset */
@@ -3970,26 +4420,41 @@ export interface UploadCreateSchema {
3970
4420
  };
3971
4421
  };
3972
4422
  }
3973
- /** This interface was referenced by `Upload`'s JSON-Schema via the `create.targetSchema` link. */
4423
+ /**
4424
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4425
+ * `create.targetSchema` link.
4426
+ */
3974
4427
  export interface UploadCreateTargetSchema {
3975
4428
  data: Job;
3976
4429
  }
3977
- /** This interface was referenced by `Upload`'s JSON-Schema via the `create.jobSchema` link. */
4430
+ /**
4431
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4432
+ * `create.jobSchema` link.
4433
+ */
3978
4434
  export interface UploadCreateJobSchema {
3979
4435
  data: Upload;
3980
4436
  }
3981
- /** This interface was referenced by `Upload`'s JSON-Schema via the `instances.targetSchema` link. */
4437
+ /**
4438
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4439
+ * `instances.targetSchema` link.
4440
+ */
3982
4441
  export interface UploadInstancesTargetSchema {
3983
4442
  data: Upload[];
3984
4443
  meta?: {
3985
4444
  total_count: number;
3986
4445
  };
3987
4446
  }
3988
- /** This interface was referenced by `Upload`'s JSON-Schema via the `self.targetSchema` link. */
4447
+ /**
4448
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4449
+ * `self.targetSchema` link.
4450
+ */
3989
4451
  export interface UploadSelfTargetSchema {
3990
4452
  data: Upload;
3991
4453
  }
3992
- /** This interface was referenced by `Upload`'s JSON-Schema via the `destroy.targetSchema` link. */
4454
+ /**
4455
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4456
+ * `destroy.targetSchema` link.
4457
+ */
3993
4458
  export interface UploadDestroyTargetSchema {
3994
4459
  data: Upload;
3995
4460
  }
@@ -4012,13 +4477,14 @@ export interface UploadUpdateSchema {
4012
4477
  /** Tags */
4013
4478
  tags?: string[];
4014
4479
  /**
4015
- * For each of the project's locales, the default metadata to apply if nothing is
4016
- * specified at record's level.
4480
+ * For each of the project's locales, the default metadata to apply if
4481
+ * nothing is specified at record's level.
4017
4482
  */
4018
4483
  default_field_metadata?: {
4019
4484
  /**
4020
- * This interface was referenced by `undefined`'s JSON-Schema definition via the
4021
- * `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
4485
+ * This interface was referenced by `undefined`'s JSON-Schema definition
4486
+ * via the `patternProperty`
4487
+ * "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
4022
4488
  */
4023
4489
  [k: string]: {
4024
4490
  /** Alternate text for the asset */
@@ -4042,8 +4508,8 @@ export interface UploadUpdateSchema {
4042
4508
  };
4043
4509
  relationships?: {
4044
4510
  /**
4045
- * The entity (account/collaborator/access token) who created the asset. It must be
4046
- * an object with `type` (e.g. 'account') and `id` properties.
4511
+ * The entity (account/collaborator/access token) who created the asset.
4512
+ * It must be an object with `type` (e.g. 'account') and `id` properties.
4047
4513
  */
4048
4514
  creator: {
4049
4515
  data: AccountData | AccessTokenData | UserData | SsoUserData;
@@ -4051,15 +4517,24 @@ export interface UploadUpdateSchema {
4051
4517
  };
4052
4518
  };
4053
4519
  }
4054
- /** This interface was referenced by `Upload`'s JSON-Schema via the `update.targetSchema` link. */
4520
+ /**
4521
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4522
+ * `update.targetSchema` link.
4523
+ */
4055
4524
  export interface UploadUpdateTargetSchema {
4056
4525
  data: Job;
4057
4526
  }
4058
- /** This interface was referenced by `Upload`'s JSON-Schema via the `update.jobSchema` link. */
4527
+ /**
4528
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4529
+ * `update.jobSchema` link.
4530
+ */
4059
4531
  export interface UploadUpdateJobSchema {
4060
4532
  data: Upload;
4061
4533
  }
4062
- /** This interface was referenced by `Upload`'s JSON-Schema via the `batch_add_tags.schema` link. */
4534
+ /**
4535
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4536
+ * `batch_add_tags.schema` link.
4537
+ */
4063
4538
  export interface UploadBatchAddTagsSchema {
4064
4539
  data: {
4065
4540
  type: UploadType;
@@ -4076,7 +4551,10 @@ export interface UploadBatchAddTagsSchema {
4076
4551
  export interface UploadBatchAddTagsTargetSchema {
4077
4552
  data: Job;
4078
4553
  }
4079
- /** This interface was referenced by `Upload`'s JSON-Schema via the `batch_add_tags.jobSchema` link. */
4554
+ /**
4555
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4556
+ * `batch_add_tags.jobSchema` link.
4557
+ */
4080
4558
  export interface UploadBatchAddTagsJobSchema {
4081
4559
  data: unknown[];
4082
4560
  meta: {
@@ -4091,7 +4569,10 @@ export interface UploadBatchAddTagsJobSchema {
4091
4569
  export interface UploadBatchDestroyTargetSchema {
4092
4570
  data: Job;
4093
4571
  }
4094
- /** This interface was referenced by `Upload`'s JSON-Schema via the `batch_destroy.jobSchema` link. */
4572
+ /**
4573
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4574
+ * `batch_destroy.jobSchema` link.
4575
+ */
4095
4576
  export interface UploadBatchDestroyJobSchema {
4096
4577
  data: unknown[];
4097
4578
  meta: {
@@ -4099,7 +4580,10 @@ export interface UploadBatchDestroyJobSchema {
4099
4580
  failed: number;
4100
4581
  };
4101
4582
  }
4102
- /** This interface was referenced by `Upload`'s JSON-Schema via the `references.targetSchema` link. */
4583
+ /**
4584
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4585
+ * `references.targetSchema` link.
4586
+ */
4103
4587
  export interface UploadReferencesTargetSchema {
4104
4588
  data: Item;
4105
4589
  }
@@ -4121,11 +4605,17 @@ export interface UploadBulkTagSchema {
4121
4605
  };
4122
4606
  };
4123
4607
  }
4124
- /** This interface was referenced by `Upload`'s JSON-Schema via the `bulk_tag.targetSchema` link. */
4608
+ /**
4609
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4610
+ * `bulk_tag.targetSchema` link.
4611
+ */
4125
4612
  export interface UploadBulkTagTargetSchema {
4126
4613
  data: Job;
4127
4614
  }
4128
- /** This interface was referenced by `Upload`'s JSON-Schema via the `bulk_tag.jobSchema` link. */
4615
+ /**
4616
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4617
+ * `bulk_tag.jobSchema` link.
4618
+ */
4129
4619
  export interface UploadBulkTagJobSchema {
4130
4620
  data: unknown[];
4131
4621
  meta: {
@@ -4133,7 +4623,10 @@ export interface UploadBulkTagJobSchema {
4133
4623
  failed: number;
4134
4624
  };
4135
4625
  }
4136
- /** This interface was referenced by `Upload`'s JSON-Schema via the `bulk_destroy.schema` link. */
4626
+ /**
4627
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4628
+ * `bulk_destroy.schema` link.
4629
+ */
4137
4630
  export interface UploadBulkDestroySchema {
4138
4631
  data: {
4139
4632
  /** JSON API type field */
@@ -4153,7 +4646,10 @@ export interface UploadBulkDestroySchema {
4153
4646
  export interface UploadBulkDestroyTargetSchema {
4154
4647
  data: Job;
4155
4648
  }
4156
- /** This interface was referenced by `Upload`'s JSON-Schema via the `bulk_destroy.jobSchema` link. */
4649
+ /**
4650
+ * This interface was referenced by `Upload`'s JSON-Schema via the
4651
+ * `bulk_destroy.jobSchema` link.
4652
+ */
4157
4653
  export interface UploadBulkDestroyJobSchema {
4158
4654
  data: unknown[];
4159
4655
  meta: {
@@ -4162,12 +4658,12 @@ export interface UploadBulkDestroyJobSchema {
4162
4658
  };
4163
4659
  }
4164
4660
  /**
4165
- * To upload a file in DatoCMS, first you need to obtain an upload permission through
4166
- * this API endpoint. The response will contain the S3 URL where you will be able to
4167
- * upload the file with a direct PUT request.
4661
+ * To upload a file in DatoCMS, first you need to obtain an upload permission
4662
+ * through this API endpoint. The response will contain the S3 URL where you
4663
+ * will be able to upload the file with a direct PUT request.
4168
4664
  *
4169
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4170
- * "upload_request".
4665
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
4666
+ * `definition` "upload_request".
4171
4667
  */
4172
4668
  export interface UploadRequest {
4173
4669
  type: UploadRequestType;
@@ -4177,15 +4673,18 @@ export interface UploadRequest {
4177
4673
  /**
4178
4674
  * JSON API attributes
4179
4675
  *
4180
- * This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition`
4181
- * "attributes".
4676
+ * This interface was referenced by `UploadRequest`'s JSON-Schema via the
4677
+ * `definition` "attributes".
4182
4678
  */
4183
4679
  export interface UploadRequestAttributes {
4184
4680
  /** The URL to use to upload the file with a direct PUT request */
4185
4681
  url: string;
4186
4682
  [k: string]: unknown;
4187
4683
  }
4188
- /** This interface was referenced by `UploadRequest`'s JSON-Schema via the `create.schema` link. */
4684
+ /**
4685
+ * This interface was referenced by `UploadRequest`'s JSON-Schema via the
4686
+ * `create.schema` link.
4687
+ */
4189
4688
  export interface UploadRequestCreateSchema {
4190
4689
  data: {
4191
4690
  type: UploadRequestType;
@@ -4207,8 +4706,8 @@ export interface UploadRequestCreateTargetSchema {
4207
4706
  /**
4208
4707
  * You can create scheduled publication to publish records in the future
4209
4708
  *
4210
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4211
- * "scheduled_publication".
4709
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
4710
+ * `definition` "scheduled_publication".
4212
4711
  */
4213
4712
  export interface ScheduledPublication {
4214
4713
  type: ScheduledPublicationType;
@@ -4276,8 +4775,8 @@ export interface ScheduledPublicationDestroyTargetSchema {
4276
4775
  /**
4277
4776
  * You can create a scheduled unpublishing to unpublish records in the future
4278
4777
  *
4279
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4280
- * "scheduled_unpublishing".
4778
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
4779
+ * `definition` "scheduled_unpublishing".
4281
4780
  */
4282
4781
  export interface ScheduledUnpublishing {
4283
4782
  type: ScheduledUnpublishingType;
@@ -4288,8 +4787,8 @@ export interface ScheduledUnpublishing {
4288
4787
  /**
4289
4788
  * JSON API attributes
4290
4789
  *
4291
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
4292
- * `definition` "attributes".
4790
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
4791
+ * the `definition` "attributes".
4293
4792
  */
4294
4793
  export interface ScheduledUnpublishingAttributes {
4295
4794
  /** The future date for the unpublishing */
@@ -4298,8 +4797,8 @@ export interface ScheduledUnpublishingAttributes {
4298
4797
  /**
4299
4798
  * JSON API links
4300
4799
  *
4301
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
4302
- * `definition` "relationships".
4800
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
4801
+ * the `definition` "relationships".
4303
4802
  */
4304
4803
  export interface ScheduledUnpublishingRelationships {
4305
4804
  /** Item */
@@ -4310,16 +4809,16 @@ export interface ScheduledUnpublishingRelationships {
4310
4809
  /**
4311
4810
  * JSON API data
4312
4811
  *
4313
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
4314
- * `definition` "data".
4812
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
4813
+ * the `definition` "data".
4315
4814
  */
4316
4815
  export interface ScheduledUnpublishingData {
4317
4816
  type: ScheduledUnpublishingType;
4318
4817
  id: ScheduledUnpublishingIdentity;
4319
4818
  }
4320
4819
  /**
4321
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
4322
- * `create.schema` link.
4820
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
4821
+ * the `create.schema` link.
4323
4822
  */
4324
4823
  export interface ScheduledUnpublishingCreateSchema {
4325
4824
  data: {
@@ -4328,26 +4827,26 @@ export interface ScheduledUnpublishingCreateSchema {
4328
4827
  };
4329
4828
  }
4330
4829
  /**
4331
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
4332
- * `create.targetSchema` link.
4830
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
4831
+ * the `create.targetSchema` link.
4333
4832
  */
4334
4833
  export interface ScheduledUnpublishingCreateTargetSchema {
4335
4834
  data: ScheduledUnpublishing;
4336
4835
  included: Item[];
4337
4836
  }
4338
4837
  /**
4339
- * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
4340
- * `destroy.targetSchema` link.
4838
+ * This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
4839
+ * the `destroy.targetSchema` link.
4341
4840
  */
4342
4841
  export interface ScheduledUnpublishingDestroyTargetSchema {
4343
4842
  data: Item;
4344
4843
  }
4345
4844
  /**
4346
- * DatoCMS Site Search is a way to deliver tailored search results to your site visitors.
4347
- * This is the endpoint you can use to query for results.
4845
+ * DatoCMS Site Search is a way to deliver tailored search results to your site
4846
+ * visitors. This is the endpoint you can use to query for results.
4348
4847
  *
4349
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4350
- * "search_result".
4848
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
4849
+ * `definition` "search_result".
4351
4850
  */
4352
4851
  export interface SearchResult {
4353
4852
  type: SearchResultType;
@@ -4357,7 +4856,8 @@ export interface SearchResult {
4357
4856
  /**
4358
4857
  * JSON API attributes
4359
4858
  *
4360
- * This interface was referenced by `SearchResult`'s JSON-Schema via the `definition` "attributes".
4859
+ * This interface was referenced by `SearchResult`'s JSON-Schema via the
4860
+ * `definition` "attributes".
4361
4861
  */
4362
4862
  export interface SearchResultAttributes {
4363
4863
  /** Page title */
@@ -4376,7 +4876,8 @@ export interface SearchResultAttributes {
4376
4876
  /**
4377
4877
  * JSON API data
4378
4878
  *
4379
- * This interface was referenced by `SearchResult`'s JSON-Schema via the `definition` "data".
4879
+ * This interface was referenced by `SearchResult`'s JSON-Schema via the
4880
+ * `definition` "data".
4380
4881
  */
4381
4882
  export interface SearchResultData {
4382
4883
  type: SearchResultType;
@@ -4394,20 +4895,22 @@ export interface SearchResultInstancesTargetSchema {
4394
4895
  }
4395
4896
  /**
4396
4897
  * [Environments](https://www.datocms.com/docs/general-concepts/primary-and-sandbox-environments)
4397
- * make it easier for your development team to **manage and maintain content structure
4398
- * once your content has been published**. You can think of environments like code
4399
- * branches: great for testing, development and pre-production environments.
4898
+ * make it easier for your development team to **manage and maintain content
4899
+ * structure once your content has been published**. You can think of
4900
+ * environments like code branches: great for testing, development and
4901
+ * pre-production environments.
4400
4902
  *
4401
- * By default, every project has one environment, called **primary environment**, which
4402
- * is meant to be used for the regular editorial workflow. Additionally, multiple
4403
- * **sandbox environments** can be created by developers to safely test/experiment new
4404
- * changes in the content.
4903
+ * By default, every project has one environment, called **primary
4904
+ * environment**, which is meant to be used for the regular editorial workflow.
4905
+ * Additionally, multiple **sandbox environments** can be created by developers
4906
+ * to safely test/experiment new changes in the content.
4405
4907
  *
4406
- * Sandbox environments start out as **exact copies of one of the existing environments**
4407
- * (ie. the primary one). The process of creating a new sandbox starting off from an
4408
- * existing environment is called fork.
4908
+ * Sandbox environments start out as **exact copies of one of the existing
4909
+ * environments** (ie. the primary one). The process of creating a new sandbox
4910
+ * starting off from an existing environment is called fork.
4409
4911
  *
4410
- * Each environment is identified by a name (ie. `master`) and stores the following information:
4912
+ * Each environment is identified by a name (ie. `master`) and stores the
4913
+ * following information:
4411
4914
  *
4412
4915
  * - Models
4413
4916
  * - Records
@@ -4422,8 +4925,8 @@ export interface SearchResultInstancesTargetSchema {
4422
4925
  * including the primary environment, **the data in all other environments isn’t
4423
4926
  * affected** and stays the same.
4424
4927
  *
4425
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4426
- * "environment".
4928
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
4929
+ * `definition` "environment".
4427
4930
  */
4428
4931
  export interface Environment {
4429
4932
  type: EnvironmentType;
@@ -4433,7 +4936,8 @@ export interface Environment {
4433
4936
  /**
4434
4937
  * Meta attributes
4435
4938
  *
4436
- * This interface was referenced by `Environment`'s JSON-Schema via the `definition` "meta".
4939
+ * This interface was referenced by `Environment`'s JSON-Schema via the
4940
+ * `definition` "meta".
4437
4941
  */
4438
4942
  export interface EnvironmentMeta {
4439
4943
  /** Status of the environment */
@@ -4448,13 +4952,17 @@ export interface EnvironmentMeta {
4448
4952
  /**
4449
4953
  * JSON API data
4450
4954
  *
4451
- * This interface was referenced by `Environment`'s JSON-Schema via the `definition` "data".
4955
+ * This interface was referenced by `Environment`'s JSON-Schema via the
4956
+ * `definition` "data".
4452
4957
  */
4453
4958
  export interface EnvironmentData {
4454
4959
  type: EnvironmentType;
4455
4960
  id: EnvironmentIdentity;
4456
4961
  }
4457
- /** This interface was referenced by `Environment`'s JSON-Schema via the `fork.schema` link. */
4962
+ /**
4963
+ * This interface was referenced by `Environment`'s JSON-Schema via the
4964
+ * `fork.schema` link.
4965
+ */
4458
4966
  export interface EnvironmentForkSchema {
4459
4967
  data: {
4460
4968
  type: EnvironmentType;
@@ -4462,11 +4970,17 @@ export interface EnvironmentForkSchema {
4462
4970
  id: string;
4463
4971
  };
4464
4972
  }
4465
- /** This interface was referenced by `Environment`'s JSON-Schema via the `fork.targetSchema` link. */
4973
+ /**
4974
+ * This interface was referenced by `Environment`'s JSON-Schema via the
4975
+ * `fork.targetSchema` link.
4976
+ */
4466
4977
  export interface EnvironmentForkTargetSchema {
4467
4978
  data: Job | Environment;
4468
4979
  }
4469
- /** This interface was referenced by `Environment`'s JSON-Schema via the `fork.jobSchema` link. */
4980
+ /**
4981
+ * This interface was referenced by `Environment`'s JSON-Schema via the
4982
+ * `fork.jobSchema` link.
4983
+ */
4470
4984
  export interface EnvironmentForkJobSchema {
4471
4985
  data: Environment;
4472
4986
  }
@@ -4484,7 +4998,10 @@ export interface EnvironmentPromoteTargetSchema {
4484
4998
  export interface EnvironmentInstancesTargetSchema {
4485
4999
  data: Environment[];
4486
5000
  }
4487
- /** This interface was referenced by `Environment`'s JSON-Schema via the `self.targetSchema` link. */
5001
+ /**
5002
+ * This interface was referenced by `Environment`'s JSON-Schema via the
5003
+ * `self.targetSchema` link.
5004
+ */
4488
5005
  export interface EnvironmentSelfTargetSchema {
4489
5006
  data: Environment;
4490
5007
  }
@@ -4495,13 +5012,16 @@ export interface EnvironmentSelfTargetSchema {
4495
5012
  export interface EnvironmentDestroyTargetSchema {
4496
5013
  data: Job | Environment;
4497
5014
  }
4498
- /** This interface was referenced by `Environment`'s JSON-Schema via the `destroy.jobSchema` link. */
5015
+ /**
5016
+ * This interface was referenced by `Environment`'s JSON-Schema via the
5017
+ * `destroy.jobSchema` link.
5018
+ */
4499
5019
  export interface EnvironmentDestroyJobSchema {
4500
5020
  data: Environment;
4501
5021
  }
4502
5022
  /**
4503
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4504
- * "maintenance_mode".
5023
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5024
+ * `definition` "maintenance_mode".
4505
5025
  */
4506
5026
  export interface MaintenanceMode {
4507
5027
  type: MaintenanceModeType;
@@ -4511,8 +5031,8 @@ export interface MaintenanceMode {
4511
5031
  /**
4512
5032
  * JSON API attributes
4513
5033
  *
4514
- * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition`
4515
- * "attributes".
5034
+ * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
5035
+ * `definition` "attributes".
4516
5036
  */
4517
5037
  export interface MaintenanceModeAttributes {
4518
5038
  /** Whether maintenance mode is currently active or not */
@@ -4521,7 +5041,8 @@ export interface MaintenanceModeAttributes {
4521
5041
  /**
4522
5042
  * JSON API data
4523
5043
  *
4524
- * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition` "data".
5044
+ * This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
5045
+ * `definition` "data".
4525
5046
  */
4526
5047
  export interface MaintenanceModeData {
4527
5048
  type: MaintenanceModeType;
@@ -4549,10 +5070,11 @@ export interface MaintenanceModeDeactivateTargetSchema {
4549
5070
  data: MaintenanceMode;
4550
5071
  }
4551
5072
  /**
4552
- * A webhook allows to make requests following certain Dato events. It is linked to a
4553
- * Role, which describes what actions can be performed.
5073
+ * A webhook allows to make requests following certain Dato events. It is linked
5074
+ * to a Role, which describes what actions can be performed.
4554
5075
  *
4555
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "webhook".
5076
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5077
+ * `definition` "webhook".
4556
5078
  */
4557
5079
  export interface Webhook {
4558
5080
  type: WebhookType;
@@ -4562,7 +5084,8 @@ export interface Webhook {
4562
5084
  /**
4563
5085
  * JSON API attributes
4564
5086
  *
4565
- * This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "attributes".
5087
+ * This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
5088
+ * "attributes".
4566
5089
  */
4567
5090
  export interface WebhookAttributes {
4568
5091
  /** Unique name for the webhook */
@@ -4620,14 +5143,23 @@ export interface WebhookCreateSchema {
4620
5143
  http_basic_password: string | null;
4621
5144
  /** Whether the webhook is enabled and sending events or not */
4622
5145
  enabled?: boolean;
4623
- /** Specifies which API version to use when serializing entities in the webhook payload */
5146
+ /**
5147
+ * Specifies which API version to use when serializing entities in the
5148
+ * webhook payload
5149
+ */
4624
5150
  payload_api_version?: string;
4625
- /** Whether the you want records present in the payload to show blocks expanded or not */
5151
+ /**
5152
+ * Whether the you want records present in the payload to show blocks
5153
+ * expanded or not
5154
+ */
4626
5155
  nested_items_in_payload?: boolean;
4627
5156
  };
4628
5157
  };
4629
5158
  }
4630
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `create.targetSchema` link. */
5159
+ /**
5160
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
5161
+ * `create.targetSchema` link.
5162
+ */
4631
5163
  export interface WebhookCreateTargetSchema {
4632
5164
  data: Webhook;
4633
5165
  }
@@ -4655,34 +5187,52 @@ export interface WebhookUpdateSchema {
4655
5187
  http_basic_password?: string | null;
4656
5188
  /** Whether the webhook is enabled and sending events or not */
4657
5189
  enabled?: boolean;
4658
- /** Specifies which API version to use when serializing entities in the webhook payload */
5190
+ /**
5191
+ * Specifies which API version to use when serializing entities in the
5192
+ * webhook payload
5193
+ */
4659
5194
  payload_api_version?: string;
4660
- /** Whether the you want records present in the payload to show blocks expanded or not */
5195
+ /**
5196
+ * Whether the you want records present in the payload to show blocks
5197
+ * expanded or not
5198
+ */
4661
5199
  nested_items_in_payload?: boolean;
4662
5200
  };
4663
5201
  };
4664
5202
  }
4665
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `update.targetSchema` link. */
5203
+ /**
5204
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
5205
+ * `update.targetSchema` link.
5206
+ */
4666
5207
  export interface WebhookUpdateTargetSchema {
4667
5208
  data: Webhook;
4668
5209
  }
4669
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `instances.targetSchema` link. */
5210
+ /**
5211
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
5212
+ * `instances.targetSchema` link.
5213
+ */
4670
5214
  export interface WebhookInstancesTargetSchema {
4671
5215
  data: Webhook[];
4672
5216
  }
4673
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `self.targetSchema` link. */
5217
+ /**
5218
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
5219
+ * `self.targetSchema` link.
5220
+ */
4674
5221
  export interface WebhookSelfTargetSchema {
4675
5222
  data: Webhook;
4676
5223
  }
4677
- /** This interface was referenced by `Webhook`'s JSON-Schema via the `destroy.targetSchema` link. */
5224
+ /**
5225
+ * This interface was referenced by `Webhook`'s JSON-Schema via the
5226
+ * `destroy.targetSchema` link.
5227
+ */
4678
5228
  export interface WebhookDestroyTargetSchema {
4679
5229
  data: Webhook;
4680
5230
  }
4681
5231
  /**
4682
5232
  * Represents a log entry in the webhooks activity list.
4683
5233
  *
4684
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4685
- * "webhook_call".
5234
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5235
+ * `definition` "webhook_call".
4686
5236
  */
4687
5237
  export interface WebhookCall {
4688
5238
  type: WebhookCallType;
@@ -4693,7 +5243,8 @@ export interface WebhookCall {
4693
5243
  /**
4694
5244
  * JSON API attributes
4695
5245
  *
4696
- * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "attributes".
5246
+ * This interface was referenced by `WebhookCall`'s JSON-Schema via the
5247
+ * `definition` "attributes".
4697
5248
  */
4698
5249
  export interface WebhookCallAttributes {
4699
5250
  /** The subject of webhook triggering */
@@ -4722,8 +5273,8 @@ export interface WebhookCallAttributes {
4722
5273
  /**
4723
5274
  * JSON API links
4724
5275
  *
4725
- * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition`
4726
- * "relationships".
5276
+ * This interface was referenced by `WebhookCall`'s JSON-Schema via the
5277
+ * `definition` "relationships".
4727
5278
  */
4728
5279
  export interface WebhookCallRelationships {
4729
5280
  /** The webhook which has been called */
@@ -4734,7 +5285,8 @@ export interface WebhookCallRelationships {
4734
5285
  /**
4735
5286
  * JSON API data
4736
5287
  *
4737
- * This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "data".
5288
+ * This interface was referenced by `WebhookCall`'s JSON-Schema via the
5289
+ * `definition` "data".
4738
5290
  */
4739
5291
  export interface WebhookCallData {
4740
5292
  type: WebhookCallType;
@@ -4748,11 +5300,11 @@ export interface WebhookCallInstancesTargetSchema {
4748
5300
  data: WebhookCall[];
4749
5301
  }
4750
5302
  /**
4751
- * Configuration for different build triggers. You can have different staging and
4752
- * production environments in order to test your site before final deploy
5303
+ * Configuration for different build triggers. You can have different staging
5304
+ * and production environments in order to test your site before final deploy
4753
5305
  *
4754
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4755
- * "build_trigger".
5306
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5307
+ * `definition` "build_trigger".
4756
5308
  */
4757
5309
  export interface BuildTrigger {
4758
5310
  type: BuildTriggerType;
@@ -4762,7 +5314,8 @@ export interface BuildTrigger {
4762
5314
  /**
4763
5315
  * JSON API attributes
4764
5316
  *
4765
- * This interface was referenced by `BuildTrigger`'s JSON-Schema via the `definition` "attributes".
5317
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
5318
+ * `definition` "attributes".
4766
5319
  */
4767
5320
  export interface BuildTriggerAttributes {
4768
5321
  /** Name of the environment */
@@ -4797,11 +5350,17 @@ export interface BuildTriggerAttributes {
4797
5350
  export interface BuildTriggerInstancesTargetSchema {
4798
5351
  data: BuildTrigger[];
4799
5352
  }
4800
- /** This interface was referenced by `BuildTrigger`'s JSON-Schema via the `self.targetSchema` link. */
5353
+ /**
5354
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
5355
+ * `self.targetSchema` link.
5356
+ */
4801
5357
  export interface BuildTriggerSelfTargetSchema {
4802
5358
  data: BuildTrigger;
4803
5359
  }
4804
- /** This interface was referenced by `BuildTrigger`'s JSON-Schema via the `create.schema` link. */
5360
+ /**
5361
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
5362
+ * `create.schema` link.
5363
+ */
4805
5364
  export interface BuildTriggerCreateSchema {
4806
5365
  data: {
4807
5366
  type: BuildTriggerType;
@@ -4832,7 +5391,10 @@ export interface BuildTriggerCreateSchema {
4832
5391
  export interface BuildTriggerCreateTargetSchema {
4833
5392
  data: BuildTrigger;
4834
5393
  }
4835
- /** This interface was referenced by `BuildTrigger`'s JSON-Schema via the `update.schema` link. */
5394
+ /**
5395
+ * This interface was referenced by `BuildTrigger`'s JSON-Schema via the
5396
+ * `update.schema` link.
5397
+ */
4836
5398
  export interface BuildTriggerUpdateSchema {
4837
5399
  data: {
4838
5400
  type: BuildTriggerType;
@@ -4870,10 +5432,11 @@ export interface BuildTriggerDestroyTargetSchema {
4870
5432
  data: BuildTrigger;
4871
5433
  }
4872
5434
  /**
4873
- * In DatoCMS you can create filters to help you (and other editors) quickly search for records
5435
+ * In DatoCMS you can create filters to help you (and other editors) quickly
5436
+ * search for records
4874
5437
  *
4875
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4876
- * "item_type_filter".
5438
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5439
+ * `definition` "item_type_filter".
4877
5440
  */
4878
5441
  export interface ItemTypeFilter {
4879
5442
  type: ItemTypeFilterType;
@@ -4884,8 +5447,8 @@ export interface ItemTypeFilter {
4884
5447
  /**
4885
5448
  * JSON API attributes
4886
5449
  *
4887
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `definition`
4888
- * "attributes".
5450
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
5451
+ * `definition` "attributes".
4889
5452
  */
4890
5453
  export interface ItemTypeFilterAttributes {
4891
5454
  /** The name of the filter */
@@ -4900,8 +5463,8 @@ export interface ItemTypeFilterAttributes {
4900
5463
  /**
4901
5464
  * JSON API links
4902
5465
  *
4903
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `definition`
4904
- * "relationships".
5466
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
5467
+ * `definition` "relationships".
4905
5468
  */
4906
5469
  export interface ItemTypeFilterRelationships {
4907
5470
  /** Model associated with the filter */
@@ -4912,13 +5475,17 @@ export interface ItemTypeFilterRelationships {
4912
5475
  /**
4913
5476
  * JSON API data
4914
5477
  *
4915
- * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `definition` "data".
5478
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
5479
+ * `definition` "data".
4916
5480
  */
4917
5481
  export interface ItemTypeFilterData {
4918
5482
  type: ItemTypeFilterType;
4919
5483
  id: ItemTypeFilterIdentity;
4920
5484
  }
4921
- /** This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `create.schema` link. */
5485
+ /**
5486
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
5487
+ * `create.schema` link.
5488
+ */
4922
5489
  export interface ItemTypeFilterCreateSchema {
4923
5490
  data: {
4924
5491
  type: ItemTypeFilterType;
@@ -4942,7 +5509,10 @@ export interface ItemTypeFilterCreateSchema {
4942
5509
  export interface ItemTypeFilterCreateTargetSchema {
4943
5510
  data: ItemTypeFilter;
4944
5511
  }
4945
- /** This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the `update.schema` link. */
5512
+ /**
5513
+ * This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
5514
+ * `update.schema` link.
5515
+ */
4946
5516
  export interface ItemTypeFilterUpdateSchema {
4947
5517
  data: {
4948
5518
  type: ItemTypeFilterType;
@@ -4989,10 +5559,11 @@ export interface ItemTypeFilterDestroyTargetSchema {
4989
5559
  data: ItemTypeFilter;
4990
5560
  }
4991
5561
  /**
4992
- * In DatoCMS you can create filters to help you (and other editors) quickly search for uploads
5562
+ * In DatoCMS you can create filters to help you (and other editors) quickly
5563
+ * search for uploads
4993
5564
  *
4994
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
4995
- * "upload_filter".
5565
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5566
+ * `definition` "upload_filter".
4996
5567
  */
4997
5568
  export interface UploadFilter {
4998
5569
  type: UploadFilterType;
@@ -5002,7 +5573,8 @@ export interface UploadFilter {
5002
5573
  /**
5003
5574
  * JSON API attributes
5004
5575
  *
5005
- * This interface was referenced by `UploadFilter`'s JSON-Schema via the `definition` "attributes".
5576
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
5577
+ * `definition` "attributes".
5006
5578
  */
5007
5579
  export interface UploadFilterAttributes {
5008
5580
  /** The name of the filter */
@@ -5017,13 +5589,17 @@ export interface UploadFilterAttributes {
5017
5589
  /**
5018
5590
  * JSON API data
5019
5591
  *
5020
- * This interface was referenced by `UploadFilter`'s JSON-Schema via the `definition` "data".
5592
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
5593
+ * `definition` "data".
5021
5594
  */
5022
5595
  export interface UploadFilterData {
5023
5596
  type: UploadFilterType;
5024
5597
  id: UploadFilterIdentity;
5025
5598
  }
5026
- /** This interface was referenced by `UploadFilter`'s JSON-Schema via the `create.schema` link. */
5599
+ /**
5600
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
5601
+ * `create.schema` link.
5602
+ */
5027
5603
  export interface UploadFilterCreateSchema {
5028
5604
  data: {
5029
5605
  type: UploadFilterType;
@@ -5047,7 +5623,10 @@ export interface UploadFilterCreateSchema {
5047
5623
  export interface UploadFilterCreateTargetSchema {
5048
5624
  data: UploadFilter;
5049
5625
  }
5050
- /** This interface was referenced by `UploadFilter`'s JSON-Schema via the `update.schema` link. */
5626
+ /**
5627
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
5628
+ * `update.schema` link.
5629
+ */
5051
5630
  export interface UploadFilterUpdateSchema {
5052
5631
  data: {
5053
5632
  type: UploadFilterType;
@@ -5079,7 +5658,10 @@ export interface UploadFilterUpdateTargetSchema {
5079
5658
  export interface UploadFilterInstancesTargetSchema {
5080
5659
  data: UploadFilter[];
5081
5660
  }
5082
- /** This interface was referenced by `UploadFilter`'s JSON-Schema via the `self.targetSchema` link. */
5661
+ /**
5662
+ * This interface was referenced by `UploadFilter`'s JSON-Schema via the
5663
+ * `self.targetSchema` link.
5664
+ */
5083
5665
  export interface UploadFilterSelfTargetSchema {
5084
5666
  data: UploadFilter;
5085
5667
  }
@@ -5091,12 +5673,12 @@ export interface UploadFilterDestroyTargetSchema {
5091
5673
  data: UploadFilter;
5092
5674
  }
5093
5675
  /**
5094
- * A DatoCMS administrative area can be accessed by multiple people. Every invitation is
5095
- * linked to a specific Role, which describes what actions it will be able to perform
5096
- * once the user will register.
5676
+ * A DatoCMS administrative area can be accessed by multiple people. Every
5677
+ * invitation is linked to a specific Role, which describes what actions it will
5678
+ * be able to perform once the user will register.
5097
5679
  *
5098
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5099
- * "site_invitation".
5680
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5681
+ * `definition` "site_invitation".
5100
5682
  */
5101
5683
  export interface SiteInvitation {
5102
5684
  type: SiteInvitationType;
@@ -5107,8 +5689,8 @@ export interface SiteInvitation {
5107
5689
  /**
5108
5690
  * JSON API attributes
5109
5691
  *
5110
- * This interface was referenced by `SiteInvitation`'s JSON-Schema via the `definition`
5111
- * "attributes".
5692
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
5693
+ * `definition` "attributes".
5112
5694
  */
5113
5695
  export interface SiteInvitationAttributes {
5114
5696
  /** Email */
@@ -5117,8 +5699,8 @@ export interface SiteInvitationAttributes {
5117
5699
  /**
5118
5700
  * JSON API links
5119
5701
  *
5120
- * This interface was referenced by `SiteInvitation`'s JSON-Schema via the `definition`
5121
- * "relationships".
5702
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
5703
+ * `definition` "relationships".
5122
5704
  */
5123
5705
  export interface SiteInvitationRelationships {
5124
5706
  /** Role */
@@ -5129,13 +5711,17 @@ export interface SiteInvitationRelationships {
5129
5711
  /**
5130
5712
  * JSON API data
5131
5713
  *
5132
- * This interface was referenced by `SiteInvitation`'s JSON-Schema via the `definition` "data".
5714
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
5715
+ * `definition` "data".
5133
5716
  */
5134
5717
  export interface SiteInvitationData {
5135
5718
  type: SiteInvitationType;
5136
5719
  id: SiteInvitationIdentity;
5137
5720
  }
5138
- /** This interface was referenced by `SiteInvitation`'s JSON-Schema via the `create.schema` link. */
5721
+ /**
5722
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
5723
+ * `create.schema` link.
5724
+ */
5139
5725
  export interface SiteInvitationCreateSchema {
5140
5726
  data: {
5141
5727
  type: SiteInvitationType;
@@ -5158,7 +5744,10 @@ export interface SiteInvitationCreateSchema {
5158
5744
  export interface SiteInvitationCreateTargetSchema {
5159
5745
  data: SiteInvitation;
5160
5746
  }
5161
- /** This interface was referenced by `SiteInvitation`'s JSON-Schema via the `update.schema` link. */
5747
+ /**
5748
+ * This interface was referenced by `SiteInvitation`'s JSON-Schema via the
5749
+ * `update.schema` link.
5750
+ */
5162
5751
  export interface SiteInvitationUpdateSchema {
5163
5752
  data: {
5164
5753
  type: SiteInvitationType;
@@ -5200,11 +5789,11 @@ export interface SiteInvitationDestroyTargetSchema {
5200
5789
  data: SiteInvitation;
5201
5790
  }
5202
5791
  /**
5203
- * Session track users movements in the administrative area, and allows locking a record
5204
- * when editing it.
5792
+ * Session track users movements in the administrative area, and allows locking
5793
+ * a record when editing it.
5205
5794
  *
5206
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5207
- * "editing_session".
5795
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5796
+ * `definition` "editing_session".
5208
5797
  */
5209
5798
  export interface EditingSession {
5210
5799
  type: EditingSessionType;
@@ -5215,8 +5804,8 @@ export interface EditingSession {
5215
5804
  /**
5216
5805
  * JSON API attributes
5217
5806
  *
5218
- * This interface was referenced by `EditingSession`'s JSON-Schema via the `definition`
5219
- * "attributes".
5807
+ * This interface was referenced by `EditingSession`'s JSON-Schema via the
5808
+ * `definition` "attributes".
5220
5809
  */
5221
5810
  export interface EditingSessionAttributes {
5222
5811
  /** User entered at */
@@ -5227,8 +5816,8 @@ export interface EditingSessionAttributes {
5227
5816
  /**
5228
5817
  * JSON API links
5229
5818
  *
5230
- * This interface was referenced by `EditingSession`'s JSON-Schema via the `definition`
5231
- * "relationships".
5819
+ * This interface was referenced by `EditingSession`'s JSON-Schema via the
5820
+ * `definition` "relationships".
5232
5821
  */
5233
5822
  export interface EditingSessionRelationships {
5234
5823
  /** The active item in the session */
@@ -5247,7 +5836,8 @@ export interface EditingSessionRelationships {
5247
5836
  /**
5248
5837
  * JSON API data
5249
5838
  *
5250
- * This interface was referenced by `EditingSession`'s JSON-Schema via the `definition` "data".
5839
+ * This interface was referenced by `EditingSession`'s JSON-Schema via the
5840
+ * `definition` "data".
5251
5841
  */
5252
5842
  export interface EditingSessionData {
5253
5843
  type: EditingSessionType;
@@ -5260,7 +5850,10 @@ export interface EditingSessionData {
5260
5850
  export interface EditingSessionInstancesTargetSchema {
5261
5851
  data: EditingSession[];
5262
5852
  }
5263
- /** This interface was referenced by `EditingSession`'s JSON-Schema via the `update.schema` link. */
5853
+ /**
5854
+ * This interface was referenced by `EditingSession`'s JSON-Schema via the
5855
+ * `update.schema` link.
5856
+ */
5264
5857
  export interface EditingSessionUpdateSchema {
5265
5858
  data: {
5266
5859
  /** JSON API type */
@@ -5312,11 +5905,12 @@ export interface EditingSessionDestroyTargetSchema {
5312
5905
  data: EditingSession;
5313
5906
  }
5314
5907
  /**
5315
- * A Single Sign-On group exists when a DatoCMS project is connected to an Identity
5316
- * Provider. These groups can be used to link DatoCMS roles to the Identity Provider's groups.
5908
+ * A Single Sign-On group exists when a DatoCMS project is connected to an
5909
+ * Identity Provider. These groups can be used to link DatoCMS roles to the
5910
+ * Identity Provider's groups.
5317
5911
  *
5318
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5319
- * "sso_group".
5912
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
5913
+ * `definition` "sso_group".
5320
5914
  */
5321
5915
  export interface SsoGroup {
5322
5916
  type: SsoGroupType;
@@ -5327,21 +5921,23 @@ export interface SsoGroup {
5327
5921
  /**
5328
5922
  * JSON API attributes
5329
5923
  *
5330
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "attributes".
5924
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
5925
+ * `definition` "attributes".
5331
5926
  */
5332
5927
  export interface SsoGroupAttributes {
5333
5928
  /** Name of the group */
5334
5929
  name: string;
5335
5930
  /**
5336
- * When an user belongs to multiple groups, the role associated to the group with the
5337
- * highest priority will be used
5931
+ * When an user belongs to multiple groups, the role associated to the group
5932
+ * with the highest priority will be used
5338
5933
  */
5339
5934
  priority: number;
5340
5935
  }
5341
5936
  /**
5342
5937
  * JSON API links
5343
5938
  *
5344
- * This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "relationships".
5939
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
5940
+ * `definition` "relationships".
5345
5941
  */
5346
5942
  export interface SsoGroupRelationships {
5347
5943
  /** Sso Group's role */
@@ -5353,7 +5949,10 @@ export interface SsoGroupRelationships {
5353
5949
  data: SsoUserData[];
5354
5950
  };
5355
5951
  }
5356
- /** This interface was referenced by `SsoGroup`'s JSON-Schema via the `instances.targetSchema` link. */
5952
+ /**
5953
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
5954
+ * `instances.targetSchema` link.
5955
+ */
5357
5956
  export interface SsoGroupInstancesTargetSchema {
5358
5957
  data: SsoGroup[];
5359
5958
  }
@@ -5371,8 +5970,8 @@ export interface SsoGroupUpdateSchema {
5371
5970
  id: SsoGroupIdentity;
5372
5971
  attributes: {
5373
5972
  /**
5374
- * When an user belongs to multiple groups, the role associated to the group with
5375
- * the highest priority will be used
5973
+ * When an user belongs to multiple groups, the role associated to the
5974
+ * group with the highest priority will be used
5376
5975
  */
5377
5976
  priority: number;
5378
5977
  };
@@ -5384,19 +5983,25 @@ export interface SsoGroupUpdateSchema {
5384
5983
  };
5385
5984
  };
5386
5985
  }
5387
- /** This interface was referenced by `SsoGroup`'s JSON-Schema via the `update.targetSchema` link. */
5986
+ /**
5987
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
5988
+ * `update.targetSchema` link.
5989
+ */
5388
5990
  export interface SsoGroupUpdateTargetSchema {
5389
5991
  data: SsoGroup;
5390
5992
  }
5391
- /** This interface was referenced by `SsoGroup`'s JSON-Schema via the `destroy.targetSchema` link. */
5993
+ /**
5994
+ * This interface was referenced by `SsoGroup`'s JSON-Schema via the
5995
+ * `destroy.targetSchema` link.
5996
+ */
5392
5997
  export interface SsoGroupDestroyTargetSchema {
5393
5998
  data: SsoGroup;
5394
5999
  }
5395
6000
  /**
5396
6001
  * Represents the Single Sign-on settings of the current DatoCMS project
5397
6002
  *
5398
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5399
- * "sso_settings".
6003
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6004
+ * `definition` "sso_settings".
5400
6005
  */
5401
6006
  export interface SsoSettings {
5402
6007
  type: SsoSettingsType;
@@ -5407,7 +6012,8 @@ export interface SsoSettings {
5407
6012
  /**
5408
6013
  * JSON API attributes
5409
6014
  *
5410
- * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "attributes".
6015
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
6016
+ * `definition` "attributes".
5411
6017
  */
5412
6018
  export interface SsoSettingsAttributes {
5413
6019
  /** URL of Identity Provider SAML Metadata endpoint */
@@ -5428,8 +6034,8 @@ export interface SsoSettingsAttributes {
5428
6034
  /**
5429
6035
  * JSON API links
5430
6036
  *
5431
- * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition`
5432
- * "relationships".
6037
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
6038
+ * `definition` "relationships".
5433
6039
  */
5434
6040
  export interface SsoSettingsRelationships {
5435
6041
  /** The default role assigned to SSO users that do not belong to any SSO group */
@@ -5440,13 +6046,17 @@ export interface SsoSettingsRelationships {
5440
6046
  /**
5441
6047
  * JSON API data
5442
6048
  *
5443
- * This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "data".
6049
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
6050
+ * `definition` "data".
5444
6051
  */
5445
6052
  export interface SsoSettingsData {
5446
6053
  type: SsoSettingsType;
5447
6054
  id: SsoSettingsIdentity;
5448
6055
  }
5449
- /** This interface was referenced by `SsoSettings`'s JSON-Schema via the `self.targetSchema` link. */
6056
+ /**
6057
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
6058
+ * `self.targetSchema` link.
6059
+ */
5450
6060
  export interface SsoSettingsSelfTargetSchema {
5451
6061
  data: SsoSettings;
5452
6062
  }
@@ -5466,7 +6076,10 @@ export interface SsoSettingsGenerateTokenTargetSchema {
5466
6076
  [k: string]: unknown;
5467
6077
  };
5468
6078
  }
5469
- /** This interface was referenced by `SsoSettings`'s JSON-Schema via the `update.schema` link. */
6079
+ /**
6080
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
6081
+ * `update.schema` link.
6082
+ */
5470
6083
  export interface SsoSettingsUpdateSchema {
5471
6084
  data: {
5472
6085
  type: SsoSettingsType;
@@ -5483,15 +6096,18 @@ export interface SsoSettingsUpdateSchema {
5483
6096
  };
5484
6097
  };
5485
6098
  }
5486
- /** This interface was referenced by `SsoSettings`'s JSON-Schema via the `update.targetSchema` link. */
6099
+ /**
6100
+ * This interface was referenced by `SsoSettings`'s JSON-Schema via the
6101
+ * `update.targetSchema` link.
6102
+ */
5487
6103
  export interface SsoSettingsUpdateTargetSchema {
5488
6104
  data: SsoSettings;
5489
6105
  }
5490
6106
  /**
5491
6107
  * Represents the white-label settings of the current DatoCMS project
5492
6108
  *
5493
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5494
- * "white_label_settings".
6109
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6110
+ * `definition` "white_label_settings".
5495
6111
  */
5496
6112
  export interface WhiteLabelSettings {
5497
6113
  type: WhiteLabelSettingsType;
@@ -5505,13 +6121,17 @@ export interface WhiteLabelSettings {
5505
6121
  * `definition` "attributes".
5506
6122
  */
5507
6123
  export interface WhiteLabelSettingsAttributes {
5508
- /** URL of custom I18n messages. The :locale placeholder represents the current DatoCMS UI locale. */
6124
+ /**
6125
+ * URL of custom I18n messages. The :locale placeholder represents the current
6126
+ * DatoCMS UI locale.
6127
+ */
5509
6128
  custom_i18n_messages_template_url: null | string;
5510
6129
  }
5511
6130
  /**
5512
6131
  * JSON API data
5513
6132
  *
5514
- * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the `definition` "data".
6133
+ * This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
6134
+ * `definition` "data".
5515
6135
  */
5516
6136
  export interface WhiteLabelSettingsData {
5517
6137
  type: WhiteLabelSettingsType;
@@ -5534,8 +6154,8 @@ export interface WhiteLabelSettingsUpdateSchema {
5534
6154
  id?: WhiteLabelSettingsIdentity;
5535
6155
  attributes?: {
5536
6156
  /**
5537
- * URL of custom I18n messages. The :locale placeholder represents the current
5538
- * DatoCMS UI locale.
6157
+ * URL of custom I18n messages. The :locale placeholder represents the
6158
+ * current DatoCMS UI locale.
5539
6159
  */
5540
6160
  custom_i18n_messages_template_url: null | string;
5541
6161
  };
@@ -5551,8 +6171,8 @@ export interface WhiteLabelSettingsUpdateTargetSchema {
5551
6171
  /**
5552
6172
  * Info that can be accessed by unauthorized users
5553
6173
  *
5554
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5555
- * "public_info".
6174
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6175
+ * `definition` "public_info".
5556
6176
  */
5557
6177
  export interface PublicInfo {
5558
6178
  type: PublicInfoType;
@@ -5562,7 +6182,8 @@ export interface PublicInfo {
5562
6182
  /**
5563
6183
  * JSON API attributes
5564
6184
  *
5565
- * This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "attributes".
6185
+ * This interface was referenced by `PublicInfo`'s JSON-Schema via the
6186
+ * `definition` "attributes".
5566
6187
  */
5567
6188
  export interface PublicInfoAttributes {
5568
6189
  /** Site name */
@@ -5617,21 +6238,25 @@ export interface PublicInfoAttributes {
5617
6238
  /**
5618
6239
  * JSON API data
5619
6240
  *
5620
- * This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "data".
6241
+ * This interface was referenced by `PublicInfo`'s JSON-Schema via the
6242
+ * `definition` "data".
5621
6243
  */
5622
6244
  export interface PublicInfoData {
5623
6245
  type: PublicInfoType;
5624
6246
  id: PublicInfoIdentity;
5625
6247
  }
5626
- /** This interface was referenced by `PublicInfo`'s JSON-Schema via the `self.targetSchema` link. */
6248
+ /**
6249
+ * This interface was referenced by `PublicInfo`'s JSON-Schema via the
6250
+ * `self.targetSchema` link.
6251
+ */
5627
6252
  export interface PublicInfoSelfTargetSchema {
5628
6253
  data: PublicInfo;
5629
6254
  }
5630
6255
  /**
5631
6256
  * DatoCMS resources usage organized by day
5632
6257
  *
5633
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5634
- * "daily_usage".
6258
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6259
+ * `definition` "daily_usage".
5635
6260
  */
5636
6261
  export interface DailyUsage {
5637
6262
  type: DailyUsageType;
@@ -5641,7 +6266,8 @@ export interface DailyUsage {
5641
6266
  /**
5642
6267
  * JSON API attributes
5643
6268
  *
5644
- * This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "attributes".
6269
+ * This interface was referenced by `DailyUsage`'s JSON-Schema via the
6270
+ * `definition` "attributes".
5645
6271
  */
5646
6272
  export interface DailyUsageAttributes {
5647
6273
  /** The date the data are referring to */
@@ -5660,7 +6286,8 @@ export interface DailyUsageAttributes {
5660
6286
  /**
5661
6287
  * JSON API data
5662
6288
  *
5663
- * This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "data".
6289
+ * This interface was referenced by `DailyUsage`'s JSON-Schema via the
6290
+ * `definition` "data".
5664
6291
  */
5665
6292
  export interface DailyUsageData {
5666
6293
  type: DailyUsageType;
@@ -5674,13 +6301,14 @@ export interface DailyUsageInstancesTargetSchema {
5674
6301
  data: DailyUsage;
5675
6302
  }
5676
6303
  /**
5677
- * You can use counters to analyze your project's data consumption over a period of time.
5678
- * Counters are especially useful if your project is exceeding its API calls/traffic
5679
- * quota limits, to better understand where and how requests are originating. Counters
5680
- * are updated every minute, so you can debug in real-time the results of your changes.
6304
+ * You can use counters to analyze your project's data consumption over a period
6305
+ * of time. Counters are especially useful if your project is exceeding its API
6306
+ * calls/traffic quota limits, to better understand where and how requests are
6307
+ * originating. Counters are updated every minute, so you can debug in real-time
6308
+ * the results of your changes.
5681
6309
  *
5682
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5683
- * "usage_counter".
6310
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6311
+ * `definition` "usage_counter".
5684
6312
  */
5685
6313
  export interface UsageCounter {
5686
6314
  type: UsageCounterType;
@@ -5690,7 +6318,8 @@ export interface UsageCounter {
5690
6318
  /**
5691
6319
  * JSON API attributes
5692
6320
  *
5693
- * This interface was referenced by `UsageCounter`'s JSON-Schema via the `definition` "attributes".
6321
+ * This interface was referenced by `UsageCounter`'s JSON-Schema via the
6322
+ * `definition` "attributes".
5694
6323
  */
5695
6324
  export interface UsageCounterAttributes {
5696
6325
  result: {
@@ -5703,21 +6332,25 @@ export interface UsageCounterAttributes {
5703
6332
  /**
5704
6333
  * JSON API data
5705
6334
  *
5706
- * This interface was referenced by `UsageCounter`'s JSON-Schema via the `definition` "data".
6335
+ * This interface was referenced by `UsageCounter`'s JSON-Schema via the
6336
+ * `definition` "data".
5707
6337
  */
5708
6338
  export interface UsageCounterData {
5709
6339
  type: UsageCounterType;
5710
6340
  id: UsageCounterIdentity;
5711
6341
  }
5712
- /** This interface was referenced by `UsageCounter`'s JSON-Schema via the `self.targetSchema` link. */
6342
+ /**
6343
+ * This interface was referenced by `UsageCounter`'s JSON-Schema via the
6344
+ * `self.targetSchema` link.
6345
+ */
5713
6346
  export interface UsageCounterSelfTargetSchema {
5714
6347
  data: UsageCounter;
5715
6348
  }
5716
6349
  /**
5717
6350
  * All the project's upload tags
5718
6351
  *
5719
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5720
- * "upload_tag".
6352
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6353
+ * `definition` "upload_tag".
5721
6354
  */
5722
6355
  export interface UploadTag {
5723
6356
  type: UploadTagType;
@@ -5727,7 +6360,8 @@ export interface UploadTag {
5727
6360
  /**
5728
6361
  * JSON API attributes
5729
6362
  *
5730
- * This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "attributes".
6363
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
6364
+ * `definition` "attributes".
5731
6365
  */
5732
6366
  export interface UploadTagAttributes {
5733
6367
  /** The tag name */
@@ -5749,7 +6383,10 @@ export interface UploadTagData {
5749
6383
  export interface UploadTagInstancesTargetSchema {
5750
6384
  data: UploadTag[];
5751
6385
  }
5752
- /** This interface was referenced by `UploadTag`'s JSON-Schema via the `create.schema` link. */
6386
+ /**
6387
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
6388
+ * `create.schema` link.
6389
+ */
5753
6390
  export interface UploadTagCreateSchema {
5754
6391
  data: {
5755
6392
  type: UploadTagType;
@@ -5759,15 +6396,18 @@ export interface UploadTagCreateSchema {
5759
6396
  };
5760
6397
  };
5761
6398
  }
5762
- /** This interface was referenced by `UploadTag`'s JSON-Schema via the `create.targetSchema` link. */
6399
+ /**
6400
+ * This interface was referenced by `UploadTag`'s JSON-Schema via the
6401
+ * `create.targetSchema` link.
6402
+ */
5763
6403
  export interface UploadTagCreateTargetSchema {
5764
6404
  data: UploadTag;
5765
6405
  }
5766
6406
  /**
5767
6407
  * All the site's upload automatically generated tags
5768
6408
  *
5769
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
5770
- * "upload_smart_tag".
6409
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6410
+ * `definition` "upload_smart_tag".
5771
6411
  */
5772
6412
  export interface UploadSmartTag {
5773
6413
  type: UploadSmartTagType;
@@ -5777,8 +6417,8 @@ export interface UploadSmartTag {
5777
6417
  /**
5778
6418
  * JSON API attributes
5779
6419
  *
5780
- * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the `definition`
5781
- * "attributes".
6420
+ * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
6421
+ * `definition` "attributes".
5782
6422
  */
5783
6423
  export interface UploadSmartTagAttributes {
5784
6424
  /** The tag name */
@@ -5787,7 +6427,8 @@ export interface UploadSmartTagAttributes {
5787
6427
  /**
5788
6428
  * JSON API data
5789
6429
  *
5790
- * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the `definition` "data".
6430
+ * This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
6431
+ * `definition` "data".
5791
6432
  */
5792
6433
  export interface UploadSmartTagData {
5793
6434
  type: UploadSmartTagType;
@@ -5803,7 +6444,8 @@ export interface UploadSmartTagInstancesTargetSchema {
5803
6444
  /**
5804
6445
  * A site represents a specific DatoCMS administrative area
5805
6446
  *
5806
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "site".
6447
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6448
+ * `definition` "site".
5807
6449
  */
5808
6450
  export interface Site {
5809
6451
  type: SiteType;
@@ -5814,7 +6456,8 @@ export interface Site {
5814
6456
  /**
5815
6457
  * JSON API attributes
5816
6458
  *
5817
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "attributes".
6459
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
6460
+ * "attributes".
5818
6461
  */
5819
6462
  export interface SiteAttributes {
5820
6463
  /** Site name */
@@ -5839,7 +6482,10 @@ export interface SiteAttributes {
5839
6482
  last_data_change_at: null | string;
5840
6483
  /** Frontend website url */
5841
6484
  frontend_url: string | null;
5842
- /** Specifies whether all users of this site need to authenticate using two-factor authentication */
6485
+ /**
6486
+ * Specifies whether all users of this site need to authenticate using
6487
+ * two-factor authentication
6488
+ */
5843
6489
  require_2fa: boolean;
5844
6490
  /** Specifies whether you want IPs to be tracked in the Project usages section */
5845
6491
  ip_tracking_enabled: boolean;
@@ -5902,7 +6548,8 @@ export interface SiteAttributes {
5902
6548
  /**
5903
6549
  * JSON API links
5904
6550
  *
5905
- * This interface was referenced by `Site`'s JSON-Schema via the `definition` "relationships".
6551
+ * This interface was referenced by `Site`'s JSON-Schema via the `definition`
6552
+ * "relationships".
5906
6553
  */
5907
6554
  export interface SiteRelationships {
5908
6555
  account: {
@@ -6023,8 +6670,8 @@ export interface SiteUpdateSchema {
6023
6670
  /** Site default timezone */
6024
6671
  timezone?: string;
6025
6672
  /**
6026
- * Specifies whether all users of this site need to authenticate using two-factor
6027
- * authentication
6673
+ * Specifies whether all users of this site need to authenticate using
6674
+ * two-factor authentication
6028
6675
  */
6029
6676
  require_2fa?: boolean;
6030
6677
  /** Specifies whether you want IPs to be tracked in the Project usages section */
@@ -6037,7 +6684,10 @@ export interface SiteUpdateSchema {
6037
6684
  };
6038
6685
  };
6039
6686
  }
6040
- /** This interface was referenced by `Site`'s JSON-Schema via the `update.targetSchema` link. */
6687
+ /**
6688
+ * This interface was referenced by `Site`'s JSON-Schema via the
6689
+ * `update.targetSchema` link.
6690
+ */
6041
6691
  export interface SiteUpdateTargetSchema {
6042
6692
  data: Job;
6043
6693
  }
@@ -6046,11 +6696,12 @@ export interface SiteUpdateJobSchema {
6046
6696
  data: Site;
6047
6697
  }
6048
6698
  /**
6049
- * Through workflows it is possible to set up a precise state machine able to bring a
6050
- * draft content up to the final publication (and beyond), through a series of
6051
- * intermediate, fully customizable approval steps.
6699
+ * Through workflows it is possible to set up a precise state machine able to
6700
+ * bring a draft content up to the final publication (and beyond), through a
6701
+ * series of intermediate, fully customizable approval steps.
6052
6702
  *
6053
- * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "workflow".
6703
+ * This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
6704
+ * `definition` "workflow".
6054
6705
  */
6055
6706
  export interface Workflow {
6056
6707
  type: WorkflowType;
@@ -6060,7 +6711,8 @@ export interface Workflow {
6060
6711
  /**
6061
6712
  * JSON API attributes
6062
6713
  *
6063
- * This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "attributes".
6714
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
6715
+ * `definition` "attributes".
6064
6716
  */
6065
6717
  export interface WorkflowAttributes {
6066
6718
  /** The name of the workflow */
@@ -6124,7 +6776,10 @@ export interface WorkflowCreateSchema {
6124
6776
  };
6125
6777
  };
6126
6778
  }
6127
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `create.targetSchema` link. */
6779
+ /**
6780
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
6781
+ * `create.targetSchema` link.
6782
+ */
6128
6783
  export interface WorkflowCreateTargetSchema {
6129
6784
  data: Workflow;
6130
6785
  }
@@ -6163,15 +6818,24 @@ export interface WorkflowUpdateSchema {
6163
6818
  };
6164
6819
  };
6165
6820
  }
6166
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `update.targetSchema` link. */
6821
+ /**
6822
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
6823
+ * `update.targetSchema` link.
6824
+ */
6167
6825
  export interface WorkflowUpdateTargetSchema {
6168
6826
  data: Workflow;
6169
6827
  }
6170
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `instances.targetSchema` link. */
6828
+ /**
6829
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
6830
+ * `instances.targetSchema` link.
6831
+ */
6171
6832
  export interface WorkflowInstancesTargetSchema {
6172
6833
  data: Workflow[];
6173
6834
  }
6174
- /** This interface was referenced by `Workflow`'s JSON-Schema via the `self.targetSchema` link. */
6835
+ /**
6836
+ * This interface was referenced by `Workflow`'s JSON-Schema via the
6837
+ * `self.targetSchema` link.
6838
+ */
6175
6839
  export interface WorkflowSelfTargetSchema {
6176
6840
  data: Workflow;
6177
6841
  }