@datocms/cma-client 0.1.8 → 1.0.0
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/generated/resources/Site.js +4 -3
- package/dist/cjs/generated/resources/Site.js.map +1 -1
- package/dist/cjs/generated/resources/User.js +26 -3
- package/dist/cjs/generated/resources/User.js.map +1 -1
- package/dist/esm/buildBlockRecord.d.ts +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +1323 -443
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +1332 -460
- package/dist/esm/generated/resources/Site.d.ts +2 -2
- package/dist/esm/generated/resources/Site.js +4 -3
- package/dist/esm/generated/resources/Site.js.map +1 -1
- package/dist/esm/generated/resources/User.d.ts +14 -2
- package/dist/esm/generated/resources/User.js +26 -3
- package/dist/esm/generated/resources/User.js.map +1 -1
- package/dist/types/buildBlockRecord.d.ts +1 -1
- package/dist/types/generated/SchemaTypes.d.ts +1323 -443
- package/dist/types/generated/SimpleSchemaTypes.d.ts +1332 -460
- package/dist/types/generated/resources/Site.d.ts +2 -2
- package/dist/types/generated/resources/User.d.ts +14 -2
- package/package.json +4 -4
- package/resources.json +6 -0
- package/src/generated/SchemaTypes.ts +1368 -476
- package/src/generated/SimpleSchemaTypes.ts +1338 -466
- package/src/generated/resources/Site.ts +6 -3
- package/src/generated/resources/User.ts +36 -3
|
@@ -77,17 +77,13 @@ export declare type UserType = 'user';
|
|
|
77
77
|
export declare type UserIdentity = string;
|
|
78
78
|
/**
|
|
79
79
|
* This interface was referenced by `User`'s JSON-Schema
|
|
80
|
-
* via the `
|
|
80
|
+
* via the `self.hrefSchema` link.
|
|
81
81
|
*/
|
|
82
|
-
export declare type
|
|
83
|
-
/**
|
|
84
|
-
* New owner for resources previously owned by the deleted user. This argument specifies the new owner type.
|
|
85
|
-
*/
|
|
86
|
-
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
82
|
+
export declare type UserSelfHrefSchema = {
|
|
87
83
|
/**
|
|
88
|
-
*
|
|
84
|
+
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `role`.
|
|
89
85
|
*/
|
|
90
|
-
|
|
86
|
+
include?: string;
|
|
91
87
|
[k: string]: unknown;
|
|
92
88
|
};
|
|
93
89
|
/**
|
|
@@ -142,20 +138,35 @@ export declare type SsoUserDestroyHrefSchema = {
|
|
|
142
138
|
/**
|
|
143
139
|
* JSON API type field
|
|
144
140
|
*
|
|
145
|
-
* This interface was referenced by `
|
|
141
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
146
142
|
* via the `definition` "type".
|
|
147
143
|
*/
|
|
148
|
-
export declare type
|
|
144
|
+
export declare type AccessTokenType = 'access_token';
|
|
149
145
|
/**
|
|
150
|
-
*
|
|
146
|
+
* ID of access_token
|
|
151
147
|
*
|
|
152
|
-
* This interface was referenced by `
|
|
148
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
153
149
|
* via the `definition` "identity".
|
|
154
150
|
*
|
|
155
|
-
* This interface was referenced by `
|
|
151
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
156
152
|
* via the `definition` "id".
|
|
157
153
|
*/
|
|
158
|
-
export declare type
|
|
154
|
+
export declare type AccessTokenIdentity = string;
|
|
155
|
+
/**
|
|
156
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
157
|
+
* via the `destroy.hrefSchema` link.
|
|
158
|
+
*/
|
|
159
|
+
export declare type AccessTokenDestroyHrefSchema = {
|
|
160
|
+
/**
|
|
161
|
+
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner type.
|
|
162
|
+
*/
|
|
163
|
+
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
164
|
+
/**
|
|
165
|
+
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner ID.
|
|
166
|
+
*/
|
|
167
|
+
destination_user_id?: string;
|
|
168
|
+
[k: string]: unknown;
|
|
169
|
+
};
|
|
159
170
|
/**
|
|
160
171
|
* JSON API type field
|
|
161
172
|
*
|
|
@@ -173,6 +184,49 @@ export declare type AccountType = 'account';
|
|
|
173
184
|
* via the `definition` "id".
|
|
174
185
|
*/
|
|
175
186
|
export declare type AccountIdentity = string;
|
|
187
|
+
/**
|
|
188
|
+
* This interface was referenced by `User`'s JSON-Schema
|
|
189
|
+
* via the `me.hrefSchema` link.
|
|
190
|
+
*/
|
|
191
|
+
export declare type UserMeHrefSchema = {
|
|
192
|
+
/**
|
|
193
|
+
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `role`.
|
|
194
|
+
*/
|
|
195
|
+
include?: string;
|
|
196
|
+
[k: string]: unknown;
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* This interface was referenced by `User`'s JSON-Schema
|
|
200
|
+
* via the `destroy.hrefSchema` link.
|
|
201
|
+
*/
|
|
202
|
+
export declare type UserDestroyHrefSchema = {
|
|
203
|
+
/**
|
|
204
|
+
* New owner for resources previously owned by the deleted user. This argument specifies the new owner type.
|
|
205
|
+
*/
|
|
206
|
+
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
207
|
+
/**
|
|
208
|
+
* New owner for resources previously owned by the deleted user. This argument specifies the new owner ID.
|
|
209
|
+
*/
|
|
210
|
+
destination_user_id?: string;
|
|
211
|
+
[k: string]: unknown;
|
|
212
|
+
};
|
|
213
|
+
/**
|
|
214
|
+
* JSON API type field
|
|
215
|
+
*
|
|
216
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
217
|
+
* via the `definition` "type".
|
|
218
|
+
*/
|
|
219
|
+
export declare type AuditLogEventType = 'audit_log_event';
|
|
220
|
+
/**
|
|
221
|
+
* ULID of event (https://github.com/ulid/spec)
|
|
222
|
+
*
|
|
223
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
224
|
+
* via the `definition` "identity".
|
|
225
|
+
*
|
|
226
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
227
|
+
* via the `definition` "id".
|
|
228
|
+
*/
|
|
229
|
+
export declare type AuditLogEventIdentity = string;
|
|
176
230
|
/**
|
|
177
231
|
* JSON API type field
|
|
178
232
|
*
|
|
@@ -260,6 +314,23 @@ export declare type FieldType = 'field';
|
|
|
260
314
|
* via the `definition` "id".
|
|
261
315
|
*/
|
|
262
316
|
export declare type FieldIdentity = string;
|
|
317
|
+
/**
|
|
318
|
+
* JSON API type fieldset
|
|
319
|
+
*
|
|
320
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
321
|
+
* via the `definition` "type".
|
|
322
|
+
*/
|
|
323
|
+
export declare type FieldsetType = 'fieldset';
|
|
324
|
+
/**
|
|
325
|
+
* ID of fieldset
|
|
326
|
+
*
|
|
327
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
328
|
+
* via the `definition` "identity".
|
|
329
|
+
*
|
|
330
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
331
|
+
* via the `definition` "id".
|
|
332
|
+
*/
|
|
333
|
+
export declare type FieldsetIdentity = string;
|
|
263
334
|
/**
|
|
264
335
|
* JSON API type field
|
|
265
336
|
*
|
|
@@ -284,23 +355,6 @@ export declare type JobType = 'job';
|
|
|
284
355
|
* via the `definition` "id".
|
|
285
356
|
*/
|
|
286
357
|
export declare type JobIdentity = string;
|
|
287
|
-
/**
|
|
288
|
-
* JSON API type fieldset
|
|
289
|
-
*
|
|
290
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
291
|
-
* via the `definition` "type".
|
|
292
|
-
*/
|
|
293
|
-
export declare type FieldsetType = 'fieldset';
|
|
294
|
-
/**
|
|
295
|
-
* ID of fieldset
|
|
296
|
-
*
|
|
297
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
298
|
-
* via the `definition` "identity".
|
|
299
|
-
*
|
|
300
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
301
|
-
* via the `definition` "id".
|
|
302
|
-
*/
|
|
303
|
-
export declare type FieldsetIdentity = string;
|
|
304
358
|
/**
|
|
305
359
|
* JSON API type field
|
|
306
360
|
*
|
|
@@ -318,38 +372,6 @@ export declare type SessionType = 'session';
|
|
|
318
372
|
* via the `definition` "id".
|
|
319
373
|
*/
|
|
320
374
|
export declare type SessionIdentity = string;
|
|
321
|
-
/**
|
|
322
|
-
* JSON API type field
|
|
323
|
-
*
|
|
324
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
325
|
-
* via the `definition` "type".
|
|
326
|
-
*/
|
|
327
|
-
export declare type AccessTokenType = 'access_token';
|
|
328
|
-
/**
|
|
329
|
-
* ID of access_token
|
|
330
|
-
*
|
|
331
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
332
|
-
* via the `definition` "identity".
|
|
333
|
-
*
|
|
334
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
335
|
-
* via the `definition` "id".
|
|
336
|
-
*/
|
|
337
|
-
export declare type AccessTokenIdentity = string;
|
|
338
|
-
/**
|
|
339
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
340
|
-
* via the `destroy.hrefSchema` link.
|
|
341
|
-
*/
|
|
342
|
-
export declare type AccessTokenDestroyHrefSchema = {
|
|
343
|
-
/**
|
|
344
|
-
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner type.
|
|
345
|
-
*/
|
|
346
|
-
destination_user_type?: 'account' | 'user' | 'access_token' | 'sso_user';
|
|
347
|
-
/**
|
|
348
|
-
* New owner for resources previously owned by the deleted access token. This argument specifies the new owner ID.
|
|
349
|
-
*/
|
|
350
|
-
destination_user_id?: string;
|
|
351
|
-
[k: string]: unknown;
|
|
352
|
-
};
|
|
353
375
|
/**
|
|
354
376
|
* JSON API type field
|
|
355
377
|
*
|
|
@@ -1191,6 +1213,17 @@ export declare type SiteType = 'site';
|
|
|
1191
1213
|
* via the `definition` "id".
|
|
1192
1214
|
*/
|
|
1193
1215
|
export declare type SiteIdentity = string;
|
|
1216
|
+
/**
|
|
1217
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
1218
|
+
* via the `self.hrefSchema` link.
|
|
1219
|
+
*/
|
|
1220
|
+
export declare type SiteSelfHrefSchema = {
|
|
1221
|
+
/**
|
|
1222
|
+
* Comma-separated list of [relationship paths](https://jsonapi.org/format/#fetching-includes). A relationship path is a dot-separated list of relationship names. Allowed relationship paths: `item_types`, `item_types.fields`, `item_types.fieldsets`, `item_types.singleton_item`, `account`.
|
|
1223
|
+
*/
|
|
1224
|
+
include?: string;
|
|
1225
|
+
[k: string]: unknown;
|
|
1226
|
+
};
|
|
1194
1227
|
export declare type DatoApi = {
|
|
1195
1228
|
role?: Role;
|
|
1196
1229
|
user?: User;
|
|
@@ -2233,13 +2266,15 @@ export declare type UserInstancesTargetSchema = {
|
|
|
2233
2266
|
*/
|
|
2234
2267
|
export declare type UserSelfTargetSchema = {
|
|
2235
2268
|
data: User;
|
|
2269
|
+
included?: Role[];
|
|
2236
2270
|
};
|
|
2237
2271
|
/**
|
|
2238
2272
|
* This interface was referenced by `User`'s JSON-Schema
|
|
2239
|
-
* via the `
|
|
2273
|
+
* via the `me.targetSchema` link.
|
|
2240
2274
|
*/
|
|
2241
|
-
export declare type
|
|
2242
|
-
data: User;
|
|
2275
|
+
export declare type UserMeTargetSchema = {
|
|
2276
|
+
data: User | SsoUser | AccessToken | Account;
|
|
2277
|
+
included?: Role[];
|
|
2243
2278
|
};
|
|
2244
2279
|
/**
|
|
2245
2280
|
* A Single Sign-On user exists when a DatoCMS project is connected to an external Identity Provider. An SSO user will not use the standard login procedure but has to go through SAML authentication. It can also be linked to one or more IdP groups.
|
|
@@ -2363,171 +2398,183 @@ export declare type SsoUserDestroyTargetSchema = {
|
|
|
2363
2398
|
data: SsoUser;
|
|
2364
2399
|
};
|
|
2365
2400
|
/**
|
|
2366
|
-
*
|
|
2401
|
+
* An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
|
|
2367
2402
|
*
|
|
2368
2403
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2369
|
-
* via the `definition` "
|
|
2404
|
+
* via the `definition` "access_token".
|
|
2370
2405
|
*/
|
|
2371
|
-
export declare type
|
|
2372
|
-
type:
|
|
2373
|
-
id:
|
|
2374
|
-
attributes:
|
|
2375
|
-
|
|
2406
|
+
export declare type AccessToken = {
|
|
2407
|
+
type: AccessTokenType;
|
|
2408
|
+
id: AccessTokenIdentity;
|
|
2409
|
+
attributes: AccessTokenAttributes;
|
|
2410
|
+
relationships: AccessTokenRelationships;
|
|
2376
2411
|
};
|
|
2377
2412
|
/**
|
|
2378
2413
|
* JSON API attributes
|
|
2379
2414
|
*
|
|
2380
|
-
* This interface was referenced by `
|
|
2415
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2381
2416
|
* via the `definition` "attributes".
|
|
2382
2417
|
*/
|
|
2383
|
-
export declare type
|
|
2384
|
-
/**
|
|
2385
|
-
* The actual action performed
|
|
2386
|
-
*/
|
|
2387
|
-
action_name: string;
|
|
2418
|
+
export declare type AccessTokenAttributes = {
|
|
2388
2419
|
/**
|
|
2389
|
-
*
|
|
2420
|
+
* Name of API token
|
|
2390
2421
|
*/
|
|
2391
|
-
|
|
2392
|
-
/**
|
|
2393
|
-
* The type of actor (can be `account`, `user`, `sso_user` or `access_token`)
|
|
2394
|
-
*/
|
|
2395
|
-
type: string;
|
|
2396
|
-
/**
|
|
2397
|
-
* The ID of the actor
|
|
2398
|
-
*/
|
|
2399
|
-
id: string;
|
|
2400
|
-
/**
|
|
2401
|
-
* An human representation of the actor (name/email/username depending on the type of actor)
|
|
2402
|
-
*/
|
|
2403
|
-
name: string;
|
|
2404
|
-
};
|
|
2422
|
+
name: string;
|
|
2405
2423
|
/**
|
|
2406
|
-
* The
|
|
2424
|
+
* The actual API token (or null if the current user has no permission to read the token)
|
|
2407
2425
|
*/
|
|
2408
|
-
|
|
2409
|
-
/**
|
|
2410
|
-
* The name of the role
|
|
2411
|
-
*/
|
|
2412
|
-
name: string;
|
|
2413
|
-
/**
|
|
2414
|
-
* The ID of the role
|
|
2415
|
-
*/
|
|
2416
|
-
id: string;
|
|
2417
|
-
};
|
|
2426
|
+
token?: null | string;
|
|
2418
2427
|
/**
|
|
2419
|
-
*
|
|
2428
|
+
* Whether this API token can access the Content Delivery API published content endpoint
|
|
2420
2429
|
*/
|
|
2421
|
-
|
|
2422
|
-
/**
|
|
2423
|
-
* The ID of the environment
|
|
2424
|
-
*/
|
|
2425
|
-
id: string;
|
|
2426
|
-
/**
|
|
2427
|
-
* Whether the environment was the primary one at the time the action was performed
|
|
2428
|
-
*/
|
|
2429
|
-
primary: boolean;
|
|
2430
|
-
};
|
|
2430
|
+
can_access_cda: boolean;
|
|
2431
2431
|
/**
|
|
2432
|
-
*
|
|
2432
|
+
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
2433
2433
|
*/
|
|
2434
|
-
|
|
2435
|
-
/**
|
|
2436
|
-
* The full path of the request
|
|
2437
|
-
*/
|
|
2438
|
-
path: string;
|
|
2439
|
-
/**
|
|
2440
|
-
* The HTTP method of the request
|
|
2441
|
-
*/
|
|
2442
|
-
method: string;
|
|
2443
|
-
/**
|
|
2444
|
-
* The X-Request-ID header of the request
|
|
2445
|
-
*/
|
|
2446
|
-
id?: string;
|
|
2447
|
-
/**
|
|
2448
|
-
* The full HTTP body of the request
|
|
2449
|
-
*/
|
|
2450
|
-
payload?: null | {
|
|
2451
|
-
[k: string]: unknown;
|
|
2452
|
-
};
|
|
2453
|
-
};
|
|
2434
|
+
can_access_cda_preview: boolean;
|
|
2454
2435
|
/**
|
|
2455
|
-
*
|
|
2436
|
+
* Whether this API token can access the Content Management API
|
|
2456
2437
|
*/
|
|
2457
|
-
|
|
2458
|
-
|
|
2459
|
-
* The HTTP status code of the response
|
|
2460
|
-
*/
|
|
2461
|
-
status: number;
|
|
2462
|
-
/**
|
|
2463
|
-
* The full HTTP body of the response
|
|
2464
|
-
*/
|
|
2465
|
-
payload: {
|
|
2466
|
-
[k: string]: unknown;
|
|
2467
|
-
};
|
|
2468
|
-
};
|
|
2438
|
+
can_access_cma: boolean;
|
|
2439
|
+
hardcoded_type: null | string;
|
|
2469
2440
|
};
|
|
2470
2441
|
/**
|
|
2471
|
-
* JSON API
|
|
2442
|
+
* JSON API links
|
|
2472
2443
|
*
|
|
2473
|
-
* This interface was referenced by `
|
|
2474
|
-
* via the `definition` "
|
|
2444
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2445
|
+
* via the `definition` "relationships".
|
|
2475
2446
|
*/
|
|
2476
|
-
export declare type
|
|
2447
|
+
export declare type AccessTokenRelationships = {
|
|
2477
2448
|
/**
|
|
2478
|
-
*
|
|
2449
|
+
* Role
|
|
2479
2450
|
*/
|
|
2480
|
-
|
|
2451
|
+
role: {
|
|
2452
|
+
data: RoleData | null;
|
|
2453
|
+
};
|
|
2481
2454
|
};
|
|
2482
2455
|
/**
|
|
2483
2456
|
* JSON API data
|
|
2484
2457
|
*
|
|
2485
|
-
* This interface was referenced by `
|
|
2458
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2486
2459
|
* via the `definition` "data".
|
|
2487
2460
|
*/
|
|
2488
|
-
export declare type
|
|
2489
|
-
type:
|
|
2490
|
-
id:
|
|
2461
|
+
export declare type AccessTokenData = {
|
|
2462
|
+
type: AccessTokenType;
|
|
2463
|
+
id: AccessTokenIdentity;
|
|
2491
2464
|
};
|
|
2492
2465
|
/**
|
|
2493
|
-
* This interface was referenced by `
|
|
2494
|
-
* via the `
|
|
2466
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2467
|
+
* via the `create.schema` link.
|
|
2495
2468
|
*/
|
|
2496
|
-
export declare type
|
|
2469
|
+
export declare type AccessTokenCreateSchema = {
|
|
2497
2470
|
data: {
|
|
2498
|
-
|
|
2499
|
-
* JSON API type field
|
|
2500
|
-
*/
|
|
2501
|
-
type: 'audit_log_query';
|
|
2471
|
+
type: AccessTokenType;
|
|
2502
2472
|
attributes: {
|
|
2503
2473
|
/**
|
|
2504
|
-
*
|
|
2474
|
+
* Name of API token
|
|
2505
2475
|
*/
|
|
2506
|
-
|
|
2476
|
+
name: string;
|
|
2507
2477
|
/**
|
|
2508
|
-
*
|
|
2478
|
+
* Whether this API token can access the Content Delivery API published content endpoint
|
|
2509
2479
|
*/
|
|
2510
|
-
|
|
2480
|
+
can_access_cda: boolean;
|
|
2511
2481
|
/**
|
|
2512
|
-
* Whether
|
|
2482
|
+
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
2513
2483
|
*/
|
|
2514
|
-
|
|
2484
|
+
can_access_cda_preview: boolean;
|
|
2485
|
+
/**
|
|
2486
|
+
* Whether this API token can access the Content Management API
|
|
2487
|
+
*/
|
|
2488
|
+
can_access_cma: boolean;
|
|
2489
|
+
};
|
|
2490
|
+
relationships: {
|
|
2491
|
+
/**
|
|
2492
|
+
* Role
|
|
2493
|
+
*/
|
|
2494
|
+
role: {
|
|
2495
|
+
data: RoleData | null;
|
|
2496
|
+
};
|
|
2515
2497
|
};
|
|
2516
2498
|
};
|
|
2517
2499
|
};
|
|
2518
2500
|
/**
|
|
2519
|
-
* This interface was referenced by `
|
|
2520
|
-
* via the `
|
|
2501
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2502
|
+
* via the `create.targetSchema` link.
|
|
2521
2503
|
*/
|
|
2522
|
-
export declare type
|
|
2523
|
-
data:
|
|
2524
|
-
|
|
2525
|
-
|
|
2526
|
-
|
|
2527
|
-
|
|
2528
|
-
|
|
2504
|
+
export declare type AccessTokenCreateTargetSchema = {
|
|
2505
|
+
data: AccessToken;
|
|
2506
|
+
};
|
|
2507
|
+
/**
|
|
2508
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2509
|
+
* via the `update.schema` link.
|
|
2510
|
+
*/
|
|
2511
|
+
export declare type AccessTokenUpdateSchema = {
|
|
2512
|
+
data: {
|
|
2513
|
+
type: AccessTokenType;
|
|
2514
|
+
id: AccessTokenIdentity;
|
|
2515
|
+
attributes: {
|
|
2516
|
+
/**
|
|
2517
|
+
* Name of API token
|
|
2518
|
+
*/
|
|
2519
|
+
name: string;
|
|
2520
|
+
/**
|
|
2521
|
+
* Whether this API token can access the Content Delivery API published content endpoint
|
|
2522
|
+
*/
|
|
2523
|
+
can_access_cda: boolean;
|
|
2524
|
+
/**
|
|
2525
|
+
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
2526
|
+
*/
|
|
2527
|
+
can_access_cda_preview: boolean;
|
|
2528
|
+
/**
|
|
2529
|
+
* Whether this API token can access the Content Management API
|
|
2530
|
+
*/
|
|
2531
|
+
can_access_cma: boolean;
|
|
2532
|
+
};
|
|
2533
|
+
relationships: {
|
|
2534
|
+
/**
|
|
2535
|
+
* Role
|
|
2536
|
+
*/
|
|
2537
|
+
role: {
|
|
2538
|
+
data: RoleData | null;
|
|
2539
|
+
};
|
|
2540
|
+
};
|
|
2529
2541
|
};
|
|
2530
2542
|
};
|
|
2543
|
+
/**
|
|
2544
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2545
|
+
* via the `update.targetSchema` link.
|
|
2546
|
+
*/
|
|
2547
|
+
export declare type AccessTokenUpdateTargetSchema = {
|
|
2548
|
+
data: AccessToken;
|
|
2549
|
+
};
|
|
2550
|
+
/**
|
|
2551
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2552
|
+
* via the `instances.targetSchema` link.
|
|
2553
|
+
*/
|
|
2554
|
+
export declare type AccessTokenInstancesTargetSchema = {
|
|
2555
|
+
data: AccessToken[];
|
|
2556
|
+
};
|
|
2557
|
+
/**
|
|
2558
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2559
|
+
* via the `self.targetSchema` link.
|
|
2560
|
+
*/
|
|
2561
|
+
export declare type AccessTokenSelfTargetSchema = {
|
|
2562
|
+
data: AccessToken;
|
|
2563
|
+
};
|
|
2564
|
+
/**
|
|
2565
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2566
|
+
* via the `regenerate_token.targetSchema` link.
|
|
2567
|
+
*/
|
|
2568
|
+
export declare type AccessTokenRegenerateTokenTargetSchema = {
|
|
2569
|
+
data: AccessToken;
|
|
2570
|
+
};
|
|
2571
|
+
/**
|
|
2572
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
2573
|
+
* via the `destroy.targetSchema` link.
|
|
2574
|
+
*/
|
|
2575
|
+
export declare type AccessTokenDestroyTargetSchema = {
|
|
2576
|
+
data: AccessToken;
|
|
2577
|
+
};
|
|
2531
2578
|
/**
|
|
2532
2579
|
* DatoCMS account
|
|
2533
2580
|
*
|
|
@@ -2578,49 +2625,222 @@ export declare type AccountData = {
|
|
|
2578
2625
|
id: AccountIdentity;
|
|
2579
2626
|
};
|
|
2580
2627
|
/**
|
|
2581
|
-
*
|
|
2628
|
+
* This interface was referenced by `User`'s JSON-Schema
|
|
2629
|
+
* via the `destroy.targetSchema` link.
|
|
2630
|
+
*/
|
|
2631
|
+
export declare type UserDestroyTargetSchema = {
|
|
2632
|
+
data: User;
|
|
2633
|
+
};
|
|
2634
|
+
/**
|
|
2635
|
+
* If the Audit log functionality is enabled in a project, logged events can be queried using SQL-like language and fetched in full detail so that they can be exported or analyzed.
|
|
2582
2636
|
*
|
|
2583
2637
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2584
|
-
* via the `definition` "
|
|
2638
|
+
* via the `definition` "audit_log_event".
|
|
2585
2639
|
*/
|
|
2586
|
-
export declare type
|
|
2587
|
-
type:
|
|
2588
|
-
id:
|
|
2589
|
-
attributes:
|
|
2640
|
+
export declare type AuditLogEvent = {
|
|
2641
|
+
type: AuditLogEventType;
|
|
2642
|
+
id: AuditLogEventIdentity;
|
|
2643
|
+
attributes: AuditLogEventAttributes;
|
|
2644
|
+
meta: AuditLogEventMeta;
|
|
2590
2645
|
};
|
|
2591
2646
|
/**
|
|
2592
2647
|
* JSON API attributes
|
|
2593
2648
|
*
|
|
2594
|
-
* This interface was referenced by `
|
|
2649
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2595
2650
|
* via the `definition` "attributes".
|
|
2596
2651
|
*/
|
|
2597
|
-
export declare type
|
|
2652
|
+
export declare type AuditLogEventAttributes = {
|
|
2598
2653
|
/**
|
|
2599
|
-
* The
|
|
2654
|
+
* The actual action performed
|
|
2600
2655
|
*/
|
|
2601
|
-
|
|
2656
|
+
action_name: string;
|
|
2602
2657
|
/**
|
|
2603
|
-
*
|
|
2658
|
+
* The actor who performed the action
|
|
2604
2659
|
*/
|
|
2605
|
-
|
|
2660
|
+
actor: {
|
|
2661
|
+
/**
|
|
2662
|
+
* The type of actor (can be `account`, `user`, `sso_user` or `access_token`)
|
|
2663
|
+
*/
|
|
2664
|
+
type: string;
|
|
2665
|
+
/**
|
|
2666
|
+
* The ID of the actor
|
|
2667
|
+
*/
|
|
2668
|
+
id: string;
|
|
2669
|
+
/**
|
|
2670
|
+
* An human representation of the actor (name/email/username depending on the type of actor)
|
|
2671
|
+
*/
|
|
2672
|
+
name: string;
|
|
2673
|
+
};
|
|
2606
2674
|
/**
|
|
2607
|
-
*
|
|
2675
|
+
* The role of the actor at the time the action was performed
|
|
2608
2676
|
*/
|
|
2609
|
-
|
|
2677
|
+
role: null | {
|
|
2678
|
+
/**
|
|
2679
|
+
* The name of the role
|
|
2680
|
+
*/
|
|
2681
|
+
name: string;
|
|
2682
|
+
/**
|
|
2683
|
+
* The ID of the role
|
|
2684
|
+
*/
|
|
2685
|
+
id: string;
|
|
2686
|
+
};
|
|
2610
2687
|
/**
|
|
2611
|
-
*
|
|
2688
|
+
* The environment inside of which the action was performed
|
|
2612
2689
|
*/
|
|
2613
|
-
|
|
2690
|
+
environment: {
|
|
2691
|
+
/**
|
|
2692
|
+
* The ID of the environment
|
|
2693
|
+
*/
|
|
2694
|
+
id: string;
|
|
2695
|
+
/**
|
|
2696
|
+
* Whether the environment was the primary one at the time the action was performed
|
|
2697
|
+
*/
|
|
2698
|
+
primary: boolean;
|
|
2699
|
+
};
|
|
2614
2700
|
/**
|
|
2615
|
-
*
|
|
2701
|
+
* The actual request being performed
|
|
2616
2702
|
*/
|
|
2617
|
-
|
|
2703
|
+
request: {
|
|
2704
|
+
/**
|
|
2705
|
+
* The full path of the request
|
|
2706
|
+
*/
|
|
2707
|
+
path: string;
|
|
2708
|
+
/**
|
|
2709
|
+
* The HTTP method of the request
|
|
2710
|
+
*/
|
|
2711
|
+
method: string;
|
|
2712
|
+
/**
|
|
2713
|
+
* The X-Request-ID header of the request
|
|
2714
|
+
*/
|
|
2715
|
+
id?: string;
|
|
2716
|
+
/**
|
|
2717
|
+
* The full HTTP body of the request
|
|
2718
|
+
*/
|
|
2719
|
+
payload?: null | {
|
|
2720
|
+
[k: string]: unknown;
|
|
2721
|
+
};
|
|
2722
|
+
};
|
|
2618
2723
|
/**
|
|
2619
|
-
*
|
|
2724
|
+
* The actual response being returned by DatoCMS
|
|
2620
2725
|
*/
|
|
2621
|
-
|
|
2726
|
+
response: null | {
|
|
2727
|
+
/**
|
|
2728
|
+
* The HTTP status code of the response
|
|
2729
|
+
*/
|
|
2730
|
+
status: number;
|
|
2731
|
+
/**
|
|
2732
|
+
* The full HTTP body of the response
|
|
2733
|
+
*/
|
|
2734
|
+
payload: {
|
|
2735
|
+
[k: string]: unknown;
|
|
2736
|
+
};
|
|
2737
|
+
};
|
|
2738
|
+
};
|
|
2739
|
+
/**
|
|
2740
|
+
* JSON API meta
|
|
2741
|
+
*
|
|
2742
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2743
|
+
* via the `definition` "meta".
|
|
2744
|
+
*/
|
|
2745
|
+
export declare type AuditLogEventMeta = {
|
|
2622
2746
|
/**
|
|
2623
|
-
*
|
|
2747
|
+
* The date of the event
|
|
2748
|
+
*/
|
|
2749
|
+
occurred_at: string;
|
|
2750
|
+
};
|
|
2751
|
+
/**
|
|
2752
|
+
* JSON API data
|
|
2753
|
+
*
|
|
2754
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2755
|
+
* via the `definition` "data".
|
|
2756
|
+
*/
|
|
2757
|
+
export declare type AuditLogEventData = {
|
|
2758
|
+
type: AuditLogEventType;
|
|
2759
|
+
id: AuditLogEventIdentity;
|
|
2760
|
+
};
|
|
2761
|
+
/**
|
|
2762
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2763
|
+
* via the `query.schema` link.
|
|
2764
|
+
*/
|
|
2765
|
+
export declare type AuditLogEventQuerySchema = {
|
|
2766
|
+
data: {
|
|
2767
|
+
/**
|
|
2768
|
+
* JSON API type field
|
|
2769
|
+
*/
|
|
2770
|
+
type: 'audit_log_query';
|
|
2771
|
+
attributes: {
|
|
2772
|
+
/**
|
|
2773
|
+
* An SQL-like expression to filter the events
|
|
2774
|
+
*/
|
|
2775
|
+
filter?: string;
|
|
2776
|
+
/**
|
|
2777
|
+
* Set this value to get remaining results, if a meta.next_token was returned in the previous query response
|
|
2778
|
+
*/
|
|
2779
|
+
next_token?: string;
|
|
2780
|
+
/**
|
|
2781
|
+
* Whether a detailed log complete with full request and response payload must be returned or not
|
|
2782
|
+
*/
|
|
2783
|
+
detailed_log?: boolean;
|
|
2784
|
+
};
|
|
2785
|
+
};
|
|
2786
|
+
};
|
|
2787
|
+
/**
|
|
2788
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2789
|
+
* via the `query.targetSchema` link.
|
|
2790
|
+
*/
|
|
2791
|
+
export declare type AuditLogEventQueryTargetSchema = {
|
|
2792
|
+
data: AuditLogEvent[];
|
|
2793
|
+
meta: {
|
|
2794
|
+
/**
|
|
2795
|
+
* If the response request exceeds the response payload limit DatoCMS will set this value in the response. If set, you can use that this value in the subsequent request to get the remaining results
|
|
2796
|
+
*/
|
|
2797
|
+
next_token: null | string;
|
|
2798
|
+
};
|
|
2799
|
+
};
|
|
2800
|
+
/**
|
|
2801
|
+
* Stores the information regarding the current plan for the project.
|
|
2802
|
+
*
|
|
2803
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2804
|
+
* via the `definition` "site_plan".
|
|
2805
|
+
*/
|
|
2806
|
+
export declare type SitePlan = {
|
|
2807
|
+
type: SitePlanType;
|
|
2808
|
+
id: SitePlanIdentity;
|
|
2809
|
+
attributes: SitePlanAttributes;
|
|
2810
|
+
};
|
|
2811
|
+
/**
|
|
2812
|
+
* JSON API attributes
|
|
2813
|
+
*
|
|
2814
|
+
* This interface was referenced by `SitePlan`'s JSON-Schema
|
|
2815
|
+
* via the `definition` "attributes".
|
|
2816
|
+
*/
|
|
2817
|
+
export declare type SitePlanAttributes = {
|
|
2818
|
+
/**
|
|
2819
|
+
* The name of the plan
|
|
2820
|
+
*/
|
|
2821
|
+
name: string;
|
|
2822
|
+
/**
|
|
2823
|
+
* Whether this plan is active or legacy
|
|
2824
|
+
*/
|
|
2825
|
+
active: boolean;
|
|
2826
|
+
/**
|
|
2827
|
+
* Whether custom domain can be enabled or not
|
|
2828
|
+
*/
|
|
2829
|
+
custom_domain: boolean;
|
|
2830
|
+
/**
|
|
2831
|
+
* Number of users that can be invited
|
|
2832
|
+
*/
|
|
2833
|
+
users: null | number;
|
|
2834
|
+
/**
|
|
2835
|
+
* Number of indexable pages
|
|
2836
|
+
*/
|
|
2837
|
+
indexable_pages: null | number;
|
|
2838
|
+
/**
|
|
2839
|
+
* Number of build triggers
|
|
2840
|
+
*/
|
|
2841
|
+
build_triggers: null | number;
|
|
2842
|
+
/**
|
|
2843
|
+
* Number of plugins
|
|
2624
2844
|
*/
|
|
2625
2845
|
plugins: null | number;
|
|
2626
2846
|
/**
|
|
@@ -3105,6 +3325,12 @@ export declare type ItemTypeRelationships = {
|
|
|
3105
3325
|
fields: {
|
|
3106
3326
|
data: FieldData[];
|
|
3107
3327
|
};
|
|
3328
|
+
/**
|
|
3329
|
+
* The list of item type fieldsets
|
|
3330
|
+
*/
|
|
3331
|
+
fieldsets: {
|
|
3332
|
+
data: FieldsetData[];
|
|
3333
|
+
};
|
|
3108
3334
|
/**
|
|
3109
3335
|
* The field to use as display title
|
|
3110
3336
|
*/
|
|
@@ -3156,6 +3382,16 @@ export declare type FieldData = {
|
|
|
3156
3382
|
type: FieldType;
|
|
3157
3383
|
id: FieldIdentity;
|
|
3158
3384
|
};
|
|
3385
|
+
/**
|
|
3386
|
+
* JSON API data
|
|
3387
|
+
*
|
|
3388
|
+
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
3389
|
+
* via the `definition` "data".
|
|
3390
|
+
*/
|
|
3391
|
+
export declare type FieldsetData = {
|
|
3392
|
+
type: FieldsetType;
|
|
3393
|
+
id: FieldsetIdentity;
|
|
3394
|
+
};
|
|
3159
3395
|
/**
|
|
3160
3396
|
* JSON API data
|
|
3161
3397
|
*
|
|
@@ -3393,57 +3629,889 @@ export declare type Job = {
|
|
|
3393
3629
|
/**
|
|
3394
3630
|
* JSON API data
|
|
3395
3631
|
*
|
|
3396
|
-
* This interface was referenced by `Job`'s JSON-Schema
|
|
3397
|
-
* via the `definition` "data".
|
|
3398
|
-
*/
|
|
3399
|
-
export declare type JobData = {
|
|
3400
|
-
type: JobType;
|
|
3401
|
-
id: JobIdentity;
|
|
3402
|
-
};
|
|
3403
|
-
/**
|
|
3404
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3405
|
-
* via the `update.jobSchema` link.
|
|
3406
|
-
*/
|
|
3407
|
-
export declare type ItemTypeUpdateJobSchema = {
|
|
3408
|
-
data: ItemType;
|
|
3409
|
-
};
|
|
3410
|
-
/**
|
|
3411
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3412
|
-
* via the `instances.targetSchema` link.
|
|
3413
|
-
*/
|
|
3414
|
-
export declare type ItemTypeInstancesTargetSchema = {
|
|
3415
|
-
data: ItemType[];
|
|
3416
|
-
};
|
|
3417
|
-
/**
|
|
3418
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3419
|
-
* via the `self.targetSchema` link.
|
|
3420
|
-
*/
|
|
3421
|
-
export declare type ItemTypeSelfTargetSchema = {
|
|
3422
|
-
data: ItemType;
|
|
3423
|
-
};
|
|
3424
|
-
/**
|
|
3425
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3426
|
-
* via the `duplicate.targetSchema` link.
|
|
3427
|
-
*/
|
|
3428
|
-
export declare type ItemTypeDuplicateTargetSchema = {
|
|
3429
|
-
data: ItemType;
|
|
3430
|
-
};
|
|
3431
|
-
/**
|
|
3432
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3433
|
-
* via the `destroy.targetSchema` link.
|
|
3434
|
-
*/
|
|
3435
|
-
export declare type ItemTypeDestroyTargetSchema = {
|
|
3436
|
-
data: Job;
|
|
3437
|
-
};
|
|
3438
|
-
/**
|
|
3439
|
-
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3440
|
-
* via the `destroy.jobSchema` link.
|
|
3441
|
-
*/
|
|
3442
|
-
export declare type ItemTypeDestroyJobSchema = {
|
|
3443
|
-
data: ItemType;
|
|
3444
|
-
};
|
|
3445
|
-
/**
|
|
3446
|
-
*
|
|
3632
|
+
* This interface was referenced by `Job`'s JSON-Schema
|
|
3633
|
+
* via the `definition` "data".
|
|
3634
|
+
*/
|
|
3635
|
+
export declare type JobData = {
|
|
3636
|
+
type: JobType;
|
|
3637
|
+
id: JobIdentity;
|
|
3638
|
+
};
|
|
3639
|
+
/**
|
|
3640
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3641
|
+
* via the `update.jobSchema` link.
|
|
3642
|
+
*/
|
|
3643
|
+
export declare type ItemTypeUpdateJobSchema = {
|
|
3644
|
+
data: ItemType;
|
|
3645
|
+
};
|
|
3646
|
+
/**
|
|
3647
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3648
|
+
* via the `instances.targetSchema` link.
|
|
3649
|
+
*/
|
|
3650
|
+
export declare type ItemTypeInstancesTargetSchema = {
|
|
3651
|
+
data: ItemType[];
|
|
3652
|
+
};
|
|
3653
|
+
/**
|
|
3654
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3655
|
+
* via the `self.targetSchema` link.
|
|
3656
|
+
*/
|
|
3657
|
+
export declare type ItemTypeSelfTargetSchema = {
|
|
3658
|
+
data: ItemType;
|
|
3659
|
+
};
|
|
3660
|
+
/**
|
|
3661
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3662
|
+
* via the `duplicate.targetSchema` link.
|
|
3663
|
+
*/
|
|
3664
|
+
export declare type ItemTypeDuplicateTargetSchema = {
|
|
3665
|
+
data: ItemType;
|
|
3666
|
+
};
|
|
3667
|
+
/**
|
|
3668
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3669
|
+
* via the `destroy.targetSchema` link.
|
|
3670
|
+
*/
|
|
3671
|
+
export declare type ItemTypeDestroyTargetSchema = {
|
|
3672
|
+
data: Job;
|
|
3673
|
+
};
|
|
3674
|
+
/**
|
|
3675
|
+
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3676
|
+
* via the `destroy.jobSchema` link.
|
|
3677
|
+
*/
|
|
3678
|
+
export declare type ItemTypeDestroyJobSchema = {
|
|
3679
|
+
data: ItemType;
|
|
3680
|
+
};
|
|
3681
|
+
/**
|
|
3682
|
+
* DatoCMS offers a number of different fields that you can combine togheter to create a [Model](/docs/content-management-api/resources/item-type). Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `float`, etc.) and any required validation.
|
|
3683
|
+
*
|
|
3684
|
+
* ### Different field types require different settings
|
|
3685
|
+
*
|
|
3686
|
+
* When looking at a field resource, you have to pay attention to two particular properties, `validators` and `appearance`.
|
|
3687
|
+
*
|
|
3688
|
+
* The `validators` property expresses the set of validations to be performed server-side on a specific field value for it to be considered valid, while the `appearance` property lets you specify _how_ the field itself will be presented inside the form to the final editor.
|
|
3689
|
+
*
|
|
3690
|
+
* For both properties, the value to specify depends on the type of field itself. For example, you can add a "Limit character count" validation to a _Single-line string_ field, or set its appearence to "Show it as heading", but they won't be accepted for a ie. _Color_ field, as it supports different validations and appearance settings.
|
|
3691
|
+
*
|
|
3692
|
+
* ### Specifying validations
|
|
3693
|
+
*
|
|
3694
|
+
* The `validators` property requires an object whose keys are the validations that you want to be enforced, and the values are objects representing any settings that the validation itself requires. If the validation doesn't have additional settings, you just pass down an empty object.
|
|
3695
|
+
*
|
|
3696
|
+
* This is a valid example for a _Single-line string_ field:
|
|
3697
|
+
*
|
|
3698
|
+
* ```js
|
|
3699
|
+
* {
|
|
3700
|
+
* "validators": {
|
|
3701
|
+
* // "required" validator has no settings
|
|
3702
|
+
* "required": {},
|
|
3703
|
+
* // "length" validator requires "min" and/or "max" properties
|
|
3704
|
+
* "length": { "min": 80 }
|
|
3705
|
+
* }
|
|
3706
|
+
* }
|
|
3707
|
+
* ```
|
|
3708
|
+
*
|
|
3709
|
+
* Below you'll find a summary of all the validators available for each field type with their settings.
|
|
3710
|
+
*
|
|
3711
|
+
* Some validators are required for a specific type of field. For example, the _Slug_ field needs to have a `slug_title_field` validator to specify the ID of the _Single-line string_ field that will be used to generate the slug itself.
|
|
3712
|
+
*
|
|
3713
|
+
* ### Specifying the appearance
|
|
3714
|
+
*
|
|
3715
|
+
* The `appearance` property requires an object with three specific properties: `editor`, `parameters` and `addons`.
|
|
3716
|
+
*
|
|
3717
|
+
* The `editor` represents the type of editor that the users will see inside the form to change the value of this specific field. Depending on the type of field, DatoCMS offers a number of different editors for you to choose from. The `parameters` property is an object representing any additional settings that the editor itself might require.
|
|
3718
|
+
*
|
|
3719
|
+
* This is a valid example for a _Single-line string_ field:
|
|
3720
|
+
*
|
|
3721
|
+
* ```js
|
|
3722
|
+
* {
|
|
3723
|
+
* "appearance": {
|
|
3724
|
+
* // single_line is a DatoCMS built-in editor that you can use with single-line string fields
|
|
3725
|
+
* "editor": "single_line",
|
|
3726
|
+
* // each built-in editor has specific settings
|
|
3727
|
+
* "parameters": { "heading": true },
|
|
3728
|
+
* "addons": []
|
|
3729
|
+
* },
|
|
3730
|
+
* }
|
|
3731
|
+
* ```
|
|
3732
|
+
*
|
|
3733
|
+
* Following you'll find a summary of all the editors available for each field type with their settings.
|
|
3734
|
+
*
|
|
3735
|
+
* #### Setting the appearance to a field editor provided by a plugin
|
|
3736
|
+
*
|
|
3737
|
+
* If the project contains a plugin that exposes [manual field editors](/docs/plugin-sdk/manual-field-extensions), you can also configure the field to be presented with it instead of using one of the build-in editors.
|
|
3738
|
+
*
|
|
3739
|
+
* In this case:
|
|
3740
|
+
*
|
|
3741
|
+
* - the `editor` property must be the ID of the plugin;
|
|
3742
|
+
* - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes;
|
|
3743
|
+
* - the `parameters` property must provide a configuration object compatible with the [config screen of the manual field extension](/docs/plugin-sdk/manual-field-extensions#add-per-field-config-screens-to-manual-field-extensions), or an empty object if it doesn't require any configuration.
|
|
3744
|
+
*
|
|
3745
|
+
* ```js
|
|
3746
|
+
* {
|
|
3747
|
+
* "appearance": {
|
|
3748
|
+
* // "2132" is a the ID of a plugin exposing a manual field editor
|
|
3749
|
+
* "editor": "2134",
|
|
3750
|
+
* // "starRating" is a manual field editor exposed by the plugin
|
|
3751
|
+
* "field_extension": "starRating",
|
|
3752
|
+
* // this is a valid configuration for the "starRating" field editor
|
|
3753
|
+
* "parameters": { "maxRating": 5, "starsColor": "#ff0000" },
|
|
3754
|
+
* "addons": []
|
|
3755
|
+
* },
|
|
3756
|
+
* }
|
|
3757
|
+
* ```
|
|
3758
|
+
*
|
|
3759
|
+
* #### Configuring manual field addons
|
|
3760
|
+
*
|
|
3761
|
+
* If the project contains plugins that expose [manual field addons](/docs/plugin-sdk/manual-field-extensions), you can also add them to the field via the `addons` property.
|
|
3762
|
+
*
|
|
3763
|
+
* ```js
|
|
3764
|
+
* {
|
|
3765
|
+
* "appearance": {
|
|
3766
|
+
* "editor": "single_line",
|
|
3767
|
+
* "parameters": { "heading": true },
|
|
3768
|
+
* "addons": [
|
|
3769
|
+
* {
|
|
3770
|
+
* // "2138" is a the ID of a plugin exposing a manual addon editor
|
|
3771
|
+
* "id": "2138",
|
|
3772
|
+
* // "loremIpsumGenerator" is a manual field addon exposed by the plugin
|
|
3773
|
+
* "field_extension": "loremIpsumGenerator",
|
|
3774
|
+
* // this is a valid configuration for the "loremIpsumGenerator" field addon
|
|
3775
|
+
* "parameters": { "sentences": 2 },
|
|
3776
|
+
* }
|
|
3777
|
+
* ]
|
|
3778
|
+
* },
|
|
3779
|
+
* }
|
|
3780
|
+
* ```
|
|
3781
|
+
*
|
|
3782
|
+
* ### Available field types
|
|
3783
|
+
*
|
|
3784
|
+
* <details>
|
|
3785
|
+
* <summary>Single-line string (<code>string</code>)</summary>
|
|
3786
|
+
*
|
|
3787
|
+
* | Property | Value |
|
|
3788
|
+
* | ------------------------------ | ---------------------------------------------------- |
|
|
3789
|
+
* | Code | `string` |
|
|
3790
|
+
* | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
|
|
3791
|
+
* | Available validators | `required`, `unique`, `length`, `format`, `enum` |
|
|
3792
|
+
*
|
|
3793
|
+
* </details>
|
|
3794
|
+
*
|
|
3795
|
+
* <details>
|
|
3796
|
+
* <summary>Multi-line text (<code>text</code>)</summary>
|
|
3797
|
+
*
|
|
3798
|
+
* | Property | Value |
|
|
3799
|
+
* | ------------------------------ | --------------------------------- |
|
|
3800
|
+
* | Code | `text` |
|
|
3801
|
+
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
|
|
3802
|
+
* | Available validators | `required`, `length`, `format` |
|
|
3803
|
+
*
|
|
3804
|
+
* </details>
|
|
3805
|
+
*
|
|
3806
|
+
* <details>
|
|
3807
|
+
* <summary>Boolean (<code>boolean</code>)</summary>
|
|
3808
|
+
*
|
|
3809
|
+
* | Property | Value |
|
|
3810
|
+
* | ------------------------------ | -------------------------------- |
|
|
3811
|
+
* | Code | `boolean` |
|
|
3812
|
+
* | Built-in editors for the field | `boolean`, `boolean_radio_group` |
|
|
3813
|
+
* | Available validators | no validators available |
|
|
3814
|
+
*
|
|
3815
|
+
* </details>
|
|
3816
|
+
*
|
|
3817
|
+
* <details>
|
|
3818
|
+
* <summary>Integer (<code>integer</code>)</summary>
|
|
3819
|
+
*
|
|
3820
|
+
* | Property | Value |
|
|
3821
|
+
* | ------------------------------ | -------------------------- |
|
|
3822
|
+
* | Code | `integer` |
|
|
3823
|
+
* | Built-in editors for the field | `integer` |
|
|
3824
|
+
* | Available validators | `required`, `number_range` |
|
|
3825
|
+
*
|
|
3826
|
+
* </details>
|
|
3827
|
+
*
|
|
3828
|
+
* <details>
|
|
3829
|
+
* <summary>Float (<code>float</code>)</summary>
|
|
3830
|
+
*
|
|
3831
|
+
* | Property | Value |
|
|
3832
|
+
* | ------------------------------ | -------------------------- |
|
|
3833
|
+
* | Code | `float` |
|
|
3834
|
+
* | Built-in editors for the field | `float` |
|
|
3835
|
+
* | Available validators | `required`, `number_range` |
|
|
3836
|
+
*
|
|
3837
|
+
* </details>
|
|
3838
|
+
*
|
|
3839
|
+
* <details>
|
|
3840
|
+
* <summary>Date (<code>date</code>)</summary>
|
|
3841
|
+
*
|
|
3842
|
+
* | Property | Value |
|
|
3843
|
+
* | ------------------------------ | ------------------------ |
|
|
3844
|
+
* | Code | `date` |
|
|
3845
|
+
* | Built-in editors for the field | `date_picker` |
|
|
3846
|
+
* | Available validators | `required`, `date_range` |
|
|
3847
|
+
*
|
|
3848
|
+
* </details>
|
|
3849
|
+
*
|
|
3850
|
+
* <details>
|
|
3851
|
+
* <summary>Date time (<code>date_time</code>)</summary>
|
|
3852
|
+
*
|
|
3853
|
+
* | Property | Value |
|
|
3854
|
+
* | ------------------------------ | ----------------------------- |
|
|
3855
|
+
* | Code | `date_time` |
|
|
3856
|
+
* | Built-in editors for the field | `date_time_picker` |
|
|
3857
|
+
* | Available validators | `required`, `date_time_range` |
|
|
3858
|
+
*
|
|
3859
|
+
* </details>
|
|
3860
|
+
*
|
|
3861
|
+
* <details>
|
|
3862
|
+
* <summary>Color (<code>color</code>)</summary>
|
|
3863
|
+
*
|
|
3864
|
+
* | Property | Value |
|
|
3865
|
+
* | ------------------------------ | -------------- |
|
|
3866
|
+
* | Code | `color` |
|
|
3867
|
+
* | Built-in editors for the field | `color_picker` |
|
|
3868
|
+
* | Available validators | `required` |
|
|
3869
|
+
*
|
|
3870
|
+
* </details>
|
|
3871
|
+
*
|
|
3872
|
+
* <details>
|
|
3873
|
+
* <summary>JSON (<code>json</code>)</summary>
|
|
3874
|
+
*
|
|
3875
|
+
* | Property | Value |
|
|
3876
|
+
* | ------------------------------ | ------------------------------------------------------ |
|
|
3877
|
+
* | Code | `json` |
|
|
3878
|
+
* | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
|
|
3879
|
+
* | Available validators | `required` |
|
|
3880
|
+
*
|
|
3881
|
+
* </details>
|
|
3882
|
+
*
|
|
3883
|
+
* <details>
|
|
3884
|
+
* <summary>Location (<code>lat_lon</code>)</summary>
|
|
3885
|
+
*
|
|
3886
|
+
* | Property | Value |
|
|
3887
|
+
* | ------------------------------ | ---------- |
|
|
3888
|
+
* | Code | `lat_lon` |
|
|
3889
|
+
* | Built-in editors for the field | `map` |
|
|
3890
|
+
* | Available validators | `required` |
|
|
3891
|
+
*
|
|
3892
|
+
* </details>
|
|
3893
|
+
*
|
|
3894
|
+
* <details>
|
|
3895
|
+
* <summary>SEO (<code>seo</code>)</summary>
|
|
3896
|
+
*
|
|
3897
|
+
* | Property | Value |
|
|
3898
|
+
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
3899
|
+
* | Code | `seo` |
|
|
3900
|
+
* | Built-in editors for the field | `seo` |
|
|
3901
|
+
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
|
|
3902
|
+
*
|
|
3903
|
+
* </details>
|
|
3904
|
+
*
|
|
3905
|
+
* <details>
|
|
3906
|
+
* <summary>Slug (<code>slug</code>)</summary>
|
|
3907
|
+
*
|
|
3908
|
+
* | Property | Value |
|
|
3909
|
+
* | ------------------------------ | ----------------------------------- |
|
|
3910
|
+
* | Code | `slug` |
|
|
3911
|
+
* | Built-in editors for the field | `slug` |
|
|
3912
|
+
* | Required validators | `slug_title_field` |
|
|
3913
|
+
* | Other validators available | `required`, `length`, `slug_format` |
|
|
3914
|
+
*
|
|
3915
|
+
* </details>
|
|
3916
|
+
*
|
|
3917
|
+
* <details>
|
|
3918
|
+
* <summary>External video (<code>video</code>)</summary>
|
|
3919
|
+
*
|
|
3920
|
+
* | Property | Value |
|
|
3921
|
+
* | ------------------------------ | ---------- |
|
|
3922
|
+
* | Code | `video` |
|
|
3923
|
+
* | Built-in editors for the field | `video` |
|
|
3924
|
+
* | Available validators | `required` |
|
|
3925
|
+
*
|
|
3926
|
+
* </details>
|
|
3927
|
+
*
|
|
3928
|
+
* <details>
|
|
3929
|
+
* <summary>Single-asset (<code>file</code>)</summary>
|
|
3930
|
+
*
|
|
3931
|
+
* | Property | Value |
|
|
3932
|
+
* | ------------------------------ | ------------------------------------------------------------------------------ |
|
|
3933
|
+
* | Code | `file` |
|
|
3934
|
+
* | Built-in editors for the field | `file` |
|
|
3935
|
+
* | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
3936
|
+
*
|
|
3937
|
+
* </details>
|
|
3938
|
+
*
|
|
3939
|
+
* <details>
|
|
3940
|
+
* <summary>Asset gallery (<code>gallery</code>)</summary>
|
|
3941
|
+
*
|
|
3942
|
+
* | Property | Value |
|
|
3943
|
+
* | ------------------------------ | -------------------------------------------------------------------------- |
|
|
3944
|
+
* | Code | `gallery` |
|
|
3945
|
+
* | Built-in editors for the field | `gallery` |
|
|
3946
|
+
* | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
3947
|
+
*
|
|
3948
|
+
* </details>
|
|
3949
|
+
*
|
|
3950
|
+
* <details>
|
|
3951
|
+
* <summary>Single link (<code>link</code>)</summary>
|
|
3952
|
+
*
|
|
3953
|
+
* | Property | Value |
|
|
3954
|
+
* | ------------------------------ | --------------------------- |
|
|
3955
|
+
* | Code | `link` |
|
|
3956
|
+
* | Built-in editors for the field | `link_select`, `link_embed` |
|
|
3957
|
+
* | Default `editor` | `link_select` |
|
|
3958
|
+
* | Required validators | `item_item_type` |
|
|
3959
|
+
* | Other validators available | `required`, `unique` |
|
|
3960
|
+
*
|
|
3961
|
+
* </details>
|
|
3962
|
+
*
|
|
3963
|
+
* <details>
|
|
3964
|
+
* <summary>Multiple links (<code>links</code>)</summary>
|
|
3965
|
+
*
|
|
3966
|
+
* | Property | Value |
|
|
3967
|
+
* | ------------------------------ | ----------------------------- |
|
|
3968
|
+
* | Code | `links` |
|
|
3969
|
+
* | Built-in editors for the field | `links_select`, `links_embed` |
|
|
3970
|
+
* | Default `editor` | `links_select` |
|
|
3971
|
+
* | Required validators | `items_item_type` |
|
|
3972
|
+
* | Other validators available | `size` |
|
|
3973
|
+
*
|
|
3974
|
+
* </details>
|
|
3975
|
+
*
|
|
3976
|
+
* <details>
|
|
3977
|
+
* <summary>Modular content (<code>rich_text</code>)</summary>
|
|
3978
|
+
*
|
|
3979
|
+
* | Property | Value |
|
|
3980
|
+
* | ------------------------------ | ------------------ |
|
|
3981
|
+
* | Code | `rich_text` |
|
|
3982
|
+
* | Built-in editors for the field | `rich_text` |
|
|
3983
|
+
* | Required validators | `rich_text_blocks` |
|
|
3984
|
+
* | Other validators available | `size` |
|
|
3985
|
+
*
|
|
3986
|
+
* </details>
|
|
3987
|
+
*
|
|
3988
|
+
* <details>
|
|
3989
|
+
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
3990
|
+
*
|
|
3991
|
+
* | Property | Value |
|
|
3992
|
+
* | ------------------------------ | ------------------------------------------------- |
|
|
3993
|
+
* | Code | `structured_text` |
|
|
3994
|
+
* | Built-in editors for the field | `structured_text` |
|
|
3995
|
+
* | Required validators | `structured_text_blocks`, `structured_text_links` |
|
|
3996
|
+
* | Other validators available | `length` |
|
|
3997
|
+
*
|
|
3998
|
+
* </details>
|
|
3999
|
+
*
|
|
4000
|
+
* ### Validators
|
|
4001
|
+
*
|
|
4002
|
+
* <details>
|
|
4003
|
+
* <summary><code>date_range</code></summary>
|
|
4004
|
+
*
|
|
4005
|
+
* Accept dates only inside a specified date range.
|
|
4006
|
+
*
|
|
4007
|
+
* | Parameter | Type | Required | Description |
|
|
4008
|
+
* | --------- | ------------- | -------- | ------------ |
|
|
4009
|
+
* | `min` | ISO 8601 date | | Minimum date |
|
|
4010
|
+
* | `max` | ISO 8601 date | | Maximum date |
|
|
4011
|
+
*
|
|
4012
|
+
* At least one of the parameters must be specified.
|
|
4013
|
+
*
|
|
4014
|
+
* </details>
|
|
4015
|
+
*
|
|
4016
|
+
* <details>
|
|
4017
|
+
* <summary><code>date_time_range</code></summary>
|
|
4018
|
+
*
|
|
4019
|
+
* Accept date times only inside a specified date range.
|
|
4020
|
+
*
|
|
4021
|
+
* | Parameter | Type | Required | Description |
|
|
4022
|
+
* | --------- | ----------------- | -------- | ---------------- |
|
|
4023
|
+
* | `min` | ISO 8601 datetime | | Minimum datetime |
|
|
4024
|
+
* | `max` | ISO 8601 datetime | | Maximum datetime |
|
|
4025
|
+
*
|
|
4026
|
+
* At least one of the parameters must be specified.
|
|
4027
|
+
*
|
|
4028
|
+
* </details>
|
|
4029
|
+
*
|
|
4030
|
+
* <details>
|
|
4031
|
+
* <summary><code>enum</code></summary>
|
|
4032
|
+
*
|
|
4033
|
+
* Only accept a specific set of values
|
|
4034
|
+
*
|
|
4035
|
+
* | Parameter | Type | Required | Description |
|
|
4036
|
+
* | --------- | --------------- | -------- | --------------------- |
|
|
4037
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |
|
|
4038
|
+
*
|
|
4039
|
+
* </details>
|
|
4040
|
+
*
|
|
4041
|
+
* <details>
|
|
4042
|
+
* <summary><code>extension</code></summary>
|
|
4043
|
+
*
|
|
4044
|
+
* Only accept assets with specific file extensions.
|
|
4045
|
+
*
|
|
4046
|
+
* | Parameter | Type | Required | Description |
|
|
4047
|
+
* | ----------------- | ----------------------------------------- | -------- | ------------------------------ |
|
|
4048
|
+
* | `extensions` | `Array<String>` | | Set of allowed file extensions |
|
|
4049
|
+
* | `predefined_list` | one of `"image"`, `"video"`, `"document"` | | Allowed file type |
|
|
4050
|
+
*
|
|
4051
|
+
* Only one of the parameters must be specified.
|
|
4052
|
+
*
|
|
4053
|
+
* </details>
|
|
4054
|
+
*
|
|
4055
|
+
* <details>
|
|
4056
|
+
* <summary><code>file_size</code></summary>
|
|
4057
|
+
*
|
|
4058
|
+
* Accept assets only inside a specified date range.
|
|
4059
|
+
*
|
|
4060
|
+
* | Parameter | Type | Required | Description |
|
|
4061
|
+
* | ----------- | ---------------------------- | -------- | ---------------------------------- |
|
|
4062
|
+
* | `min_value` | `Integer` | | Numeric value for minimum filesize |
|
|
4063
|
+
* | `min_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for minimum filesize |
|
|
4064
|
+
* | `max_value` | `Integer` | | Numeric value for maximum filesize |
|
|
4065
|
+
* | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
|
|
4066
|
+
*
|
|
4067
|
+
* At least one couple of value/unit must be specified.
|
|
4068
|
+
*
|
|
4069
|
+
* </details>
|
|
4070
|
+
*
|
|
4071
|
+
* <details>
|
|
4072
|
+
* <summary><code>format</code></summary>
|
|
4073
|
+
*
|
|
4074
|
+
* Only accept strings having a specific format.
|
|
4075
|
+
*
|
|
4076
|
+
* | Parameter | Type | Required | Description |
|
|
4077
|
+
* | -------------------- | ------------------------- | -------- | ---------------------------------- |
|
|
4078
|
+
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
4079
|
+
* | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
|
|
4080
|
+
*
|
|
4081
|
+
* Only one of the parameters must be specified.
|
|
4082
|
+
*
|
|
4083
|
+
* </details>
|
|
4084
|
+
*
|
|
4085
|
+
* <details>
|
|
4086
|
+
* <summary><code>slug_format</code></summary>
|
|
4087
|
+
*
|
|
4088
|
+
* Only accept slugs having a specific format.
|
|
4089
|
+
*
|
|
4090
|
+
* | Parameter | Type | Required | Description |
|
|
4091
|
+
* | -------------------- | ---------------- | -------- | ---------------------------------- |
|
|
4092
|
+
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
4093
|
+
* | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
|
|
4094
|
+
*
|
|
4095
|
+
* Only one of the parameters must be specified.
|
|
4096
|
+
*
|
|
4097
|
+
* </details>
|
|
4098
|
+
*
|
|
4099
|
+
* <details>
|
|
4100
|
+
* <summary><code>image_dimensions</code></summary>
|
|
4101
|
+
*
|
|
4102
|
+
* Accept assets only within a specified height/width range.
|
|
4103
|
+
*
|
|
4104
|
+
* | Parameter | Type | Required | Description |
|
|
4105
|
+
* | ------------------ | --------- | -------- | -------------------------------- |
|
|
4106
|
+
* | `width_min_value` | `Integer` | | Numeric value for minimum width |
|
|
4107
|
+
* | `width_max_value` | `Integer` | | Numeric value for maximum height |
|
|
4108
|
+
* | `height_min_value` | `Integer` | | Numeric value for minimum width |
|
|
4109
|
+
* | `height_max_value` | `Integer` | | Numeric value for maximum height |
|
|
4110
|
+
*
|
|
4111
|
+
* At least one parameter must be specified.
|
|
4112
|
+
*
|
|
4113
|
+
* </details>
|
|
4114
|
+
*
|
|
4115
|
+
* <details>
|
|
4116
|
+
* <summary><code>item_item_type</code></summary>
|
|
4117
|
+
*
|
|
4118
|
+
* Only accept references to records of the specified models.
|
|
4119
|
+
*
|
|
4120
|
+
* | Parameter | Type | Required | Description |
|
|
4121
|
+
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4122
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4123
|
+
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4124
|
+
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4125
|
+
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
4126
|
+
*
|
|
4127
|
+
* Possible values for `on_publish_with_unpublished_references_strategy`:
|
|
4128
|
+
*
|
|
4129
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4130
|
+
* - `"publish_references"`: Publish also the referenced records
|
|
4131
|
+
*
|
|
4132
|
+
* Possible values for `on_reference_unpublish_strategy`:
|
|
4133
|
+
*
|
|
4134
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4135
|
+
* - `"unpublish"`: Unpublish also this record
|
|
4136
|
+
* - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
|
|
4137
|
+
*
|
|
4138
|
+
* Possible values for `on_reference_delete_strategy`:
|
|
4139
|
+
*
|
|
4140
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4141
|
+
* - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
|
|
4142
|
+
* </details>
|
|
4143
|
+
*
|
|
4144
|
+
* <details>
|
|
4145
|
+
* <summary><code>items_item_type</code></summary>
|
|
4146
|
+
*
|
|
4147
|
+
* Only accept references to records of the specified models.
|
|
4148
|
+
*
|
|
4149
|
+
* | Parameter | Type | Required | Description |
|
|
4150
|
+
* | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4151
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4152
|
+
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4153
|
+
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"fail"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4154
|
+
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
4155
|
+
*
|
|
4156
|
+
* Possible values for `on_publish_with_unpublished_references_strategy`:
|
|
4157
|
+
*
|
|
4158
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4159
|
+
* - `"publish_references"`: Publish also the referenced records
|
|
4160
|
+
*
|
|
4161
|
+
* Possible values for `on_reference_unpublish_strategy`:
|
|
4162
|
+
*
|
|
4163
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4164
|
+
* - `"unpublish"`: Unpublish also this record
|
|
4165
|
+
* - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
|
|
4166
|
+
*
|
|
4167
|
+
* Possible values for `on_reference_delete_strategy`:
|
|
4168
|
+
*
|
|
4169
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4170
|
+
* - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
|
|
4171
|
+
* </details>
|
|
4172
|
+
*
|
|
4173
|
+
* <details>
|
|
4174
|
+
* <summary><code>length</code></summary>
|
|
4175
|
+
*
|
|
4176
|
+
* Accept strings only with a specified number of characters.
|
|
4177
|
+
*
|
|
4178
|
+
* | Parameter | Type | Required | Description |
|
|
4179
|
+
* | --------- | --------- | -------- | --------------- |
|
|
4180
|
+
* | `min` | `Integer` | | Minimum length |
|
|
4181
|
+
* | `eq` | `Integer` | | Expected length |
|
|
4182
|
+
* | `max` | `Integer` | | Maximum length |
|
|
4183
|
+
*
|
|
4184
|
+
* At least one parameter must be specified.
|
|
4185
|
+
*
|
|
4186
|
+
* </details>
|
|
4187
|
+
*
|
|
4188
|
+
* <details>
|
|
4189
|
+
* <summary><code>number_range</code></summary>
|
|
4190
|
+
*
|
|
4191
|
+
* Accept numbers only inside a specified range.
|
|
4192
|
+
*
|
|
4193
|
+
* | Parameter | Type | Required | Description |
|
|
4194
|
+
* | --------- | ------- | -------- | ------------- |
|
|
4195
|
+
* | `min` | `Float` | | Minimum value |
|
|
4196
|
+
* | `max` | `Float` | | Maximum value |
|
|
4197
|
+
*
|
|
4198
|
+
* At least one of the parameters must be specified.
|
|
4199
|
+
*
|
|
4200
|
+
* </details>
|
|
4201
|
+
*
|
|
4202
|
+
* <details>
|
|
4203
|
+
* <summary><code>required</code></summary>
|
|
4204
|
+
*
|
|
4205
|
+
* Value must be specified or it won't be valid.
|
|
4206
|
+
*
|
|
4207
|
+
* </details>
|
|
4208
|
+
*
|
|
4209
|
+
* <details>
|
|
4210
|
+
* <summary><code>required_alt_title</code></summary>
|
|
4211
|
+
*
|
|
4212
|
+
* Assets contained in the field are required to specify custom title or alternate text, or they won't be valid.
|
|
4213
|
+
*
|
|
4214
|
+
* | Parameter | Type | Required | Description |
|
|
4215
|
+
* | --------- | --------- | -------- | ---------------------------------------------------------- |
|
|
4216
|
+
* | `title` | `Boolean` | | Whether the title for the asset must be specified |
|
|
4217
|
+
* | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
|
|
4218
|
+
*
|
|
4219
|
+
* At least one of the parameters must be specified.
|
|
4220
|
+
*
|
|
4221
|
+
* </details>
|
|
4222
|
+
*
|
|
4223
|
+
* <details>
|
|
4224
|
+
* <summary><code>required_seo_fields</code></summary>
|
|
4225
|
+
*
|
|
4226
|
+
* SEO field is to specify one or more properties, or it won't be valid.
|
|
4227
|
+
*
|
|
4228
|
+
* | Parameter | Type | Required | Description |
|
|
4229
|
+
* | -------------- | --------- | -------- | -------------------------------------------------- |
|
|
4230
|
+
* | `title` | `Boolean` | | Whether the meta title must be specified |
|
|
4231
|
+
* | `description` | `Boolean` | | Whether the meta description must be specified |
|
|
4232
|
+
* | `image` | `Boolean` | | Whether the social sharing image must be specified |
|
|
4233
|
+
* | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
|
|
4234
|
+
*
|
|
4235
|
+
* At least one of the parameters must be specified.
|
|
4236
|
+
*
|
|
4237
|
+
* </details>
|
|
4238
|
+
*
|
|
4239
|
+
* <details>
|
|
4240
|
+
* <summary><code>title_length</code></summary>
|
|
4241
|
+
*
|
|
4242
|
+
* Limits the length of the title for a SEO field. Search engines usually truncate title tags to 60 character so it is a good practice to keep the title around this length.
|
|
4243
|
+
*
|
|
4244
|
+
* | Parameter | Type | Required | Description |
|
|
4245
|
+
* | --------- | --------- | -------- | ------------- |
|
|
4246
|
+
* | `min` | `Integer` | | Minimum value |
|
|
4247
|
+
* | `max` | `Integer` | | Maximum value |
|
|
4248
|
+
*
|
|
4249
|
+
* At least one of the parameters must be specified.
|
|
4250
|
+
*
|
|
4251
|
+
* </details>
|
|
4252
|
+
*
|
|
4253
|
+
* <details>
|
|
4254
|
+
* <summary><code>description_length</code></summary>
|
|
4255
|
+
*
|
|
4256
|
+
* Limits the length of the description for a SEO field. Search engines usually truncate description tags to 160 character so it is a good practice to keep the description around this length.
|
|
4257
|
+
*
|
|
4258
|
+
* | Parameter | Type | Required | Description |
|
|
4259
|
+
* | --------- | --------- | -------- | ------------- |
|
|
4260
|
+
* | `min` | `Integer` | | Minimum value |
|
|
4261
|
+
* | `max` | `Integer` | | Maximum value |
|
|
4262
|
+
*
|
|
4263
|
+
* At least one of the parameters must be specified.
|
|
4264
|
+
*
|
|
4265
|
+
* </details>
|
|
4266
|
+
*
|
|
4267
|
+
* <details>
|
|
4268
|
+
* <summary><code>rich_text_blocks</code></summary>
|
|
4269
|
+
*
|
|
4270
|
+
* Only accept references to block records of the specified block models.
|
|
4271
|
+
*
|
|
4272
|
+
* | Parameter | Type | Required | Description |
|
|
4273
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4274
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4275
|
+
*
|
|
4276
|
+
* </details>
|
|
4277
|
+
*
|
|
4278
|
+
* <details>
|
|
4279
|
+
* <summary><code>structured_text_blocks</code></summary>
|
|
4280
|
+
*
|
|
4281
|
+
* Only accept references to block records of the specified block models.
|
|
4282
|
+
*
|
|
4283
|
+
* | Parameter | Type | Required | Description |
|
|
4284
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
4285
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
|
|
4286
|
+
*
|
|
4287
|
+
* </details>
|
|
4288
|
+
*
|
|
4289
|
+
* <details>
|
|
4290
|
+
* <summary><code>structured_text_links</code></summary>
|
|
4291
|
+
*
|
|
4292
|
+
* Only accept `itemLink` to `inlineItem` nodes for records of the specified models.
|
|
4293
|
+
*
|
|
4294
|
+
* | Parameter | Type | Required | Description |
|
|
4295
|
+
* | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
|
|
4296
|
+
* | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
|
|
4297
|
+
* | `on_publish_with_unpublished_references_strategy` | `"fail"`, `"publish_references"` (default value: `"fail"`) | | Strategy to apply when a publishing is requested and this field references some unpublished records |
|
|
4298
|
+
* | `on_reference_unpublish_strategy` | `"fail"`, `"unpublish"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when unpublishing is requested for a record referenced by this field |
|
|
4299
|
+
* | `on_reference_delete_strategy` | `"fail"`, `"delete_references"` (default value: `"delete_references"`) | | Strategy to apply when deletion is requested for a record referenced by this field |
|
|
4300
|
+
*
|
|
4301
|
+
* Possible values for `on_publish_with_unpublished_references_strategy`:
|
|
4302
|
+
*
|
|
4303
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4304
|
+
* - `"publish_references"`: Publish also the referenced records
|
|
4305
|
+
*
|
|
4306
|
+
* Possible values for `on_reference_unpublish_strategy`:
|
|
4307
|
+
*
|
|
4308
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4309
|
+
* - `"unpublish"`: Unpublish also this record
|
|
4310
|
+
* - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
|
|
4311
|
+
*
|
|
4312
|
+
* Possible values for `on_reference_delete_strategy`:
|
|
4313
|
+
*
|
|
4314
|
+
* - `"fail"`: Fail the operation and notify the user
|
|
4315
|
+
* - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
|
|
4316
|
+
* </details>
|
|
4317
|
+
*
|
|
4318
|
+
* <details>
|
|
4319
|
+
* <summary><code>size</code></summary>
|
|
4320
|
+
*
|
|
4321
|
+
* Only accept a number of items within the specified range.
|
|
4322
|
+
*
|
|
4323
|
+
* | Parameter | Type | Required | Description |
|
|
4324
|
+
* | ------------- | --------- | -------- | -------------------------------------------------- |
|
|
4325
|
+
* | `min` | `Integer` | | Minimum length |
|
|
4326
|
+
* | `eq` | `Integer` | | Expected length |
|
|
4327
|
+
* | `max` | `Integer` | | Maximum length |
|
|
4328
|
+
* | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
|
|
4329
|
+
*
|
|
4330
|
+
* At least one parameter must be specified.
|
|
4331
|
+
*
|
|
4332
|
+
* </details>
|
|
4333
|
+
*
|
|
4334
|
+
* <details>
|
|
4335
|
+
* <summary><code>slug_title_field</code></summary>
|
|
4336
|
+
*
|
|
4337
|
+
* Specifies the ID of the _Single-line string_ field that will be used to generate the slug
|
|
4338
|
+
*
|
|
4339
|
+
* | Parameter | Type | Required | Description |
|
|
4340
|
+
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
4341
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
|
|
4342
|
+
*
|
|
4343
|
+
* </details>
|
|
4344
|
+
*
|
|
4345
|
+
* <details>
|
|
4346
|
+
* <summary><code>unique</code></summary>
|
|
4347
|
+
*
|
|
4348
|
+
* The value must be unique across the whole collection of records.
|
|
4349
|
+
*
|
|
4350
|
+
* </details>
|
|
4351
|
+
*
|
|
4352
|
+
* ### Configuration parameters for DatoCMS built-in field editors
|
|
4353
|
+
*
|
|
4354
|
+
* If a field editor is not specified in this table, just pass an empty object `{}` as its configuration parameters.
|
|
4355
|
+
*
|
|
4356
|
+
* <details>
|
|
4357
|
+
* <summary><code>boolean_radio_group</code></summary>
|
|
4358
|
+
*
|
|
4359
|
+
* Radio group input for _boolean_ fields.
|
|
4360
|
+
*
|
|
4361
|
+
* | Parameter | Type | Required | Description |
|
|
4362
|
+
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
4363
|
+
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
4364
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
|
|
4365
|
+
*
|
|
4366
|
+
* </details>
|
|
4367
|
+
*
|
|
4368
|
+
* <details>
|
|
4369
|
+
* <summary><code>string_radio_group</code></summary>
|
|
4370
|
+
*
|
|
4371
|
+
* Radio group input for _string_ fields.
|
|
4372
|
+
*
|
|
4373
|
+
* | Parameter | Type | Required | Description |
|
|
4374
|
+
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
4375
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
|
|
4376
|
+
*
|
|
4377
|
+
* </details>
|
|
4378
|
+
*
|
|
4379
|
+
* <details>
|
|
4380
|
+
* <summary><code>string_select</code></summary>
|
|
4381
|
+
*
|
|
4382
|
+
* Select input for _string_ fields.
|
|
4383
|
+
*
|
|
4384
|
+
* | Parameter | Type | Required | Description |
|
|
4385
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4386
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4387
|
+
*
|
|
4388
|
+
* </details>
|
|
4389
|
+
*
|
|
4390
|
+
* <details>
|
|
4391
|
+
* <summary><code>string_multi_select</code></summary>
|
|
4392
|
+
*
|
|
4393
|
+
* Select input for _JSON_ fields, to edit an array of strings.
|
|
4394
|
+
*
|
|
4395
|
+
* | Parameter | Type | Required | Description |
|
|
4396
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4397
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4398
|
+
*
|
|
4399
|
+
* </details>
|
|
4400
|
+
*
|
|
4401
|
+
* <details>
|
|
4402
|
+
* <summary><code>string_checkbox_group</code></summary>
|
|
4403
|
+
*
|
|
4404
|
+
* Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
|
|
4405
|
+
*
|
|
4406
|
+
* | Parameter | Type | Required | Description |
|
|
4407
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4408
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
|
|
4409
|
+
*
|
|
4410
|
+
* </details>
|
|
4411
|
+
*
|
|
4412
|
+
* <details>
|
|
4413
|
+
* <summary><code>single_line</code></summary>
|
|
4414
|
+
*
|
|
4415
|
+
* Simple textual input for _Single-line string_ fields.
|
|
4416
|
+
*
|
|
4417
|
+
* | Parameter | Type | Required | Description |
|
|
4418
|
+
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
4419
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
|
|
4420
|
+
*
|
|
4421
|
+
* </details>
|
|
4422
|
+
*
|
|
4423
|
+
* <details>
|
|
4424
|
+
* <summary><code>markdown</code></summary>
|
|
4425
|
+
*
|
|
4426
|
+
* Markdown editor for _Multiple-paragraph text_ fields.
|
|
4427
|
+
*
|
|
4428
|
+
* | Parameter | Type | Required | Description |
|
|
4429
|
+
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4430
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"heading"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"unordered_list"`, `"ordered_list"`, `"quote"`, `"link"`, `"image"`, `"fullscreen"` |
|
|
4431
|
+
*
|
|
4432
|
+
* </details>
|
|
4433
|
+
*
|
|
4434
|
+
* <details>
|
|
4435
|
+
* <summary><code>wysiwyg</code></summary>
|
|
4436
|
+
*
|
|
4437
|
+
* HTML editor for _Multiple-paragraph text_ fields.
|
|
4438
|
+
*
|
|
4439
|
+
* | Parameter | Type | Required | Description |
|
|
4440
|
+
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4441
|
+
* | `toolbar` | `Array<String>` | ✅ | Specify which buttons the toolbar should have. Valid values: `"format"`, `"bold"`, `"italic"`, `"strikethrough"`, `"code"`, `"ordered_list"`, `"unordered_list"`, `"quote"`, `"table"`, `"link"`, `"image"`, `"show_source"`, `"undo"`, `"redo"`, `"align_left"`, `"align_center"`, `"align_right"`, `"align_justify"`, `"outdent"`, `"indent"`, `"fullscreen"` |
|
|
4442
|
+
*
|
|
4443
|
+
* </details>
|
|
4444
|
+
*
|
|
4445
|
+
* <details>
|
|
4446
|
+
* <summary><code>textarea</code></summary>
|
|
4447
|
+
*
|
|
4448
|
+
* Basic textarea editor for _Multiple-paragraph text_ fields.
|
|
4449
|
+
*
|
|
4450
|
+
* </details>
|
|
4451
|
+
*
|
|
4452
|
+
* <details>
|
|
4453
|
+
* <summary><code>color_picker</code></summary>
|
|
4454
|
+
*
|
|
4455
|
+
* Built-in editor for _Color_ fields.
|
|
4456
|
+
*
|
|
4457
|
+
* | Parameter | Type | Required | Description |
|
|
4458
|
+
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
4459
|
+
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
4460
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
|
|
4461
|
+
*
|
|
4462
|
+
* </details>
|
|
4463
|
+
*
|
|
4464
|
+
* <details>
|
|
4465
|
+
* <summary><code>slug</code></summary>
|
|
4466
|
+
*
|
|
4467
|
+
* Built-in editor for _Slug_ fields.
|
|
4468
|
+
*
|
|
4469
|
+
* | Parameter | Type | Required | Description |
|
|
4470
|
+
* | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
|
|
4471
|
+
* | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. |
|
|
4472
|
+
*
|
|
4473
|
+
* </details>
|
|
4474
|
+
*
|
|
4475
|
+
* <details>
|
|
4476
|
+
* <summary><code>rich_text</code></summary>
|
|
4477
|
+
*
|
|
4478
|
+
* Built-in editor for _Modular content_ fields.
|
|
4479
|
+
*
|
|
4480
|
+
* | Parameter | Type | Required | Description |
|
|
4481
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
4482
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not |
|
|
4483
|
+
*
|
|
4484
|
+
* </details>
|
|
4485
|
+
*
|
|
4486
|
+
* <details>
|
|
4487
|
+
* <summary><code>structured_text</code></summary>
|
|
4488
|
+
*
|
|
4489
|
+
* Built-in editor for _Structured text_ fields.
|
|
4490
|
+
*
|
|
4491
|
+
* | Parameter | Type | Required | Description |
|
|
4492
|
+
* | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4493
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
4494
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
4495
|
+
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
4496
|
+
* | `show_links_target_blank` | `Boolean` | | Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the `target: "_blank"` meta attribute for links |
|
|
4497
|
+
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
|
|
4498
|
+
*
|
|
4499
|
+
* </details>
|
|
4500
|
+
*
|
|
4501
|
+
* <details>
|
|
4502
|
+
* <summary><code>link_select</code> and <code>links_select</code></summary>
|
|
4503
|
+
*
|
|
4504
|
+
* Use a select input with auto-completion to pick the records to reference inside the field.
|
|
4505
|
+
*
|
|
4506
|
+
* </details>
|
|
4507
|
+
*
|
|
4508
|
+
* <details>
|
|
4509
|
+
* <summary><code>link_embed</code> and <code>links_embed</code></summary>
|
|
4510
|
+
*
|
|
4511
|
+
* Use an expanded view with records' image preview to pick the records to reference inside the field.
|
|
4512
|
+
*
|
|
4513
|
+
* </details>
|
|
4514
|
+
*
|
|
3447
4515
|
*
|
|
3448
4516
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3449
4517
|
* via the `definition` "field".
|
|
@@ -3565,16 +4633,6 @@ export declare type FieldRelationships = {
|
|
|
3565
4633
|
data: null | FieldsetData;
|
|
3566
4634
|
};
|
|
3567
4635
|
};
|
|
3568
|
-
/**
|
|
3569
|
-
* JSON API data
|
|
3570
|
-
*
|
|
3571
|
-
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
3572
|
-
* via the `definition` "data".
|
|
3573
|
-
*/
|
|
3574
|
-
export declare type FieldsetData = {
|
|
3575
|
-
type: FieldsetType;
|
|
3576
|
-
id: FieldsetIdentity;
|
|
3577
|
-
};
|
|
3578
4636
|
/**
|
|
3579
4637
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
3580
4638
|
* via the `create.schema` link.
|
|
@@ -4104,184 +5162,6 @@ export declare type SessionCreateTargetSchema = {
|
|
|
4104
5162
|
data: Session;
|
|
4105
5163
|
included: User[];
|
|
4106
5164
|
};
|
|
4107
|
-
/**
|
|
4108
|
-
* An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
|
|
4109
|
-
*
|
|
4110
|
-
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4111
|
-
* via the `definition` "access_token".
|
|
4112
|
-
*/
|
|
4113
|
-
export declare type AccessToken = {
|
|
4114
|
-
type: AccessTokenType;
|
|
4115
|
-
id: AccessTokenIdentity;
|
|
4116
|
-
attributes: AccessTokenAttributes;
|
|
4117
|
-
relationships: AccessTokenRelationships;
|
|
4118
|
-
};
|
|
4119
|
-
/**
|
|
4120
|
-
* JSON API attributes
|
|
4121
|
-
*
|
|
4122
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4123
|
-
* via the `definition` "attributes".
|
|
4124
|
-
*/
|
|
4125
|
-
export declare type AccessTokenAttributes = {
|
|
4126
|
-
/**
|
|
4127
|
-
* Name of API token
|
|
4128
|
-
*/
|
|
4129
|
-
name: string;
|
|
4130
|
-
/**
|
|
4131
|
-
* The actual API token
|
|
4132
|
-
*/
|
|
4133
|
-
token?: string;
|
|
4134
|
-
/**
|
|
4135
|
-
* Whether this API token can access the Content Delivery API published content endpoint
|
|
4136
|
-
*/
|
|
4137
|
-
can_access_cda: boolean;
|
|
4138
|
-
/**
|
|
4139
|
-
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
4140
|
-
*/
|
|
4141
|
-
can_access_cda_preview: boolean;
|
|
4142
|
-
/**
|
|
4143
|
-
* Whether this API token can access the Content Management API
|
|
4144
|
-
*/
|
|
4145
|
-
can_access_cma: boolean;
|
|
4146
|
-
hardcoded_type: null | string;
|
|
4147
|
-
};
|
|
4148
|
-
/**
|
|
4149
|
-
* JSON API links
|
|
4150
|
-
*
|
|
4151
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4152
|
-
* via the `definition` "relationships".
|
|
4153
|
-
*/
|
|
4154
|
-
export declare type AccessTokenRelationships = {
|
|
4155
|
-
/**
|
|
4156
|
-
* Role
|
|
4157
|
-
*/
|
|
4158
|
-
role: {
|
|
4159
|
-
data: RoleData | null;
|
|
4160
|
-
};
|
|
4161
|
-
};
|
|
4162
|
-
/**
|
|
4163
|
-
* JSON API data
|
|
4164
|
-
*
|
|
4165
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4166
|
-
* via the `definition` "data".
|
|
4167
|
-
*/
|
|
4168
|
-
export declare type AccessTokenData = {
|
|
4169
|
-
type: AccessTokenType;
|
|
4170
|
-
id: AccessTokenIdentity;
|
|
4171
|
-
};
|
|
4172
|
-
/**
|
|
4173
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4174
|
-
* via the `create.schema` link.
|
|
4175
|
-
*/
|
|
4176
|
-
export declare type AccessTokenCreateSchema = {
|
|
4177
|
-
data: {
|
|
4178
|
-
type: AccessTokenType;
|
|
4179
|
-
attributes: {
|
|
4180
|
-
/**
|
|
4181
|
-
* Name of API token
|
|
4182
|
-
*/
|
|
4183
|
-
name: string;
|
|
4184
|
-
/**
|
|
4185
|
-
* Whether this API token can access the Content Delivery API published content endpoint
|
|
4186
|
-
*/
|
|
4187
|
-
can_access_cda: boolean;
|
|
4188
|
-
/**
|
|
4189
|
-
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
4190
|
-
*/
|
|
4191
|
-
can_access_cda_preview: boolean;
|
|
4192
|
-
/**
|
|
4193
|
-
* Whether this API token can access the Content Management API
|
|
4194
|
-
*/
|
|
4195
|
-
can_access_cma: boolean;
|
|
4196
|
-
};
|
|
4197
|
-
relationships: {
|
|
4198
|
-
/**
|
|
4199
|
-
* Role
|
|
4200
|
-
*/
|
|
4201
|
-
role: {
|
|
4202
|
-
data: RoleData | null;
|
|
4203
|
-
};
|
|
4204
|
-
};
|
|
4205
|
-
};
|
|
4206
|
-
};
|
|
4207
|
-
/**
|
|
4208
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4209
|
-
* via the `create.targetSchema` link.
|
|
4210
|
-
*/
|
|
4211
|
-
export declare type AccessTokenCreateTargetSchema = {
|
|
4212
|
-
data: AccessToken;
|
|
4213
|
-
};
|
|
4214
|
-
/**
|
|
4215
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4216
|
-
* via the `update.schema` link.
|
|
4217
|
-
*/
|
|
4218
|
-
export declare type AccessTokenUpdateSchema = {
|
|
4219
|
-
data: {
|
|
4220
|
-
type: AccessTokenType;
|
|
4221
|
-
id: AccessTokenIdentity;
|
|
4222
|
-
attributes: {
|
|
4223
|
-
/**
|
|
4224
|
-
* Name of API token
|
|
4225
|
-
*/
|
|
4226
|
-
name: string;
|
|
4227
|
-
/**
|
|
4228
|
-
* Whether this API token can access the Content Delivery API published content endpoint
|
|
4229
|
-
*/
|
|
4230
|
-
can_access_cda: boolean;
|
|
4231
|
-
/**
|
|
4232
|
-
* Whether this API token can access the Content Delivery API draft content endpoint
|
|
4233
|
-
*/
|
|
4234
|
-
can_access_cda_preview: boolean;
|
|
4235
|
-
/**
|
|
4236
|
-
* Whether this API token can access the Content Management API
|
|
4237
|
-
*/
|
|
4238
|
-
can_access_cma: boolean;
|
|
4239
|
-
};
|
|
4240
|
-
relationships: {
|
|
4241
|
-
/**
|
|
4242
|
-
* Role
|
|
4243
|
-
*/
|
|
4244
|
-
role: {
|
|
4245
|
-
data: RoleData | null;
|
|
4246
|
-
};
|
|
4247
|
-
};
|
|
4248
|
-
};
|
|
4249
|
-
};
|
|
4250
|
-
/**
|
|
4251
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4252
|
-
* via the `update.targetSchema` link.
|
|
4253
|
-
*/
|
|
4254
|
-
export declare type AccessTokenUpdateTargetSchema = {
|
|
4255
|
-
data: AccessToken;
|
|
4256
|
-
};
|
|
4257
|
-
/**
|
|
4258
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4259
|
-
* via the `instances.targetSchema` link.
|
|
4260
|
-
*/
|
|
4261
|
-
export declare type AccessTokenInstancesTargetSchema = {
|
|
4262
|
-
data: AccessToken[];
|
|
4263
|
-
};
|
|
4264
|
-
/**
|
|
4265
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4266
|
-
* via the `self.targetSchema` link.
|
|
4267
|
-
*/
|
|
4268
|
-
export declare type AccessTokenSelfTargetSchema = {
|
|
4269
|
-
data: AccessToken;
|
|
4270
|
-
};
|
|
4271
|
-
/**
|
|
4272
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4273
|
-
* via the `regenerate_token.targetSchema` link.
|
|
4274
|
-
*/
|
|
4275
|
-
export declare type AccessTokenRegenerateTokenTargetSchema = {
|
|
4276
|
-
data: AccessToken;
|
|
4277
|
-
};
|
|
4278
|
-
/**
|
|
4279
|
-
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4280
|
-
* via the `destroy.targetSchema` link.
|
|
4281
|
-
*/
|
|
4282
|
-
export declare type AccessTokenDestroyTargetSchema = {
|
|
4283
|
-
data: AccessToken;
|
|
4284
|
-
};
|
|
4285
5165
|
/**
|
|
4286
5166
|
* Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.
|
|
4287
5167
|
*
|
|
@@ -8282,7 +9162,7 @@ export declare type SiteData = {
|
|
|
8282
9162
|
*/
|
|
8283
9163
|
export declare type SiteSelfTargetSchema = {
|
|
8284
9164
|
data: Site;
|
|
8285
|
-
included?: (MenuItem | User | ItemType | Role | Field | Upload | SsoUser)[];
|
|
9165
|
+
included?: (MenuItem | User | ItemType | Role | Field | Upload | SsoUser | Fieldset | Item | Account)[];
|
|
8286
9166
|
};
|
|
8287
9167
|
/**
|
|
8288
9168
|
* This interface was referenced by `Site`'s JSON-Schema
|