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
|
@@ -281,6 +281,23 @@ export declare type MenuItemIdentity = string;
|
|
|
281
281
|
* `definition` "type".
|
|
282
282
|
*/
|
|
283
283
|
export declare type ItemTypeType = 'item_type';
|
|
284
|
+
/**
|
|
285
|
+
* JSON API type field
|
|
286
|
+
*
|
|
287
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
288
|
+
* `definition` "type".
|
|
289
|
+
*/
|
|
290
|
+
export declare type ItemTypeFilterType = 'item_type_filter';
|
|
291
|
+
/**
|
|
292
|
+
* ID of filter
|
|
293
|
+
*
|
|
294
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
295
|
+
* `definition` "identity".
|
|
296
|
+
*
|
|
297
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
298
|
+
* `definition` "id".
|
|
299
|
+
*/
|
|
300
|
+
export declare type ItemTypeFilterIdentity = string;
|
|
284
301
|
/**
|
|
285
302
|
* This interface was referenced by `MenuItem`'s JSON-Schema via the
|
|
286
303
|
* `instances.hrefSchema` link.
|
|
@@ -349,6 +366,15 @@ export declare type FieldsetIdentity = string;
|
|
|
349
366
|
* `definition` "type".
|
|
350
367
|
*/
|
|
351
368
|
export declare type WorkflowType = 'workflow';
|
|
369
|
+
/**
|
|
370
|
+
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
371
|
+
* `create.hrefSchema` link.
|
|
372
|
+
*/
|
|
373
|
+
export declare type ItemTypeCreateHrefSchema = {
|
|
374
|
+
/** Skip the creation of a menu item linked to the model */
|
|
375
|
+
skip_menu_item_creation?: string;
|
|
376
|
+
[k: string]: unknown;
|
|
377
|
+
};
|
|
352
378
|
/**
|
|
353
379
|
* JSON API type field
|
|
354
380
|
*
|
|
@@ -366,6 +392,15 @@ export declare type JobType = 'job';
|
|
|
366
392
|
* "id".
|
|
367
393
|
*/
|
|
368
394
|
export declare type JobIdentity = string;
|
|
395
|
+
/**
|
|
396
|
+
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
397
|
+
* `destroy.hrefSchema` link.
|
|
398
|
+
*/
|
|
399
|
+
export declare type ItemTypeDestroyHrefSchema = {
|
|
400
|
+
/** Skip the deletion of the menu items linked to the model */
|
|
401
|
+
skip_menu_items_deletion?: string;
|
|
402
|
+
[k: string]: unknown;
|
|
403
|
+
};
|
|
369
404
|
/**
|
|
370
405
|
* JSON API type field
|
|
371
406
|
*
|
|
@@ -529,10 +564,14 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
529
564
|
[k: string]: unknown;
|
|
530
565
|
};
|
|
531
566
|
/**
|
|
532
|
-
* Fields used to order results. You
|
|
567
|
+
* Fields used to order results. You **must** specify also `filter[type]` with
|
|
533
568
|
* one element only to be able use this option. Format:
|
|
534
|
-
* `<field_name>_
|
|
535
|
-
*
|
|
569
|
+
* `<field_name>_(ASC|DESC)`, where `<field_name>` can be either the API key
|
|
570
|
+
* of a model's field, or one of the following meta columns: `id`,
|
|
571
|
+
* `_updated_at`, `_created_at`, `_status`, `_published_at`,
|
|
572
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
573
|
+
* `_unpublishing_scheduled_at`, `_is_valid`, `position` (only for sortable
|
|
574
|
+
* models). You can pass multiple comma separated rules.
|
|
536
575
|
*/
|
|
537
576
|
order_by?: string;
|
|
538
577
|
/**
|
|
@@ -828,16 +867,32 @@ export declare type SearchResultIdentity = string;
|
|
|
828
867
|
* `instances.hrefSchema` link.
|
|
829
868
|
*/
|
|
830
869
|
export declare type SearchResultInstancesHrefSchema = {
|
|
831
|
-
/**
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
|
|
836
|
-
|
|
837
|
-
|
|
838
|
-
|
|
839
|
-
/**
|
|
840
|
-
|
|
870
|
+
/** Attributes to manage results pagination */
|
|
871
|
+
page?: {
|
|
872
|
+
/** Index of first element to fetch (defaults to 0) */
|
|
873
|
+
offset?: number;
|
|
874
|
+
/** Number of elements to fetch (defaults to 20, maximum is 100) */
|
|
875
|
+
limit?: number;
|
|
876
|
+
[k: string]: unknown;
|
|
877
|
+
};
|
|
878
|
+
/** Attributes to filter search results */
|
|
879
|
+
filter: {
|
|
880
|
+
/**
|
|
881
|
+
* When any value is passed, it enables the fuzzy search: the Levenshtein
|
|
882
|
+
* Edit Distance is used to match more results.
|
|
883
|
+
*/
|
|
884
|
+
fuzzy?: string;
|
|
885
|
+
/** Text to search */
|
|
886
|
+
query: string;
|
|
887
|
+
/**
|
|
888
|
+
* The build trigger ID on which the search will be performed. Required if
|
|
889
|
+
* more than one build trigger is present in a project
|
|
890
|
+
*/
|
|
891
|
+
build_trigger_id?: string;
|
|
892
|
+
/** Restrict the search on pages in a specific locale */
|
|
893
|
+
locale?: string;
|
|
894
|
+
[k: string]: unknown;
|
|
895
|
+
};
|
|
841
896
|
[k: string]: unknown;
|
|
842
897
|
};
|
|
843
898
|
/**
|
|
@@ -922,23 +977,6 @@ export declare type WebhookCallInstancesHrefSchema = {
|
|
|
922
977
|
};
|
|
923
978
|
[k: string]: unknown;
|
|
924
979
|
};
|
|
925
|
-
/**
|
|
926
|
-
* JSON API type field
|
|
927
|
-
*
|
|
928
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
929
|
-
* `definition` "type".
|
|
930
|
-
*/
|
|
931
|
-
export declare type ItemTypeFilterType = 'item_type_filter';
|
|
932
|
-
/**
|
|
933
|
-
* ID of filter
|
|
934
|
-
*
|
|
935
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
936
|
-
* `definition` "identity".
|
|
937
|
-
*
|
|
938
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
939
|
-
* `definition` "id".
|
|
940
|
-
*/
|
|
941
|
-
export declare type ItemTypeFilterIdentity = string;
|
|
942
980
|
/**
|
|
943
981
|
* JSON API type field
|
|
944
982
|
*
|
|
@@ -2607,7 +2645,7 @@ export interface MenuItemAttributes {
|
|
|
2607
2645
|
external_url: null | string;
|
|
2608
2646
|
/** Ordering index */
|
|
2609
2647
|
position: number;
|
|
2610
|
-
/** Opens link in new tab (used together with `external_url`) */
|
|
2648
|
+
/** Opens link in new tab (to be used together with `external_url`) */
|
|
2611
2649
|
open_in_new_tab: boolean;
|
|
2612
2650
|
}
|
|
2613
2651
|
/**
|
|
@@ -2621,6 +2659,13 @@ export interface MenuItemRelationships {
|
|
|
2621
2659
|
item_type: {
|
|
2622
2660
|
data: ItemTypeData | null;
|
|
2623
2661
|
};
|
|
2662
|
+
/**
|
|
2663
|
+
* Item type filter associated with the menu item (to be used together with
|
|
2664
|
+
* `item_type` relationship)
|
|
2665
|
+
*/
|
|
2666
|
+
item_type_filter: {
|
|
2667
|
+
data: ItemTypeFilterData | null;
|
|
2668
|
+
};
|
|
2624
2669
|
/** Parent menu item */
|
|
2625
2670
|
parent: {
|
|
2626
2671
|
data: null | MenuItemData;
|
|
@@ -2640,6 +2685,16 @@ export interface ItemTypeData {
|
|
|
2640
2685
|
type: ItemTypeType;
|
|
2641
2686
|
id: ItemTypeIdentity;
|
|
2642
2687
|
}
|
|
2688
|
+
/**
|
|
2689
|
+
* JSON API data
|
|
2690
|
+
*
|
|
2691
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
2692
|
+
* `definition` "data".
|
|
2693
|
+
*/
|
|
2694
|
+
export interface ItemTypeFilterData {
|
|
2695
|
+
type: ItemTypeFilterType;
|
|
2696
|
+
id: ItemTypeFilterIdentity;
|
|
2697
|
+
}
|
|
2643
2698
|
/**
|
|
2644
2699
|
* JSON API data
|
|
2645
2700
|
*
|
|
@@ -2664,8 +2719,8 @@ export interface MenuItemCreateSchema {
|
|
|
2664
2719
|
/** The URL to which the menu item points to */
|
|
2665
2720
|
external_url?: null | string;
|
|
2666
2721
|
/** Ordering index */
|
|
2667
|
-
position
|
|
2668
|
-
/** Opens link in new tab (used together with `external_url`) */
|
|
2722
|
+
position?: number;
|
|
2723
|
+
/** Opens link in new tab (to be used together with `external_url`) */
|
|
2669
2724
|
open_in_new_tab?: boolean;
|
|
2670
2725
|
};
|
|
2671
2726
|
relationships?: {
|
|
@@ -2673,6 +2728,13 @@ export interface MenuItemCreateSchema {
|
|
|
2673
2728
|
item_type?: {
|
|
2674
2729
|
data: ItemTypeData | null;
|
|
2675
2730
|
};
|
|
2731
|
+
/**
|
|
2732
|
+
* Item type filter associated with the menu item (to be used together
|
|
2733
|
+
* with `item_type` relationship)
|
|
2734
|
+
*/
|
|
2735
|
+
item_type_filter?: {
|
|
2736
|
+
data: ItemTypeFilterData | null;
|
|
2737
|
+
};
|
|
2676
2738
|
/** Parent menu item */
|
|
2677
2739
|
parent?: {
|
|
2678
2740
|
data: null | MenuItemData;
|
|
@@ -2698,12 +2760,12 @@ export interface MenuItemUpdateSchema {
|
|
|
2698
2760
|
/** JSON API attributes */
|
|
2699
2761
|
attributes?: {
|
|
2700
2762
|
/** The label of the menu item */
|
|
2701
|
-
label
|
|
2763
|
+
label?: string;
|
|
2702
2764
|
/** The URL to which the menu item points to */
|
|
2703
2765
|
external_url?: null | string;
|
|
2704
2766
|
/** Ordering index */
|
|
2705
|
-
position
|
|
2706
|
-
/** Opens link in new tab (used together with `external_url`) */
|
|
2767
|
+
position?: number;
|
|
2768
|
+
/** Opens link in new tab (to be used together with `external_url`) */
|
|
2707
2769
|
open_in_new_tab?: boolean;
|
|
2708
2770
|
};
|
|
2709
2771
|
relationships?: {
|
|
@@ -2711,6 +2773,13 @@ export interface MenuItemUpdateSchema {
|
|
|
2711
2773
|
item_type?: {
|
|
2712
2774
|
data: ItemTypeData | null;
|
|
2713
2775
|
};
|
|
2776
|
+
/**
|
|
2777
|
+
* Item type filter associated with the menu item (to be used together
|
|
2778
|
+
* with `item_type` relationship)
|
|
2779
|
+
*/
|
|
2780
|
+
item_type_filter?: {
|
|
2781
|
+
data: ItemTypeFilterData | null;
|
|
2782
|
+
};
|
|
2714
2783
|
/** Parent menu item */
|
|
2715
2784
|
parent?: {
|
|
2716
2785
|
data: null | MenuItemData;
|
|
@@ -2760,6 +2829,7 @@ export interface ItemType {
|
|
|
2760
2829
|
id: ItemTypeIdentity;
|
|
2761
2830
|
attributes: ItemTypeAttributes;
|
|
2762
2831
|
relationships: ItemTypeRelationships;
|
|
2832
|
+
meta: ItemTypeMeta;
|
|
2763
2833
|
}
|
|
2764
2834
|
/**
|
|
2765
2835
|
* JSON API attributes
|
|
@@ -2773,7 +2843,7 @@ export interface ItemTypeAttributes {
|
|
|
2773
2843
|
/** API key of the model */
|
|
2774
2844
|
api_key: string;
|
|
2775
2845
|
/** The way the model collection should be presented to the editors */
|
|
2776
|
-
collection_appeareance
|
|
2846
|
+
collection_appeareance?: 'compact' | 'table';
|
|
2777
2847
|
/** The way the model collection should be presented to the editors */
|
|
2778
2848
|
collection_appearance: 'compact' | 'table';
|
|
2779
2849
|
/** Whether the model is single-instance or not */
|
|
@@ -2808,6 +2878,8 @@ export interface ItemTypeAttributes {
|
|
|
2808
2878
|
* model/block
|
|
2809
2879
|
*/
|
|
2810
2880
|
hint: string | null;
|
|
2881
|
+
/** Whether inverse relationships fields are expressed in GraphQL or not */
|
|
2882
|
+
inverse_relationships_enabled: boolean;
|
|
2811
2883
|
}
|
|
2812
2884
|
/**
|
|
2813
2885
|
* JSON API links
|
|
@@ -2889,6 +2961,19 @@ export interface WorkflowData {
|
|
|
2889
2961
|
type: WorkflowType;
|
|
2890
2962
|
id: WorkflowIdentity;
|
|
2891
2963
|
}
|
|
2964
|
+
/**
|
|
2965
|
+
* Meta information regarding the item type
|
|
2966
|
+
*
|
|
2967
|
+
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
2968
|
+
* `definition` "meta".
|
|
2969
|
+
*/
|
|
2970
|
+
export interface ItemTypeMeta {
|
|
2971
|
+
/**
|
|
2972
|
+
* If this model is single-instance, this tells the single-instance record has
|
|
2973
|
+
* already been created or not
|
|
2974
|
+
*/
|
|
2975
|
+
has_singleton_item: boolean;
|
|
2976
|
+
}
|
|
2892
2977
|
/**
|
|
2893
2978
|
* This interface was referenced by `ItemType`'s JSON-Schema via the
|
|
2894
2979
|
* `create.schema` link.
|
|
@@ -2933,6 +3018,8 @@ export interface ItemTypeCreateSchema {
|
|
|
2933
3018
|
* model/block
|
|
2934
3019
|
*/
|
|
2935
3020
|
hint?: string | null;
|
|
3021
|
+
/** Whether inverse relationships fields are expressed in GraphQL or not */
|
|
3022
|
+
inverse_relationships_enabled?: boolean;
|
|
2936
3023
|
};
|
|
2937
3024
|
relationships?: {
|
|
2938
3025
|
/** The field upon which the collection is sorted */
|
|
@@ -3016,6 +3103,8 @@ export interface ItemTypeUpdateSchema {
|
|
|
3016
3103
|
* model/block
|
|
3017
3104
|
*/
|
|
3018
3105
|
hint?: string | null;
|
|
3106
|
+
/** Whether inverse relationships fields are expressed in GraphQL or not */
|
|
3107
|
+
inverse_relationships_enabled?: boolean;
|
|
3019
3108
|
};
|
|
3020
3109
|
relationships?: {
|
|
3021
3110
|
/** The field upon which the collection is sorted */
|
|
@@ -3039,6 +3128,13 @@ export interface ItemTypeUpdateSchema {
|
|
|
3039
3128
|
data: WorkflowData | null;
|
|
3040
3129
|
};
|
|
3041
3130
|
};
|
|
3131
|
+
meta?: {
|
|
3132
|
+
/**
|
|
3133
|
+
* If this model is single-instance, this tells the single-instance record
|
|
3134
|
+
* has already been created or not
|
|
3135
|
+
*/
|
|
3136
|
+
has_singleton_item?: boolean;
|
|
3137
|
+
};
|
|
3042
3138
|
};
|
|
3043
3139
|
}
|
|
3044
3140
|
/**
|
|
@@ -3243,148 +3339,150 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3243
3339
|
* }
|
|
3244
3340
|
* ```
|
|
3245
3341
|
*
|
|
3246
|
-
* ### Available field types<details
|
|
3342
|
+
* ### Available field types<details>
|
|
3343
|
+
* <summary>Single-line string (<code>string</code>)</summary>
|
|
3247
3344
|
*
|
|
3248
3345
|
* | Property | Value |
|
|
3249
|
-
* | ------------------------------ | ---------------------------------------------------- |
|
|
3346
|
+
* | ------------------------------ | ---------------------------------------------------- |
|
|
3250
3347
|
* | Code | `string` |
|
|
3251
3348
|
* | Built-in editors for the field | `single_line`, `string_radio_group`, `string_select` |
|
|
3252
|
-
* | Available validators | `required`, `unique`, `length`, `format`, `enum`
|
|
3253
|
-
*
|
|
3254
|
-
* | Property | Value |
|
|
3349
|
+
* | Available validators | `required`, `unique`, `length`, `format`, `enum` |</details><details>
|
|
3350
|
+
* <summary>Multi-line text (<code>text</code>)</summary>
|
|
3255
3351
|
*
|
|
3256
|
-
* |
|
|
3257
|
-
* |
|
|
3352
|
+
* | Property | Value |
|
|
3353
|
+
* | ------------------------------ | --------------------------------- |
|
|
3354
|
+
* | Code | `text` |
|
|
3258
3355
|
* | Built-in editors for the field | `markdown`, `wysiwyg`, `textarea` |
|
|
3259
|
-
* | Available validators
|
|
3260
|
-
*
|
|
3261
|
-
* | Property | Value |
|
|
3356
|
+
* | Available validators | `required`, `length`, `format` |</details><details>
|
|
3357
|
+
* <summary>Boolean (<code>boolean</code>)</summary>
|
|
3262
3358
|
*
|
|
3263
|
-
* |
|
|
3264
|
-
* |
|
|
3359
|
+
* | Property | Value |
|
|
3360
|
+
* | ------------------------------ | -------------------------------- |
|
|
3361
|
+
* | Code | `boolean` |
|
|
3265
3362
|
* | Built-in editors for the field | `boolean`, `boolean_radio_group` |
|
|
3266
|
-
* | Available validators
|
|
3267
|
-
*
|
|
3268
|
-
*
|
|
3269
|
-
*
|
|
3270
|
-
* | ------------------------------ | -------------------------- |
|
|
3271
|
-
* | Code
|
|
3272
|
-
* | Built-in editors for the field | `integer`
|
|
3273
|
-
* | Available validators
|
|
3274
|
-
*
|
|
3275
|
-
*
|
|
3276
|
-
*
|
|
3277
|
-
* | ------------------------------ | -------------------------- |
|
|
3278
|
-
* | Code
|
|
3279
|
-
* | Built-in editors for the field | `float`
|
|
3280
|
-
* | Available validators
|
|
3281
|
-
*
|
|
3282
|
-
*
|
|
3283
|
-
*
|
|
3284
|
-
* | ------------------------------ | ------------------------ |
|
|
3285
|
-
* | Code
|
|
3286
|
-
* | Built-in editors for the field | `date_picker`
|
|
3287
|
-
* | Available validators
|
|
3288
|
-
*
|
|
3289
|
-
*
|
|
3290
|
-
*
|
|
3291
|
-
* | ------------------------------ | ----------------------------- |
|
|
3292
|
-
* | Code
|
|
3293
|
-
* | Built-in editors for the field | `date_time_picker`
|
|
3294
|
-
* | Available validators
|
|
3295
|
-
*
|
|
3296
|
-
*
|
|
3297
|
-
*
|
|
3298
|
-
* | ------------------------------ | -------------- |
|
|
3299
|
-
* | Code
|
|
3363
|
+
* | Available validators | no validators available |</details><details>
|
|
3364
|
+
* <summary>Integer (<code>integer</code>)</summary>
|
|
3365
|
+
*
|
|
3366
|
+
* | Property | Value |
|
|
3367
|
+
* | ------------------------------ | -------------------------- |
|
|
3368
|
+
* | Code | `integer` |
|
|
3369
|
+
* | Built-in editors for the field | `integer` |
|
|
3370
|
+
* | Available validators | `required`, `number_range` |</details><details>
|
|
3371
|
+
* <summary>Float (<code>float</code>)</summary>
|
|
3372
|
+
*
|
|
3373
|
+
* | Property | Value |
|
|
3374
|
+
* | ------------------------------ | -------------------------- |
|
|
3375
|
+
* | Code | `float` |
|
|
3376
|
+
* | Built-in editors for the field | `float` |
|
|
3377
|
+
* | Available validators | `required`, `number_range` |</details><details>
|
|
3378
|
+
* <summary>Date (<code>date</code>)</summary>
|
|
3379
|
+
*
|
|
3380
|
+
* | Property | Value |
|
|
3381
|
+
* | ------------------------------ | ------------------------ |
|
|
3382
|
+
* | Code | `date` |
|
|
3383
|
+
* | Built-in editors for the field | `date_picker` |
|
|
3384
|
+
* | Available validators | `required`, `date_range` |</details><details>
|
|
3385
|
+
* <summary>Date time (<code>date_time</code>)</summary>
|
|
3386
|
+
*
|
|
3387
|
+
* | Property | Value |
|
|
3388
|
+
* | ------------------------------ | ----------------------------- |
|
|
3389
|
+
* | Code | `date_time` |
|
|
3390
|
+
* | Built-in editors for the field | `date_time_picker` |
|
|
3391
|
+
* | Available validators | `required`, `date_time_range` |</details><details>
|
|
3392
|
+
* <summary>Color (<code>color</code>)</summary>
|
|
3393
|
+
*
|
|
3394
|
+
* | Property | Value |
|
|
3395
|
+
* | ------------------------------ | -------------- |
|
|
3396
|
+
* | Code | `color` |
|
|
3300
3397
|
* | Built-in editors for the field | `color_picker` |
|
|
3301
|
-
* | Available validators
|
|
3398
|
+
* | Available validators | `required` |</details><details>
|
|
3399
|
+
* <summary>JSON (<code>json</code>)</summary>
|
|
3302
3400
|
*
|
|
3303
|
-
* | Property
|
|
3304
|
-
*
|
|
3305
|
-
* |
|
|
3306
|
-
* | Code | `json` |
|
|
3401
|
+
* | Property | Value |
|
|
3402
|
+
* | ------------------------------ | ------------------------------------------------------ |
|
|
3403
|
+
* | Code | `json` |
|
|
3307
3404
|
* | Built-in editors for the field | `json`, `string_multi_select`, `string_checkbox_group` |
|
|
3308
|
-
* | Available validators
|
|
3309
|
-
*
|
|
3310
|
-
*
|
|
3311
|
-
*
|
|
3312
|
-
* | ------------------------------ | ---------- |
|
|
3313
|
-
* | Code
|
|
3314
|
-
* | Built-in editors for the field | `map`
|
|
3315
|
-
* | Available validators
|
|
3316
|
-
*
|
|
3317
|
-
*
|
|
3318
|
-
*
|
|
3319
|
-
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
3320
|
-
* | Code
|
|
3321
|
-
* | Built-in editors for the field | `seo`
|
|
3322
|
-
* | Available validators
|
|
3323
|
-
*
|
|
3324
|
-
*
|
|
3325
|
-
*
|
|
3326
|
-
* | ------------------------------ | ----------------------------------- |
|
|
3327
|
-
* | Code
|
|
3328
|
-
* | Built-in editors for the field | `slug`
|
|
3329
|
-
* | Required validators
|
|
3330
|
-
* | Other validators available
|
|
3331
|
-
*
|
|
3332
|
-
*
|
|
3333
|
-
*
|
|
3334
|
-
* | ------------------------------ | ---------- |
|
|
3335
|
-
* | Code
|
|
3336
|
-
* | Built-in editors for the field | `video`
|
|
3337
|
-
* | Available validators
|
|
3338
|
-
*
|
|
3339
|
-
*
|
|
3340
|
-
*
|
|
3341
|
-
* | ------------------------------ | ------------------------------------------------------------------------------ |
|
|
3342
|
-
* | Code
|
|
3343
|
-
* | Built-in editors for the field | `file`
|
|
3344
|
-
* | Available validators
|
|
3345
|
-
*
|
|
3346
|
-
*
|
|
3347
|
-
*
|
|
3348
|
-
* | ------------------------------ | -------------------------------------------------------------------------- |
|
|
3349
|
-
* | Code
|
|
3350
|
-
* | Built-in editors for the field | `gallery`
|
|
3351
|
-
* | Available validators
|
|
3352
|
-
*
|
|
3353
|
-
*
|
|
3354
|
-
*
|
|
3355
|
-
* | ------------------------------ | --------------------------- |
|
|
3356
|
-
* | Code
|
|
3405
|
+
* | Available validators | `required` |</details><details>
|
|
3406
|
+
* <summary>Location (<code>lat_lon</code>)</summary>
|
|
3407
|
+
*
|
|
3408
|
+
* | Property | Value |
|
|
3409
|
+
* | ------------------------------ | ---------- |
|
|
3410
|
+
* | Code | `lat_lon` |
|
|
3411
|
+
* | Built-in editors for the field | `map` |
|
|
3412
|
+
* | Available validators | `required` |</details><details>
|
|
3413
|
+
* <summary>SEO (<code>seo</code>)</summary>
|
|
3414
|
+
*
|
|
3415
|
+
* | Property | Value |
|
|
3416
|
+
* | ------------------------------ | -------------------------------------------------------------------------------------------- |
|
|
3417
|
+
* | Code | `seo` |
|
|
3418
|
+
* | Built-in editors for the field | `seo` |
|
|
3419
|
+
* | Available validators | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |</details><details>
|
|
3420
|
+
* <summary>Slug (<code>slug</code>)</summary>
|
|
3421
|
+
*
|
|
3422
|
+
* | Property | Value |
|
|
3423
|
+
* | ------------------------------ | ----------------------------------- |
|
|
3424
|
+
* | Code | `slug` |
|
|
3425
|
+
* | Built-in editors for the field | `slug` |
|
|
3426
|
+
* | Required validators | `slug_title_field` |
|
|
3427
|
+
* | Other validators available | `required`, `length`, `slug_format` |</details><details>
|
|
3428
|
+
* <summary>External video (<code>video</code>)</summary>
|
|
3429
|
+
*
|
|
3430
|
+
* | Property | Value |
|
|
3431
|
+
* | ------------------------------ | ---------- |
|
|
3432
|
+
* | Code | `video` |
|
|
3433
|
+
* | Built-in editors for the field | `video` |
|
|
3434
|
+
* | Available validators | `required` |</details><details>
|
|
3435
|
+
* <summary>Single-asset (<code>file</code>)</summary>
|
|
3436
|
+
*
|
|
3437
|
+
* | Property | Value |
|
|
3438
|
+
* | ------------------------------ | ------------------------------------------------------------------------------ |
|
|
3439
|
+
* | Code | `file` |
|
|
3440
|
+
* | Built-in editors for the field | `file` |
|
|
3441
|
+
* | Available validators | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |</details><details>
|
|
3442
|
+
* <summary>Asset gallery (<code>gallery</code>)</summary>
|
|
3443
|
+
*
|
|
3444
|
+
* | Property | Value |
|
|
3445
|
+
* | ------------------------------ | -------------------------------------------------------------------------- |
|
|
3446
|
+
* | Code | `gallery` |
|
|
3447
|
+
* | Built-in editors for the field | `gallery` |
|
|
3448
|
+
* | Available validators | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |</details><details>
|
|
3449
|
+
* <summary>Single link (<code>link</code>)</summary>
|
|
3450
|
+
*
|
|
3451
|
+
* | Property | Value |
|
|
3452
|
+
* | ------------------------------ | --------------------------- |
|
|
3453
|
+
* | Code | `link` |
|
|
3357
3454
|
* | Built-in editors for the field | `link_select`, `link_embed` |
|
|
3358
|
-
* | Default `editor`
|
|
3359
|
-
* | Required validators
|
|
3360
|
-
* | Other validators available
|
|
3361
|
-
*
|
|
3362
|
-
*
|
|
3363
|
-
*
|
|
3364
|
-
* | ------------------------------ | ----------------------------- |
|
|
3365
|
-
* | Code
|
|
3455
|
+
* | Default `editor` | `link_select` |
|
|
3456
|
+
* | Required validators | `item_item_type` |
|
|
3457
|
+
* | Other validators available | `required`, `unique` |</details><details>
|
|
3458
|
+
* <summary>Multiple links (<code>links</code>)</summary>
|
|
3459
|
+
*
|
|
3460
|
+
* | Property | Value |
|
|
3461
|
+
* | ------------------------------ | ----------------------------- |
|
|
3462
|
+
* | Code | `links` |
|
|
3366
3463
|
* | Built-in editors for the field | `links_select`, `links_embed` |
|
|
3367
|
-
* | Default `editor`
|
|
3368
|
-
* | Required validators
|
|
3369
|
-
* | Other validators available
|
|
3370
|
-
*
|
|
3371
|
-
*
|
|
3372
|
-
*
|
|
3373
|
-
* | ------------------------------ | ------------------ |
|
|
3374
|
-
* | Code
|
|
3375
|
-
* | Built-in editors for the field | `rich_text`
|
|
3376
|
-
* | Required validators
|
|
3377
|
-
* | Other validators available
|
|
3378
|
-
*
|
|
3379
|
-
*
|
|
3380
|
-
*
|
|
3381
|
-
* | ------------------------------ | ------------------------------------------------- |
|
|
3382
|
-
* | Code
|
|
3383
|
-
* | Built-in editors for the field | `structured_text`
|
|
3384
|
-
* | Required validators
|
|
3385
|
-
* | Other validators available
|
|
3386
|
-
*
|
|
3387
|
-
* ### Validators<details
|
|
3464
|
+
* | Default `editor` | `links_select` |
|
|
3465
|
+
* | Required validators | `items_item_type` |
|
|
3466
|
+
* | Other validators available | `size` |</details><details>
|
|
3467
|
+
* <summary>Modular content (<code>rich_text</code>)</summary>
|
|
3468
|
+
*
|
|
3469
|
+
* | Property | Value |
|
|
3470
|
+
* | ------------------------------ | ------------------ |
|
|
3471
|
+
* | Code | `rich_text` |
|
|
3472
|
+
* | Built-in editors for the field | `rich_text` |
|
|
3473
|
+
* | Required validators | `rich_text_blocks` |
|
|
3474
|
+
* | Other validators available | `size` |</details><details>
|
|
3475
|
+
* <summary>Structured text (<code>structured_text</code>)</summary>
|
|
3476
|
+
*
|
|
3477
|
+
* | Property | Value |
|
|
3478
|
+
* | ------------------------------ | ------------------------------------------------- |
|
|
3479
|
+
* | Code | `structured_text` |
|
|
3480
|
+
* | Built-in editors for the field | `structured_text` |
|
|
3481
|
+
* | Required validators | `structured_text_blocks`, `structured_text_links` |
|
|
3482
|
+
* | Other validators available | `length` |</details>
|
|
3483
|
+
*
|
|
3484
|
+
* ### Validators<details>
|
|
3485
|
+
* <summary><code>date_range</code></summary>
|
|
3388
3486
|
*
|
|
3389
3487
|
* Accept dates only inside a specified date range.
|
|
3390
3488
|
*
|
|
@@ -3393,8 +3491,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3393
3491
|
* | `min` | ISO 8601 date | | Minimum date |
|
|
3394
3492
|
* | `max` | ISO 8601 date | | Maximum date |
|
|
3395
3493
|
*
|
|
3396
|
-
* At least one of the parameters must be
|
|
3397
|
-
*
|
|
3494
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3495
|
+
* <summary><code>date_time_range</code></summary>
|
|
3398
3496
|
*
|
|
3399
3497
|
* Accept date times only inside a specified date range.
|
|
3400
3498
|
*
|
|
@@ -3403,14 +3501,15 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3403
3501
|
* | `min` | ISO 8601 datetime | | Minimum datetime |
|
|
3404
3502
|
* | `max` | ISO 8601 datetime | | Maximum datetime |
|
|
3405
3503
|
*
|
|
3406
|
-
* At least one of the parameters must be
|
|
3407
|
-
*
|
|
3504
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3505
|
+
* <summary><code>enum</code></summary>
|
|
3408
3506
|
*
|
|
3409
3507
|
* Only accept a specific set of values
|
|
3410
3508
|
*
|
|
3411
3509
|
* | Parameter | Type | Required | Description |
|
|
3412
|
-
* | --------- | --------------- | -------- | --------------------- |
|
|
3413
|
-
* | `values` | `Array<String>` | ✅ | Set of allowed values
|
|
3510
|
+
* | --------- | --------------- | -------- | --------------------- |
|
|
3511
|
+
* | `values` | `Array<String>` | ✅ | Set of allowed values |</details><details>
|
|
3512
|
+
* <summary><code>extension</code></summary>
|
|
3414
3513
|
*
|
|
3415
3514
|
* Only accept assets with specific file extensions.
|
|
3416
3515
|
*
|
|
@@ -3419,8 +3518,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3419
3518
|
* | `extensions` | `Array<String>` | | Set of allowed file extensions |
|
|
3420
3519
|
* | `predefined_list` | one of `"image"`, `"transformable_image"`, `"video"`, `"document"` | | Allowed file type |
|
|
3421
3520
|
*
|
|
3422
|
-
* Only one of the parameters must be
|
|
3423
|
-
*
|
|
3521
|
+
* Only one of the parameters must be specified.</details><details>
|
|
3522
|
+
* <summary><code>file_size</code></summary>
|
|
3424
3523
|
*
|
|
3425
3524
|
* Accept assets only inside a specified date range.
|
|
3426
3525
|
*
|
|
@@ -3431,8 +3530,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3431
3530
|
* | `max_value` | `Integer` | | Numeric value for maximum filesize |
|
|
3432
3531
|
* | `max_unit` | one of `"B"`, `"KB"`, `"MB"` | | Unit for maximum filesize |
|
|
3433
3532
|
*
|
|
3434
|
-
* At least one couple of value/unit must be
|
|
3435
|
-
*
|
|
3533
|
+
* At least one couple of value/unit must be specified.</details><details>
|
|
3534
|
+
* <summary><code>format</code></summary>
|
|
3436
3535
|
*
|
|
3437
3536
|
* Only accept strings having a specific format.
|
|
3438
3537
|
*
|
|
@@ -3441,8 +3540,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3441
3540
|
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
3442
3541
|
* | `predefined_pattern` | one of `"email"`, `"url"` | | Allowed format |
|
|
3443
3542
|
*
|
|
3444
|
-
* Only one of the parameters must be
|
|
3445
|
-
*
|
|
3543
|
+
* Only one of the parameters must be specified.</details><details>
|
|
3544
|
+
* <summary><code>slug_format</code></summary>
|
|
3446
3545
|
*
|
|
3447
3546
|
* Only accept slugs having a specific format.
|
|
3448
3547
|
*
|
|
@@ -3451,8 +3550,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3451
3550
|
* | `custom_pattern` | `Regexp` | | Regular expression to be validated |
|
|
3452
3551
|
* | `predefined_pattern` | `"webpage_slug"` | | Allowed format |
|
|
3453
3552
|
*
|
|
3454
|
-
* Only one of the parameters must be
|
|
3455
|
-
*
|
|
3553
|
+
* Only one of the parameters must be specified.</details><details>
|
|
3554
|
+
* <summary><code>image_dimensions</code></summary>
|
|
3456
3555
|
*
|
|
3457
3556
|
* Accept assets only within a specified height/width range.
|
|
3458
3557
|
*
|
|
@@ -3463,8 +3562,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3463
3562
|
* | `height_min_value` | `Integer` | | Numeric value for minimum width |
|
|
3464
3563
|
* | `height_max_value` | `Integer` | | Numeric value for maximum height |
|
|
3465
3564
|
*
|
|
3466
|
-
* At least one parameter must be
|
|
3467
|
-
*
|
|
3565
|
+
* At least one parameter must be specified.</details><details>
|
|
3566
|
+
* <summary><code>item_item_type</code></summary>
|
|
3468
3567
|
*
|
|
3469
3568
|
* Only accept references to records of the specified models.
|
|
3470
3569
|
*
|
|
@@ -3491,8 +3590,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3491
3590
|
*
|
|
3492
3591
|
* - `"fail"`: Fail the operation and notify the user
|
|
3493
3592
|
* - `"delete_references"`: Try to remove the reference to the deleted record (if
|
|
3494
|
-
* the field has a `required` validation it will
|
|
3495
|
-
*
|
|
3593
|
+
* the field has a `required` validation it will fail)</details><details>
|
|
3594
|
+
* <summary><code>items_item_type</code></summary>
|
|
3496
3595
|
*
|
|
3497
3596
|
* Only accept references to records of the specified models.
|
|
3498
3597
|
*
|
|
@@ -3519,8 +3618,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3519
3618
|
*
|
|
3520
3619
|
* - `"fail"`: Fail the operation and notify the user
|
|
3521
3620
|
* - `"delete_references"`: Try to remove the reference to the deleted record (if
|
|
3522
|
-
* the field has a `required` validation it will
|
|
3523
|
-
*
|
|
3621
|
+
* the field has a `required` validation it will fail)</details><details>
|
|
3622
|
+
* <summary><code>length</code></summary>
|
|
3524
3623
|
*
|
|
3525
3624
|
* Accept strings only with a specified number of characters.
|
|
3526
3625
|
*
|
|
@@ -3530,8 +3629,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3530
3629
|
* | `eq` | `Integer` | | Expected length |
|
|
3531
3630
|
* | `max` | `Integer` | | Maximum length |
|
|
3532
3631
|
*
|
|
3533
|
-
* At least one parameter must be
|
|
3534
|
-
*
|
|
3632
|
+
* At least one parameter must be specified.</details><details>
|
|
3633
|
+
* <summary><code>number_range</code></summary>
|
|
3535
3634
|
*
|
|
3536
3635
|
* Accept numbers only inside a specified range.
|
|
3537
3636
|
*
|
|
@@ -3540,11 +3639,11 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3540
3639
|
* | `min` | `Float` | | Minimum value |
|
|
3541
3640
|
* | `max` | `Float` | | Maximum value |
|
|
3542
3641
|
*
|
|
3543
|
-
* At least one of the parameters must be
|
|
3544
|
-
*
|
|
3642
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3643
|
+
* <summary><code>required</code></summary>
|
|
3545
3644
|
*
|
|
3546
|
-
* Value must be specified or it won't be
|
|
3547
|
-
*
|
|
3645
|
+
* Value must be specified or it won't be valid.</details><details>
|
|
3646
|
+
* <summary><code>required_alt_title</code></summary>
|
|
3548
3647
|
*
|
|
3549
3648
|
* Assets contained in the field are required to specify custom title or
|
|
3550
3649
|
* alternate text, or they won't be valid.
|
|
@@ -3554,8 +3653,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3554
3653
|
* | `title` | `Boolean` | | Whether the title for the asset must be specified |
|
|
3555
3654
|
* | `alt` | `Boolean` | | Whether the alternate text for the asset must be specified |
|
|
3556
3655
|
*
|
|
3557
|
-
* At least one of the parameters must be
|
|
3558
|
-
*
|
|
3656
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3657
|
+
* <summary><code>required_seo_fields</code></summary>
|
|
3559
3658
|
*
|
|
3560
3659
|
* SEO field is to specify one or more properties, or it won't be valid.
|
|
3561
3660
|
*
|
|
@@ -3566,8 +3665,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3566
3665
|
* | `image` | `Boolean` | | Whether the social sharing image must be specified |
|
|
3567
3666
|
* | `twitter_card` | `Boolean` | | Whether the type of Twitter card must be specified |
|
|
3568
3667
|
*
|
|
3569
|
-
* At least one of the parameters must be
|
|
3570
|
-
*
|
|
3668
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3669
|
+
* <summary><code>title_length</code></summary>
|
|
3571
3670
|
*
|
|
3572
3671
|
* Limits the length of the title for a SEO field. Search engines usually
|
|
3573
3672
|
* truncate title tags to 60 character so it is a good practice to keep the
|
|
@@ -3578,8 +3677,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3578
3677
|
* | `min` | `Integer` | | Minimum value |
|
|
3579
3678
|
* | `max` | `Integer` | | Maximum value |
|
|
3580
3679
|
*
|
|
3581
|
-
* At least one of the parameters must be
|
|
3582
|
-
*
|
|
3680
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3681
|
+
* <summary><code>description_length</code></summary>
|
|
3583
3682
|
*
|
|
3584
3683
|
* Limits the length of the description for a SEO field. Search engines usually
|
|
3585
3684
|
* truncate description tags to 160 character so it is a good practice to keep
|
|
@@ -3590,20 +3689,22 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3590
3689
|
* | `min` | `Integer` | | Minimum value |
|
|
3591
3690
|
* | `max` | `Integer` | | Maximum value |
|
|
3592
3691
|
*
|
|
3593
|
-
* At least one of the parameters must be
|
|
3594
|
-
*
|
|
3692
|
+
* At least one of the parameters must be specified.</details><details>
|
|
3693
|
+
* <summary><code>rich_text_blocks</code></summary>
|
|
3595
3694
|
*
|
|
3596
3695
|
* Only accept references to block records of the specified block models.
|
|
3597
3696
|
*
|
|
3598
3697
|
* | Parameter | Type | Required | Description |
|
|
3599
|
-
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3600
|
-
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs
|
|
3698
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3699
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |</details><details>
|
|
3700
|
+
* <summary><code>structured_text_blocks</code></summary>
|
|
3601
3701
|
*
|
|
3602
3702
|
* Only accept references to block records of the specified block models.
|
|
3603
3703
|
*
|
|
3604
3704
|
* | Parameter | Type | Required | Description |
|
|
3605
|
-
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3606
|
-
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs
|
|
3705
|
+
* | ------------ | ----------------------- | -------- | ------------------------------ |
|
|
3706
|
+
* | `item_types` | `Array<Block Model ID>` | ✅ | Set of allowed Block Model IDs |</details><details>
|
|
3707
|
+
* <summary><code>structured_text_links</code></summary>
|
|
3607
3708
|
*
|
|
3608
3709
|
* Only accept `itemLink` to `inlineItem` nodes for records of the specified
|
|
3609
3710
|
* models.
|
|
@@ -3631,8 +3732,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3631
3732
|
*
|
|
3632
3733
|
* - `"fail"`: Fail the operation and notify the user
|
|
3633
3734
|
* - `"delete_references"`: Try to remove the reference to the deleted record (if
|
|
3634
|
-
* the field has a `required` validation it will
|
|
3635
|
-
*
|
|
3735
|
+
* the field has a `required` validation it will fail)</details><details>
|
|
3736
|
+
* <summary><code>size</code></summary>
|
|
3636
3737
|
*
|
|
3637
3738
|
* Only accept a number of items within the specified range.
|
|
3638
3739
|
*
|
|
@@ -3643,108 +3744,122 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
3643
3744
|
* | `max` | `Integer` | | Maximum length |
|
|
3644
3745
|
* | `multiple_of` | `Integer` | | The number of items must be multiple of this value |
|
|
3645
3746
|
*
|
|
3646
|
-
* At least one parameter must be
|
|
3647
|
-
*
|
|
3747
|
+
* At least one parameter must be specified.</details><details>
|
|
3748
|
+
* <summary><code>slug_title_field</code></summary>
|
|
3648
3749
|
*
|
|
3649
3750
|
* Specifies the ID of the _Single-line string_ field that will be used to
|
|
3650
3751
|
* generate the slug
|
|
3651
3752
|
*
|
|
3652
3753
|
* | Parameter | Type | Required | Description |
|
|
3653
|
-
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
3654
|
-
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug
|
|
3754
|
+
* | ---------------- | ---------- | -------- | ------------------------------------------------ |
|
|
3755
|
+
* | `title_field_id` | `Field ID` | ✅ | The field that will be used to generate the slug |</details><details>
|
|
3756
|
+
* <summary><code>unique</code></summary>
|
|
3655
3757
|
*
|
|
3656
3758
|
* The value must be unique across the whole collection of records.</details>
|
|
3657
3759
|
*
|
|
3658
3760
|
* ### Configuration parameters for DatoCMS built-in field editors
|
|
3659
3761
|
*
|
|
3660
3762
|
* If a field editor is not specified in this table, just pass an empty object
|
|
3661
|
-
* `{}` as its configuration
|
|
3662
|
-
*
|
|
3763
|
+
* `{}` as its configuration parameters.<details>
|
|
3764
|
+
* <summary><code>boolean_radio_group</code></summary>
|
|
3663
3765
|
*
|
|
3664
3766
|
* Radio group input for _boolean_ fields.
|
|
3665
3767
|
*
|
|
3666
3768
|
* | Parameter | Type | Required | Description |
|
|
3667
|
-
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
3769
|
+
* | ---------------- | ---------------------------------- | -------- | ----------------------------------------- |
|
|
3668
3770
|
* | `positive_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for positive choice (`true`) |
|
|
3669
|
-
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`)
|
|
3771
|
+
* | `negative_radio` | `{ label: string, hint?: string }` | ✅ | Radio input for negative choice (`false`) |</details><details>
|
|
3772
|
+
* <summary><code>string_radio_group</code></summary>
|
|
3670
3773
|
*
|
|
3671
3774
|
* Radio group input for _string_ fields.
|
|
3672
3775
|
*
|
|
3673
3776
|
* | Parameter | Type | Required | Description |
|
|
3674
|
-
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
3675
|
-
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options
|
|
3777
|
+
* | --------- | -------------------------------------------------------- | -------- | --------------------------- |
|
|
3778
|
+
* | `radios` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different radio options |</details><details>
|
|
3779
|
+
* <summary><code>string_select</code></summary>
|
|
3676
3780
|
*
|
|
3677
3781
|
* Select input for _string_ fields.
|
|
3678
3782
|
*
|
|
3679
3783
|
* | Parameter | Type | Required | Description |
|
|
3680
|
-
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3681
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options
|
|
3784
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3785
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |</details><details>
|
|
3786
|
+
* <summary><code>string_multi_select</code></summary>
|
|
3682
3787
|
*
|
|
3683
3788
|
* Select input for _JSON_ fields, to edit an array of strings.
|
|
3684
3789
|
*
|
|
3685
3790
|
* | Parameter | Type | Required | Description |
|
|
3686
|
-
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3687
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options
|
|
3791
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3792
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |</details><details>
|
|
3793
|
+
* <summary><code>string_checkbox_group</code></summary>
|
|
3688
3794
|
*
|
|
3689
3795
|
* Multiple chechboxes input for _JSON_ fields, to edit an array of strings.
|
|
3690
3796
|
*
|
|
3691
3797
|
* | Parameter | Type | Required | Description |
|
|
3692
|
-
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3693
|
-
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options
|
|
3798
|
+
* | --------- | -------------------------------------------------------- | -------- | ---------------------------- |
|
|
3799
|
+
* | `options` | `Array<{ label: string, value: string, hint?: string }>` | ✅ | The different select options |</details><details>
|
|
3800
|
+
* <summary><code>single_line</code></summary>
|
|
3694
3801
|
*
|
|
3695
3802
|
* Simple textual input for _Single-line string_ fields.
|
|
3696
3803
|
*
|
|
3697
3804
|
* | Parameter | Type | Required | Description |
|
|
3698
|
-
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
3699
|
-
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading
|
|
3805
|
+
* | --------- | --------- | -------- | -------------------------------------------------------------------------------- |
|
|
3806
|
+
* | `heading` | `Boolean` | ✅ | Indicates if the field should be shown bigger, as a field representing a heading |</details><details>
|
|
3807
|
+
* <summary><code>markdown</code></summary>
|
|
3700
3808
|
*
|
|
3701
3809
|
* Markdown editor for _Multiple-paragraph text_ fields.
|
|
3702
3810
|
*
|
|
3703
3811
|
* | Parameter | Type | Required | Description |
|
|
3704
|
-
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3705
|
-
* | `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"`
|
|
3812
|
+
* | --------- | --------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3813
|
+
* | `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>
|
|
3814
|
+
* <summary><code>wysiwyg</code></summary>
|
|
3706
3815
|
*
|
|
3707
3816
|
* HTML editor for _Multiple-paragraph text_ fields.
|
|
3708
3817
|
*
|
|
3709
3818
|
* | Parameter | Type | Required | Description |
|
|
3710
|
-
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3711
|
-
* | `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"`
|
|
3819
|
+
* | --------- | --------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3820
|
+
* | `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>
|
|
3821
|
+
* <summary><code>textarea</code></summary>
|
|
3712
3822
|
*
|
|
3713
|
-
* Basic textarea editor for _Multiple-paragraph text_
|
|
3714
|
-
*
|
|
3823
|
+
* Basic textarea editor for _Multiple-paragraph text_ fields.</details><details>
|
|
3824
|
+
* <summary><code>color_picker</code></summary>
|
|
3715
3825
|
*
|
|
3716
3826
|
* Built-in editor for _Color_ fields.
|
|
3717
3827
|
*
|
|
3718
3828
|
* | Parameter | Type | Required | Description |
|
|
3719
|
-
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
3829
|
+
* | --------------- | ------------------------- | -------- | --------------------------------------------------------- |
|
|
3720
3830
|
* | `enable_alpha` | `Boolean` | ✅ | Should the color picker allow to specify the alpha value? |
|
|
3721
|
-
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user
|
|
3831
|
+
* | `preset_colors` | `Array<Hex color string>` | ✅ | List of preset colors to offer to the user |</details><details>
|
|
3832
|
+
* <summary><code>slug</code></summary>
|
|
3722
3833
|
*
|
|
3723
3834
|
* Built-in editor for _Slug_ fields.
|
|
3724
3835
|
*
|
|
3725
3836
|
* | Parameter | Type | Required | Description |
|
|
3726
|
-
* | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
|
|
3727
|
-
* | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors.
|
|
3837
|
+
* | ------------ | -------- | -------- | -------------------------------------------------------------------------------------- |
|
|
3838
|
+
* | `url_prefix` | `String` | | A prefix that will be shown in the editor's form to give some context to your editors. |</details><details>
|
|
3839
|
+
* <summary><code>rich_text</code></summary>
|
|
3728
3840
|
*
|
|
3729
3841
|
* Built-in editor for _Modular content_ fields.
|
|
3730
3842
|
*
|
|
3731
3843
|
* | Parameter | Type | Required | Description |
|
|
3732
|
-
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
3733
|
-
* | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not
|
|
3844
|
+
* | ----------------- | --------- | -------- | ---------------------------------------------------------- |
|
|
3845
|
+
* | `start_collapsed` | `Boolean` | | Whether you want block records collapsed by default or not |</details><details>
|
|
3846
|
+
* <summary><code>structured_text</code></summary>
|
|
3734
3847
|
*
|
|
3735
3848
|
* Built-in editor for _Structured text_ fields.
|
|
3736
3849
|
*
|
|
3737
|
-
* | Parameter | Type
|
|
3738
|
-
* | ------------------------- |
|
|
3739
|
-
* | `nodes` | `Array<String>`
|
|
3740
|
-
* | `marks` | `Array<String>`
|
|
3741
|
-
* | `
|
|
3742
|
-
* | `
|
|
3743
|
-
* | `
|
|
3850
|
+
* | Parameter | Type | Required | Description |
|
|
3851
|
+
* | ------------------------- | ---------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
3852
|
+
* | `nodes` | `Array<String>` | ✅ | Specify which nodes the field should allow. Valid values: `"blockquote"`, `"code"`, `"heading"`, `"link"`, `"list"`, `"thematicBreak"` |
|
|
3853
|
+
* | `marks` | `Array<String>` | ✅ | Specify which marks the field should allow. Valid values: `"strong"`, `"emphasis"`, `"underline"`, `"strikethrough"`, `"code"`, `"highlight"` |
|
|
3854
|
+
* | `heading_levels` | `Array<Integer>` | ✅ | If `nodes` includes `"heading"`, specify which heading levels the field should allow. Valid values: numbers between 1 and 6 |
|
|
3855
|
+
* | `blocks_start_collapsed` | `Boolean` | | Whether you want block nodes collapsed by default or not |
|
|
3856
|
+
* | `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 |
|
|
3857
|
+
* | `show_links_meta_editor` | `Boolean` | | Whether you want to show the complete meta editor for links |</details><details>
|
|
3858
|
+
* <summary><code>link_select</code> and <code>links_select</code></summary>
|
|
3744
3859
|
*
|
|
3745
3860
|
* Use a select input with auto-completion to pick the records to reference
|
|
3746
|
-
* inside the field.</details><details
|
|
3747
|
-
* <code>links_embed</code></summary>
|
|
3861
|
+
* inside the field.</details><details>
|
|
3862
|
+
* <summary><code>link_embed</code> and <code>links_embed</code></summary>
|
|
3748
3863
|
*
|
|
3749
3864
|
* Use an expanded view with records' image preview to pick the records to
|
|
3750
3865
|
* reference inside the field.</details>
|
|
@@ -3768,7 +3883,7 @@ export interface FieldAttributes {
|
|
|
3768
3883
|
/** The label of the field */
|
|
3769
3884
|
label: string;
|
|
3770
3885
|
/** Type of input */
|
|
3771
|
-
field_type: string;
|
|
3886
|
+
field_type: 'string' | 'text' | 'boolean' | 'integer' | 'float' | 'date' | 'date_time' | 'color' | 'json' | 'lat_lon' | 'seo' | 'slug' | 'video' | 'file' | 'gallery' | 'link' | 'links' | 'rich_text' | 'structured_text';
|
|
3772
3887
|
/** Whether the field needs to be multilanguage or not */
|
|
3773
3888
|
localized: boolean;
|
|
3774
3889
|
/**
|
|
@@ -3787,7 +3902,7 @@ export interface FieldAttributes {
|
|
|
3787
3902
|
[k: string]: unknown;
|
|
3788
3903
|
};
|
|
3789
3904
|
/** Field appearance */
|
|
3790
|
-
appeareance
|
|
3905
|
+
appeareance?: {
|
|
3791
3906
|
editor: string;
|
|
3792
3907
|
parameters: {
|
|
3793
3908
|
[k: string]: unknown;
|
|
@@ -3857,7 +3972,7 @@ export interface FieldCreateSchema {
|
|
|
3857
3972
|
/** The label of the field */
|
|
3858
3973
|
label: string;
|
|
3859
3974
|
/** Type of input */
|
|
3860
|
-
field_type: string;
|
|
3975
|
+
field_type: 'string' | 'text' | 'boolean' | 'integer' | 'float' | 'date' | 'date_time' | 'color' | 'json' | 'lat_lon' | 'seo' | 'slug' | 'video' | 'file' | 'gallery' | 'link' | 'links' | 'rich_text' | 'structured_text';
|
|
3861
3976
|
/** Field API key */
|
|
3862
3977
|
api_key: string;
|
|
3863
3978
|
/** Whether the field needs to be multilanguage or not */
|
|
@@ -4011,7 +4126,7 @@ export interface FieldUpdateSchema {
|
|
|
4011
4126
|
/** Ordering index */
|
|
4012
4127
|
position?: number;
|
|
4013
4128
|
/** Type of input */
|
|
4014
|
-
field_type?: string;
|
|
4129
|
+
field_type?: 'string' | 'text' | 'boolean' | 'integer' | 'float' | 'date' | 'date_time' | 'color' | 'json' | 'lat_lon' | 'seo' | 'slug' | 'video' | 'file' | 'gallery' | 'link' | 'links' | 'rich_text' | 'structured_text';
|
|
4015
4130
|
/** Field hint */
|
|
4016
4131
|
hint?: string | null;
|
|
4017
4132
|
};
|
|
@@ -4174,6 +4289,7 @@ export interface FieldsetCreateSchema {
|
|
|
4174
4289
|
*/
|
|
4175
4290
|
export interface FieldsetCreateTargetSchema {
|
|
4176
4291
|
data: Fieldset;
|
|
4292
|
+
included?: ItemType[];
|
|
4177
4293
|
}
|
|
4178
4294
|
/**
|
|
4179
4295
|
* This interface was referenced by `Fieldset`'s JSON-Schema via the
|
|
@@ -4756,6 +4872,10 @@ export interface ItemMeta {
|
|
|
4756
4872
|
status: null | ('draft' | 'updated' | 'published');
|
|
4757
4873
|
/** Whether the current record is valid or not */
|
|
4758
4874
|
is_valid: boolean;
|
|
4875
|
+
/** Whether the current version of the record is valid or not */
|
|
4876
|
+
is_current_version_valid: null | boolean;
|
|
4877
|
+
/** Whether the published version of record is valid or not */
|
|
4878
|
+
is_published_version_valid: null | boolean;
|
|
4759
4879
|
/** The ID of the current record version */
|
|
4760
4880
|
current_version: string;
|
|
4761
4881
|
/** Workflow stage in which the item is */
|
|
@@ -4845,6 +4965,10 @@ export interface ItemCreateSchema {
|
|
|
4845
4965
|
status?: null | ('draft' | 'updated' | 'published');
|
|
4846
4966
|
/** Whether the current record is valid or not */
|
|
4847
4967
|
is_valid?: boolean;
|
|
4968
|
+
/** Whether the current version of the record is valid or not */
|
|
4969
|
+
is_current_version_valid?: null | boolean;
|
|
4970
|
+
/** Whether the published version of the record is valid or not */
|
|
4971
|
+
is_published_version_valid?: null | boolean;
|
|
4848
4972
|
/** The ID of the current record version */
|
|
4849
4973
|
current_version?: string;
|
|
4850
4974
|
};
|
|
@@ -4914,6 +5038,10 @@ export interface ItemUpdateSchema {
|
|
|
4914
5038
|
* example)
|
|
4915
5039
|
*/
|
|
4916
5040
|
current_version?: string;
|
|
5041
|
+
/** Whether the current version of the record is valid or not */
|
|
5042
|
+
is_current_version_valid?: null | boolean;
|
|
5043
|
+
/** Whether the published version of record is valid or not */
|
|
5044
|
+
is_published_version_valid?: null | boolean;
|
|
4917
5045
|
/** The new stage to move the record to */
|
|
4918
5046
|
stage?: string | null;
|
|
4919
5047
|
};
|
|
@@ -5596,7 +5724,7 @@ export interface UploadBatchAddTagsSchema {
|
|
|
5596
5724
|
type: UploadType;
|
|
5597
5725
|
attributes: {
|
|
5598
5726
|
/** Tags */
|
|
5599
|
-
tags
|
|
5727
|
+
tags: string[];
|
|
5600
5728
|
};
|
|
5601
5729
|
};
|
|
5602
5730
|
}
|
|
@@ -5919,13 +6047,13 @@ export interface SearchResult {
|
|
|
5919
6047
|
* `definition` "attributes".
|
|
5920
6048
|
*/
|
|
5921
6049
|
export interface SearchResultAttributes {
|
|
5922
|
-
/**
|
|
6050
|
+
/** Title of the page */
|
|
5923
6051
|
title: string;
|
|
5924
|
-
/** First
|
|
6052
|
+
/** First 200 characters of page body, unformatted */
|
|
5925
6053
|
body_excerpt: string;
|
|
5926
6054
|
/** URL */
|
|
5927
6055
|
url: string;
|
|
5928
|
-
/**
|
|
6056
|
+
/** Search score */
|
|
5929
6057
|
score: number;
|
|
5930
6058
|
highlight: {
|
|
5931
6059
|
title?: string[] | null;
|
|
@@ -5948,7 +6076,7 @@ export interface SearchResultData {
|
|
|
5948
6076
|
*/
|
|
5949
6077
|
export interface SearchResultInstancesTargetSchema {
|
|
5950
6078
|
data: SearchResult[];
|
|
5951
|
-
meta
|
|
6079
|
+
meta: {
|
|
5952
6080
|
total_count: number;
|
|
5953
6081
|
};
|
|
5954
6082
|
}
|
|
@@ -6530,10 +6658,52 @@ export interface ItemTypeFilter {
|
|
|
6530
6658
|
export interface ItemTypeFilterAttributes {
|
|
6531
6659
|
/** The name of the filter */
|
|
6532
6660
|
name: string;
|
|
6533
|
-
/**
|
|
6661
|
+
/**
|
|
6662
|
+
* The actual filter. It follows the form of the `filter` query parameter of
|
|
6663
|
+
* the [List all
|
|
6664
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6665
|
+
* endpoint.
|
|
6666
|
+
*/
|
|
6534
6667
|
filter: {
|
|
6535
6668
|
[k: string]: unknown;
|
|
6536
6669
|
};
|
|
6670
|
+
/** The columns to show with this filter */
|
|
6671
|
+
columns: [
|
|
6672
|
+
{
|
|
6673
|
+
/**
|
|
6674
|
+
* Can be either the API key of a model's field, or one of the
|
|
6675
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
6676
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
6677
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
6678
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
6679
|
+
* models), `_stage (only for models associated with a workflow).
|
|
6680
|
+
*/
|
|
6681
|
+
name: string;
|
|
6682
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
6683
|
+
width: number;
|
|
6684
|
+
},
|
|
6685
|
+
...{
|
|
6686
|
+
/**
|
|
6687
|
+
* Can be either the API key of a model's field, or one of the
|
|
6688
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
6689
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
6690
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
6691
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
6692
|
+
* models), `_stage (only for models associated with a workflow).
|
|
6693
|
+
*/
|
|
6694
|
+
name: string;
|
|
6695
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
6696
|
+
width: number;
|
|
6697
|
+
}[]
|
|
6698
|
+
] | null;
|
|
6699
|
+
/**
|
|
6700
|
+
* The ordering to apply with this filter, or `null` for the default model
|
|
6701
|
+
* ordering. It follows the form of the `order_by` query parameter of the
|
|
6702
|
+
* [List all
|
|
6703
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6704
|
+
* endpoint.
|
|
6705
|
+
*/
|
|
6706
|
+
order_by: string | null;
|
|
6537
6707
|
/** Whether it's a shared filter or not */
|
|
6538
6708
|
shared: boolean;
|
|
6539
6709
|
}
|
|
@@ -6549,16 +6719,6 @@ export interface ItemTypeFilterRelationships {
|
|
|
6549
6719
|
data: ItemTypeData;
|
|
6550
6720
|
};
|
|
6551
6721
|
}
|
|
6552
|
-
/**
|
|
6553
|
-
* JSON API data
|
|
6554
|
-
*
|
|
6555
|
-
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
6556
|
-
* `definition` "data".
|
|
6557
|
-
*/
|
|
6558
|
-
export interface ItemTypeFilterData {
|
|
6559
|
-
type: ItemTypeFilterType;
|
|
6560
|
-
id: ItemTypeFilterIdentity;
|
|
6561
|
-
}
|
|
6562
6722
|
/**
|
|
6563
6723
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
6564
6724
|
* `create.schema` link.
|
|
@@ -6569,12 +6729,54 @@ export interface ItemTypeFilterCreateSchema {
|
|
|
6569
6729
|
attributes: {
|
|
6570
6730
|
/** The name of the filter */
|
|
6571
6731
|
name: string;
|
|
6572
|
-
/**
|
|
6573
|
-
|
|
6732
|
+
/**
|
|
6733
|
+
* The actual filter. It follows the form of the `filter` query parameter
|
|
6734
|
+
* of the [List all
|
|
6735
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6736
|
+
* endpoint.
|
|
6737
|
+
*/
|
|
6738
|
+
filter?: {
|
|
6574
6739
|
[k: string]: unknown;
|
|
6575
6740
|
};
|
|
6741
|
+
/** The columns to show with this filter */
|
|
6742
|
+
columns?: [
|
|
6743
|
+
{
|
|
6744
|
+
/**
|
|
6745
|
+
* Can be either the API key of a model's field, or one of the
|
|
6746
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
6747
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
6748
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
6749
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
6750
|
+
* models), `_stage (only for models associated with a workflow).
|
|
6751
|
+
*/
|
|
6752
|
+
name: string;
|
|
6753
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
6754
|
+
width: number;
|
|
6755
|
+
},
|
|
6756
|
+
...{
|
|
6757
|
+
/**
|
|
6758
|
+
* Can be either the API key of a model's field, or one of the
|
|
6759
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
6760
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
6761
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
6762
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
6763
|
+
* models), `_stage (only for models associated with a workflow).
|
|
6764
|
+
*/
|
|
6765
|
+
name: string;
|
|
6766
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
6767
|
+
width: number;
|
|
6768
|
+
}[]
|
|
6769
|
+
] | null;
|
|
6770
|
+
/**
|
|
6771
|
+
* The ordering to apply with this filter, or `null` for the default model
|
|
6772
|
+
* ordering. It follows the form of the `order_by` query parameter of the
|
|
6773
|
+
* [List all
|
|
6774
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6775
|
+
* endpoint.
|
|
6776
|
+
*/
|
|
6777
|
+
order_by?: string | null;
|
|
6576
6778
|
/** Whether it's a shared filter or not */
|
|
6577
|
-
shared
|
|
6779
|
+
shared?: boolean;
|
|
6578
6780
|
};
|
|
6579
6781
|
relationships: {
|
|
6580
6782
|
/** Model associated with the filter */
|
|
@@ -6602,14 +6804,62 @@ export interface ItemTypeFilterUpdateSchema {
|
|
|
6602
6804
|
/** JSON API attributes */
|
|
6603
6805
|
attributes: {
|
|
6604
6806
|
/** The name of the filter */
|
|
6605
|
-
name
|
|
6807
|
+
name?: string;
|
|
6808
|
+
/** The columns to show with this filter */
|
|
6809
|
+
columns?: [
|
|
6810
|
+
{
|
|
6811
|
+
/**
|
|
6812
|
+
* Can be either the API key of a model's field, or one of the
|
|
6813
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
6814
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
6815
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
6816
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
6817
|
+
* models), `_stage (only for models associated with a workflow).
|
|
6818
|
+
*/
|
|
6819
|
+
name: string;
|
|
6820
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
6821
|
+
width: number;
|
|
6822
|
+
},
|
|
6823
|
+
...{
|
|
6824
|
+
/**
|
|
6825
|
+
* Can be either the API key of a model's field, or one of the
|
|
6826
|
+
* following meta columns: `id`, `_preview`, `_updated_at`,
|
|
6827
|
+
* `_created_at`, `_creator`, `_status`, `_published_at`,
|
|
6828
|
+
* `_first_published_at`, `_publication_scheduled_at`,
|
|
6829
|
+
* `_unpublishing_scheduled_at`, `position` (only for sortable
|
|
6830
|
+
* models), `_stage (only for models associated with a workflow).
|
|
6831
|
+
*/
|
|
6832
|
+
name: string;
|
|
6833
|
+
/** The percentage width for the column (float, from 0 to 1.0) */
|
|
6834
|
+
width: number;
|
|
6835
|
+
}[]
|
|
6836
|
+
] | null;
|
|
6837
|
+
/**
|
|
6838
|
+
* The ordering to apply with this filter, or `null` for the default model
|
|
6839
|
+
* ordering. It follows the form of the `order_by` query parameter of the
|
|
6840
|
+
* [List all
|
|
6841
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6842
|
+
* endpoint.
|
|
6843
|
+
*/
|
|
6844
|
+
order_by?: string | null;
|
|
6606
6845
|
/** Whether it's a shared filter or not */
|
|
6607
6846
|
shared?: boolean;
|
|
6608
|
-
/**
|
|
6609
|
-
|
|
6847
|
+
/**
|
|
6848
|
+
* The actual filter. It follows the form of the `filter` query parameter
|
|
6849
|
+
* of the [List all
|
|
6850
|
+
* records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
|
|
6851
|
+
* endpoint.
|
|
6852
|
+
*/
|
|
6853
|
+
filter?: {
|
|
6610
6854
|
[k: string]: unknown;
|
|
6611
6855
|
};
|
|
6612
6856
|
};
|
|
6857
|
+
relationships?: {
|
|
6858
|
+
/** Model associated with the filter */
|
|
6859
|
+
item_type: {
|
|
6860
|
+
data: ItemTypeData;
|
|
6861
|
+
};
|
|
6862
|
+
};
|
|
6613
6863
|
};
|
|
6614
6864
|
}
|
|
6615
6865
|
/**
|
|
@@ -6777,6 +7027,8 @@ export interface SiteInvitation {
|
|
|
6777
7027
|
export interface SiteInvitationAttributes {
|
|
6778
7028
|
/** Email */
|
|
6779
7029
|
email: string;
|
|
7030
|
+
/** Whether this invitation has expired */
|
|
7031
|
+
expired: boolean;
|
|
6780
7032
|
}
|
|
6781
7033
|
/**
|
|
6782
7034
|
* JSON API links
|
|
@@ -7103,6 +7355,8 @@ export interface SsoSettings {
|
|
|
7103
7355
|
export interface SsoSettingsAttributes {
|
|
7104
7356
|
/** URL of Identity Provider SAML Metadata endpoint */
|
|
7105
7357
|
idp_saml_metadata_url: null | string;
|
|
7358
|
+
/** Identity Provider SAML Metadata */
|
|
7359
|
+
idp_saml_metadata_xml?: null | string;
|
|
7106
7360
|
/** DatoCMS SCIM base URL */
|
|
7107
7361
|
scim_base_url: string;
|
|
7108
7362
|
/** DatoCMS SAML ACS URL */
|
|
@@ -7171,9 +7425,11 @@ export interface SsoSettingsUpdateSchema {
|
|
|
7171
7425
|
id?: SsoSettingsIdentity;
|
|
7172
7426
|
attributes?: {
|
|
7173
7427
|
/** URL of Identity Provider SAML Metadata endpoint */
|
|
7174
|
-
idp_saml_metadata_url
|
|
7428
|
+
idp_saml_metadata_url?: null | string;
|
|
7429
|
+
/** Identity Provider SAML Metadata */
|
|
7430
|
+
idp_saml_metadata_xml?: null | string;
|
|
7175
7431
|
};
|
|
7176
|
-
relationships
|
|
7432
|
+
relationships?: {
|
|
7177
7433
|
/**
|
|
7178
7434
|
* The default role assigned to SSO users that do not belong to any SSO
|
|
7179
7435
|
* group
|
|
@@ -7390,7 +7646,7 @@ export interface DailyUsageData {
|
|
|
7390
7646
|
* `instances.targetSchema` link.
|
|
7391
7647
|
*/
|
|
7392
7648
|
export interface DailyUsageInstancesTargetSchema {
|
|
7393
|
-
data: DailyUsage;
|
|
7649
|
+
data: DailyUsage[];
|
|
7394
7650
|
}
|
|
7395
7651
|
/**
|
|
7396
7652
|
* You can use counters to analyze your project's data consumption over a period
|
|
@@ -7832,6 +8088,8 @@ export interface Workflow {
|
|
|
7832
8088
|
export interface WorkflowAttributes {
|
|
7833
8089
|
/** The name of the workflow */
|
|
7834
8090
|
name: string;
|
|
8091
|
+
/** Workflow API key */
|
|
8092
|
+
api_key: string;
|
|
7835
8093
|
/** The stages of the workflow */
|
|
7836
8094
|
stages: [
|
|
7837
8095
|
{
|
|
@@ -7863,11 +8121,12 @@ export interface WorkflowAttributes {
|
|
|
7863
8121
|
export interface WorkflowCreateSchema {
|
|
7864
8122
|
data: {
|
|
7865
8123
|
type: WorkflowType;
|
|
7866
|
-
id: WorkflowIdentity;
|
|
7867
8124
|
/** JSON API attributes */
|
|
7868
8125
|
attributes: {
|
|
7869
8126
|
/** The name of the workflow */
|
|
7870
8127
|
name: string;
|
|
8128
|
+
/** Workflow API key */
|
|
8129
|
+
api_key: string;
|
|
7871
8130
|
/** The stages of the workflow */
|
|
7872
8131
|
stages: [
|
|
7873
8132
|
{
|
|
@@ -7913,6 +8172,8 @@ export interface WorkflowUpdateSchema {
|
|
|
7913
8172
|
attributes?: {
|
|
7914
8173
|
/** The name of the workflow */
|
|
7915
8174
|
name?: string;
|
|
8175
|
+
/** Workflow API key */
|
|
8176
|
+
api_key?: string;
|
|
7916
8177
|
/** The stages of the workflow */
|
|
7917
8178
|
stages?: [
|
|
7918
8179
|
{
|