@datocms/cma-client 2.2.5 → 3.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/Client.js +1 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/esm/generated/Client.d.ts +3 -1
- package/dist/esm/generated/Client.js +1 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +60 -36
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +60 -36
- package/dist/types/generated/Client.d.ts +3 -1
- package/dist/types/generated/SchemaTypes.d.ts +60 -36
- package/dist/types/generated/SimpleSchemaTypes.d.ts +60 -36
- package/package.json +4 -4
- package/src/generated/Client.ts +3 -1
- package/src/generated/SchemaTypes.ts +60 -36
- package/src/generated/SimpleSchemaTypes.ts +60 -36
|
@@ -21,7 +21,7 @@ export type RoleType = 'role';
|
|
|
21
21
|
*/
|
|
22
22
|
export type RoleIdentity = string;
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* RFC 4122 UUID of item type expressed in URL-safe base64 format
|
|
25
25
|
*
|
|
26
26
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
27
27
|
* via the `definition` "identity".
|
|
@@ -31,7 +31,7 @@ export type RoleIdentity = string;
|
|
|
31
31
|
*/
|
|
32
32
|
export type ItemTypeIdentity = string;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* RFC 4122 UUID of workflow expressed in URL-safe base64 format
|
|
35
35
|
*
|
|
36
36
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
37
37
|
* via the `definition` "identity".
|
|
@@ -271,7 +271,7 @@ export type SitePlanIdentity = string;
|
|
|
271
271
|
*/
|
|
272
272
|
export type MenuItemType = 'menu_item';
|
|
273
273
|
/**
|
|
274
|
-
*
|
|
274
|
+
* RFC 4122 UUID of menu item expressed in URL-safe base64 format
|
|
275
275
|
*
|
|
276
276
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
277
277
|
* via the `definition` "identity".
|
|
@@ -295,7 +295,7 @@ export type ItemTypeType = 'item_type';
|
|
|
295
295
|
*/
|
|
296
296
|
export type ItemTypeFilterType = 'item_type_filter';
|
|
297
297
|
/**
|
|
298
|
-
*
|
|
298
|
+
* RFC 4122 UUID of filter expressed in URL-safe base64 format
|
|
299
299
|
*
|
|
300
300
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
301
301
|
* via the `definition` "identity".
|
|
@@ -324,7 +324,7 @@ export type MenuItemInstancesHrefSchema = {
|
|
|
324
324
|
*/
|
|
325
325
|
export type ItemType1 = 'item';
|
|
326
326
|
/**
|
|
327
|
-
*
|
|
327
|
+
* RFC 4122 UUID of record expressed in URL-safe base64 format
|
|
328
328
|
*
|
|
329
329
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
330
330
|
* via the `definition` "identity".
|
|
@@ -341,7 +341,7 @@ export type ItemIdentity = string;
|
|
|
341
341
|
*/
|
|
342
342
|
export type FieldType = 'field';
|
|
343
343
|
/**
|
|
344
|
-
*
|
|
344
|
+
* RFC 4122 UUID of field expressed in URL-safe base64 format
|
|
345
345
|
*
|
|
346
346
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
347
347
|
* via the `definition` "identity".
|
|
@@ -358,7 +358,7 @@ export type FieldIdentity = string;
|
|
|
358
358
|
*/
|
|
359
359
|
export type FieldsetType = 'fieldset';
|
|
360
360
|
/**
|
|
361
|
-
*
|
|
361
|
+
* RFC 4122 UUID of fieldset expressed in URL-safe base64 format
|
|
362
362
|
*
|
|
363
363
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
364
364
|
* via the `definition` "identity".
|
|
@@ -438,7 +438,7 @@ export type SessionIdentity = string;
|
|
|
438
438
|
*/
|
|
439
439
|
export type PluginType = 'plugin';
|
|
440
440
|
/**
|
|
441
|
-
*
|
|
441
|
+
* RFC 4122 UUID of plugin expressed in URL-safe base64 format
|
|
442
442
|
*
|
|
443
443
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
444
444
|
* via the `definition` "identity".
|
|
@@ -625,7 +625,7 @@ export type ItemSelfHrefSchema = {
|
|
|
625
625
|
*/
|
|
626
626
|
export type ItemCurrentVsPublishedStateType = 'item_current_vs_published_state';
|
|
627
627
|
/**
|
|
628
|
-
*
|
|
628
|
+
* RFC 4122 UUID of record expressed in URL-safe base64 format
|
|
629
629
|
*
|
|
630
630
|
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
631
631
|
* via the `definition` "identity".
|
|
@@ -676,7 +676,7 @@ export type ScheduledUnpublishingIdentity = string;
|
|
|
676
676
|
*/
|
|
677
677
|
export type ItemVersionType = 'item_version';
|
|
678
678
|
/**
|
|
679
|
-
*
|
|
679
|
+
* RFC 4122 UUID of redord version expressed in URL-safe base64 format
|
|
680
680
|
*
|
|
681
681
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
682
682
|
* via the `definition` "identity".
|
|
@@ -810,7 +810,7 @@ export type ItemUnpublishHrefSchema = {
|
|
|
810
810
|
*/
|
|
811
811
|
export type UploadType = 'upload';
|
|
812
812
|
/**
|
|
813
|
-
*
|
|
813
|
+
* RFC 4122 UUID of upload expressed in URL-safe base64 format
|
|
814
814
|
*
|
|
815
815
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
816
816
|
* via the `definition` "identity".
|
|
@@ -1099,7 +1099,7 @@ export type WebhookCallInstancesHrefSchema = {
|
|
|
1099
1099
|
*/
|
|
1100
1100
|
export type UploadFilterType = 'upload_filter';
|
|
1101
1101
|
/**
|
|
1102
|
-
*
|
|
1102
|
+
* RFC 4122 UUID of upload filter expressed in URL-safe base64 format
|
|
1103
1103
|
*
|
|
1104
1104
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
1105
1105
|
* via the `definition` "identity".
|
|
@@ -4234,7 +4234,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4234
4234
|
*
|
|
4235
4235
|
* Below you'll find a summary of all the validators available for each field type with their settings.
|
|
4236
4236
|
*
|
|
4237
|
-
* Some validators are required for a specific type of field. For example, the
|
|
4237
|
+
* Some validators are required for a specific type of field. For example, the _Modular Content_ field needs to have a `rich_text_blocks` validator, specifying which types of blocks it can contain.
|
|
4238
4238
|
*
|
|
4239
4239
|
* ### Specifying the appearance
|
|
4240
4240
|
*
|
|
@@ -4420,23 +4420,22 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4420
4420
|
* <details>
|
|
4421
4421
|
* <summary>SEO and Social (<code>seo</code>)</summary>
|
|
4422
4422
|
*
|
|
4423
|
-
* | Property | Value
|
|
4424
|
-
* | ------------------------------ |
|
|
4425
|
-
* | Code | `seo`
|
|
4426
|
-
* | Built-in editors for the field | `seo`
|
|
4427
|
-
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
|
|
4423
|
+
* | Property | Value |
|
|
4424
|
+
* | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
4425
|
+
* | Code | `seo` |
|
|
4426
|
+
* | Built-in editors for the field | `seo` |
|
|
4427
|
+
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `title_length`, `description_length` |
|
|
4428
4428
|
*
|
|
4429
4429
|
* </details>
|
|
4430
4430
|
*
|
|
4431
4431
|
* <details>
|
|
4432
4432
|
* <summary>Slug (<code>slug</code>)</summary>
|
|
4433
4433
|
*
|
|
4434
|
-
* | Property | Value
|
|
4435
|
-
* | ------------------------------ |
|
|
4436
|
-
* | Code | `slug`
|
|
4437
|
-
* | Built-in editors for the field | `slug`
|
|
4438
|
-
* |
|
|
4439
|
-
* | Other validators available | `required`, `length`, `slug_format` |
|
|
4434
|
+
* | Property | Value |
|
|
4435
|
+
* | ------------------------------ | ------------------------------------------------------- |
|
|
4436
|
+
* | Code | `slug` |
|
|
4437
|
+
* | Built-in editors for the field | `slug` |
|
|
4438
|
+
* | Available validators | `required`, `length`, `slug_format`, `slug_title_field` |
|
|
4440
4439
|
*
|
|
4441
4440
|
* </details>
|
|
4442
4441
|
*
|
|
@@ -4454,22 +4453,22 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4454
4453
|
* <details>
|
|
4455
4454
|
* <summary>Single-asset (<code>file</code>)</summary>
|
|
4456
4455
|
*
|
|
4457
|
-
* | Property | Value
|
|
4458
|
-
* | ------------------------------ |
|
|
4459
|
-
* | Code | `file`
|
|
4460
|
-
* | Built-in editors for the field | `file`
|
|
4461
|
-
* | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
4456
|
+
* | Property | Value |
|
|
4457
|
+
* | ------------------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
4458
|
+
* | Code | `file` |
|
|
4459
|
+
* | Built-in editors for the field | `file` |
|
|
4460
|
+
* | Available validators | `required`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
|
|
4462
4461
|
*
|
|
4463
4462
|
* </details>
|
|
4464
4463
|
*
|
|
4465
4464
|
* <details>
|
|
4466
4465
|
* <summary>Asset gallery (<code>gallery</code>)</summary>
|
|
4467
4466
|
*
|
|
4468
|
-
* | Property | Value
|
|
4469
|
-
* | ------------------------------ |
|
|
4470
|
-
* | Code | `gallery`
|
|
4471
|
-
* | Built-in editors for the field | `gallery`
|
|
4472
|
-
* | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
4467
|
+
* | Property | Value |
|
|
4468
|
+
* | ------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
4469
|
+
* | Code | `gallery` |
|
|
4470
|
+
* | Built-in editors for the field | `gallery` |
|
|
4471
|
+
* | Available validators | `size`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
|
|
4473
4472
|
*
|
|
4474
4473
|
* </details>
|
|
4475
4474
|
*
|
|
@@ -4625,7 +4624,7 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4625
4624
|
* <details>
|
|
4626
4625
|
* <summary><code>image_dimensions</code></summary>
|
|
4627
4626
|
*
|
|
4628
|
-
* Accept assets only within a specified height
|
|
4627
|
+
* Accept assets only within a specified height and width range.
|
|
4629
4628
|
*
|
|
4630
4629
|
* | Parameter | Type | Required | Description |
|
|
4631
4630
|
* | ------------------ | --------- | -------- | -------------------------------- |
|
|
@@ -4634,7 +4633,25 @@ export type ItemTypeDestroyJobSchema = {
|
|
|
4634
4633
|
* | `height_min_value` | `Integer` | | Numeric value for minimum width |
|
|
4635
4634
|
* | `height_max_value` | `Integer` | | Numeric value for maximum height |
|
|
4636
4635
|
*
|
|
4637
|
-
* At least one
|
|
4636
|
+
* At least one pair of height/width parameters must be specified.
|
|
4637
|
+
*
|
|
4638
|
+
* </details>
|
|
4639
|
+
*
|
|
4640
|
+
* <details>
|
|
4641
|
+
* <summary><code>image_aspect_ratio</code></summary>
|
|
4642
|
+
*
|
|
4643
|
+
* Accept assets only within a specified aspect ratio range.
|
|
4644
|
+
*
|
|
4645
|
+
* | Parameter | Type | Required | Description |
|
|
4646
|
+
* | -------------------- | --------- | -------- | ---------------------------------------------- |
|
|
4647
|
+
* | `min_ar_numerator` | `Integer` | | Numerator part of the minimum aspect ratio |
|
|
4648
|
+
* | `min_ar_denominator` | `Integer` | | Denominator part of the minimum aspect ratio |
|
|
4649
|
+
* | `eq_ar_numerator` | `Integer` | | Numerator part for the required aspect ratio |
|
|
4650
|
+
* | `eq_ar_denominator` | `Integer` | | Denominator part for the required aspect ratio |
|
|
4651
|
+
* | `max_ar_numerator` | `Integer` | | Numerator part of the maximum aspect ratio |
|
|
4652
|
+
* | `max_ar_denominator` | `Integer` | | Denominator part of the maximum aspect ratio |
|
|
4653
|
+
*
|
|
4654
|
+
* At least one pair of numerator/denominator must be specified.
|
|
4638
4655
|
*
|
|
4639
4656
|
* </details>
|
|
4640
4657
|
*
|
|
@@ -6348,6 +6365,13 @@ export type BuildEventSelfTargetSchema = {
|
|
|
6348
6365
|
/**
|
|
6349
6366
|
* DatoCMS stores the individual pieces of content you create from a model as records, which are much like table rows in a database. For backward-compatibility reasons, the API refers to records as "items".
|
|
6350
6367
|
*
|
|
6368
|
+
* You can learn how the records are structured at the API level, and everything that is necessary to interact with the records through CMA in the following detail sections:
|
|
6369
|
+
*
|
|
6370
|
+
* * [List/filter records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6371
|
+
* * [Create new records](https://www.datocms.com/docs/content-management-api/resources/item/create)
|
|
6372
|
+
* * [Update existing records](https://www.datocms.com/docs/content-management-api/resources/item/update)
|
|
6373
|
+
*
|
|
6374
|
+
*
|
|
6351
6375
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6352
6376
|
* via the `definition` "item".
|
|
6353
6377
|
*/
|
|
@@ -21,7 +21,7 @@ export type RoleIdentity = string;
|
|
|
21
21
|
*/
|
|
22
22
|
export type RoleType = 'role';
|
|
23
23
|
/**
|
|
24
|
-
*
|
|
24
|
+
* RFC 4122 UUID of item type expressed in URL-safe base64 format
|
|
25
25
|
*
|
|
26
26
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
27
27
|
* via the `definition` "identity".
|
|
@@ -31,7 +31,7 @@ export type RoleType = 'role';
|
|
|
31
31
|
*/
|
|
32
32
|
export type ItemTypeIdentity = string;
|
|
33
33
|
/**
|
|
34
|
-
*
|
|
34
|
+
* RFC 4122 UUID of workflow expressed in URL-safe base64 format
|
|
35
35
|
*
|
|
36
36
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
37
37
|
* via the `definition` "identity".
|
|
@@ -299,7 +299,7 @@ export type SitePlanIdentity = string;
|
|
|
299
299
|
*/
|
|
300
300
|
export type SitePlanType = 'site_plan';
|
|
301
301
|
/**
|
|
302
|
-
*
|
|
302
|
+
* RFC 4122 UUID of menu item expressed in URL-safe base64 format
|
|
303
303
|
*
|
|
304
304
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
305
305
|
* via the `definition` "identity".
|
|
@@ -330,7 +330,7 @@ export type ItemTypeType = 'item_type';
|
|
|
330
330
|
*/
|
|
331
331
|
export type ItemTypeFilterType = 'item_type_filter';
|
|
332
332
|
/**
|
|
333
|
-
*
|
|
333
|
+
* RFC 4122 UUID of filter expressed in URL-safe base64 format
|
|
334
334
|
*
|
|
335
335
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
336
336
|
* via the `definition` "identity".
|
|
@@ -364,7 +364,7 @@ export type MenuItemInstancesHrefSchema = {
|
|
|
364
364
|
*/
|
|
365
365
|
export type ItemType1 = 'item';
|
|
366
366
|
/**
|
|
367
|
-
*
|
|
367
|
+
* RFC 4122 UUID of record expressed in URL-safe base64 format
|
|
368
368
|
*
|
|
369
369
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
370
370
|
* via the `definition` "identity".
|
|
@@ -381,7 +381,7 @@ export type ItemIdentity = string;
|
|
|
381
381
|
*/
|
|
382
382
|
export type FieldType = 'field';
|
|
383
383
|
/**
|
|
384
|
-
*
|
|
384
|
+
* RFC 4122 UUID of field expressed in URL-safe base64 format
|
|
385
385
|
*
|
|
386
386
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
387
387
|
* via the `definition` "identity".
|
|
@@ -398,7 +398,7 @@ export type FieldIdentity = string;
|
|
|
398
398
|
*/
|
|
399
399
|
export type FieldsetType = 'fieldset';
|
|
400
400
|
/**
|
|
401
|
-
*
|
|
401
|
+
* RFC 4122 UUID of fieldset expressed in URL-safe base64 format
|
|
402
402
|
*
|
|
403
403
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
404
404
|
* via the `definition` "identity".
|
|
@@ -496,7 +496,7 @@ export type SessionIdentity = string;
|
|
|
496
496
|
*/
|
|
497
497
|
export type SessionType = 'session';
|
|
498
498
|
/**
|
|
499
|
-
*
|
|
499
|
+
* RFC 4122 UUID of plugin expressed in URL-safe base64 format
|
|
500
500
|
*
|
|
501
501
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
502
502
|
* via the `definition` "identity".
|
|
@@ -718,7 +718,7 @@ export type ItemSelfHrefSchema = {
|
|
|
718
718
|
[k: string]: unknown;
|
|
719
719
|
};
|
|
720
720
|
/**
|
|
721
|
-
*
|
|
721
|
+
* RFC 4122 UUID of record expressed in URL-safe base64 format
|
|
722
722
|
*
|
|
723
723
|
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
724
724
|
* via the `definition` "identity".
|
|
@@ -776,7 +776,7 @@ export type ScheduledUnpublishingIdentity = string;
|
|
|
776
776
|
*/
|
|
777
777
|
export type ItemVersionType = 'item_version';
|
|
778
778
|
/**
|
|
779
|
-
*
|
|
779
|
+
* RFC 4122 UUID of redord version expressed in URL-safe base64 format
|
|
780
780
|
*
|
|
781
781
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
782
782
|
* via the `definition` "identity".
|
|
@@ -940,7 +940,7 @@ export type ItemVersionInstancesHrefSchema = {
|
|
|
940
940
|
[k: string]: unknown;
|
|
941
941
|
};
|
|
942
942
|
/**
|
|
943
|
-
*
|
|
943
|
+
* RFC 4122 UUID of upload expressed in URL-safe base64 format
|
|
944
944
|
*
|
|
945
945
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
946
946
|
* via the `definition` "identity".
|
|
@@ -1299,7 +1299,7 @@ export type BuildTriggerInstancesTargetSchema = BuildTrigger[];
|
|
|
1299
1299
|
*/
|
|
1300
1300
|
export type ItemTypeFilterInstancesTargetSchema = ItemTypeFilter[];
|
|
1301
1301
|
/**
|
|
1302
|
-
*
|
|
1302
|
+
* RFC 4122 UUID of upload filter expressed in URL-safe base64 format
|
|
1303
1303
|
*
|
|
1304
1304
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
1305
1305
|
* via the `definition` "identity".
|
|
@@ -4759,7 +4759,7 @@ export type JobData = {
|
|
|
4759
4759
|
*
|
|
4760
4760
|
* Below you'll find a summary of all the validators available for each field type with their settings.
|
|
4761
4761
|
*
|
|
4762
|
-
* Some validators are required for a specific type of field. For example, the
|
|
4762
|
+
* Some validators are required for a specific type of field. For example, the _Modular Content_ field needs to have a `rich_text_blocks` validator, specifying which types of blocks it can contain.
|
|
4763
4763
|
*
|
|
4764
4764
|
* ### Specifying the appearance
|
|
4765
4765
|
*
|
|
@@ -4945,23 +4945,22 @@ export type JobData = {
|
|
|
4945
4945
|
* <details>
|
|
4946
4946
|
* <summary>SEO and Social (<code>seo</code>)</summary>
|
|
4947
4947
|
*
|
|
4948
|
-
* | Property | Value
|
|
4949
|
-
* | ------------------------------ |
|
|
4950
|
-
* | Code | `seo`
|
|
4951
|
-
* | Built-in editors for the field | `seo`
|
|
4952
|
-
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
|
|
4948
|
+
* | Property | Value |
|
|
4949
|
+
* | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
4950
|
+
* | Code | `seo` |
|
|
4951
|
+
* | Built-in editors for the field | `seo` |
|
|
4952
|
+
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `title_length`, `description_length` |
|
|
4953
4953
|
*
|
|
4954
4954
|
* </details>
|
|
4955
4955
|
*
|
|
4956
4956
|
* <details>
|
|
4957
4957
|
* <summary>Slug (<code>slug</code>)</summary>
|
|
4958
4958
|
*
|
|
4959
|
-
* | Property | Value
|
|
4960
|
-
* | ------------------------------ |
|
|
4961
|
-
* | Code | `slug`
|
|
4962
|
-
* | Built-in editors for the field | `slug`
|
|
4963
|
-
* |
|
|
4964
|
-
* | Other validators available | `required`, `length`, `slug_format` |
|
|
4959
|
+
* | Property | Value |
|
|
4960
|
+
* | ------------------------------ | ------------------------------------------------------- |
|
|
4961
|
+
* | Code | `slug` |
|
|
4962
|
+
* | Built-in editors for the field | `slug` |
|
|
4963
|
+
* | Available validators | `required`, `length`, `slug_format`, `slug_title_field` |
|
|
4965
4964
|
*
|
|
4966
4965
|
* </details>
|
|
4967
4966
|
*
|
|
@@ -4979,22 +4978,22 @@ export type JobData = {
|
|
|
4979
4978
|
* <details>
|
|
4980
4979
|
* <summary>Single-asset (<code>file</code>)</summary>
|
|
4981
4980
|
*
|
|
4982
|
-
* | Property | Value
|
|
4983
|
-
* | ------------------------------ |
|
|
4984
|
-
* | Code | `file`
|
|
4985
|
-
* | Built-in editors for the field | `file`
|
|
4986
|
-
* | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
4981
|
+
* | Property | Value |
|
|
4982
|
+
* | ------------------------------ | ---------------------------------------------------------------------------------------------------- |
|
|
4983
|
+
* | Code | `file` |
|
|
4984
|
+
* | Built-in editors for the field | `file` |
|
|
4985
|
+
* | Available validators | `required`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
|
|
4987
4986
|
*
|
|
4988
4987
|
* </details>
|
|
4989
4988
|
*
|
|
4990
4989
|
* <details>
|
|
4991
4990
|
* <summary>Asset gallery (<code>gallery</code>)</summary>
|
|
4992
4991
|
*
|
|
4993
|
-
* | Property | Value
|
|
4994
|
-
* | ------------------------------ |
|
|
4995
|
-
* | Code | `gallery`
|
|
4996
|
-
* | Built-in editors for the field | `gallery`
|
|
4997
|
-
* | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
|
|
4992
|
+
* | Property | Value |
|
|
4993
|
+
* | ------------------------------ | ------------------------------------------------------------------------------------------------ |
|
|
4994
|
+
* | Code | `gallery` |
|
|
4995
|
+
* | Built-in editors for the field | `gallery` |
|
|
4996
|
+
* | Available validators | `size`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
|
|
4998
4997
|
*
|
|
4999
4998
|
* </details>
|
|
5000
4999
|
*
|
|
@@ -5150,7 +5149,7 @@ export type JobData = {
|
|
|
5150
5149
|
* <details>
|
|
5151
5150
|
* <summary><code>image_dimensions</code></summary>
|
|
5152
5151
|
*
|
|
5153
|
-
* Accept assets only within a specified height
|
|
5152
|
+
* Accept assets only within a specified height and width range.
|
|
5154
5153
|
*
|
|
5155
5154
|
* | Parameter | Type | Required | Description |
|
|
5156
5155
|
* | ------------------ | --------- | -------- | -------------------------------- |
|
|
@@ -5159,7 +5158,25 @@ export type JobData = {
|
|
|
5159
5158
|
* | `height_min_value` | `Integer` | | Numeric value for minimum width |
|
|
5160
5159
|
* | `height_max_value` | `Integer` | | Numeric value for maximum height |
|
|
5161
5160
|
*
|
|
5162
|
-
* At least one
|
|
5161
|
+
* At least one pair of height/width parameters must be specified.
|
|
5162
|
+
*
|
|
5163
|
+
* </details>
|
|
5164
|
+
*
|
|
5165
|
+
* <details>
|
|
5166
|
+
* <summary><code>image_aspect_ratio</code></summary>
|
|
5167
|
+
*
|
|
5168
|
+
* Accept assets only within a specified aspect ratio range.
|
|
5169
|
+
*
|
|
5170
|
+
* | Parameter | Type | Required | Description |
|
|
5171
|
+
* | -------------------- | --------- | -------- | ---------------------------------------------- |
|
|
5172
|
+
* | `min_ar_numerator` | `Integer` | | Numerator part of the minimum aspect ratio |
|
|
5173
|
+
* | `min_ar_denominator` | `Integer` | | Denominator part of the minimum aspect ratio |
|
|
5174
|
+
* | `eq_ar_numerator` | `Integer` | | Numerator part for the required aspect ratio |
|
|
5175
|
+
* | `eq_ar_denominator` | `Integer` | | Denominator part for the required aspect ratio |
|
|
5176
|
+
* | `max_ar_numerator` | `Integer` | | Numerator part of the maximum aspect ratio |
|
|
5177
|
+
* | `max_ar_denominator` | `Integer` | | Denominator part of the maximum aspect ratio |
|
|
5178
|
+
*
|
|
5179
|
+
* At least one pair of numerator/denominator must be specified.
|
|
5163
5180
|
*
|
|
5164
5181
|
* </details>
|
|
5165
5182
|
*
|
|
@@ -6803,6 +6820,13 @@ export type BuildEventRelationships = {
|
|
|
6803
6820
|
/**
|
|
6804
6821
|
* DatoCMS stores the individual pieces of content you create from a model as records, which are much like table rows in a database. For backward-compatibility reasons, the API refers to records as "items".
|
|
6805
6822
|
*
|
|
6823
|
+
* You can learn how the records are structured at the API level, and everything that is necessary to interact with the records through CMA in the following detail sections:
|
|
6824
|
+
*
|
|
6825
|
+
* * [List/filter records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6826
|
+
* * [Create new records](https://www.datocms.com/docs/content-management-api/resources/item/create)
|
|
6827
|
+
* * [Update existing records](https://www.datocms.com/docs/content-management-api/resources/item/update)
|
|
6828
|
+
*
|
|
6829
|
+
*
|
|
6806
6830
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6807
6831
|
* via the `destroy.targetSchema` link.
|
|
6808
6832
|
*
|