datocms-plugin-sdk 0.5.2 → 0.5.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/SiteApiSchema.js +0 -1
- package/dist/cjs/SiteApiSchema.js.map +1 -1
- package/dist/esm/SiteApiSchema.d.ts +1298 -634
- package/dist/esm/SiteApiSchema.js +0 -1
- package/dist/esm/SiteApiSchema.js.map +1 -1
- package/dist/types/SiteApiSchema.d.ts +1298 -634
- package/package.json +2 -2
- package/src/SiteApiSchema.ts +1404 -741
- package/types.json +70 -70
package/src/SiteApiSchema.ts
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
/* eslint-disable camelcase */
|
|
2
2
|
/* tslint:disable */
|
|
3
|
-
/** This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT BY HAND. */
|
|
4
3
|
|
|
4
|
+
/** This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT BY HAND. */
|
|
5
5
|
/**
|
|
6
6
|
* JSON API type field
|
|
7
7
|
*
|
|
8
8
|
* This interface was referenced by `Role`'s JSON-Schema via the `definition` "type".
|
|
9
9
|
*/
|
|
10
|
-
export type RoleType = 'role';
|
|
10
|
+
export declare type RoleType = 'role';
|
|
11
11
|
/**
|
|
12
12
|
* ID of role
|
|
13
13
|
*
|
|
@@ -15,45 +15,50 @@ export type RoleType = 'role';
|
|
|
15
15
|
*
|
|
16
16
|
* This interface was referenced by `Role`'s JSON-Schema via the `definition` "id".
|
|
17
17
|
*/
|
|
18
|
-
export type RoleIdentity = string;
|
|
18
|
+
export declare type RoleIdentity = string;
|
|
19
19
|
/**
|
|
20
20
|
* ID of item type
|
|
21
21
|
*
|
|
22
|
-
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
22
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
23
|
+
* `definition` "identity".
|
|
23
24
|
*
|
|
24
25
|
* This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition` "id".
|
|
25
26
|
*/
|
|
26
|
-
export type ItemTypeIdentity = string;
|
|
27
|
+
export declare type ItemTypeIdentity = string;
|
|
27
28
|
/**
|
|
28
29
|
* ID of workflow
|
|
29
30
|
*
|
|
30
|
-
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
31
|
+
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
32
|
+
* `definition` "identity".
|
|
31
33
|
*
|
|
32
34
|
* This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "id".
|
|
33
35
|
*/
|
|
34
|
-
export type WorkflowIdentity = string;
|
|
36
|
+
export declare type WorkflowIdentity = string;
|
|
35
37
|
/**
|
|
36
38
|
* ID of environment. Can only contain lowercase letters, numbers and dashes
|
|
37
39
|
*
|
|
38
|
-
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
40
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
41
|
+
* `definition` "identity".
|
|
39
42
|
*
|
|
40
43
|
* This interface was referenced by `Environment`'s JSON-Schema via the `definition` "id".
|
|
41
44
|
*/
|
|
42
|
-
export type EnvironmentIdentity = string;
|
|
45
|
+
export declare type EnvironmentIdentity = string;
|
|
43
46
|
/**
|
|
44
47
|
* ID of build_trigger
|
|
45
48
|
*
|
|
46
|
-
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
49
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
50
|
+
* `definition` "identity".
|
|
47
51
|
*
|
|
48
|
-
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
52
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
53
|
+
* `definition` "id".
|
|
49
54
|
*/
|
|
50
|
-
export type BuildTriggerIdentity = string;
|
|
55
|
+
export declare type BuildTriggerIdentity = string;
|
|
51
56
|
/**
|
|
52
57
|
* JSON API type field
|
|
53
58
|
*
|
|
54
59
|
* This interface was referenced by `User`'s JSON-Schema via the `definition` "type".
|
|
55
60
|
*/
|
|
56
|
-
export type UserType = 'user';
|
|
61
|
+
export declare type UserType = 'user';
|
|
57
62
|
/**
|
|
58
63
|
* ID of collaborator
|
|
59
64
|
*
|
|
@@ -61,99 +66,111 @@ export type UserType = 'user';
|
|
|
61
66
|
*
|
|
62
67
|
* This interface was referenced by `User`'s JSON-Schema via the `definition` "id".
|
|
63
68
|
*/
|
|
64
|
-
export type UserIdentity = string;
|
|
69
|
+
export declare type UserIdentity = string;
|
|
65
70
|
/**
|
|
66
71
|
* JSON API type field
|
|
67
72
|
*
|
|
68
73
|
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "type".
|
|
69
74
|
*/
|
|
70
|
-
export type SsoUserType = 'sso_user';
|
|
75
|
+
export declare type SsoUserType = 'sso_user';
|
|
71
76
|
/**
|
|
72
77
|
* ID of user
|
|
73
78
|
*
|
|
74
|
-
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
|
|
79
|
+
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
|
|
80
|
+
* "identity".
|
|
75
81
|
*
|
|
76
82
|
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition` "id".
|
|
77
83
|
*/
|
|
78
|
-
export type SsoUserIdentity = string;
|
|
84
|
+
export declare type SsoUserIdentity = string;
|
|
79
85
|
/**
|
|
80
86
|
* JSON API type field
|
|
81
87
|
*
|
|
82
88
|
* This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "type".
|
|
83
89
|
*/
|
|
84
|
-
export type SsoGroupType = 'sso_group';
|
|
90
|
+
export declare type SsoGroupType = 'sso_group';
|
|
85
91
|
/**
|
|
86
92
|
* ID of group
|
|
87
93
|
*
|
|
88
|
-
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
94
|
+
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
95
|
+
* `definition` "identity".
|
|
89
96
|
*
|
|
90
97
|
* This interface was referenced by `SsoGroup`'s JSON-Schema via the `definition` "id".
|
|
91
98
|
*/
|
|
92
|
-
export type SsoGroupIdentity = string;
|
|
99
|
+
export declare type SsoGroupIdentity = string;
|
|
93
100
|
/**
|
|
94
101
|
* JSON API type field
|
|
95
102
|
*
|
|
96
|
-
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
103
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
104
|
+
* `definition` "type".
|
|
97
105
|
*/
|
|
98
|
-
export type AuditLogEventType = 'audit_log_event';
|
|
106
|
+
export declare type AuditLogEventType = 'audit_log_event';
|
|
99
107
|
/**
|
|
100
108
|
* ULID of event (https://github.com/ulid/spec)
|
|
101
109
|
*
|
|
102
|
-
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
110
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
111
|
+
* `definition` "identity".
|
|
103
112
|
*
|
|
104
|
-
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
113
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
114
|
+
* `definition` "id".
|
|
105
115
|
*/
|
|
106
|
-
export type AuditLogEventIdentity = string;
|
|
116
|
+
export declare type AuditLogEventIdentity = string;
|
|
107
117
|
/**
|
|
108
118
|
* JSON API type field
|
|
109
119
|
*
|
|
110
120
|
* This interface was referenced by `Account`'s JSON-Schema via the `definition` "type".
|
|
111
121
|
*/
|
|
112
|
-
export type AccountType = 'account';
|
|
122
|
+
export declare type AccountType = 'account';
|
|
113
123
|
/**
|
|
114
124
|
* ID of account
|
|
115
125
|
*
|
|
116
|
-
* This interface was referenced by `Account`'s JSON-Schema via the `definition`
|
|
126
|
+
* This interface was referenced by `Account`'s JSON-Schema via the `definition`
|
|
127
|
+
* "identity".
|
|
117
128
|
*
|
|
118
129
|
* This interface was referenced by `Account`'s JSON-Schema via the `definition` "id".
|
|
119
130
|
*/
|
|
120
|
-
export type AccountIdentity = string;
|
|
131
|
+
export declare type AccountIdentity = string;
|
|
121
132
|
/**
|
|
122
133
|
* JSON API type field
|
|
123
134
|
*
|
|
124
135
|
* This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "type".
|
|
125
136
|
*/
|
|
126
|
-
export type SitePlanType = 'site_plan';
|
|
137
|
+
export declare type SitePlanType = 'site_plan';
|
|
127
138
|
/**
|
|
128
139
|
* ID of plan
|
|
129
140
|
*
|
|
130
|
-
* This interface was referenced by `SitePlan`'s JSON-Schema via the
|
|
141
|
+
* This interface was referenced by `SitePlan`'s JSON-Schema via the
|
|
142
|
+
* `definition` "identity".
|
|
131
143
|
*
|
|
132
144
|
* This interface was referenced by `SitePlan`'s JSON-Schema via the `definition` "id".
|
|
133
145
|
*/
|
|
134
|
-
export type SitePlanIdentity = string;
|
|
146
|
+
export declare type SitePlanIdentity = string;
|
|
135
147
|
/**
|
|
136
148
|
* JSON API type field
|
|
137
149
|
*
|
|
138
150
|
* This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "type".
|
|
139
151
|
*/
|
|
140
|
-
export type MenuItemType = 'menu_item';
|
|
152
|
+
export declare type MenuItemType = 'menu_item';
|
|
141
153
|
/**
|
|
142
154
|
* ID of menu item
|
|
143
155
|
*
|
|
144
|
-
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
156
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
157
|
+
* `definition` "identity".
|
|
145
158
|
*
|
|
146
159
|
* This interface was referenced by `MenuItem`'s JSON-Schema via the `definition` "id".
|
|
147
160
|
*/
|
|
148
|
-
export type MenuItemIdentity = string;
|
|
161
|
+
export declare type MenuItemIdentity = string;
|
|
149
162
|
/**
|
|
150
163
|
* JSON API type field
|
|
151
164
|
*
|
|
152
|
-
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
165
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
166
|
+
* `definition` "type".
|
|
167
|
+
*/
|
|
168
|
+
export declare type ItemTypeType = 'item_type';
|
|
169
|
+
/**
|
|
170
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
171
|
+
* `instances.hrefSchema` link.
|
|
153
172
|
*/
|
|
154
|
-
export type
|
|
155
|
-
/** This interface was referenced by `MenuItem`'s JSON-Schema via the `instances.hrefSchema` link. */
|
|
156
|
-
export type MenuItemInstancesHrefSchema = {
|
|
173
|
+
export declare type MenuItemInstancesHrefSchema = {
|
|
157
174
|
filter?: {
|
|
158
175
|
/** IDs to fetch, comma separated */
|
|
159
176
|
ids: string;
|
|
@@ -164,7 +181,7 @@ export type MenuItemInstancesHrefSchema = {
|
|
|
164
181
|
*
|
|
165
182
|
* This interface was referenced by `Item`'s JSON-Schema via the `definition` "type".
|
|
166
183
|
*/
|
|
167
|
-
export type ItemType = 'item';
|
|
184
|
+
export declare type ItemType = 'item';
|
|
168
185
|
/**
|
|
169
186
|
* ID of record
|
|
170
187
|
*
|
|
@@ -172,13 +189,13 @@ export type ItemType = 'item';
|
|
|
172
189
|
*
|
|
173
190
|
* This interface was referenced by `Item`'s JSON-Schema via the `definition` "id".
|
|
174
191
|
*/
|
|
175
|
-
export type ItemIdentity = string;
|
|
192
|
+
export declare type ItemIdentity = string;
|
|
176
193
|
/**
|
|
177
194
|
* JSON API type field
|
|
178
195
|
*
|
|
179
196
|
* This interface was referenced by `Field`'s JSON-Schema via the `definition` "type".
|
|
180
197
|
*/
|
|
181
|
-
export type FieldType = 'field';
|
|
198
|
+
export declare type FieldType = 'field';
|
|
182
199
|
/**
|
|
183
200
|
* ID of field
|
|
184
201
|
*
|
|
@@ -186,19 +203,19 @@ export type FieldType = 'field';
|
|
|
186
203
|
*
|
|
187
204
|
* This interface was referenced by `Field`'s JSON-Schema via the `definition` "id".
|
|
188
205
|
*/
|
|
189
|
-
export type FieldIdentity = string;
|
|
206
|
+
export declare type FieldIdentity = string;
|
|
190
207
|
/**
|
|
191
208
|
* JSON API type field
|
|
192
209
|
*
|
|
193
210
|
* This interface was referenced by `Workflow`'s JSON-Schema via the `definition` "type".
|
|
194
211
|
*/
|
|
195
|
-
export type WorkflowType = 'workflow';
|
|
212
|
+
export declare type WorkflowType = 'workflow';
|
|
196
213
|
/**
|
|
197
214
|
* JSON API type field
|
|
198
215
|
*
|
|
199
216
|
* This interface was referenced by `Job`'s JSON-Schema via the `definition` "type".
|
|
200
217
|
*/
|
|
201
|
-
export type TargetSchemaPropertiesDataType = 'job';
|
|
218
|
+
export declare type TargetSchemaPropertiesDataType = 'job';
|
|
202
219
|
/**
|
|
203
220
|
* ID of job
|
|
204
221
|
*
|
|
@@ -206,158 +223,174 @@ export type TargetSchemaPropertiesDataType = 'job';
|
|
|
206
223
|
*
|
|
207
224
|
* This interface was referenced by `Job`'s JSON-Schema via the `definition` "id".
|
|
208
225
|
*/
|
|
209
|
-
export type TargetSchemaPropertiesDataIdentity = string;
|
|
226
|
+
export declare type TargetSchemaPropertiesDataIdentity = string;
|
|
210
227
|
/**
|
|
211
228
|
* JSON API type fieldset
|
|
212
229
|
*
|
|
213
230
|
* This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "type".
|
|
214
231
|
*/
|
|
215
|
-
export type FieldsetType = 'fieldset';
|
|
232
|
+
export declare type FieldsetType = 'fieldset';
|
|
216
233
|
/**
|
|
217
234
|
* ID of fieldset
|
|
218
235
|
*
|
|
219
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
236
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
237
|
+
* `definition` "identity".
|
|
220
238
|
*
|
|
221
239
|
* This interface was referenced by `Fieldset`'s JSON-Schema via the `definition` "id".
|
|
222
240
|
*/
|
|
223
|
-
export type FieldsetIdentity = string;
|
|
241
|
+
export declare type FieldsetIdentity = string;
|
|
224
242
|
/**
|
|
225
243
|
* JSON API type field
|
|
226
244
|
*
|
|
227
245
|
* This interface was referenced by `Session`'s JSON-Schema via the `definition` "type".
|
|
228
246
|
*/
|
|
229
|
-
export type SessionType = 'session';
|
|
247
|
+
export declare type SessionType = 'session';
|
|
230
248
|
/**
|
|
231
249
|
* JSON web token for the session
|
|
232
250
|
*
|
|
233
|
-
* This interface was referenced by `Session`'s JSON-Schema via the `definition`
|
|
251
|
+
* This interface was referenced by `Session`'s JSON-Schema via the `definition`
|
|
252
|
+
* "identity".
|
|
234
253
|
*
|
|
235
254
|
* This interface was referenced by `Session`'s JSON-Schema via the `definition` "id".
|
|
236
255
|
*/
|
|
237
|
-
export type SessionIdentity = string;
|
|
256
|
+
export declare type SessionIdentity = string;
|
|
238
257
|
/**
|
|
239
258
|
* JSON API type field
|
|
240
259
|
*
|
|
241
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
260
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
261
|
+
* `definition` "type".
|
|
242
262
|
*/
|
|
243
|
-
export type AccessTokenType = 'access_token';
|
|
263
|
+
export declare type AccessTokenType = 'access_token';
|
|
244
264
|
/**
|
|
245
265
|
* ID of access_token
|
|
246
266
|
*
|
|
247
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
267
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
268
|
+
* `definition` "identity".
|
|
248
269
|
*
|
|
249
270
|
* This interface was referenced by `AccessToken`'s JSON-Schema via the `definition` "id".
|
|
250
271
|
*/
|
|
251
|
-
export type AccessTokenIdentity = string;
|
|
272
|
+
export declare type AccessTokenIdentity = string;
|
|
252
273
|
/**
|
|
253
274
|
* JSON API type field
|
|
254
275
|
*
|
|
255
276
|
* This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "type".
|
|
256
277
|
*/
|
|
257
|
-
export type PluginType = 'plugin';
|
|
278
|
+
export declare type PluginType = 'plugin';
|
|
258
279
|
/**
|
|
259
280
|
* ID of plugin
|
|
260
281
|
*
|
|
261
|
-
* This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
|
|
282
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
|
|
283
|
+
* "identity".
|
|
262
284
|
*
|
|
263
285
|
* This interface was referenced by `Plugin`'s JSON-Schema via the `definition` "id".
|
|
264
286
|
*/
|
|
265
|
-
export type PluginIdentity = string;
|
|
287
|
+
export declare type PluginIdentity = string;
|
|
266
288
|
/**
|
|
267
289
|
* JSON API type field
|
|
268
290
|
*
|
|
269
291
|
* This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "type".
|
|
270
292
|
*/
|
|
271
|
-
export type JobResultType = 'job_result';
|
|
293
|
+
export declare type JobResultType = 'job_result';
|
|
272
294
|
/**
|
|
273
295
|
* ID of job result
|
|
274
296
|
*
|
|
275
|
-
* This interface was referenced by `JobResult`'s JSON-Schema via the
|
|
297
|
+
* This interface was referenced by `JobResult`'s JSON-Schema via the
|
|
298
|
+
* `definition` "identity".
|
|
276
299
|
*
|
|
277
300
|
* This interface was referenced by `JobResult`'s JSON-Schema via the `definition` "id".
|
|
278
301
|
*/
|
|
279
|
-
export type JobResultIdentity = string;
|
|
302
|
+
export declare type JobResultIdentity = string;
|
|
280
303
|
/**
|
|
281
304
|
* JSON API type field
|
|
282
305
|
*
|
|
283
|
-
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
306
|
+
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
307
|
+
* `definition` "type".
|
|
284
308
|
*/
|
|
285
|
-
export type SubscriptionLimitType = 'subscription_limit';
|
|
309
|
+
export declare type SubscriptionLimitType = 'subscription_limit';
|
|
286
310
|
/**
|
|
287
311
|
* ID of limit
|
|
288
312
|
*
|
|
289
313
|
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
290
314
|
* `definition` "identity".
|
|
291
315
|
*
|
|
292
|
-
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
316
|
+
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
317
|
+
* `definition` "id".
|
|
293
318
|
*/
|
|
294
|
-
export type SubscriptionLimitIdentity = string;
|
|
319
|
+
export declare type SubscriptionLimitIdentity = string;
|
|
295
320
|
/**
|
|
296
321
|
* JSON API type field
|
|
297
322
|
*
|
|
298
323
|
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
299
324
|
* `definition` "type".
|
|
300
325
|
*/
|
|
301
|
-
export type SubscriptionFeatureType = 'subscription_feature';
|
|
326
|
+
export declare type SubscriptionFeatureType = 'subscription_feature';
|
|
302
327
|
/**
|
|
303
328
|
* ID of feature
|
|
304
329
|
*
|
|
305
330
|
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
306
331
|
* `definition` "identity".
|
|
307
332
|
*
|
|
308
|
-
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
333
|
+
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
334
|
+
* `definition` "id".
|
|
309
335
|
*/
|
|
310
|
-
export type SubscriptionFeatureIdentity = string;
|
|
336
|
+
export declare type SubscriptionFeatureIdentity = string;
|
|
311
337
|
/**
|
|
312
338
|
* JSON API type field
|
|
313
339
|
*
|
|
314
|
-
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
340
|
+
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
341
|
+
* `definition` "type".
|
|
315
342
|
*/
|
|
316
|
-
export type BuildEventType = 'build_event';
|
|
343
|
+
export declare type BuildEventType = 'build_event';
|
|
317
344
|
/**
|
|
318
345
|
* ID of menu item
|
|
319
346
|
*
|
|
320
|
-
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
347
|
+
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
348
|
+
* `definition` "identity".
|
|
321
349
|
*
|
|
322
350
|
* This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition` "id".
|
|
323
351
|
*/
|
|
324
|
-
export type BuildEventIdentity = string;
|
|
352
|
+
export declare type BuildEventIdentity = string;
|
|
325
353
|
/**
|
|
326
354
|
* JSON API type field
|
|
327
355
|
*
|
|
328
|
-
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
356
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
357
|
+
* `definition` "type".
|
|
329
358
|
*/
|
|
330
|
-
export type BuildTriggerType = 'build_trigger';
|
|
331
|
-
/**
|
|
332
|
-
|
|
359
|
+
export declare type BuildTriggerType = 'build_trigger';
|
|
360
|
+
/**
|
|
361
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
362
|
+
* `instances.hrefSchema` link.
|
|
363
|
+
*/
|
|
364
|
+
export declare type ItemInstancesHrefSchema = {
|
|
333
365
|
/**
|
|
334
|
-
* For Modular Content fields and Structured Text fields. If set, returns full
|
|
335
|
-
* for nested blocks instead of IDs
|
|
366
|
+
* For Modular Content fields and Structured Text fields. If set, returns full
|
|
367
|
+
* payload for nested blocks instead of IDs
|
|
336
368
|
*/
|
|
337
369
|
nested?: string;
|
|
338
370
|
/** Attributes to filter records */
|
|
339
371
|
filter?: {
|
|
340
372
|
/**
|
|
341
|
-
* Record (or block record) IDs to fetch, comma separated. If you use this
|
|
342
|
-
* you *must not* use `filter[type]` or `filter[fields]`
|
|
373
|
+
* Record (or block record) IDs to fetch, comma separated. If you use this
|
|
374
|
+
* filter, you *must not* use `filter[type]` or `filter[fields]`
|
|
343
375
|
*/
|
|
344
376
|
ids?: string;
|
|
345
377
|
/**
|
|
346
|
-
* Model ID or `api_key` to filter. If you use this filter, you *must not*
|
|
347
|
-
* `filter[ids]`. Comma separated values are accepted, but you *must
|
|
348
|
-
* `filter[fields]` in this case
|
|
378
|
+
* Model ID or `api_key` to filter. If you use this filter, you *must not*
|
|
379
|
+
* use `filter[ids]`. Comma separated values are accepted, but you *must
|
|
380
|
+
* not* use `filter[fields]` in this case
|
|
349
381
|
*/
|
|
350
382
|
type?: string;
|
|
351
383
|
/**
|
|
352
|
-
* Textual query to match. You *must not* use `filter[ids]`. If `locale` is
|
|
353
|
-
* search within that locale. Otherwise environment's main locale
|
|
384
|
+
* Textual query to match. You *must not* use `filter[ids]`. If `locale` is
|
|
385
|
+
* defined, search within that locale. Otherwise environment's main locale
|
|
386
|
+
* will be used.
|
|
354
387
|
*/
|
|
355
388
|
query?: string;
|
|
356
389
|
/**
|
|
357
390
|
* Same as [GraphQL API records
|
|
358
|
-
* filters](/docs/content-delivery-api/filtering-records). Use snake_case
|
|
359
|
-
* names. If `locale` is defined, search within that locale.
|
|
360
|
-
* main locale will be used.
|
|
391
|
+
* filters](/docs/content-delivery-api/filtering-records). Use snake_case
|
|
392
|
+
* for fields names. If `locale` is defined, search within that locale.
|
|
393
|
+
* Otherwise environment's main locale will be used.
|
|
361
394
|
*/
|
|
362
395
|
fields?: {
|
|
363
396
|
[k: string]: unknown;
|
|
@@ -365,8 +398,8 @@ export type ItemInstancesHrefSchema = {
|
|
|
365
398
|
[k: string]: unknown;
|
|
366
399
|
};
|
|
367
400
|
/**
|
|
368
|
-
* When `filter[query]` or `field[fields]` is defined, filter by this locale.
|
|
369
|
-
* environment's main locale
|
|
401
|
+
* When `filter[query]` or `field[fields]` is defined, filter by this locale.
|
|
402
|
+
* Default: environment's main locale
|
|
370
403
|
*/
|
|
371
404
|
locale?: string;
|
|
372
405
|
/** Attributes to manage results pagination */
|
|
@@ -378,69 +411,87 @@ export type ItemInstancesHrefSchema = {
|
|
|
378
411
|
[k: string]: unknown;
|
|
379
412
|
};
|
|
380
413
|
/**
|
|
381
|
-
* Fields used to order results. You *must* specify also `filter[type]` with
|
|
382
|
-
* element only to be able use this option. Format:
|
|
414
|
+
* Fields used to order results. You *must* specify also `filter[type]` with
|
|
415
|
+
* one element only to be able use this option. Format:
|
|
383
416
|
* `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
|
|
384
417
|
*/
|
|
385
418
|
order_by?: string;
|
|
386
419
|
/**
|
|
387
|
-
* Whether you want the currently published versions (`published`, default) of
|
|
388
|
-
* records, or the latest available (`current`)
|
|
420
|
+
* Whether you want the currently published versions (`published`, default) of
|
|
421
|
+
* your records, or the latest available (`current`)
|
|
389
422
|
*/
|
|
390
423
|
version?: string;
|
|
391
424
|
[k: string]: unknown;
|
|
392
425
|
};
|
|
393
|
-
/**
|
|
394
|
-
|
|
426
|
+
/**
|
|
427
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
428
|
+
* `references.hrefSchema` link.
|
|
429
|
+
*/
|
|
430
|
+
export declare type ItemReferencesHrefSchema = {
|
|
395
431
|
/**
|
|
396
|
-
* For Modular Content fields and Structured Text fields, return full payload
|
|
397
|
-
* nested blocks instead of IDs
|
|
432
|
+
* For Modular Content fields and Structured Text fields, return full payload
|
|
433
|
+
* for nested blocks instead of IDs
|
|
398
434
|
*/
|
|
399
435
|
nested?: 'true';
|
|
400
436
|
/**
|
|
401
|
-
* Retrieve only the selected type of version that is linked to the record;
|
|
402
|
-
* published or both
|
|
437
|
+
* Retrieve only the selected type of version that is linked to the record;
|
|
438
|
+
* current, published or both
|
|
403
439
|
*/
|
|
404
440
|
version?: null | ('current' | 'published' | 'published-or-current');
|
|
405
441
|
[k: string]: unknown;
|
|
406
442
|
};
|
|
407
443
|
/** This interface was referenced by `Item`'s JSON-Schema via the `self.hrefSchema` link. */
|
|
408
|
-
export type ItemSelfHrefSchema = {
|
|
444
|
+
export declare type ItemSelfHrefSchema = {
|
|
409
445
|
/**
|
|
410
|
-
* For Modular Content fields and Structured Text fields. If set, returns full
|
|
411
|
-
* for nested blocks instead of IDs
|
|
446
|
+
* For Modular Content fields and Structured Text fields. If set, returns full
|
|
447
|
+
* payload for nested blocks instead of IDs
|
|
412
448
|
*/
|
|
413
449
|
nested?: string;
|
|
414
450
|
/**
|
|
415
|
-
* Whether you want the currently published versions (`published`, default) of
|
|
416
|
-
* records, or the latest available (`current`)
|
|
451
|
+
* Whether you want the currently published versions (`published`, default) of
|
|
452
|
+
* your records, or the latest available (`current`)
|
|
417
453
|
*/
|
|
418
454
|
version?: string;
|
|
419
455
|
[k: string]: unknown;
|
|
420
456
|
};
|
|
421
|
-
/**
|
|
422
|
-
|
|
457
|
+
/**
|
|
458
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
459
|
+
* `batch_destroy.hrefSchema` link.
|
|
460
|
+
*/
|
|
461
|
+
export declare type ItemBatchDestroyHrefSchema = {
|
|
423
462
|
/** IDs of records to delete, comma separated */
|
|
424
463
|
'filter[ids]': string;
|
|
425
464
|
};
|
|
426
|
-
/**
|
|
427
|
-
|
|
465
|
+
/**
|
|
466
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
467
|
+
* `batch_publish.hrefSchema` link.
|
|
468
|
+
*/
|
|
469
|
+
export declare type ItemBatchPublishHrefSchema = {
|
|
428
470
|
/** IDs of records to publish, comma separated */
|
|
429
471
|
'filter[ids]': string;
|
|
430
472
|
};
|
|
431
|
-
/**
|
|
432
|
-
|
|
473
|
+
/**
|
|
474
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
475
|
+
* `batch_unpublish.hrefSchema` link.
|
|
476
|
+
*/
|
|
477
|
+
export declare type ItemBatchUnpublishHrefSchema = {
|
|
433
478
|
/** IDs of records to unpublish, comma separated */
|
|
434
479
|
'filter[ids]': string;
|
|
435
480
|
};
|
|
436
|
-
/**
|
|
437
|
-
|
|
481
|
+
/**
|
|
482
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
483
|
+
* `publish.hrefSchema` link.
|
|
484
|
+
*/
|
|
485
|
+
export declare type ItemPublishHrefSchema = {
|
|
438
486
|
/** If the record references other draft records, force a recursive publication */
|
|
439
487
|
recursive?: string;
|
|
440
488
|
[k: string]: unknown;
|
|
441
489
|
};
|
|
442
|
-
/**
|
|
443
|
-
|
|
490
|
+
/**
|
|
491
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
492
|
+
* `unpublish.hrefSchema` link.
|
|
493
|
+
*/
|
|
494
|
+
export declare type ItemUnpublishHrefSchema = {
|
|
444
495
|
/** If the record is referenced by other published records, unpublish them recursively */
|
|
445
496
|
recursive?: string;
|
|
446
497
|
[k: string]: unknown;
|
|
@@ -448,47 +499,53 @@ export type ItemUnpublishHrefSchema = {
|
|
|
448
499
|
/**
|
|
449
500
|
* JSON API type field
|
|
450
501
|
*
|
|
451
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
502
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
503
|
+
* `definition` "type".
|
|
452
504
|
*/
|
|
453
|
-
export type ItemVersionType = 'item_version';
|
|
505
|
+
export declare type ItemVersionType = 'item_version';
|
|
454
506
|
/**
|
|
455
507
|
* ID of record version
|
|
456
508
|
*
|
|
457
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
509
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
510
|
+
* `definition` "identity".
|
|
458
511
|
*
|
|
459
512
|
* This interface was referenced by `ItemVersion`'s JSON-Schema via the `definition` "id".
|
|
460
513
|
*/
|
|
461
|
-
export type ItemVersionIdentity = string;
|
|
514
|
+
export declare type ItemVersionIdentity = string;
|
|
462
515
|
/**
|
|
463
516
|
* JSON API type upload
|
|
464
517
|
*
|
|
465
518
|
* This interface was referenced by `Upload`'s JSON-Schema via the `definition` "type".
|
|
466
519
|
*/
|
|
467
|
-
export type UploadType = 'upload';
|
|
520
|
+
export declare type UploadType = 'upload';
|
|
468
521
|
/**
|
|
469
522
|
* ID of upload
|
|
470
523
|
*
|
|
471
|
-
* This interface was referenced by `Upload`'s JSON-Schema via the `definition`
|
|
524
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the `definition`
|
|
525
|
+
* "identity".
|
|
472
526
|
*
|
|
473
527
|
* This interface was referenced by `Upload`'s JSON-Schema via the `definition` "id".
|
|
474
528
|
*/
|
|
475
|
-
export type UploadIdentity = string;
|
|
476
|
-
/**
|
|
477
|
-
|
|
529
|
+
export declare type UploadIdentity = string;
|
|
530
|
+
/**
|
|
531
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
532
|
+
* `instances.hrefSchema` link.
|
|
533
|
+
*/
|
|
534
|
+
export declare type UploadInstancesHrefSchema = {
|
|
478
535
|
/** Attributes to filter uploads */
|
|
479
536
|
filter?: {
|
|
480
537
|
/** IDs to fetch, comma separated */
|
|
481
538
|
ids?: string;
|
|
482
539
|
/**
|
|
483
|
-
* Textual query to match. If `locale` is defined, search within that
|
|
484
|
-
* Otherwise environment's main locale will be used.
|
|
540
|
+
* Textual query to match. If `locale` is defined, search within that
|
|
541
|
+
* locale. Otherwise environment's main locale will be used.
|
|
485
542
|
*/
|
|
486
543
|
query?: string;
|
|
487
544
|
/**
|
|
488
545
|
* Same as [GraphQL API uploads
|
|
489
|
-
* filters](/docs/content-delivery-api/filtering-uploads). Use snake_case
|
|
490
|
-
* names. If `locale` is defined, search within that locale.
|
|
491
|
-
* main locale will be used.
|
|
546
|
+
* filters](/docs/content-delivery-api/filtering-uploads). Use snake_case
|
|
547
|
+
* for fields names. If `locale` is defined, search within that locale.
|
|
548
|
+
* Otherwise environment's main locale will be used.
|
|
492
549
|
*/
|
|
493
550
|
fields?: {
|
|
494
551
|
[k: string]: unknown;
|
|
@@ -496,13 +553,13 @@ export type UploadInstancesHrefSchema = {
|
|
|
496
553
|
[k: string]: unknown;
|
|
497
554
|
};
|
|
498
555
|
/**
|
|
499
|
-
* When `filter[query]` or `field[fields]` is defined, filter by this locale.
|
|
500
|
-
* environment's main locale
|
|
556
|
+
* When `filter[query]` or `field[fields]` is defined, filter by this locale.
|
|
557
|
+
* Default: environment's main locale
|
|
501
558
|
*/
|
|
502
559
|
locale?: string;
|
|
503
560
|
/**
|
|
504
|
-
* Fields used to order results. Format: `<field_name>_<DIRECTION(ASC|DESC)>`.
|
|
505
|
-
* pass multiple comma separated rules.
|
|
561
|
+
* Fields used to order results. Format: `<field_name>_<DIRECTION(ASC|DESC)>`.
|
|
562
|
+
* You can pass multiple comma separated rules.
|
|
506
563
|
*/
|
|
507
564
|
order_by?: string;
|
|
508
565
|
/** Attributes to manage results pagination */
|
|
@@ -519,27 +576,33 @@ export type UploadInstancesHrefSchema = {
|
|
|
519
576
|
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
520
577
|
* `batch_add_tags.hrefSchema` link.
|
|
521
578
|
*/
|
|
522
|
-
export type UploadBatchAddTagsHrefSchema = {
|
|
579
|
+
export declare type UploadBatchAddTagsHrefSchema = {
|
|
523
580
|
/** IDs to tag, comma separated */
|
|
524
581
|
'filter[ids]'?: string;
|
|
525
582
|
[k: string]: unknown;
|
|
526
583
|
};
|
|
527
|
-
/**
|
|
528
|
-
|
|
584
|
+
/**
|
|
585
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
586
|
+
* `batch_destroy.hrefSchema` link.
|
|
587
|
+
*/
|
|
588
|
+
export declare type UploadBatchDestroyHrefSchema = {
|
|
529
589
|
/** IDs to destroy, comma separated */
|
|
530
590
|
'filter[ids]'?: string;
|
|
531
591
|
[k: string]: unknown;
|
|
532
592
|
};
|
|
533
|
-
/**
|
|
534
|
-
|
|
593
|
+
/**
|
|
594
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
595
|
+
* `references.hrefSchema` link.
|
|
596
|
+
*/
|
|
597
|
+
export declare type UploadReferencesHrefSchema = {
|
|
535
598
|
/**
|
|
536
|
-
* For Modular Content fields and Structured Text fields, return full payload
|
|
537
|
-
* nested blocks instead of IDs
|
|
599
|
+
* For Modular Content fields and Structured Text fields, return full payload
|
|
600
|
+
* for nested blocks instead of IDs
|
|
538
601
|
*/
|
|
539
602
|
nested?: string;
|
|
540
603
|
/**
|
|
541
|
-
* Retrieve only the selected type of version that is linked to the upload;
|
|
542
|
-
* published or both
|
|
604
|
+
* Retrieve only the selected type of version that is linked to the upload;
|
|
605
|
+
* current, published or both
|
|
543
606
|
*/
|
|
544
607
|
version?: null | ('current' | 'published' | 'published-or-current');
|
|
545
608
|
[k: string]: unknown;
|
|
@@ -547,69 +610,76 @@ export type UploadReferencesHrefSchema = {
|
|
|
547
610
|
/**
|
|
548
611
|
* JSON API type field
|
|
549
612
|
*
|
|
550
|
-
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
613
|
+
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
614
|
+
* `definition` "type".
|
|
551
615
|
*/
|
|
552
|
-
export type UploadRequestType = 'upload_request';
|
|
616
|
+
export declare type UploadRequestType = 'upload_request';
|
|
553
617
|
/**
|
|
554
618
|
* The S3 path where the file will be stored
|
|
555
619
|
*
|
|
556
|
-
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
620
|
+
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
621
|
+
* `definition` "identity".
|
|
557
622
|
*
|
|
558
|
-
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
623
|
+
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
624
|
+
* `definition` "id".
|
|
559
625
|
*/
|
|
560
|
-
export type UploadRequestIdentity = string;
|
|
626
|
+
export declare type UploadRequestIdentity = string;
|
|
561
627
|
/**
|
|
562
628
|
* JSON API type field
|
|
563
629
|
*
|
|
564
630
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema via the
|
|
565
631
|
* `definition` "type".
|
|
566
632
|
*/
|
|
567
|
-
export type ScheduledPublicationType = 'scheduled_publication';
|
|
633
|
+
export declare type ScheduledPublicationType = 'scheduled_publication';
|
|
568
634
|
/**
|
|
569
635
|
* ID of scheduled_publication
|
|
570
636
|
*
|
|
571
637
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema via the
|
|
572
638
|
* `definition` "identity".
|
|
573
639
|
*
|
|
574
|
-
* This interface was referenced by `ScheduledPublication`'s JSON-Schema via the
|
|
640
|
+
* This interface was referenced by `ScheduledPublication`'s JSON-Schema via the
|
|
641
|
+
* `definition` "id".
|
|
575
642
|
*/
|
|
576
|
-
export type ScheduledPublicationIdentity = string;
|
|
643
|
+
export declare type ScheduledPublicationIdentity = string;
|
|
577
644
|
/**
|
|
578
645
|
* JSON API type field
|
|
579
646
|
*
|
|
580
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
581
|
-
* `definition` "type".
|
|
647
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
648
|
+
* the `definition` "type".
|
|
582
649
|
*/
|
|
583
|
-
export type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
650
|
+
export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
584
651
|
/**
|
|
585
652
|
* ID of scheduled_unpublishing
|
|
586
653
|
*
|
|
587
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
588
|
-
* `definition` "identity".
|
|
654
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
655
|
+
* the `definition` "identity".
|
|
589
656
|
*
|
|
590
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
591
|
-
* `definition` "id".
|
|
657
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
658
|
+
* the `definition` "id".
|
|
592
659
|
*/
|
|
593
|
-
export type ScheduledUnpublishingIdentity = string;
|
|
660
|
+
export declare type ScheduledUnpublishingIdentity = string;
|
|
594
661
|
/**
|
|
595
662
|
* JSON API type field
|
|
596
663
|
*
|
|
597
|
-
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
664
|
+
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
665
|
+
* `definition` "type".
|
|
598
666
|
*/
|
|
599
|
-
export type SearchResultType = 'search_result';
|
|
667
|
+
export declare type SearchResultType = 'search_result';
|
|
600
668
|
/**
|
|
601
669
|
* ID of result
|
|
602
670
|
*
|
|
603
|
-
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
671
|
+
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
672
|
+
* `definition` "identity".
|
|
604
673
|
*
|
|
605
|
-
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
674
|
+
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
675
|
+
* `definition` "id".
|
|
606
676
|
*/
|
|
607
|
-
export type SearchResultIdentity = string;
|
|
677
|
+
export declare type SearchResultIdentity = string;
|
|
608
678
|
/**
|
|
609
679
|
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
610
680
|
* `instances.hrefSchema` link.
|
|
611
681
|
*/
|
|
612
|
-
export type SearchResultInstancesHrefSchema = {
|
|
682
|
+
export declare type SearchResultInstancesHrefSchema = {
|
|
613
683
|
/** The query string to search */
|
|
614
684
|
q: string;
|
|
615
685
|
/** The build trigger ID on which the search will be performed */
|
|
@@ -625,29 +695,32 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
625
695
|
/**
|
|
626
696
|
* JSON API type field
|
|
627
697
|
*
|
|
628
|
-
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
698
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
699
|
+
* `definition` "type".
|
|
629
700
|
*/
|
|
630
|
-
export type EnvironmentType = 'environment';
|
|
701
|
+
export declare type EnvironmentType = 'environment';
|
|
631
702
|
/**
|
|
632
703
|
* JSON API type field
|
|
633
704
|
*
|
|
634
|
-
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
705
|
+
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
706
|
+
* `definition` "type".
|
|
635
707
|
*/
|
|
636
|
-
export type MaintenanceModeType = 'maintenance_mode';
|
|
708
|
+
export declare type MaintenanceModeType = 'maintenance_mode';
|
|
637
709
|
/**
|
|
638
710
|
* ID of maintenance_mode
|
|
639
711
|
*
|
|
640
|
-
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
641
|
-
* "identity".
|
|
712
|
+
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
713
|
+
* `definition` "identity".
|
|
642
714
|
*
|
|
643
|
-
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
715
|
+
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
716
|
+
* `definition` "id".
|
|
644
717
|
*/
|
|
645
|
-
export type MaintenanceModeIdentity = string;
|
|
718
|
+
export declare type MaintenanceModeIdentity = string;
|
|
646
719
|
/**
|
|
647
720
|
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
648
721
|
* `activate.hrefSchema` link.
|
|
649
722
|
*/
|
|
650
|
-
export type MaintenanceModeActivateHrefSchema = {
|
|
723
|
+
export declare type MaintenanceModeActivateHrefSchema = {
|
|
651
724
|
/** Force the activation, even if there are collaborators editing some records. */
|
|
652
725
|
force?: boolean;
|
|
653
726
|
[k: string]: unknown;
|
|
@@ -657,156 +730,182 @@ export type MaintenanceModeActivateHrefSchema = {
|
|
|
657
730
|
*
|
|
658
731
|
* This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "type".
|
|
659
732
|
*/
|
|
660
|
-
export type WebhookType = 'webhook';
|
|
733
|
+
export declare type WebhookType = 'webhook';
|
|
661
734
|
/**
|
|
662
735
|
* ID of webhook
|
|
663
736
|
*
|
|
664
|
-
* This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
|
|
737
|
+
* This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
|
|
738
|
+
* "identity".
|
|
665
739
|
*
|
|
666
740
|
* This interface was referenced by `Webhook`'s JSON-Schema via the `definition` "id".
|
|
667
741
|
*/
|
|
668
|
-
export type WebhookIdentity = string;
|
|
742
|
+
export declare type WebhookIdentity = string;
|
|
669
743
|
/**
|
|
670
744
|
* JSON API type field
|
|
671
745
|
*
|
|
672
|
-
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
746
|
+
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
747
|
+
* `definition` "type".
|
|
673
748
|
*/
|
|
674
|
-
export type WebhookCallType = 'webhook_call';
|
|
749
|
+
export declare type WebhookCallType = 'webhook_call';
|
|
675
750
|
/**
|
|
676
751
|
* ID of webhook call
|
|
677
752
|
*
|
|
678
|
-
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
753
|
+
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
754
|
+
* `definition` "identity".
|
|
679
755
|
*
|
|
680
756
|
* This interface was referenced by `WebhookCall`'s JSON-Schema via the `definition` "id".
|
|
681
757
|
*/
|
|
682
|
-
export type WebhookCallIdentity = string;
|
|
758
|
+
export declare type WebhookCallIdentity = string;
|
|
683
759
|
/**
|
|
684
760
|
* JSON API type field
|
|
685
761
|
*
|
|
686
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
762
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
763
|
+
* `definition` "type".
|
|
687
764
|
*/
|
|
688
|
-
export type ItemTypeFilterType = 'item_type_filter';
|
|
765
|
+
export declare type ItemTypeFilterType = 'item_type_filter';
|
|
689
766
|
/**
|
|
690
767
|
* ID of filter
|
|
691
768
|
*
|
|
692
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
769
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
770
|
+
* `definition` "identity".
|
|
693
771
|
*
|
|
694
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
772
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
773
|
+
* `definition` "id".
|
|
695
774
|
*/
|
|
696
|
-
export type ItemTypeFilterIdentity = string;
|
|
775
|
+
export declare type ItemTypeFilterIdentity = string;
|
|
697
776
|
/**
|
|
698
777
|
* JSON API type field
|
|
699
778
|
*
|
|
700
|
-
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
779
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
780
|
+
* `definition` "type".
|
|
701
781
|
*/
|
|
702
|
-
export type UploadFilterType = 'upload_filter';
|
|
782
|
+
export declare type UploadFilterType = 'upload_filter';
|
|
703
783
|
/**
|
|
704
784
|
* ID of filter
|
|
705
785
|
*
|
|
706
|
-
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
786
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
787
|
+
* `definition` "identity".
|
|
707
788
|
*
|
|
708
|
-
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
789
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
790
|
+
* `definition` "id".
|
|
709
791
|
*/
|
|
710
|
-
export type UploadFilterIdentity = string;
|
|
792
|
+
export declare type UploadFilterIdentity = string;
|
|
711
793
|
/**
|
|
712
794
|
* JSON API type field
|
|
713
795
|
*
|
|
714
|
-
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
796
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
797
|
+
* `definition` "type".
|
|
715
798
|
*/
|
|
716
|
-
export type SiteInvitationType = 'site_invitation';
|
|
799
|
+
export declare type SiteInvitationType = 'site_invitation';
|
|
717
800
|
/**
|
|
718
801
|
* ID of invitation
|
|
719
802
|
*
|
|
720
|
-
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
803
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
804
|
+
* `definition` "identity".
|
|
721
805
|
*
|
|
722
|
-
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
806
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
807
|
+
* `definition` "id".
|
|
723
808
|
*/
|
|
724
|
-
export type SiteInvitationIdentity = string;
|
|
809
|
+
export declare type SiteInvitationIdentity = string;
|
|
725
810
|
/**
|
|
726
811
|
* JSON API type field
|
|
727
812
|
*
|
|
728
|
-
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
813
|
+
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
814
|
+
* `definition` "type".
|
|
729
815
|
*/
|
|
730
|
-
export type EditingSessionType = 'editing_session';
|
|
816
|
+
export declare type EditingSessionType = 'editing_session';
|
|
731
817
|
/**
|
|
732
818
|
* UUID of presence
|
|
733
819
|
*
|
|
734
|
-
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
820
|
+
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
821
|
+
* `definition` "identity".
|
|
735
822
|
*
|
|
736
|
-
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
823
|
+
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
824
|
+
* `definition` "id".
|
|
737
825
|
*/
|
|
738
|
-
export type EditingSessionIdentity = string;
|
|
826
|
+
export declare type EditingSessionIdentity = string;
|
|
739
827
|
/**
|
|
740
828
|
* JSON API type field
|
|
741
829
|
*
|
|
742
|
-
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
830
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
831
|
+
* `definition` "type".
|
|
743
832
|
*/
|
|
744
|
-
export type SsoSettingsType = 'sso_settings';
|
|
833
|
+
export declare type SsoSettingsType = 'sso_settings';
|
|
745
834
|
/**
|
|
746
835
|
* ID
|
|
747
836
|
*
|
|
748
|
-
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
837
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
838
|
+
* `definition` "identity".
|
|
749
839
|
*
|
|
750
840
|
* This interface was referenced by `SsoSettings`'s JSON-Schema via the `definition` "id".
|
|
751
841
|
*/
|
|
752
|
-
export type SsoSettingsIdentity = string;
|
|
842
|
+
export declare type SsoSettingsIdentity = string;
|
|
753
843
|
/**
|
|
754
844
|
* JSON API type field
|
|
755
845
|
*
|
|
756
|
-
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
846
|
+
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
847
|
+
* `definition` "type".
|
|
757
848
|
*/
|
|
758
|
-
export type WhiteLabelSettingsType = 'white_label_settings';
|
|
849
|
+
export declare type WhiteLabelSettingsType = 'white_label_settings';
|
|
759
850
|
/**
|
|
760
851
|
* ID
|
|
761
852
|
*
|
|
762
853
|
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
763
854
|
* `definition` "identity".
|
|
764
855
|
*
|
|
765
|
-
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
856
|
+
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
857
|
+
* `definition` "id".
|
|
766
858
|
*/
|
|
767
|
-
export type WhiteLabelSettingsIdentity = string;
|
|
859
|
+
export declare type WhiteLabelSettingsIdentity = string;
|
|
768
860
|
/**
|
|
769
861
|
* JSON API type field
|
|
770
862
|
*
|
|
771
|
-
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
863
|
+
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
864
|
+
* `definition` "type".
|
|
772
865
|
*/
|
|
773
|
-
export type PublicInfoType = 'public_info';
|
|
866
|
+
export declare type PublicInfoType = 'public_info';
|
|
774
867
|
/**
|
|
775
868
|
* ID of site
|
|
776
869
|
*
|
|
777
|
-
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
870
|
+
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
871
|
+
* `definition` "identity".
|
|
778
872
|
*
|
|
779
873
|
* This interface was referenced by `PublicInfo`'s JSON-Schema via the `definition` "id".
|
|
780
874
|
*/
|
|
781
|
-
export type PublicInfoIdentity = string;
|
|
875
|
+
export declare type PublicInfoIdentity = string;
|
|
782
876
|
/**
|
|
783
877
|
* JSON API type field
|
|
784
878
|
*
|
|
785
|
-
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
879
|
+
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
880
|
+
* `definition` "type".
|
|
786
881
|
*/
|
|
787
|
-
export type DailyUsageType = 'daily_usage';
|
|
882
|
+
export declare type DailyUsageType = 'daily_usage';
|
|
788
883
|
/**
|
|
789
884
|
* ID of site
|
|
790
885
|
*
|
|
791
|
-
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
886
|
+
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
887
|
+
* `definition` "identity".
|
|
792
888
|
*
|
|
793
889
|
* This interface was referenced by `DailyUsage`'s JSON-Schema via the `definition` "id".
|
|
794
890
|
*/
|
|
795
|
-
export type DailyUsageIdentity = string;
|
|
891
|
+
export declare type DailyUsageIdentity = string;
|
|
796
892
|
/**
|
|
797
893
|
* JSON API type field
|
|
798
894
|
*
|
|
799
|
-
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
895
|
+
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
896
|
+
* `definition` "type".
|
|
800
897
|
*/
|
|
801
|
-
export type UsageCounterType = 'usage_counter';
|
|
898
|
+
export declare type UsageCounterType = 'usage_counter';
|
|
802
899
|
/**
|
|
803
900
|
* Name of the counter
|
|
804
901
|
*
|
|
805
|
-
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
902
|
+
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
903
|
+
* `definition` "identity".
|
|
806
904
|
*
|
|
807
|
-
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
905
|
+
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
906
|
+
* `definition` "id".
|
|
808
907
|
*/
|
|
809
|
-
export type UsageCounterIdentity =
|
|
908
|
+
export declare type UsageCounterIdentity =
|
|
810
909
|
| 'assets_path_bytes'
|
|
811
910
|
| 'assets_referrer_bytes'
|
|
812
911
|
| 'assets_ip_bytes'
|
|
@@ -823,8 +922,11 @@ export type UsageCounterIdentity =
|
|
|
823
922
|
| 'cma_ip_bytes'
|
|
824
923
|
| 'cma_ip_requests'
|
|
825
924
|
| 'video_path_seconds';
|
|
826
|
-
/**
|
|
827
|
-
|
|
925
|
+
/**
|
|
926
|
+
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
927
|
+
* `self.hrefSchema` link.
|
|
928
|
+
*/
|
|
929
|
+
export declare type UsageCounterSelfHrefSchema = {
|
|
828
930
|
/** The time period upon which counters will be returned */
|
|
829
931
|
period?: 'today' | 'current_month' | 'last_month';
|
|
830
932
|
};
|
|
@@ -833,35 +935,39 @@ export type UsageCounterSelfHrefSchema = {
|
|
|
833
935
|
*
|
|
834
936
|
* This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "type".
|
|
835
937
|
*/
|
|
836
|
-
export type UploadTagType = 'upload_tag';
|
|
938
|
+
export declare type UploadTagType = 'upload_tag';
|
|
837
939
|
/**
|
|
838
940
|
* ID of upload tag
|
|
839
941
|
*
|
|
840
|
-
* This interface was referenced by `UploadTag`'s JSON-Schema via the
|
|
942
|
+
* This interface was referenced by `UploadTag`'s JSON-Schema via the
|
|
943
|
+
* `definition` "identity".
|
|
841
944
|
*
|
|
842
945
|
* This interface was referenced by `UploadTag`'s JSON-Schema via the `definition` "id".
|
|
843
946
|
*/
|
|
844
|
-
export type UploadTagIdentity = string;
|
|
947
|
+
export declare type UploadTagIdentity = string;
|
|
845
948
|
/**
|
|
846
949
|
* JSON API type field
|
|
847
950
|
*
|
|
848
|
-
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
951
|
+
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
952
|
+
* `definition` "type".
|
|
849
953
|
*/
|
|
850
|
-
export type UploadSmartTagType = 'upload_smart_tag';
|
|
954
|
+
export declare type UploadSmartTagType = 'upload_smart_tag';
|
|
851
955
|
/**
|
|
852
956
|
* ID of upload tag
|
|
853
957
|
*
|
|
854
|
-
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
958
|
+
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
959
|
+
* `definition` "identity".
|
|
855
960
|
*
|
|
856
|
-
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
961
|
+
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
962
|
+
* `definition` "id".
|
|
857
963
|
*/
|
|
858
|
-
export type UploadSmartTagIdentity = string;
|
|
964
|
+
export declare type UploadSmartTagIdentity = string;
|
|
859
965
|
/**
|
|
860
966
|
* JSON API type field
|
|
861
967
|
*
|
|
862
968
|
* This interface was referenced by `Site`'s JSON-Schema via the `definition` "type".
|
|
863
969
|
*/
|
|
864
|
-
export type SiteType = 'site';
|
|
970
|
+
export declare type SiteType = 'site';
|
|
865
971
|
/**
|
|
866
972
|
* ID of site
|
|
867
973
|
*
|
|
@@ -869,8 +975,7 @@ export type SiteType = 'site';
|
|
|
869
975
|
*
|
|
870
976
|
* This interface was referenced by `Site`'s JSON-Schema via the `definition` "id".
|
|
871
977
|
*/
|
|
872
|
-
export type SiteIdentity = string;
|
|
873
|
-
|
|
978
|
+
export declare type SiteIdentity = string;
|
|
874
979
|
export interface DatoCMSSiteAPI {
|
|
875
980
|
role?: Role;
|
|
876
981
|
user?: User;
|
|
@@ -919,10 +1024,11 @@ export interface DatoCMSSiteAPI {
|
|
|
919
1024
|
[k: string]: unknown;
|
|
920
1025
|
}
|
|
921
1026
|
/**
|
|
922
|
-
* A Role represents a specific set of actions an editor (or an API token) can
|
|
923
|
-
* your administrative area.
|
|
1027
|
+
* A Role represents a specific set of actions an editor (or an API token) can
|
|
1028
|
+
* perform on your administrative area.
|
|
924
1029
|
*
|
|
925
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1030
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1031
|
+
* `definition` "role".
|
|
926
1032
|
*/
|
|
927
1033
|
export interface Role {
|
|
928
1034
|
type: RoleType;
|
|
@@ -934,7 +1040,8 @@ export interface Role {
|
|
|
934
1040
|
/**
|
|
935
1041
|
* JSON API attributes
|
|
936
1042
|
*
|
|
937
|
-
* This interface was referenced by `Role`'s JSON-Schema via the `definition`
|
|
1043
|
+
* This interface was referenced by `Role`'s JSON-Schema via the `definition`
|
|
1044
|
+
* "attributes".
|
|
938
1045
|
*/
|
|
939
1046
|
export interface RoleAttributes {
|
|
940
1047
|
/** The name of the role */
|
|
@@ -999,8 +1106,8 @@ export interface RoleAttributes {
|
|
|
999
1106
|
/** Permitted content scope */
|
|
1000
1107
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1001
1108
|
/**
|
|
1002
|
-
* Permitted localized content in this locale. Required when
|
|
1003
|
-
* `localized`
|
|
1109
|
+
* Permitted localized content in this locale. Required when
|
|
1110
|
+
* `localization_scope` is `localized`
|
|
1004
1111
|
*/
|
|
1005
1112
|
locale?: string | null;
|
|
1006
1113
|
}[];
|
|
@@ -1028,8 +1135,8 @@ export interface RoleAttributes {
|
|
|
1028
1135
|
/** Permitted content scope */
|
|
1029
1136
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1030
1137
|
/**
|
|
1031
|
-
* Permitted localized content in this locale. Required when
|
|
1032
|
-
* `localized`
|
|
1138
|
+
* Permitted localized content in this locale. Required when
|
|
1139
|
+
* `localization_scope` is `localized`
|
|
1033
1140
|
*/
|
|
1034
1141
|
locale?: string | null;
|
|
1035
1142
|
}[];
|
|
@@ -1050,8 +1157,8 @@ export interface RoleAttributes {
|
|
|
1050
1157
|
/** Permitted content scope */
|
|
1051
1158
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1052
1159
|
/**
|
|
1053
|
-
* Permitted localized content in this locale. Required when
|
|
1054
|
-
* `localized`
|
|
1160
|
+
* Permitted localized content in this locale. Required when
|
|
1161
|
+
* `localization_scope` is `localized`
|
|
1055
1162
|
*/
|
|
1056
1163
|
locale?: string | null;
|
|
1057
1164
|
}[];
|
|
@@ -1072,8 +1179,8 @@ export interface RoleAttributes {
|
|
|
1072
1179
|
/** Permitted content scope */
|
|
1073
1180
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1074
1181
|
/**
|
|
1075
|
-
* Permitted localized content in this locale. Required when
|
|
1076
|
-
* `localized`
|
|
1182
|
+
* Permitted localized content in this locale. Required when
|
|
1183
|
+
* `localization_scope` is `localized`
|
|
1077
1184
|
*/
|
|
1078
1185
|
locale?: string | null;
|
|
1079
1186
|
}[];
|
|
@@ -1089,7 +1196,8 @@ export interface RoleAttributes {
|
|
|
1089
1196
|
/**
|
|
1090
1197
|
* JSON API links
|
|
1091
1198
|
*
|
|
1092
|
-
* This interface was referenced by `Role`'s JSON-Schema via the `definition`
|
|
1199
|
+
* This interface was referenced by `Role`'s JSON-Schema via the `definition`
|
|
1200
|
+
* "relationships".
|
|
1093
1201
|
*/
|
|
1094
1202
|
export interface RoleRelationships {
|
|
1095
1203
|
/** The roles from which this role inherits permissions */
|
|
@@ -1174,8 +1282,8 @@ export interface RoleMeta {
|
|
|
1174
1282
|
/** Permitted content scope */
|
|
1175
1283
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1176
1284
|
/**
|
|
1177
|
-
* Permitted localized content in this locale. Required when
|
|
1178
|
-
* is `localized`
|
|
1285
|
+
* Permitted localized content in this locale. Required when
|
|
1286
|
+
* `localization_scope` is `localized`
|
|
1179
1287
|
*/
|
|
1180
1288
|
locale?: string | null;
|
|
1181
1289
|
}[];
|
|
@@ -1203,8 +1311,8 @@ export interface RoleMeta {
|
|
|
1203
1311
|
/** Permitted content scope */
|
|
1204
1312
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1205
1313
|
/**
|
|
1206
|
-
* Permitted localized content in this locale. Required when
|
|
1207
|
-
* is `localized`
|
|
1314
|
+
* Permitted localized content in this locale. Required when
|
|
1315
|
+
* `localization_scope` is `localized`
|
|
1208
1316
|
*/
|
|
1209
1317
|
locale?: string | null;
|
|
1210
1318
|
}[];
|
|
@@ -1225,8 +1333,8 @@ export interface RoleMeta {
|
|
|
1225
1333
|
/** Permitted content scope */
|
|
1226
1334
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1227
1335
|
/**
|
|
1228
|
-
* Permitted localized content in this locale. Required when
|
|
1229
|
-
* is `localized`
|
|
1336
|
+
* Permitted localized content in this locale. Required when
|
|
1337
|
+
* `localization_scope` is `localized`
|
|
1230
1338
|
*/
|
|
1231
1339
|
locale?: string | null;
|
|
1232
1340
|
}[];
|
|
@@ -1247,8 +1355,8 @@ export interface RoleMeta {
|
|
|
1247
1355
|
/** Permitted content scope */
|
|
1248
1356
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1249
1357
|
/**
|
|
1250
|
-
* Permitted localized content in this locale. Required when
|
|
1251
|
-
* is `localized`
|
|
1358
|
+
* Permitted localized content in this locale. Required when
|
|
1359
|
+
* `localization_scope` is `localized`
|
|
1252
1360
|
*/
|
|
1253
1361
|
locale?: string | null;
|
|
1254
1362
|
}[];
|
|
@@ -1330,8 +1438,8 @@ export interface RoleCreateSchema {
|
|
|
1330
1438
|
/** Permitted content scope */
|
|
1331
1439
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1332
1440
|
/**
|
|
1333
|
-
* Permitted localized content in this locale. Required when
|
|
1334
|
-
* is `localized`
|
|
1441
|
+
* Permitted localized content in this locale. Required when
|
|
1442
|
+
* `localization_scope` is `localized`
|
|
1335
1443
|
*/
|
|
1336
1444
|
locale?: string | null;
|
|
1337
1445
|
}[];
|
|
@@ -1359,8 +1467,8 @@ export interface RoleCreateSchema {
|
|
|
1359
1467
|
/** Permitted content scope */
|
|
1360
1468
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1361
1469
|
/**
|
|
1362
|
-
* Permitted localized content in this locale. Required when
|
|
1363
|
-
* is `localized`
|
|
1470
|
+
* Permitted localized content in this locale. Required when
|
|
1471
|
+
* `localization_scope` is `localized`
|
|
1364
1472
|
*/
|
|
1365
1473
|
locale?: string | null;
|
|
1366
1474
|
}[];
|
|
@@ -1381,8 +1489,8 @@ export interface RoleCreateSchema {
|
|
|
1381
1489
|
/** Permitted content scope */
|
|
1382
1490
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1383
1491
|
/**
|
|
1384
|
-
* Permitted localized content in this locale. Required when
|
|
1385
|
-
* is `localized`
|
|
1492
|
+
* Permitted localized content in this locale. Required when
|
|
1493
|
+
* `localization_scope` is `localized`
|
|
1386
1494
|
*/
|
|
1387
1495
|
locale?: string | null;
|
|
1388
1496
|
}[];
|
|
@@ -1403,8 +1511,8 @@ export interface RoleCreateSchema {
|
|
|
1403
1511
|
/** Permitted content scope */
|
|
1404
1512
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1405
1513
|
/**
|
|
1406
|
-
* Permitted localized content in this locale. Required when
|
|
1407
|
-
* is `localized`
|
|
1514
|
+
* Permitted localized content in this locale. Required when
|
|
1515
|
+
* `localization_scope` is `localized`
|
|
1408
1516
|
*/
|
|
1409
1517
|
locale?: string | null;
|
|
1410
1518
|
}[];
|
|
@@ -1427,7 +1535,10 @@ export interface RoleCreateSchema {
|
|
|
1427
1535
|
meta?: RoleMeta;
|
|
1428
1536
|
};
|
|
1429
1537
|
}
|
|
1430
|
-
/**
|
|
1538
|
+
/**
|
|
1539
|
+
* This interface was referenced by `Role`'s JSON-Schema via the
|
|
1540
|
+
* `create.targetSchema` link.
|
|
1541
|
+
*/
|
|
1431
1542
|
export interface RoleCreateTargetSchema {
|
|
1432
1543
|
data: Role;
|
|
1433
1544
|
}
|
|
@@ -1500,8 +1611,8 @@ export interface RoleUpdateSchema {
|
|
|
1500
1611
|
/** Permitted content scope */
|
|
1501
1612
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1502
1613
|
/**
|
|
1503
|
-
* Permitted localized content in this locale. Required when
|
|
1504
|
-
* is `localized`
|
|
1614
|
+
* Permitted localized content in this locale. Required when
|
|
1615
|
+
* `localization_scope` is `localized`
|
|
1505
1616
|
*/
|
|
1506
1617
|
locale?: string | null;
|
|
1507
1618
|
}[];
|
|
@@ -1529,8 +1640,8 @@ export interface RoleUpdateSchema {
|
|
|
1529
1640
|
/** Permitted content scope */
|
|
1530
1641
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1531
1642
|
/**
|
|
1532
|
-
* Permitted localized content in this locale. Required when
|
|
1533
|
-
* is `localized`
|
|
1643
|
+
* Permitted localized content in this locale. Required when
|
|
1644
|
+
* `localization_scope` is `localized`
|
|
1534
1645
|
*/
|
|
1535
1646
|
locale?: string | null;
|
|
1536
1647
|
}[];
|
|
@@ -1551,8 +1662,8 @@ export interface RoleUpdateSchema {
|
|
|
1551
1662
|
/** Permitted content scope */
|
|
1552
1663
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1553
1664
|
/**
|
|
1554
|
-
* Permitted localized content in this locale. Required when
|
|
1555
|
-
* is `localized`
|
|
1665
|
+
* Permitted localized content in this locale. Required when
|
|
1666
|
+
* `localization_scope` is `localized`
|
|
1556
1667
|
*/
|
|
1557
1668
|
locale?: string | null;
|
|
1558
1669
|
}[];
|
|
@@ -1573,8 +1684,8 @@ export interface RoleUpdateSchema {
|
|
|
1573
1684
|
/** Permitted content scope */
|
|
1574
1685
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1575
1686
|
/**
|
|
1576
|
-
* Permitted localized content in this locale. Required when
|
|
1577
|
-
* is `localized`
|
|
1687
|
+
* Permitted localized content in this locale. Required when
|
|
1688
|
+
* `localization_scope` is `localized`
|
|
1578
1689
|
*/
|
|
1579
1690
|
locale?: string | null;
|
|
1580
1691
|
}[];
|
|
@@ -1597,11 +1708,17 @@ export interface RoleUpdateSchema {
|
|
|
1597
1708
|
meta?: RoleMeta;
|
|
1598
1709
|
};
|
|
1599
1710
|
}
|
|
1600
|
-
/**
|
|
1711
|
+
/**
|
|
1712
|
+
* This interface was referenced by `Role`'s JSON-Schema via the
|
|
1713
|
+
* `update.targetSchema` link.
|
|
1714
|
+
*/
|
|
1601
1715
|
export interface RoleUpdateTargetSchema {
|
|
1602
1716
|
data: Role;
|
|
1603
1717
|
}
|
|
1604
|
-
/**
|
|
1718
|
+
/**
|
|
1719
|
+
* This interface was referenced by `Role`'s JSON-Schema via the
|
|
1720
|
+
* `instances.targetSchema` link.
|
|
1721
|
+
*/
|
|
1605
1722
|
export interface RoleInstancesTargetSchema {
|
|
1606
1723
|
data: Role[];
|
|
1607
1724
|
}
|
|
@@ -1609,16 +1726,20 @@ export interface RoleInstancesTargetSchema {
|
|
|
1609
1726
|
export interface RoleSelfTargetSchema {
|
|
1610
1727
|
data: Role;
|
|
1611
1728
|
}
|
|
1612
|
-
/**
|
|
1729
|
+
/**
|
|
1730
|
+
* This interface was referenced by `Role`'s JSON-Schema via the
|
|
1731
|
+
* `destroy.targetSchema` link.
|
|
1732
|
+
*/
|
|
1613
1733
|
export interface RoleDestroyTargetSchema {
|
|
1614
1734
|
data: Role;
|
|
1615
1735
|
}
|
|
1616
1736
|
/**
|
|
1617
|
-
* A DatoCMS administrative area can be accessed by multiple people. Every
|
|
1618
|
-
* is linked to a specific Role, which describes what actions it
|
|
1619
|
-
* once logged in.
|
|
1737
|
+
* A DatoCMS administrative area can be accessed by multiple people. Every
|
|
1738
|
+
* collaborator is linked to a specific Role, which describes what actions it
|
|
1739
|
+
* will be able to perform once logged in.
|
|
1620
1740
|
*
|
|
1621
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1741
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1742
|
+
* `definition` "user".
|
|
1622
1743
|
*/
|
|
1623
1744
|
export interface User {
|
|
1624
1745
|
type: UserType;
|
|
@@ -1630,7 +1751,8 @@ export interface User {
|
|
|
1630
1751
|
/**
|
|
1631
1752
|
* JSON API attributes
|
|
1632
1753
|
*
|
|
1633
|
-
* This interface was referenced by `User`'s JSON-Schema via the `definition`
|
|
1754
|
+
* This interface was referenced by `User`'s JSON-Schema via the `definition`
|
|
1755
|
+
* "attributes".
|
|
1634
1756
|
*/
|
|
1635
1757
|
export interface UserAttributes {
|
|
1636
1758
|
/** Email */
|
|
@@ -1645,7 +1767,8 @@ export interface UserAttributes {
|
|
|
1645
1767
|
/**
|
|
1646
1768
|
* JSON API links
|
|
1647
1769
|
*
|
|
1648
|
-
* This interface was referenced by `User`'s JSON-Schema via the `definition`
|
|
1770
|
+
* This interface was referenced by `User`'s JSON-Schema via the `definition`
|
|
1771
|
+
* "relationships".
|
|
1649
1772
|
*/
|
|
1650
1773
|
export interface UserRelationships {
|
|
1651
1774
|
/** Role */
|
|
@@ -1688,11 +1811,17 @@ export interface UserUpdateSchema {
|
|
|
1688
1811
|
};
|
|
1689
1812
|
};
|
|
1690
1813
|
}
|
|
1691
|
-
/**
|
|
1814
|
+
/**
|
|
1815
|
+
* This interface was referenced by `User`'s JSON-Schema via the
|
|
1816
|
+
* `update.targetSchema` link.
|
|
1817
|
+
*/
|
|
1692
1818
|
export interface UserUpdateTargetSchema {
|
|
1693
1819
|
data: User;
|
|
1694
1820
|
}
|
|
1695
|
-
/**
|
|
1821
|
+
/**
|
|
1822
|
+
* This interface was referenced by `User`'s JSON-Schema via the
|
|
1823
|
+
* `instances.targetSchema` link.
|
|
1824
|
+
*/
|
|
1696
1825
|
export interface UserInstancesTargetSchema {
|
|
1697
1826
|
data: User[];
|
|
1698
1827
|
}
|
|
@@ -1700,16 +1829,21 @@ export interface UserInstancesTargetSchema {
|
|
|
1700
1829
|
export interface UserSelfTargetSchema {
|
|
1701
1830
|
data: User;
|
|
1702
1831
|
}
|
|
1703
|
-
/**
|
|
1832
|
+
/**
|
|
1833
|
+
* This interface was referenced by `User`'s JSON-Schema via the
|
|
1834
|
+
* `destroy.targetSchema` link.
|
|
1835
|
+
*/
|
|
1704
1836
|
export interface UserDestroyTargetSchema {
|
|
1705
1837
|
data: User;
|
|
1706
1838
|
}
|
|
1707
1839
|
/**
|
|
1708
|
-
* A Single Sign-On user exists when a DatoCMS project is connected to an
|
|
1709
|
-
* Identity Provider. An SSO user will not use the standard login
|
|
1710
|
-
* through SAML authentication. It can also be linked to
|
|
1840
|
+
* A Single Sign-On user exists when a DatoCMS project is connected to an
|
|
1841
|
+
* external Identity Provider. An SSO user will not use the standard login
|
|
1842
|
+
* procedure but has to go through SAML authentication. It can also be linked to
|
|
1843
|
+
* one or more IdP groups.
|
|
1711
1844
|
*
|
|
1712
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1845
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1846
|
+
* `definition` "sso_user".
|
|
1713
1847
|
*/
|
|
1714
1848
|
export interface SsoUser {
|
|
1715
1849
|
type: SsoUserType;
|
|
@@ -1721,7 +1855,8 @@ export interface SsoUser {
|
|
|
1721
1855
|
/**
|
|
1722
1856
|
* JSON API attributes
|
|
1723
1857
|
*
|
|
1724
|
-
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
|
|
1858
|
+
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
|
|
1859
|
+
* "attributes".
|
|
1725
1860
|
*/
|
|
1726
1861
|
export interface SsoUserAttributes {
|
|
1727
1862
|
/** Email */
|
|
@@ -1729,8 +1864,8 @@ export interface SsoUserAttributes {
|
|
|
1729
1864
|
/** Identity provider ID */
|
|
1730
1865
|
external_id: string | null;
|
|
1731
1866
|
/**
|
|
1732
|
-
* Whether this user is active on the identity provider. De-activated users
|
|
1733
|
-
* able to login.
|
|
1867
|
+
* Whether this user is active on the identity provider. De-activated users
|
|
1868
|
+
* won't be able to login.
|
|
1734
1869
|
*/
|
|
1735
1870
|
is_active: boolean;
|
|
1736
1871
|
/** First name */
|
|
@@ -1741,7 +1876,8 @@ export interface SsoUserAttributes {
|
|
|
1741
1876
|
/**
|
|
1742
1877
|
* JSON API links
|
|
1743
1878
|
*
|
|
1744
|
-
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
|
|
1879
|
+
* This interface was referenced by `SsoUser`'s JSON-Schema via the `definition`
|
|
1880
|
+
* "relationships".
|
|
1745
1881
|
*/
|
|
1746
1882
|
export interface SsoUserRelationships {
|
|
1747
1883
|
/** All the users's groups */
|
|
@@ -1780,28 +1916,41 @@ export interface SsoUserData {
|
|
|
1780
1916
|
type: SsoUserType;
|
|
1781
1917
|
id: SsoUserIdentity;
|
|
1782
1918
|
}
|
|
1783
|
-
/**
|
|
1919
|
+
/**
|
|
1920
|
+
* This interface was referenced by `SsoUser`'s JSON-Schema via the
|
|
1921
|
+
* `instances.targetSchema` link.
|
|
1922
|
+
*/
|
|
1784
1923
|
export interface SsoUserInstancesTargetSchema {
|
|
1785
1924
|
data: SsoUser[];
|
|
1786
1925
|
}
|
|
1787
|
-
/**
|
|
1926
|
+
/**
|
|
1927
|
+
* This interface was referenced by `SsoUser`'s JSON-Schema via the
|
|
1928
|
+
* `self.targetSchema` link.
|
|
1929
|
+
*/
|
|
1788
1930
|
export interface SsoUserSelfTargetSchema {
|
|
1789
1931
|
data: SsoUser;
|
|
1790
1932
|
}
|
|
1791
|
-
/**
|
|
1933
|
+
/**
|
|
1934
|
+
* This interface was referenced by `SsoUser`'s JSON-Schema via the
|
|
1935
|
+
* `copy_users.targetSchema` link.
|
|
1936
|
+
*/
|
|
1792
1937
|
export interface SsoUserCopyUsersTargetSchema {
|
|
1793
1938
|
data: SsoUser[];
|
|
1794
1939
|
}
|
|
1795
|
-
/**
|
|
1940
|
+
/**
|
|
1941
|
+
* This interface was referenced by `SsoUser`'s JSON-Schema via the
|
|
1942
|
+
* `destroy.targetSchema` link.
|
|
1943
|
+
*/
|
|
1796
1944
|
export interface SsoUserDestroyTargetSchema {
|
|
1797
1945
|
data: SsoUser;
|
|
1798
1946
|
}
|
|
1799
1947
|
/**
|
|
1800
|
-
* If the Audit log functionality is enabled in a project, logged events can be
|
|
1801
|
-
* using SQL-like language and fetched in full detail so that they can
|
|
1948
|
+
* If the Audit log functionality is enabled in a project, logged events can be
|
|
1949
|
+
* queried using SQL-like language and fetched in full detail so that they can
|
|
1950
|
+
* be exported or analyzed.
|
|
1802
1951
|
*
|
|
1803
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1804
|
-
* "audit_log_event".
|
|
1952
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1953
|
+
* `definition` "audit_log_event".
|
|
1805
1954
|
*/
|
|
1806
1955
|
export interface AuditLogEvent {
|
|
1807
1956
|
type: AuditLogEventType;
|
|
@@ -1812,8 +1961,8 @@ export interface AuditLogEvent {
|
|
|
1812
1961
|
/**
|
|
1813
1962
|
* JSON API attributes
|
|
1814
1963
|
*
|
|
1815
|
-
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
1816
|
-
* "attributes".
|
|
1964
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
1965
|
+
* `definition` "attributes".
|
|
1817
1966
|
*/
|
|
1818
1967
|
export interface AuditLogEventAttributes {
|
|
1819
1968
|
/** The actual action performed */
|
|
@@ -1824,7 +1973,10 @@ export interface AuditLogEventAttributes {
|
|
|
1824
1973
|
type: string;
|
|
1825
1974
|
/** The ID of the actor */
|
|
1826
1975
|
id: string;
|
|
1827
|
-
/**
|
|
1976
|
+
/**
|
|
1977
|
+
* An human representation of the actor (name/email/username depending on
|
|
1978
|
+
* the type of actor)
|
|
1979
|
+
*/
|
|
1828
1980
|
name: string;
|
|
1829
1981
|
};
|
|
1830
1982
|
/** The role of the actor at the time the action was performed */
|
|
@@ -1867,7 +2019,8 @@ export interface AuditLogEventAttributes {
|
|
|
1867
2019
|
/**
|
|
1868
2020
|
* JSON API meta
|
|
1869
2021
|
*
|
|
1870
|
-
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
2022
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
2023
|
+
* `definition` "meta".
|
|
1871
2024
|
*/
|
|
1872
2025
|
export interface AuditLogEventMeta {
|
|
1873
2026
|
/** The date of the event */
|
|
@@ -1876,13 +2029,17 @@ export interface AuditLogEventMeta {
|
|
|
1876
2029
|
/**
|
|
1877
2030
|
* JSON API data
|
|
1878
2031
|
*
|
|
1879
|
-
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
2032
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
2033
|
+
* `definition` "data".
|
|
1880
2034
|
*/
|
|
1881
2035
|
export interface AuditLogEventData {
|
|
1882
2036
|
type: AuditLogEventType;
|
|
1883
2037
|
id: AuditLogEventIdentity;
|
|
1884
2038
|
}
|
|
1885
|
-
/**
|
|
2039
|
+
/**
|
|
2040
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
2041
|
+
* `query.schema` link.
|
|
2042
|
+
*/
|
|
1886
2043
|
export interface AuditLogEventQuerySchema {
|
|
1887
2044
|
data: {
|
|
1888
2045
|
/** JSON API type field */
|
|
@@ -1891,13 +2048,13 @@ export interface AuditLogEventQuerySchema {
|
|
|
1891
2048
|
/** An SQL-like expression to filter the events */
|
|
1892
2049
|
filter?: string;
|
|
1893
2050
|
/**
|
|
1894
|
-
* Set this value to get remaining results, if a meta.next_token was
|
|
1895
|
-
* the previous query response
|
|
2051
|
+
* Set this value to get remaining results, if a meta.next_token was
|
|
2052
|
+
* returned in the previous query response
|
|
1896
2053
|
*/
|
|
1897
2054
|
next_token?: string;
|
|
1898
2055
|
/**
|
|
1899
|
-
* Whether a detailed log complete with full request and response payload
|
|
1900
|
-
* returned or not
|
|
2056
|
+
* Whether a detailed log complete with full request and response payload
|
|
2057
|
+
* must be returned or not
|
|
1901
2058
|
*/
|
|
1902
2059
|
detailed_log?: boolean;
|
|
1903
2060
|
};
|
|
@@ -1911,9 +2068,9 @@ export interface AuditLogEventQueryTargetSchema {
|
|
|
1911
2068
|
data: AuditLogEvent[];
|
|
1912
2069
|
meta: {
|
|
1913
2070
|
/**
|
|
1914
|
-
* If the response request exceeds the response payload limit DatoCMS will
|
|
1915
|
-
* value in the response. If set, you can use that this value in
|
|
1916
|
-
* request to get the remaining results
|
|
2071
|
+
* If the response request exceeds the response payload limit DatoCMS will
|
|
2072
|
+
* set this value in the response. If set, you can use that this value in
|
|
2073
|
+
* the subsequent request to get the remaining results
|
|
1917
2074
|
*/
|
|
1918
2075
|
next_token: null | string;
|
|
1919
2076
|
};
|
|
@@ -1921,7 +2078,8 @@ export interface AuditLogEventQueryTargetSchema {
|
|
|
1921
2078
|
/**
|
|
1922
2079
|
* DatoCMS account
|
|
1923
2080
|
*
|
|
1924
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2081
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2082
|
+
* `definition` "account".
|
|
1925
2083
|
*/
|
|
1926
2084
|
export interface Account {
|
|
1927
2085
|
type: AccountType;
|
|
@@ -1931,7 +2089,8 @@ export interface Account {
|
|
|
1931
2089
|
/**
|
|
1932
2090
|
* JSON API attributes
|
|
1933
2091
|
*
|
|
1934
|
-
* This interface was referenced by `Account`'s JSON-Schema via the `definition`
|
|
2092
|
+
* This interface was referenced by `Account`'s JSON-Schema via the `definition`
|
|
2093
|
+
* "attributes".
|
|
1935
2094
|
*/
|
|
1936
2095
|
export interface AccountAttributes {
|
|
1937
2096
|
/** Email */
|
|
@@ -1957,8 +2116,8 @@ export interface AccountData {
|
|
|
1957
2116
|
/**
|
|
1958
2117
|
* Stores the information regarding the current plan for the project.
|
|
1959
2118
|
*
|
|
1960
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
1961
|
-
* "site_plan".
|
|
2119
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2120
|
+
* `definition` "site_plan".
|
|
1962
2121
|
*/
|
|
1963
2122
|
export interface SitePlan {
|
|
1964
2123
|
type: SitePlanType;
|
|
@@ -1968,7 +2127,8 @@ export interface SitePlan {
|
|
|
1968
2127
|
/**
|
|
1969
2128
|
* JSON API attributes
|
|
1970
2129
|
*
|
|
1971
|
-
* This interface was referenced by `SitePlan`'s JSON-Schema via the
|
|
2130
|
+
* This interface was referenced by `SitePlan`'s JSON-Schema via the
|
|
2131
|
+
* `definition` "attributes".
|
|
1972
2132
|
*/
|
|
1973
2133
|
export interface SitePlanAttributes {
|
|
1974
2134
|
/** The name of the plan */
|
|
@@ -1996,8 +2156,8 @@ export interface SitePlanAttributes {
|
|
|
1996
2156
|
/** Uploadable bytes */
|
|
1997
2157
|
uploadable_bytes: null | number;
|
|
1998
2158
|
/**
|
|
1999
|
-
* Amount of asset data transferred between our Asset CDN and GraphQL Content
|
|
2000
|
-
* API and content consumers
|
|
2159
|
+
* Amount of asset data transferred between our Asset CDN and GraphQL Content
|
|
2160
|
+
* Delivery API and content consumers
|
|
2001
2161
|
*/
|
|
2002
2162
|
traffic_bytes: null | number;
|
|
2003
2163
|
/** The number of requests made to both our Content Management and Content Delivery APIs */
|
|
@@ -2033,8 +2193,8 @@ export interface SitePlanAttributes {
|
|
|
2033
2193
|
/** Days of version history retention */
|
|
2034
2194
|
history_retention_days: number | null;
|
|
2035
2195
|
/**
|
|
2036
|
-
* Period (in minutes) in which bursts of changes made to the same record by
|
|
2037
|
-
* user (or API token) will be grouped into a single one
|
|
2196
|
+
* Period (in minutes) in which bursts of changes made to the same record by
|
|
2197
|
+
* the same user (or API token) will be grouped into a single one
|
|
2038
2198
|
*/
|
|
2039
2199
|
history_resolution_minutes: number;
|
|
2040
2200
|
/** Whether two-factor authentication can be enabled or not */
|
|
@@ -2108,11 +2268,12 @@ export interface SitePlanData {
|
|
|
2108
2268
|
id: SitePlanIdentity;
|
|
2109
2269
|
}
|
|
2110
2270
|
/**
|
|
2111
|
-
* In DatoCMS you can organize the different Models present in your
|
|
2112
|
-
* reordering and grouping them, so that their purpose will
|
|
2271
|
+
* In DatoCMS you can organize the different Models present in your
|
|
2272
|
+
* administrative area reordering and grouping them, so that their purpose will
|
|
2273
|
+
* be more clear to the final editor.
|
|
2113
2274
|
*
|
|
2114
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2115
|
-
* "menu_item".
|
|
2275
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2276
|
+
* `definition` "menu_item".
|
|
2116
2277
|
*/
|
|
2117
2278
|
export interface MenuItem {
|
|
2118
2279
|
type: MenuItemType;
|
|
@@ -2123,7 +2284,8 @@ export interface MenuItem {
|
|
|
2123
2284
|
/**
|
|
2124
2285
|
* JSON API attributes
|
|
2125
2286
|
*
|
|
2126
|
-
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2287
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2288
|
+
* `definition` "attributes".
|
|
2127
2289
|
*/
|
|
2128
2290
|
export interface MenuItemAttributes {
|
|
2129
2291
|
/** The label of the menu item */
|
|
@@ -2138,7 +2300,8 @@ export interface MenuItemAttributes {
|
|
|
2138
2300
|
/**
|
|
2139
2301
|
* JSON API links
|
|
2140
2302
|
*
|
|
2141
|
-
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2303
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2304
|
+
* `definition` "relationships".
|
|
2142
2305
|
*/
|
|
2143
2306
|
export interface MenuItemRelationships {
|
|
2144
2307
|
/** Item type associated with the menu item */
|
|
@@ -2157,7 +2320,8 @@ export interface MenuItemRelationships {
|
|
|
2157
2320
|
/**
|
|
2158
2321
|
* JSON API data
|
|
2159
2322
|
*
|
|
2160
|
-
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2323
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2324
|
+
* `definition` "data".
|
|
2161
2325
|
*/
|
|
2162
2326
|
export interface ItemTypeData {
|
|
2163
2327
|
type: ItemTypeType;
|
|
@@ -2199,7 +2363,10 @@ export interface MenuItemCreateSchema {
|
|
|
2199
2363
|
};
|
|
2200
2364
|
};
|
|
2201
2365
|
}
|
|
2202
|
-
/**
|
|
2366
|
+
/**
|
|
2367
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2368
|
+
* `create.targetSchema` link.
|
|
2369
|
+
*/
|
|
2203
2370
|
export interface MenuItemCreateTargetSchema {
|
|
2204
2371
|
data: MenuItem;
|
|
2205
2372
|
}
|
|
@@ -2231,29 +2398,42 @@ export interface MenuItemUpdateSchema {
|
|
|
2231
2398
|
};
|
|
2232
2399
|
};
|
|
2233
2400
|
}
|
|
2234
|
-
/**
|
|
2401
|
+
/**
|
|
2402
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2403
|
+
* `update.targetSchema` link.
|
|
2404
|
+
*/
|
|
2235
2405
|
export interface MenuItemUpdateTargetSchema {
|
|
2236
2406
|
data: MenuItem;
|
|
2237
2407
|
}
|
|
2238
|
-
/**
|
|
2408
|
+
/**
|
|
2409
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2410
|
+
* `instances.targetSchema` link.
|
|
2411
|
+
*/
|
|
2239
2412
|
export interface MenuItemInstancesTargetSchema {
|
|
2240
2413
|
data: MenuItem[];
|
|
2241
2414
|
}
|
|
2242
|
-
/**
|
|
2415
|
+
/**
|
|
2416
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2417
|
+
* `self.targetSchema` link.
|
|
2418
|
+
*/
|
|
2243
2419
|
export interface MenuItemSelfTargetSchema {
|
|
2244
2420
|
data: MenuItem;
|
|
2245
2421
|
}
|
|
2246
|
-
/**
|
|
2422
|
+
/**
|
|
2423
|
+
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
2424
|
+
* `destroy.targetSchema` link.
|
|
2425
|
+
*/
|
|
2247
2426
|
export interface MenuItemDestroyTargetSchema {
|
|
2248
2427
|
data: MenuItem;
|
|
2249
2428
|
}
|
|
2250
2429
|
/**
|
|
2251
|
-
* The way you define the kind of content you can edit inside your
|
|
2252
|
-
* passes through the concept of Models, which are much like
|
|
2253
|
-
* backward-compatibility reasons, the API refers to models
|
|
2430
|
+
* The way you define the kind of content you can edit inside your
|
|
2431
|
+
* administrative area passes through the concept of Models, which are much like
|
|
2432
|
+
* database tables. For backward-compatibility reasons, the API refers to models
|
|
2433
|
+
* as "item types".
|
|
2254
2434
|
*
|
|
2255
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2256
|
-
* "item_type".
|
|
2435
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2436
|
+
* `definition` "item_type".
|
|
2257
2437
|
*/
|
|
2258
2438
|
export interface ModelBlock {
|
|
2259
2439
|
type: ItemTypeType;
|
|
@@ -2264,7 +2444,8 @@ export interface ModelBlock {
|
|
|
2264
2444
|
/**
|
|
2265
2445
|
* JSON API attributes
|
|
2266
2446
|
*
|
|
2267
|
-
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2447
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2448
|
+
* `definition` "attributes".
|
|
2268
2449
|
*/
|
|
2269
2450
|
export interface ItemTypeAttributes {
|
|
2270
2451
|
/** Name of the model */
|
|
@@ -2277,7 +2458,10 @@ export interface ItemTypeAttributes {
|
|
|
2277
2458
|
collection_appearance: 'compact' | 'table';
|
|
2278
2459
|
/** Whether the model is single-instance or not */
|
|
2279
2460
|
singleton: boolean;
|
|
2280
|
-
/**
|
|
2461
|
+
/**
|
|
2462
|
+
* Whether we require all the project locales to be present for each localized
|
|
2463
|
+
* field or not
|
|
2464
|
+
*/
|
|
2281
2465
|
all_locales_required: boolean;
|
|
2282
2466
|
/** Whether editors can sort records via drag & drop or not */
|
|
2283
2467
|
sortable: boolean;
|
|
@@ -2289,7 +2473,10 @@ export interface ItemTypeAttributes {
|
|
|
2289
2473
|
tree: boolean;
|
|
2290
2474
|
/** If an ordering field is set, this fields specify the sorting direction */
|
|
2291
2475
|
ordering_direction: null | 'asc' | 'desc';
|
|
2292
|
-
/**
|
|
2476
|
+
/**
|
|
2477
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with
|
|
2478
|
+
* ordering_field
|
|
2479
|
+
*/
|
|
2293
2480
|
ordering_meta:
|
|
2294
2481
|
| null
|
|
2295
2482
|
| 'created_at'
|
|
@@ -2297,8 +2484,8 @@ export interface ItemTypeAttributes {
|
|
|
2297
2484
|
| 'first_published_at'
|
|
2298
2485
|
| 'published_at';
|
|
2299
2486
|
/**
|
|
2300
|
-
* If this model is single-instance, this tells the single-instance record has
|
|
2301
|
-
* been created or not
|
|
2487
|
+
* If this model is single-instance, this tells the single-instance record has
|
|
2488
|
+
* already been created or not
|
|
2302
2489
|
*/
|
|
2303
2490
|
has_singleton_item: boolean;
|
|
2304
2491
|
/** A hint shown to editors to help them understand the purpose of this model/block */
|
|
@@ -2307,8 +2494,8 @@ export interface ItemTypeAttributes {
|
|
|
2307
2494
|
/**
|
|
2308
2495
|
* JSON API links
|
|
2309
2496
|
*
|
|
2310
|
-
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2311
|
-
* "relationships".
|
|
2497
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2498
|
+
* `definition` "relationships".
|
|
2312
2499
|
*/
|
|
2313
2500
|
export interface ItemTypeRelationships {
|
|
2314
2501
|
/** The item instance related to this item type */
|
|
@@ -2359,9 +2546,12 @@ export interface WorkflowData {
|
|
|
2359
2546
|
type: WorkflowType;
|
|
2360
2547
|
id: WorkflowIdentity;
|
|
2361
2548
|
}
|
|
2362
|
-
/**
|
|
2363
|
-
|
|
2364
|
-
|
|
2549
|
+
/**
|
|
2550
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2551
|
+
* `create.schema` link.
|
|
2552
|
+
*/
|
|
2553
|
+
export interface ItemTypeCreateSchema {
|
|
2554
|
+
data: {
|
|
2365
2555
|
type: ItemTypeType;
|
|
2366
2556
|
/** JSON API attributes */
|
|
2367
2557
|
attributes: {
|
|
@@ -2371,7 +2561,10 @@ export interface ItemTypeCreateSchema {
|
|
|
2371
2561
|
api_key: string;
|
|
2372
2562
|
/** Whether the model is single-instance or not */
|
|
2373
2563
|
singleton?: boolean;
|
|
2374
|
-
/**
|
|
2564
|
+
/**
|
|
2565
|
+
* Whether we require all the project locales to be present for each
|
|
2566
|
+
* localized field or not
|
|
2567
|
+
*/
|
|
2375
2568
|
all_locales_required?: boolean;
|
|
2376
2569
|
/** Whether editors can sort records via drag & drop or not */
|
|
2377
2570
|
sortable?: boolean;
|
|
@@ -2383,7 +2576,10 @@ export interface ItemTypeCreateSchema {
|
|
|
2383
2576
|
tree?: boolean;
|
|
2384
2577
|
/** If an ordering field is set, this fields specify the sorting direction */
|
|
2385
2578
|
ordering_direction?: null | 'asc' | 'desc';
|
|
2386
|
-
/**
|
|
2579
|
+
/**
|
|
2580
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with
|
|
2581
|
+
* ordering_field
|
|
2582
|
+
*/
|
|
2387
2583
|
ordering_meta?:
|
|
2388
2584
|
| null
|
|
2389
2585
|
| 'created_at'
|
|
@@ -2413,12 +2609,18 @@ export interface ItemTypeCreateSchema {
|
|
|
2413
2609
|
};
|
|
2414
2610
|
};
|
|
2415
2611
|
}
|
|
2416
|
-
/**
|
|
2612
|
+
/**
|
|
2613
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2614
|
+
* `create.targetSchema` link.
|
|
2615
|
+
*/
|
|
2417
2616
|
export interface ItemTypeCreateTargetSchema {
|
|
2418
2617
|
data: ModelBlock;
|
|
2419
2618
|
included?: MenuItem[];
|
|
2420
2619
|
}
|
|
2421
|
-
/**
|
|
2620
|
+
/**
|
|
2621
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2622
|
+
* `update.schema` link.
|
|
2623
|
+
*/
|
|
2422
2624
|
export interface ItemTypeUpdateSchema {
|
|
2423
2625
|
data: {
|
|
2424
2626
|
type: ItemTypeType;
|
|
@@ -2435,7 +2637,10 @@ export interface ItemTypeUpdateSchema {
|
|
|
2435
2637
|
collection_appearance?: 'compact' | 'table';
|
|
2436
2638
|
/** Whether the model is single-instance or not */
|
|
2437
2639
|
singleton?: boolean;
|
|
2438
|
-
/**
|
|
2640
|
+
/**
|
|
2641
|
+
* Whether we require all the project locales to be present for each
|
|
2642
|
+
* localized field or not
|
|
2643
|
+
*/
|
|
2439
2644
|
all_locales_required?: boolean;
|
|
2440
2645
|
/** Whether editors can sort records via drag & drop or not */
|
|
2441
2646
|
sortable?: boolean;
|
|
@@ -2447,7 +2652,10 @@ export interface ItemTypeUpdateSchema {
|
|
|
2447
2652
|
tree?: boolean;
|
|
2448
2653
|
/** If an ordering field is set, this fields specify the sorting direction */
|
|
2449
2654
|
ordering_direction?: null | 'asc' | 'desc';
|
|
2450
|
-
/**
|
|
2655
|
+
/**
|
|
2656
|
+
* Specifies the model's sorting method. Cannot be set in concurrency with
|
|
2657
|
+
* ordering_field
|
|
2658
|
+
*/
|
|
2451
2659
|
ordering_meta?:
|
|
2452
2660
|
| null
|
|
2453
2661
|
| 'created_at'
|
|
@@ -2455,8 +2663,8 @@ export interface ItemTypeUpdateSchema {
|
|
|
2455
2663
|
| 'first_published_at'
|
|
2456
2664
|
| 'published_at';
|
|
2457
2665
|
/**
|
|
2458
|
-
* If this model is single-instance, this tells the single-instance record
|
|
2459
|
-
* already been created or not
|
|
2666
|
+
* If this model is single-instance, this tells the single-instance record
|
|
2667
|
+
* has already been created or not
|
|
2460
2668
|
*/
|
|
2461
2669
|
has_singleton_item?: boolean;
|
|
2462
2670
|
/** A hint shown to editors to help them understand the purpose of this model/block */
|
|
@@ -2478,11 +2686,17 @@ export interface ItemTypeUpdateSchema {
|
|
|
2478
2686
|
};
|
|
2479
2687
|
};
|
|
2480
2688
|
}
|
|
2481
|
-
/**
|
|
2689
|
+
/**
|
|
2690
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2691
|
+
* `update.targetSchema` link.
|
|
2692
|
+
*/
|
|
2482
2693
|
export interface ItemTypeUpdateTargetSchema {
|
|
2483
2694
|
data: Job;
|
|
2484
2695
|
}
|
|
2485
|
-
/**
|
|
2696
|
+
/**
|
|
2697
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2698
|
+
* `definition` "job".
|
|
2699
|
+
*/
|
|
2486
2700
|
export interface Job {
|
|
2487
2701
|
type: TargetSchemaPropertiesDataType;
|
|
2488
2702
|
id: TargetSchemaPropertiesDataIdentity;
|
|
@@ -2496,7 +2710,10 @@ export interface TargetSchemaPropertiesDataData {
|
|
|
2496
2710
|
type: TargetSchemaPropertiesDataType;
|
|
2497
2711
|
id: TargetSchemaPropertiesDataIdentity;
|
|
2498
2712
|
}
|
|
2499
|
-
/**
|
|
2713
|
+
/**
|
|
2714
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2715
|
+
* `update.jobSchema` link.
|
|
2716
|
+
*/
|
|
2500
2717
|
export interface ItemTypeUpdateJobSchema {
|
|
2501
2718
|
data: ModelBlock;
|
|
2502
2719
|
}
|
|
@@ -2507,7 +2724,10 @@ export interface ItemTypeUpdateJobSchema {
|
|
|
2507
2724
|
export interface ItemTypeInstancesTargetSchema {
|
|
2508
2725
|
data: ModelBlock[];
|
|
2509
2726
|
}
|
|
2510
|
-
/**
|
|
2727
|
+
/**
|
|
2728
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2729
|
+
* `self.targetSchema` link.
|
|
2730
|
+
*/
|
|
2511
2731
|
export interface ItemTypeSelfTargetSchema {
|
|
2512
2732
|
data: ModelBlock;
|
|
2513
2733
|
}
|
|
@@ -2518,20 +2738,27 @@ export interface ItemTypeSelfTargetSchema {
|
|
|
2518
2738
|
export interface ItemTypeDuplicateTargetSchema {
|
|
2519
2739
|
data: ModelBlock;
|
|
2520
2740
|
}
|
|
2521
|
-
/**
|
|
2741
|
+
/**
|
|
2742
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2743
|
+
* `destroy.targetSchema` link.
|
|
2744
|
+
*/
|
|
2522
2745
|
export interface ItemTypeDestroyTargetSchema {
|
|
2523
2746
|
data: Job;
|
|
2524
2747
|
}
|
|
2525
|
-
/**
|
|
2748
|
+
/**
|
|
2749
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the
|
|
2750
|
+
* `destroy.jobSchema` link.
|
|
2751
|
+
*/
|
|
2526
2752
|
export interface ItemTypeDestroyJobSchema {
|
|
2527
2753
|
data: ModelBlock;
|
|
2528
2754
|
}
|
|
2529
2755
|
/**
|
|
2530
|
-
* Each Model consists of a set of fields. Using the database metaphore, fields
|
|
2531
|
-
* table columns, and when creating them you need to specify their type
|
|
2532
|
-
* `file`, `float`, etc.) and any required validation.
|
|
2756
|
+
* Each Model consists of a set of fields. Using the database metaphore, fields
|
|
2757
|
+
* are like table columns, and when creating them you need to specify their type
|
|
2758
|
+
* (`string`, `file`, `float`, etc.) and any required validation.
|
|
2533
2759
|
*
|
|
2534
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2760
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
2761
|
+
* `definition` "field".
|
|
2535
2762
|
*/
|
|
2536
2763
|
export interface Field {
|
|
2537
2764
|
type: FieldType;
|
|
@@ -2542,7 +2769,8 @@ export interface Field {
|
|
|
2542
2769
|
/**
|
|
2543
2770
|
* JSON API attributes
|
|
2544
2771
|
*
|
|
2545
|
-
* This interface was referenced by `Field`'s JSON-Schema via the `definition`
|
|
2772
|
+
* This interface was referenced by `Field`'s JSON-Schema via the `definition`
|
|
2773
|
+
* "attributes".
|
|
2546
2774
|
*/
|
|
2547
2775
|
export interface FieldAttributes {
|
|
2548
2776
|
/** The label of the field */
|
|
@@ -2552,8 +2780,8 @@ export interface FieldAttributes {
|
|
|
2552
2780
|
/** Whether the field needs to be multilanguage or not */
|
|
2553
2781
|
localized: boolean;
|
|
2554
2782
|
/**
|
|
2555
|
-
* Default value for Field. When field is localized accepts an object of
|
|
2556
|
-
* with site locales as keys
|
|
2783
|
+
* Default value for Field. When field is localized accepts an object of
|
|
2784
|
+
* default values with site locales as keys
|
|
2557
2785
|
*/
|
|
2558
2786
|
default_value:
|
|
2559
2787
|
| boolean
|
|
@@ -2582,11 +2810,14 @@ export interface FieldAttributes {
|
|
|
2582
2810
|
/** Field appearance details, plugin configuration and field add-ons */
|
|
2583
2811
|
appearance: {
|
|
2584
2812
|
/**
|
|
2585
|
-
* A valid editor can be a DatoCMS default field editor type (ie.
|
|
2586
|
-
* or a plugin ID offering a custom field editor
|
|
2813
|
+
* A valid editor can be a DatoCMS default field editor type (ie.
|
|
2814
|
+
* `"single_line"`), or a plugin ID offering a custom field editor
|
|
2587
2815
|
*/
|
|
2588
2816
|
editor: string;
|
|
2589
|
-
/**
|
|
2817
|
+
/**
|
|
2818
|
+
* The specific field extension to use for the field (only if the editor is
|
|
2819
|
+
* a modern plugin)
|
|
2820
|
+
*/
|
|
2590
2821
|
field_extension?: string;
|
|
2591
2822
|
/** The editor plugin's parameters */
|
|
2592
2823
|
parameters: {
|
|
@@ -2596,7 +2827,10 @@ export interface FieldAttributes {
|
|
|
2596
2827
|
addons: {
|
|
2597
2828
|
/** The ID of a plugin offering a field addon */
|
|
2598
2829
|
id: string;
|
|
2599
|
-
/**
|
|
2830
|
+
/**
|
|
2831
|
+
* The specific field extension to use for the field (only if the editor
|
|
2832
|
+
* is a modern plugin)
|
|
2833
|
+
*/
|
|
2600
2834
|
field_extension?: string;
|
|
2601
2835
|
parameters: {
|
|
2602
2836
|
[k: string]: unknown;
|
|
@@ -2611,7 +2845,8 @@ export interface FieldAttributes {
|
|
|
2611
2845
|
/**
|
|
2612
2846
|
* JSON API links
|
|
2613
2847
|
*
|
|
2614
|
-
* This interface was referenced by `Field`'s JSON-Schema via the `definition`
|
|
2848
|
+
* This interface was referenced by `Field`'s JSON-Schema via the `definition`
|
|
2849
|
+
* "relationships".
|
|
2615
2850
|
*/
|
|
2616
2851
|
export interface FieldRelationships {
|
|
2617
2852
|
/** Field item type */
|
|
@@ -2666,8 +2901,8 @@ export interface FieldCreateSchema {
|
|
|
2666
2901
|
*/
|
|
2667
2902
|
editor: string;
|
|
2668
2903
|
/**
|
|
2669
|
-
* The specific field extension to use for the field (only if the editor
|
|
2670
|
-
* modern plugin)
|
|
2904
|
+
* The specific field extension to use for the field (only if the editor
|
|
2905
|
+
* is a modern plugin)
|
|
2671
2906
|
*/
|
|
2672
2907
|
field_extension?: string;
|
|
2673
2908
|
/** The editor plugin's parameters */
|
|
@@ -2679,8 +2914,8 @@ export interface FieldCreateSchema {
|
|
|
2679
2914
|
/** The ID of a plugin offering a field addon */
|
|
2680
2915
|
id: string;
|
|
2681
2916
|
/**
|
|
2682
|
-
* The specific field extension to use for the field (only if the
|
|
2683
|
-
* modern plugin)
|
|
2917
|
+
* The specific field extension to use for the field (only if the
|
|
2918
|
+
* editor is a modern plugin)
|
|
2684
2919
|
*/
|
|
2685
2920
|
field_extension?: string;
|
|
2686
2921
|
parameters: {
|
|
@@ -2695,8 +2930,8 @@ export interface FieldCreateSchema {
|
|
|
2695
2930
|
/** Field hint */
|
|
2696
2931
|
hint?: string | null;
|
|
2697
2932
|
/**
|
|
2698
|
-
* Default value for Field. When field is localized accepts an object of
|
|
2699
|
-
* values with site locales as keys
|
|
2933
|
+
* Default value for Field. When field is localized accepts an object of
|
|
2934
|
+
* default values with site locales as keys
|
|
2700
2935
|
*/
|
|
2701
2936
|
default_value?:
|
|
2702
2937
|
| boolean
|
|
@@ -2716,7 +2951,10 @@ export interface FieldCreateSchema {
|
|
|
2716
2951
|
};
|
|
2717
2952
|
};
|
|
2718
2953
|
}
|
|
2719
|
-
/**
|
|
2954
|
+
/**
|
|
2955
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
2956
|
+
* `create.targetSchema` link.
|
|
2957
|
+
*/
|
|
2720
2958
|
export interface FieldCreateTargetSchema {
|
|
2721
2959
|
data: Job;
|
|
2722
2960
|
}
|
|
@@ -2732,8 +2970,8 @@ export interface FieldUpdateSchema {
|
|
|
2732
2970
|
id: FieldIdentity;
|
|
2733
2971
|
attributes: {
|
|
2734
2972
|
/**
|
|
2735
|
-
* Default value for Field. When field is localized accepts an object of
|
|
2736
|
-
* values with site locales as keys
|
|
2973
|
+
* Default value for Field. When field is localized accepts an object of
|
|
2974
|
+
* default values with site locales as keys
|
|
2737
2975
|
*/
|
|
2738
2976
|
default_value?:
|
|
2739
2977
|
| boolean
|
|
@@ -2769,8 +3007,8 @@ export interface FieldUpdateSchema {
|
|
|
2769
3007
|
*/
|
|
2770
3008
|
editor: string;
|
|
2771
3009
|
/**
|
|
2772
|
-
* The specific field extension to use for the field (only if the editor
|
|
2773
|
-
* modern plugin)
|
|
3010
|
+
* The specific field extension to use for the field (only if the editor
|
|
3011
|
+
* is a modern plugin)
|
|
2774
3012
|
*/
|
|
2775
3013
|
field_extension?: string;
|
|
2776
3014
|
/** The editor plugin's parameters */
|
|
@@ -2782,8 +3020,8 @@ export interface FieldUpdateSchema {
|
|
|
2782
3020
|
/** The ID of a plugin offering a field addon */
|
|
2783
3021
|
id: string;
|
|
2784
3022
|
/**
|
|
2785
|
-
* The specific field extension to use for the field (only if the
|
|
2786
|
-
* modern plugin)
|
|
3023
|
+
* The specific field extension to use for the field (only if the
|
|
3024
|
+
* editor is a modern plugin)
|
|
2787
3025
|
*/
|
|
2788
3026
|
field_extension?: string;
|
|
2789
3027
|
parameters: {
|
|
@@ -2809,7 +3047,10 @@ export interface FieldUpdateSchema {
|
|
|
2809
3047
|
};
|
|
2810
3048
|
};
|
|
2811
3049
|
}
|
|
2812
|
-
/**
|
|
3050
|
+
/**
|
|
3051
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3052
|
+
* `update.targetSchema` link.
|
|
3053
|
+
*/
|
|
2813
3054
|
export interface FieldUpdateTargetSchema {
|
|
2814
3055
|
data: Job;
|
|
2815
3056
|
}
|
|
@@ -2818,36 +3059,60 @@ export interface FieldUpdateJobSchema {
|
|
|
2818
3059
|
data: Field;
|
|
2819
3060
|
included?: (ModelBlock | Field)[];
|
|
2820
3061
|
}
|
|
2821
|
-
/**
|
|
3062
|
+
/**
|
|
3063
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3064
|
+
* `instances.targetSchema` link.
|
|
3065
|
+
*/
|
|
2822
3066
|
export interface FieldInstancesTargetSchema {
|
|
2823
3067
|
data: Field[];
|
|
2824
3068
|
}
|
|
2825
|
-
/**
|
|
3069
|
+
/**
|
|
3070
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3071
|
+
* `referencing.targetSchema` link.
|
|
3072
|
+
*/
|
|
2826
3073
|
export interface FieldReferencingTargetSchema {
|
|
2827
3074
|
data: Field[];
|
|
2828
3075
|
}
|
|
2829
|
-
/**
|
|
3076
|
+
/**
|
|
3077
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3078
|
+
* `related.targetSchema` link.
|
|
3079
|
+
*/
|
|
2830
3080
|
export interface FieldRelatedTargetSchema {
|
|
2831
3081
|
data: Field[];
|
|
2832
3082
|
}
|
|
2833
|
-
/**
|
|
3083
|
+
/**
|
|
3084
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3085
|
+
* `self.targetSchema` link.
|
|
3086
|
+
*/
|
|
2834
3087
|
export interface FieldSelfTargetSchema {
|
|
2835
3088
|
data: Field;
|
|
2836
3089
|
}
|
|
2837
|
-
/**
|
|
3090
|
+
/**
|
|
3091
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3092
|
+
* `destroy.targetSchema` link.
|
|
3093
|
+
*/
|
|
2838
3094
|
export interface FieldDestroyTargetSchema {
|
|
2839
3095
|
data: Job;
|
|
2840
3096
|
}
|
|
2841
|
-
/**
|
|
3097
|
+
/**
|
|
3098
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3099
|
+
* `destroy.jobSchema` link.
|
|
3100
|
+
*/
|
|
2842
3101
|
export interface FieldDestroyJobSchema {
|
|
2843
3102
|
data: Field;
|
|
2844
3103
|
included?: ModelBlock[];
|
|
2845
3104
|
}
|
|
2846
|
-
/**
|
|
3105
|
+
/**
|
|
3106
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3107
|
+
* `duplicate.targetSchema` link.
|
|
3108
|
+
*/
|
|
2847
3109
|
export interface FieldDuplicateTargetSchema {
|
|
2848
3110
|
data: Job;
|
|
2849
3111
|
}
|
|
2850
|
-
/**
|
|
3112
|
+
/**
|
|
3113
|
+
* This interface was referenced by `Field`'s JSON-Schema via the
|
|
3114
|
+
* `duplicate.jobSchema` link.
|
|
3115
|
+
*/
|
|
2851
3116
|
export interface FieldDuplicateJobSchema {
|
|
2852
3117
|
data: Field;
|
|
2853
3118
|
included: ModelBlock[];
|
|
@@ -2855,7 +3120,8 @@ export interface FieldDuplicateJobSchema {
|
|
|
2855
3120
|
/**
|
|
2856
3121
|
* Fields can be organized and grouped into fieldset to better present them to editors.
|
|
2857
3122
|
*
|
|
2858
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3123
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3124
|
+
* `definition` "fieldset".
|
|
2859
3125
|
*/
|
|
2860
3126
|
export interface Fieldset {
|
|
2861
3127
|
type: FieldsetType;
|
|
@@ -2866,7 +3132,8 @@ export interface Fieldset {
|
|
|
2866
3132
|
/**
|
|
2867
3133
|
* JSON API attributes
|
|
2868
3134
|
*
|
|
2869
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3135
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3136
|
+
* `definition` "attributes".
|
|
2870
3137
|
*/
|
|
2871
3138
|
export interface FieldsetAttributes {
|
|
2872
3139
|
/** The title of the fieldset */
|
|
@@ -2883,7 +3150,8 @@ export interface FieldsetAttributes {
|
|
|
2883
3150
|
/**
|
|
2884
3151
|
* JSON API links
|
|
2885
3152
|
*
|
|
2886
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3153
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3154
|
+
* `definition` "relationships".
|
|
2887
3155
|
*/
|
|
2888
3156
|
export interface FieldsetRelationships {
|
|
2889
3157
|
/** Fieldset item type */
|
|
@@ -2905,12 +3173,18 @@ export interface FieldsetCreateSchema {
|
|
|
2905
3173
|
position?: number;
|
|
2906
3174
|
/** Whether the fieldset can be collapsed or not */
|
|
2907
3175
|
collapsible?: boolean;
|
|
2908
|
-
/**
|
|
3176
|
+
/**
|
|
3177
|
+
* When fieldset is collapsible, determines if the default is to start
|
|
3178
|
+
* collapsed or not
|
|
3179
|
+
*/
|
|
2909
3180
|
start_collapsed?: boolean;
|
|
2910
3181
|
};
|
|
2911
3182
|
};
|
|
2912
3183
|
}
|
|
2913
|
-
/**
|
|
3184
|
+
/**
|
|
3185
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3186
|
+
* `create.targetSchema` link.
|
|
3187
|
+
*/
|
|
2914
3188
|
export interface FieldsetCreateTargetSchema {
|
|
2915
3189
|
data: Fieldset;
|
|
2916
3190
|
}
|
|
@@ -2928,31 +3202,47 @@ export interface FieldsetUpdateSchema {
|
|
|
2928
3202
|
position?: number;
|
|
2929
3203
|
/** Whether the fieldset can be collapsed or not */
|
|
2930
3204
|
collapsible?: boolean;
|
|
2931
|
-
/**
|
|
3205
|
+
/**
|
|
3206
|
+
* When fieldset is collapsible, determines if the default is to start
|
|
3207
|
+
* collapsed or not
|
|
3208
|
+
*/
|
|
2932
3209
|
start_collapsed?: boolean;
|
|
2933
3210
|
};
|
|
2934
3211
|
};
|
|
2935
3212
|
}
|
|
2936
|
-
/**
|
|
3213
|
+
/**
|
|
3214
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3215
|
+
* `update.targetSchema` link.
|
|
3216
|
+
*/
|
|
2937
3217
|
export interface FieldsetUpdateTargetSchema {
|
|
2938
3218
|
data: Fieldset;
|
|
2939
3219
|
}
|
|
2940
|
-
/**
|
|
3220
|
+
/**
|
|
3221
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3222
|
+
* `instances.targetSchema` link.
|
|
3223
|
+
*/
|
|
2941
3224
|
export interface FieldsetInstancesTargetSchema {
|
|
2942
3225
|
data: Fieldset[];
|
|
2943
3226
|
}
|
|
2944
|
-
/**
|
|
3227
|
+
/**
|
|
3228
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3229
|
+
* `self.targetSchema` link.
|
|
3230
|
+
*/
|
|
2945
3231
|
export interface FieldsetSelfTargetSchema {
|
|
2946
3232
|
data: Fieldset;
|
|
2947
3233
|
}
|
|
2948
|
-
/**
|
|
3234
|
+
/**
|
|
3235
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
3236
|
+
* `destroy.targetSchema` link.
|
|
3237
|
+
*/
|
|
2949
3238
|
export interface FieldsetDestroyTargetSchema {
|
|
2950
3239
|
data: Fieldset;
|
|
2951
3240
|
}
|
|
2952
3241
|
/**
|
|
2953
3242
|
* A session is required to access to read-and-write API endpoints
|
|
2954
3243
|
*
|
|
2955
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3244
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3245
|
+
* `definition` "session".
|
|
2956
3246
|
*/
|
|
2957
3247
|
export interface Session {
|
|
2958
3248
|
type: SessionType;
|
|
@@ -2962,7 +3252,8 @@ export interface Session {
|
|
|
2962
3252
|
/**
|
|
2963
3253
|
* JSON API links
|
|
2964
3254
|
*
|
|
2965
|
-
* This interface was referenced by `Session`'s JSON-Schema via the `definition`
|
|
3255
|
+
* This interface was referenced by `Session`'s JSON-Schema via the `definition`
|
|
3256
|
+
* "relationships".
|
|
2966
3257
|
*/
|
|
2967
3258
|
export interface SessionRelationships {
|
|
2968
3259
|
/** The user associated with the session */
|
|
@@ -3018,17 +3309,20 @@ export interface SessionCreateSchema {
|
|
|
3018
3309
|
};
|
|
3019
3310
|
};
|
|
3020
3311
|
}
|
|
3021
|
-
/**
|
|
3312
|
+
/**
|
|
3313
|
+
* This interface was referenced by `Session`'s JSON-Schema via the
|
|
3314
|
+
* `create.targetSchema` link.
|
|
3315
|
+
*/
|
|
3022
3316
|
export interface SessionCreateTargetSchema {
|
|
3023
3317
|
data: Session;
|
|
3024
3318
|
included: User[];
|
|
3025
3319
|
}
|
|
3026
3320
|
/**
|
|
3027
|
-
* An API token allows access to our API. It is linked to a Role, which
|
|
3028
|
-
* actions can be performed.
|
|
3321
|
+
* An API token allows access to our API. It is linked to a Role, which
|
|
3322
|
+
* describes what actions can be performed.
|
|
3029
3323
|
*
|
|
3030
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3031
|
-
* "access_token".
|
|
3324
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3325
|
+
* `definition` "access_token".
|
|
3032
3326
|
*/
|
|
3033
3327
|
export interface AccessToken {
|
|
3034
3328
|
type: AccessTokenType;
|
|
@@ -3039,7 +3333,8 @@ export interface AccessToken {
|
|
|
3039
3333
|
/**
|
|
3040
3334
|
* JSON API attributes
|
|
3041
3335
|
*
|
|
3042
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3336
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3337
|
+
* `definition` "attributes".
|
|
3043
3338
|
*/
|
|
3044
3339
|
export interface AccessTokenAttributes {
|
|
3045
3340
|
/** Name of API token */
|
|
@@ -3057,8 +3352,8 @@ export interface AccessTokenAttributes {
|
|
|
3057
3352
|
/**
|
|
3058
3353
|
* JSON API links
|
|
3059
3354
|
*
|
|
3060
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3061
|
-
* "relationships".
|
|
3355
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3356
|
+
* `definition` "relationships".
|
|
3062
3357
|
*/
|
|
3063
3358
|
export interface AccessTokenRelationships {
|
|
3064
3359
|
/** Role */
|
|
@@ -3069,20 +3364,27 @@ export interface AccessTokenRelationships {
|
|
|
3069
3364
|
/**
|
|
3070
3365
|
* JSON API data
|
|
3071
3366
|
*
|
|
3072
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3367
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3368
|
+
* `definition` "data".
|
|
3073
3369
|
*/
|
|
3074
3370
|
export interface AccessTokenData {
|
|
3075
3371
|
type: AccessTokenType;
|
|
3076
3372
|
id: AccessTokenIdentity;
|
|
3077
3373
|
}
|
|
3078
|
-
/**
|
|
3374
|
+
/**
|
|
3375
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3376
|
+
* `create.schema` link.
|
|
3377
|
+
*/
|
|
3079
3378
|
export interface AccessTokenCreateSchema {
|
|
3080
3379
|
data: {
|
|
3081
3380
|
type: AccessTokenType;
|
|
3082
3381
|
attributes: {
|
|
3083
3382
|
/** Name of API token */
|
|
3084
3383
|
name: string;
|
|
3085
|
-
/**
|
|
3384
|
+
/**
|
|
3385
|
+
* Whether this API token can access the Content Delivery API published
|
|
3386
|
+
* content endpoint
|
|
3387
|
+
*/
|
|
3086
3388
|
can_access_cda: boolean;
|
|
3087
3389
|
/** Whether this API token can access the Content Delivery API draft content endpoint */
|
|
3088
3390
|
can_access_cda_preview: boolean;
|
|
@@ -3097,11 +3399,17 @@ export interface AccessTokenCreateSchema {
|
|
|
3097
3399
|
};
|
|
3098
3400
|
};
|
|
3099
3401
|
}
|
|
3100
|
-
/**
|
|
3402
|
+
/**
|
|
3403
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3404
|
+
* `create.targetSchema` link.
|
|
3405
|
+
*/
|
|
3101
3406
|
export interface AccessTokenCreateTargetSchema {
|
|
3102
3407
|
data: AccessToken;
|
|
3103
3408
|
}
|
|
3104
|
-
/**
|
|
3409
|
+
/**
|
|
3410
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3411
|
+
* `update.schema` link.
|
|
3412
|
+
*/
|
|
3105
3413
|
export interface AccessTokenUpdateSchema {
|
|
3106
3414
|
data: {
|
|
3107
3415
|
type: AccessTokenType;
|
|
@@ -3109,7 +3417,10 @@ export interface AccessTokenUpdateSchema {
|
|
|
3109
3417
|
attributes: {
|
|
3110
3418
|
/** Name of API token */
|
|
3111
3419
|
name: string;
|
|
3112
|
-
/**
|
|
3420
|
+
/**
|
|
3421
|
+
* Whether this API token can access the Content Delivery API published
|
|
3422
|
+
* content endpoint
|
|
3423
|
+
*/
|
|
3113
3424
|
can_access_cda: boolean;
|
|
3114
3425
|
/** Whether this API token can access the Content Delivery API draft content endpoint */
|
|
3115
3426
|
can_access_cda_preview: boolean;
|
|
@@ -3124,7 +3435,10 @@ export interface AccessTokenUpdateSchema {
|
|
|
3124
3435
|
};
|
|
3125
3436
|
};
|
|
3126
3437
|
}
|
|
3127
|
-
/**
|
|
3438
|
+
/**
|
|
3439
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3440
|
+
* `update.targetSchema` link.
|
|
3441
|
+
*/
|
|
3128
3442
|
export interface AccessTokenUpdateTargetSchema {
|
|
3129
3443
|
data: AccessToken;
|
|
3130
3444
|
}
|
|
@@ -3135,7 +3449,10 @@ export interface AccessTokenUpdateTargetSchema {
|
|
|
3135
3449
|
export interface AccessTokenInstancesTargetSchema {
|
|
3136
3450
|
data: AccessToken[];
|
|
3137
3451
|
}
|
|
3138
|
-
/**
|
|
3452
|
+
/**
|
|
3453
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
3454
|
+
* `self.targetSchema` link.
|
|
3455
|
+
*/
|
|
3139
3456
|
export interface AccessTokenSelfTargetSchema {
|
|
3140
3457
|
data: AccessToken;
|
|
3141
3458
|
}
|
|
@@ -3154,10 +3471,11 @@ export interface AccessTokenDestroyTargetSchema {
|
|
|
3154
3471
|
data: AccessToken;
|
|
3155
3472
|
}
|
|
3156
3473
|
/**
|
|
3157
|
-
* Plugins enable developers to replace DatoCMS field components with HTML5
|
|
3158
|
-
* so the editing experiences of the DatoCMS web app can be customized.
|
|
3474
|
+
* Plugins enable developers to replace DatoCMS field components with HTML5
|
|
3475
|
+
* applications so the editing experiences of the DatoCMS web app can be customized.
|
|
3159
3476
|
*
|
|
3160
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3477
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3478
|
+
* `definition` "plugin".
|
|
3161
3479
|
*/
|
|
3162
3480
|
export interface Plugin {
|
|
3163
3481
|
type: PluginType;
|
|
@@ -3168,7 +3486,8 @@ export interface Plugin {
|
|
|
3168
3486
|
/**
|
|
3169
3487
|
* JSON API attributes
|
|
3170
3488
|
*
|
|
3171
|
-
* This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
|
|
3489
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the `definition`
|
|
3490
|
+
* "attributes".
|
|
3172
3491
|
*/
|
|
3173
3492
|
export interface PluginAttributes {
|
|
3174
3493
|
/** The name of the plugin */
|
|
@@ -3182,8 +3501,8 @@ export interface PluginAttributes {
|
|
|
3182
3501
|
/** The entry point URL of the plugin */
|
|
3183
3502
|
url: string;
|
|
3184
3503
|
/**
|
|
3185
|
-
* Global plugin configuration. Plugins can persist whatever information they
|
|
3186
|
-
* this object to reuse it later.
|
|
3504
|
+
* Global plugin configuration. Plugins can persist whatever information they
|
|
3505
|
+
* want in this object to reuse it later.
|
|
3187
3506
|
*/
|
|
3188
3507
|
parameters: {
|
|
3189
3508
|
[k: string]: unknown;
|
|
@@ -3245,29 +3564,35 @@ export interface PluginCreateSchema {
|
|
|
3245
3564
|
type: PluginType;
|
|
3246
3565
|
attributes: {
|
|
3247
3566
|
/**
|
|
3248
|
-
* NPM package name of the public plugin you want to install. For public
|
|
3249
|
-
* that's the only attribute you need to pass.
|
|
3567
|
+
* NPM package name of the public plugin you want to install. For public
|
|
3568
|
+
* plugins, that's the only attribute you need to pass.
|
|
3250
3569
|
*/
|
|
3251
3570
|
package_name?: string;
|
|
3252
3571
|
/** The name of the plugin. Only to be passed if package name key is not specified. */
|
|
3253
3572
|
name?: string;
|
|
3254
|
-
/**
|
|
3573
|
+
/**
|
|
3574
|
+
* A description of the plugin. Only to be passed if package name key is
|
|
3575
|
+
* not specified.
|
|
3576
|
+
*/
|
|
3255
3577
|
description?: string;
|
|
3256
|
-
/**
|
|
3578
|
+
/**
|
|
3579
|
+
* The entry point URL of the plugin. Only to be passed if package name
|
|
3580
|
+
* key is not specified.
|
|
3581
|
+
*/
|
|
3257
3582
|
url?: string;
|
|
3258
3583
|
/**
|
|
3259
|
-
* Permissions granted to this plugin. Only to be passed if package name
|
|
3260
|
-
* specified.
|
|
3584
|
+
* Permissions granted to this plugin. Only to be passed if package name
|
|
3585
|
+
* key is not specified.
|
|
3261
3586
|
*/
|
|
3262
3587
|
permissions?: 'currentUserAccessToken'[];
|
|
3263
3588
|
/**
|
|
3264
|
-
* The type of field extension this legacy plugin implements. Only to be
|
|
3265
|
-
* package name key is not specified.
|
|
3589
|
+
* The type of field extension this legacy plugin implements. Only to be
|
|
3590
|
+
* passed if package name key is not specified.
|
|
3266
3591
|
*/
|
|
3267
3592
|
plugin_type?: 'field_editor' | 'sidebar' | 'field_addon';
|
|
3268
3593
|
/**
|
|
3269
|
-
* On which types of field in which this legacy plugin can be used. Only
|
|
3270
|
-
* passed if package name key is not specified.
|
|
3594
|
+
* On which types of field in which this legacy plugin can be used. Only
|
|
3595
|
+
* to be passed if package name key is not specified.
|
|
3271
3596
|
*/
|
|
3272
3597
|
field_types?: (
|
|
3273
3598
|
| 'boolean'
|
|
@@ -3299,7 +3624,10 @@ export interface PluginCreateSchema {
|
|
|
3299
3624
|
};
|
|
3300
3625
|
};
|
|
3301
3626
|
}
|
|
3302
|
-
/**
|
|
3627
|
+
/**
|
|
3628
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the
|
|
3629
|
+
* `create.targetSchema` link.
|
|
3630
|
+
*/
|
|
3303
3631
|
export interface PluginCreateTargetSchema {
|
|
3304
3632
|
data: Plugin;
|
|
3305
3633
|
}
|
|
@@ -3316,8 +3644,8 @@ export interface PluginUpdateSchema {
|
|
|
3316
3644
|
/** The entry point URL of the plugin */
|
|
3317
3645
|
url?: string;
|
|
3318
3646
|
/**
|
|
3319
|
-
* Global plugin configuration. Plugins can persist whatever information
|
|
3320
|
-
* in this object to reuse it later.
|
|
3647
|
+
* Global plugin configuration. Plugins can persist whatever information
|
|
3648
|
+
* they want in this object to reuse it later.
|
|
3321
3649
|
*/
|
|
3322
3650
|
parameters?: {
|
|
3323
3651
|
[k: string]: unknown;
|
|
@@ -3330,31 +3658,46 @@ export interface PluginUpdateSchema {
|
|
|
3330
3658
|
};
|
|
3331
3659
|
};
|
|
3332
3660
|
}
|
|
3333
|
-
/**
|
|
3661
|
+
/**
|
|
3662
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the
|
|
3663
|
+
* `update.targetSchema` link.
|
|
3664
|
+
*/
|
|
3334
3665
|
export interface PluginUpdateTargetSchema {
|
|
3335
3666
|
data: Plugin;
|
|
3336
3667
|
}
|
|
3337
|
-
/**
|
|
3668
|
+
/**
|
|
3669
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the
|
|
3670
|
+
* `instances.targetSchema` link.
|
|
3671
|
+
*/
|
|
3338
3672
|
export interface PluginInstancesTargetSchema {
|
|
3339
3673
|
data: Plugin[];
|
|
3340
3674
|
}
|
|
3341
|
-
/**
|
|
3675
|
+
/**
|
|
3676
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the
|
|
3677
|
+
* `self.targetSchema` link.
|
|
3678
|
+
*/
|
|
3342
3679
|
export interface PluginSelfTargetSchema {
|
|
3343
3680
|
data: Plugin;
|
|
3344
3681
|
}
|
|
3345
|
-
/**
|
|
3682
|
+
/**
|
|
3683
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the
|
|
3684
|
+
* `destroy.targetSchema` link.
|
|
3685
|
+
*/
|
|
3346
3686
|
export interface PluginDestroyTargetSchema {
|
|
3347
3687
|
data: Plugin;
|
|
3348
3688
|
}
|
|
3349
|
-
/**
|
|
3689
|
+
/**
|
|
3690
|
+
* This interface was referenced by `Plugin`'s JSON-Schema via the
|
|
3691
|
+
* `fields.targetSchema` link.
|
|
3692
|
+
*/
|
|
3350
3693
|
export interface PluginFieldsTargetSchema {
|
|
3351
3694
|
data: Field[];
|
|
3352
3695
|
}
|
|
3353
3696
|
/**
|
|
3354
3697
|
* Some API endpoint give results asynchronously, returning the ID of a job.
|
|
3355
3698
|
*
|
|
3356
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3357
|
-
* "job_result".
|
|
3699
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3700
|
+
* `definition` "job_result".
|
|
3358
3701
|
*/
|
|
3359
3702
|
export interface JobResult {
|
|
3360
3703
|
type: JobResultType;
|
|
@@ -3364,7 +3707,8 @@ export interface JobResult {
|
|
|
3364
3707
|
/**
|
|
3365
3708
|
* JSON API attributes
|
|
3366
3709
|
*
|
|
3367
|
-
* This interface was referenced by `JobResult`'s JSON-Schema via the
|
|
3710
|
+
* This interface was referenced by `JobResult`'s JSON-Schema via the
|
|
3711
|
+
* `definition` "attributes".
|
|
3368
3712
|
*/
|
|
3369
3713
|
export interface JobResultAttributes {
|
|
3370
3714
|
/** Status of delayed HTTP response */
|
|
@@ -3383,13 +3727,16 @@ export interface JobResultData {
|
|
|
3383
3727
|
type: JobResultType;
|
|
3384
3728
|
id: JobResultIdentity;
|
|
3385
3729
|
}
|
|
3386
|
-
/**
|
|
3730
|
+
/**
|
|
3731
|
+
* This interface was referenced by `JobResult`'s JSON-Schema via the
|
|
3732
|
+
* `self.targetSchema` link.
|
|
3733
|
+
*/
|
|
3387
3734
|
export interface JobResultSelfTargetSchema {
|
|
3388
3735
|
data: JobResult;
|
|
3389
3736
|
}
|
|
3390
3737
|
/**
|
|
3391
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3392
|
-
* "subscription_limit".
|
|
3738
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3739
|
+
* `definition` "subscription_limit".
|
|
3393
3740
|
*/
|
|
3394
3741
|
export interface SubscriptionLimit {
|
|
3395
3742
|
type: SubscriptionLimitType;
|
|
@@ -3413,7 +3760,8 @@ export interface SubscriptionLimitAttributes {
|
|
|
3413
3760
|
/**
|
|
3414
3761
|
* JSON API data
|
|
3415
3762
|
*
|
|
3416
|
-
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
3763
|
+
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
3764
|
+
* `definition` "data".
|
|
3417
3765
|
*/
|
|
3418
3766
|
export interface SubscriptionLimitData {
|
|
3419
3767
|
type: SubscriptionLimitType;
|
|
@@ -3434,8 +3782,8 @@ export interface SubscriptionLimitSelfTargetSchema {
|
|
|
3434
3782
|
data: SubscriptionLimit;
|
|
3435
3783
|
}
|
|
3436
3784
|
/**
|
|
3437
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3438
|
-
* "subscription_feature".
|
|
3785
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3786
|
+
* `definition` "subscription_feature".
|
|
3439
3787
|
*/
|
|
3440
3788
|
export interface SubscriptionFeature {
|
|
3441
3789
|
type: SubscriptionFeatureType;
|
|
@@ -3476,8 +3824,8 @@ export interface SubscriptionFeatureInstancesTargetSchema {
|
|
|
3476
3824
|
/**
|
|
3477
3825
|
* Represents an event occurred during the deploy process of your administrative area.
|
|
3478
3826
|
*
|
|
3479
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3480
|
-
* "build_event".
|
|
3827
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3828
|
+
* `definition` "build_event".
|
|
3481
3829
|
*/
|
|
3482
3830
|
export interface BuildEvent {
|
|
3483
3831
|
type: BuildEventType;
|
|
@@ -3488,7 +3836,8 @@ export interface BuildEvent {
|
|
|
3488
3836
|
/**
|
|
3489
3837
|
* JSON API attributes
|
|
3490
3838
|
*
|
|
3491
|
-
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
3839
|
+
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
3840
|
+
* `definition` "attributes".
|
|
3492
3841
|
*/
|
|
3493
3842
|
export interface BuildEventAttributes {
|
|
3494
3843
|
/** The type of activity */
|
|
@@ -3512,8 +3861,8 @@ export interface BuildEventAttributes {
|
|
|
3512
3861
|
/**
|
|
3513
3862
|
* JSON API links
|
|
3514
3863
|
*
|
|
3515
|
-
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
3516
|
-
* "relationships".
|
|
3864
|
+
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
3865
|
+
* `definition` "relationships".
|
|
3517
3866
|
*/
|
|
3518
3867
|
export interface BuildEventRelationships {
|
|
3519
3868
|
/** Source build trigger */
|
|
@@ -3524,7 +3873,8 @@ export interface BuildEventRelationships {
|
|
|
3524
3873
|
/**
|
|
3525
3874
|
* JSON API data
|
|
3526
3875
|
*
|
|
3527
|
-
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
3876
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
3877
|
+
* `definition` "data".
|
|
3528
3878
|
*/
|
|
3529
3879
|
export interface BuildTriggerData {
|
|
3530
3880
|
type: BuildTriggerType;
|
|
@@ -3533,7 +3883,8 @@ export interface BuildTriggerData {
|
|
|
3533
3883
|
/**
|
|
3534
3884
|
* JSON API data
|
|
3535
3885
|
*
|
|
3536
|
-
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
3886
|
+
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
3887
|
+
* `definition` "data".
|
|
3537
3888
|
*/
|
|
3538
3889
|
export interface BuildEventData {
|
|
3539
3890
|
type: BuildEventType;
|
|
@@ -3546,16 +3897,20 @@ export interface BuildEventData {
|
|
|
3546
3897
|
export interface BuildEventInstancesTargetSchema {
|
|
3547
3898
|
data: BuildEvent[];
|
|
3548
3899
|
}
|
|
3549
|
-
/**
|
|
3900
|
+
/**
|
|
3901
|
+
* This interface was referenced by `BuildEvent`'s JSON-Schema via the
|
|
3902
|
+
* `self.targetSchema` link.
|
|
3903
|
+
*/
|
|
3550
3904
|
export interface BuildEventSelfTargetSchema {
|
|
3551
3905
|
data: BuildEvent;
|
|
3552
3906
|
}
|
|
3553
3907
|
/**
|
|
3554
|
-
* DatoCMS stores the individual pieces of content you create from a model as
|
|
3555
|
-
* which are much like table rows in a database. For
|
|
3556
|
-
* API refers to records as "items".
|
|
3908
|
+
* DatoCMS stores the individual pieces of content you create from a model as
|
|
3909
|
+
* records, which are much like table rows in a database. For
|
|
3910
|
+
* backward-compatibility reasons, the API refers to records as "items".
|
|
3557
3911
|
*
|
|
3558
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3912
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3913
|
+
* `definition` "item".
|
|
3559
3914
|
*/
|
|
3560
3915
|
export interface Item {
|
|
3561
3916
|
type: ItemType;
|
|
@@ -3567,7 +3922,8 @@ export interface Item {
|
|
|
3567
3922
|
/**
|
|
3568
3923
|
* The JSON data associated to the record
|
|
3569
3924
|
*
|
|
3570
|
-
* This interface was referenced by `Item`'s JSON-Schema via the `definition`
|
|
3925
|
+
* This interface was referenced by `Item`'s JSON-Schema via the `definition`
|
|
3926
|
+
* "attributes".
|
|
3571
3927
|
*/
|
|
3572
3928
|
export interface ItemAttributes {
|
|
3573
3929
|
[k: string]: unknown;
|
|
@@ -3575,7 +3931,8 @@ export interface ItemAttributes {
|
|
|
3575
3931
|
/**
|
|
3576
3932
|
* JSON API links
|
|
3577
3933
|
*
|
|
3578
|
-
* This interface was referenced by `Item`'s JSON-Schema via the `definition`
|
|
3934
|
+
* This interface was referenced by `Item`'s JSON-Schema via the `definition`
|
|
3935
|
+
* "relationships".
|
|
3579
3936
|
*/
|
|
3580
3937
|
export interface ItemRelationships {
|
|
3581
3938
|
/** The record's model */
|
|
@@ -3583,8 +3940,8 @@ export interface ItemRelationships {
|
|
|
3583
3940
|
data: ItemTypeData;
|
|
3584
3941
|
};
|
|
3585
3942
|
/**
|
|
3586
|
-
* The entity (account/collaborator/access token/sso user) who created the
|
|
3587
|
-
* must be an object with `type` (e.g. 'account') and `id` properties.
|
|
3943
|
+
* The entity (account/collaborator/access token/sso user) who created the
|
|
3944
|
+
* record. It must be an object with `type` (e.g. 'account') and `id` properties.
|
|
3588
3945
|
*/
|
|
3589
3946
|
creator?: {
|
|
3590
3947
|
data: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
@@ -3617,14 +3974,20 @@ export interface ItemMeta {
|
|
|
3617
3974
|
/** Workflow stage in which the item is */
|
|
3618
3975
|
stage: null | string;
|
|
3619
3976
|
}
|
|
3620
|
-
/**
|
|
3977
|
+
/**
|
|
3978
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
3979
|
+
* `instances.targetSchema` link.
|
|
3980
|
+
*/
|
|
3621
3981
|
export interface ItemInstancesTargetSchema {
|
|
3622
3982
|
data: Item[];
|
|
3623
3983
|
meta: {
|
|
3624
3984
|
total_count: number;
|
|
3625
3985
|
};
|
|
3626
3986
|
}
|
|
3627
|
-
/**
|
|
3987
|
+
/**
|
|
3988
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
3989
|
+
* `validate_existing.schema` link.
|
|
3990
|
+
*/
|
|
3628
3991
|
export interface ItemValidateExistingSchema {
|
|
3629
3992
|
data: {
|
|
3630
3993
|
id: ItemIdentity;
|
|
@@ -3638,8 +4001,8 @@ export interface ItemValidateExistingSchema {
|
|
|
3638
4001
|
data: ItemTypeData;
|
|
3639
4002
|
};
|
|
3640
4003
|
/**
|
|
3641
|
-
* The entity (account/collaborator/access token/sso user) who created the
|
|
3642
|
-
* It must be an object with `type` (e.g. 'account') and `id` properties.
|
|
4004
|
+
* The entity (account/collaborator/access token/sso user) who created the
|
|
4005
|
+
* record. It must be an object with `type` (e.g. 'account') and `id` properties.
|
|
3643
4006
|
*/
|
|
3644
4007
|
creator?: {
|
|
3645
4008
|
data: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
@@ -3647,7 +4010,10 @@ export interface ItemValidateExistingSchema {
|
|
|
3647
4010
|
};
|
|
3648
4011
|
};
|
|
3649
4012
|
}
|
|
3650
|
-
/**
|
|
4013
|
+
/**
|
|
4014
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4015
|
+
* `validate_new.schema` link.
|
|
4016
|
+
*/
|
|
3651
4017
|
export interface ItemValidateNewSchema {
|
|
3652
4018
|
data: {
|
|
3653
4019
|
type: ItemType;
|
|
@@ -3697,16 +4063,25 @@ export interface ItemCreateSchema {
|
|
|
3697
4063
|
};
|
|
3698
4064
|
};
|
|
3699
4065
|
}
|
|
3700
|
-
/**
|
|
4066
|
+
/**
|
|
4067
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4068
|
+
* `create.targetSchema` link.
|
|
4069
|
+
*/
|
|
3701
4070
|
export interface ItemCreateTargetSchema {
|
|
3702
4071
|
data: Item;
|
|
3703
4072
|
included: (ModelBlock | Item)[];
|
|
3704
4073
|
}
|
|
3705
|
-
/**
|
|
4074
|
+
/**
|
|
4075
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4076
|
+
* `duplicate.targetSchema` link.
|
|
4077
|
+
*/
|
|
3706
4078
|
export interface ItemDuplicateTargetSchema {
|
|
3707
4079
|
data: Job;
|
|
3708
4080
|
}
|
|
3709
|
-
/**
|
|
4081
|
+
/**
|
|
4082
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4083
|
+
* `duplicate.jobSchema` link.
|
|
4084
|
+
*/
|
|
3710
4085
|
export interface ItemDuplicateJobSchema {
|
|
3711
4086
|
data: Item;
|
|
3712
4087
|
included: ModelBlock[];
|
|
@@ -3750,12 +4125,18 @@ export interface ItemUpdateSchema {
|
|
|
3750
4125
|
};
|
|
3751
4126
|
};
|
|
3752
4127
|
}
|
|
3753
|
-
/**
|
|
4128
|
+
/**
|
|
4129
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4130
|
+
* `update.targetSchema` link.
|
|
4131
|
+
*/
|
|
3754
4132
|
export interface ItemUpdateTargetSchema {
|
|
3755
4133
|
data: Item;
|
|
3756
4134
|
included?: (ModelBlock | Item)[];
|
|
3757
4135
|
}
|
|
3758
|
-
/**
|
|
4136
|
+
/**
|
|
4137
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4138
|
+
* `references.targetSchema` link.
|
|
4139
|
+
*/
|
|
3759
4140
|
export interface ItemReferencesTargetSchema {
|
|
3760
4141
|
data: Item[];
|
|
3761
4142
|
}
|
|
@@ -3763,7 +4144,10 @@ export interface ItemReferencesTargetSchema {
|
|
|
3763
4144
|
export interface ItemSelfTargetSchema {
|
|
3764
4145
|
data: Item;
|
|
3765
4146
|
}
|
|
3766
|
-
/**
|
|
4147
|
+
/**
|
|
4148
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4149
|
+
* `destroy.targetSchema` link.
|
|
4150
|
+
*/
|
|
3767
4151
|
export interface ItemDestroyTargetSchema {
|
|
3768
4152
|
data: Job;
|
|
3769
4153
|
}
|
|
@@ -3771,11 +4155,17 @@ export interface ItemDestroyTargetSchema {
|
|
|
3771
4155
|
export interface ItemDestroyJobSchema {
|
|
3772
4156
|
data: Item;
|
|
3773
4157
|
}
|
|
3774
|
-
/**
|
|
4158
|
+
/**
|
|
4159
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4160
|
+
* `batch_destroy.targetSchema` link.
|
|
4161
|
+
*/
|
|
3775
4162
|
export interface ItemBatchDestroyTargetSchema {
|
|
3776
4163
|
data: Job;
|
|
3777
4164
|
}
|
|
3778
|
-
/**
|
|
4165
|
+
/**
|
|
4166
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4167
|
+
* `batch_destroy.jobSchema` link.
|
|
4168
|
+
*/
|
|
3779
4169
|
export interface ItemBatchDestroyJobSchema {
|
|
3780
4170
|
data: unknown[];
|
|
3781
4171
|
meta: {
|
|
@@ -3783,11 +4173,17 @@ export interface ItemBatchDestroyJobSchema {
|
|
|
3783
4173
|
failed: number;
|
|
3784
4174
|
};
|
|
3785
4175
|
}
|
|
3786
|
-
/**
|
|
4176
|
+
/**
|
|
4177
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4178
|
+
* `batch_publish.targetSchema` link.
|
|
4179
|
+
*/
|
|
3787
4180
|
export interface ItemBatchPublishTargetSchema {
|
|
3788
4181
|
data: Job;
|
|
3789
4182
|
}
|
|
3790
|
-
/**
|
|
4183
|
+
/**
|
|
4184
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4185
|
+
* `batch_publish.jobSchema` link.
|
|
4186
|
+
*/
|
|
3791
4187
|
export interface ItemBatchPublishJobSchema {
|
|
3792
4188
|
data: unknown[];
|
|
3793
4189
|
meta: {
|
|
@@ -3802,7 +4198,10 @@ export interface ItemBatchPublishJobSchema {
|
|
|
3802
4198
|
export interface ItemBatchUnpublishTargetSchema {
|
|
3803
4199
|
data: Job;
|
|
3804
4200
|
}
|
|
3805
|
-
/**
|
|
4201
|
+
/**
|
|
4202
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4203
|
+
* `batch_unpublish.jobSchema` link.
|
|
4204
|
+
*/
|
|
3806
4205
|
export interface ItemBatchUnpublishJobSchema {
|
|
3807
4206
|
data: unknown[];
|
|
3808
4207
|
meta: {
|
|
@@ -3810,17 +4209,26 @@ export interface ItemBatchUnpublishJobSchema {
|
|
|
3810
4209
|
failed: number;
|
|
3811
4210
|
};
|
|
3812
4211
|
}
|
|
3813
|
-
/**
|
|
4212
|
+
/**
|
|
4213
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4214
|
+
* `publish.targetSchema` link.
|
|
4215
|
+
*/
|
|
3814
4216
|
export interface ItemPublishTargetSchema {
|
|
3815
4217
|
data: Item;
|
|
3816
4218
|
included?: ModelBlock[];
|
|
3817
4219
|
}
|
|
3818
|
-
/**
|
|
4220
|
+
/**
|
|
4221
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4222
|
+
* `unpublish.targetSchema` link.
|
|
4223
|
+
*/
|
|
3819
4224
|
export interface ItemUnpublishTargetSchema {
|
|
3820
4225
|
data: Item;
|
|
3821
4226
|
included?: ModelBlock[];
|
|
3822
4227
|
}
|
|
3823
|
-
/**
|
|
4228
|
+
/**
|
|
4229
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4230
|
+
* `bulk_publish.schema` link.
|
|
4231
|
+
*/
|
|
3824
4232
|
export interface ItemBulkPublishSchema {
|
|
3825
4233
|
data: {
|
|
3826
4234
|
/** JSON API type field */
|
|
@@ -3834,11 +4242,17 @@ export interface ItemBulkPublishSchema {
|
|
|
3834
4242
|
};
|
|
3835
4243
|
};
|
|
3836
4244
|
}
|
|
3837
|
-
/**
|
|
4245
|
+
/**
|
|
4246
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4247
|
+
* `bulk_publish.targetSchema` link.
|
|
4248
|
+
*/
|
|
3838
4249
|
export interface ItemBulkPublishTargetSchema {
|
|
3839
4250
|
data: Job;
|
|
3840
4251
|
}
|
|
3841
|
-
/**
|
|
4252
|
+
/**
|
|
4253
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4254
|
+
* `bulk_publish.jobSchema` link.
|
|
4255
|
+
*/
|
|
3842
4256
|
export interface ItemBulkPublishJobSchema {
|
|
3843
4257
|
data: unknown[];
|
|
3844
4258
|
meta: {
|
|
@@ -3846,7 +4260,10 @@ export interface ItemBulkPublishJobSchema {
|
|
|
3846
4260
|
failed: number;
|
|
3847
4261
|
};
|
|
3848
4262
|
}
|
|
3849
|
-
/**
|
|
4263
|
+
/**
|
|
4264
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4265
|
+
* `bulk_unpublish.schema` link.
|
|
4266
|
+
*/
|
|
3850
4267
|
export interface ItemBulkUnpublishSchema {
|
|
3851
4268
|
data: {
|
|
3852
4269
|
/** JSON API type field */
|
|
@@ -3867,7 +4284,10 @@ export interface ItemBulkUnpublishSchema {
|
|
|
3867
4284
|
export interface ItemBulkUnpublishTargetSchema {
|
|
3868
4285
|
data: Job;
|
|
3869
4286
|
}
|
|
3870
|
-
/**
|
|
4287
|
+
/**
|
|
4288
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4289
|
+
* `bulk_unpublish.jobSchema` link.
|
|
4290
|
+
*/
|
|
3871
4291
|
export interface ItemBulkUnpublishJobSchema {
|
|
3872
4292
|
data: unknown[];
|
|
3873
4293
|
meta: {
|
|
@@ -3875,7 +4295,10 @@ export interface ItemBulkUnpublishJobSchema {
|
|
|
3875
4295
|
failed: number;
|
|
3876
4296
|
};
|
|
3877
4297
|
}
|
|
3878
|
-
/**
|
|
4298
|
+
/**
|
|
4299
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4300
|
+
* `bulk_destroy.schema` link.
|
|
4301
|
+
*/
|
|
3879
4302
|
export interface ItemBulkDestroySchema {
|
|
3880
4303
|
data: {
|
|
3881
4304
|
/** JSON API type field */
|
|
@@ -3889,11 +4312,17 @@ export interface ItemBulkDestroySchema {
|
|
|
3889
4312
|
};
|
|
3890
4313
|
};
|
|
3891
4314
|
}
|
|
3892
|
-
/**
|
|
4315
|
+
/**
|
|
4316
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4317
|
+
* `bulk_destroy.targetSchema` link.
|
|
4318
|
+
*/
|
|
3893
4319
|
export interface ItemBulkDestroyTargetSchema {
|
|
3894
4320
|
data: Job;
|
|
3895
4321
|
}
|
|
3896
|
-
/**
|
|
4322
|
+
/**
|
|
4323
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4324
|
+
* `bulk_destroy.jobSchema` link.
|
|
4325
|
+
*/
|
|
3897
4326
|
export interface ItemBulkDestroyJobSchema {
|
|
3898
4327
|
data: unknown[];
|
|
3899
4328
|
meta: {
|
|
@@ -3901,7 +4330,10 @@ export interface ItemBulkDestroyJobSchema {
|
|
|
3901
4330
|
failed: number;
|
|
3902
4331
|
};
|
|
3903
4332
|
}
|
|
3904
|
-
/**
|
|
4333
|
+
/**
|
|
4334
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
4335
|
+
* `bulk_move_to_stage.schema` link.
|
|
4336
|
+
*/
|
|
3905
4337
|
export interface ItemBulkMoveToStageSchema {
|
|
3906
4338
|
data: {
|
|
3907
4339
|
/** JSON API type field */
|
|
@@ -3940,8 +4372,8 @@ export interface ItemBulkMoveToStageJobSchema {
|
|
|
3940
4372
|
/**
|
|
3941
4373
|
* Every change to a record is stored as a separate record version in DatoCMS.
|
|
3942
4374
|
*
|
|
3943
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
3944
|
-
* "item_version".
|
|
4375
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4376
|
+
* `definition` "item_version".
|
|
3945
4377
|
*/
|
|
3946
4378
|
export interface ItemVersion {
|
|
3947
4379
|
type: ItemVersionType;
|
|
@@ -3953,7 +4385,8 @@ export interface ItemVersion {
|
|
|
3953
4385
|
/**
|
|
3954
4386
|
* The JSON data associated to the record version
|
|
3955
4387
|
*
|
|
3956
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4388
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4389
|
+
* `definition` "attributes".
|
|
3957
4390
|
*/
|
|
3958
4391
|
export interface ItemVersionAttributes {
|
|
3959
4392
|
[k: string]: unknown;
|
|
@@ -3961,8 +4394,8 @@ export interface ItemVersionAttributes {
|
|
|
3961
4394
|
/**
|
|
3962
4395
|
* JSON API links
|
|
3963
4396
|
*
|
|
3964
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
3965
|
-
* "relationships".
|
|
4397
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4398
|
+
* `definition` "relationships".
|
|
3966
4399
|
*/
|
|
3967
4400
|
export interface ItemVersionRelationships {
|
|
3968
4401
|
/** The record version's model */
|
|
@@ -3974,8 +4407,9 @@ export interface ItemVersionRelationships {
|
|
|
3974
4407
|
data: ItemData;
|
|
3975
4408
|
};
|
|
3976
4409
|
/**
|
|
3977
|
-
* The entity (account/collaborator/access token/sso user) who made this
|
|
3978
|
-
* record. It must be an object with `type` (e.g. 'account') and
|
|
4410
|
+
* The entity (account/collaborator/access token/sso user) who made this
|
|
4411
|
+
* change to the record. It must be an object with `type` (e.g. 'account') and
|
|
4412
|
+
* `id` properties.
|
|
3979
4413
|
*/
|
|
3980
4414
|
editor: {
|
|
3981
4415
|
data: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
@@ -3984,7 +4418,8 @@ export interface ItemVersionRelationships {
|
|
|
3984
4418
|
/**
|
|
3985
4419
|
* Meta information regarding the record version
|
|
3986
4420
|
*
|
|
3987
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4421
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4422
|
+
* `definition` "meta".
|
|
3988
4423
|
*/
|
|
3989
4424
|
export interface ItemVersionMeta {
|
|
3990
4425
|
/** Date of record version creation */
|
|
@@ -3999,7 +4434,8 @@ export interface ItemVersionMeta {
|
|
|
3999
4434
|
/**
|
|
4000
4435
|
* JSON API data
|
|
4001
4436
|
*
|
|
4002
|
-
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4437
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4438
|
+
* `definition` "data".
|
|
4003
4439
|
*/
|
|
4004
4440
|
export interface ItemVersionData {
|
|
4005
4441
|
type: ItemVersionType;
|
|
@@ -4012,7 +4448,10 @@ export interface ItemVersionData {
|
|
|
4012
4448
|
export interface ItemVersionRestoreTargetSchema {
|
|
4013
4449
|
data: Job;
|
|
4014
4450
|
}
|
|
4015
|
-
/**
|
|
4451
|
+
/**
|
|
4452
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4453
|
+
* `restore.jobSchema` link.
|
|
4454
|
+
*/
|
|
4016
4455
|
export interface ItemVersionRestoreJobSchema {
|
|
4017
4456
|
data: [Item, ItemVersion];
|
|
4018
4457
|
}
|
|
@@ -4026,7 +4465,10 @@ export interface ItemVersionInstancesTargetSchema {
|
|
|
4026
4465
|
[k: string]: unknown;
|
|
4027
4466
|
};
|
|
4028
4467
|
}
|
|
4029
|
-
/**
|
|
4468
|
+
/**
|
|
4469
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
4470
|
+
* `self.targetSchema` link.
|
|
4471
|
+
*/
|
|
4030
4472
|
export interface ItemVersionSelfTargetSchema {
|
|
4031
4473
|
data: ItemVersion;
|
|
4032
4474
|
meta?: {
|
|
@@ -4036,7 +4478,8 @@ export interface ItemVersionSelfTargetSchema {
|
|
|
4036
4478
|
/**
|
|
4037
4479
|
* Every file you upload to DatoCMS will be retrievable from this endpoint.
|
|
4038
4480
|
*
|
|
4039
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4481
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4482
|
+
* `definition` "upload".
|
|
4040
4483
|
*/
|
|
4041
4484
|
export interface Upload {
|
|
4042
4485
|
type: UploadType;
|
|
@@ -4047,7 +4490,8 @@ export interface Upload {
|
|
|
4047
4490
|
/**
|
|
4048
4491
|
* JSON API attributes
|
|
4049
4492
|
*
|
|
4050
|
-
* This interface was referenced by `Upload`'s JSON-Schema via the `definition`
|
|
4493
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the `definition`
|
|
4494
|
+
* "attributes".
|
|
4051
4495
|
*/
|
|
4052
4496
|
export interface UploadAttributes {
|
|
4053
4497
|
/** Size of the upload */
|
|
@@ -4080,18 +4524,21 @@ export interface UploadAttributes {
|
|
|
4080
4524
|
frame_rate: number | null;
|
|
4081
4525
|
/** Blurhash for the asset */
|
|
4082
4526
|
blurhash: string | null;
|
|
4083
|
-
/**
|
|
4527
|
+
/**
|
|
4528
|
+
* Public Mux playback ID. Used with stream.mux.com to create the source URL
|
|
4529
|
+
* for a video player.
|
|
4530
|
+
*/
|
|
4084
4531
|
mux_playback_id: string | null;
|
|
4085
4532
|
/** Maximum quality of MP4 rendition available */
|
|
4086
4533
|
mux_mp4_highest_res: null | 'high' | 'medium' | 'low';
|
|
4087
4534
|
/**
|
|
4088
|
-
* For each of the project's locales, the default metadata to apply if nothing
|
|
4089
|
-
* specified at record's level.
|
|
4535
|
+
* For each of the project's locales, the default metadata to apply if nothing
|
|
4536
|
+
* is specified at record's level.
|
|
4090
4537
|
*/
|
|
4091
4538
|
default_field_metadata: {
|
|
4092
4539
|
/**
|
|
4093
|
-
* This interface was referenced by `undefined`'s JSON-Schema definition via
|
|
4094
|
-
* `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
|
|
4540
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition via
|
|
4541
|
+
* the `patternProperty` "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
|
|
4095
4542
|
*/
|
|
4096
4543
|
[k: string]: {
|
|
4097
4544
|
/** Alternate text for the asset */
|
|
@@ -4142,12 +4589,13 @@ export interface UploadAttributes {
|
|
|
4142
4589
|
/**
|
|
4143
4590
|
* JSON API links
|
|
4144
4591
|
*
|
|
4145
|
-
* This interface was referenced by `Upload`'s JSON-Schema via the `definition`
|
|
4592
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the `definition`
|
|
4593
|
+
* "relationships".
|
|
4146
4594
|
*/
|
|
4147
4595
|
export interface UploadRelationships {
|
|
4148
4596
|
/**
|
|
4149
|
-
* The entity (account/collaborator/access token) who created the asset. It
|
|
4150
|
-
* object with `type` (e.g. 'account') and `id` properties.
|
|
4597
|
+
* The entity (account/collaborator/access token) who created the asset. It
|
|
4598
|
+
* must be an object with `type` (e.g. 'account') and `id` properties.
|
|
4151
4599
|
*/
|
|
4152
4600
|
creator: {
|
|
4153
4601
|
data: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
@@ -4176,13 +4624,14 @@ export interface UploadCreateSchema {
|
|
|
4176
4624
|
/** Notes */
|
|
4177
4625
|
notes?: string | null;
|
|
4178
4626
|
/**
|
|
4179
|
-
* For each of the project's locales, the default metadata to apply if
|
|
4180
|
-
* specified at record's level.
|
|
4627
|
+
* For each of the project's locales, the default metadata to apply if
|
|
4628
|
+
* nothing is specified at record's level.
|
|
4181
4629
|
*/
|
|
4182
4630
|
default_field_metadata?: {
|
|
4183
4631
|
/**
|
|
4184
|
-
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
4185
|
-
* `patternProperty`
|
|
4632
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
4633
|
+
* via the `patternProperty`
|
|
4634
|
+
* "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
|
|
4186
4635
|
*/
|
|
4187
4636
|
[k: string]: {
|
|
4188
4637
|
/** Alternate text for the asset */
|
|
@@ -4208,26 +4657,41 @@ export interface UploadCreateSchema {
|
|
|
4208
4657
|
};
|
|
4209
4658
|
};
|
|
4210
4659
|
}
|
|
4211
|
-
/**
|
|
4660
|
+
/**
|
|
4661
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4662
|
+
* `create.targetSchema` link.
|
|
4663
|
+
*/
|
|
4212
4664
|
export interface UploadCreateTargetSchema {
|
|
4213
4665
|
data: Job;
|
|
4214
4666
|
}
|
|
4215
|
-
/**
|
|
4667
|
+
/**
|
|
4668
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4669
|
+
* `create.jobSchema` link.
|
|
4670
|
+
*/
|
|
4216
4671
|
export interface UploadCreateJobSchema {
|
|
4217
4672
|
data: Upload;
|
|
4218
4673
|
}
|
|
4219
|
-
/**
|
|
4674
|
+
/**
|
|
4675
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4676
|
+
* `instances.targetSchema` link.
|
|
4677
|
+
*/
|
|
4220
4678
|
export interface UploadInstancesTargetSchema {
|
|
4221
4679
|
data: Upload[];
|
|
4222
4680
|
meta?: {
|
|
4223
4681
|
total_count: number;
|
|
4224
4682
|
};
|
|
4225
4683
|
}
|
|
4226
|
-
/**
|
|
4684
|
+
/**
|
|
4685
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4686
|
+
* `self.targetSchema` link.
|
|
4687
|
+
*/
|
|
4227
4688
|
export interface UploadSelfTargetSchema {
|
|
4228
4689
|
data: Upload;
|
|
4229
4690
|
}
|
|
4230
|
-
/**
|
|
4691
|
+
/**
|
|
4692
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4693
|
+
* `destroy.targetSchema` link.
|
|
4694
|
+
*/
|
|
4231
4695
|
export interface UploadDestroyTargetSchema {
|
|
4232
4696
|
data: Upload;
|
|
4233
4697
|
}
|
|
@@ -4250,13 +4714,14 @@ export interface UploadUpdateSchema {
|
|
|
4250
4714
|
/** Tags */
|
|
4251
4715
|
tags?: string[];
|
|
4252
4716
|
/**
|
|
4253
|
-
* For each of the project's locales, the default metadata to apply if
|
|
4254
|
-
* specified at record's level.
|
|
4717
|
+
* For each of the project's locales, the default metadata to apply if
|
|
4718
|
+
* nothing is specified at record's level.
|
|
4255
4719
|
*/
|
|
4256
4720
|
default_field_metadata?: {
|
|
4257
4721
|
/**
|
|
4258
|
-
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
4259
|
-
* `patternProperty`
|
|
4722
|
+
* This interface was referenced by `undefined`'s JSON-Schema definition
|
|
4723
|
+
* via the `patternProperty`
|
|
4724
|
+
* "^(?<languagecode>[a-z]{0,3}(-[A-Za-z]+)?(-[A-Z]{0,3})?)$".
|
|
4260
4725
|
*/
|
|
4261
4726
|
[k: string]: {
|
|
4262
4727
|
/** Alternate text for the asset */
|
|
@@ -4280,8 +4745,8 @@ export interface UploadUpdateSchema {
|
|
|
4280
4745
|
};
|
|
4281
4746
|
relationships?: {
|
|
4282
4747
|
/**
|
|
4283
|
-
* The entity (account/collaborator/access token) who created the asset.
|
|
4284
|
-
* an object with `type` (e.g. 'account') and `id` properties.
|
|
4748
|
+
* The entity (account/collaborator/access token) who created the asset.
|
|
4749
|
+
* It must be an object with `type` (e.g. 'account') and `id` properties.
|
|
4285
4750
|
*/
|
|
4286
4751
|
creator: {
|
|
4287
4752
|
data: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
@@ -4289,15 +4754,24 @@ export interface UploadUpdateSchema {
|
|
|
4289
4754
|
};
|
|
4290
4755
|
};
|
|
4291
4756
|
}
|
|
4292
|
-
/**
|
|
4757
|
+
/**
|
|
4758
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4759
|
+
* `update.targetSchema` link.
|
|
4760
|
+
*/
|
|
4293
4761
|
export interface UploadUpdateTargetSchema {
|
|
4294
4762
|
data: Job;
|
|
4295
4763
|
}
|
|
4296
|
-
/**
|
|
4764
|
+
/**
|
|
4765
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4766
|
+
* `update.jobSchema` link.
|
|
4767
|
+
*/
|
|
4297
4768
|
export interface UploadUpdateJobSchema {
|
|
4298
4769
|
data: Upload;
|
|
4299
4770
|
}
|
|
4300
|
-
/**
|
|
4771
|
+
/**
|
|
4772
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4773
|
+
* `batch_add_tags.schema` link.
|
|
4774
|
+
*/
|
|
4301
4775
|
export interface UploadBatchAddTagsSchema {
|
|
4302
4776
|
data: {
|
|
4303
4777
|
type: UploadType;
|
|
@@ -4314,7 +4788,10 @@ export interface UploadBatchAddTagsSchema {
|
|
|
4314
4788
|
export interface UploadBatchAddTagsTargetSchema {
|
|
4315
4789
|
data: Job;
|
|
4316
4790
|
}
|
|
4317
|
-
/**
|
|
4791
|
+
/**
|
|
4792
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4793
|
+
* `batch_add_tags.jobSchema` link.
|
|
4794
|
+
*/
|
|
4318
4795
|
export interface UploadBatchAddTagsJobSchema {
|
|
4319
4796
|
data: unknown[];
|
|
4320
4797
|
meta: {
|
|
@@ -4329,7 +4806,10 @@ export interface UploadBatchAddTagsJobSchema {
|
|
|
4329
4806
|
export interface UploadBatchDestroyTargetSchema {
|
|
4330
4807
|
data: Job;
|
|
4331
4808
|
}
|
|
4332
|
-
/**
|
|
4809
|
+
/**
|
|
4810
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4811
|
+
* `batch_destroy.jobSchema` link.
|
|
4812
|
+
*/
|
|
4333
4813
|
export interface UploadBatchDestroyJobSchema {
|
|
4334
4814
|
data: unknown[];
|
|
4335
4815
|
meta: {
|
|
@@ -4337,7 +4817,10 @@ export interface UploadBatchDestroyJobSchema {
|
|
|
4337
4817
|
failed: number;
|
|
4338
4818
|
};
|
|
4339
4819
|
}
|
|
4340
|
-
/**
|
|
4820
|
+
/**
|
|
4821
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4822
|
+
* `references.targetSchema` link.
|
|
4823
|
+
*/
|
|
4341
4824
|
export interface UploadReferencesTargetSchema {
|
|
4342
4825
|
data: Item;
|
|
4343
4826
|
}
|
|
@@ -4359,11 +4842,17 @@ export interface UploadBulkTagSchema {
|
|
|
4359
4842
|
};
|
|
4360
4843
|
};
|
|
4361
4844
|
}
|
|
4362
|
-
/**
|
|
4845
|
+
/**
|
|
4846
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4847
|
+
* `bulk_tag.targetSchema` link.
|
|
4848
|
+
*/
|
|
4363
4849
|
export interface UploadBulkTagTargetSchema {
|
|
4364
4850
|
data: Job;
|
|
4365
4851
|
}
|
|
4366
|
-
/**
|
|
4852
|
+
/**
|
|
4853
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4854
|
+
* `bulk_tag.jobSchema` link.
|
|
4855
|
+
*/
|
|
4367
4856
|
export interface UploadBulkTagJobSchema {
|
|
4368
4857
|
data: unknown[];
|
|
4369
4858
|
meta: {
|
|
@@ -4371,7 +4860,10 @@ export interface UploadBulkTagJobSchema {
|
|
|
4371
4860
|
failed: number;
|
|
4372
4861
|
};
|
|
4373
4862
|
}
|
|
4374
|
-
/**
|
|
4863
|
+
/**
|
|
4864
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4865
|
+
* `bulk_destroy.schema` link.
|
|
4866
|
+
*/
|
|
4375
4867
|
export interface UploadBulkDestroySchema {
|
|
4376
4868
|
data: {
|
|
4377
4869
|
/** JSON API type field */
|
|
@@ -4391,7 +4883,10 @@ export interface UploadBulkDestroySchema {
|
|
|
4391
4883
|
export interface UploadBulkDestroyTargetSchema {
|
|
4392
4884
|
data: Job;
|
|
4393
4885
|
}
|
|
4394
|
-
/**
|
|
4886
|
+
/**
|
|
4887
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4888
|
+
* `bulk_destroy.jobSchema` link.
|
|
4889
|
+
*/
|
|
4395
4890
|
export interface UploadBulkDestroyJobSchema {
|
|
4396
4891
|
data: unknown[];
|
|
4397
4892
|
meta: {
|
|
@@ -4400,12 +4895,12 @@ export interface UploadBulkDestroyJobSchema {
|
|
|
4400
4895
|
};
|
|
4401
4896
|
}
|
|
4402
4897
|
/**
|
|
4403
|
-
* To upload a file in DatoCMS, first you need to obtain an upload permission
|
|
4404
|
-
* this API endpoint. The response will contain the S3 URL where you
|
|
4405
|
-
* upload the file with a direct PUT request.
|
|
4898
|
+
* To upload a file in DatoCMS, first you need to obtain an upload permission
|
|
4899
|
+
* through this API endpoint. The response will contain the S3 URL where you
|
|
4900
|
+
* will be able to upload the file with a direct PUT request.
|
|
4406
4901
|
*
|
|
4407
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4408
|
-
* "upload_request".
|
|
4902
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4903
|
+
* `definition` "upload_request".
|
|
4409
4904
|
*/
|
|
4410
4905
|
export interface UploadRequest {
|
|
4411
4906
|
type: UploadRequestType;
|
|
@@ -4415,15 +4910,18 @@ export interface UploadRequest {
|
|
|
4415
4910
|
/**
|
|
4416
4911
|
* JSON API attributes
|
|
4417
4912
|
*
|
|
4418
|
-
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
4419
|
-
* "attributes".
|
|
4913
|
+
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
4914
|
+
* `definition` "attributes".
|
|
4420
4915
|
*/
|
|
4421
4916
|
export interface UploadRequestAttributes {
|
|
4422
4917
|
/** The URL to use to upload the file with a direct PUT request */
|
|
4423
4918
|
url: string;
|
|
4424
4919
|
[k: string]: unknown;
|
|
4425
4920
|
}
|
|
4426
|
-
/**
|
|
4921
|
+
/**
|
|
4922
|
+
* This interface was referenced by `UploadRequest`'s JSON-Schema via the
|
|
4923
|
+
* `create.schema` link.
|
|
4924
|
+
*/
|
|
4427
4925
|
export interface UploadRequestCreateSchema {
|
|
4428
4926
|
data: {
|
|
4429
4927
|
type: UploadRequestType;
|
|
@@ -4445,8 +4943,8 @@ export interface UploadRequestCreateTargetSchema {
|
|
|
4445
4943
|
/**
|
|
4446
4944
|
* You can create scheduled publication to publish records in the future
|
|
4447
4945
|
*
|
|
4448
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4449
|
-
* "scheduled_publication".
|
|
4946
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4947
|
+
* `definition` "scheduled_publication".
|
|
4450
4948
|
*/
|
|
4451
4949
|
export interface ScheduledPublication {
|
|
4452
4950
|
type: ScheduledPublicationType;
|
|
@@ -4514,8 +5012,8 @@ export interface ScheduledPublicationDestroyTargetSchema {
|
|
|
4514
5012
|
/**
|
|
4515
5013
|
* You can create a scheduled unpublishing to unpublish records in the future
|
|
4516
5014
|
*
|
|
4517
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4518
|
-
* "scheduled_unpublishing".
|
|
5015
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5016
|
+
* `definition` "scheduled_unpublishing".
|
|
4519
5017
|
*/
|
|
4520
5018
|
export interface ScheduledUnpublishing {
|
|
4521
5019
|
type: ScheduledUnpublishingType;
|
|
@@ -4526,8 +5024,8 @@ export interface ScheduledUnpublishing {
|
|
|
4526
5024
|
/**
|
|
4527
5025
|
* JSON API attributes
|
|
4528
5026
|
*
|
|
4529
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
4530
|
-
* `definition` "attributes".
|
|
5027
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
5028
|
+
* the `definition` "attributes".
|
|
4531
5029
|
*/
|
|
4532
5030
|
export interface ScheduledUnpublishingAttributes {
|
|
4533
5031
|
/** The future date for the unpublishing */
|
|
@@ -4536,8 +5034,8 @@ export interface ScheduledUnpublishingAttributes {
|
|
|
4536
5034
|
/**
|
|
4537
5035
|
* JSON API links
|
|
4538
5036
|
*
|
|
4539
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
4540
|
-
* `definition` "relationships".
|
|
5037
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
5038
|
+
* the `definition` "relationships".
|
|
4541
5039
|
*/
|
|
4542
5040
|
export interface ScheduledUnpublishingRelationships {
|
|
4543
5041
|
/** Item */
|
|
@@ -4548,16 +5046,16 @@ export interface ScheduledUnpublishingRelationships {
|
|
|
4548
5046
|
/**
|
|
4549
5047
|
* JSON API data
|
|
4550
5048
|
*
|
|
4551
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
4552
|
-
* `definition` "data".
|
|
5049
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
5050
|
+
* the `definition` "data".
|
|
4553
5051
|
*/
|
|
4554
5052
|
export interface ScheduledUnpublishingData {
|
|
4555
5053
|
type: ScheduledUnpublishingType;
|
|
4556
5054
|
id: ScheduledUnpublishingIdentity;
|
|
4557
5055
|
}
|
|
4558
5056
|
/**
|
|
4559
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
4560
|
-
* `create.schema` link.
|
|
5057
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
5058
|
+
* the `create.schema` link.
|
|
4561
5059
|
*/
|
|
4562
5060
|
export interface ScheduledUnpublishingCreateSchema {
|
|
4563
5061
|
data: {
|
|
@@ -4566,26 +5064,26 @@ export interface ScheduledUnpublishingCreateSchema {
|
|
|
4566
5064
|
};
|
|
4567
5065
|
}
|
|
4568
5066
|
/**
|
|
4569
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
4570
|
-
* `create.targetSchema` link.
|
|
5067
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
5068
|
+
* the `create.targetSchema` link.
|
|
4571
5069
|
*/
|
|
4572
5070
|
export interface ScheduledUnpublishingCreateTargetSchema {
|
|
4573
5071
|
data: ScheduledUnpublishing;
|
|
4574
5072
|
included: Item[];
|
|
4575
5073
|
}
|
|
4576
5074
|
/**
|
|
4577
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
4578
|
-
* `destroy.targetSchema` link.
|
|
5075
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via
|
|
5076
|
+
* the `destroy.targetSchema` link.
|
|
4579
5077
|
*/
|
|
4580
5078
|
export interface ScheduledUnpublishingDestroyTargetSchema {
|
|
4581
5079
|
data: Item;
|
|
4582
5080
|
}
|
|
4583
5081
|
/**
|
|
4584
|
-
* DatoCMS Site Search is a way to deliver tailored search results to your site
|
|
4585
|
-
* This is the endpoint you can use to query for results.
|
|
5082
|
+
* DatoCMS Site Search is a way to deliver tailored search results to your site
|
|
5083
|
+
* visitors. This is the endpoint you can use to query for results.
|
|
4586
5084
|
*
|
|
4587
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4588
|
-
* "search_result".
|
|
5085
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5086
|
+
* `definition` "search_result".
|
|
4589
5087
|
*/
|
|
4590
5088
|
export interface SearchResult {
|
|
4591
5089
|
type: SearchResultType;
|
|
@@ -4595,7 +5093,8 @@ export interface SearchResult {
|
|
|
4595
5093
|
/**
|
|
4596
5094
|
* JSON API attributes
|
|
4597
5095
|
*
|
|
4598
|
-
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
5096
|
+
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
5097
|
+
* `definition` "attributes".
|
|
4599
5098
|
*/
|
|
4600
5099
|
export interface SearchResultAttributes {
|
|
4601
5100
|
/** Page title */
|
|
@@ -4614,7 +5113,8 @@ export interface SearchResultAttributes {
|
|
|
4614
5113
|
/**
|
|
4615
5114
|
* JSON API data
|
|
4616
5115
|
*
|
|
4617
|
-
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
5116
|
+
* This interface was referenced by `SearchResult`'s JSON-Schema via the
|
|
5117
|
+
* `definition` "data".
|
|
4618
5118
|
*/
|
|
4619
5119
|
export interface SearchResultData {
|
|
4620
5120
|
type: SearchResultType;
|
|
@@ -4632,20 +5132,22 @@ export interface SearchResultInstancesTargetSchema {
|
|
|
4632
5132
|
}
|
|
4633
5133
|
/**
|
|
4634
5134
|
* [Environments](https://www.datocms.com/docs/general-concepts/primary-and-sandbox-environments)
|
|
4635
|
-
* make it easier for your development team to **manage and maintain content
|
|
4636
|
-
* once your content has been published**. You can think of
|
|
4637
|
-
* branches: great for testing, development and
|
|
5135
|
+
* make it easier for your development team to **manage and maintain content
|
|
5136
|
+
* structure once your content has been published**. You can think of
|
|
5137
|
+
* environments like code branches: great for testing, development and
|
|
5138
|
+
* pre-production environments.
|
|
4638
5139
|
*
|
|
4639
|
-
* By default, every project has one environment, called **primary
|
|
4640
|
-
* is meant to be used for the regular editorial workflow.
|
|
4641
|
-
* **sandbox environments** can be created by developers
|
|
4642
|
-
* changes in the content.
|
|
5140
|
+
* By default, every project has one environment, called **primary
|
|
5141
|
+
* environment**, which is meant to be used for the regular editorial workflow.
|
|
5142
|
+
* Additionally, multiple **sandbox environments** can be created by developers
|
|
5143
|
+
* to safely test/experiment new changes in the content.
|
|
4643
5144
|
*
|
|
4644
|
-
* Sandbox environments start out as **exact copies of one of the existing
|
|
4645
|
-
* (ie. the primary one). The process of creating a new sandbox
|
|
4646
|
-
* existing environment is called fork.
|
|
5145
|
+
* Sandbox environments start out as **exact copies of one of the existing
|
|
5146
|
+
* environments** (ie. the primary one). The process of creating a new sandbox
|
|
5147
|
+
* starting off from an existing environment is called fork.
|
|
4647
5148
|
*
|
|
4648
|
-
* Each environment is identified by a name (ie. `master`) and stores the
|
|
5149
|
+
* Each environment is identified by a name (ie. `master`) and stores the
|
|
5150
|
+
* following information:
|
|
4649
5151
|
*
|
|
4650
5152
|
* - Models
|
|
4651
5153
|
* - Records
|
|
@@ -4660,8 +5162,8 @@ export interface SearchResultInstancesTargetSchema {
|
|
|
4660
5162
|
* including the primary environment, **the data in all other environments isn’t
|
|
4661
5163
|
* affected** and stays the same.
|
|
4662
5164
|
*
|
|
4663
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4664
|
-
* "environment".
|
|
5165
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5166
|
+
* `definition` "environment".
|
|
4665
5167
|
*/
|
|
4666
5168
|
export interface Environment {
|
|
4667
5169
|
type: EnvironmentType;
|
|
@@ -4671,7 +5173,8 @@ export interface Environment {
|
|
|
4671
5173
|
/**
|
|
4672
5174
|
* Meta attributes
|
|
4673
5175
|
*
|
|
4674
|
-
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5176
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5177
|
+
* `definition` "meta".
|
|
4675
5178
|
*/
|
|
4676
5179
|
export interface EnvironmentMeta {
|
|
4677
5180
|
/** Status of the environment */
|
|
@@ -4686,13 +5189,17 @@ export interface EnvironmentMeta {
|
|
|
4686
5189
|
/**
|
|
4687
5190
|
* JSON API data
|
|
4688
5191
|
*
|
|
4689
|
-
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5192
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5193
|
+
* `definition` "data".
|
|
4690
5194
|
*/
|
|
4691
5195
|
export interface EnvironmentData {
|
|
4692
5196
|
type: EnvironmentType;
|
|
4693
5197
|
id: EnvironmentIdentity;
|
|
4694
5198
|
}
|
|
4695
|
-
/**
|
|
5199
|
+
/**
|
|
5200
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5201
|
+
* `fork.schema` link.
|
|
5202
|
+
*/
|
|
4696
5203
|
export interface EnvironmentForkSchema {
|
|
4697
5204
|
data: {
|
|
4698
5205
|
type: EnvironmentType;
|
|
@@ -4700,11 +5207,17 @@ export interface EnvironmentForkSchema {
|
|
|
4700
5207
|
id: string;
|
|
4701
5208
|
};
|
|
4702
5209
|
}
|
|
4703
|
-
/**
|
|
5210
|
+
/**
|
|
5211
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5212
|
+
* `fork.targetSchema` link.
|
|
5213
|
+
*/
|
|
4704
5214
|
export interface EnvironmentForkTargetSchema {
|
|
4705
5215
|
data: Job | Environment;
|
|
4706
5216
|
}
|
|
4707
|
-
/**
|
|
5217
|
+
/**
|
|
5218
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5219
|
+
* `fork.jobSchema` link.
|
|
5220
|
+
*/
|
|
4708
5221
|
export interface EnvironmentForkJobSchema {
|
|
4709
5222
|
data: Environment;
|
|
4710
5223
|
}
|
|
@@ -4722,7 +5235,10 @@ export interface EnvironmentPromoteTargetSchema {
|
|
|
4722
5235
|
export interface EnvironmentInstancesTargetSchema {
|
|
4723
5236
|
data: Environment[];
|
|
4724
5237
|
}
|
|
4725
|
-
/**
|
|
5238
|
+
/**
|
|
5239
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5240
|
+
* `self.targetSchema` link.
|
|
5241
|
+
*/
|
|
4726
5242
|
export interface EnvironmentSelfTargetSchema {
|
|
4727
5243
|
data: Environment;
|
|
4728
5244
|
}
|
|
@@ -4733,13 +5249,16 @@ export interface EnvironmentSelfTargetSchema {
|
|
|
4733
5249
|
export interface EnvironmentDestroyTargetSchema {
|
|
4734
5250
|
data: Job | Environment;
|
|
4735
5251
|
}
|
|
4736
|
-
/**
|
|
5252
|
+
/**
|
|
5253
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
5254
|
+
* `destroy.jobSchema` link.
|
|
5255
|
+
*/
|
|
4737
5256
|
export interface EnvironmentDestroyJobSchema {
|
|
4738
5257
|
data: Environment;
|
|
4739
5258
|
}
|
|
4740
5259
|
/**
|
|
4741
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4742
|
-
* "maintenance_mode".
|
|
5260
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5261
|
+
* `definition` "maintenance_mode".
|
|
4743
5262
|
*/
|
|
4744
5263
|
export interface MaintenanceMode {
|
|
4745
5264
|
type: MaintenanceModeType;
|
|
@@ -4749,8 +5268,8 @@ export interface MaintenanceMode {
|
|
|
4749
5268
|
/**
|
|
4750
5269
|
* JSON API attributes
|
|
4751
5270
|
*
|
|
4752
|
-
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
4753
|
-
* "attributes".
|
|
5271
|
+
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
5272
|
+
* `definition` "attributes".
|
|
4754
5273
|
*/
|
|
4755
5274
|
export interface MaintenanceModeAttributes {
|
|
4756
5275
|
/** Whether maintenance mode is currently active or not */
|
|
@@ -4759,7 +5278,8 @@ export interface MaintenanceModeAttributes {
|
|
|
4759
5278
|
/**
|
|
4760
5279
|
* JSON API data
|
|
4761
5280
|
*
|
|
4762
|
-
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
5281
|
+
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the
|
|
5282
|
+
* `definition` "data".
|
|
4763
5283
|
*/
|
|
4764
5284
|
export interface MaintenanceModeData {
|
|
4765
5285
|
type: MaintenanceModeType;
|
|
@@ -4787,10 +5307,11 @@ export interface MaintenanceModeDeactivateTargetSchema {
|
|
|
4787
5307
|
data: MaintenanceMode;
|
|
4788
5308
|
}
|
|
4789
5309
|
/**
|
|
4790
|
-
* A webhook allows to make requests following certain Dato events. It is linked
|
|
4791
|
-
* Role, which describes what actions can be performed.
|
|
5310
|
+
* A webhook allows to make requests following certain Dato events. It is linked
|
|
5311
|
+
* to a Role, which describes what actions can be performed.
|
|
4792
5312
|
*
|
|
4793
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5313
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5314
|
+
* `definition` "webhook".
|
|
4794
5315
|
*/
|
|
4795
5316
|
export interface Webhook {
|
|
4796
5317
|
type: WebhookType;
|
|
@@ -4800,7 +5321,8 @@ export interface Webhook {
|
|
|
4800
5321
|
/**
|
|
4801
5322
|
* JSON API attributes
|
|
4802
5323
|
*
|
|
4803
|
-
* This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
|
|
5324
|
+
* This interface was referenced by `Webhook`'s JSON-Schema via the `definition`
|
|
5325
|
+
* "attributes".
|
|
4804
5326
|
*/
|
|
4805
5327
|
export interface WebhookAttributes {
|
|
4806
5328
|
/** Unique name for the webhook */
|
|
@@ -4858,14 +5380,23 @@ export interface WebhookCreateSchema {
|
|
|
4858
5380
|
http_basic_password: string | null;
|
|
4859
5381
|
/** Whether the webhook is enabled and sending events or not */
|
|
4860
5382
|
enabled?: boolean;
|
|
4861
|
-
/**
|
|
5383
|
+
/**
|
|
5384
|
+
* Specifies which API version to use when serializing entities in the
|
|
5385
|
+
* webhook payload
|
|
5386
|
+
*/
|
|
4862
5387
|
payload_api_version?: string;
|
|
4863
|
-
/**
|
|
5388
|
+
/**
|
|
5389
|
+
* Whether the you want records present in the payload to show blocks
|
|
5390
|
+
* expanded or not
|
|
5391
|
+
*/
|
|
4864
5392
|
nested_items_in_payload?: boolean;
|
|
4865
5393
|
};
|
|
4866
5394
|
};
|
|
4867
5395
|
}
|
|
4868
|
-
/**
|
|
5396
|
+
/**
|
|
5397
|
+
* This interface was referenced by `Webhook`'s JSON-Schema via the
|
|
5398
|
+
* `create.targetSchema` link.
|
|
5399
|
+
*/
|
|
4869
5400
|
export interface WebhookCreateTargetSchema {
|
|
4870
5401
|
data: Webhook;
|
|
4871
5402
|
}
|
|
@@ -4893,34 +5424,52 @@ export interface WebhookUpdateSchema {
|
|
|
4893
5424
|
http_basic_password?: string | null;
|
|
4894
5425
|
/** Whether the webhook is enabled and sending events or not */
|
|
4895
5426
|
enabled?: boolean;
|
|
4896
|
-
/**
|
|
5427
|
+
/**
|
|
5428
|
+
* Specifies which API version to use when serializing entities in the
|
|
5429
|
+
* webhook payload
|
|
5430
|
+
*/
|
|
4897
5431
|
payload_api_version?: string;
|
|
4898
|
-
/**
|
|
5432
|
+
/**
|
|
5433
|
+
* Whether the you want records present in the payload to show blocks
|
|
5434
|
+
* expanded or not
|
|
5435
|
+
*/
|
|
4899
5436
|
nested_items_in_payload?: boolean;
|
|
4900
5437
|
};
|
|
4901
5438
|
};
|
|
4902
5439
|
}
|
|
4903
|
-
/**
|
|
5440
|
+
/**
|
|
5441
|
+
* This interface was referenced by `Webhook`'s JSON-Schema via the
|
|
5442
|
+
* `update.targetSchema` link.
|
|
5443
|
+
*/
|
|
4904
5444
|
export interface WebhookUpdateTargetSchema {
|
|
4905
5445
|
data: Webhook;
|
|
4906
5446
|
}
|
|
4907
|
-
/**
|
|
5447
|
+
/**
|
|
5448
|
+
* This interface was referenced by `Webhook`'s JSON-Schema via the
|
|
5449
|
+
* `instances.targetSchema` link.
|
|
5450
|
+
*/
|
|
4908
5451
|
export interface WebhookInstancesTargetSchema {
|
|
4909
5452
|
data: Webhook[];
|
|
4910
5453
|
}
|
|
4911
|
-
/**
|
|
5454
|
+
/**
|
|
5455
|
+
* This interface was referenced by `Webhook`'s JSON-Schema via the
|
|
5456
|
+
* `self.targetSchema` link.
|
|
5457
|
+
*/
|
|
4912
5458
|
export interface WebhookSelfTargetSchema {
|
|
4913
5459
|
data: Webhook;
|
|
4914
5460
|
}
|
|
4915
|
-
/**
|
|
5461
|
+
/**
|
|
5462
|
+
* This interface was referenced by `Webhook`'s JSON-Schema via the
|
|
5463
|
+
* `destroy.targetSchema` link.
|
|
5464
|
+
*/
|
|
4916
5465
|
export interface WebhookDestroyTargetSchema {
|
|
4917
5466
|
data: Webhook;
|
|
4918
5467
|
}
|
|
4919
5468
|
/**
|
|
4920
5469
|
* Represents a log entry in the webhooks activity list.
|
|
4921
5470
|
*
|
|
4922
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4923
|
-
* "webhook_call".
|
|
5471
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5472
|
+
* `definition` "webhook_call".
|
|
4924
5473
|
*/
|
|
4925
5474
|
export interface WebhookCall {
|
|
4926
5475
|
type: WebhookCallType;
|
|
@@ -4931,7 +5480,8 @@ export interface WebhookCall {
|
|
|
4931
5480
|
/**
|
|
4932
5481
|
* JSON API attributes
|
|
4933
5482
|
*
|
|
4934
|
-
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
5483
|
+
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
5484
|
+
* `definition` "attributes".
|
|
4935
5485
|
*/
|
|
4936
5486
|
export interface WebhookCallAttributes {
|
|
4937
5487
|
/** The subject of webhook triggering */
|
|
@@ -4960,8 +5510,8 @@ export interface WebhookCallAttributes {
|
|
|
4960
5510
|
/**
|
|
4961
5511
|
* JSON API links
|
|
4962
5512
|
*
|
|
4963
|
-
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
4964
|
-
* "relationships".
|
|
5513
|
+
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
5514
|
+
* `definition` "relationships".
|
|
4965
5515
|
*/
|
|
4966
5516
|
export interface WebhookCallRelationships {
|
|
4967
5517
|
/** The webhook which has been called */
|
|
@@ -4972,7 +5522,8 @@ export interface WebhookCallRelationships {
|
|
|
4972
5522
|
/**
|
|
4973
5523
|
* JSON API data
|
|
4974
5524
|
*
|
|
4975
|
-
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
5525
|
+
* This interface was referenced by `WebhookCall`'s JSON-Schema via the
|
|
5526
|
+
* `definition` "data".
|
|
4976
5527
|
*/
|
|
4977
5528
|
export interface WebhookCallData {
|
|
4978
5529
|
type: WebhookCallType;
|
|
@@ -4986,11 +5537,11 @@ export interface WebhookCallInstancesTargetSchema {
|
|
|
4986
5537
|
data: WebhookCall[];
|
|
4987
5538
|
}
|
|
4988
5539
|
/**
|
|
4989
|
-
* Configuration for different build triggers. You can have different staging
|
|
4990
|
-
* production environments in order to test your site before final deploy
|
|
5540
|
+
* Configuration for different build triggers. You can have different staging
|
|
5541
|
+
* and production environments in order to test your site before final deploy
|
|
4991
5542
|
*
|
|
4992
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
4993
|
-
* "build_trigger".
|
|
5543
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5544
|
+
* `definition` "build_trigger".
|
|
4994
5545
|
*/
|
|
4995
5546
|
export interface BuildTrigger {
|
|
4996
5547
|
type: BuildTriggerType;
|
|
@@ -5000,7 +5551,8 @@ export interface BuildTrigger {
|
|
|
5000
5551
|
/**
|
|
5001
5552
|
* JSON API attributes
|
|
5002
5553
|
*
|
|
5003
|
-
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
5554
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
5555
|
+
* `definition` "attributes".
|
|
5004
5556
|
*/
|
|
5005
5557
|
export interface BuildTriggerAttributes {
|
|
5006
5558
|
/** Name of the environment */
|
|
@@ -5035,11 +5587,17 @@ export interface BuildTriggerAttributes {
|
|
|
5035
5587
|
export interface BuildTriggerInstancesTargetSchema {
|
|
5036
5588
|
data: BuildTrigger[];
|
|
5037
5589
|
}
|
|
5038
|
-
/**
|
|
5590
|
+
/**
|
|
5591
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
5592
|
+
* `self.targetSchema` link.
|
|
5593
|
+
*/
|
|
5039
5594
|
export interface BuildTriggerSelfTargetSchema {
|
|
5040
5595
|
data: BuildTrigger;
|
|
5041
5596
|
}
|
|
5042
|
-
/**
|
|
5597
|
+
/**
|
|
5598
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
5599
|
+
* `create.schema` link.
|
|
5600
|
+
*/
|
|
5043
5601
|
export interface BuildTriggerCreateSchema {
|
|
5044
5602
|
data: {
|
|
5045
5603
|
type: BuildTriggerType;
|
|
@@ -5070,7 +5628,10 @@ export interface BuildTriggerCreateSchema {
|
|
|
5070
5628
|
export interface BuildTriggerCreateTargetSchema {
|
|
5071
5629
|
data: BuildTrigger;
|
|
5072
5630
|
}
|
|
5073
|
-
/**
|
|
5631
|
+
/**
|
|
5632
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
5633
|
+
* `update.schema` link.
|
|
5634
|
+
*/
|
|
5074
5635
|
export interface BuildTriggerUpdateSchema {
|
|
5075
5636
|
data: {
|
|
5076
5637
|
type: BuildTriggerType;
|
|
@@ -5108,10 +5669,11 @@ export interface BuildTriggerDestroyTargetSchema {
|
|
|
5108
5669
|
data: BuildTrigger;
|
|
5109
5670
|
}
|
|
5110
5671
|
/**
|
|
5111
|
-
* In DatoCMS you can create filters to help you (and other editors) quickly
|
|
5672
|
+
* In DatoCMS you can create filters to help you (and other editors) quickly
|
|
5673
|
+
* search for records
|
|
5112
5674
|
*
|
|
5113
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5114
|
-
* "item_type_filter".
|
|
5675
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5676
|
+
* `definition` "item_type_filter".
|
|
5115
5677
|
*/
|
|
5116
5678
|
export interface ItemTypeFilter {
|
|
5117
5679
|
type: ItemTypeFilterType;
|
|
@@ -5122,8 +5684,8 @@ export interface ItemTypeFilter {
|
|
|
5122
5684
|
/**
|
|
5123
5685
|
* JSON API attributes
|
|
5124
5686
|
*
|
|
5125
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5126
|
-
* "attributes".
|
|
5687
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5688
|
+
* `definition` "attributes".
|
|
5127
5689
|
*/
|
|
5128
5690
|
export interface ItemTypeFilterAttributes {
|
|
5129
5691
|
/** The name of the filter */
|
|
@@ -5138,8 +5700,8 @@ export interface ItemTypeFilterAttributes {
|
|
|
5138
5700
|
/**
|
|
5139
5701
|
* JSON API links
|
|
5140
5702
|
*
|
|
5141
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5142
|
-
* "relationships".
|
|
5703
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5704
|
+
* `definition` "relationships".
|
|
5143
5705
|
*/
|
|
5144
5706
|
export interface ItemTypeFilterRelationships {
|
|
5145
5707
|
/** Model associated with the filter */
|
|
@@ -5150,13 +5712,17 @@ export interface ItemTypeFilterRelationships {
|
|
|
5150
5712
|
/**
|
|
5151
5713
|
* JSON API data
|
|
5152
5714
|
*
|
|
5153
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5715
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5716
|
+
* `definition` "data".
|
|
5154
5717
|
*/
|
|
5155
5718
|
export interface ItemTypeFilterData {
|
|
5156
5719
|
type: ItemTypeFilterType;
|
|
5157
5720
|
id: ItemTypeFilterIdentity;
|
|
5158
5721
|
}
|
|
5159
|
-
/**
|
|
5722
|
+
/**
|
|
5723
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5724
|
+
* `create.schema` link.
|
|
5725
|
+
*/
|
|
5160
5726
|
export interface ItemTypeFilterCreateSchema {
|
|
5161
5727
|
data: {
|
|
5162
5728
|
type: ItemTypeFilterType;
|
|
@@ -5180,7 +5746,10 @@ export interface ItemTypeFilterCreateSchema {
|
|
|
5180
5746
|
export interface ItemTypeFilterCreateTargetSchema {
|
|
5181
5747
|
data: ItemTypeFilter;
|
|
5182
5748
|
}
|
|
5183
|
-
/**
|
|
5749
|
+
/**
|
|
5750
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
5751
|
+
* `update.schema` link.
|
|
5752
|
+
*/
|
|
5184
5753
|
export interface ItemTypeFilterUpdateSchema {
|
|
5185
5754
|
data: {
|
|
5186
5755
|
type: ItemTypeFilterType;
|
|
@@ -5227,10 +5796,11 @@ export interface ItemTypeFilterDestroyTargetSchema {
|
|
|
5227
5796
|
data: ItemTypeFilter;
|
|
5228
5797
|
}
|
|
5229
5798
|
/**
|
|
5230
|
-
* In DatoCMS you can create filters to help you (and other editors) quickly
|
|
5799
|
+
* In DatoCMS you can create filters to help you (and other editors) quickly
|
|
5800
|
+
* search for uploads
|
|
5231
5801
|
*
|
|
5232
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5233
|
-
* "upload_filter".
|
|
5802
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5803
|
+
* `definition` "upload_filter".
|
|
5234
5804
|
*/
|
|
5235
5805
|
export interface UploadFilter {
|
|
5236
5806
|
type: UploadFilterType;
|
|
@@ -5240,7 +5810,8 @@ export interface UploadFilter {
|
|
|
5240
5810
|
/**
|
|
5241
5811
|
* JSON API attributes
|
|
5242
5812
|
*
|
|
5243
|
-
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5813
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5814
|
+
* `definition` "attributes".
|
|
5244
5815
|
*/
|
|
5245
5816
|
export interface UploadFilterAttributes {
|
|
5246
5817
|
/** The name of the filter */
|
|
@@ -5255,13 +5826,17 @@ export interface UploadFilterAttributes {
|
|
|
5255
5826
|
/**
|
|
5256
5827
|
* JSON API data
|
|
5257
5828
|
*
|
|
5258
|
-
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5829
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5830
|
+
* `definition` "data".
|
|
5259
5831
|
*/
|
|
5260
5832
|
export interface UploadFilterData {
|
|
5261
5833
|
type: UploadFilterType;
|
|
5262
5834
|
id: UploadFilterIdentity;
|
|
5263
5835
|
}
|
|
5264
|
-
/**
|
|
5836
|
+
/**
|
|
5837
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5838
|
+
* `create.schema` link.
|
|
5839
|
+
*/
|
|
5265
5840
|
export interface UploadFilterCreateSchema {
|
|
5266
5841
|
data: {
|
|
5267
5842
|
type: UploadFilterType;
|
|
@@ -5285,7 +5860,10 @@ export interface UploadFilterCreateSchema {
|
|
|
5285
5860
|
export interface UploadFilterCreateTargetSchema {
|
|
5286
5861
|
data: UploadFilter;
|
|
5287
5862
|
}
|
|
5288
|
-
/**
|
|
5863
|
+
/**
|
|
5864
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5865
|
+
* `update.schema` link.
|
|
5866
|
+
*/
|
|
5289
5867
|
export interface UploadFilterUpdateSchema {
|
|
5290
5868
|
data: {
|
|
5291
5869
|
type: UploadFilterType;
|
|
@@ -5317,7 +5895,10 @@ export interface UploadFilterUpdateTargetSchema {
|
|
|
5317
5895
|
export interface UploadFilterInstancesTargetSchema {
|
|
5318
5896
|
data: UploadFilter[];
|
|
5319
5897
|
}
|
|
5320
|
-
/**
|
|
5898
|
+
/**
|
|
5899
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5900
|
+
* `self.targetSchema` link.
|
|
5901
|
+
*/
|
|
5321
5902
|
export interface UploadFilterSelfTargetSchema {
|
|
5322
5903
|
data: UploadFilter;
|
|
5323
5904
|
}
|
|
@@ -5329,12 +5910,12 @@ export interface UploadFilterDestroyTargetSchema {
|
|
|
5329
5910
|
data: UploadFilter;
|
|
5330
5911
|
}
|
|
5331
5912
|
/**
|
|
5332
|
-
* A DatoCMS administrative area can be accessed by multiple people. Every
|
|
5333
|
-
* linked to a specific Role, which describes what actions it will
|
|
5334
|
-
* once the user will register.
|
|
5913
|
+
* A DatoCMS administrative area can be accessed by multiple people. Every
|
|
5914
|
+
* invitation is linked to a specific Role, which describes what actions it will
|
|
5915
|
+
* be able to perform once the user will register.
|
|
5335
5916
|
*
|
|
5336
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5337
|
-
* "site_invitation".
|
|
5917
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5918
|
+
* `definition` "site_invitation".
|
|
5338
5919
|
*/
|
|
5339
5920
|
export interface SiteInvitation {
|
|
5340
5921
|
type: SiteInvitationType;
|
|
@@ -5345,8 +5926,8 @@ export interface SiteInvitation {
|
|
|
5345
5926
|
/**
|
|
5346
5927
|
* JSON API attributes
|
|
5347
5928
|
*
|
|
5348
|
-
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5349
|
-
* "attributes".
|
|
5929
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5930
|
+
* `definition` "attributes".
|
|
5350
5931
|
*/
|
|
5351
5932
|
export interface SiteInvitationAttributes {
|
|
5352
5933
|
/** Email */
|
|
@@ -5355,8 +5936,8 @@ export interface SiteInvitationAttributes {
|
|
|
5355
5936
|
/**
|
|
5356
5937
|
* JSON API links
|
|
5357
5938
|
*
|
|
5358
|
-
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5359
|
-
* "relationships".
|
|
5939
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5940
|
+
* `definition` "relationships".
|
|
5360
5941
|
*/
|
|
5361
5942
|
export interface SiteInvitationRelationships {
|
|
5362
5943
|
/** Role */
|
|
@@ -5367,13 +5948,17 @@ export interface SiteInvitationRelationships {
|
|
|
5367
5948
|
/**
|
|
5368
5949
|
* JSON API data
|
|
5369
5950
|
*
|
|
5370
|
-
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5951
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5952
|
+
* `definition` "data".
|
|
5371
5953
|
*/
|
|
5372
5954
|
export interface SiteInvitationData {
|
|
5373
5955
|
type: SiteInvitationType;
|
|
5374
5956
|
id: SiteInvitationIdentity;
|
|
5375
5957
|
}
|
|
5376
|
-
/**
|
|
5958
|
+
/**
|
|
5959
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5960
|
+
* `create.schema` link.
|
|
5961
|
+
*/
|
|
5377
5962
|
export interface SiteInvitationCreateSchema {
|
|
5378
5963
|
data: {
|
|
5379
5964
|
type: SiteInvitationType;
|
|
@@ -5396,7 +5981,10 @@ export interface SiteInvitationCreateSchema {
|
|
|
5396
5981
|
export interface SiteInvitationCreateTargetSchema {
|
|
5397
5982
|
data: SiteInvitation;
|
|
5398
5983
|
}
|
|
5399
|
-
/**
|
|
5984
|
+
/**
|
|
5985
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5986
|
+
* `update.schema` link.
|
|
5987
|
+
*/
|
|
5400
5988
|
export interface SiteInvitationUpdateSchema {
|
|
5401
5989
|
data: {
|
|
5402
5990
|
type: SiteInvitationType;
|
|
@@ -5438,11 +6026,11 @@ export interface SiteInvitationDestroyTargetSchema {
|
|
|
5438
6026
|
data: SiteInvitation;
|
|
5439
6027
|
}
|
|
5440
6028
|
/**
|
|
5441
|
-
* Session track users movements in the administrative area, and allows locking
|
|
5442
|
-
* when editing it.
|
|
6029
|
+
* Session track users movements in the administrative area, and allows locking
|
|
6030
|
+
* a record when editing it.
|
|
5443
6031
|
*
|
|
5444
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5445
|
-
* "editing_session".
|
|
6032
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6033
|
+
* `definition` "editing_session".
|
|
5446
6034
|
*/
|
|
5447
6035
|
export interface EditingSession {
|
|
5448
6036
|
type: EditingSessionType;
|
|
@@ -5453,8 +6041,8 @@ export interface EditingSession {
|
|
|
5453
6041
|
/**
|
|
5454
6042
|
* JSON API attributes
|
|
5455
6043
|
*
|
|
5456
|
-
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
5457
|
-
* "attributes".
|
|
6044
|
+
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
6045
|
+
* `definition` "attributes".
|
|
5458
6046
|
*/
|
|
5459
6047
|
export interface EditingSessionAttributes {
|
|
5460
6048
|
/** User entered at */
|
|
@@ -5465,8 +6053,8 @@ export interface EditingSessionAttributes {
|
|
|
5465
6053
|
/**
|
|
5466
6054
|
* JSON API links
|
|
5467
6055
|
*
|
|
5468
|
-
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
5469
|
-
* "relationships".
|
|
6056
|
+
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
6057
|
+
* `definition` "relationships".
|
|
5470
6058
|
*/
|
|
5471
6059
|
export interface EditingSessionRelationships {
|
|
5472
6060
|
/** The active item in the session */
|
|
@@ -5485,7 +6073,8 @@ export interface EditingSessionRelationships {
|
|
|
5485
6073
|
/**
|
|
5486
6074
|
* JSON API data
|
|
5487
6075
|
*
|
|
5488
|
-
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
6076
|
+
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
6077
|
+
* `definition` "data".
|
|
5489
6078
|
*/
|
|
5490
6079
|
export interface EditingSessionData {
|
|
5491
6080
|
type: EditingSessionType;
|
|
@@ -5498,7 +6087,10 @@ export interface EditingSessionData {
|
|
|
5498
6087
|
export interface EditingSessionInstancesTargetSchema {
|
|
5499
6088
|
data: EditingSession[];
|
|
5500
6089
|
}
|
|
5501
|
-
/**
|
|
6090
|
+
/**
|
|
6091
|
+
* This interface was referenced by `EditingSession`'s JSON-Schema via the
|
|
6092
|
+
* `update.schema` link.
|
|
6093
|
+
*/
|
|
5502
6094
|
export interface EditingSessionUpdateSchema {
|
|
5503
6095
|
data:
|
|
5504
6096
|
| {
|
|
@@ -5554,11 +6146,12 @@ export interface EditingSessionDestroyTargetSchema {
|
|
|
5554
6146
|
data: EditingSession;
|
|
5555
6147
|
}
|
|
5556
6148
|
/**
|
|
5557
|
-
* A Single Sign-On group exists when a DatoCMS project is connected to an
|
|
5558
|
-
* Provider. These groups can be used to link DatoCMS roles to the
|
|
6149
|
+
* A Single Sign-On group exists when a DatoCMS project is connected to an
|
|
6150
|
+
* Identity Provider. These groups can be used to link DatoCMS roles to the
|
|
6151
|
+
* Identity Provider's groups.
|
|
5559
6152
|
*
|
|
5560
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5561
|
-
* "sso_group".
|
|
6153
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6154
|
+
* `definition` "sso_group".
|
|
5562
6155
|
*/
|
|
5563
6156
|
export interface SsoGroup {
|
|
5564
6157
|
type: SsoGroupType;
|
|
@@ -5569,21 +6162,23 @@ export interface SsoGroup {
|
|
|
5569
6162
|
/**
|
|
5570
6163
|
* JSON API attributes
|
|
5571
6164
|
*
|
|
5572
|
-
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
6165
|
+
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
6166
|
+
* `definition` "attributes".
|
|
5573
6167
|
*/
|
|
5574
6168
|
export interface SsoGroupAttributes {
|
|
5575
6169
|
/** Name of the group */
|
|
5576
6170
|
name: string;
|
|
5577
6171
|
/**
|
|
5578
|
-
* When an user belongs to multiple groups, the role associated to the group
|
|
5579
|
-
* highest priority will be used
|
|
6172
|
+
* When an user belongs to multiple groups, the role associated to the group
|
|
6173
|
+
* with the highest priority will be used
|
|
5580
6174
|
*/
|
|
5581
6175
|
priority: number;
|
|
5582
6176
|
}
|
|
5583
6177
|
/**
|
|
5584
6178
|
* JSON API links
|
|
5585
6179
|
*
|
|
5586
|
-
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
6180
|
+
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
6181
|
+
* `definition` "relationships".
|
|
5587
6182
|
*/
|
|
5588
6183
|
export interface SsoGroupRelationships {
|
|
5589
6184
|
/** Sso Group's role */
|
|
@@ -5595,7 +6190,10 @@ export interface SsoGroupRelationships {
|
|
|
5595
6190
|
data: SsoUserData[];
|
|
5596
6191
|
};
|
|
5597
6192
|
}
|
|
5598
|
-
/**
|
|
6193
|
+
/**
|
|
6194
|
+
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
6195
|
+
* `instances.targetSchema` link.
|
|
6196
|
+
*/
|
|
5599
6197
|
export interface SsoGroupInstancesTargetSchema {
|
|
5600
6198
|
data: SsoGroup[];
|
|
5601
6199
|
}
|
|
@@ -5613,8 +6211,8 @@ export interface SsoGroupUpdateSchema {
|
|
|
5613
6211
|
id: SsoGroupIdentity;
|
|
5614
6212
|
attributes: {
|
|
5615
6213
|
/**
|
|
5616
|
-
* When an user belongs to multiple groups, the role associated to the
|
|
5617
|
-
* the highest priority will be used
|
|
6214
|
+
* When an user belongs to multiple groups, the role associated to the
|
|
6215
|
+
* group with the highest priority will be used
|
|
5618
6216
|
*/
|
|
5619
6217
|
priority: number;
|
|
5620
6218
|
};
|
|
@@ -5626,19 +6224,25 @@ export interface SsoGroupUpdateSchema {
|
|
|
5626
6224
|
};
|
|
5627
6225
|
};
|
|
5628
6226
|
}
|
|
5629
|
-
/**
|
|
6227
|
+
/**
|
|
6228
|
+
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
6229
|
+
* `update.targetSchema` link.
|
|
6230
|
+
*/
|
|
5630
6231
|
export interface SsoGroupUpdateTargetSchema {
|
|
5631
6232
|
data: SsoGroup;
|
|
5632
6233
|
}
|
|
5633
|
-
/**
|
|
6234
|
+
/**
|
|
6235
|
+
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
6236
|
+
* `destroy.targetSchema` link.
|
|
6237
|
+
*/
|
|
5634
6238
|
export interface SsoGroupDestroyTargetSchema {
|
|
5635
6239
|
data: SsoGroup;
|
|
5636
6240
|
}
|
|
5637
6241
|
/**
|
|
5638
6242
|
* Represents the Single Sign-on settings of the current DatoCMS project
|
|
5639
6243
|
*
|
|
5640
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5641
|
-
* "sso_settings".
|
|
6244
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6245
|
+
* `definition` "sso_settings".
|
|
5642
6246
|
*/
|
|
5643
6247
|
export interface SsoSettings {
|
|
5644
6248
|
type: SsoSettingsType;
|
|
@@ -5649,7 +6253,8 @@ export interface SsoSettings {
|
|
|
5649
6253
|
/**
|
|
5650
6254
|
* JSON API attributes
|
|
5651
6255
|
*
|
|
5652
|
-
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6256
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6257
|
+
* `definition` "attributes".
|
|
5653
6258
|
*/
|
|
5654
6259
|
export interface SsoSettingsAttributes {
|
|
5655
6260
|
/** URL of Identity Provider SAML Metadata endpoint */
|
|
@@ -5670,8 +6275,8 @@ export interface SsoSettingsAttributes {
|
|
|
5670
6275
|
/**
|
|
5671
6276
|
* JSON API links
|
|
5672
6277
|
*
|
|
5673
|
-
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
5674
|
-
* "relationships".
|
|
6278
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6279
|
+
* `definition` "relationships".
|
|
5675
6280
|
*/
|
|
5676
6281
|
export interface SsoSettingsRelationships {
|
|
5677
6282
|
/** The default role assigned to SSO users that do not belong to any SSO group */
|
|
@@ -5682,13 +6287,17 @@ export interface SsoSettingsRelationships {
|
|
|
5682
6287
|
/**
|
|
5683
6288
|
* JSON API data
|
|
5684
6289
|
*
|
|
5685
|
-
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6290
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6291
|
+
* `definition` "data".
|
|
5686
6292
|
*/
|
|
5687
6293
|
export interface SsoSettingsData {
|
|
5688
6294
|
type: SsoSettingsType;
|
|
5689
6295
|
id: SsoSettingsIdentity;
|
|
5690
6296
|
}
|
|
5691
|
-
/**
|
|
6297
|
+
/**
|
|
6298
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6299
|
+
* `self.targetSchema` link.
|
|
6300
|
+
*/
|
|
5692
6301
|
export interface SsoSettingsSelfTargetSchema {
|
|
5693
6302
|
data: SsoSettings;
|
|
5694
6303
|
}
|
|
@@ -5708,7 +6317,10 @@ export interface SsoSettingsGenerateTokenTargetSchema {
|
|
|
5708
6317
|
[k: string]: unknown;
|
|
5709
6318
|
};
|
|
5710
6319
|
}
|
|
5711
|
-
/**
|
|
6320
|
+
/**
|
|
6321
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6322
|
+
* `update.schema` link.
|
|
6323
|
+
*/
|
|
5712
6324
|
export interface SsoSettingsUpdateSchema {
|
|
5713
6325
|
data: {
|
|
5714
6326
|
type: SsoSettingsType;
|
|
@@ -5725,15 +6337,18 @@ export interface SsoSettingsUpdateSchema {
|
|
|
5725
6337
|
};
|
|
5726
6338
|
};
|
|
5727
6339
|
}
|
|
5728
|
-
/**
|
|
6340
|
+
/**
|
|
6341
|
+
* This interface was referenced by `SsoSettings`'s JSON-Schema via the
|
|
6342
|
+
* `update.targetSchema` link.
|
|
6343
|
+
*/
|
|
5729
6344
|
export interface SsoSettingsUpdateTargetSchema {
|
|
5730
6345
|
data: SsoSettings;
|
|
5731
6346
|
}
|
|
5732
6347
|
/**
|
|
5733
6348
|
* Represents the white-label settings of the current DatoCMS project
|
|
5734
6349
|
*
|
|
5735
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5736
|
-
* "white_label_settings".
|
|
6350
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6351
|
+
* `definition` "white_label_settings".
|
|
5737
6352
|
*/
|
|
5738
6353
|
export interface WhiteLabelSettings {
|
|
5739
6354
|
type: WhiteLabelSettingsType;
|
|
@@ -5747,13 +6362,17 @@ export interface WhiteLabelSettings {
|
|
|
5747
6362
|
* `definition` "attributes".
|
|
5748
6363
|
*/
|
|
5749
6364
|
export interface WhiteLabelSettingsAttributes {
|
|
5750
|
-
/**
|
|
6365
|
+
/**
|
|
6366
|
+
* URL of custom I18n messages. The :locale placeholder represents the current
|
|
6367
|
+
* DatoCMS UI locale.
|
|
6368
|
+
*/
|
|
5751
6369
|
custom_i18n_messages_template_url: null | string;
|
|
5752
6370
|
}
|
|
5753
6371
|
/**
|
|
5754
6372
|
* JSON API data
|
|
5755
6373
|
*
|
|
5756
|
-
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
6374
|
+
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
6375
|
+
* `definition` "data".
|
|
5757
6376
|
*/
|
|
5758
6377
|
export interface WhiteLabelSettingsData {
|
|
5759
6378
|
type: WhiteLabelSettingsType;
|
|
@@ -5776,8 +6395,8 @@ export interface WhiteLabelSettingsUpdateSchema {
|
|
|
5776
6395
|
id?: WhiteLabelSettingsIdentity;
|
|
5777
6396
|
attributes?: {
|
|
5778
6397
|
/**
|
|
5779
|
-
* URL of custom I18n messages. The :locale placeholder represents the
|
|
5780
|
-
* DatoCMS UI locale.
|
|
6398
|
+
* URL of custom I18n messages. The :locale placeholder represents the
|
|
6399
|
+
* current DatoCMS UI locale.
|
|
5781
6400
|
*/
|
|
5782
6401
|
custom_i18n_messages_template_url: null | string;
|
|
5783
6402
|
};
|
|
@@ -5793,8 +6412,8 @@ export interface WhiteLabelSettingsUpdateTargetSchema {
|
|
|
5793
6412
|
/**
|
|
5794
6413
|
* Info that can be accessed by unauthorized users
|
|
5795
6414
|
*
|
|
5796
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5797
|
-
* "public_info".
|
|
6415
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6416
|
+
* `definition` "public_info".
|
|
5798
6417
|
*/
|
|
5799
6418
|
export interface PublicInfo {
|
|
5800
6419
|
type: PublicInfoType;
|
|
@@ -5804,7 +6423,8 @@ export interface PublicInfo {
|
|
|
5804
6423
|
/**
|
|
5805
6424
|
* JSON API attributes
|
|
5806
6425
|
*
|
|
5807
|
-
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
6426
|
+
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
6427
|
+
* `definition` "attributes".
|
|
5808
6428
|
*/
|
|
5809
6429
|
export interface PublicInfoAttributes {
|
|
5810
6430
|
/** Site name */
|
|
@@ -5859,21 +6479,25 @@ export interface PublicInfoAttributes {
|
|
|
5859
6479
|
/**
|
|
5860
6480
|
* JSON API data
|
|
5861
6481
|
*
|
|
5862
|
-
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
6482
|
+
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
6483
|
+
* `definition` "data".
|
|
5863
6484
|
*/
|
|
5864
6485
|
export interface PublicInfoData {
|
|
5865
6486
|
type: PublicInfoType;
|
|
5866
6487
|
id: PublicInfoIdentity;
|
|
5867
6488
|
}
|
|
5868
|
-
/**
|
|
6489
|
+
/**
|
|
6490
|
+
* This interface was referenced by `PublicInfo`'s JSON-Schema via the
|
|
6491
|
+
* `self.targetSchema` link.
|
|
6492
|
+
*/
|
|
5869
6493
|
export interface PublicInfoSelfTargetSchema {
|
|
5870
6494
|
data: PublicInfo;
|
|
5871
6495
|
}
|
|
5872
6496
|
/**
|
|
5873
6497
|
* DatoCMS resources usage organized by day
|
|
5874
6498
|
*
|
|
5875
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5876
|
-
* "daily_usage".
|
|
6499
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6500
|
+
* `definition` "daily_usage".
|
|
5877
6501
|
*/
|
|
5878
6502
|
export interface DailyUsage {
|
|
5879
6503
|
type: DailyUsageType;
|
|
@@ -5883,7 +6507,8 @@ export interface DailyUsage {
|
|
|
5883
6507
|
/**
|
|
5884
6508
|
* JSON API attributes
|
|
5885
6509
|
*
|
|
5886
|
-
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
6510
|
+
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
6511
|
+
* `definition` "attributes".
|
|
5887
6512
|
*/
|
|
5888
6513
|
export interface DailyUsageAttributes {
|
|
5889
6514
|
/** The date the data are referring to */
|
|
@@ -5902,7 +6527,8 @@ export interface DailyUsageAttributes {
|
|
|
5902
6527
|
/**
|
|
5903
6528
|
* JSON API data
|
|
5904
6529
|
*
|
|
5905
|
-
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
6530
|
+
* This interface was referenced by `DailyUsage`'s JSON-Schema via the
|
|
6531
|
+
* `definition` "data".
|
|
5906
6532
|
*/
|
|
5907
6533
|
export interface DailyUsageData {
|
|
5908
6534
|
type: DailyUsageType;
|
|
@@ -5916,13 +6542,14 @@ export interface DailyUsageInstancesTargetSchema {
|
|
|
5916
6542
|
data: DailyUsage;
|
|
5917
6543
|
}
|
|
5918
6544
|
/**
|
|
5919
|
-
* You can use counters to analyze your project's data consumption over a period
|
|
5920
|
-
* Counters are especially useful if your project is exceeding its API
|
|
5921
|
-
* quota limits, to better understand where and how requests are
|
|
5922
|
-
* are updated every minute, so you can debug in real-time
|
|
6545
|
+
* You can use counters to analyze your project's data consumption over a period
|
|
6546
|
+
* of time. Counters are especially useful if your project is exceeding its API
|
|
6547
|
+
* calls/traffic quota limits, to better understand where and how requests are
|
|
6548
|
+
* originating. Counters are updated every minute, so you can debug in real-time
|
|
6549
|
+
* the results of your changes.
|
|
5923
6550
|
*
|
|
5924
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5925
|
-
* "usage_counter".
|
|
6551
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6552
|
+
* `definition` "usage_counter".
|
|
5926
6553
|
*/
|
|
5927
6554
|
export interface UsageCounter {
|
|
5928
6555
|
type: UsageCounterType;
|
|
@@ -5932,7 +6559,8 @@ export interface UsageCounter {
|
|
|
5932
6559
|
/**
|
|
5933
6560
|
* JSON API attributes
|
|
5934
6561
|
*
|
|
5935
|
-
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
6562
|
+
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
6563
|
+
* `definition` "attributes".
|
|
5936
6564
|
*/
|
|
5937
6565
|
export interface UsageCounterAttributes {
|
|
5938
6566
|
result: {
|
|
@@ -5945,21 +6573,25 @@ export interface UsageCounterAttributes {
|
|
|
5945
6573
|
/**
|
|
5946
6574
|
* JSON API data
|
|
5947
6575
|
*
|
|
5948
|
-
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
6576
|
+
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
6577
|
+
* `definition` "data".
|
|
5949
6578
|
*/
|
|
5950
6579
|
export interface UsageCounterData {
|
|
5951
6580
|
type: UsageCounterType;
|
|
5952
6581
|
id: UsageCounterIdentity;
|
|
5953
6582
|
}
|
|
5954
|
-
/**
|
|
6583
|
+
/**
|
|
6584
|
+
* This interface was referenced by `UsageCounter`'s JSON-Schema via the
|
|
6585
|
+
* `self.targetSchema` link.
|
|
6586
|
+
*/
|
|
5955
6587
|
export interface UsageCounterSelfTargetSchema {
|
|
5956
6588
|
data: UsageCounter;
|
|
5957
6589
|
}
|
|
5958
6590
|
/**
|
|
5959
6591
|
* All the project's upload tags
|
|
5960
6592
|
*
|
|
5961
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
5962
|
-
* "upload_tag".
|
|
6593
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6594
|
+
* `definition` "upload_tag".
|
|
5963
6595
|
*/
|
|
5964
6596
|
export interface UploadTag {
|
|
5965
6597
|
type: UploadTagType;
|
|
@@ -5969,7 +6601,8 @@ export interface UploadTag {
|
|
|
5969
6601
|
/**
|
|
5970
6602
|
* JSON API attributes
|
|
5971
6603
|
*
|
|
5972
|
-
* This interface was referenced by `UploadTag`'s JSON-Schema via the
|
|
6604
|
+
* This interface was referenced by `UploadTag`'s JSON-Schema via the
|
|
6605
|
+
* `definition` "attributes".
|
|
5973
6606
|
*/
|
|
5974
6607
|
export interface UploadTagAttributes {
|
|
5975
6608
|
/** The tag name */
|
|
@@ -5991,7 +6624,10 @@ export interface UploadTagData {
|
|
|
5991
6624
|
export interface UploadTagInstancesTargetSchema {
|
|
5992
6625
|
data: UploadTag[];
|
|
5993
6626
|
}
|
|
5994
|
-
/**
|
|
6627
|
+
/**
|
|
6628
|
+
* This interface was referenced by `UploadTag`'s JSON-Schema via the
|
|
6629
|
+
* `create.schema` link.
|
|
6630
|
+
*/
|
|
5995
6631
|
export interface UploadTagCreateSchema {
|
|
5996
6632
|
data: {
|
|
5997
6633
|
type: UploadTagType;
|
|
@@ -6001,15 +6637,18 @@ export interface UploadTagCreateSchema {
|
|
|
6001
6637
|
};
|
|
6002
6638
|
};
|
|
6003
6639
|
}
|
|
6004
|
-
/**
|
|
6640
|
+
/**
|
|
6641
|
+
* This interface was referenced by `UploadTag`'s JSON-Schema via the
|
|
6642
|
+
* `create.targetSchema` link.
|
|
6643
|
+
*/
|
|
6005
6644
|
export interface UploadTagCreateTargetSchema {
|
|
6006
6645
|
data: UploadTag;
|
|
6007
6646
|
}
|
|
6008
6647
|
/**
|
|
6009
6648
|
* All the site's upload automatically generated tags
|
|
6010
6649
|
*
|
|
6011
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6012
|
-
* "upload_smart_tag".
|
|
6650
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6651
|
+
* `definition` "upload_smart_tag".
|
|
6013
6652
|
*/
|
|
6014
6653
|
export interface UploadSmartTag {
|
|
6015
6654
|
type: UploadSmartTagType;
|
|
@@ -6019,8 +6658,8 @@ export interface UploadSmartTag {
|
|
|
6019
6658
|
/**
|
|
6020
6659
|
* JSON API attributes
|
|
6021
6660
|
*
|
|
6022
|
-
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
6023
|
-
* "attributes".
|
|
6661
|
+
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
6662
|
+
* `definition` "attributes".
|
|
6024
6663
|
*/
|
|
6025
6664
|
export interface UploadSmartTagAttributes {
|
|
6026
6665
|
/** The tag name */
|
|
@@ -6029,7 +6668,8 @@ export interface UploadSmartTagAttributes {
|
|
|
6029
6668
|
/**
|
|
6030
6669
|
* JSON API data
|
|
6031
6670
|
*
|
|
6032
|
-
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
6671
|
+
* This interface was referenced by `UploadSmartTag`'s JSON-Schema via the
|
|
6672
|
+
* `definition` "data".
|
|
6033
6673
|
*/
|
|
6034
6674
|
export interface UploadSmartTagData {
|
|
6035
6675
|
type: UploadSmartTagType;
|
|
@@ -6045,7 +6685,8 @@ export interface UploadSmartTagInstancesTargetSchema {
|
|
|
6045
6685
|
/**
|
|
6046
6686
|
* A site represents a specific DatoCMS administrative area
|
|
6047
6687
|
*
|
|
6048
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6688
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6689
|
+
* `definition` "site".
|
|
6049
6690
|
*/
|
|
6050
6691
|
export interface Site {
|
|
6051
6692
|
type: SiteType;
|
|
@@ -6056,7 +6697,8 @@ export interface Site {
|
|
|
6056
6697
|
/**
|
|
6057
6698
|
* JSON API attributes
|
|
6058
6699
|
*
|
|
6059
|
-
* This interface was referenced by `Site`'s JSON-Schema via the `definition`
|
|
6700
|
+
* This interface was referenced by `Site`'s JSON-Schema via the `definition`
|
|
6701
|
+
* "attributes".
|
|
6060
6702
|
*/
|
|
6061
6703
|
export interface SiteAttributes {
|
|
6062
6704
|
/** Site name */
|
|
@@ -6081,7 +6723,10 @@ export interface SiteAttributes {
|
|
|
6081
6723
|
last_data_change_at: null | string;
|
|
6082
6724
|
/** Frontend website url */
|
|
6083
6725
|
frontend_url: string | null;
|
|
6084
|
-
/**
|
|
6726
|
+
/**
|
|
6727
|
+
* Specifies whether all users of this site need to authenticate using
|
|
6728
|
+
* two-factor authentication
|
|
6729
|
+
*/
|
|
6085
6730
|
require_2fa: boolean;
|
|
6086
6731
|
/** Specifies whether you want IPs to be tracked in the Project usages section */
|
|
6087
6732
|
ip_tracking_enabled: boolean;
|
|
@@ -6144,7 +6789,8 @@ export interface SiteAttributes {
|
|
|
6144
6789
|
/**
|
|
6145
6790
|
* JSON API links
|
|
6146
6791
|
*
|
|
6147
|
-
* This interface was referenced by `Site`'s JSON-Schema via the `definition`
|
|
6792
|
+
* This interface was referenced by `Site`'s JSON-Schema via the `definition`
|
|
6793
|
+
* "relationships".
|
|
6148
6794
|
*/
|
|
6149
6795
|
export interface SiteRelationships {
|
|
6150
6796
|
account: {
|
|
@@ -6265,8 +6911,8 @@ export interface SiteUpdateSchema {
|
|
|
6265
6911
|
/** Site default timezone */
|
|
6266
6912
|
timezone?: string;
|
|
6267
6913
|
/**
|
|
6268
|
-
* Specifies whether all users of this site need to authenticate using
|
|
6269
|
-
* authentication
|
|
6914
|
+
* Specifies whether all users of this site need to authenticate using
|
|
6915
|
+
* two-factor authentication
|
|
6270
6916
|
*/
|
|
6271
6917
|
require_2fa?: boolean;
|
|
6272
6918
|
/** Specifies whether you want IPs to be tracked in the Project usages section */
|
|
@@ -6279,7 +6925,10 @@ export interface SiteUpdateSchema {
|
|
|
6279
6925
|
};
|
|
6280
6926
|
};
|
|
6281
6927
|
}
|
|
6282
|
-
/**
|
|
6928
|
+
/**
|
|
6929
|
+
* This interface was referenced by `Site`'s JSON-Schema via the
|
|
6930
|
+
* `update.targetSchema` link.
|
|
6931
|
+
*/
|
|
6283
6932
|
export interface SiteUpdateTargetSchema {
|
|
6284
6933
|
data: Job;
|
|
6285
6934
|
}
|
|
@@ -6288,11 +6937,12 @@ export interface SiteUpdateJobSchema {
|
|
|
6288
6937
|
data: Site;
|
|
6289
6938
|
}
|
|
6290
6939
|
/**
|
|
6291
|
-
* Through workflows it is possible to set up a precise state machine able to
|
|
6292
|
-
* draft content up to the final publication (and beyond), through a
|
|
6293
|
-
* intermediate, fully customizable approval steps.
|
|
6940
|
+
* Through workflows it is possible to set up a precise state machine able to
|
|
6941
|
+
* bring a draft content up to the final publication (and beyond), through a
|
|
6942
|
+
* series of intermediate, fully customizable approval steps.
|
|
6294
6943
|
*
|
|
6295
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6944
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the
|
|
6945
|
+
* `definition` "workflow".
|
|
6296
6946
|
*/
|
|
6297
6947
|
export interface Workflow {
|
|
6298
6948
|
type: WorkflowType;
|
|
@@ -6302,7 +6952,8 @@ export interface Workflow {
|
|
|
6302
6952
|
/**
|
|
6303
6953
|
* JSON API attributes
|
|
6304
6954
|
*
|
|
6305
|
-
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
6955
|
+
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
6956
|
+
* `definition` "attributes".
|
|
6306
6957
|
*/
|
|
6307
6958
|
export interface WorkflowAttributes {
|
|
6308
6959
|
/** The name of the workflow */
|
|
@@ -6366,7 +7017,10 @@ export interface WorkflowCreateSchema {
|
|
|
6366
7017
|
};
|
|
6367
7018
|
};
|
|
6368
7019
|
}
|
|
6369
|
-
/**
|
|
7020
|
+
/**
|
|
7021
|
+
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
7022
|
+
* `create.targetSchema` link.
|
|
7023
|
+
*/
|
|
6370
7024
|
export interface WorkflowCreateTargetSchema {
|
|
6371
7025
|
data: Workflow;
|
|
6372
7026
|
}
|
|
@@ -6405,15 +7059,24 @@ export interface WorkflowUpdateSchema {
|
|
|
6405
7059
|
};
|
|
6406
7060
|
};
|
|
6407
7061
|
}
|
|
6408
|
-
/**
|
|
7062
|
+
/**
|
|
7063
|
+
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
7064
|
+
* `update.targetSchema` link.
|
|
7065
|
+
*/
|
|
6409
7066
|
export interface WorkflowUpdateTargetSchema {
|
|
6410
7067
|
data: Workflow;
|
|
6411
7068
|
}
|
|
6412
|
-
/**
|
|
7069
|
+
/**
|
|
7070
|
+
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
7071
|
+
* `instances.targetSchema` link.
|
|
7072
|
+
*/
|
|
6413
7073
|
export interface WorkflowInstancesTargetSchema {
|
|
6414
7074
|
data: Workflow[];
|
|
6415
7075
|
}
|
|
6416
|
-
/**
|
|
7076
|
+
/**
|
|
7077
|
+
* This interface was referenced by `Workflow`'s JSON-Schema via the
|
|
7078
|
+
* `self.targetSchema` link.
|
|
7079
|
+
*/
|
|
6417
7080
|
export interface WorkflowSelfTargetSchema {
|
|
6418
7081
|
data: Workflow;
|
|
6419
7082
|
}
|