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