@datocms/cma-client 0.1.8 → 1.1.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.
Files changed (36) hide show
  1. package/dist/cjs/generated/resources/Item.js.map +1 -1
  2. package/dist/cjs/generated/resources/SearchResult.js +116 -0
  3. package/dist/cjs/generated/resources/SearchResult.js.map +1 -1
  4. package/dist/cjs/generated/resources/Site.js +4 -3
  5. package/dist/cjs/generated/resources/Site.js.map +1 -1
  6. package/dist/cjs/generated/resources/User.js +26 -3
  7. package/dist/cjs/generated/resources/User.js.map +1 -1
  8. package/dist/esm/buildBlockRecord.d.ts +1 -1
  9. package/dist/esm/generated/SchemaTypes.d.ts +1301 -440
  10. package/dist/esm/generated/SimpleSchemaTypes.d.ts +1354 -508
  11. package/dist/esm/generated/resources/Item.d.ts +6 -6
  12. package/dist/esm/generated/resources/Item.js.map +1 -1
  13. package/dist/esm/generated/resources/SearchResult.d.ts +15 -2
  14. package/dist/esm/generated/resources/SearchResult.js +116 -0
  15. package/dist/esm/generated/resources/SearchResult.js.map +1 -1
  16. package/dist/esm/generated/resources/Site.d.ts +2 -2
  17. package/dist/esm/generated/resources/Site.js +4 -3
  18. package/dist/esm/generated/resources/Site.js.map +1 -1
  19. package/dist/esm/generated/resources/User.d.ts +14 -2
  20. package/dist/esm/generated/resources/User.js +26 -3
  21. package/dist/esm/generated/resources/User.js.map +1 -1
  22. package/dist/types/buildBlockRecord.d.ts +1 -1
  23. package/dist/types/generated/SchemaTypes.d.ts +1301 -440
  24. package/dist/types/generated/SimpleSchemaTypes.d.ts +1354 -508
  25. package/dist/types/generated/resources/Item.d.ts +6 -6
  26. package/dist/types/generated/resources/SearchResult.d.ts +15 -2
  27. package/dist/types/generated/resources/Site.d.ts +2 -2
  28. package/dist/types/generated/resources/User.d.ts +14 -2
  29. package/package.json +4 -4
  30. package/resources.json +10 -0
  31. package/src/generated/SchemaTypes.ts +1308 -446
  32. package/src/generated/SimpleSchemaTypes.ts +1354 -508
  33. package/src/generated/resources/Item.ts +6 -6
  34. package/src/generated/resources/SearchResult.ts +42 -2
  35. package/src/generated/resources/Site.ts +6 -3
  36. 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 `destroy.hrefSchema` link.
80
+ * via the `self.hrefSchema` link.
81
81
  */
