datocms-plugin-sdk 0.6.15 → 0.6.17
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/SiteApiSchema.js +0 -1
- package/dist/cjs/SiteApiSchema.js.map +1 -1
- package/dist/esm/SiteApiSchema.d.ts +536 -275
- package/dist/esm/SiteApiSchema.js +0 -1
- package/dist/esm/SiteApiSchema.js.map +1 -1
- package/dist/types/SiteApiSchema.d.ts +536 -275
- package/package.json +2 -2
- package/src/SiteApiSchema.ts +601 -277
- package/types.json +2059 -2007
package/src/SiteApiSchema.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
/* eslint-disable camelcase */
|
|
2
1
|
/* tslint:disable */
|
|
3
2
|
/**
|
|
4
3
|
* This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT
|
|
@@ -284,6 +283,23 @@ export type MenuItemIdentity = string;
|
|
|
284
283
|
* `definition` "type".
|
|
285
284
|
*/
|
|
286
285
|
export type ItemTypeType = 'item_type';
|
|
286
|
+
/**
|
|
287
|
+
* JSON API type field
|
|
288
|
+
*
|
|
289
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
290
|
+
* `definition` "type".
|
|
291
|
+
*/
|
|
292
|
+
export type ItemTypeFilterType = 'item_type_filter';
|
|
293
|
+
/**
|
|
294
|
+
* ID of filter
|
|
295
|
+
*
|
|
296
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
297
|
+
* `definition` "identity".
|
|
298
|
+
*
|
|
299
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
300
|
+
* `definition` "id".
|
|
301
|
+
*/
|
|
302
|
+
export type ItemTypeFilterIdentity = string;
|
|
287
303
|
/**
|
|
288
304
|
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
289
305
|
* `instances.hrefSchema` link.
|
|
@@ -352,6 +368,15 @@ export type FieldsetIdentity = string;
|
|
|
352
368
|
* `definition` "type".
|
|
353
369
|
*/
|
|
354
370
|
export type WorkflowType = 'workflow';
|
|
371
|
+
/**
|
|
372
|
+
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
373
|
+
* `create.hrefSchema` link.
|
|
374
|
+
*/
|
|
375
|
+
export type ItemTypeCreateHrefSchema = {
|
|
376
|
+
/** Skip the creation of a menu item linked to the model */
|
|
377
|
+
skip_menu_item_creation?: string;
|
|
378
|
+
[k: string]: unknown;
|
|
379
|
+
};
|
|
355
380
|
/**
|
|
356
381
|
* JSON API type field
|
|
357
382
|
*
|
|
@@ -369,6 +394,15 @@ export type JobType = 'job';
|
|
|
369
394
|
* "id".
|
|
370
395
|
*/
|
|
371
396
|
export type JobIdentity = string;
|
|
397
|
+
/**
|
|
398
|
+
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
399
|
+
* `destroy.hrefSchema` link.
|
|
400
|
+
*/
|
|
401
|
+
export type ItemTypeDestroyHrefSchema = {
|
|
402
|
+
/** Skip the deletion of the menu items linked to the model */
|
|
403
|
+
skip_menu_items_deletion?: string;
|
|
404
|
+
[k: string]: unknown;
|
|
405
|
+
};
|
|
372
406
|
/**
|
|
373
407
|
* JSON API type field
|
|
374
408
|
*
|
|
@@ -532,10 +566,14 @@ export type ItemInstancesHrefSchema = {
|
|
|
532
566
|
[k: string]: unknown;
|
|
533
567
|
};
|
|
534
568
|
/**
|
|
535
|
-
* Fields used to order results. You
|
|
569
|
+
* Fields used to order results. You **must** specify also `filter[type]` with
|
|
536
570
|
* one element only to be able use this option. Format:
|
|
537
|
-
* `<field_name>_
|
|
538
|
-
*
|
|
571
|
+
* `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key
|
|
572
|
+
* of a model's field, or one of the following meta columns: `id`,
|
|
573
|
+
* `_updated_at`, `_created_at`, `_status`, `_published_at`,
|
|
574
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
575
|
+
* `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable
|
|
576
|
+
* models). You can pass multiple comma separated rules.
|
|
539
577
|
*/
|
|
540
578
|
order_by?: string;
|
|
541
579
|
/**
|
|
@@ -831,16 +869,32 @@ export type SearchResultIdentity = string;
|
|
|
831
869
|
* `instances.hrefSchema` link.
|
|
832
870
|
*/
|
|
833
871
|
export type SearchResultInstancesHrefSchema = {
|
|
834
|
-
/**
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
/**
|
|
843
|
-
|
|
872
|
+
/** Attributes to manage results pagination */
|
|
873
|
+
page?: {
|
|
874
|
+
/** Index of first element to fetch (defaults to 0) */
|
|
875
|
+
offset?: number;
|
|
876
|
+
/** Number of elements to fetch (defaults to 20, maximum is 100) */
|
|
877
|
+
limit?: number;
|
|
878
|
+
[k: string]: unknown;
|
|
879
|
+
};
|
|
880
|
+
/** Attributes to filter search results */
|
|
881
|
+
filter: {
|
|
882
|
+
/**
|
|
883
|
+
* When any value is passed, it enables the fuzzy search: the Levenshtein
|
|
884
|
+
* Edit Distance is used to match more results.
|
|
885
|
+
*/
|
|
886
|
+
fuzzy?: string;
|
|
887
|
+
/** Text to search */
|
|
888
|
+
query: string;
|
|
889
|
+
/**
|
|
890
|
+
* The build trigger ID on which the search will be performed. Required if
|
|
891
|
+
* more than one build trigger is present in a project
|
|
892
|
+
*/
|
|
893
|
+
build_trigger_id?: string;
|
|
894
|
+
/** Restrict the search on pages in a specific locale */
|
|
895
|
+
locale?: string;
|
|
896
|
+
[k: string]: unknown;
|
|
897
|
+
};
|
|
844
898
|
[k: string]: unknown;
|
|
845
899
|
};
|
|
846
900
|
/**
|
|
@@ -925,23 +979,6 @@ export type WebhookCallInstancesHrefSchema = {
|
|
|
925
979
|
};
|
|
926
980
|
[k: string]: unknown;
|
|
927
981
|
};
|
|
928
|
-
/**
|
|
929
|
-
* JSON API type field
|
|
930
|
-
*
|
|
931
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
932
|
-
* `definition` "type".
|
|
933
|
-
*/
|
|
934
|
-
export type ItemTypeFilterType = 'item_type_filter';
|
|
935
|
-
/**
|
|
936
|
-
* ID of filter
|
|
937
|
-
*
|
|
938
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
939
|
-
* `definition` "identity".
|
|
940
|
-
*
|
|
941
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
942
|
-
* `definition` "id".
|
|
943
|
-
*/
|
|
944
|
-
export type ItemTypeFilterIdentity = string;
|
|
945
982
|
/**
|
|
946
983
|
* JSON API type field
|
|
947
984
|
*
|
|
@@ -2825,7 +2862,7 @@ export interface MenuItemAttributes {
|
|
|
2825
2862
|
external_url: null | string;
|
|
2826
2863
|
/** Ordering index */
|
|
2827
2864
|
position: number;
|
|
2828
|
-
/** Opens link in new tab (used together with `external_url`) */
|
|
2865
|
+
/** Opens link in new tab (to be used together with `external_url`) */
|
|
2829
2866
|
open_in_new_tab: boolean;
|
|
2830
2867
|
}
|
|
2831
2868
|
|
|
@@ -2840,6 +2877,13 @@ export interface MenuItemRelationships {
|
|
|
2840
2877
|
item_type: {
|
|
2841
2878
|
data: ItemTypeData | null;
|
|
2842
2879
|
};
|
|
2880
|
+
/**
|
|
2881
|
+
* Item type filter associated with the menu item (to be used together with
|
|
2882
|
+
* `item_type` relationship)
|
|
2883
|
+
*/
|
|
2884
|
+
item_type_filter: {
|
|
2885
|
+
data: ItemTypeFilterData | null;
|
|
2886
|
+
};
|
|
2843
2887
|
/** Parent menu item */
|
|
2844
2888
|
parent: {
|
|
2845
2889
|
data: null | MenuItemData;
|
|
@@ -2861,6 +2905,17 @@ export interface ItemTypeData {
|
|
|
2861
2905
|
id: ItemTypeIdentity;
|
|
2862
2906
|
}
|
|
2863
2907
|
|
|
2908
|
+
/**
|
|
2909
|
+
* JSON API data
|
|
2910
|
+
*
|
|
2911
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
2912
|
+
* `definition` "data".
|
|
2913
|
+
*/
|
|
2914
|
+
export interface ItemTypeFilterData {
|
|
2915
|
+
type: ItemTypeFilterType;
|
|
2916
|
+
id: ItemTypeFilterIdentity;
|
|
2917
|
+
}
|
|
2918
|
+
|
|
2864
2919
|
/**
|
|
2865
2920
|
* JSON API data
|
|
2866
2921
|
*
|
|
@@ -2886,8 +2941,8 @@ export interface MenuItemCreateSchema {
|
|
|
2886
2941
|
/** The URL to which the menu item points to */
|
|
2887
2942
|
external_url?: null | string;
|
|
2888
2943
|
/** Ordering index */
|
|
2889
|
-
position
|
|
2890
|
-
/** Opens link in new tab (used together with `external_url`) */
|
|
2944
|
+
position?: number;
|
|
2945
|
+
/** Opens link in new tab (to be used together with `external_url`) */
|
|
2891
2946
|
open_in_new_tab?: boolean;
|
|
2892
2947
|
};
|
|
2893
2948
|
relationships?: {
|
|
@@ -2895,6 +2950,13 @@ export interface MenuItemCreateSchema {
|
|
|
2895
2950
|
item_type?: {
|
|
2896
2951
|
data: ItemTypeData | null;
|
|
2897
2952
|
};
|
|
2953
|
+
/**
|
|
2954
|
+
* Item type filter associated with the menu item (to be used together
|
|
2955
|
+
* with `item_type` relationship)
|
|
2956
|
+
*/
|
|
2957
|
+
item_type_filter?: {
|
|
2958
|
+
data: ItemTypeFilterData | null;
|
|
2959
|
+
};
|
|
2898
2960
|
/** Parent menu item */
|
|
2899
2961
|
parent?: {
|
|
2900
2962
|
data: null | MenuItemData;
|
|
@@ -2922,12 +2984,12 @@ export interface MenuItemUpdateSchema {
|
|
|
2922
2984
|
/** JSON API attributes */
|
|
2923
2985
|
attributes?: {
|
|
2924
2986
|
/** The label of the menu item */
|
|
2925
|
-
label
|
|
2987
|
+
label?: string;
|
|
2926
2988
|
/** The URL to which the menu item points to */
|
|
2927
2989
|
external_url?: null | string;
|
|
2928
2990
|
/** Ordering index */
|
|
2929
|
-
position
|
|
2930
|
-
/** Opens link in new tab (used together with `external_url`) */
|
|
2991
|
+
position?: number;
|
|
2992
|
+
/** Opens link in new tab (to be used together with `external_url`) */
|
|
2931
2993
|
open_in_new_tab?: boolean;
|
|
2932
2994
|
};
|
|
2933
2995
|
relationships?: {
|
|
@@ -2935,6 +2997,13 @@ export interface MenuItemUpdateSchema {
|
|
|
2935
2997
|
item_type?: {
|
|
2936
2998
|
data: ItemTypeData | null;
|
|
2937
2999
|
};
|
|
3000
|
+
/**
|
|
3001
|
+
* Item type filter associated with the menu item (to be used together
|
|
3002
|
+
* with `item_type` relationship)
|
|
3003
|
+
*/
|
|
3004
|
+
item_type_filter?: {
|
|
3005
|
+
data: ItemTypeFilterData | null;
|
|
3006
|
+
};
|
|
2938
3007
|
/** Parent menu item */
|
|
2939
3008
|
parent?: {
|
|
2940
3009
|
data: null | MenuItemData;
|
|
@@ -2989,6 +3058,7 @@ export interface ItemType {
|
|
|
2989
3058
|
id: ItemTypeIdentity;
|
|
2990
3059
|
attributes: ItemTypeAttributes;
|
|
2991
3060
|
relationships: ItemTypeRelationships;
|
|
3061
|
+
meta: ItemTypeMeta;
|
|
2992
3062
|
}
|
|
2993
3063
|
|
|
2994
3064
|
/**
|
|
@@ -3003,7 +3073,7 @@ export interface ItemTypeAttributes {
|
|
|
3003
3073
|
/** API key of the model */
|
|
3004
3074
|
api_key: string;
|
|
3005
3075
|
/** The way the model collection should be presented to the editors */
|
|
3006
|
-
collection_appeareance
|
|
3076
|
+
collection_appeareance?: 'compact' | 'table';
|
|
3007
3077
|
/** The way the model collection should be presented to the editors */
|
|
3008
3078
|
collection_appearance: 'compact' | 'table';
|
|
3009
3079
|
/** Whether the model is single-instance or not */
|
|
@@ -3043,6 +3113,8 @@ export interface ItemTypeAttributes {
|
|
|
3043
3113
|
* model/block
|
|
3044
3114
|
*/
|
|
3045
3115
|
hint: string | null;
|
|
3116
|
+
/** Whether inverse relationships fields are expressed in GraphQL or not */
|
|
3117
|
+
inverse_relationships_enabled: boolean;
|
|
3046
3118
|
}
|
|
3047
3119
|
|
|
3048
3120
|
/**
|
|
@@ -3130,6 +3202,20 @@ export interface WorkflowData {
|
|
|
3130
3202
|
id: WorkflowIdentity;
|
|
3131
3203
|
}
|
|
3132
3204
|
|
|
3205
|
+
/**
|
|
3206
|
+
* Meta information regarding the item type
|
|
3207
|
+
*
|
|
3208
|
+
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
3209
|
+
* `definition` "meta".
|
|
3210
|
+
*/
|
|
3211
|
+
export interface ItemTypeMeta {
|
|
3212
|
+
/**
|
|
3213
|
+
* If this model is single-instance, this tells the single-instance record has
|
|
3214
|
+
* already been created or not
|
|
3215
|
+
*/
|
|
3216
|
+
has_singleton_item: boolean;
|
|
3217
|
+
}
|
|
3218
|
+
|
|
3133
3219
|
/**
|
|
3134
3220
|
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
3135
3221
|
* `create.schema` link.
|
|
@@ -3179,6 +3265,8 @@ export interface ItemTypeCreateSchema {
|
|
|
3179
3265
|
* model/block
|
|
3180
3266
|
*/
|
|
3181
3267
|
hint?: string | null;
|
|
3268
|
+
/** Whether inverse relationships fields are expressed in GraphQL or not */
|
|
3269
|
+
inverse_relationships_enabled?: boolean;
|
|
3182
3270
|
};
|
|
3183
3271
|
relationships?: {
|
|
3184
3272
|
/** The field upon which the collection is sorted */
|
|
@@ -3269,6 +3357,8 @@ export interface ItemTypeUpdateSchema {
|
|
|
3269
3357
|
* model/block
|
|
3270
3358
|
*/
|
|
3271
3359
|
hint?: string | null;
|
|
3360
|
+
/** Whether inverse relationships fields are expressed in GraphQL or not */
|
|
3361
|
+
inverse_relationships_enabled?: boolean;
|
|
3272
3362
|
};
|
|
3273
3363
|
relationships?: {
|
|
3274
3364
|
/** The field upon which the collection is sorted */
|
|
@@ -3292,6 +3382,13 @@ export interface ItemTypeUpdateSchema {
|
|
|
3292
3382
|
data: WorkflowData | null;
|
|
3293
3383
|
};
|
|
3294
3384
|
};
|
|
3385
|
+
meta?: {
|
|
3386
|
+
/**
|
|
3387
|
+
* If this model is single-instance, this tells the single-instance record
|
|
3388
|
+
* has already been created or not
|
|
3389
|
+
*/
|
|
3390
|
+
has_singleton_item?: boolean;
|
|
3391
|
+
};
|
|
3295
3392
|
};
|
|
3296
3393
|
}
|
|
3297
3394
|
|
|
@@ -3506,148 +3603,150 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3506
3603
|
* }
|
|
3507
3604
|
* ```
|
|
3508
3605
|
*
|
|
3509
|
-
* ### Available field types<details
|
|
3606
|
+
* ### Available field types<details>
|
|
3607
|
+
* <summary>Single-line string (<code>string</code>)</summary>
|
|
3510
3608
|
*
|
|
3511
3609
|
* | Property | Value |
|
|
3512
|
-
* | ------------------------------ | ---------------------------------------------------- |
|
|
3610
|
+
* | ------------------------------ | ---------------------------------------------------- |
|
|
3513
3611
|
* | Code | `string` |
|
|
3514
3612
|
* | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
|
|
3515
|
-
* | Available validators | `required`, `unique`, `length`, `format`, `enum`
|
|
3516
|
-
*
|
|
3517
|
-
* | Property | Value |
|
|
3613
|
+
* | Available validators | `required`, `unique`, `length`, `format`, `enum` |</details><details>
|
|
3614
|
+
* <summary>Multi-line text (<code>text</code>)</summary>
|
|
3518
3615
|
*
|
|
3519
|
-
* |
|
|
3520
|
-
* |
|
|
3616
|
+
* | Property | Value |
|
|
3617
|
+
* | ------------------------------ | --------------------------------- |
|
|
3618
|
+
* | Code | `text` |
|
|
3521
3619
|
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
|
|
3522
|
-
* | Available validators
|
|
3620
|
+
* | Available validators | `required`, `length`, `format` |</details><details>
|
|
3621
|
+
* <summary>Boolean (<code>boolean</code>)</summary>
|
|
3523
3622
|
*
|
|
3524
|
-
* | Property
|
|
3525
|
-
*
|
|
3526
|
-
* |
|
|
3527
|
-
* | Code | `boolean` |
|
|
3623
|
+
* | Property | Value |
|
|
3624
|
+
* | ------------------------------ | -------------------------------- |
|
|
3625
|
+
* | Code | `boolean` |
|
|
3528
3626
|
* | Built-in editors for the field | `boolean`, `boolean_radio_group` |
|
|
3529
|
-
* | Available validators
|
|
3530
|
-
*
|
|
3531
|
-
*
|
|
3532
|
-
*
|
|
3533
|
-
* | ------------------------------ | -------------------------- |
|
|
3534
|
-
* | Code
|
|
3535
|
-
* | Built-in editors for the field | `integer`
|
|
3536
|
-
* | Available validators
|
|
3537
|
-
*
|
|
3538
|
-
*
|
|
3539
|
-
*
|
|
3540
|
-
* | ------------------------------ | -------------------------- |
|
|
3541
|
-
* | Code
|
|
3542
|
-
* | Built-in editors for the field | `float`
|
|
3543
|
-
* | Available validators
|
|
3544
|
-
*
|
|
3545
|
-
*
|
|
3546
|
-
*
|
|
3547
|
-
* | ------------------------------ | ------------------------ |
|
|
3548
|
-
* | Code
|
|
3549
|
-
* | Built-in editors for the field | `date_picker`
|
|
3550
|
-
* | Available validators
|
|
3551
|
-
*
|
|
3552
|
-
*
|
|
3553
|
-
*
|
|
3554
|
-
* | ------------------------------ | ----------------------------- |
|
|
3555
|
-
* | Code
|
|
3556
|
-
* | Built-in editors for the field | `date_time_picker`
|
|
3557
|
-
* | Available validators
|
|
3558
|
-
*
|
|
3559
|
-
*
|
|
3560
|
-
*
|
|
3561
|
-
* | ------------------------------ | -------------- |
|
|
3562
|
-
* | Code
|
|
3627
|
+
* | Available validators | no validators available |</details><details>
|
|
3628
|
+
* <summary>Integer (<code>integer</code>)</summary>
|
|
3629
|
+
*
|
|
3630
|
+
* | Property | Value |
|
|
3631
|
+
* | ------------------------------ | -------------------------- |
|
|
3632
|
+
* | Code | `integer` |
|
|
3633
|
+
* | Built-in editors for the field | `integer` |
|
|
3634
|
+
* | Available validators | `required`, `number_range` |</details><details>
|
|
3635
|
+
* <summary>Float (<code>float</code>)</summary>
|
|
3636
|
+
*
|
|
3637
|
+
* | Property | Value |
|
|
3638
|
+
* | ------------------------------ | -------------------------- |
|
|
3639
|
+
* | Code | `float` |
|
|
3640
|
+
* | Built-in editors for the field | `float` |
|
|
3641
|
+
* | Available validators | `required`, `number_range` |</details><details>
|
|
3642
|
+
* <summary>Date (<code>date</code>)</summary>
|
|
3643
|
+
*
|
|
3644
|
+
* | Property | Value |
|
|
3645
|
+
* | ------------------------------ | ------------------------ |
|
|
3646
|
+
* | Code | `date` |
|
|
3647
|
+
* | Built-in editors for the field | `date_picker` |
|
|
3648
|
+
* | Available validators | `required`, `date_range` |</details><details>
|
|
3649
|
+
* <summary>Date time (<code>date_time</code>)</summary>
|
|
3650
|
+
*
|
|
3651
|
+
* | Property | Value |
|
|
3652
|
+
* | ------------------------------ | ----------------------------- |
|
|
3653
|
+
* | Code | `date_time` |
|
|
3654
|
+
* | Built-in editors for the field | `date_time_picker` |
|
|
3655
|
+
* | Available validators | `required`, `date_time_range` |</details><details>
|
|
3656
|
+
* <summary>Color (<code>color</code>)</summary>
|
|
3657
|
+
*
|
|
3658
|
+
* | Property | Value |
|
|
3659
|
+
* | ------------------------------ | -------------- |
|
|
3660
|
+
* | Code | `color` |
|
|
3563
3661
|
* | Built-in editors for the field | `color_picker` |
|
|
3564
|
-
* | Available validators
|
|
3565
|
-
*
|
|
3566
|
-
* | Property | Value |
|
|
3662
|
+
* | Available validators | `required` |</details><details>
|
|
3663
|
+
* <summary>JSON (<code>json</code>)</summary>
|
|
3567
3664
|
*
|
|
3568
|
-
* |
|
|
3569
|
-
* |
|
|
3665
|
+
* | Property | Value |
|
|
3666
|
+
* | ------------------------------ | ------------------------------------------------------ |
|
|
3667
|
+
* | Code | `json` |
|
|
3570
3668
|
* | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
|
|
3571
|
-
* | Available validators
|
|
3572
|
-
*
|
|
3573
|
-
*
|
|
3574
|
-
*
|
|
3575
|
-
* | ------------------------------ | ---------- |
|
|
3576
|
-
* | Code
|
|
3577
|
-
* | Built-in editors for the field | `map`
|
|
3578
|
-
* | Available validators
|
|
3579
|
-
*
|
|
3580
|
-
*
|
|
3581
|
-
*
|
|
3582
|
-
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
3583
|
-
* | Code
|
|
3584
|
-
* | Built-in editors for the field | `seo`
|
|
3585
|
-
* | Available validators
|
|
3586
|
-
*
|
|
3587
|
-
*
|
|
3588
|
-
*
|
|
3589
|
-
* | ------------------------------ | ----------------------------------- |
|
|
3590
|
-
* | Code
|
|
3591
|
-
* | Built-in editors for the field | `slug`
|
|
3592
|
-
* | Required validators
|
|
3593
|
-
* | Other validators available
|
|
3594
|
-
*
|
|
3595
|
-
*
|
|
3596
|
-
*
|
|
3597
|
-
* | ------------------------------ | ---------- |
|
|
3598
|
-
* | Code
|
|
3599
|
-
* | Built-in editors for the field | `video`
|
|
3600
|
-
* | Available validators
|
|
3601
|
-
*
|
|
3602
|
-
*
|
|
3603
|
-
*
|
|
3604
|
-
* | ------------------------------ | ------------------------------------------------------------------------------ |
|
|
3605
|
-
* | Code
|
|
3606
|
-
* | Built-in editors for the field | `file`
|
|
3607
|
-
* | Available validators
|
|
3608
|
-
*
|
|
3609
|
-
*
|
|
3610
|
-
*
|
|
3611
|
-
* | ------------------------------ | -------------------------------------------------------------------------- |
|
|
3612
|
-
* | Code
|
|
3613
|
-
* | Built-in editors for the field | `gallery`
|
|
3614
|
-
* | Available validators
|
|
3615
|
-
*
|
|
3616
|
-
*
|
|
3617
|
-
*
|
|
3618
|
-
* | ------------------------------ | --------------------------- |
|
|
3619
|
-
* | Code
|
|
3669
|
+
* | Available validators | `required` |</details><details>
|
|
3670
|
+
* <summary>Location (<code>lat_lon</code>)</summary>
|
|
3671
|
+
*
|
|
3672
|
+
* | Property | Value |
|
|
3673
|
+
* | ------------------------------ | ---------- |
|
|
3674
|
+
* | Code | `lat_lon` |
|
|
3675
|
+
* | Built-in editors for the field | `map` |
|
|
3676
|
+
* | Available validators | `required` |</details><details>
|
|
3677
|
+
* <summary>SEO (<code>seo</code>)</summary>
|
|
3678
|
+
*
|
|
3679
|
+
* | Property | Value |
|
|
3680
|
+
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
3681
|
+
* | Code | `seo` |
|
|
3682
|
+
* | Built-in editors for the field | `seo` |
|
|
3683
|
+
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |</details><details>
|
|
3684
|
+
* <summary>Slug (<code>slug</code>)</summary>
|
|
3685
|
+
*
|
|
3686
|
+
* | Property | Value |
|
|
3687
|
+
* | ------------------------------ | ----------------------------------- |
|
|
3688
|
+
* | Code | `slug` |
|
|
3689
|
+
* | Built-in editors for the field | `slug` |
|
|
3690
|
+
* | Required validators | `slug_title_field` |
|
|
3691
|
+
* | Other validators available | `required`, `length`, `slug_format` |</details><details>
|
|
3692
|
+
* <summary>External video (<code>video</code>)</summary>
|
|
3693
|
+
*
|
|
3694
|
+
* | Property | Value |
|
|
3695
|
+
* | ------------------------------ | ---------- |
|
|
3696
|
+
* | Code | `video` |
|
|
3697
|
+
* | Built-in editors for the field | `video` |
|
|
3698
|
+
* | Available validators | `required` |</details><details>
|
|
3699
|
+
* <summary>Single-asset (<code>file</code>)</summary>
|
|
3700
|
+
*
|
|
3701
|
+
* | Property | Value |
|
|
3702
|
+
* | ------------------------------ | ------------------------------------------------------------------------------ |
|
|
3703
|
+
* | Code | `file` |
|
|
3704
|
+
* | Built-in editors for the field | `file` |
|
|
3705
|
+
* | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |</details><details>
|
|
3706
|
+
* <summary>Asset gallery (<code>gallery</code>)</summary>
|
|
3707
|
+
*
|
|
3708
|
+
* | Property | Value |
|
|
3709
|
+
* | ------------------------------ | -------------------------------------------------------------------------- |
|
|
3710
|
+
* | Code | `gallery` |
|
|
3711
|
+
* | Built-in editors for the field | `gallery` |
|
|
3712
|
+
* | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |</details><details>
|
|
3713
|
+
* <summary>Single link (<code>link</code>)</summary>
|
|
3714
|
+
*
|
|
3715
|
+
* | Property | Value |
|
|
3716
|
+
* | ------------------------------ | --------------------------- |
|
|
3717
|
+
* | Code | `link` |
|
|
3620
3718
|
* | Built-in editors for the field | `link_select`, `link_embed` |
|
|
3621
|
-
* | Default `editor`
|
|
3622
|
-
* | Required validators
|
|
3623
|
-
* | Other validators available
|
|
3624
|
-
*
|
|
3625
|
-
*
|
|
3626
|
-
*
|
|
3627
|
-
* | ------------------------------ | ----------------------------- |
|
|
3628
|
-
* | Code
|
|
3719
|
+
* | Default `editor` | `link_select` |
|
|
3720
|
+
* | Required validators | `item_item_type` |
|
|
3721
|
+
* | Other validators available | `required`, `unique` |</details><details>
|
|
3722
|
+
* <summary>Multiple links (<code>links</code>)</summary>
|
|
3723
|
+
*
|
|
3724
|
+
* | Property | Value |
|
|
3725
|
+
* | ------------------------------ | ----------------------------- |
|
|
3726
|
+
* | Code | `links` |
|
|
3629
3727
|
* | Built-in editors for the field | `links_select`, `links_embed` |
|
|
3630
|
-
* | Default `editor`
|
|
3631
|
-
* | Required validators
|
|
3632
|
-
* | Other validators available
|
|
3633
|
-
*
|
|
3634
|
-
*
|
|
3635
|
-
*
|
|
3636
|
-
* | ------------------------------ | ------------------ |
|
|
3637
|
-
* | Code
|
|
3638
|
-
* | Built-in editors for the field | `rich_text`
|
|
3639
|
-
* | Required validators
|
|
3640
|
-
* | Other validators available
|
|
3641
|
-
*
|
|
3642
|
-
*
|
|
3643
|
-
*
|
|
3644
|
-
* | ------------------------------ | ------------------------------------------------- |
|
|
3645
|
-
* | Code
|
|
3646
|
-
* | Built-in editors for the field | `structured_text`
|
|
3647
|
-
* | Required validators
|
|
3648
|
-
* | Other validators available
|
|
3649
|
-
*
|
|
3650
|
-
* ### Validators<details
|
|
3728
|
+
* | Default `editor` | `links_select` |
|
|
3729
|
+
* | Required validators | `items_item_type` |
|
|
3730
|
+
* | Other validators available | `size` |</details><details>
|
|
3731
|
+
* <summary>Modular content (<code>rich_text</code>)</summary>
|
|
3732
|
+
*
|
|
3733
|
+
* | Property | Value |
|
|
3734
|
+
* | ------------------------------ | ------------------ |
|
|
3735
|
+
* | Code | `rich_text` |
|
|
3736
|
+
* | Built-in editors for the field | `rich_text` |
|
|
3737
|
+
* | Required validators | `rich_text_blocks` |
|
|
3738
|
+
* | Other validators available | `size` |</details><details>
|
|
3739
|
+
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
3740
|
+
*
|
|
3741
|
+
* | Property | Value |
|
|
3742
|
+
* | ------------------------------ | ------------------------------------------------- |
|
|
3743
|
+
* | Code | `structured_text` |
|
|
3744
|
+
* | Built-in editors for the field | `structured_text` |
|
|
3745
|
+
* | Required validators | `structured_text_blocks`, `structured_text_links` |
|
|
3746
|
+
* | Other validators available | `length` |</details>
|
|
3747
|
+
*
|
|
3748
|
+
* ### Validators<details>
|
|
3749
|
+
* <summary><code>date_range</code></summary>
|
|
3651
3750
|
*
|
|
3652
3751
|
* Accept dates only inside a specified date range.
|
|
3653
3752
|
*
|
|
@@ -3656,8 +3755,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3656
3755
|
* | `min` | ISO 8601 date | | Minimum date |
|
|
3657
3756
|
* | `max` | ISO 8601 date | | Maximum date |
|
|
3658
3757
|
*
|
|
3659
|
-
* At least one of the parameters must be
|
|
3660
|
-
*
|
|
3758
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3759
|
+
* <summary><code>date_time_range</code></summary>
|
|
3661
3760
|
*
|
|
3662
3761
|
* Accept date times only inside a specified date range.
|
|
3663
3762
|
*
|
|
@@ -3666,14 +3765,15 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3666
3765
|
* | `min` | ISO 8601 datetime | | Minimum datetime |
|
|
3667
3766
|
* | `max` | ISO 8601 datetime | | Maximum datetime |
|
|
3668
3767
|
*
|
|
3669
|
-
* At least one of the parameters must be
|
|
3670
|
-
*
|
|
3768
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3769
|
+
* <summary><code>enum</code></summary>
|
|
3671
3770
|
*
|
|
3672
3771
|
* Only accept a specific set of values
|
|
3673
3772
|
*
|
|
3674
3773
|
* | Parameter | Type | Required | Description |
|
|
3675
|
-
* | --------- | --------------- | -------- | --------------------- |
|
|
3676
|
-
* | `values` | `Array<String>` | ✅ | Set of allowed values
|
|
3774
|
+
* | --------- | --------------- | -------- | --------------------- |
|
|
3775
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |</details><details>
|
|
3776
|
+
* <summary><code>extension</code></summary>
|
|
3677
3777
|
*
|
|
3678
3778
|
* Only accept assets with specific file extensions.
|
|
3679
3779
|
*
|
|
@@ -3682,8 +3782,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3682
3782
|
* | `extensions` | `Array<String>` | | Set of allowed file extensions |
|
|
3683
3783
|
* | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` | | Allowed file type |
|
|
3684
3784
|
*
|
|
3685
|
-
* Only one of the parameters must be
|
|
3686
|
-
*
|
|
3785
|
+
* Only one of the parameters must be specified.</details><details>
|
|
3786
|
+
* <summary><code>file_size</code></summary>
|
|
3687
3787
|
*
|
|
3688
3788
|
* Accept assets only inside a specified date range.
|
|
3689
3789
|
*
|
|
@@ -3694,8 +3794,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3694
3794
|
* | `max_value` | `Integer` | | Numeric value for maximum filesize |
|
|
3695
3795
|
* | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
|
|
3696
3796
|
*
|
|
3697
|
-
* At least one couple of value/unit must be
|
|
3698
|
-
*
|
|
3797
|
+
* At least one couple of value/unit must be specified.</details><details>
|
|
3798
|
+
* <summary><code>format</code></summary>
|
|
3699
3799
|
*
|
|
3700
3800
|
* Only accept strings having a specific format.
|
|
3701
3801
|
*
|
|
@@ -3704,8 +3804,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3704
3804
|
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
3705
3805
|
* | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
|
|
3706
3806
|
*
|
|
3707
|
-
* Only one of the parameters must be
|
|
3708
|
-
*
|
|
3807
|
+
* Only one of the parameters must be specified.</details><details>
|
|
3808
|
+
* <summary><code>slug_format</code></summary>
|
|
3709
3809
|
*
|
|
3710
3810
|
* Only accept slugs having a specific format.
|
|
3711
3811
|
*
|
|
@@ -3714,8 +3814,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3714
3814
|
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
3715
3815
|
* | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
|
|
3716
3816
|
*
|
|
3717
|
-
* Only one of the parameters must be
|
|
3718
|
-
*
|
|
3817
|
+
* Only one of the parameters must be specified.</details><details>
|
|
3818
|
+
* <summary><code>image_dimensions</code></summary>
|
|
3719
3819
|
*
|
|
3720
3820
|
* Accept assets only within a specified height/width range.
|
|
3721
3821
|
*
|
|
@@ -3726,8 +3826,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3726
3826
|
* | `height_min_value` | `Integer` | | Numeric value for minimum width |
|
|
3727
3827
|
* | `height_max_value` | `Integer` | | Numeric value for maximum height |
|
|
3728
3828
|
*
|
|
3729
|
-
* At least one parameter must be
|
|
3730
|
-
*
|
|
3829
|
+
* At least one parameter must be specified.</details><details>
|
|
3830
|
+
* <summary><code>item_item_type</code></summary>
|
|
3731
3831
|
*
|
|
3732
3832
|
* Only accept references to records of the specified models.
|
|
3733
3833
|
*
|
|
@@ -3754,8 +3854,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3754
3854
|
*
|
|
3755
3855
|
* - `"fail"`: Fail the operation and notify the user
|
|
3756
3856
|
* - `"delete_references"`: Try to remove the reference to the deleted record (if
|
|
3757
|
-
* the field has a `required` validation it will
|
|
3758
|
-
*
|
|
3857
|
+
* the field has a `required` validation it will fail)</details><details>
|
|
3858
|
+
* <summary><code>items_item_type</code></summary>
|
|
3759
3859
|
*
|
|
3760
3860
|
* Only accept references to records of the specified models.
|
|
3761
3861
|
*
|
|
@@ -3782,8 +3882,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3782
3882
|
*
|
|
3783
3883
|
* - `"fail"`: Fail the operation and notify the user
|
|
3784
3884
|
* - `"delete_references"`: Try to remove the reference to the deleted record (if
|
|
3785
|
-
* the field has a `required` validation it will
|
|
3786
|
-
*
|
|
3885
|
+
* the field has a `required` validation it will fail)</details><details>
|
|
3886
|
+
* <summary><code>length</code></summary>
|
|
3787
3887
|
*
|
|
3788
3888
|
* Accept strings only with a specified number of characters.
|
|
3789
3889
|
*
|
|
@@ -3793,8 +3893,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3793
3893
|
* | `eq` | `Integer` | | Expected length |
|
|
3794
3894
|
* | `max` | `Integer` | | Maximum length |
|
|
3795
3895
|
*
|
|
3796
|
-
* At least one parameter must be
|
|
3797
|
-
*
|
|
3896
|
+
* At least one parameter must be specified.</details><details>
|
|
3897
|
+
* <summary><code>number_range</code></summary>
|
|
3798
3898
|
*
|
|
3799
3899
|
* Accept numbers only inside a specified range.
|
|
3800
3900
|
*
|
|
@@ -3803,11 +3903,11 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3803
3903
|
* | `min` | `Float` | | Minimum value |
|
|
3804
3904
|
* | `max` | `Float` | | Maximum value |
|
|
3805
3905
|
*
|
|
3806
|
-
* At least one of the parameters must be
|
|
3807
|
-
*
|
|
3906
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3907
|
+
* <summary><code>required</code></summary>
|
|
3808
3908
|
*
|
|
3809
|
-
* Value must be specified or it won't be
|
|
3810
|
-
*
|
|
3909
|
+
* Value must be specified or it won't be valid.</details><details>
|
|
3910
|
+
* <summary><code>required_alt_title</code></summary>
|
|
3811
3911
|
*
|
|
3812
3912
|
* Assets contained in the field are required to specify custom title or
|
|
3813
3913
|
* alternate text, or they won't be valid.
|
|
@@ -3817,8 +3917,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3817
3917
|
* | `title` | `Boolean` | | Whether the title for the asset must be specified |
|
|
3818
3918
|
* | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
|
|
3819
3919
|
*
|
|
3820
|
-
* At least one of the parameters must be
|
|
3821
|
-
*
|
|
3920
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3921
|
+
* <summary><code>required_seo_fields</code></summary>
|
|
3822
3922
|
*
|
|
3823
3923
|
* SEO field is to specify one or more properties, or it won't be valid.
|
|
3824
3924
|
*
|
|
@@ -3829,8 +3929,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3829
3929
|
* | `image` | `Boolean` | | Whether the social sharing image must be specified |
|
|
3830
3930
|
* | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
|
|
3831
3931
|
*
|
|
3832
|
-
* At least one of the parameters must be
|
|
3833
|
-
*
|
|
3932
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3933
|
+
* <summary><code>title_length</code></summary>
|
|
3834
3934
|
*
|
|
3835
3935
|
* Limits the length of the title for a SEO field. Search engines usually
|
|
3836
3936
|
* truncate title tags to 60 character so it is a good practice to keep the
|
|
@@ -3841,8 +3941,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3841
3941
|
* | `min` | `Integer` | | Minimum value |
|
|
3842
3942
|
* | `max` | `Integer` | | Maximum value |
|
|
3843
3943
|
*
|
|
3844
|
-
* At least one of the parameters must be
|
|
3845
|
-
*
|
|
3944
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3945
|
+
* <summary><code>description_length</code></summary>
|
|
3846
3946
|
*
|
|
3847
3947
|
* Limits the length of the description for a SEO field. Search engines usually
|
|
3848
3948
|
* truncate description tags to 160 character so it is a good practice to keep
|
|
@@ -3853,20 +3953,22 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3853
3953
|
* | `min` | `Integer` | | Minimum value |
|
|
3854
3954
|
* | `max` | `Integer` | | Maximum value |
|
|
3855
3955
|
*
|
|
3856
|
-
* At least one of the parameters must be
|
|
3857
|
-
*
|
|
3956
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3957
|
+
* <summary><code>rich_text_blocks</code></summary>
|
|
3858
3958
|
*
|
|
3859
3959
|
* Only accept references to block records of the specified block models.
|
|
3860
3960
|
*
|
|
3861
3961
|
* | Parameter | Type | Required | Description |
|
|
3862
|
-
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3863
|
-
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs
|
|
3962
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3963
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |</details><details>
|
|
3964
|
+
* <summary><code>structured_text_blocks</code></summary>
|
|
3864
3965
|
*
|
|
3865
3966
|
* Only accept references to block records of the specified block models.
|
|
3866
3967
|
*
|
|
3867
3968
|
* | Parameter | Type | Required | Description |
|
|
3868
|
-
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3869
|
-
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs
|
|
3969
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3970
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |</details><details>
|
|
3971
|
+
* <summary><code>structured_text_links</code></summary>
|
|
3870
3972
|
*
|
|
3871
3973
|
* Only accept `itemLink` to `inlineItem` nodes for records of the specified
|
|
3872
3974
|
* models.
|
|
@@ -3894,8 +3996,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3894
3996
|
*
|
|
3895
3997
|
* - `"fail"`: Fail the operation and notify the user
|
|
3896
3998
|
* - `"delete_references"`: Try to remove the reference to the deleted record (if
|
|
3897
|
-
* the field has a `required` validation it will
|
|
3898
|
-
*
|
|
3999
|
+
* the field has a `required` validation it will fail)</details><details>
|
|
4000
|
+
* <summary><code>size</code></summary>
|
|
3899
4001
|
*
|
|
3900
4002
|
* Only accept a number of items within the specified range.
|
|
3901
4003
|
*
|
|
@@ -3906,108 +4008,122 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3906
4008
|
* | `max` | `Integer` | | Maximum length |
|
|
3907
4009
|
* | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
|
|
3908
4010
|
*
|
|
3909
|
-
* At least one parameter must be
|
|
3910
|
-
*
|
|
4011
|
+
* At least one parameter must be specified.</details><details>
|
|
4012
|
+
* <summary><code>slug_title_field</code></summary>
|
|
3911
4013
|
*
|
|
3912
4014
|
* Specifies the ID of the _Single-line string_ field that will be used to
|
|
3913
4015
|
* generate the slug
|
|
3914
4016
|
*
|
|
3915
4017
|
* | Parameter | Type | Required | Description |
|
|
3916
|
-
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
3917
|
-
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug
|
|
4018
|
+
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
4019
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |</details><details>
|
|
4020
|
+
* <summary><code>unique</code></summary>
|
|
3918
4021
|
*
|
|
3919
4022
|
* The value must be unique across the whole collection of records.</details>
|
|
3920
4023
|
*
|
|
3921
4024
|
* ### Configuration parameters for DatoCMS built-in field editors
|
|
3922
4025
|
*
|
|
3923
4026
|
* If a field editor is not specified in this table, just pass an empty object
|
|
3924
|
-
* `{}` as its configuration
|
|
3925
|
-
*
|
|
4027
|
+
* `{}` as its configuration parameters.<details>
|
|
4028
|
+
* <summary><code>boolean_radio_group</code></summary>
|
|
3926
4029
|
*
|
|
3927
4030
|
* Radio group input for _boolean_ fields.
|
|
3928
4031
|
*
|
|
3929
4032
|
* | Parameter | Type | Required | Description |
|
|
3930
|
-
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
4033
|
+
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
3931
4034
|
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
3932
|
-
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`)
|
|
4035
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |</details><details>
|
|
4036
|
+
* <summary><code>string_radio_group</code></summary>
|
|
3933
4037
|
*
|
|
3934
4038
|
* Radio group input for _string_ fields.
|
|
3935
4039
|
*
|
|
3936
4040
|
* | Parameter | Type | Required | Description |
|
|
3937
|
-
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
3938
|
-
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options
|
|
4041
|
+
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
4042
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |</details><details>
|
|
4043
|
+
* <summary><code>string_select</code></summary>
|
|
3939
4044
|
*
|
|
3940
4045
|
* Select input for _string_ fields.
|
|
3941
4046
|
*
|
|
3942
4047
|
* | Parameter | Type | Required | Description |
|
|
3943
|
-
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3944
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options
|
|
4048
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4049
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |</details><details>
|
|
4050
|
+
* <summary><code>string_multi_select</code></summary>
|
|
3945
4051
|
*
|
|
3946
4052
|
* Select input for _JSON_ fields, to edit an array of strings.
|
|
3947
4053
|
*
|
|
3948
4054
|
* | Parameter | Type | Required | Description |
|
|
3949
|
-
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3950
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options
|
|
4055
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4056
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |</details><details>
|
|
4057
|
+
* <summary><code>string_checkbox_group</code></summary>
|
|
3951
4058
|
*
|
|
3952
4059
|
* Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
|
|
3953
4060
|
*
|
|
3954
4061
|
* | Parameter | Type | Required | Description |
|
|
3955
|
-
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3956
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options
|
|
4062
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
4063
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |</details><details>
|
|
4064
|
+
* <summary><code>single_line</code></summary>
|
|
3957
4065
|
*
|
|
3958
4066
|
* Simple textual input for _Single-line string_ fields.
|
|
3959
4067
|
*
|
|
3960
4068
|
* | Parameter | Type | Required | Description |
|
|
3961
|
-
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
3962
|
-
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading
|
|
4069
|
+
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
4070
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |</details><details>
|
|
4071
|
+
* <summary><code>markdown</code></summary>
|
|
3963
4072
|
*
|
|
3964
4073
|
* Markdown editor for _Multiple-paragraph text_ fields.
|
|
3965
4074
|
*
|
|
3966
4075
|
* | Parameter | Type | Required | Description |
|
|
3967
|
-
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3968
|
-
* | `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"`
|
|
4076
|
+
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4077
|
+
* | `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"` |</details><details>
|
|
4078
|
+
* <summary><code>wysiwyg</code></summary>
|
|
3969
4079
|
*
|
|
3970
4080
|
* HTML editor for _Multiple-paragraph text_ fields.
|
|
3971
4081
|
*
|
|
3972
4082
|
* | Parameter | Type | Required | Description |
|
|
3973
|
-
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3974
|
-
* | `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"`
|
|
4083
|
+
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4084
|
+
* | `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"` |</details><details>
|
|
4085
|
+
* <summary><code>textarea</code></summary>
|
|
3975
4086
|
*
|
|
3976
|
-
* Basic textarea editor for _Multiple-paragraph text_
|
|
3977
|
-
*
|
|
4087
|
+
* Basic textarea editor for _Multiple-paragraph text_ fields.</details><details>
|
|
4088
|
+
* <summary><code>color_picker</code></summary>
|
|
3978
4089
|
*
|
|
3979
4090
|
* Built-in editor for _Color_ fields.
|
|
3980
4091
|
*
|
|
3981
4092
|
* | Parameter | Type | Required | Description |
|
|
3982
|
-
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
4093
|
+
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
3983
4094
|
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
3984
|
-
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user
|
|
4095
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |</details><details>
|
|
4096
|
+
* <summary><code>slug</code></summary>
|
|
3985
4097
|
*
|
|
3986
4098
|
* Built-in editor for _Slug_ fields.
|
|
3987
4099
|
*
|
|
3988
4100
|
* | Parameter | Type | Required | Description |
|
|
3989
|
-
* | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
|
|
3990
|
-
* | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors.
|
|
4101
|
+
* | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
|
|
4102
|
+
* | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. |</details><details>
|
|
4103
|
+
* <summary><code>rich_text</code></summary>
|
|
3991
4104
|
*
|
|
3992
4105
|
* Built-in editor for _Modular content_ fields.
|
|
3993
4106
|
*
|
|
3994
4107
|
* | Parameter | Type | Required | Description |
|
|
3995
|
-
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
3996
|
-
* | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not
|
|
4108
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
4109
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not |</details><details>
|
|
4110
|
+
* <summary><code>structured_text</code></summary>
|
|
3997
4111
|
*
|
|
3998
4112
|
* Built-in editor for _Structured text_ fields.
|
|
3999
4113
|
*
|
|
4000
|
-
* | Parameter | Type
|
|
4001
|
-
* | ------------------------- |
|
|
4002
|
-
* | `nodes` | `Array<String>`
|
|
4003
|
-
* | `marks` | `Array<String>`
|
|
4004
|
-
* | `
|
|
4005
|
-
* | `
|
|
4006
|
-
* | `
|
|
4114
|
+
* | Parameter | Type | Required | Description |
|
|
4115
|
+
* | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4116
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
4117
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
4118
|
+
* | `heading_levels` | `Array<Integer>` | ✅ | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6 |
|
|
4119
|
+
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
4120
|
+
* | `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 |
|
|
4121
|
+
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |</details><details>
|
|
4122
|
+
* <summary><code>link_select</code> and <code>links_select</code></summary>
|
|
4007
4123
|
*
|
|
4008
4124
|
* Use a select input with auto-completion to pick the records to reference
|
|
4009
|
-
* inside the field.</details><details
|
|
4010
|
-
* <code>links_embed</code></summary>
|
|
4125
|
+
* inside the field.</details><details>
|
|
4126
|
+
* <summary><code>link_embed</code> and <code>links_embed</code></summary>
|
|
4011
4127
|
*
|
|
4012
4128
|
* Use an expanded view with records' image preview to pick the records to
|
|
4013
4129
|
* reference inside the field.</details>
|
|
@@ -4032,7 +4148,26 @@ export interface FieldAttributes {
|
|
|
4032
4148
|
/** The label of the field */
|
|
4033
4149
|
label: string;
|
|
4034
4150
|
/** Type of input */
|
|
4035
|
-
field_type:
|
|
4151
|
+
field_type:
|
|
4152
|
+
| 'string'
|
|
4153
|
+
| 'text'
|
|
4154
|
+
| 'boolean'
|
|
4155
|
+
| 'integer'
|
|
4156
|
+
| 'float'
|
|
4157
|
+
| 'date'
|
|
4158
|
+
| 'date_time'
|
|
4159
|
+
| 'color'
|
|
4160
|
+
| 'json'
|
|
4161
|
+
| 'lat_lon'
|
|
4162
|
+
| 'seo'
|
|
4163
|
+
| 'slug'
|
|
4164
|
+
| 'video'
|
|
4165
|
+
| 'file'
|
|
4166
|
+
| 'gallery'
|
|
4167
|
+
| 'link'
|
|
4168
|
+
| 'links'
|
|
4169
|
+
| 'rich_text'
|
|
4170
|
+
| 'structured_text';
|
|
4036
4171
|
/** Whether the field needs to be multilanguage or not */
|
|
4037
4172
|
localized: boolean;
|
|
4038
4173
|
/**
|
|
@@ -4056,7 +4191,7 @@ export interface FieldAttributes {
|
|
|
4056
4191
|
[k: string]: unknown;
|
|
4057
4192
|
};
|
|
4058
4193
|
/** Field appearance */
|
|
4059
|
-
appeareance
|
|
4194
|
+
appeareance?: {
|
|
4060
4195
|
editor: string;
|
|
4061
4196
|
parameters: {
|
|
4062
4197
|
[k: string]: unknown;
|
|
@@ -4128,7 +4263,26 @@ export interface FieldCreateSchema {
|
|
|
4128
4263
|
/** The label of the field */
|
|
4129
4264
|
label: string;
|
|
4130
4265
|
/** Type of input */
|
|
4131
|
-
field_type:
|
|
4266
|
+
field_type:
|
|
4267
|
+
| 'string'
|
|
4268
|
+
| 'text'
|
|
4269
|
+
| 'boolean'
|
|
4270
|
+
| 'integer'
|
|
4271
|
+
| 'float'
|
|
4272
|
+
| 'date'
|
|
4273
|
+
| 'date_time'
|
|
4274
|
+
| 'color'
|
|
4275
|
+
| 'json'
|
|
4276
|
+
| 'lat_lon'
|
|
4277
|
+
| 'seo'
|
|
4278
|
+
| 'slug'
|
|
4279
|
+
| 'video'
|
|
4280
|
+
| 'file'
|
|
4281
|
+
| 'gallery'
|
|
4282
|
+
| 'link'
|
|
4283
|
+
| 'links'
|
|
4284
|
+
| 'rich_text'
|
|
4285
|
+
| 'structured_text';
|
|
4132
4286
|
/** Field API key */
|
|
4133
4287
|
api_key: string;
|
|
4134
4288
|
/** Whether the field needs to be multilanguage or not */
|
|
@@ -4295,7 +4449,26 @@ export interface FieldUpdateSchema {
|
|
|
4295
4449
|
/** Ordering index */
|
|
4296
4450
|
position?: number;
|
|
4297
4451
|
/** Type of input */
|
|
4298
|
-
field_type?:
|
|
4452
|
+
field_type?:
|
|
4453
|
+
| 'string'
|
|
4454
|
+
| 'text'
|
|
4455
|
+
| 'boolean'
|
|
4456
|
+
| 'integer'
|
|
4457
|
+
| 'float'
|
|
4458
|
+
| 'date'
|
|
4459
|
+
| 'date_time'
|
|
4460
|
+
| 'color'
|
|
4461
|
+
| 'json'
|
|
4462
|
+
| 'lat_lon'
|
|
4463
|
+
| 'seo'
|
|
4464
|
+
| 'slug'
|
|
4465
|
+
| 'video'
|
|
4466
|
+
| 'file'
|
|
4467
|
+
| 'gallery'
|
|
4468
|
+
| 'link'
|
|
4469
|
+
| 'links'
|
|
4470
|
+
| 'rich_text'
|
|
4471
|
+
| 'structured_text';
|
|
4299
4472
|
/** Field hint */
|
|
4300
4473
|
hint?: string | null;
|
|
4301
4474
|
};
|
|
@@ -4473,6 +4646,7 @@ export interface FieldsetCreateSchema {
|
|
|
4473
4646
|
*/
|
|
4474
4647
|
export interface FieldsetCreateTargetSchema {
|
|
4475
4648
|
data: Fieldset;
|
|
4649
|
+
included?: ItemType[];
|
|
4476
4650
|
}
|
|
4477
4651
|
|
|
4478
4652
|
/**
|
|
@@ -5150,6 +5324,10 @@ export interface ItemMeta {
|
|
|
5150
5324
|
status: null | ('draft' | 'updated' | 'published');
|
|
5151
5325
|
/** Whether the current record is valid or not */
|
|
5152
5326
|
is_valid: boolean;
|
|
5327
|
+
/** Whether the current version of the record is valid or not */
|
|
5328
|
+
is_current_version_valid: null | boolean;
|
|
5329
|
+
/** Whether the published version of record is valid or not */
|
|
5330
|
+
is_published_version_valid: null | boolean;
|
|
5153
5331
|
/** The ID of the current record version */
|
|
5154
5332
|
current_version: string;
|
|
5155
5333
|
/** Workflow stage in which the item is */
|
|
@@ -5243,6 +5421,10 @@ export interface ItemCreateSchema {
|
|
|
5243
5421
|
status?: null | ('draft' | 'updated' | 'published');
|
|
5244
5422
|
/** Whether the current record is valid or not */
|
|
5245
5423
|
is_valid?: boolean;
|
|
5424
|
+
/** Whether the current version of the record is valid or not */
|
|
5425
|
+
is_current_version_valid?: null | boolean;
|
|
5426
|
+
/** Whether the published version of the record is valid or not */
|
|
5427
|
+
is_published_version_valid?: null | boolean;
|
|
5246
5428
|
/** The ID of the current record version */
|
|
5247
5429
|
current_version?: string;
|
|
5248
5430
|
};
|
|
@@ -5316,6 +5498,10 @@ export interface ItemUpdateSchema {
|
|
|
5316
5498
|
* example)
|
|
5317
5499
|
*/
|
|
5318
5500
|
current_version?: string;
|
|
5501
|
+
/** Whether the current version of the record is valid or not */
|
|
5502
|
+
is_current_version_valid?: null | boolean;
|
|
5503
|
+
/** Whether the published version of record is valid or not */
|
|
5504
|
+
is_published_version_valid?: null | boolean;
|
|
5319
5505
|
/** The new stage to move the record to */
|
|
5320
5506
|
stage?: string | null;
|
|
5321
5507
|
};
|
|
@@ -6046,7 +6232,7 @@ export interface UploadBatchAddTagsSchema {
|
|
|
6046
6232
|
type: UploadType;
|
|
6047
6233
|
attributes: {
|
|
6048
6234
|
/** Tags */
|
|
6049
|
-
tags
|
|
6235
|
+
tags: string[];
|
|
6050
6236
|
};
|
|
6051
6237
|
};
|
|
6052
6238
|
}
|
|
@@ -6400,13 +6586,13 @@ export interface SearchResult {
|
|
|
6400
6586
|
* `definition` "attributes".
|
|
6401
6587
|
*/
|
|
6402
6588
|
export interface SearchResultAttributes {
|
|
6403
|
-
/**
|
|
6589
|
+
/** Title of the page */
|
|
6404
6590
|
title: string;
|
|
6405
|
-
/** First
|
|
6591
|
+
/** First 200 characters of page body, unformatted */
|
|
6406
6592
|
body_excerpt: string;
|
|
6407
6593
|
/** URL */
|
|
6408
6594
|
url: string;
|
|
6409
|
-
/**
|
|
6595
|
+
/** Search score */
|
|
6410
6596
|
score: number;
|
|
6411
6597
|
highlight: {
|
|
6412
6598
|
title?: string[] | null;
|
|
@@ -6431,7 +6617,7 @@ export interface SearchResultData {
|
|
|
6431
6617
|
*/
|
|
6432
6618
|
export interface SearchResultInstancesTargetSchema {
|
|
6433
6619
|
data: SearchResult[];
|
|
6434
|
-
meta
|
|
6620
|
+
meta: {
|
|
6435
6621
|
total_count: number;
|
|
6436
6622
|
};
|
|
6437
6623
|
}
|
|
@@ -7056,10 +7242,54 @@ export interface ItemTypeFilter {
|
|
|
7056
7242
|
export interface ItemTypeFilterAttributes {
|
|
7057
7243
|
/** The name of the filter */
|
|
7058
7244
|
name: string;
|
|
7059
|
-
/**
|
|
7245
|
+
/**
|
|
7246
|
+
* The actual filter. It follows the form of the `filter` query parameter of
|
|
7247
|
+
* the [List all
|
|
7248
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
7249
|
+
* endpoint.
|
|
7250
|
+
*/
|
|
7060
7251
|
filter: {
|
|
7061
7252
|
[k: string]: unknown;
|
|
7062
7253
|
};
|
|
7254
|
+
/** The columns to show with this filter */
|
|
7255
|
+
columns:
|
|
7256
|
+
| [
|
|
7257
|
+
{
|
|
7258
|
+
/**
|
|
7259
|
+
* Can be either the API key of a model's field, or one of the
|
|
7260
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
7261
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
7262
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
7263
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
7264
|
+
* models), `_stage (only for models associated with a workflow).
|
|
7265
|
+
*/
|
|
7266
|
+
name: string;
|
|
7267
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
7268
|
+
width: number;
|
|
7269
|
+
},
|
|
7270
|
+
...{
|
|
7271
|
+
/**
|
|
7272
|
+
* Can be either the API key of a model's field, or one of the
|
|
7273
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
7274
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
7275
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
7276
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
7277
|
+
* models), `_stage (only for models associated with a workflow).
|
|
7278
|
+
*/
|
|
7279
|
+
name: string;
|
|
7280
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
7281
|
+
width: number;
|
|
7282
|
+
}[],
|
|
7283
|
+
]
|
|
7284
|
+
| null;
|
|
7285
|
+
/**
|
|
7286
|
+
* The ordering to apply with this filter, or `null` for the default model
|
|
7287
|
+
* ordering. It follows the form of the `order_by` query parameter of the
|
|
7288
|
+
* [List all
|
|
7289
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
7290
|
+
* endpoint.
|
|
7291
|
+
*/
|
|
7292
|
+
order_by: string | null;
|
|
7063
7293
|
/** Whether it's a shared filter or not */
|
|
7064
7294
|
shared: boolean;
|
|
7065
7295
|
}
|
|
@@ -7077,17 +7307,6 @@ export interface ItemTypeFilterRelationships {
|
|
|
7077
7307
|
};
|
|
7078
7308
|
}
|
|
7079
7309
|
|
|
7080
|
-
/**
|
|
7081
|
-
* JSON API data
|
|
7082
|
-
*
|
|
7083
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
7084
|
-
* `definition` "data".
|
|
7085
|
-
*/
|
|
7086
|
-
export interface ItemTypeFilterData {
|
|
7087
|
-
type: ItemTypeFilterType;
|
|
7088
|
-
id: ItemTypeFilterIdentity;
|
|
7089
|
-
}
|
|
7090
|
-
|
|
7091
7310
|
/**
|
|
7092
7311
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
7093
7312
|
* `create.schema` link.
|
|
@@ -7098,12 +7317,56 @@ export interface ItemTypeFilterCreateSchema {
|
|
|
7098
7317
|
attributes: {
|
|
7099
7318
|
/** The name of the filter */
|
|
7100
7319
|
name: string;
|
|
7101
|
-
/**
|
|
7102
|
-
|
|
7320
|
+
/**
|
|
7321
|
+
* The actual filter. It follows the form of the `filter` query parameter
|
|
7322
|
+
* of the [List all
|
|
7323
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
7324
|
+
* endpoint.
|
|
7325
|
+
*/
|
|
7326
|
+
filter?: {
|
|
7103
7327
|
[k: string]: unknown;
|
|
7104
7328
|
};
|
|
7329
|
+
/** The columns to show with this filter */
|
|
7330
|
+
columns?:
|
|
7331
|
+
| [
|
|
7332
|
+
{
|
|
7333
|
+
/**
|
|
7334
|
+
* Can be either the API key of a model's field, or one of the
|
|
7335
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
7336
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
7337
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
7338
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
7339
|
+
* models), `_stage (only for models associated with a workflow).
|
|
7340
|
+
*/
|
|
7341
|
+
name: string;
|
|
7342
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
7343
|
+
width: number;
|
|
7344
|
+
},
|
|
7345
|
+
...{
|
|
7346
|
+
/**
|
|
7347
|
+
* Can be either the API key of a model's field, or one of the
|
|
7348
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
7349
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
7350
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
7351
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
7352
|
+
* models), `_stage (only for models associated with a workflow).
|
|
7353
|
+
*/
|
|
7354
|
+
name: string;
|
|
7355
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
7356
|
+
width: number;
|
|
7357
|
+
}[],
|
|
7358
|
+
]
|
|
7359
|
+
| null;
|
|
7360
|
+
/**
|
|
7361
|
+
* The ordering to apply with this filter, or `null` for the default model
|
|
7362
|
+
* ordering. It follows the form of the `order_by` query parameter of the
|
|
7363
|
+
* [List all
|
|
7364
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
7365
|
+
* endpoint.
|
|
7366
|
+
*/
|
|
7367
|
+
order_by?: string | null;
|
|
7105
7368
|
/** Whether it's a shared filter or not */
|
|
7106
|
-
shared
|
|
7369
|
+
shared?: boolean;
|
|
7107
7370
|
};
|
|
7108
7371
|
relationships: {
|
|
7109
7372
|
/** Model associated with the filter */
|
|
@@ -7133,14 +7396,64 @@ export interface ItemTypeFilterUpdateSchema {
|
|
|
7133
7396
|
/** JSON API attributes */
|
|
7134
7397
|
attributes: {
|
|
7135
7398
|
/** The name of the filter */
|
|
7136
|
-
name
|
|
7399
|
+
name?: string;
|
|
7400
|
+
/** The columns to show with this filter */
|
|
7401
|
+
columns?:
|
|
7402
|
+
| [
|
|
7403
|
+
{
|
|
7404
|
+
/**
|
|
7405
|
+
* Can be either the API key of a model's field, or one of the
|
|
7406
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
7407
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
7408
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
7409
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
7410
|
+
* models), `_stage (only for models associated with a workflow).
|
|
7411
|
+
*/
|
|
7412
|
+
name: string;
|
|
7413
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
7414
|
+
width: number;
|
|
7415
|
+
},
|
|
7416
|
+
...{
|
|
7417
|
+
/**
|
|
7418
|
+
* Can be either the API key of a model's field, or one of the
|
|
7419
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
7420
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
7421
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
7422
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
7423
|
+
* models), `_stage (only for models associated with a workflow).
|
|
7424
|
+
*/
|
|
7425
|
+
name: string;
|
|
7426
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
7427
|
+
width: number;
|
|
7428
|
+
}[],
|
|
7429
|
+
]
|
|
7430
|
+
| null;
|
|
7431
|
+
/**
|
|
7432
|
+
* The ordering to apply with this filter, or `null` for the default model
|
|
7433
|
+
* ordering. It follows the form of the `order_by` query parameter of the
|
|
7434
|
+
* [List all
|
|
7435
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
7436
|
+
* endpoint.
|
|
7437
|
+
*/
|
|
7438
|
+
order_by?: string | null;
|
|
7137
7439
|
/** Whether it's a shared filter or not */
|
|
7138
7440
|
shared?: boolean;
|
|
7139
|
-
/**
|
|
7140
|
-
|
|
7441
|
+
/**
|
|
7442
|
+
* The actual filter. It follows the form of the `filter` query parameter
|
|
7443
|
+
* of the [List all
|
|
7444
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
7445
|
+
* endpoint.
|
|
7446
|
+
*/
|
|
7447
|
+
filter?: {
|
|
7141
7448
|
[k: string]: unknown;
|
|
7142
7449
|
};
|
|
7143
7450
|
};
|
|
7451
|
+
relationships?: {
|
|
7452
|
+
/** Model associated with the filter */
|
|
7453
|
+
item_type: {
|
|
7454
|
+
data: ItemTypeData;
|
|
7455
|
+
};
|
|
7456
|
+
};
|
|
7144
7457
|
};
|
|
7145
7458
|
}
|
|
7146
7459
|
|
|
@@ -7324,6 +7637,8 @@ export interface SiteInvitation {
|
|
|
7324
7637
|
export interface SiteInvitationAttributes {
|
|
7325
7638
|
/** Email */
|
|
7326
7639
|
email: string;
|
|
7640
|
+
/** Whether this invitation has expired */
|
|
7641
|
+
expired: boolean;
|
|
7327
7642
|
}
|
|
7328
7643
|
|
|
7329
7644
|
/**
|
|
@@ -7681,6 +7996,8 @@ export interface SsoSettings {
|
|
|
7681
7996
|
export interface SsoSettingsAttributes {
|
|
7682
7997
|
/** URL of Identity Provider SAML Metadata endpoint */
|
|
7683
7998
|
idp_saml_metadata_url: null | string;
|
|
7999
|
+
/** Identity Provider SAML Metadata */
|
|
8000
|
+
idp_saml_metadata_xml?: null | string;
|
|
7684
8001
|
/** DatoCMS SCIM base URL */
|
|
7685
8002
|
scim_base_url: string;
|
|
7686
8003
|
/** DatoCMS SAML ACS URL */
|
|
@@ -7754,9 +8071,11 @@ export interface SsoSettingsUpdateSchema {
|
|
|
7754
8071
|
id?: SsoSettingsIdentity;
|
|
7755
8072
|
attributes?: {
|
|
7756
8073
|
/** URL of Identity Provider SAML Metadata endpoint */
|
|
7757
|
-
idp_saml_metadata_url
|
|
8074
|
+
idp_saml_metadata_url?: null | string;
|
|
8075
|
+
/** Identity Provider SAML Metadata */
|
|
8076
|
+
idp_saml_metadata_xml?: null | string;
|
|
7758
8077
|
};
|
|
7759
|
-
relationships
|
|
8078
|
+
relationships?: {
|
|
7760
8079
|
/**
|
|
7761
8080
|
* The default role assigned to SSO users that do not belong to any SSO
|
|
7762
8081
|
* group
|
|
@@ -7988,7 +8307,7 @@ export interface DailyUsageData {
|
|
|
7988
8307
|
* `instances.targetSchema` link.
|
|
7989
8308
|
*/
|
|
7990
8309
|
export interface DailyUsageInstancesTargetSchema {
|
|
7991
|
-
data: DailyUsage;
|
|
8310
|
+
data: DailyUsage[];
|
|
7992
8311
|
}
|
|
7993
8312
|
|
|
7994
8313
|
/**
|
|
@@ -8457,6 +8776,8 @@ export interface Workflow {
|
|
|
8457
8776
|
export interface WorkflowAttributes {
|
|
8458
8777
|
/** The name of the workflow */
|
|
8459
8778
|
name: string;
|
|
8779
|
+
/** Workflow API key */
|
|
8780
|
+
api_key: string;
|
|
8460
8781
|
/** The stages of the workflow */
|
|
8461
8782
|
stages: [
|
|
8462
8783
|
{
|
|
@@ -8489,11 +8810,12 @@ export interface WorkflowAttributes {
|
|
|
8489
8810
|
export interface WorkflowCreateSchema {
|
|
8490
8811
|
data: {
|
|
8491
8812
|
type: WorkflowType;
|
|
8492
|
-
id: WorkflowIdentity;
|
|
8493
8813
|
/** JSON API attributes */
|
|
8494
8814
|
attributes: {
|
|
8495
8815
|
/** The name of the workflow */
|
|
8496
8816
|
name: string;
|
|
8817
|
+
/** Workflow API key */
|
|
8818
|
+
api_key: string;
|
|
8497
8819
|
/** The stages of the workflow */
|
|
8498
8820
|
stages: [
|
|
8499
8821
|
{
|
|
@@ -8541,6 +8863,8 @@ export interface WorkflowUpdateSchema {
|
|
|
8541
8863
|
attributes?: {
|
|
8542
8864
|
/** The name of the workflow */
|
|
8543
8865
|
name?: string;
|
|
8866
|
+
/** Workflow API key */
|
|
8867
|
+
api_key?: string;
|
|
8544
8868
|
/** The stages of the workflow */
|
|
8545
8869
|
stages?: [
|
|
8546
8870
|
{
|