82
- export declare type UserDestroyHrefSchema = {
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
- * New owner for resources previously owned by the deleted user. This argument specifies the new owner ID.
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
- destination_user_id?: string;
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 `AuditLogEvent`'s JSON-Schema
141
+ * This interface was referenced by `AccessToken`'s JSON-Schema
146
142
  * via the `definition` "type".
147
143
  */
148
- export declare type AuditLogEventType = 'audit_log_event';
144
+ export declare type AccessTokenType = 'access_token';
149
145
  /**
150
- * ULID of event (https://github.com/ulid/spec)
146
+ * ID of access_token
151
147
  *
152
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
148
+ * This interface was referenced by `AccessToken`'s JSON-Schema
153
149
  * via the `definition` "identity".
154
150
  *
155
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
151
+ * This interface was referenced by `AccessToken`'s JSON-Schema
156
152
  * via the `definition` "id".
157
153
  */
158
- export declare type AuditLogEventIdentity = string;
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
  *
@@ -804,25 +826,37 @@ export declare type SearchResultIdentity = string;
804
826
  */
805
827
  export declare type SearchResultInstancesHrefSchema = {
806
828
  /**
807
- * The query string to search
808
- */
809
- q: string;
810
- /**
811
- * The build trigger ID on which the search will be performed
812
- */
813
- build_trigger_id?: string;
814
- /**
815
- * Restrict the search on one locale
816
- */
817
- locale?: string;
818
- /**
819
- * Maximum number of results to return (defaults to 20, maximum is 100)
829
+ * Attributes to manage results pagination
820
830
  */
821
- limit?: number;
831
+ page?: {
832
+ /**
833
+ * Index of first element to fetch (defaults to 0)
834
+ */
835
+ offset?: number;
836
+ /**
837
+ * Number of elements to fetch (defaults to 20, maximum is 100)
838
+ */
839
+ limit?: number;
840
+ [k: string]: unknown;
841
+ };
822
842
  /**
823
- * Number of records to offset for the search
843
+ * Attributes to filter search results
824
844
  */
825
- offset?: string;
845
+ filter: {
846
+ /**
847
+ * Text to search
848
+ */
849
+ query: string;
850
+ /**
851
+ * The build trigger ID on which the search will be performed. Required if more than one build trigger is present in a project
852
+ */
853
+ build_trigger_id?: string;
854
+ /**
855
+ * Restrict the search on pages in a specific locale
856
+ */
857
+ locale?: string;
858
+ [k: string]: unknown;
859
+ };
826
860
  [k: string]: unknown;
827
861
  };
828
862
  /**
@@ -1191,6 +1225,17 @@ export declare type SiteType = 'site';
1191
1225
  * via the `definition` "id".
1192
1226
  */
1193
1227
  export declare type SiteIdentity = string;
1228
+ /**
1229
+ * This interface was referenced by `Site`'s JSON-Schema
1230
+ * via the `self.hrefSchema` link.
1231
+ */
1232
+ export declare type SiteSelfHrefSchema = {
1233
+ /**
1234
+ * 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`.
1235
+ */
1236
+ include?: string;
1237
+ [k: string]: unknown;
1238
+ };
1194
1239
  export declare type DatoApi = {
1195
1240
  role?: Role;
1196
1241
  user?: User;
@@ -2233,13 +2278,15 @@ export declare type UserInstancesTargetSchema = {
2233
2278
  */
2234
2279
  export declare type UserSelfTargetSchema = {
2235
2280
  data: User;
2281
+ included?: Role[];
2236
2282
  };
2237
2283
  /**
2238
2284
  * This interface was referenced by `User`'s JSON-Schema
2239
- * via the `destroy.targetSchema` link.
2285
+ * via the `me.targetSchema` link.
2240
2286
  */
2241
- export declare type UserDestroyTargetSchema = {
2242
- data: User;
2287
+ export declare type UserMeTargetSchema = {
2288
+ data: User | SsoUser | AccessToken | Account;
2289
+ included?: Role[];
2243
2290
  };
2244
2291
  /**
2245
2292
  * 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 +2410,183 @@ export declare type SsoUserDestroyTargetSchema = {
2363
2410
  data: SsoUser;
2364
2411
  };
2365
2412
  /**
2366
- * 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.
2413
+ * An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
2367
2414
  *
2368
2415
  * This interface was referenced by `DatoApi`'s JSON-Schema
2369
- * via the `definition` "audit_log_event".
2416
+ * via the `definition` "access_token".
2370
2417
  */
2371
- export declare type AuditLogEvent = {
2372
- type: AuditLogEventType;
2373
- id: AuditLogEventIdentity;
2374
- attributes: AuditLogEventAttributes;
2375
- meta: AuditLogEventMeta;
2418
+ export declare type AccessToken = {
2419
+ type: AccessTokenType;
2420
+ id: AccessTokenIdentity;
2421
+ attributes: AccessTokenAttributes;
2422
+ relationships: AccessTokenRelationships;
2376
2423
  };
2377
2424
  /**
2378
2425
  * JSON API attributes
2379
2426
  *
2380
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2427
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2381
2428
  * via the `definition` "attributes".
2382
2429
  */
2383
- export declare type AuditLogEventAttributes = {
2430
+ export declare type AccessTokenAttributes = {
2384
2431
  /**
2385
- * The actual action performed
2432
+ * Name of API token
2386
2433
  */
2387
- action_name: string;
2434
+ name: string;
2388
2435
  /**
2389
- * The actor who performed the action
2436
+ * The actual API token (or null if the current user has no permission to read the token)
2390
2437
  */
2391
- actor: {
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
- };
2438
+ token?: null | string;
2405
2439
  /**
2406
- * The role of the actor at the time the action was performed
2440
+ * Whether this API token can access the Content Delivery API published content endpoint
2407
2441
  */
2408
- role: null | {
2409
- /**
2410
- * The name of the role
2411
- */
2412
- name: string;
2413
- /**
2414
- * The ID of the role
2415
- */
2416
- id: string;
2417
- };
2442
+ can_access_cda: boolean;
2418
2443
  /**
2419
- * The environment inside of which the action was performed
2444
+ * Whether this API token can access the Content Delivery API draft content endpoint
2420
2445
  */
2421
- environment: {
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
- };
2446
+ can_access_cda_preview: boolean;
2431
2447
  /**
2432
- * The actual request being performed
2448
+ * Whether this API token can access the Content Management API
2433
2449
  */
2434
- request: {
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
- };
2454
- /**
2455
- * The actual response being returned by DatoCMS
2456
- */
2457
- response: null | {
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
- };
2450
+ can_access_cma: boolean;
2451
+ hardcoded_type: null | string;
2469
2452
  };
2470
2453
  /**
2471
- * JSON API meta
2454
+ * JSON API links
2472
2455
  *
2473
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2474
- * via the `definition` "meta".
2456
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2457
+ * via the `definition` "relationships".
2475
2458
  */
2476
- export declare type AuditLogEventMeta = {
2459
+ export declare type AccessTokenRelationships = {
2477
2460
  /**
2478
- * The date of the event
2461
+ * Role
2479
2462
  */
2480
- occurred_at: string;
2463
+ role: {
2464
+ data: RoleData | null;
2465
+ };
2481
2466
  };
2482
2467
  /**
2483
2468
  * JSON API data
2484
2469
  *
2485
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2470
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2486
2471
  * via the `definition` "data".
2487
2472
  */
2488
- export declare type AuditLogEventData = {
2489
- type: AuditLogEventType;
2490
- id: AuditLogEventIdentity;
2473
+ export declare type AccessTokenData = {
2474
+ type: AccessTokenType;
2475
+ id: AccessTokenIdentity;
2491
2476
  };
2492
2477
  /**
2493
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2494
- * via the `query.schema` link.
2478
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2479
+ * via the `create.schema` link.
2495
2480
  */
2496
- export declare type AuditLogEventQuerySchema = {
2481
+ export declare type AccessTokenCreateSchema = {
2497
2482
  data: {
2498
- /**
2499
- * JSON API type field
2500
- */
2501
- type: 'audit_log_query';
2483
+ type: AccessTokenType;
2502
2484
  attributes: {
2503
2485
  /**
2504
- * An SQL-like expression to filter the events
2486
+ * Name of API token
2505
2487
  */
2506
- filter?: string;
2488
+ name: string;
2507
2489
  /**
2508
- * Set this value to get remaining results, if a meta.next_token was returned in the previous query response
2490
+ * Whether this API token can access the Content Delivery API published content endpoint
2509
2491
  */
2510
- next_token?: string;
2492
+ can_access_cda: boolean;
2511
2493
  /**
2512
- * Whether a detailed log complete with full request and response payload must be returned or not
2494
+ * Whether this API token can access the Content Delivery API draft content endpoint
2513
2495
  */
2514
- detailed_log?: boolean;
2496
+ can_access_cda_preview: boolean;
2497
+ /**
2498
+ * Whether this API token can access the Content Management API
2499
+ */
2500
+ can_access_cma: boolean;
2501
+ };
2502
+ relationships: {
2503
+ /**
2504
+ * Role
2505
+ */
2506
+ role: {
2507
+ data: RoleData | null;
2508
+ };
2515
2509
  };
2516
2510
  };
2517
2511
  };
2518
2512
  /**
2519
- * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2520
- * via the `query.targetSchema` link.
2513
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2514
+ * via the `create.targetSchema` link.
2521
2515
  */
2522
- export declare type AuditLogEventQueryTargetSchema = {
2523
- data: AuditLogEvent[];
2524
- meta: {
2525
- /**
2526
- * 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
2527
- */
2528
- next_token: null | string;
2516
+ export declare type AccessTokenCreateTargetSchema = {
2517
+ data: AccessToken;
2518
+ };
2519
+ /**
2520
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2521
+ * via the `update.schema` link.
2522
+ */
2523
+ export declare type AccessTokenUpdateSchema = {
2524
+ data: {
2525
+ type: AccessTokenType;
2526
+ id: AccessTokenIdentity;
2527
+ attributes: {
2528
+ /**
2529
+ * Name of API token
2530
+ */
2531
+ name: string;
2532
+ /**
2533
+ * Whether this API token can access the Content Delivery API published content endpoint
2534
+ */
2535
+ can_access_cda: boolean;
2536
+ /**
2537
+ * Whether this API token can access the Content Delivery API draft content endpoint
2538
+ */
2539
+ can_access_cda_preview: boolean;
2540
+ /**
2541
+ * Whether this API token can access the Content Management API
2542
+ */
2543
+ can_access_cma: boolean;
2544
+ };
2545
+ relationships: {
2546
+ /**
2547
+ * Role
2548
+ */
2549
+ role: {
2550
+ data: RoleData | null;
2551
+ };
2552
+ };
2529
2553
  };
2530
2554
  };
2555
+ /**
2556
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2557
+ * via the `update.targetSchema` link.
2558
+ */
2559
+ export declare type AccessTokenUpdateTargetSchema = {
2560
+ data: AccessToken;
2561
+ };
2562
+ /**
2563
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2564
+ * via the `instances.targetSchema` link.
2565
+ */
2566
+ export declare type AccessTokenInstancesTargetSchema = {
2567
+ data: AccessToken[];
2568
+ };
2569
+ /**
2570
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2571
+ * via the `self.targetSchema` link.
2572
+ */
2573
+ export declare type AccessTokenSelfTargetSchema = {
2574
+ data: AccessToken;
2575
+ };
2576
+ /**
2577
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2578
+ * via the `regenerate_token.targetSchema` link.
2579
+ */
2580
+ export declare type AccessTokenRegenerateTokenTargetSchema = {
2581
+ data: AccessToken;
2582
+ };
2583
+ /**
2584
+ * This interface was referenced by `AccessToken`'s JSON-Schema
2585
+ * via the `destroy.targetSchema` link.
2586
+ */
2587
+ export declare type AccessTokenDestroyTargetSchema = {
2588
+ data: AccessToken;
2589
+ };
2531
2590
  /**
2532
2591
  * DatoCMS account
2533
2592
  *
@@ -2568,14 +2627,187 @@ export declare type AccountAttributes = {
2568
2627
  password?: string;
2569
2628
  };
2570
2629
  /**
2571
- * JSON API data
2572
- *
2573
- * This interface was referenced by `Account`'s JSON-Schema
2574
- * via the `definition` "data".
2630
+ * JSON API data
2631
+ *
2632
+ * This interface was referenced by `Account`'s JSON-Schema
2633
+ * via the `definition` "data".
2634
+ */
2635
+ export declare type AccountData = {
2636
+ type: AccountType;
2637
+ id: AccountIdentity;
2638
+ };
2639
+ /**
2640
+ * This interface was referenced by `User`'s JSON-Schema
2641
+ * via the `destroy.targetSchema` link.
2642
+ */
2643
+ export declare type UserDestroyTargetSchema = {
2644
+ data: User;
2645
+ };
2646
+ /**
2647
+ * 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.
2648
+ *
2649
+ * This interface was referenced by `DatoApi`'s JSON-Schema
2650
+ * via the `definition` "audit_log_event".
2651
+ */
2652
+ export declare type AuditLogEvent = {
2653
+ type: AuditLogEventType;
2654
+ id: AuditLogEventIdentity;
2655
+ attributes: AuditLogEventAttributes;
2656
+ meta: AuditLogEventMeta;
2657
+ };
2658
+ /**
2659
+ * JSON API attributes
2660
+ *
2661
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2662
+ * via the `definition` "attributes".
2663
+ */
2664
+ export declare type AuditLogEventAttributes = {
2665
+ /**
2666
+ * The actual action performed
2667
+ */
2668
+ action_name: string;
2669
+ /**
2670
+ * The actor who performed the action
2671
+ */
2672
+ actor: {
2673
+ /**
2674
+ * The type of actor (can be `account`, `user`, `sso_user` or `access_token`)
2675
+ */
2676
+ type: string;
2677
+ /**
2678
+ * The ID of the actor
2679
+ */
2680
+ id: string;
2681
+ /**
2682
+ * An human representation of the actor (name/email/username depending on the type of actor)
2683
+ */
2684
+ name: string;
2685
+ };
2686
+ /**
2687
+ * The role of the actor at the time the action was performed
2688
+ */
2689
+ role: null | {
2690
+ /**
2691
+ * The name of the role
2692
+ */
2693
+ name: string;
2694
+ /**
2695
+ * The ID of the role
2696
+ */
2697
+ id: string;
2698
+ };
2699
+ /**
2700
+ * The environment inside of which the action was performed
2701
+ */
2702
+ environment: {
2703
+ /**
2704
+ * The ID of the environment
2705
+ */
2706
+ id: string;
2707
+ /**
2708
+ * Whether the environment was the primary one at the time the action was performed
2709
+ */
2710
+ primary: boolean;
2711
+ };
2712
+ /**
2713
+ * The actual request being performed
2714
+ */
2715
+ request: {
2716
+ /**
2717
+ * The full path of the request
2718
+ */
2719
+ path: string;
2720
+ /**
2721
+ * The HTTP method of the request
2722
+ */
2723
+ method: string;
2724
+ /**
2725
+ * The X-Request-ID header of the request
2726
+ */
2727
+ id?: string;
2728
+ /**
2729
+ * The full HTTP body of the request
2730
+ */
2731
+ payload?: null | {
2732
+ [k: string]: unknown;
2733
+ };
2734
+ };
2735
+ /**
2736
+ * The actual response being returned by DatoCMS
2737
+ */
2738
+ response: null | {
2739
+ /**
2740
+ * The HTTP status code of the response
2741
+ */
2742
+ status: number;
2743
+ /**
2744
+ * The full HTTP body of the response
2745
+ */
2746
+ payload: {
2747
+ [k: string]: unknown;
2748
+ };
2749
+ };
2750
+ };
2751
+ /**
2752
+ * JSON API meta
2753
+ *
2754
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2755
+ * via the `definition` "meta".
2756
+ */
2757
+ export declare type AuditLogEventMeta = {
2758
+ /**
2759
+ * The date of the event
2760
+ */
2761
+ occurred_at: string;
2762
+ };
2763
+ /**
2764
+ * JSON API data
2765
+ *
2766
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2767
+ * via the `definition` "data".
2768
+ */
2769
+ export declare type AuditLogEventData = {
2770
+ type: AuditLogEventType;
2771
+ id: AuditLogEventIdentity;
2772
+ };
2773
+ /**
2774
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2775
+ * via the `query.schema` link.
2776
+ */
2777
+ export declare type AuditLogEventQuerySchema = {
2778
+ data: {
2779
+ /**
2780
+ * JSON API type field
2781
+ */
2782
+ type: 'audit_log_query';
2783
+ attributes: {
2784
+ /**
2785
+ * An SQL-like expression to filter the events
2786
+ */
2787
+ filter?: string;
2788
+ /**
2789
+ * Set this value to get remaining results, if a meta.next_token was returned in the previous query response
2790
+ */
2791
+ next_token?: string;
2792
+ /**
2793
+ * Whether a detailed log complete with full request and response payload must be returned or not
2794
+ */
2795
+ detailed_log?: boolean;
2796
+ };
2797
+ };
2798
+ };
2799
+ /**
2800
+ * This interface was referenced by `AuditLogEvent`'s JSON-Schema
2801
+ * via the `query.targetSchema` link.
2575
2802
  */
2576
- export declare type AccountData = {
2577
- type: AccountType;
2578
- id: AccountIdentity;
2803
+ export declare type AuditLogEventQueryTargetSchema = {
2804
+ data: AuditLogEvent[];
2805
+ meta: {
2806
+ /**
2807
+ * 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
2808
+ */
2809
+ next_token: null | string;
2810
+ };
2579
2811
  };
2580
2812
  /**
2581
2813
  * Stores the information regarding the current plan for the project.
@@ -2739,6 +2971,14 @@ export declare type SitePlanAttributes = {
2739
2971
  * Whether translator roles are enabled or not
2740
2972
  */
2741
2973
  translator_roles: boolean;
2974
+ /**
2975
+ * Whether or not use a static IP when sending webhooks
2976
+ */
2977
+ static_webhooks_ip: boolean;
2978
+ /**
2979
+ * Maximum size in bytes for a single file upload
2980
+ */
2981
+ maximum_single_upload_bytes: number;
2742
2982
  /**
2743
2983
  * Available extra packets
2744
2984
  */
@@ -3105,6 +3345,12 @@ export declare type ItemTypeRelationships = {
3105
3345
  fields: {
3106
3346
  data: FieldData[];
3107
3347
  };
3348
+ /**
3349
+ * The list of item type fieldsets
3350
+ */
3351
+ fieldsets: {
3352
+ data: FieldsetData[];
3353
+ };
3108
3354
  /**
3109
3355
  * The field to use as display title
3110
3356
  */
@@ -3156,6 +3402,16 @@ export declare type FieldData = {
3156
3402
  type: FieldType;
3157
3403
  id: FieldIdentity;
3158
3404
  };
3405
+ /**
3406
+ * JSON API data
3407
+ *
3408
+ * This interface was referenced by `Fieldset`'s JSON-Schema
3409
+ * via the `definition` "data".
3410
+ */
3411
+ export declare type FieldsetData = {
3412
+ type: FieldsetType;
3413
+ id: FieldsetIdentity;
3414
+ };
3159
3415
  /**
3160
3416
  * JSON API data
3161
3417
  *
@@ -3443,7 +3699,839 @@ export declare type ItemTypeDestroyJobSchema = {
3443
3699
  data: ItemType;
3444
3700
  };
3445
3701
  /**
3446
- * Each Model consists of a set of fields. Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `file`, `float`, etc.) and any required validation.
3702
+ * 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.
3703
+ *
3704
+ * ### Different field types require different settings
3705
+ *
3706
+ * When looking at a field resource, you have to pay attention to two particular properties, `validators` and `appearance`.
3707
+ *
3708
+ * 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.
3709
+ *
3710
+ * 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.
3711
+ *
3712
+ * ### Specifying validations
3713
+ *
3714
+ * 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.
3715
+ *
3716
+ * This is a valid example for a _Single-line string_ field:
3717
+ *
3718
+ * ```js
3719
+ * {
3720
+ * "validators": {
3721
+ * // "required" validator has no settings
3722
+ * "required": {},
3723
+ * // "length" validator requires "min" and/or "max" properties
3724
+ * "length": { "min": 80 }
3725
+ * }
3726
+ * }
3727
+ * ```
3728
+ *
3729
+ * Below you'll find a summary of all the validators available for each field type with their settings.
3730
+ *
3731
+ * 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.
3732
+ *
3733
+ * ### Specifying the appearance
3734
+ *
3735
+ * The `appearance` property requires an object with three specific properties: `editor`, `parameters` and `addons`.
3736
+ *
3737
+ * 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.
3738
+ *
3739
+ * This is a valid example for a _Single-line string_ field:
3740
+ *
3741
+ * ```js
3742
+ * {
3743
+ * "appearance": {
3744
+ * // single_line is a DatoCMS built-in editor that you can use with single-line string fields
3745
+ * "editor": "single_line",
3746
+ * // each built-in editor has specific settings
3747
+ * "parameters": { "heading": true },
3748
+ * "addons": []
3749
+ * },
3750
+ * }
3751
+ * ```
3752
+ *
3753
+ * Following you'll find a summary of all the editors available for each field type with their settings.
3754
+ *
3755
+ * #### Setting the appearance to a field editor provided by a plugin
3756
+ *
3757
+ * 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.
3758
+ *
3759
+ * In this case:
3760
+ *
3761
+ * - the `editor` property must be the ID of the plugin;
3762
+ * - the `field_extension` property must be the ID of the specific manual field editor that the plugin exposes;
3763
+ * - 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.
3764
+ *
3765
+ * ```js
3766
+ * {
3767
+ * "appearance": {
3768
+ * // "2132" is a the ID of a plugin exposing a manual field editor
3769
+ * "editor": "2134",
3770
+ * // "starRating" is a manual field editor exposed by the plugin
3771
+ * "field_extension": "starRating",
3772
+ * // this is a valid configuration for the "starRating" field editor
3773
+ * "parameters": { "maxRating": 5, "starsColor": "#ff0000" },
3774
+ * "addons": []
3775
+ * },
3776
+ * }
3777
+ * ```
3778
+ *
3779
+ * #### Configuring manual field addons
3780
+ *
3781
+ * 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.
3782
+ *
3783
+ * ```js
3784
+ * {
3785
+ * "appearance": {
3786
+ * "editor": "single_line",
3787
+ * "parameters": { "heading": true },
3788
+ * "addons": [
3789
+ * {
3790
+ * // "2138" is a the ID of a plugin exposing a manual addon editor
3791
+ * "id": "2138",
3792
+ * // "loremIpsumGenerator" is a manual field addon exposed by the plugin
3793
+ * "field_extension": "loremIpsumGenerator",
3794
+ * // this is a valid configuration for the "loremIpsumGenerator" field addon
3795
+ * "parameters": { "sentences": 2 },
3796
+ * }
3797
+ * ]
3798
+ * },
3799
+ * }
3800
+ * ```
3801
+ *
3802
+ * ### Available field types
3803
+ *
3804
+ * <details>
3805
+ * <summary>Single-line string (<code>string</code>)</summary>
3806
+ *
3807
+ * | Property | Value |
3808
+ * | ------------------------------ | ---------------------------------------------------- |
3809
+ * | Code | `string` |
3810
+ * | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
3811
+ * | Available validators | `required`, `unique`, `length`, `format`, `enum` |
3812
+ *
3813
+ * </details>
3814
+ *
3815
+ * <details>
3816
+ * <summary>Multi-line text (<code>text</code>)</summary>
3817
+ *
3818
+ * | Property | Value |
3819
+ * | ------------------------------ | --------------------------------- |
3820
+ * | Code | `text` |
3821
+ * | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
3822
+ * | Available validators | `required`, `length`, `format` |
3823
+ *
3824
+ * </details>
3825
+ *
3826
+ * <details>
3827
+ * <summary>Boolean (<code>boolean</code>)</summary>
3828
+ *
3829
+ * | Property | Value |
3830
+ * | ------------------------------ | -------------------------------- |
3831
+ * | Code | `boolean` |
3832
+ * | Built-in editors for the field | `boolean`, `boolean_radio_group` |
3833
+ * | Available validators | no validators available |
3834
+ *
3835
+ * </details>
3836
+ *
3837
+ * <details>
3838
+ * <summary>Integer (<code>integer</code>)</summary>
3839
+ *
3840
+ * | Property | Value |
3841
+ * | ------------------------------ | -------------------------- |
3842
+ * | Code | `integer` |
3843
+ * | Built-in editors for the field | `integer` |
3844
+ * | Available validators | `required`, `number_range` |
3845
+ *
3846
+ * </details>
3847
+ *
3848
+ * <details>
3849
+ * <summary>Float (<code>float</code>)</summary>
3850
+ *
3851
+ * | Property | Value |
3852
+ * | ------------------------------ | -------------------------- |
3853
+ * | Code | `float` |
3854
+ * | Built-in editors for the field | `float` |
3855
+ * | Available validators | `required`, `number_range` |
3856
+ *
3857
+ * </details>
3858
+ *
3859
+ * <details>
3860
+ * <summary>Date (<code>date</code>)</summary>
3861
+ *
3862
+ * | Property | Value |
3863
+ * | ------------------------------ | ------------------------ |
3864
+ * | Code | `date` |
3865
+ * | Built-in editors for the field | `date_picker` |
3866
+ * | Available validators | `required`, `date_range` |
3867
+ *
3868
+ * </details>
3869
+ *
3870
+ * <details>
3871
+ * <summary>Date time (<code>date_time</code>)</summary>
3872
+ *
3873
+ * | Property | Value |
3874
+ * | ------------------------------ | ----------------------------- |
3875
+ * | Code | `date_time` |
3876
+ * | Built-in editors for the field | `date_time_picker` |
3877
+ * | Available validators | `required`, `date_time_range` |
3878
+ *
3879
+ * </details>
3880
+ *
3881
+ * <details>
3882
+ * <summary>Color (<code>color</code>)</summary>
3883
+ *
3884
+ * | Property | Value |
3885
+ * | ------------------------------ | -------------- |
3886
+ * | Code | `color` |
3887
+ * | Built-in editors for the field | `color_picker` |
3888
+ * | Available validators | `required` |
3889
+ *
3890
+ * </details>
3891
+ *
3892
+ * <details>
3893
+ * <summary>JSON (<code>json</code>)</summary>
3894
+ *
3895
+ * | Property | Value |
3896
+ * | ------------------------------ | ------------------------------------------------------ |
3897
+ * | Code | `json` |
3898
+ * | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
3899
+ * | Available validators | `required` |
3900
+ *
3901
+ * </details>
3902
+ *
3903
+ * <details>
3904
+ * <summary>Location (<code>lat_lon</code>)</summary>
3905
+ *
3906
+ * | Property | Value |
3907
+ * | ------------------------------ | ---------- |
3908
+ * | Code | `lat_lon` |
3909
+ * | Built-in editors for the field | `map` |
3910
+ * | Available validators | `required` |
3911
+ *
3912
+ * </details>
3913
+ *
3914
+ * <details>
3915
+ * <summary>SEO (<code>seo</code>)</summary>
3916
+ *
3917
+ * | Property | Value |
3918
+ * | ------------------------------ | -------------------------------------------------------------------------------------------- |
3919
+ * | Code | `seo` |
3920
+ * | Built-in editors for the field | `seo` |
3921
+ * | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
3922
+ *
3923
+ * </details>
3924
+ *
3925
+ * <details>
3926
+ * <summary>Slug (<code>slug</code>)</summary>
3927
+ *
3928
+ * | Property | Value |
3929
+ * | ------------------------------ | ----------------------------------- |
3930
+ * | Code | `slug` |
3931
+ * | Built-in editors for the field | `slug` |
3932
+ * | Required validators | `slug_title_field` |
3933
+ * | Other validators available | `required`, `length`, `slug_format` |
3934
+ *
3935
+ * </details>
3936
+ *
3937
+ * <details>
3938
+ * <summary>External video (<code>video</code>)</summary>
3939
+ *
3940
+ * | Property | Value |
3941
+ * | ------------------------------ | ---------- |
3942
+ * | Code | `video` |
3943
+ * | Built-in editors for the field | `video` |
3944
+ * | Available validators | `required` |
3945
+ *
3946
+ * </details>
3947
+ *
3948
+ * <details>
3949
+ * <summary>Single-asset (<code>file</code>)</summary>
3950
+ *
3951
+ * | Property | Value |
3952
+ * | ------------------------------ | ------------------------------------------------------------------------------ |
3953
+ * | Code | `file` |
3954
+ * | Built-in editors for the field | `file` |
3955
+ * | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
3956
+ *
3957
+ * </details>
3958
+ *
3959
+ * <details>
3960
+ * <summary>Asset gallery (<code>gallery</code>)</summary>
3961
+ *
3962
+ * | Property | Value |
3963
+ * | ------------------------------ | -------------------------------------------------------------------------- |
3964
+ * | Code | `gallery` |
3965
+ * | Built-in editors for the field | `gallery` |
3966
+ * | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
3967
+ *
3968
+ * </details>
3969
+ *
3970
+ * <details>
3971
+ * <summary>Single link (<code>link</code>)</summary>
3972
+ *
3973
+ * | Property | Value |
3974
+ * | ------------------------------ | --------------------------- |
3975
+ * | Code | `link` |
3976
+ * | Built-in editors for the field | `link_select`, `link_embed` |
3977
+ * | Default `editor` | `link_select` |
3978
+ * | Required validators | `item_item_type` |
3979
+ * | Other validators available | `required`, `unique` |
3980
+ *
3981
+ * </details>
3982
+ *
3983
+ * <details>
3984
+ * <summary>Multiple links (<code>links</code>)</summary>
3985
+ *
3986
+ * | Property | Value |
3987
+ * | ------------------------------ | ----------------------------- |
3988
+ * | Code | `links` |
3989
+ * | Built-in editors for the field | `links_select`, `links_embed` |
3990
+ * | Default `editor` | `links_select` |
3991
+ * | Required validators | `items_item_type` |
3992
+ * | Other validators available | `size` |
3993
+ *
3994
+ * </details>
3995
+ *
3996
+ * <details>
3997
+ * <summary>Modular content (<code>rich_text</code>)</summary>
3998
+ *
3999
+ * | Property | Value |
4000
+ * | ------------------------------ | ------------------ |
4001
+ * | Code | `rich_text` |
4002
+ * | Built-in editors for the field | `rich_text` |
4003
+ * | Required validators | `rich_text_blocks` |
4004
+ * | Other validators available | `size` |
4005
+ *
4006
+ * </details>
4007
+ *
4008
+ * <details>
4009
+ * <summary>Structured text (<code>structured_text</code>)</summary>
4010
+ *
4011
+ * | Property | Value |
4012
+ * | ------------------------------ | ------------------------------------------------- |
4013
+ * | Code | `structured_text` |
4014
+ * | Built-in editors for the field | `structured_text` |
4015
+ * | Required validators | `structured_text_blocks`, `structured_text_links` |
4016
+ * | Other validators available | `length` |
4017
+ *
4018
+ * </details>
4019
+ *
4020
+ * ### Validators
4021
+ *
4022
+ * <details>
4023
+ * <summary><code>date_range</code></summary>
4024
+ *
4025
+ * Accept dates only inside a specified date range.
4026
+ *
4027
+ * | Parameter | Type | Required | Description |
4028
+ * | --------- | ------------- | -------- | ------------ |
4029
+ * | `min` | ISO 8601 date | | Minimum date |
4030
+ * | `max` | ISO 8601 date | | Maximum date |
4031
+ *
4032
+ * At least one of the parameters must be specified.
4033
+ *
4034
+ * </details>
4035
+ *
4036
+ * <details>
4037
+ * <summary><code>date_time_range</code></summary>
4038
+ *
4039
+ * Accept date times only inside a specified date range.
4040
+ *
4041
+ * | Parameter | Type | Required | Description |
4042
+ * | --------- | ----------------- | -------- | ---------------- |
4043
+ * | `min` | ISO 8601 datetime | | Minimum datetime |
4044
+ * | `max` | ISO 8601 datetime | | Maximum datetime |
4045
+ *
4046
+ * At least one of the parameters must be specified.
4047
+ *
4048
+ * </details>
4049
+ *
4050
+ * <details>
4051
+ * <summary><code>enum</code></summary>
4052
+ *
4053
+ * Only accept a specific set of values
4054
+ *
4055
+ * | Parameter | Type | Required | Description |
4056
+ * | --------- | --------------- | -------- | --------------------- |
4057
+ * | `values` | `Array<String>` | ✅ | Set of allowed values |
4058
+ *
4059
+ * </details>
4060
+ *
4061
+ * <details>
4062
+ * <summary><code>extension</code></summary>
4063
+ *
4064
+ * Only accept assets with specific file extensions.
4065
+ *
4066
+ * | Parameter | Type | Required | Description |
4067
+ * | ----------------- | ----------------------------------------- | -------- | ------------------------------ |
4068
+ * | `extensions` | `Array<String>` | | Set of allowed file extensions |
4069
+ * | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` | | Allowed file type |
4070
+ *
4071
+ * Only one of the parameters must be specified.
4072
+ *
4073
+ * </details>
4074
+ *
4075
+ * <details>
4076
+ * <summary><code>file_size</code></summary>
4077
+ *
4078
+ * Accept assets only inside a specified date range.
4079
+ *
4080
+ * | Parameter | Type | Required | Description |
4081
+ * | ----------- | ---------------------------- | -------- | ---------------------------------- |
4082
+ * | `min_value` | `Integer` | | Numeric value for minimum filesize |
4083
+ * | `min_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for minimum filesize |
4084
+ * | `max_value` | `Integer` | | Numeric value for maximum filesize |
4085
+ * | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
4086
+ *
4087
+ * At least one couple of value/unit must be specified.
4088
+ *
4089
+ * </details>
4090
+ *
4091
+ * <details>
4092
+ * <summary><code>format</code></summary>
4093
+ *
4094
+ * Only accept strings having a specific format.
4095
+ *
4096
+ * | Parameter | Type | Required | Description |
4097
+ * | -------------------- | ------------------------- | -------- | ---------------------------------- |
4098
+ * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
4099
+ * | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
4100
+ *
4101
+ * Only one of the parameters must be specified.
4102
+ *
4103
+ * </details>
4104
+ *
4105
+ * <details>
4106
+ * <summary><code>slug_format</code></summary>
4107
+ *
4108
+ * Only accept slugs having a specific format.
4109
+ *
4110
+ * | Parameter | Type | Required | Description |
4111
+ * | -------------------- | ---------------- | -------- | ---------------------------------- |
4112
+ * | `custom_pattern` | `Regexp` | | Regular expression to be validated |
4113
+ * | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
4114
+ *
4115
+ * Only one of the parameters must be specified.
4116
+ *
4117
+ * </details>
4118
+ *
4119
+ * <details>
4120
+ * <summary><code>image_dimensions</code></summary>
4121
+ *
4122
+ * Accept assets only within a specified height/width range.
4123
+ *
4124
+ * | Parameter | Type | Required | Description |
4125
+ * | ------------------ | --------- | -------- | -------------------------------- |
4126
+ * | `width_min_value` | `Integer` | | Numeric value for minimum width |
4127
+ * | `width_max_value` | `Integer` | | Numeric value for maximum height |
4128
+ * | `height_min_value` | `Integer` | | Numeric value for minimum width |
4129
+ * | `height_max_value` | `Integer` | | Numeric value for maximum height |
4130
+ *
4131
+ * At least one parameter must be specified.
4132
+ *
4133
+ * </details>
4134
+ *
4135
+ * <details>
4136
+ * <summary><code>item_item_type</code></summary>
4137
+ *
4138
+ * Only accept references to records of the specified models.
4139
+ *
4140
+ * | Parameter | Type | Required | Description |
4141
+ * | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
4142
+ * | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
4143
+ * | `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 |
4144
+ * | `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 |
4145
+ * | `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 |
4146
+ *
4147
+ * Possible values for `on_publish_with_unpublished_references_strategy`:
4148
+ *
4149
+ * - `"fail"`: Fail the operation and notify the user
4150
+ * - `"publish_references"`: Publish also the referenced records
4151
+ *
4152
+ * Possible values for `on_reference_unpublish_strategy`:
4153
+ *
4154
+ * - `"fail"`: Fail the operation and notify the user
4155
+ * - `"unpublish"`: Unpublish also this record
4156
+ * - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
4157
+ *
4158
+ * Possible values for `on_reference_delete_strategy`:
4159
+ *
4160
+ * - `"fail"`: Fail the operation and notify the user
4161
+ * - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
4162
+ * </details>
4163
+ *
4164
+ * <details>
4165
+ * <summary><code>items_item_type</code></summary>
4166
+ *
4167
+ * Only accept references to records of the specified models.
4168
+ *
4169
+ * | Parameter | Type | Required | Description |
4170
+ * | ------------------------------------------------- | ------------------------------------------------------------------------ | -------- | --------------------------------------------------------------------------------------------------- |
4171
+ * | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
4172
+ * | `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 |
4173
+ * | `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 |
4174
+ * | `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 |
4175
+ *
4176
+ * Possible values for `on_publish_with_unpublished_references_strategy`:
4177
+ *
4178
+ * - `"fail"`: Fail the operation and notify the user
4179
+ * - `"publish_references"`: Publish also the referenced records
4180
+ *
4181
+ * Possible values for `on_reference_unpublish_strategy`:
4182
+ *
4183
+ * - `"fail"`: Fail the operation and notify the user
4184
+ * - `"unpublish"`: Unpublish also this record
4185
+ * - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
4186
+ *
4187
+ * Possible values for `on_reference_delete_strategy`:
4188
+ *
4189
+ * - `"fail"`: Fail the operation and notify the user
4190
+ * - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
4191
+ * </details>
4192
+ *
4193
+ * <details>
4194
+ * <summary><code>length</code></summary>
4195
+ *
4196
+ * Accept strings only with a specified number of characters.
4197
+ *
4198
+ * | Parameter | Type | Required | Description |
4199
+ * | --------- | --------- | -------- | --------------- |
4200
+ * | `min` | `Integer` | | Minimum length |
4201
+ * | `eq` | `Integer` | | Expected length |
4202
+ * | `max` | `Integer` | | Maximum length |
4203
+ *
4204
+ * At least one parameter must be specified.
4205
+ *
4206
+ * </details>
4207
+ *
4208
+ * <details>
4209
+ * <summary><code>number_range</code></summary>
4210
+ *
4211
+ * Accept numbers only inside a specified range.
4212
+ *
4213
+ * | Parameter | Type | Required | Description |
4214
+ * | --------- | ------- | -------- | ------------- |
4215
+ * | `min` | `Float` | | Minimum value |
4216
+ * | `max` | `Float` | | Maximum value |
4217
+ *
4218
+ * At least one of the parameters must be specified.
4219
+ *
4220
+ * </details>
4221
+ *
4222
+ * <details>
4223
+ * <summary><code>required</code></summary>
4224
+ *
4225
+ * Value must be specified or it won't be valid.
4226
+ *
4227
+ * </details>
4228
+ *
4229
+ * <details>
4230
+ * <summary><code>required_alt_title</code></summary>
4231
+ *
4232
+ * Assets contained in the field are required to specify custom title or alternate text, or they won't be valid.
4233
+ *
4234
+ * | Parameter | Type | Required | Description |
4235
+ * | --------- | --------- | -------- | ---------------------------------------------------------- |
4236
+ * | `title` | `Boolean` | | Whether the title for the asset must be specified |
4237
+ * | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
4238
+ *
4239
+ * At least one of the parameters must be specified.
4240
+ *
4241
+ * </details>
4242
+ *
4243
+ * <details>
4244
+ * <summary><code>required_seo_fields</code></summary>
4245
+ *
4246
+ * SEO field is to specify one or more properties, or it won't be valid.
4247
+ *
4248
+ * | Parameter | Type | Required | Description |
4249
+ * | -------------- | --------- | -------- | -------------------------------------------------- |
4250
+ * | `title` | `Boolean` | | Whether the meta title must be specified |
4251
+ * | `description` | `Boolean` | | Whether the meta description must be specified |
4252
+ * | `image` | `Boolean` | | Whether the social sharing image must be specified |
4253
+ * | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
4254
+ *
4255
+ * At least one of the parameters must be specified.
4256
+ *
4257
+ * </details>
4258
+ *
4259
+ * <details>
4260
+ * <summary><code>title_length</code></summary>
4261
+ *
4262
+ * 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.
4263
+ *
4264
+ * | Parameter | Type | Required | Description |
4265
+ * | --------- | --------- | -------- | ------------- |
4266
+ * | `min` | `Integer` | | Minimum value |
4267
+ * | `max` | `Integer` | | Maximum value |
4268
+ *
4269
+ * At least one of the parameters must be specified.
4270
+ *
4271
+ * </details>
4272
+ *
4273
+ * <details>
4274
+ * <summary><code>description_length</code></summary>
4275
+ *
4276
+ * 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.
4277
+ *
4278
+ * | Parameter | Type | Required | Description |
4279
+ * | --------- | --------- | -------- | ------------- |
4280
+ * | `min` | `Integer` | | Minimum value |
4281
+ * | `max` | `Integer` | | Maximum value |
4282
+ *
4283
+ * At least one of the parameters must be specified.
4284
+ *
4285
+ * </details>
4286
+ *
4287
+ * <details>
4288
+ * <summary><code>rich_text_blocks</code></summary>
4289
+ *
4290
+ * Only accept references to block records of the specified block models.
4291
+ *
4292
+ * | Parameter | Type | Required | Description |
4293
+ * | ------------ | ----------------------- | -------- | ------------------------------ |
4294
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
4295
+ *
4296
+ * </details>
4297
+ *
4298
+ * <details>
4299
+ * <summary><code>structured_text_blocks</code></summary>
4300
+ *
4301
+ * Only accept references to block records of the specified block models.
4302
+ *
4303
+ * | Parameter | Type | Required | Description |
4304
+ * | ------------ | ----------------------- | -------- | ------------------------------ |
4305
+ * | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |
4306
+ *
4307
+ * </details>
4308
+ *
4309
+ * <details>
4310
+ * <summary><code>structured_text_links</code></summary>
4311
+ *
4312
+ * Only accept `itemLink` to `inlineItem` nodes for records of the specified models.
4313
+ *
4314
+ * | Parameter | Type | Required | Description |
4315
+ * | ------------------------------------------------- | ------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------- |
4316
+ * | `item_types` | `Array<Model ID>` | ✅ | Set of allowed model IDs |
4317
+ * | `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 |
4318
+ * | `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 |
4319
+ * | `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 |
4320
+ *
4321
+ * Possible values for `on_publish_with_unpublished_references_strategy`:
4322
+ *
4323
+ * - `"fail"`: Fail the operation and notify the user
4324
+ * - `"publish_references"`: Publish also the referenced records
4325
+ *
4326
+ * Possible values for `on_reference_unpublish_strategy`:
4327
+ *
4328
+ * - `"fail"`: Fail the operation and notify the user
4329
+ * - `"unpublish"`: Unpublish also this record
4330
+ * - `"delete_references"`: Try to remove the reference to the unpublished record (if the field has a `required` validation it will fail)
4331
+ *
4332
+ * Possible values for `on_reference_delete_strategy`:
4333
+ *
4334
+ * - `"fail"`: Fail the operation and notify the user
4335
+ * - `"delete_references"`: Try to remove the reference to the deleted record (if the field has a `required` validation it will fail)
4336
+ * </details>
4337
+ *
4338
+ * <details>
4339
+ * <summary><code>size</code></summary>
4340
+ *
4341
+ * Only accept a number of items within the specified range.
4342
+ *
4343
+ * | Parameter | Type | Required | Description |
4344
+ * | ------------- | --------- | -------- | -------------------------------------------------- |
4345
+ * | `min` | `Integer` | | Minimum length |
4346
+ * | `eq` | `Integer` | | Expected length |
4347
+ * | `max` | `Integer` | | Maximum length |
4348
+ * | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
4349
+ *
4350
+ * At least one parameter must be specified.
4351
+ *
4352
+ * </details>
4353
+ *
4354
+ * <details>
4355
+ * <summary><code>slug_title_field</code></summary>
4356
+ *
4357
+ * Specifies the ID of the _Single-line string_ field that will be used to generate the slug
4358
+ *
4359
+ * | Parameter | Type | Required | Description |
4360
+ * | ---------------- | ---------- | -------- | ------------------------------------------------ |
4361
+ * | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |
4362
+ *
4363
+ * </details>
4364
+ *
4365
+ * <details>
4366
+ * <summary><code>unique</code></summary>
4367
+ *
4368
+ * The value must be unique across the whole collection of records.
4369
+ *
4370
+ * </details>
4371
+ *
4372
+ * ### Configuration parameters for DatoCMS built-in field editors
4373
+ *
4374
+ * If a field editor is not specified in this table, just pass an empty object `{}` as its configuration parameters.
4375
+ *
4376
+ * <details>
4377
+ * <summary><code>boolean_radio_group</code></summary>
4378
+ *
4379
+ * Radio group input for _boolean_ fields.
4380
+ *
4381
+ * | Parameter | Type | Required | Description |
4382
+ * | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
4383
+ * | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
4384
+ * | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |
4385
+ *
4386
+ * </details>
4387
+ *
4388
+ * <details>
4389
+ * <summary><code>string_radio_group</code></summary>
4390
+ *
4391
+ * Radio group input for _string_ fields.
4392
+ *
4393
+ * | Parameter | Type | Required | Description |
4394
+ * | --------- | -------------------------------------------------------- | -------- | --------------------------- |
4395
+ * | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |
4396
+ *
4397
+ * </details>
4398
+ *
4399
+ * <details>
4400
+ * <summary><code>string_select</code></summary>
4401
+ *
4402
+ * Select input for _string_ fields.
4403
+ *
4404
+ * | Parameter | Type | Required | Description |
4405
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
4406
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
4407
+ *
4408
+ * </details>
4409
+ *
4410
+ * <details>
4411
+ * <summary><code>string_multi_select</code></summary>
4412
+ *
4413
+ * Select input for _JSON_ fields, to edit an array of strings.
4414
+ *
4415
+ * | Parameter | Type | Required | Description |
4416
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
4417
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
4418
+ *
4419
+ * </details>
4420
+ *
4421
+ * <details>
4422
+ * <summary><code>string_checkbox_group</code></summary>
4423
+ *
4424
+ * Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
4425
+ *
4426
+ * | Parameter | Type | Required | Description |
4427
+ * | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
4428
+ * | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |
4429
+ *
4430
+ * </details>
4431
+ *
4432
+ * <details>
4433
+ * <summary><code>single_line</code></summary>
4434
+ *
4435
+ * Simple textual input for _Single-line string_ fields.
4436
+ *
4437
+ * | Parameter | Type | Required | Description |
4438
+ * | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
4439
+ * | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |
4440
+ *
4441
+ * </details>
4442
+ *
4443
+ * <details>
4444
+ * <summary><code>markdown</code></summary>
4445
+ *
4446
+ * Markdown editor for _Multiple-paragraph text_ fields.
4447
+ *
4448
+ * | Parameter | Type | Required | Description |
4449
+ * | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4450
+ * | `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"` |
4451
+ *
4452
+ * </details>
4453
+ *
4454
+ * <details>
4455
+ * <summary><code>wysiwyg</code></summary>
4456
+ *
4457
+ * HTML editor for _Multiple-paragraph text_ fields.
4458
+ *
4459
+ * | Parameter | Type | Required | Description |
4460
+ * | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
4461
+ * | `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"` |
4462
+ *
4463
+ * </details>
4464
+ *
4465
+ * <details>
4466
+ * <summary><code>textarea</code></summary>
4467
+ *
4468
+ * Basic textarea editor for _Multiple-paragraph text_ fields.
4469
+ *
4470
+ * </details>
4471
+ *
4472
+ * <details>
4473
+ * <summary><code>color_picker</code></summary>
4474
+ *
4475
+ * Built-in editor for _Color_ fields.
4476
+ *
4477
+ * | Parameter | Type | Required | Description |
4478
+ * | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
4479
+ * | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
4480
+ * | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |
4481
+ *
4482
+ * </details>
4483
+ *
4484
+ * <details>
4485
+ * <summary><code>slug</code></summary>
4486
+ *
4487
+ * Built-in editor for _Slug_ fields.
4488
+ *
4489
+ * | Parameter | Type | Required | Description |
4490
+ * | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
4491
+ * | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. |
4492
+ *
4493
+ * </details>
4494
+ *
4495
+ * <details>
4496
+ * <summary><code>rich_text</code></summary>
4497
+ *
4498
+ * Built-in editor for _Modular content_ fields.
4499
+ *
4500
+ * | Parameter | Type | Required | Description |
4501
+ * | ----------------- | --------- | -------- | ---------------------------------------------------------- |
4502
+ * | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not |
4503
+ *
4504
+ * </details>
4505
+ *
4506
+ * <details>
4507
+ * <summary><code>structured_text</code></summary>
4508
+ *
4509
+ * Built-in editor for _Structured text_ fields.
4510
+ *
4511
+ * | Parameter | Type | Required | Description |
4512
+ * | ------------------------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
4513
+ * | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
4514
+ * | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
4515
+ * | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
4516
+ * | `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 |
4517
+ * | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |
4518
+ *
4519
+ * </details>
4520
+ *
4521
+ * <details>
4522
+ * <summary><code>link_select</code> and <code>links_select</code></summary>
4523
+ *
4524
+ * Use a select input with auto-completion to pick the records to reference inside the field.
4525
+ *
4526
+ * </details>
4527
+ *
4528
+ * <details>
4529
+ * <summary><code>link_embed</code> and <code>links_embed</code></summary>
4530
+ *
4531
+ * Use an expanded view with records' image preview to pick the records to reference inside the field.
4532
+ *
4533
+ * </details>
4534
+ *
3447
4535
  *
3448
4536
  * This interface was referenced by `DatoApi`'s JSON-Schema
3449
4537
  * via the `definition` "field".
@@ -3565,16 +4653,6 @@ export declare type FieldRelationships = {
3565
4653
  data: null | FieldsetData;
3566
4654
  };
3567
4655
  };
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
4656
  /**
3579
4657
  * This interface was referenced by `Field`'s JSON-Schema
3580
4658
  * via the `create.schema` link.
@@ -4104,184 +5182,6 @@ export declare type SessionCreateTargetSchema = {
4104
5182
  data: Session;
4105
5183
  included: User[];
4106
5184
  };
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
5185
  /**
4286
5186
  * Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.
4287
5187
  *
@@ -6185,11 +7085,11 @@ export declare type SearchResult = {
6185
7085
  */
6186
7086
  export declare type SearchResultAttributes = {
6187
7087
  /**
6188
- * Page title
7088
+ * Title of the page
6189
7089
  */
6190
7090
  title: string;
6191
7091
  /**
6192
- * First lines of body
7092
+ * First 200 characters of page body, unformatted
6193
7093
  */
6194
7094
  body_excerpt: string;
6195
7095
  /**
@@ -6197,7 +7097,7 @@ export declare type SearchResultAttributes = {
6197
7097
  */
6198
7098
  url: string;
6199
7099
  /**
6200
- * Score
7100
+ * Search score
6201
7101
  */
6202
7102
  score: number;
6203
7103
  highlight: {
@@ -6221,7 +7121,7 @@ export declare type SearchResultData = {
6221
7121
  */
6222
7122
  export declare type SearchResultInstancesTargetSchema = {
6223
7123
  data: SearchResult[];
6224
- meta?: {
7124
+ meta: {
6225
7125
  total_count: number;
6226
7126
  };
6227
7127
  };
@@ -7821,6 +8721,7 @@ export declare type PublicInfoAttributes = {
7821
8721
  extras: null | {
7822
8722
  blocks_depth: number;
7823
8723
  blocks_per_item: number;
8724
+ maximum_single_upload_bytes: number;
7824
8725
  [k: string]: unknown;
7825
8726
  };
7826
8727
  };
@@ -8115,10 +9016,6 @@ export declare type SiteAttributes = {
8115
9016
  * Specifies the last time when a change of data occurred
8116
9017
  */
8117
9018
  last_data_change_at: null | string;
8118
- /**
8119
- * Frontend website url
8120
- */
8121
- frontend_url: string | null;
8122
9019
  /**
8123
9020
  * Specifies whether all users of this site need to authenticate using two-factor authentication
8124
9021
  */
@@ -8211,48 +9108,12 @@ export declare type SiteRelationships = {
8211
9108
  account: {
8212
9109
  data: AccountData;
8213
9110
  };
8214
- build_triggers?: {
8215
- /**
8216
- * The list of build trigger
8217
- */
8218
- data: BuildTriggerData[];
8219
- };
8220
- menu_items: {
8221
- /**
8222
- * The list of site menu items
8223
- */
8224
- data: MenuItemData[];
8225
- };
8226
- sso_users: {
8227
- /**
8228
- * The list of site SSO users
8229
- */
8230
- data: SsoUserData[];
8231
- };
8232
- users: {
8233
- /**
8234
- * The list of site users
8235
- */
8236
- data: UserData[];
8237
- };
8238
9111
  item_types: {
8239
9112
  /**
8240
- * The list of site item types
9113
+ * The list item types for the site
8241
9114
  */
8242
9115
  data: ItemTypeData[];
8243
9116
  };
8244
- sso_default_role?: {
8245
- /**
8246
- * Specifies the default role for newly created identity providers users
8247
- */
8248
- data: RoleData[];
8249
- };
8250
- roles: {
8251
- /**
8252
- * The list of site roles
8253
- */
8254
- data: RoleData[];
8255
- };
8256
9117
  };
8257
9118
  /**
8258
9119
  * Meta attributes
@@ -8282,7 +9143,7 @@ export declare type SiteData = {
8282
9143
  */
8283
9144
  export declare type SiteSelfTargetSchema = {
8284
9145
  data: Site;
8285
- included?: (MenuItem | User | ItemType | Role | Field | Upload | SsoUser)[];
9146
+ included?: (ItemType | Field | Upload | Fieldset | Item | Account)[];
8286
9147
  };
8287
9148
  /**
8288
9149
  * This interface was referenced by `Site`'s JSON-Schema