@datocms/cma-client 0.1.0 → 0.1.2
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/README.md +12 -17
- package/dist/cjs/generated/schemaInfo.js +0 -2
- package/dist/cjs/generated/schemaInfo.js.map +1 -1
- package/dist/esm/BaseResource.d.ts +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +772 -772
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +422 -422
- package/dist/esm/generated/schemaInfo.d.ts +0 -2
- package/dist/esm/generated/schemaInfo.js +0 -2
- package/dist/esm/generated/schemaInfo.js.map +1 -1
- package/dist/types/BaseResource.d.ts +1 -1
- package/dist/types/generated/SchemaTypes.d.ts +772 -772
- package/dist/types/generated/SimpleSchemaTypes.d.ts +422 -422
- package/dist/types/generated/schemaInfo.d.ts +0 -2
- package/package.json +7 -7
- package/src/BaseResource.ts +1 -1
- package/src/generated/SchemaTypes.ts +772 -772
- package/src/generated/SimpleSchemaTypes.ts +422 -422
- package/src/generated/schemaInfo.ts +0 -4
|
@@ -1468,7 +1468,7 @@ export declare type SiteType = 'site';
|
|
|
1468
1468
|
* via the `instances.targetSchema` link.
|
|
1469
1469
|
*/
|
|
1470
1470
|
export declare type WorkflowInstancesTargetSchema = Workflow[];
|
|
1471
|
-
export
|
|
1471
|
+
export declare type DatoApi = {
|
|
1472
1472
|
role?: Role;
|
|
1473
1473
|
user?: User;
|
|
1474
1474
|
sso_user?: SsoUser;
|
|
@@ -1514,14 +1514,14 @@ export interface DatoApi {
|
|
|
1514
1514
|
site?: Site;
|
|
1515
1515
|
workflow?: Workflow;
|
|
1516
1516
|
[k: string]: unknown;
|
|
1517
|
-
}
|
|
1517
|
+
};
|
|
1518
1518
|
/**
|
|
1519
1519
|
* A Role represents a specific set of actions an editor (or an API token) can perform on your administrative area.
|
|
1520
1520
|
*
|
|
1521
1521
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
1522
1522
|
* via the `definition` "role".
|
|
1523
1523
|
*/
|
|
1524
|
-
export
|
|
1524
|
+
export declare type Role = {
|
|
1525
1525
|
id: RoleIdentity;
|
|
1526
1526
|
type: RoleType;
|
|
1527
1527
|
/**
|
|
@@ -1710,7 +1710,7 @@ export interface Role {
|
|
|
1710
1710
|
}[];
|
|
1711
1711
|
inherits_permissions_from: RoleData[];
|
|
1712
1712
|
meta: RoleMeta;
|
|
1713
|
-
}
|
|
1713
|
+
};
|
|
1714
1714
|
export declare type RoleCreateTargetSchema = Role;
|
|
1715
1715
|
export declare type RoleUpdateTargetSchema = Role;
|
|
1716
1716
|
export declare type RoleSelfTargetSchema = Role;
|
|
@@ -1721,17 +1721,17 @@ export declare type RoleDestroyTargetSchema = Role;
|
|
|
1721
1721
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
1722
1722
|
* via the `definition` "data".
|
|
1723
1723
|
*/
|
|
1724
|
-
export
|
|
1724
|
+
export declare type RoleData = {
|
|
1725
1725
|
type: RoleType;
|
|
1726
1726
|
id: RoleIdentity;
|
|
1727
|
-
}
|
|
1727
|
+
};
|
|
1728
1728
|
/**
|
|
1729
1729
|
* Meta information regarding the record
|
|
1730
1730
|
*
|
|
1731
1731
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
1732
1732
|
* via the `definition` "meta".
|
|
1733
1733
|
*/
|
|
1734
|
-
export
|
|
1734
|
+
export declare type RoleMeta = {
|
|
1735
1735
|
/**
|
|
1736
1736
|
* The final set of permissions considering also inherited roles
|
|
1737
1737
|
*/
|
|
@@ -1917,14 +1917,14 @@ export interface RoleMeta {
|
|
|
1917
1917
|
build_trigger?: BuildTriggerIdentity | null;
|
|
1918
1918
|
}[];
|
|
1919
1919
|
};
|
|
1920
|
-
}
|
|
1920
|
+
};
|
|
1921
1921
|
/**
|
|
1922
1922
|
* JSON API attributes
|
|
1923
1923
|
*
|
|
1924
1924
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
1925
1925
|
* via the `definition` "attributes".
|
|
1926
1926
|
*/
|
|
1927
|
-
export
|
|
1927
|
+
export declare type RoleAttributes = {
|
|
1928
1928
|
/**
|
|
1929
1929
|
* The name of the role
|
|
1930
1930
|
*/
|
|
@@ -2109,21 +2109,21 @@ export interface RoleAttributes {
|
|
|
2109
2109
|
negative_build_trigger_permissions: {
|
|
2110
2110
|
build_trigger?: BuildTriggerIdentity | null;
|
|
2111
2111
|
}[];
|
|
2112
|
-
}
|
|
2112
|
+
};
|
|
2113
2113
|
/**
|
|
2114
2114
|
* JSON API links
|
|
2115
2115
|
*
|
|
2116
2116
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
2117
2117
|
* via the `definition` "relationships".
|
|
2118
2118
|
*/
|
|
2119
|
-
export
|
|
2119
|
+
export declare type RoleRelationships = {
|
|
2120
2120
|
inherits_permissions_from: RoleData[];
|
|
2121
|
-
}
|
|
2121
|
+
};
|
|
2122
2122
|
/**
|
|
2123
2123
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
2124
2124
|
* via the `create.schema` link.
|
|
2125
2125
|
*/
|
|
2126
|
-
export
|
|
2126
|
+
export declare type RoleCreateSchema = {
|
|
2127
2127
|
type?: RoleType;
|
|
2128
2128
|
/**
|
|
2129
2129
|
* The name of the role
|
|
@@ -2311,12 +2311,12 @@ export interface RoleCreateSchema {
|
|
|
2311
2311
|
}[];
|
|
2312
2312
|
inherits_permissions_from?: RoleData[];
|
|
2313
2313
|
meta?: RoleMeta;
|
|
2314
|
-
}
|
|
2314
|
+
};
|
|
2315
2315
|
/**
|
|
2316
2316
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
2317
2317
|
* via the `update.schema` link.
|
|
2318
2318
|
*/
|
|
2319
|
-
export
|
|
2319
|
+
export declare type RoleUpdateSchema = {
|
|
2320
2320
|
id?: RoleIdentity;
|
|
2321
2321
|
type?: RoleType;
|
|
2322
2322
|
/**
|
|
@@ -2505,14 +2505,14 @@ export interface RoleUpdateSchema {
|
|
|
2505
2505
|
}[];
|
|
2506
2506
|
inherits_permissions_from?: RoleData[];
|
|
2507
2507
|
meta?: RoleMeta;
|
|
2508
|
-
}
|
|
2508
|
+
};
|
|
2509
2509
|
/**
|
|
2510
2510
|
* A DatoCMS administrative area can be accessed by multiple people. Every collaborator is linked to a specific Role, which describes what actions it will be able to perform once logged in.
|
|
2511
2511
|
*
|
|
2512
2512
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2513
2513
|
* via the `definition` "user".
|
|
2514
2514
|
*/
|
|
2515
|
-
export
|
|
2515
|
+
export declare type User = {
|
|
2516
2516
|
id: UserIdentity;
|
|
2517
2517
|
type: UserType;
|
|
2518
2518
|
/**
|
|
@@ -2533,7 +2533,7 @@ export interface User {
|
|
|
2533
2533
|
is_active: boolean;
|
|
2534
2534
|
role: RoleData;
|
|
2535
2535
|
meta?: UserMeta;
|
|
2536
|
-
}
|
|
2536
|
+
};
|
|
2537
2537
|
export declare type UserUpdateTargetSchema = User;
|
|
2538
2538
|
export declare type UserSelfTargetSchema = User;
|
|
2539
2539
|
export declare type UserDestroyTargetSchema = User;
|
|
@@ -2543,29 +2543,29 @@ export declare type UserDestroyTargetSchema = User;
|
|
|
2543
2543
|
* This interface was referenced by `User`'s JSON-Schema
|
|
2544
2544
|
* via the `definition` "meta".
|
|
2545
2545
|
*/
|
|
2546
|
-
export
|
|
2546
|
+
export declare type UserMeta = {
|
|
2547
2547
|
/**
|
|
2548
2548
|
* Date of last reading/interaction
|
|
2549
2549
|
*/
|
|
2550
2550
|
last_access: string | null;
|
|
2551
|
-
}
|
|
2551
|
+
};
|
|
2552
2552
|
/**
|
|
2553
2553
|
* JSON API data
|
|
2554
2554
|
*
|
|
2555
2555
|
* This interface was referenced by `User`'s JSON-Schema
|
|
2556
2556
|
* via the `definition` "data".
|
|
2557
2557
|
*/
|
|
2558
|
-
export
|
|
2558
|
+
export declare type UserData = {
|
|
2559
2559
|
type: UserType;
|
|
2560
2560
|
id: UserIdentity;
|
|
2561
|
-
}
|
|
2561
|
+
};
|
|
2562
2562
|
/**
|
|
2563
2563
|
* JSON API attributes
|
|
2564
2564
|
*
|
|
2565
2565
|
* This interface was referenced by `User`'s JSON-Schema
|
|
2566
2566
|
* via the `definition` "attributes".
|
|
2567
2567
|
*/
|
|
2568
|
-
export
|
|
2568
|
+
export declare type UserAttributes = {
|
|
2569
2569
|
/**
|
|
2570
2570
|
* Email
|
|
2571
2571
|
*/
|
|
@@ -2582,21 +2582,21 @@ export interface UserAttributes {
|
|
|
2582
2582
|
* Whether the user is active or not
|
|
2583
2583
|
*/
|
|
2584
2584
|
is_active: boolean;
|
|
2585
|
-
}
|
|
2585
|
+
};
|
|
2586
2586
|
/**
|
|
2587
2587
|
* JSON API links
|
|
2588
2588
|
*
|
|
2589
2589
|
* This interface was referenced by `User`'s JSON-Schema
|
|
2590
2590
|
* via the `definition` "relationships".
|
|
2591
2591
|
*/
|
|
2592
|
-
export
|
|
2592
|
+
export declare type UserRelationships = {
|
|
2593
2593
|
role: RoleData;
|
|
2594
|
-
}
|
|
2594
|
+
};
|
|
2595
2595
|
/**
|
|
2596
2596
|
* This interface was referenced by `User`'s JSON-Schema
|
|
2597
2597
|
* via the `update.schema` link.
|
|
2598
2598
|
*/
|
|
2599
|
-
export
|
|
2599
|
+
export declare type UserUpdateSchema = {
|
|
2600
2600
|
id?: UserIdentity;
|
|
2601
2601
|
type?: UserType;
|
|
2602
2602
|
/**
|
|
@@ -2604,14 +2604,14 @@ export interface UserUpdateSchema {
|
|
|
2604
2604
|
*/
|
|
2605
2605
|
is_active?: boolean;
|
|
2606
2606
|
role?: RoleData;
|
|
2607
|
-
}
|
|
2607
|
+
};
|
|
2608
2608
|
/**
|
|
2609
2609
|
* A Single Sign-On user exists when a DatoCMS project is connected to an external Identity Provider. An SSO user will not use the standard login procedure but has to go through SAML authentication. It can also be linked to one or more IdP groups.
|
|
2610
2610
|
*
|
|
2611
2611
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2612
2612
|
* via the `definition` "sso_user".
|
|
2613
2613
|
*/
|
|
2614
|
-
export
|
|
2614
|
+
export declare type SsoUser = {
|
|
2615
2615
|
id: SsoUserIdentity;
|
|
2616
2616
|
type: SsoUserType;
|
|
2617
2617
|
/**
|
|
@@ -2637,7 +2637,7 @@ export interface SsoUser {
|
|
|
2637
2637
|
groups: SsoGroupData[];
|
|
2638
2638
|
role: RoleData | null;
|
|
2639
2639
|
meta: SsoUserMeta;
|
|
2640
|
-
}
|
|
2640
|
+
};
|
|
2641
2641
|
export declare type SsoUserSelfTargetSchema = SsoUser;
|
|
2642
2642
|
export declare type SsoUserDestroyTargetSchema = SsoUser;
|
|
2643
2643
|
/**
|
|
@@ -2646,39 +2646,39 @@ export declare type SsoUserDestroyTargetSchema = SsoUser;
|
|
|
2646
2646
|
* This interface was referenced by `SsoGroup`'s JSON-Schema
|
|
2647
2647
|
* via the `definition` "data".
|
|
2648
2648
|
*/
|
|
2649
|
-
export
|
|
2649
|
+
export declare type SsoGroupData = {
|
|
2650
2650
|
type: SsoGroupType;
|
|
2651
2651
|
id: SsoGroupIdentity;
|
|
2652
|
-
}
|
|
2652
|
+
};
|
|
2653
2653
|
/**
|
|
2654
2654
|
* Meta information on the user
|
|
2655
2655
|
*
|
|
2656
2656
|
* This interface was referenced by `SsoUser`'s JSON-Schema
|
|
2657
2657
|
* via the `definition` "meta".
|
|
2658
2658
|
*/
|
|
2659
|
-
export
|
|
2659
|
+
export declare type SsoUserMeta = {
|
|
2660
2660
|
/**
|
|
2661
2661
|
* Date of last reading/interaction
|
|
2662
2662
|
*/
|
|
2663
2663
|
last_access: string | null;
|
|
2664
|
-
}
|
|
2664
|
+
};
|
|
2665
2665
|
/**
|
|
2666
2666
|
* JSON API data
|
|
2667
2667
|
*
|
|
2668
2668
|
* This interface was referenced by `SsoUser`'s JSON-Schema
|
|
2669
2669
|
* via the `definition` "data".
|
|
2670
2670
|
*/
|
|
2671
|
-
export
|
|
2671
|
+
export declare type SsoUserData = {
|
|
2672
2672
|
type: SsoUserType;
|
|
2673
2673
|
id: SsoUserIdentity;
|
|
2674
|
-
}
|
|
2674
|
+
};
|
|
2675
2675
|
/**
|
|
2676
2676
|
* JSON API attributes
|
|
2677
2677
|
*
|
|
2678
2678
|
* This interface was referenced by `SsoUser`'s JSON-Schema
|
|
2679
2679
|
* via the `definition` "attributes".
|
|
2680
2680
|
*/
|
|
2681
|
-
export
|
|
2681
|
+
export declare type SsoUserAttributes = {
|
|
2682
2682
|
/**
|
|
2683
2683
|
* Email
|
|
2684
2684
|
*/
|
|
@@ -2699,24 +2699,24 @@ export interface SsoUserAttributes {
|
|
|
2699
2699
|
* Last name
|
|
2700
2700
|
*/
|
|
2701
2701
|
last_name: string | null;
|
|
2702
|
-
}
|
|
2702
|
+
};
|
|
2703
2703
|
/**
|
|
2704
2704
|
* JSON API links
|
|
2705
2705
|
*
|
|
2706
2706
|
* This interface was referenced by `SsoUser`'s JSON-Schema
|
|
2707
2707
|
* via the `definition` "relationships".
|
|
2708
2708
|
*/
|
|
2709
|
-
export
|
|
2709
|
+
export declare type SsoUserRelationships = {
|
|
2710
2710
|
groups: SsoGroupData[];
|
|
2711
2711
|
role: RoleData | null;
|
|
2712
|
-
}
|
|
2712
|
+
};
|
|
2713
2713
|
/**
|
|
2714
2714
|
* If the Audit log functionality is enabled in a project, logged events can be queried using SQL-like language and fetched in full detail so that they can be exported or analyzed.
|
|
2715
2715
|
*
|
|
2716
2716
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2717
2717
|
* via the `definition` "audit_log_event".
|
|
2718
2718
|
*/
|
|
2719
|
-
export
|
|
2719
|
+
export declare type AuditLogEvent = {
|
|
2720
2720
|
id: AuditLogEventIdentity;
|
|
2721
2721
|
type: AuditLogEventType;
|
|
2722
2722
|
/**
|
|
@@ -2805,36 +2805,36 @@ export interface AuditLogEvent {
|
|
|
2805
2805
|
};
|
|
2806
2806
|
};
|
|
2807
2807
|
meta: AuditLogEventMeta;
|
|
2808
|
-
}
|
|
2808
|
+
};
|
|
2809
2809
|
/**
|
|
2810
2810
|
* JSON API meta
|
|
2811
2811
|
*
|
|
2812
2812
|
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2813
2813
|
* via the `definition` "meta".
|
|
2814
2814
|
*/
|
|
2815
|
-
export
|
|
2815
|
+
export declare type AuditLogEventMeta = {
|
|
2816
2816
|
/**
|
|
2817
2817
|
* The date of the event
|
|
2818
2818
|
*/
|
|
2819
2819
|
occurred_at: string;
|
|
2820
|
-
}
|
|
2820
|
+
};
|
|
2821
2821
|
/**
|
|
2822
2822
|
* JSON API data
|
|
2823
2823
|
*
|
|
2824
2824
|
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2825
2825
|
* via the `definition` "data".
|
|
2826
2826
|
*/
|
|
2827
|
-
export
|
|
2827
|
+
export declare type AuditLogEventData = {
|
|
2828
2828
|
type: AuditLogEventType;
|
|
2829
2829
|
id: AuditLogEventIdentity;
|
|
2830
|
-
}
|
|
2830
|
+
};
|
|
2831
2831
|
/**
|
|
2832
2832
|
* JSON API attributes
|
|
2833
2833
|
*
|
|
2834
2834
|
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2835
2835
|
* via the `definition` "attributes".
|
|
2836
2836
|
*/
|
|
2837
|
-
export
|
|
2837
|
+
export declare type AuditLogEventAttributes = {
|
|
2838
2838
|
/**
|
|
2839
2839
|
* The actual action performed
|
|
2840
2840
|
*/
|
|
@@ -2920,12 +2920,12 @@ export interface AuditLogEventAttributes {
|
|
|
2920
2920
|
[k: string]: unknown;
|
|
2921
2921
|
};
|
|
2922
2922
|
};
|
|
2923
|
-
}
|
|
2923
|
+
};
|
|
2924
2924
|
/**
|
|
2925
2925
|
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
2926
2926
|
* via the `query.schema` link.
|
|
2927
2927
|
*/
|
|
2928
|
-
export
|
|
2928
|
+
export declare type AuditLogEventQuerySchema = {
|
|
2929
2929
|
/**
|
|
2930
2930
|
* JSON API type field
|
|
2931
2931
|
*/
|
|
@@ -2942,14 +2942,14 @@ export interface AuditLogEventQuerySchema {
|
|
|
2942
2942
|
* Whether a detailed log complete with full request and response payload must be returned or not
|
|
2943
2943
|
*/
|
|
2944
2944
|
detailed_log?: boolean;
|
|
2945
|
-
}
|
|
2945
|
+
};
|
|
2946
2946
|
/**
|
|
2947
2947
|
* DatoCMS account
|
|
2948
2948
|
*
|
|
2949
2949
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
2950
2950
|
* via the `definition` "account".
|
|
2951
2951
|
*/
|
|
2952
|
-
export
|
|
2952
|
+
export declare type Account = {
|
|
2953
2953
|
id: AccountIdentity;
|
|
2954
2954
|
type: AccountType;
|
|
2955
2955
|
/**
|
|
@@ -2972,24 +2972,24 @@ export interface Account {
|
|
|
2972
2972
|
* Password
|
|
2973
2973
|
*/
|
|
2974
2974
|
password?: string;
|
|
2975
|
-
}
|
|
2975
|
+
};
|
|
2976
2976
|
/**
|
|
2977
2977
|
* JSON API data
|
|
2978
2978
|
*
|
|
2979
2979
|
* This interface was referenced by `Account`'s JSON-Schema
|
|
2980
2980
|
* via the `definition` "data".
|
|
2981
2981
|
*/
|
|
2982
|
-
export
|
|
2982
|
+
export declare type AccountData = {
|
|
2983
2983
|
type: AccountType;
|
|
2984
2984
|
id: AccountIdentity;
|
|
2985
|
-
}
|
|
2985
|
+
};
|
|
2986
2986
|
/**
|
|
2987
2987
|
* JSON API attributes
|
|
2988
2988
|
*
|
|
2989
2989
|
* This interface was referenced by `Account`'s JSON-Schema
|
|
2990
2990
|
* via the `definition` "attributes".
|
|
2991
2991
|
*/
|
|
2992
|
-
export
|
|
2992
|
+
export declare type AccountAttributes = {
|
|
2993
2993
|
/**
|
|
2994
2994
|
* Email
|
|
2995
2995
|
*/
|
|
@@ -3010,14 +3010,14 @@ export interface AccountAttributes {
|
|
|
3010
3010
|
* Password
|
|
3011
3011
|
*/
|
|
3012
3012
|
password?: string;
|
|
3013
|
-
}
|
|
3013
|
+
};
|
|
3014
3014
|
/**
|
|
3015
3015
|
* Stores the information regarding the current plan for the project.
|
|
3016
3016
|
*
|
|
3017
3017
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3018
3018
|
* via the `definition` "site_plan".
|
|
3019
3019
|
*/
|
|
3020
|
-
export
|
|
3020
|
+
export declare type SitePlan = {
|
|
3021
3021
|
id: SitePlanIdentity;
|
|
3022
3022
|
type: SitePlanType;
|
|
3023
3023
|
/**
|
|
@@ -3218,24 +3218,24 @@ export interface SitePlan {
|
|
|
3218
3218
|
price: number;
|
|
3219
3219
|
};
|
|
3220
3220
|
};
|
|
3221
|
-
}
|
|
3221
|
+
};
|
|
3222
3222
|
/**
|
|
3223
3223
|
* JSON API data
|
|
3224
3224
|
*
|
|
3225
3225
|
* This interface was referenced by `SitePlan`'s JSON-Schema
|
|
3226
3226
|
* via the `definition` "data".
|
|
3227
3227
|
*/
|
|
3228
|
-
export
|
|
3228
|
+
export declare type SitePlanData = {
|
|
3229
3229
|
type: SitePlanType;
|
|
3230
3230
|
id: SitePlanIdentity;
|
|
3231
|
-
}
|
|
3231
|
+
};
|
|
3232
3232
|
/**
|
|
3233
3233
|
* JSON API attributes
|
|
3234
3234
|
*
|
|
3235
3235
|
* This interface was referenced by `SitePlan`'s JSON-Schema
|
|
3236
3236
|
* via the `definition` "attributes".
|
|
3237
3237
|
*/
|
|
3238
|
-
export
|
|
3238
|
+
export declare type SitePlanAttributes = {
|
|
3239
3239
|
/**
|
|
3240
3240
|
* The name of the plan
|
|
3241
3241
|
*/
|
|
@@ -3434,14 +3434,14 @@ export interface SitePlanAttributes {
|
|
|
3434
3434
|
price: number;
|
|
3435
3435
|
};
|
|
3436
3436
|
};
|
|
3437
|
-
}
|
|
3437
|
+
};
|
|
3438
3438
|
/**
|
|
3439
3439
|
* In DatoCMS you can organize the different Models present in your administrative area reordering and grouping them, so that their purpose will be more clear to the final editor.
|
|
3440
3440
|
*
|
|
3441
3441
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3442
3442
|
* via the `definition` "menu_item".
|
|
3443
3443
|
*/
|
|
3444
|
-
export
|
|
3444
|
+
export declare type MenuItem = {
|
|
3445
3445
|
id: MenuItemIdentity;
|
|
3446
3446
|
type: MenuItemType;
|
|
3447
3447
|
/**
|
|
@@ -3463,7 +3463,7 @@ export interface MenuItem {
|
|
|
3463
3463
|
item_type: ItemTypeData | null;
|
|
3464
3464
|
parent: null | MenuItemData;
|
|
3465
3465
|
children: MenuItemData[];
|
|
3466
|
-
}
|
|
3466
|
+
};
|
|
3467
3467
|
export declare type MenuItemCreateTargetSchema = MenuItem;
|
|
3468
3468
|
export declare type MenuItemUpdateTargetSchema = MenuItem;
|
|
3469
3469
|
export declare type MenuItemSelfTargetSchema = MenuItem;
|
|
@@ -3474,27 +3474,27 @@ export declare type MenuItemDestroyTargetSchema = MenuItem;
|
|
|
3474
3474
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3475
3475
|
* via the `definition` "data".
|
|
3476
3476
|
*/
|
|
3477
|
-
export
|
|
3477
|
+
export declare type ItemTypeData = {
|
|
3478
3478
|
type: ItemTypeType;
|
|
3479
3479
|
id: ItemTypeIdentity;
|
|
3480
|
-
}
|
|
3480
|
+
};
|
|
3481
3481
|
/**
|
|
3482
3482
|
* JSON API data
|
|
3483
3483
|
*
|
|
3484
3484
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
3485
3485
|
* via the `definition` "data".
|
|
3486
3486
|
*/
|
|
3487
|
-
export
|
|
3487
|
+
export declare type MenuItemData = {
|
|
3488
3488
|
type: MenuItemType;
|
|
3489
3489
|
id: MenuItemIdentity;
|
|
3490
|
-
}
|
|
3490
|
+
};
|
|
3491
3491
|
/**
|
|
3492
3492
|
* JSON API attributes
|
|
3493
3493
|
*
|
|
3494
3494
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
3495
3495
|
* via the `definition` "attributes".
|
|
3496
3496
|
*/
|
|
3497
|
-
export
|
|
3497
|
+
export declare type MenuItemAttributes = {
|
|
3498
3498
|
/**
|
|
3499
3499
|
* The label of the menu item
|
|
3500
3500
|
*/
|
|
@@ -3511,23 +3511,23 @@ export interface MenuItemAttributes {
|
|
|
3511
3511
|
* Opens link in new tab (used together with `external_url`)
|
|
3512
3512
|
*/
|
|
3513
3513
|
open_in_new_tab: boolean;
|
|
3514
|
-
}
|
|
3514
|
+
};
|
|
3515
3515
|
/**
|
|
3516
3516
|
* JSON API links
|
|
3517
3517
|
*
|
|
3518
3518
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
3519
3519
|
* via the `definition` "relationships".
|
|
3520
3520
|
*/
|
|
3521
|
-
export
|
|
3521
|
+
export declare type MenuItemRelationships = {
|
|
3522
3522
|
item_type: ItemTypeData | null;
|
|
3523
3523
|
parent: null | MenuItemData;
|
|
3524
3524
|
children: MenuItemData[];
|
|
3525
|
-
}
|
|
3525
|
+
};
|
|
3526
3526
|
/**
|
|
3527
3527
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
3528
3528
|
* via the `create.schema` link.
|
|
3529
3529
|
*/
|
|
3530
|
-
export
|
|
3530
|
+
export declare type MenuItemCreateSchema = {
|
|
3531
3531
|
type?: MenuItemType;
|
|
3532
3532
|
/**
|
|
3533
3533
|
* The label of the menu item
|
|
@@ -3547,12 +3547,12 @@ export interface MenuItemCreateSchema {
|
|
|
3547
3547
|
open_in_new_tab?: boolean;
|
|
3548
3548
|
item_type?: ItemTypeData | null;
|
|
3549
3549
|
parent?: null | MenuItemData;
|
|
3550
|
-
}
|
|
3550
|
+
};
|
|
3551
3551
|
/**
|
|
3552
3552
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
3553
3553
|
* via the `update.schema` link.
|
|
3554
3554
|
*/
|
|
3555
|
-
export
|
|
3555
|
+
export declare type MenuItemUpdateSchema = {
|
|
3556
3556
|
id?: MenuItemIdentity;
|
|
3557
3557
|
type?: MenuItemType;
|
|
3558
3558
|
/**
|
|
@@ -3573,14 +3573,14 @@ export interface MenuItemUpdateSchema {
|
|
|
3573
3573
|
open_in_new_tab?: boolean;
|
|
3574
3574
|
item_type?: ItemTypeData | null;
|
|
3575
3575
|
parent?: null | MenuItemData;
|
|
3576
|
-
}
|
|
3576
|
+
};
|
|
3577
3577
|
/**
|
|
3578
3578
|
* The way you define the kind of content you can edit inside your administrative area passes through the concept of Models, which are much like database tables. For backward-compatibility reasons, the API refers to models as "item types".
|
|
3579
3579
|
*
|
|
3580
3580
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3581
3581
|
* via the `definition` "item_type".
|
|
3582
3582
|
*/
|
|
3583
|
-
export
|
|
3583
|
+
export declare type ItemType = {
|
|
3584
3584
|
id: ItemTypeIdentity;
|
|
3585
3585
|
type: ItemTypeType;
|
|
3586
3586
|
/**
|
|
@@ -3646,7 +3646,7 @@ export interface ItemType {
|
|
|
3646
3646
|
excerpt_field: FieldData | null;
|
|
3647
3647
|
ordering_field: FieldData | null;
|
|
3648
3648
|
workflow: WorkflowData | null;
|
|
3649
|
-
}
|
|
3649
|
+
};
|
|
3650
3650
|
export declare type ItemTypeCreateTargetSchema = ItemType;
|
|
3651
3651
|
export declare type ItemTypeUpdateJobSchema = ItemType;
|
|
3652
3652
|
export declare type ItemTypeSelfTargetSchema = ItemType;
|
|
@@ -3658,37 +3658,37 @@ export declare type ItemTypeDestroyJobSchema = ItemType;
|
|
|
3658
3658
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
3659
3659
|
* via the `definition` "data".
|
|
3660
3660
|
*/
|
|
3661
|
-
export
|
|
3661
|
+
export declare type ItemData = {
|
|
3662
3662
|
type: ItemType1;
|
|
3663
3663
|
id: ItemIdentity;
|
|
3664
|
-
}
|
|
3664
|
+
};
|
|
3665
3665
|
/**
|
|
3666
3666
|
* JSON API data
|
|
3667
3667
|
*
|
|
3668
3668
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
3669
3669
|
* via the `definition` "data".
|
|
3670
3670
|
*/
|
|
3671
|
-
export
|
|
3671
|
+
export declare type FieldData = {
|
|
3672
3672
|
type: FieldType;
|
|
3673
3673
|
id: FieldIdentity;
|
|
3674
|
-
}
|
|
3674
|
+
};
|
|
3675
3675
|
/**
|
|
3676
3676
|
* JSON API data
|
|
3677
3677
|
*
|
|
3678
3678
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
3679
3679
|
* via the `definition` "data".
|
|
3680
3680
|
*/
|
|
3681
|
-
export
|
|
3681
|
+
export declare type WorkflowData = {
|
|
3682
3682
|
type: WorkflowType;
|
|
3683
3683
|
id: WorkflowIdentity;
|
|
3684
|
-
}
|
|
3684
|
+
};
|
|
3685
3685
|
/**
|
|
3686
3686
|
* JSON API attributes
|
|
3687
3687
|
*
|
|
3688
3688
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3689
3689
|
* via the `definition` "attributes".
|
|
3690
3690
|
*/
|
|
3691
|
-
export
|
|
3691
|
+
export declare type ItemTypeAttributes = {
|
|
3692
3692
|
/**
|
|
3693
3693
|
* Name of the model
|
|
3694
3694
|
*/
|
|
@@ -3745,14 +3745,14 @@ export interface ItemTypeAttributes {
|
|
|
3745
3745
|
* A hint shown to editors to help them understand the purpose of this model/block
|
|
3746
3746
|
*/
|
|
3747
3747
|
hint: string | null;
|
|
3748
|
-
}
|
|
3748
|
+
};
|
|
3749
3749
|
/**
|
|
3750
3750
|
* JSON API links
|
|
3751
3751
|
*
|
|
3752
3752
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3753
3753
|
* via the `definition` "relationships".
|
|
3754
3754
|
*/
|
|
3755
|
-
export
|
|
3755
|
+
export declare type ItemTypeRelationships = {
|
|
3756
3756
|
singleton_item: ItemData | null;
|
|
3757
3757
|
fields: FieldData[];
|
|
3758
3758
|
title_field: FieldData | null;
|
|
@@ -3760,12 +3760,12 @@ export interface ItemTypeRelationships {
|
|
|
3760
3760
|
excerpt_field: FieldData | null;
|
|
3761
3761
|
ordering_field: FieldData | null;
|
|
3762
3762
|
workflow: WorkflowData | null;
|
|
3763
|
-
}
|
|
3763
|
+
};
|
|
3764
3764
|
/**
|
|
3765
3765
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3766
3766
|
* via the `create.schema` link.
|
|
3767
3767
|
*/
|
|
3768
|
-
export
|
|
3768
|
+
export declare type ItemTypeCreateSchema = {
|
|
3769
3769
|
type?: ItemTypeType;
|
|
3770
3770
|
/**
|
|
3771
3771
|
* Name of the model
|
|
@@ -3824,12 +3824,12 @@ export interface ItemTypeCreateSchema {
|
|
|
3824
3824
|
image_preview_field?: FieldData | null;
|
|
3825
3825
|
excerpt_field?: FieldData | null;
|
|
3826
3826
|
workflow?: WorkflowData | null;
|
|
3827
|
-
}
|
|
3827
|
+
};
|
|
3828
3828
|
/**
|
|
3829
3829
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3830
3830
|
* via the `update.schema` link.
|
|
3831
3831
|
*/
|
|
3832
|
-
export
|
|
3832
|
+
export declare type ItemTypeUpdateSchema = {
|
|
3833
3833
|
id?: ItemTypeIdentity;
|
|
3834
3834
|
type?: ItemTypeType;
|
|
3835
3835
|
/**
|
|
@@ -3893,7 +3893,7 @@ export interface ItemTypeUpdateSchema {
|
|
|
3893
3893
|
image_preview_field?: FieldData | null;
|
|
3894
3894
|
excerpt_field?: FieldData | null;
|
|
3895
3895
|
workflow?: WorkflowData | null;
|
|
3896
|
-
}
|
|
3896
|
+
};
|
|
3897
3897
|
/**
|
|
3898
3898
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
3899
3899
|
* via the `update.targetSchema` link.
|
|
@@ -3967,10 +3967,10 @@ export interface ItemTypeUpdateSchema {
|
|
|
3967
3967
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3968
3968
|
* via the `definition` "job".
|
|
3969
3969
|
*/
|
|
3970
|
-
export
|
|
3970
|
+
export declare type Job = {
|
|
3971
3971
|
id: JobIdentity;
|
|
3972
3972
|
type: JobType;
|
|
3973
|
-
}
|
|
3973
|
+
};
|
|
3974
3974
|
export declare type ItemTypeUpdateTargetSchema = Job;
|
|
3975
3975
|
export declare type ItemTypeDestroyTargetSchema = Job;
|
|
3976
3976
|
export declare type FieldCreateTargetSchema = Job;
|
|
@@ -4000,17 +4000,17 @@ export declare type SiteUpdateTargetSchema = Job;
|
|
|
4000
4000
|
* This interface was referenced by `Job`'s JSON-Schema
|
|
4001
4001
|
* via the `definition` "data".
|
|
4002
4002
|
*/
|
|
4003
|
-
export
|
|
4003
|
+
export declare type JobData = {
|
|
4004
4004
|
type: JobType;
|
|
4005
4005
|
id: JobIdentity;
|
|
4006
|
-
}
|
|
4006
|
+
};
|
|
4007
4007
|
/**
|
|
4008
4008
|
* Each Model consists of a set of fields. Using the database metaphore, fields are like table columns, and when creating them you need to specify their type (`string`, `file`, `float`, etc.) and any required validation.
|
|
4009
4009
|
*
|
|
4010
4010
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4011
4011
|
* via the `definition` "field".
|
|
4012
4012
|
*/
|
|
4013
|
-
export
|
|
4013
|
+
export declare type Field = {
|
|
4014
4014
|
id: FieldIdentity;
|
|
4015
4015
|
type: FieldType;
|
|
4016
4016
|
/**
|
|
@@ -4098,7 +4098,7 @@ export interface Field {
|
|
|
4098
4098
|
position: number;
|
|
4099
4099
|
item_type: ItemTypeData;
|
|
4100
4100
|
fieldset: null | FieldsetData;
|
|
4101
|
-
}
|
|
4101
|
+
};
|
|
4102
4102
|
export declare type FieldCreateJobSchema = Field;
|
|
4103
4103
|
export declare type FieldUpdateJobSchema = Field;
|
|
4104
4104
|
export declare type FieldSelfTargetSchema = Field;
|
|
@@ -4110,17 +4110,17 @@ export declare type FieldDuplicateJobSchema = Field;
|
|
|
4110
4110
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
4111
4111
|
* via the `definition` "data".
|
|
4112
4112
|
*/
|
|
4113
|
-
export
|
|
4113
|
+
export declare type FieldsetData = {
|
|
4114
4114
|
type: FieldsetType;
|
|
4115
4115
|
id: FieldsetIdentity;
|
|
4116
|
-
}
|
|
4116
|
+
};
|
|
4117
4117
|
/**
|
|
4118
4118
|
* JSON API attributes
|
|
4119
4119
|
*
|
|
4120
4120
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
4121
4121
|
* via the `definition` "attributes".
|
|
4122
4122
|
*/
|
|
4123
|
-
export
|
|
4123
|
+
export declare type FieldAttributes = {
|
|
4124
4124
|
/**
|
|
4125
4125
|
* The label of the field
|
|
4126
4126
|
*/
|
|
@@ -4204,22 +4204,22 @@ export interface FieldAttributes {
|
|
|
4204
4204
|
* Ordering index
|
|
4205
4205
|
*/
|
|
4206
4206
|
position: number;
|
|
4207
|
-
}
|
|
4207
|
+
};
|
|
4208
4208
|
/**
|
|
4209
4209
|
* JSON API links
|
|
4210
4210
|
*
|
|
4211
4211
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
4212
4212
|
* via the `definition` "relationships".
|
|
4213
4213
|
*/
|
|
4214
|
-
export
|
|
4214
|
+
export declare type FieldRelationships = {
|
|
4215
4215
|
item_type: ItemTypeData;
|
|
4216
4216
|
fieldset: null | FieldsetData;
|
|
4217
|
-
}
|
|
4217
|
+
};
|
|
4218
4218
|
/**
|
|
4219
4219
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
4220
4220
|
* via the `create.schema` link.
|
|
4221
4221
|
*/
|
|
4222
|
-
export
|
|
4222
|
+
export declare type FieldCreateSchema = {
|
|
4223
4223
|
type?: FieldType;
|
|
4224
4224
|
/**
|
|
4225
4225
|
* The label of the field
|
|
@@ -4305,12 +4305,12 @@ export interface FieldCreateSchema {
|
|
|
4305
4305
|
[k: string]: unknown;
|
|
4306
4306
|
};
|
|
4307
4307
|
fieldset?: null | FieldsetData;
|
|
4308
|
-
}
|
|
4308
|
+
};
|
|
4309
4309
|
/**
|
|
4310
4310
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
4311
4311
|
* via the `update.schema` link.
|
|
4312
4312
|
*/
|
|
4313
|
-
export
|
|
4313
|
+
export declare type FieldUpdateSchema = {
|
|
4314
4314
|
id?: FieldIdentity;
|
|
4315
4315
|
type?: FieldType;
|
|
4316
4316
|
/**
|
|
@@ -4397,14 +4397,14 @@ export interface FieldUpdateSchema {
|
|
|
4397
4397
|
*/
|
|
4398
4398
|
hint?: string | null;
|
|
4399
4399
|
fieldset?: null | FieldsetData;
|
|
4400
|
-
}
|
|
4400
|
+
};
|
|
4401
4401
|
/**
|
|
4402
4402
|
* Fields can be organized and grouped into fieldset to better present them to editors.
|
|
4403
4403
|
*
|
|
4404
4404
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4405
4405
|
* via the `definition` "fieldset".
|
|
4406
4406
|
*/
|
|
4407
|
-
export
|
|
4407
|
+
export declare type Fieldset = {
|
|
4408
4408
|
id: FieldsetIdentity;
|
|
4409
4409
|
type: FieldsetType;
|
|
4410
4410
|
/**
|
|
@@ -4428,7 +4428,7 @@ export interface Fieldset {
|
|
|
4428
4428
|
*/
|
|
4429
4429
|
position: number;
|
|
4430
4430
|
item_type: ItemTypeData;
|
|
4431
|
-
}
|
|
4431
|
+
};
|
|
4432
4432
|
export declare type FieldsetCreateTargetSchema = Fieldset;
|
|
4433
4433
|
export declare type FieldsetUpdateTargetSchema = Fieldset;
|
|
4434
4434
|
export declare type FieldsetSelfTargetSchema = Fieldset;
|
|
@@ -4439,7 +4439,7 @@ export declare type FieldsetDestroyTargetSchema = Fieldset;
|
|
|
4439
4439
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
4440
4440
|
* via the `definition` "attributes".
|
|
4441
4441
|
*/
|
|
4442
|
-
export
|
|
4442
|
+
export declare type FieldsetAttributes = {
|
|
4443
4443
|
/**
|
|
4444
4444
|
* The title of the fieldset
|
|
4445
4445
|
*/
|
|
@@ -4460,21 +4460,21 @@ export interface FieldsetAttributes {
|
|
|
4460
4460
|
* Ordering index
|
|
4461
4461
|
*/
|
|
4462
4462
|
position: number;
|
|
4463
|
-
}
|
|
4463
|
+
};
|
|
4464
4464
|
/**
|
|
4465
4465
|
* JSON API links
|
|
4466
4466
|
*
|
|
4467
4467
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
4468
4468
|
* via the `definition` "relationships".
|
|
4469
4469
|
*/
|
|
4470
|
-
export
|
|
4470
|
+
export declare type FieldsetRelationships = {
|
|
4471
4471
|
item_type: ItemTypeData;
|
|
4472
|
-
}
|
|
4472
|
+
};
|
|
4473
4473
|
/**
|
|
4474
4474
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
4475
4475
|
* via the `create.schema` link.
|
|
4476
4476
|
*/
|
|
4477
|
-
export
|
|
4477
|
+
export declare type FieldsetCreateSchema = {
|
|
4478
4478
|
type?: FieldsetType;
|
|
4479
4479
|
/**
|
|
4480
4480
|
* The title of the fieldset
|
|
@@ -4496,12 +4496,12 @@ export interface FieldsetCreateSchema {
|
|
|
4496
4496
|
* When fieldset is collapsible, determines if the default is to start collapsed or not
|
|
4497
4497
|
*/
|
|
4498
4498
|
start_collapsed?: boolean;
|
|
4499
|
-
}
|
|
4499
|
+
};
|
|
4500
4500
|
/**
|
|
4501
4501
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
4502
4502
|
* via the `update.schema` link.
|
|
4503
4503
|
*/
|
|
4504
|
-
export
|
|
4504
|
+
export declare type FieldsetUpdateSchema = {
|
|
4505
4505
|
id?: FieldsetIdentity;
|
|
4506
4506
|
type?: FieldsetType;
|
|
4507
4507
|
/**
|
|
@@ -4524,18 +4524,18 @@ export interface FieldsetUpdateSchema {
|
|
|
4524
4524
|
* When fieldset is collapsible, determines if the default is to start collapsed or not
|
|
4525
4525
|
*/
|
|
4526
4526
|
start_collapsed?: boolean;
|
|
4527
|
-
}
|
|
4527
|
+
};
|
|
4528
4528
|
/**
|
|
4529
4529
|
* A session is required to access to read-and-write API endpoints
|
|
4530
4530
|
*
|
|
4531
4531
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4532
4532
|
* via the `definition` "session".
|
|
4533
4533
|
*/
|
|
4534
|
-
export
|
|
4534
|
+
export declare type Session = {
|
|
4535
4535
|
id: SessionIdentity;
|
|
4536
4536
|
type: SessionType;
|
|
4537
4537
|
user: UserData;
|
|
4538
|
-
}
|
|
4538
|
+
};
|
|
4539
4539
|
export declare type SessionCreateTargetSchema = Session;
|
|
4540
4540
|
/**
|
|
4541
4541
|
* JSON API data
|
|
@@ -4543,24 +4543,24 @@ export declare type SessionCreateTargetSchema = Session;
|
|
|
4543
4543
|
* This interface was referenced by `Session`'s JSON-Schema
|
|
4544
4544
|
* via the `definition` "data".
|
|
4545
4545
|
*/
|
|
4546
|
-
export
|
|
4546
|
+
export declare type SessionData = {
|
|
4547
4547
|
type: SessionType;
|
|
4548
4548
|
id: SessionIdentity;
|
|
4549
|
-
}
|
|
4549
|
+
};
|
|
4550
4550
|
/**
|
|
4551
4551
|
* JSON API links
|
|
4552
4552
|
*
|
|
4553
4553
|
* This interface was referenced by `Session`'s JSON-Schema
|
|
4554
4554
|
* via the `definition` "relationships".
|
|
4555
4555
|
*/
|
|
4556
|
-
export
|
|
4556
|
+
export declare type SessionRelationships = {
|
|
4557
4557
|
user: UserData;
|
|
4558
|
-
}
|
|
4558
|
+
};
|
|
4559
4559
|
/**
|
|
4560
4560
|
* This interface was referenced by `Session`'s JSON-Schema
|
|
4561
4561
|
* via the `create.schema` link.
|
|
4562
4562
|
*/
|
|
4563
|
-
export
|
|
4563
|
+
export declare type SessionCreateSchema = {
|
|
4564
4564
|
/**
|
|
4565
4565
|
* JSON API type field
|
|
4566
4566
|
*/
|
|
@@ -4577,14 +4577,14 @@ export interface SessionCreateSchema {
|
|
|
4577
4577
|
* Two-factor authentication one-time password
|
|
4578
4578
|
*/
|
|
4579
4579
|
otp_code?: string;
|
|
4580
|
-
}
|
|
4580
|
+
};
|
|
4581
4581
|
/**
|
|
4582
4582
|
* An API token allows access to our API. It is linked to a Role, which describes what actions can be performed.
|
|
4583
4583
|
*
|
|
4584
4584
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4585
4585
|
* via the `definition` "access_token".
|
|
4586
4586
|
*/
|
|
4587
|
-
export
|
|
4587
|
+
export declare type AccessToken = {
|
|
4588
4588
|
id: AccessTokenIdentity;
|
|
4589
4589
|
type: AccessTokenType;
|
|
4590
4590
|
/**
|
|
@@ -4609,7 +4609,7 @@ export interface AccessToken {
|
|
|
4609
4609
|
can_access_cma: boolean;
|
|
4610
4610
|
hardcoded_type: null | string;
|
|
4611
4611
|
role: RoleData | null;
|
|
4612
|
-
}
|
|
4612
|
+
};
|
|
4613
4613
|
export declare type AccessTokenCreateTargetSchema = AccessToken;
|
|
4614
4614
|
export declare type AccessTokenUpdateTargetSchema = AccessToken;
|
|
4615
4615
|
export declare type AccessTokenSelfTargetSchema = AccessToken;
|
|
@@ -4621,17 +4621,17 @@ export declare type AccessTokenDestroyTargetSchema = AccessToken;
|
|
|
4621
4621
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4622
4622
|
* via the `definition` "data".
|
|
4623
4623
|
*/
|
|
4624
|
-
export
|
|
4624
|
+
export declare type AccessTokenData = {
|
|
4625
4625
|
type: AccessTokenType;
|
|
4626
4626
|
id: AccessTokenIdentity;
|
|
4627
|
-
}
|
|
4627
|
+
};
|
|
4628
4628
|
/**
|
|
4629
4629
|
* JSON API attributes
|
|
4630
4630
|
*
|
|
4631
4631
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4632
4632
|
* via the `definition` "attributes".
|
|
4633
4633
|
*/
|
|
4634
|
-
export
|
|
4634
|
+
export declare type AccessTokenAttributes = {
|
|
4635
4635
|
/**
|
|
4636
4636
|
* Name of API token
|
|
4637
4637
|
*/
|
|
@@ -4653,21 +4653,21 @@ export interface AccessTokenAttributes {
|
|
|
4653
4653
|
*/
|
|
4654
4654
|
can_access_cma: boolean;
|
|
4655
4655
|
hardcoded_type: null | string;
|
|
4656
|
-
}
|
|
4656
|
+
};
|
|
4657
4657
|
/**
|
|
4658
4658
|
* JSON API links
|
|
4659
4659
|
*
|
|
4660
4660
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4661
4661
|
* via the `definition` "relationships".
|
|
4662
4662
|
*/
|
|
4663
|
-
export
|
|
4663
|
+
export declare type AccessTokenRelationships = {
|
|
4664
4664
|
role: RoleData | null;
|
|
4665
|
-
}
|
|
4665
|
+
};
|
|
4666
4666
|
/**
|
|
4667
4667
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4668
4668
|
* via the `create.schema` link.
|
|
4669
4669
|
*/
|
|
4670
|
-
export
|
|
4670
|
+
export declare type AccessTokenCreateSchema = {
|
|
4671
4671
|
type?: AccessTokenType;
|
|
4672
4672
|
/**
|
|
4673
4673
|
* Name of API token
|
|
@@ -4686,12 +4686,12 @@ export interface AccessTokenCreateSchema {
|
|
|
4686
4686
|
*/
|
|
4687
4687
|
can_access_cma: boolean;
|
|
4688
4688
|
role: RoleData | null;
|
|
4689
|
-
}
|
|
4689
|
+
};
|
|
4690
4690
|
/**
|
|
4691
4691
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
4692
4692
|
* via the `update.schema` link.
|
|
4693
4693
|
*/
|
|
4694
|
-
export
|
|
4694
|
+
export declare type AccessTokenUpdateSchema = {
|
|
4695
4695
|
id?: AccessTokenIdentity;
|
|
4696
4696
|
type?: AccessTokenType;
|
|
4697
4697
|
/**
|
|
@@ -4711,14 +4711,14 @@ export interface AccessTokenUpdateSchema {
|
|
|
4711
4711
|
*/
|
|
4712
4712
|
can_access_cma: boolean;
|
|
4713
4713
|
role: RoleData | null;
|
|
4714
|
-
}
|
|
4714
|
+
};
|
|
4715
4715
|
/**
|
|
4716
4716
|
* Plugins enable developers to replace DatoCMS field components with HTML5 applications so the editing experiences of the DatoCMS web app can be customized.
|
|
4717
4717
|
*
|
|
4718
4718
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4719
4719
|
* via the `definition` "plugin".
|
|
4720
4720
|
*/
|
|
4721
|
-
export
|
|
4721
|
+
export declare type Plugin = {
|
|
4722
4722
|
id: PluginIdentity;
|
|
4723
4723
|
type: PluginType;
|
|
4724
4724
|
/**
|
|
@@ -4767,7 +4767,7 @@ export interface Plugin {
|
|
|
4767
4767
|
instance: unknown[];
|
|
4768
4768
|
};
|
|
4769
4769
|
meta: PluginMeta;
|
|
4770
|
-
}
|
|
4770
|
+
};
|
|
4771
4771
|
export declare type PluginCreateTargetSchema = Plugin;
|
|
4772
4772
|
export declare type PluginUpdateTargetSchema = Plugin;
|
|
4773
4773
|
export declare type PluginSelfTargetSchema = Plugin;
|
|
@@ -4778,29 +4778,29 @@ export declare type PluginDestroyTargetSchema = Plugin;
|
|
|
4778
4778
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
4779
4779
|
* via the `definition` "meta".
|
|
4780
4780
|
*/
|
|
4781
|
-
export
|
|
4781
|
+
export declare type PluginMeta = {
|
|
4782
4782
|
/**
|
|
4783
4783
|
* Version of the plugin. Legacy plugins are v1, new plugins are v2
|
|
4784
4784
|
*/
|
|
4785
4785
|
version: string;
|
|
4786
|
-
}
|
|
4786
|
+
};
|
|
4787
4787
|
/**
|
|
4788
4788
|
* JSON API data
|
|
4789
4789
|
*
|
|
4790
4790
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
4791
4791
|
* via the `definition` "data".
|
|
4792
4792
|
*/
|
|
4793
|
-
export
|
|
4793
|
+
export declare type PluginData = {
|
|
4794
4794
|
type: PluginType;
|
|
4795
4795
|
id: PluginIdentity;
|
|
4796
|
-
}
|
|
4796
|
+
};
|
|
4797
4797
|
/**
|
|
4798
4798
|
* JSON API attributes
|
|
4799
4799
|
*
|
|
4800
4800
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
4801
4801
|
* via the `definition` "attributes".
|
|
4802
4802
|
*/
|
|
4803
|
-
export
|
|
4803
|
+
export declare type PluginAttributes = {
|
|
4804
4804
|
/**
|
|
4805
4805
|
* The name of the plugin
|
|
4806
4806
|
*/
|
|
@@ -4846,12 +4846,12 @@ export interface PluginAttributes {
|
|
|
4846
4846
|
global: unknown[];
|
|
4847
4847
|
instance: unknown[];
|
|
4848
4848
|
};
|
|
4849
|
-
}
|
|
4849
|
+
};
|
|
4850
4850
|
/**
|
|
4851
4851
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
4852
4852
|
* via the `create.schema` link.
|
|
4853
4853
|
*/
|
|
4854
|
-
export
|
|
4854
|
+
export declare type PluginCreateSchema = {
|
|
4855
4855
|
type?: PluginType;
|
|
4856
4856
|
/**
|
|
4857
4857
|
* NPM package name of the public plugin you want to install. For public plugins, that's the only attribute you need to pass.
|
|
@@ -4892,12 +4892,12 @@ export interface PluginCreateSchema {
|
|
|
4892
4892
|
* NPM version of the plugin
|
|
4893
4893
|
*/
|
|
4894
4894
|
package_version?: null | string;
|
|
4895
|
-
}
|
|
4895
|
+
};
|
|
4896
4896
|
/**
|
|
4897
4897
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
4898
4898
|
* via the `update.schema` link.
|
|
4899
4899
|
*/
|
|
4900
|
-
export
|
|
4900
|
+
export declare type PluginUpdateSchema = {
|
|
4901
4901
|
id?: PluginIdentity;
|
|
4902
4902
|
type?: PluginType;
|
|
4903
4903
|
/**
|
|
@@ -4929,14 +4929,14 @@ export interface PluginUpdateSchema {
|
|
|
4929
4929
|
meta?: {
|
|
4930
4930
|
[k: string]: unknown;
|
|
4931
4931
|
};
|
|
4932
|
-
}
|
|
4932
|
+
};
|
|
4933
4933
|
/**
|
|
4934
4934
|
* Some API endpoint give results asynchronously, returning the ID of a job.
|
|
4935
4935
|
*
|
|
4936
4936
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4937
4937
|
* via the `definition` "job_result".
|
|
4938
4938
|
*/
|
|
4939
|
-
export
|
|
4939
|
+
export declare type JobResult = {
|
|
4940
4940
|
id: JobResultIdentity;
|
|
4941
4941
|
type: JobResultType;
|
|
4942
4942
|
/**
|
|
@@ -4949,7 +4949,7 @@ export interface JobResult {
|
|
|
4949
4949
|
payload: null | {
|
|
4950
4950
|
[k: string]: unknown;
|
|
4951
4951
|
};
|
|
4952
|
-
}
|
|
4952
|
+
};
|
|
4953
4953
|
export declare type JobResultSelfTargetSchema = JobResult;
|
|
4954
4954
|
/**
|
|
4955
4955
|
* JSON API data
|
|
@@ -4957,17 +4957,17 @@ export declare type JobResultSelfTargetSchema = JobResult;
|
|
|
4957
4957
|
* This interface was referenced by `JobResult`'s JSON-Schema
|
|
4958
4958
|
* via the `definition` "data".
|
|
4959
4959
|
*/
|
|
4960
|
-
export
|
|
4960
|
+
export declare type JobResultData = {
|
|
4961
4961
|
type: JobResultType;
|
|
4962
4962
|
id: JobResultIdentity;
|
|
4963
|
-
}
|
|
4963
|
+
};
|
|
4964
4964
|
/**
|
|
4965
4965
|
* JSON API attributes
|
|
4966
4966
|
*
|
|
4967
4967
|
* This interface was referenced by `JobResult`'s JSON-Schema
|
|
4968
4968
|
* via the `definition` "attributes".
|
|
4969
4969
|
*/
|
|
4970
|
-
export
|
|
4970
|
+
export declare type JobResultAttributes = {
|
|
4971
4971
|
/**
|
|
4972
4972
|
* Status of delayed HTTP response
|
|
4973
4973
|
*/
|
|
@@ -4978,12 +4978,12 @@ export interface JobResultAttributes {
|
|
|
4978
4978
|
payload: null | {
|
|
4979
4979
|
[k: string]: unknown;
|
|
4980
4980
|
};
|
|
4981
|
-
}
|
|
4981
|
+
};
|
|
4982
4982
|
/**
|
|
4983
4983
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4984
4984
|
* via the `definition` "subscription_limit".
|
|
4985
4985
|
*/
|
|
4986
|
-
export
|
|
4986
|
+
export declare type SubscriptionLimit = {
|
|
4987
4987
|
id: SubscriptionLimitIdentity;
|
|
4988
4988
|
type: SubscriptionLimitType;
|
|
4989
4989
|
/**
|
|
@@ -4998,7 +4998,7 @@ export interface SubscriptionLimit {
|
|
|
4998
4998
|
* The actual limit
|
|
4999
4999
|
*/
|
|
5000
5000
|
limit: number | null;
|
|
5001
|
-
}
|
|
5001
|
+
};
|
|
5002
5002
|
export declare type SubscriptionLimitSelfTargetSchema = SubscriptionLimit;
|
|
5003
5003
|
/**
|
|
5004
5004
|
* JSON API data
|
|
@@ -5006,17 +5006,17 @@ export declare type SubscriptionLimitSelfTargetSchema = SubscriptionLimit;
|
|
|
5006
5006
|
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema
|
|
5007
5007
|
* via the `definition` "data".
|
|
5008
5008
|
*/
|
|
5009
|
-
export
|
|
5009
|
+
export declare type SubscriptionLimitData = {
|
|
5010
5010
|
type: SubscriptionLimitType;
|
|
5011
5011
|
id: SubscriptionLimitIdentity;
|
|
5012
|
-
}
|
|
5012
|
+
};
|
|
5013
5013
|
/**
|
|
5014
5014
|
* JSON API attributes
|
|
5015
5015
|
*
|
|
5016
5016
|
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema
|
|
5017
5017
|
* via the `definition` "attributes".
|
|
5018
5018
|
*/
|
|
5019
|
-
export
|
|
5019
|
+
export declare type SubscriptionLimitAttributes = {
|
|
5020
5020
|
/**
|
|
5021
5021
|
* The codename for the limit
|
|
5022
5022
|
*/
|
|
@@ -5029,12 +5029,12 @@ export interface SubscriptionLimitAttributes {
|
|
|
5029
5029
|
* The actual limit
|
|
5030
5030
|
*/
|
|
5031
5031
|
limit: number | null;
|
|
5032
|
-
}
|
|
5032
|
+
};
|
|
5033
5033
|
/**
|
|
5034
5034
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
5035
5035
|
* via the `definition` "subscription_feature".
|
|
5036
5036
|
*/
|
|
5037
|
-
export
|
|
5037
|
+
export declare type SubscriptionFeature = {
|
|
5038
5038
|
id: SubscriptionFeatureIdentity;
|
|
5039
5039
|
type: SubscriptionFeatureType;
|
|
5040
5040
|
/**
|
|
@@ -5049,24 +5049,24 @@ export interface SubscriptionFeature {
|
|
|
5049
5049
|
* Whether the feature is available on the current project
|
|
5050
5050
|
*/
|
|
5051
5051
|
enabled: boolean;
|
|
5052
|
-
}
|
|
5052
|
+
};
|
|
5053
5053
|
/**
|
|
5054
5054
|
* JSON API data
|
|
5055
5055
|
*
|
|
5056
5056
|
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema
|
|
5057
5057
|
* via the `definition` "data".
|
|
5058
5058
|
*/
|
|
5059
|
-
export
|
|
5059
|
+
export declare type SubscriptionFeatureData = {
|
|
5060
5060
|
type: SubscriptionFeatureType;
|
|
5061
5061
|
id: SubscriptionFeatureIdentity;
|
|
5062
|
-
}
|
|
5062
|
+
};
|
|
5063
5063
|
/**
|
|
5064
5064
|
* JSON API attributes
|
|
5065
5065
|
*
|
|
5066
5066
|
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema
|
|
5067
5067
|
* via the `definition` "attributes".
|
|
5068
5068
|
*/
|
|
5069
|
-
export
|
|
5069
|
+
export declare type SubscriptionFeatureAttributes = {
|
|
5070
5070
|
/**
|
|
5071
5071
|
* The codename for the feature
|
|
5072
5072
|
*/
|
|
@@ -5079,14 +5079,14 @@ export interface SubscriptionFeatureAttributes {
|
|
|
5079
5079
|
* Whether the feature is available on the current project
|
|
5080
5080
|
*/
|
|
5081
5081
|
enabled: boolean;
|
|
5082
|
-
}
|
|
5082
|
+
};
|
|
5083
5083
|
/**
|
|
5084
5084
|
* Represents an event occurred during the deploy process of your administrative area.
|
|
5085
5085
|
*
|
|
5086
5086
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
5087
5087
|
* via the `definition` "build_event".
|
|
5088
5088
|
*/
|
|
5089
|
-
export
|
|
5089
|
+
export declare type BuildEvent = {
|
|
5090
5090
|
id: BuildEventIdentity;
|
|
5091
5091
|
type: BuildEventType;
|
|
5092
5092
|
/**
|
|
@@ -5104,7 +5104,7 @@ export interface BuildEvent {
|
|
|
5104
5104
|
[k: string]: unknown;
|
|
5105
5105
|
};
|
|
5106
5106
|
build_trigger: BuildTriggerData;
|
|
5107
|
-
}
|
|
5107
|
+
};
|
|
5108
5108
|
export declare type BuildEventSelfTargetSchema = BuildEvent;
|
|
5109
5109
|
/**
|
|
5110
5110
|
* JSON API data
|
|
@@ -5112,27 +5112,27 @@ export declare type BuildEventSelfTargetSchema = BuildEvent;
|
|
|
5112
5112
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
5113
5113
|
* via the `definition` "data".
|
|
5114
5114
|
*/
|
|
5115
|
-
export
|
|
5115
|
+
export declare type BuildTriggerData = {
|
|
5116
5116
|
type: BuildTriggerType;
|
|
5117
5117
|
id: BuildTriggerIdentity;
|
|
5118
|
-
}
|
|
5118
|
+
};
|
|
5119
5119
|
/**
|
|
5120
5120
|
* JSON API data
|
|
5121
5121
|
*
|
|
5122
5122
|
* This interface was referenced by `BuildEvent`'s JSON-Schema
|
|
5123
5123
|
* via the `definition` "data".
|
|
5124
5124
|
*/
|
|
5125
|
-
export
|
|
5125
|
+
export declare type BuildEventData = {
|
|
5126
5126
|
type: BuildEventType;
|
|
5127
5127
|
id: BuildEventIdentity;
|
|
5128
|
-
}
|
|
5128
|
+
};
|
|
5129
5129
|
/**
|
|
5130
5130
|
* JSON API attributes
|
|
5131
5131
|
*
|
|
5132
5132
|
* This interface was referenced by `BuildEvent`'s JSON-Schema
|
|
5133
5133
|
* via the `definition` "attributes".
|
|
5134
5134
|
*/
|
|
5135
|
-
export
|
|
5135
|
+
export declare type BuildEventAttributes = {
|
|
5136
5136
|
/**
|
|
5137
5137
|
* The type of activity
|
|
5138
5138
|
*/
|
|
@@ -5147,16 +5147,16 @@ export interface BuildEventAttributes {
|
|
|
5147
5147
|
data: {
|
|
5148
5148
|
[k: string]: unknown;
|
|
5149
5149
|
};
|
|
5150
|
-
}
|
|
5150
|
+
};
|
|
5151
5151
|
/**
|
|
5152
5152
|
* JSON API links
|
|
5153
5153
|
*
|
|
5154
5154
|
* This interface was referenced by `BuildEvent`'s JSON-Schema
|
|
5155
5155
|
* via the `definition` "relationships".
|
|
5156
5156
|
*/
|
|
5157
|
-
export
|
|
5157
|
+
export declare type BuildEventRelationships = {
|
|
5158
5158
|
build_trigger: BuildTriggerData;
|
|
5159
|
-
}
|
|
5159
|
+
};
|
|
5160
5160
|
/**
|
|
5161
5161
|
* DatoCMS stores the individual pieces of content you create from a model as records, which are much like table rows in a database. For backward-compatibility reasons, the API refers to records as "items".
|
|
5162
5162
|
*
|
|
@@ -5169,14 +5169,14 @@ export interface BuildEventRelationships {
|
|
|
5169
5169
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
5170
5170
|
* via the `definition` "item".
|
|
5171
5171
|
*/
|
|
5172
|
-
export
|
|
5172
|
+
export declare type Item = {
|
|
5173
5173
|
id: ItemIdentity;
|
|
5174
5174
|
type: ItemType1;
|
|
5175
5175
|
item_type: ItemTypeData;
|
|
5176
5176
|
creator?: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5177
5177
|
meta: ItemMeta;
|
|
5178
5178
|
[k: string]: unknown;
|
|
5179
|
-
}
|
|
5179
|
+
};
|
|
5180
5180
|
export declare type ItemCreateTargetSchema = Item;
|
|
5181
5181
|
export declare type ItemDuplicateJobSchema = Item;
|
|
5182
5182
|
export declare type ItemUpdateTargetSchema = Item;
|
|
@@ -5192,7 +5192,7 @@ export declare type ScheduledUnpublishingDestroyTargetSchema = Item;
|
|
|
5192
5192
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5193
5193
|
* via the `definition` "meta".
|
|
5194
5194
|
*/
|
|
5195
|
-
export
|
|
5195
|
+
export declare type ItemMeta = {
|
|
5196
5196
|
/**
|
|
5197
5197
|
* Date of creation
|
|
5198
5198
|
*/
|
|
@@ -5233,51 +5233,51 @@ export interface ItemMeta {
|
|
|
5233
5233
|
* Workflow stage in which the item is
|
|
5234
5234
|
*/
|
|
5235
5235
|
stage: null | string;
|
|
5236
|
-
}
|
|
5236
|
+
};
|
|
5237
5237
|
/**
|
|
5238
5238
|
* The JSON data associated to the record
|
|
5239
5239
|
*
|
|
5240
5240
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5241
5241
|
* via the `definition` "attributes".
|
|
5242
5242
|
*/
|
|
5243
|
-
export
|
|
5243
|
+
export declare type ItemAttributes = {
|
|
5244
5244
|
[k: string]: unknown;
|
|
5245
|
-
}
|
|
5245
|
+
};
|
|
5246
5246
|
/**
|
|
5247
5247
|
* JSON API links
|
|
5248
5248
|
*
|
|
5249
5249
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5250
5250
|
* via the `definition` "relationships".
|
|
5251
5251
|
*/
|
|
5252
|
-
export
|
|
5252
|
+
export declare type ItemRelationships = {
|
|
5253
5253
|
item_type: ItemTypeData;
|
|
5254
5254
|
creator?: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5255
|
-
}
|
|
5255
|
+
};
|
|
5256
5256
|
/**
|
|
5257
5257
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5258
5258
|
* via the `validate_existing.schema` link.
|
|
5259
5259
|
*/
|
|
5260
|
-
export
|
|
5260
|
+
export declare type ItemValidateExistingSchema = {
|
|
5261
5261
|
id?: ItemIdentity;
|
|
5262
5262
|
type?: ItemType1;
|
|
5263
5263
|
item_type: ItemTypeData;
|
|
5264
5264
|
creator?: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5265
5265
|
[k: string]: unknown;
|
|
5266
|
-
}
|
|
5266
|
+
};
|
|
5267
5267
|
/**
|
|
5268
5268
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5269
5269
|
* via the `validate_new.schema` link.
|
|
5270
5270
|
*/
|
|
5271
|
-
export
|
|
5271
|
+
export declare type ItemValidateNewSchema = {
|
|
5272
5272
|
type?: ItemType1;
|
|
5273
5273
|
item_type: ItemTypeData;
|
|
5274
5274
|
[k: string]: unknown;
|
|
5275
|
-
}
|
|
5275
|
+
};
|
|
5276
5276
|
/**
|
|
5277
5277
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5278
5278
|
* via the `create.schema` link.
|
|
5279
5279
|
*/
|
|
5280
|
-
export
|
|
5280
|
+
export declare type ItemCreateSchema = {
|
|
5281
5281
|
type?: ItemType1;
|
|
5282
5282
|
item_type: ItemTypeData;
|
|
5283
5283
|
/**
|
|
@@ -5318,12 +5318,12 @@ export interface ItemCreateSchema {
|
|
|
5318
5318
|
current_version?: string;
|
|
5319
5319
|
};
|
|
5320
5320
|
[k: string]: unknown;
|
|
5321
|
-
}
|
|
5321
|
+
};
|
|
5322
5322
|
/**
|
|
5323
5323
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5324
5324
|
* via the `update.schema` link.
|
|
5325
5325
|
*/
|
|
5326
|
-
export
|
|
5326
|
+
export declare type ItemUpdateSchema = {
|
|
5327
5327
|
id?: ItemIdentity;
|
|
5328
5328
|
type?: ItemType1;
|
|
5329
5329
|
item_type?: ItemTypeData;
|
|
@@ -5374,12 +5374,12 @@ export interface ItemUpdateSchema {
|
|
|
5374
5374
|
stage?: string | null;
|
|
5375
5375
|
};
|
|
5376
5376
|
[k: string]: unknown;
|
|
5377
|
-
}
|
|
5377
|
+
};
|
|
5378
5378
|
/**
|
|
5379
5379
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5380
5380
|
* via the `bulk_publish.schema` link.
|
|
5381
5381
|
*/
|
|
5382
|
-
export
|
|
5382
|
+
export declare type ItemBulkPublishSchema = {
|
|
5383
5383
|
/**
|
|
5384
5384
|
* JSON API type field
|
|
5385
5385
|
*/
|
|
@@ -5387,12 +5387,12 @@ export interface ItemBulkPublishSchema {
|
|
|
5387
5387
|
items: ItemData[];
|
|
5388
5388
|
minItems?: unknown;
|
|
5389
5389
|
[k: string]: unknown;
|
|
5390
|
-
}
|
|
5390
|
+
};
|
|
5391
5391
|
/**
|
|
5392
5392
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5393
5393
|
* via the `bulk_unpublish.schema` link.
|
|
5394
5394
|
*/
|
|
5395
|
-
export
|
|
5395
|
+
export declare type ItemBulkUnpublishSchema = {
|
|
5396
5396
|
/**
|
|
5397
5397
|
* JSON API type field
|
|
5398
5398
|
*/
|
|
@@ -5400,12 +5400,12 @@ export interface ItemBulkUnpublishSchema {
|
|
|
5400
5400
|
items: ItemData[];
|
|
5401
5401
|
minItems?: unknown;
|
|
5402
5402
|
[k: string]: unknown;
|
|
5403
|
-
}
|
|
5403
|
+
};
|
|
5404
5404
|
/**
|
|
5405
5405
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5406
5406
|
* via the `bulk_destroy.schema` link.
|
|
5407
5407
|
*/
|
|
5408
|
-
export
|
|
5408
|
+
export declare type ItemBulkDestroySchema = {
|
|
5409
5409
|
/**
|
|
5410
5410
|
* JSON API type field
|
|
5411
5411
|
*/
|
|
@@ -5413,12 +5413,12 @@ export interface ItemBulkDestroySchema {
|
|
|
5413
5413
|
items: ItemData[];
|
|
5414
5414
|
minItems?: unknown;
|
|
5415
5415
|
[k: string]: unknown;
|
|
5416
|
-
}
|
|
5416
|
+
};
|
|
5417
5417
|
/**
|
|
5418
5418
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
5419
5419
|
* via the `bulk_move_to_stage.schema` link.
|
|
5420
5420
|
*/
|
|
5421
|
-
export
|
|
5421
|
+
export declare type ItemBulkMoveToStageSchema = {
|
|
5422
5422
|
/**
|
|
5423
5423
|
* JSON API type field
|
|
5424
5424
|
*/
|
|
@@ -5429,14 +5429,14 @@ export interface ItemBulkMoveToStageSchema {
|
|
|
5429
5429
|
stage: string;
|
|
5430
5430
|
items: ItemData[];
|
|
5431
5431
|
minItems?: unknown;
|
|
5432
|
-
}
|
|
5432
|
+
};
|
|
5433
5433
|
/**
|
|
5434
5434
|
* Every change to a record is stored as a separate record version in DatoCMS.
|
|
5435
5435
|
*
|
|
5436
5436
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
5437
5437
|
* via the `definition` "item_version".
|
|
5438
5438
|
*/
|
|
5439
|
-
export
|
|
5439
|
+
export declare type ItemVersion = {
|
|
5440
5440
|
id: ItemVersionIdentity;
|
|
5441
5441
|
type: ItemVersionType;
|
|
5442
5442
|
item_type: ItemTypeData;
|
|
@@ -5444,7 +5444,7 @@ export interface ItemVersion {
|
|
|
5444
5444
|
editor: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5445
5445
|
meta: ItemVersionMeta;
|
|
5446
5446
|
[k: string]: unknown;
|
|
5447
|
-
}
|
|
5447
|
+
};
|
|
5448
5448
|
export declare type ItemVersionSelfTargetSchema = ItemVersion;
|
|
5449
5449
|
/**
|
|
5450
5450
|
* Meta information regarding the record version
|
|
@@ -5452,7 +5452,7 @@ export declare type ItemVersionSelfTargetSchema = ItemVersion;
|
|
|
5452
5452
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
5453
5453
|
* via the `definition` "meta".
|
|
5454
5454
|
*/
|
|
5455
|
-
export
|
|
5455
|
+
export declare type ItemVersionMeta = {
|
|
5456
5456
|
/**
|
|
5457
5457
|
* Date of record version creation
|
|
5458
5458
|
*/
|
|
@@ -5469,44 +5469,44 @@ export interface ItemVersionMeta {
|
|
|
5469
5469
|
* Whether the record version is the most recent version or not
|
|
5470
5470
|
*/
|
|
5471
5471
|
is_current: boolean;
|
|
5472
|
-
}
|
|
5472
|
+
};
|
|
5473
5473
|
/**
|
|
5474
5474
|
* JSON API data
|
|
5475
5475
|
*
|
|
5476
5476
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
5477
5477
|
* via the `definition` "data".
|
|
5478
5478
|
*/
|
|
5479
|
-
export
|
|
5479
|
+
export declare type ItemVersionData = {
|
|
5480
5480
|
type: ItemVersionType;
|
|
5481
5481
|
id: ItemVersionIdentity;
|
|
5482
|
-
}
|
|
5482
|
+
};
|
|
5483
5483
|
/**
|
|
5484
5484
|
* The JSON data associated to the record version
|
|
5485
5485
|
*
|
|
5486
5486
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
5487
5487
|
* via the `definition` "attributes".
|
|
5488
5488
|
*/
|
|
5489
|
-
export
|
|
5489
|
+
export declare type ItemVersionAttributes = {
|
|
5490
5490
|
[k: string]: unknown;
|
|
5491
|
-
}
|
|
5491
|
+
};
|
|
5492
5492
|
/**
|
|
5493
5493
|
* JSON API links
|
|
5494
5494
|
*
|
|
5495
5495
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
5496
5496
|
* via the `definition` "relationships".
|
|
5497
5497
|
*/
|
|
5498
|
-
export
|
|
5498
|
+
export declare type ItemVersionRelationships = {
|
|
5499
5499
|
item_type: ItemTypeData;
|
|
5500
5500
|
item: ItemData;
|
|
5501
5501
|
editor: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5502
|
-
}
|
|
5502
|
+
};
|
|
5503
5503
|
/**
|
|
5504
5504
|
* Every file you upload to DatoCMS will be retrievable from this endpoint.
|
|
5505
5505
|
*
|
|
5506
5506
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
5507
5507
|
* via the `definition` "upload".
|
|
5508
5508
|
*/
|
|
5509
|
-
export
|
|
5509
|
+
export declare type Upload = {
|
|
5510
5510
|
id: UploadIdentity;
|
|
5511
5511
|
type: UploadType;
|
|
5512
5512
|
/**
|
|
@@ -5667,7 +5667,7 @@ export interface Upload {
|
|
|
5667
5667
|
alpha: number;
|
|
5668
5668
|
}[];
|
|
5669
5669
|
creator: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5670
|
-
}
|
|
5670
|
+
};
|
|
5671
5671
|
export declare type UploadCreateJobSchema = Upload;
|
|
5672
5672
|
export declare type UploadSelfTargetSchema = Upload;
|
|
5673
5673
|
export declare type UploadDestroyTargetSchema = Upload;
|
|
@@ -5678,17 +5678,17 @@ export declare type UploadUpdateJobSchema = Upload;
|
|
|
5678
5678
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
5679
5679
|
* via the `definition` "data".
|
|
5680
5680
|
*/
|
|
5681
|
-
export
|
|
5681
|
+
export declare type UploadData = {
|
|
5682
5682
|
type: UploadType;
|
|
5683
5683
|
id: UploadIdentity;
|
|
5684
|
-
}
|
|
5684
|
+
};
|
|
5685
5685
|
/**
|
|
5686
5686
|
* JSON API attributes
|
|
5687
5687
|
*
|
|
5688
5688
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
5689
5689
|
* via the `definition` "attributes".
|
|
5690
5690
|
*/
|
|
5691
|
-
export
|
|
5691
|
+
export declare type UploadAttributes = {
|
|
5692
5692
|
/**
|
|
5693
5693
|
* size of the upload
|
|
5694
5694
|
*/
|
|
@@ -5846,21 +5846,21 @@ export interface UploadAttributes {
|
|
|
5846
5846
|
*/
|
|
5847
5847
|
alpha: number;
|
|
5848
5848
|
}[];
|
|
5849
|
-
}
|
|
5849
|
+
};
|
|
5850
5850
|
/**
|
|
5851
5851
|
* JSON API links
|
|
5852
5852
|
*
|
|
5853
5853
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
5854
5854
|
* via the `definition` "relationships".
|
|
5855
5855
|
*/
|
|
5856
|
-
export
|
|
5856
|
+
export declare type UploadRelationships = {
|
|
5857
5857
|
creator: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5858
|
-
}
|
|
5858
|
+
};
|
|
5859
5859
|
/**
|
|
5860
5860
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
5861
5861
|
* via the `create.schema` link.
|
|
5862
5862
|
*/
|
|
5863
|
-
export
|
|
5863
|
+
export declare type UploadCreateSchema = {
|
|
5864
5864
|
type?: UploadType;
|
|
5865
5865
|
/**
|
|
5866
5866
|
* Upload path
|
|
@@ -5920,12 +5920,12 @@ export interface UploadCreateSchema {
|
|
|
5920
5920
|
* Tags
|
|
5921
5921
|
*/
|
|
5922
5922
|
tags?: string[];
|
|
5923
|
-
}
|
|
5923
|
+
};
|
|
5924
5924
|
/**
|
|
5925
5925
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
5926
5926
|
* via the `update.schema` link.
|
|
5927
5927
|
*/
|
|
5928
|
-
export
|
|
5928
|
+
export declare type UploadUpdateSchema = {
|
|
5929
5929
|
id?: UploadIdentity;
|
|
5930
5930
|
type?: UploadType;
|
|
5931
5931
|
/**
|
|
@@ -5991,23 +5991,23 @@ export interface UploadUpdateSchema {
|
|
|
5991
5991
|
};
|
|
5992
5992
|
};
|
|
5993
5993
|
creator?: AccountData | AccessTokenData | UserData | SsoUserData;
|
|
5994
|
-
}
|
|
5994
|
+
};
|
|
5995
5995
|
/**
|
|
5996
5996
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
5997
5997
|
* via the `batch_add_tags.schema` link.
|
|
5998
5998
|
*/
|
|
5999
|
-
export
|
|
5999
|
+
export declare type UploadBatchAddTagsSchema = {
|
|
6000
6000
|
type?: UploadType;
|
|
6001
6001
|
/**
|
|
6002
6002
|
* Tags
|
|
6003
6003
|
*/
|
|
6004
6004
|
tags?: string[];
|
|
6005
|
-
}
|
|
6005
|
+
};
|
|
6006
6006
|
/**
|
|
6007
6007
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
6008
6008
|
* via the `bulk_tag.schema` link.
|
|
6009
6009
|
*/
|
|
6010
|
-
export
|
|
6010
|
+
export declare type UploadBulkTagSchema = {
|
|
6011
6011
|
/**
|
|
6012
6012
|
* JSON API type field
|
|
6013
6013
|
*/
|
|
@@ -6017,33 +6017,33 @@ export interface UploadBulkTagSchema {
|
|
|
6017
6017
|
*/
|
|
6018
6018
|
tags: string[];
|
|
6019
6019
|
uploads: UploadData[];
|
|
6020
|
-
}
|
|
6020
|
+
};
|
|
6021
6021
|
/**
|
|
6022
6022
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
6023
6023
|
* via the `bulk_destroy.schema` link.
|
|
6024
6024
|
*/
|
|
6025
|
-
export
|
|
6025
|
+
export declare type UploadBulkDestroySchema = {
|
|
6026
6026
|
/**
|
|
6027
6027
|
* JSON API type field
|
|
6028
6028
|
*/
|
|
6029
6029
|
type?: 'upload_bulk_destroy_operation';
|
|
6030
6030
|
uploads: UploadData[];
|
|
6031
6031
|
[k: string]: unknown;
|
|
6032
|
-
}
|
|
6032
|
+
};
|
|
6033
6033
|
/**
|
|
6034
6034
|
* To upload a file in DatoCMS, first you need to obtain an upload permission through this API endpoint. The response will contain the S3 URL where you will be able to upload the file with a direct PUT request.
|
|
6035
6035
|
*
|
|
6036
6036
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6037
6037
|
* via the `definition` "upload_request".
|
|
6038
6038
|
*/
|
|
6039
|
-
export
|
|
6039
|
+
export declare type UploadRequest = {
|
|
6040
6040
|
id: UploadRequestIdentity;
|
|
6041
6041
|
type: UploadRequestType;
|
|
6042
6042
|
/**
|
|
6043
6043
|
* The URL to use to upload the file with a direct PUT request
|
|
6044
6044
|
*/
|
|
6045
6045
|
url: string;
|
|
6046
|
-
}
|
|
6046
|
+
};
|
|
6047
6047
|
export declare type UploadRequestCreateTargetSchema = UploadRequest;
|
|
6048
6048
|
/**
|
|
6049
6049
|
* JSON API attributes
|
|
@@ -6051,31 +6051,31 @@ export declare type UploadRequestCreateTargetSchema = UploadRequest;
|
|
|
6051
6051
|
* This interface was referenced by `UploadRequest`'s JSON-Schema
|
|
6052
6052
|
* via the `definition` "attributes".
|
|
6053
6053
|
*/
|
|
6054
|
-
export
|
|
6054
|
+
export declare type UploadRequestAttributes = {
|
|
6055
6055
|
/**
|
|
6056
6056
|
* The URL to use to upload the file with a direct PUT request
|
|
6057
6057
|
*/
|
|
6058
6058
|
url: string;
|
|
6059
6059
|
[k: string]: unknown;
|
|
6060
|
-
}
|
|
6060
|
+
};
|
|
6061
6061
|
/**
|
|
6062
6062
|
* This interface was referenced by `UploadRequest`'s JSON-Schema
|
|
6063
6063
|
* via the `create.schema` link.
|
|
6064
6064
|
*/
|
|
6065
|
-
export
|
|
6065
|
+
export declare type UploadRequestCreateSchema = {
|
|
6066
6066
|
type?: UploadRequestType;
|
|
6067
6067
|
/**
|
|
6068
6068
|
* The original file name
|
|
6069
6069
|
*/
|
|
6070
6070
|
filename?: string;
|
|
6071
|
-
}
|
|
6071
|
+
};
|
|
6072
6072
|
/**
|
|
6073
6073
|
* You can create scheduled publication to publish records in the future
|
|
6074
6074
|
*
|
|
6075
6075
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6076
6076
|
* via the `definition` "scheduled_publication".
|
|
6077
6077
|
*/
|
|
6078
|
-
export
|
|
6078
|
+
export declare type ScheduledPublication = {
|
|
6079
6079
|
id: ScheduledPublicationIdentity;
|
|
6080
6080
|
type: ScheduledPublicationType;
|
|
6081
6081
|
/**
|
|
@@ -6083,7 +6083,7 @@ export interface ScheduledPublication {
|
|
|
6083
6083
|
*/
|
|
6084
6084
|
publication_scheduled_at: string;
|
|
6085
6085
|
item: ItemData;
|
|
6086
|
-
}
|
|
6086
|
+
};
|
|
6087
6087
|
export declare type ScheduledPublicationCreateTargetSchema = ScheduledPublication;
|
|
6088
6088
|
/**
|
|
6089
6089
|
* JSON API data
|
|
@@ -6091,46 +6091,46 @@ export declare type ScheduledPublicationCreateTargetSchema = ScheduledPublicatio
|
|
|
6091
6091
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6092
6092
|
* via the `definition` "data".
|
|
6093
6093
|
*/
|
|
6094
|
-
export
|
|
6094
|
+
export declare type ScheduledPublicationData = {
|
|
6095
6095
|
type: ScheduledPublicationType;
|
|
6096
6096
|
id: ScheduledPublicationIdentity;
|
|
6097
|
-
}
|
|
6097
|
+
};
|
|
6098
6098
|
/**
|
|
6099
6099
|
* JSON API attributes
|
|
6100
6100
|
*
|
|
6101
6101
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6102
6102
|
* via the `definition` "attributes".
|
|
6103
6103
|
*/
|
|
6104
|
-
export
|
|
6104
|
+
export declare type ScheduledPublicationAttributes = {
|
|
6105
6105
|
/**
|
|
6106
6106
|
* The future date for the publication
|
|
6107
6107
|
*/
|
|
6108
6108
|
publication_scheduled_at: string;
|
|
6109
|
-
}
|
|
6109
|
+
};
|
|
6110
6110
|
/**
|
|
6111
6111
|
* JSON API links
|
|
6112
6112
|
*
|
|
6113
6113
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6114
6114
|
* via the `definition` "relationships".
|
|
6115
6115
|
*/
|
|
6116
|
-
export
|
|
6116
|
+
export declare type ScheduledPublicationRelationships = {
|
|
6117
6117
|
item: ItemData;
|
|
6118
|
-
}
|
|
6118
|
+
};
|
|
6119
6119
|
/**
|
|
6120
6120
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
6121
6121
|
* via the `create.schema` link.
|
|
6122
6122
|
*/
|
|
6123
|
-
export
|
|
6123
|
+
export declare type ScheduledPublicationCreateSchema = {
|
|
6124
6124
|
type?: ScheduledPublicationType;
|
|
6125
6125
|
[k: string]: unknown;
|
|
6126
|
-
}
|
|
6126
|
+
};
|
|
6127
6127
|
/**
|
|
6128
6128
|
* You can create a scheduled unpublishing to unpublish records in the future
|
|
6129
6129
|
*
|
|
6130
6130
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6131
6131
|
* via the `definition` "scheduled_unpublishing".
|
|
6132
6132
|
*/
|
|
6133
|
-
export
|
|
6133
|
+
export declare type ScheduledUnpublishing = {
|
|
6134
6134
|
id: ScheduledUnpublishingIdentity;
|
|
6135
6135
|
type: ScheduledUnpublishingType;
|
|
6136
6136
|
/**
|
|
@@ -6138,7 +6138,7 @@ export interface ScheduledUnpublishing {
|
|
|
6138
6138
|
*/
|
|
6139
6139
|
unpublishing_scheduled_at: string;
|
|
6140
6140
|
item: ItemData;
|
|
6141
|
-
}
|
|
6141
|
+
};
|
|
6142
6142
|
export declare type ScheduledUnpublishingCreateTargetSchema = ScheduledUnpublishing;
|
|
6143
6143
|
/**
|
|
6144
6144
|
* JSON API data
|
|
@@ -6146,46 +6146,46 @@ export declare type ScheduledUnpublishingCreateTargetSchema = ScheduledUnpublish
|
|
|
6146
6146
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6147
6147
|
* via the `definition` "data".
|
|
6148
6148
|
*/
|
|
6149
|
-
export
|
|
6149
|
+
export declare type ScheduledUnpublishingData = {
|
|
6150
6150
|
type: ScheduledUnpublishingType;
|
|
6151
6151
|
id: ScheduledUnpublishingIdentity;
|
|
6152
|
-
}
|
|
6152
|
+
};
|
|
6153
6153
|
/**
|
|
6154
6154
|
* JSON API attributes
|
|
6155
6155
|
*
|
|
6156
6156
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6157
6157
|
* via the `definition` "attributes".
|
|
6158
6158
|
*/
|
|
6159
|
-
export
|
|
6159
|
+
export declare type ScheduledUnpublishingAttributes = {
|
|
6160
6160
|
/**
|
|
6161
6161
|
* The future date for the unpublishing
|
|
6162
6162
|
*/
|
|
6163
6163
|
unpublishing_scheduled_at: string;
|
|
6164
|
-
}
|
|
6164
|
+
};
|
|
6165
6165
|
/**
|
|
6166
6166
|
* JSON API links
|
|
6167
6167
|
*
|
|
6168
6168
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6169
6169
|
* via the `definition` "relationships".
|
|
6170
6170
|
*/
|
|
6171
|
-
export
|
|
6171
|
+
export declare type ScheduledUnpublishingRelationships = {
|
|
6172
6172
|
item: ItemData;
|
|
6173
|
-
}
|
|
6173
|
+
};
|
|
6174
6174
|
/**
|
|
6175
6175
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
6176
6176
|
* via the `create.schema` link.
|
|
6177
6177
|
*/
|
|
6178
|
-
export
|
|
6178
|
+
export declare type ScheduledUnpublishingCreateSchema = {
|
|
6179
6179
|
type?: ScheduledUnpublishingType;
|
|
6180
6180
|
[k: string]: unknown;
|
|
6181
|
-
}
|
|
6181
|
+
};
|
|
6182
6182
|
/**
|
|
6183
6183
|
* DatoCMS Site Search is a way to deliver tailored search results to your site visitors. This is the endpoint you can use to query for results.
|
|
6184
6184
|
*
|
|
6185
6185
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6186
6186
|
* via the `definition` "search_result".
|
|
6187
6187
|
*/
|
|
6188
|
-
export
|
|
6188
|
+
export declare type SearchResult = {
|
|
6189
6189
|
id: SearchResultIdentity;
|
|
6190
6190
|
type: SearchResultType;
|
|
6191
6191
|
/**
|
|
@@ -6208,24 +6208,24 @@ export interface SearchResult {
|
|
|
6208
6208
|
title?: string[] | null;
|
|
6209
6209
|
body?: string[] | null;
|
|
6210
6210
|
};
|
|
6211
|
-
}
|
|
6211
|
+
};
|
|
6212
6212
|
/**
|
|
6213
6213
|
* JSON API data
|
|
6214
6214
|
*
|
|
6215
6215
|
* This interface was referenced by `SearchResult`'s JSON-Schema
|
|
6216
6216
|
* via the `definition` "data".
|
|
6217
6217
|
*/
|
|
6218
|
-
export
|
|
6218
|
+
export declare type SearchResultData = {
|
|
6219
6219
|
type: SearchResultType;
|
|
6220
6220
|
id: SearchResultIdentity;
|
|
6221
|
-
}
|
|
6221
|
+
};
|
|
6222
6222
|
/**
|
|
6223
6223
|
* JSON API attributes
|
|
6224
6224
|
*
|
|
6225
6225
|
* This interface was referenced by `SearchResult`'s JSON-Schema
|
|
6226
6226
|
* via the `definition` "attributes".
|
|
6227
6227
|
*/
|
|
6228
|
-
export
|
|
6228
|
+
export declare type SearchResultAttributes = {
|
|
6229
6229
|
/**
|
|
6230
6230
|
* Page title
|
|
6231
6231
|
*/
|
|
@@ -6246,7 +6246,7 @@ export interface SearchResultAttributes {
|
|
|
6246
6246
|
title?: string[] | null;
|
|
6247
6247
|
body?: string[] | null;
|
|
6248
6248
|
};
|
|
6249
|
-
}
|
|
6249
|
+
};
|
|
6250
6250
|
/**
|
|
6251
6251
|
* [Environments](https://www.datocms.com/docs/general-concepts/primary-and-sandbox-environments) make it easier for your development team to **manage and maintain content structure once your content has been published**. You can think of environments like code branches: great for testing, development and pre-production environments.
|
|
6252
6252
|
*
|
|
@@ -6270,11 +6270,11 @@ export interface SearchResultAttributes {
|
|
|
6270
6270
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6271
6271
|
* via the `definition` "environment".
|
|
6272
6272
|
*/
|
|
6273
|
-
export
|
|
6273
|
+
export declare type Environment = {
|
|
6274
6274
|
id: EnvironmentIdentity;
|
|
6275
6275
|
type: EnvironmentType;
|
|
6276
6276
|
meta: EnvironmentMeta;
|
|
6277
|
-
}
|
|
6277
|
+
};
|
|
6278
6278
|
export declare type EnvironmentForkJobSchema = Environment;
|
|
6279
6279
|
export declare type EnvironmentPromoteTargetSchema = Environment;
|
|
6280
6280
|
export declare type EnvironmentSelfTargetSchema = Environment;
|
|
@@ -6285,7 +6285,7 @@ export declare type EnvironmentDestroyJobSchema = Environment;
|
|
|
6285
6285
|
* This interface was referenced by `Environment`'s JSON-Schema
|
|
6286
6286
|
* via the `definition` "meta".
|
|
6287
6287
|
*/
|
|
6288
|
-
export
|
|
6288
|
+
export declare type EnvironmentMeta = {
|
|
6289
6289
|
/**
|
|
6290
6290
|
* Status of the environment
|
|
6291
6291
|
*/
|
|
@@ -6302,41 +6302,41 @@ export interface EnvironmentMeta {
|
|
|
6302
6302
|
* Is this environment the primary for the project?
|
|
6303
6303
|
*/
|
|
6304
6304
|
primary: boolean;
|
|
6305
|
-
}
|
|
6305
|
+
};
|
|
6306
6306
|
/**
|
|
6307
6307
|
* JSON API data
|
|
6308
6308
|
*
|
|
6309
6309
|
* This interface was referenced by `Environment`'s JSON-Schema
|
|
6310
6310
|
* via the `definition` "data".
|
|
6311
6311
|
*/
|
|
6312
|
-
export
|
|
6312
|
+
export declare type EnvironmentData = {
|
|
6313
6313
|
type: EnvironmentType;
|
|
6314
6314
|
id: EnvironmentIdentity;
|
|
6315
|
-
}
|
|
6315
|
+
};
|
|
6316
6316
|
/**
|
|
6317
6317
|
* This interface was referenced by `Environment`'s JSON-Schema
|
|
6318
6318
|
* via the `fork.schema` link.
|
|
6319
6319
|
*/
|
|
6320
|
-
export
|
|
6320
|
+
export declare type EnvironmentForkSchema = {
|
|
6321
6321
|
/**
|
|
6322
6322
|
* The ID of the forked environment
|
|
6323
6323
|
*/
|
|
6324
6324
|
id?: string;
|
|
6325
6325
|
type?: EnvironmentType;
|
|
6326
6326
|
[k: string]: unknown;
|
|
6327
|
-
}
|
|
6327
|
+
};
|
|
6328
6328
|
/**
|
|
6329
6329
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6330
6330
|
* via the `definition` "maintenance_mode".
|
|
6331
6331
|
*/
|
|
6332
|
-
export
|
|
6332
|
+
export declare type MaintenanceMode = {
|
|
6333
6333
|
id: MaintenanceModeIdentity;
|
|
6334
6334
|
type: MaintenanceModeType;
|
|
6335
6335
|
/**
|
|
6336
6336
|
* Whether maintenance mode is currently active or not
|
|
6337
6337
|
*/
|
|
6338
6338
|
active: boolean;
|
|
6339
|
-
}
|
|
6339
|
+
};
|
|
6340
6340
|
export declare type MaintenanceModeSelfTargetSchema = MaintenanceMode;
|
|
6341
6341
|
export declare type MaintenanceModeActivateTargetSchema = MaintenanceMode;
|
|
6342
6342
|
export declare type MaintenanceModeDeactivateTargetSchema = MaintenanceMode;
|
|
@@ -6346,29 +6346,29 @@ export declare type MaintenanceModeDeactivateTargetSchema = MaintenanceMode;
|
|
|
6346
6346
|
* This interface was referenced by `MaintenanceMode`'s JSON-Schema
|
|
6347
6347
|
* via the `definition` "data".
|
|
6348
6348
|
*/
|
|
6349
|
-
export
|
|
6349
|
+
export declare type MaintenanceModeData = {
|
|
6350
6350
|
type: MaintenanceModeType;
|
|
6351
6351
|
id: MaintenanceModeIdentity;
|
|
6352
|
-
}
|
|
6352
|
+
};
|
|
6353
6353
|
/**
|
|
6354
6354
|
* JSON API attributes
|
|
6355
6355
|
*
|
|
6356
6356
|
* This interface was referenced by `MaintenanceMode`'s JSON-Schema
|
|
6357
6357
|
* via the `definition` "attributes".
|
|
6358
6358
|
*/
|
|
6359
|
-
export
|
|
6359
|
+
export declare type MaintenanceModeAttributes = {
|
|
6360
6360
|
/**
|
|
6361
6361
|
* Whether maintenance mode is currently active or not
|
|
6362
6362
|
*/
|
|
6363
6363
|
active: boolean;
|
|
6364
|
-
}
|
|
6364
|
+
};
|
|
6365
6365
|
/**
|
|
6366
6366
|
* A webhook allows to make requests following certain Dato events. It is linked to a Role, which describes what actions can be performed.
|
|
6367
6367
|
*
|
|
6368
6368
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6369
6369
|
* via the `definition` "webhook".
|
|
6370
6370
|
*/
|
|
6371
|
-
export
|
|
6371
|
+
export declare type Webhook = {
|
|
6372
6372
|
id: WebhookIdentity;
|
|
6373
6373
|
type: WebhookType;
|
|
6374
6374
|
/**
|
|
@@ -6413,7 +6413,7 @@ export interface Webhook {
|
|
|
6413
6413
|
* Whether the you want records present in the payload to show blocks expanded or not
|
|
6414
6414
|
*/
|
|
6415
6415
|
nested_items_in_payload: boolean;
|
|
6416
|
-
}
|
|
6416
|
+
};
|
|
6417
6417
|
export declare type WebhookCreateTargetSchema = Webhook;
|
|
6418
6418
|
export declare type WebhookUpdateTargetSchema = Webhook;
|
|
6419
6419
|
export declare type WebhookSelfTargetSchema = Webhook;
|
|
@@ -6424,17 +6424,17 @@ export declare type WebhookDestroyTargetSchema = Webhook;
|
|
|
6424
6424
|
* This interface was referenced by `Webhook`'s JSON-Schema
|
|
6425
6425
|
* via the `definition` "data".
|
|
6426
6426
|
*/
|
|
6427
|
-
export
|
|
6427
|
+
export declare type WebhookData = {
|
|
6428
6428
|
type: WebhookType;
|
|
6429
6429
|
id: WebhookIdentity;
|
|
6430
|
-
}
|
|
6430
|
+
};
|
|
6431
6431
|
/**
|
|
6432
6432
|
* JSON API attributes
|
|
6433
6433
|
*
|
|
6434
6434
|
* This interface was referenced by `Webhook`'s JSON-Schema
|
|
6435
6435
|
* via the `definition` "attributes".
|
|
6436
6436
|
*/
|
|
6437
|
-
export
|
|
6437
|
+
export declare type WebhookAttributes = {
|
|
6438
6438
|
/**
|
|
6439
6439
|
* Unique name for the webhook
|
|
6440
6440
|
*/
|
|
@@ -6477,12 +6477,12 @@ export interface WebhookAttributes {
|
|
|
6477
6477
|
* Whether the you want records present in the payload to show blocks expanded or not
|
|
6478
6478
|
*/
|
|
6479
6479
|
nested_items_in_payload: boolean;
|
|
6480
|
-
}
|
|
6480
|
+
};
|
|
6481
6481
|
/**
|
|
6482
6482
|
* This interface was referenced by `Webhook`'s JSON-Schema
|
|
6483
6483
|
* via the `create.schema` link.
|
|
6484
6484
|
*/
|
|
6485
|
-
export
|
|
6485
|
+
export declare type WebhookCreateSchema = {
|
|
6486
6486
|
type?: WebhookType;
|
|
6487
6487
|
/**
|
|
6488
6488
|
* Unique name for the webhook
|
|
@@ -6526,12 +6526,12 @@ export interface WebhookCreateSchema {
|
|
|
6526
6526
|
* Whether the you want records present in the payload to show blocks expanded or not
|
|
6527
6527
|
*/
|
|
6528
6528
|
nested_items_in_payload?: boolean;
|
|
6529
|
-
}
|
|
6529
|
+
};
|
|
6530
6530
|
/**
|
|
6531
6531
|
* This interface was referenced by `Webhook`'s JSON-Schema
|
|
6532
6532
|
* via the `update.schema` link.
|
|
6533
6533
|
*/
|
|
6534
|
-
export
|
|
6534
|
+
export declare type WebhookUpdateSchema = {
|
|
6535
6535
|
id?: WebhookIdentity;
|
|
6536
6536
|
type?: WebhookType;
|
|
6537
6537
|
/**
|
|
@@ -6576,14 +6576,14 @@ export interface WebhookUpdateSchema {
|
|
|
6576
6576
|
* Whether the you want records present in the payload to show blocks expanded or not
|
|
6577
6577
|
*/
|
|
6578
6578
|
nested_items_in_payload?: boolean;
|
|
6579
|
-
}
|
|
6579
|
+
};
|
|
6580
6580
|
/**
|
|
6581
6581
|
* Represents a log entry in the webhooks activity list.
|
|
6582
6582
|
*
|
|
6583
6583
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6584
6584
|
* via the `definition` "webhook_call".
|
|
6585
6585
|
*/
|
|
6586
|
-
export
|
|
6586
|
+
export declare type WebhookCall = {
|
|
6587
6587
|
id: WebhookCallIdentity;
|
|
6588
6588
|
type: WebhookCallType;
|
|
6589
6589
|
/**
|
|
@@ -6627,24 +6627,24 @@ export interface WebhookCall {
|
|
|
6627
6627
|
*/
|
|
6628
6628
|
response_payload: string | null;
|
|
6629
6629
|
webhook: WebhookData;
|
|
6630
|
-
}
|
|
6630
|
+
};
|
|
6631
6631
|
/**
|
|
6632
6632
|
* JSON API data
|
|
6633
6633
|
*
|
|
6634
6634
|
* This interface was referenced by `WebhookCall`'s JSON-Schema
|
|
6635
6635
|
* via the `definition` "data".
|
|
6636
6636
|
*/
|
|
6637
|
-
export
|
|
6637
|
+
export declare type WebhookCallData = {
|
|
6638
6638
|
type: WebhookCallType;
|
|
6639
6639
|
id: WebhookCallIdentity;
|
|
6640
|
-
}
|
|
6640
|
+
};
|
|
6641
6641
|
/**
|
|
6642
6642
|
* JSON API attributes
|
|
6643
6643
|
*
|
|
6644
6644
|
* This interface was referenced by `WebhookCall`'s JSON-Schema
|
|
6645
6645
|
* via the `definition` "attributes".
|
|
6646
6646
|
*/
|
|
6647
|
-
export
|
|
6647
|
+
export declare type WebhookCallAttributes = {
|
|
6648
6648
|
/**
|
|
6649
6649
|
* The subject of webhook triggering
|
|
6650
6650
|
*/
|
|
@@ -6685,23 +6685,23 @@ export interface WebhookCallAttributes {
|
|
|
6685
6685
|
* The body of the response
|
|
6686
6686
|
*/
|
|
6687
6687
|
response_payload: string | null;
|
|
6688
|
-
}
|
|
6688
|
+
};
|
|
6689
6689
|
/**
|
|
6690
6690
|
* JSON API links
|
|
6691
6691
|
*
|
|
6692
6692
|
* This interface was referenced by `WebhookCall`'s JSON-Schema
|
|
6693
6693
|
* via the `definition` "relationships".
|
|
6694
6694
|
*/
|
|
6695
|
-
export
|
|
6695
|
+
export declare type WebhookCallRelationships = {
|
|
6696
6696
|
webhook: WebhookData;
|
|
6697
|
-
}
|
|
6697
|
+
};
|
|
6698
6698
|
/**
|
|
6699
6699
|
* Configuration for different build triggers. You can have different staging and production environments in order to test your site before final deploy
|
|
6700
6700
|
*
|
|
6701
6701
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6702
6702
|
* via the `definition` "build_trigger".
|
|
6703
6703
|
*/
|
|
6704
|
-
export
|
|
6704
|
+
export declare type BuildTrigger = {
|
|
6705
6705
|
id: BuildTriggerIdentity;
|
|
6706
6706
|
type: BuildTriggerType;
|
|
6707
6707
|
/**
|
|
@@ -6750,7 +6750,7 @@ export interface BuildTrigger {
|
|
|
6750
6750
|
* Enable scraper on the site
|
|
6751
6751
|
*/
|
|
6752
6752
|
indexing_enabled: boolean;
|
|
6753
|
-
}
|
|
6753
|
+
};
|
|
6754
6754
|
export declare type BuildTriggerSelfTargetSchema = BuildTrigger;
|
|
6755
6755
|
export declare type BuildTriggerCreateTargetSchema = BuildTrigger;
|
|
6756
6756
|
export declare type BuildTriggerUpdateTargetSchema = BuildTrigger;
|
|
@@ -6761,7 +6761,7 @@ export declare type BuildTriggerDestroyTargetSchema = BuildTrigger;
|
|
|
6761
6761
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
6762
6762
|
* via the `definition` "attributes".
|
|
6763
6763
|
*/
|
|
6764
|
-
export
|
|
6764
|
+
export declare type BuildTriggerAttributes = {
|
|
6765
6765
|
/**
|
|
6766
6766
|
* Name of the environment
|
|
6767
6767
|
*/
|
|
@@ -6808,12 +6808,12 @@ export interface BuildTriggerAttributes {
|
|
|
6808
6808
|
* Enable scraper on the site
|
|
6809
6809
|
*/
|
|
6810
6810
|
indexing_enabled: boolean;
|
|
6811
|
-
}
|
|
6811
|
+
};
|
|
6812
6812
|
/**
|
|
6813
6813
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
6814
6814
|
* via the `create.schema` link.
|
|
6815
6815
|
*/
|
|
6816
|
-
export
|
|
6816
|
+
export declare type BuildTriggerCreateSchema = {
|
|
6817
6817
|
type?: BuildTriggerType;
|
|
6818
6818
|
/**
|
|
6819
6819
|
* Name of the environment
|
|
@@ -6845,12 +6845,12 @@ export interface BuildTriggerCreateSchema {
|
|
|
6845
6845
|
adapter_settings: {
|
|
6846
6846
|
[k: string]: unknown;
|
|
6847
6847
|
};
|
|
6848
|
-
}
|
|
6848
|
+
};
|
|
6849
6849
|
/**
|
|
6850
6850
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
6851
6851
|
* via the `update.schema` link.
|
|
6852
6852
|
*/
|
|
6853
|
-
export
|
|
6853
|
+
export declare type BuildTriggerUpdateSchema = {
|
|
6854
6854
|
id?: BuildTriggerIdentity;
|
|
6855
6855
|
type?: BuildTriggerType;
|
|
6856
6856
|
/**
|
|
@@ -6879,14 +6879,14 @@ export interface BuildTriggerUpdateSchema {
|
|
|
6879
6879
|
adapter_settings?: {
|
|
6880
6880
|
[k: string]: unknown;
|
|
6881
6881
|
};
|
|
6882
|
-
}
|
|
6882
|
+
};
|
|
6883
6883
|
/**
|
|
6884
6884
|
* In DatoCMS you can create filters to help you (and other editors) quickly search for records
|
|
6885
6885
|
*
|
|
6886
6886
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
6887
6887
|
* via the `definition` "item_type_filter".
|
|
6888
6888
|
*/
|
|
6889
|
-
export
|
|
6889
|
+
export declare type ItemTypeFilter = {
|
|
6890
6890
|
id: ItemTypeFilterIdentity;
|
|
6891
6891
|
type: ItemTypeFilterType;
|
|
6892
6892
|
/**
|
|
@@ -6904,7 +6904,7 @@ export interface ItemTypeFilter {
|
|
|
6904
6904
|
*/
|
|
6905
6905
|
shared: boolean;
|
|
6906
6906
|
item_type: ItemTypeData;
|
|
6907
|
-
}
|
|
6907
|
+
};
|
|
6908
6908
|
export declare type ItemTypeFilterCreateTargetSchema = ItemTypeFilter;
|
|
6909
6909
|
export declare type ItemTypeFilterUpdateTargetSchema = ItemTypeFilter;
|
|
6910
6910
|
export declare type ItemTypeFilterSelfTargetSchema = ItemTypeFilter;
|
|
@@ -6915,17 +6915,17 @@ export declare type ItemTypeFilterDestroyTargetSchema = ItemTypeFilter;
|
|
|
6915
6915
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
6916
6916
|
* via the `definition` "data".
|
|
6917
6917
|
*/
|
|
6918
|
-
export
|
|
6918
|
+
export declare type ItemTypeFilterData = {
|
|
6919
6919
|
type: ItemTypeFilterType;
|
|
6920
6920
|
id: ItemTypeFilterIdentity;
|
|
6921
|
-
}
|
|
6921
|
+
};
|
|
6922
6922
|
/**
|
|
6923
6923
|
* JSON API attributes
|
|
6924
6924
|
*
|
|
6925
6925
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
6926
6926
|
* via the `definition` "attributes".
|
|
6927
6927
|
*/
|
|
6928
|
-
export
|
|
6928
|
+
export declare type ItemTypeFilterAttributes = {
|
|
6929
6929
|
/**
|
|
6930
6930
|
* The name of the filter
|
|
6931
6931
|
*/
|
|
@@ -6940,21 +6940,21 @@ export interface ItemTypeFilterAttributes {
|
|
|
6940
6940
|
* Whether it's a shared filter or not
|
|
6941
6941
|
*/
|
|
6942
6942
|
shared: boolean;
|
|
6943
|
-
}
|
|
6943
|
+
};
|
|
6944
6944
|
/**
|
|
6945
6945
|
* JSON API links
|
|
6946
6946
|
*
|
|
6947
6947
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
6948
6948
|
* via the `definition` "relationships".
|
|
6949
6949
|
*/
|
|
6950
|
-
export
|
|
6950
|
+
export declare type ItemTypeFilterRelationships = {
|
|
6951
6951
|
item_type: ItemTypeData;
|
|
6952
|
-
}
|
|
6952
|
+
};
|
|
6953
6953
|
/**
|
|
6954
6954
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
6955
6955
|
* via the `create.schema` link.
|
|
6956
6956
|
*/
|
|
6957
|
-
export
|
|
6957
|
+
export declare type ItemTypeFilterCreateSchema = {
|
|
6958
6958
|
type?: ItemTypeFilterType;
|
|
6959
6959
|
/**
|
|
6960
6960
|
* The name of the filter
|
|
@@ -6971,12 +6971,12 @@ export interface ItemTypeFilterCreateSchema {
|
|
|
6971
6971
|
*/
|
|
6972
6972
|
shared: boolean;
|
|
6973
6973
|
item_type: ItemTypeData;
|
|
6974
|
-
}
|
|
6974
|
+
};
|
|
6975
6975
|
/**
|
|
6976
6976
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
6977
6977
|
* via the `update.schema` link.
|
|
6978
6978
|
*/
|
|
6979
|
-
export
|
|
6979
|
+
export declare type ItemTypeFilterUpdateSchema = {
|
|
6980
6980
|
id?: ItemTypeFilterIdentity;
|
|
6981
6981
|
type?: ItemTypeFilterType;
|
|
6982
6982
|
/**
|
|
@@ -6993,14 +6993,14 @@ export interface ItemTypeFilterUpdateSchema {
|
|
|
6993
6993
|
filter: {
|
|
6994
6994
|
[k: string]: unknown;
|
|
6995
6995
|
};
|
|
6996
|
-
}
|
|
6996
|
+
};
|
|
6997
6997
|
/**
|
|
6998
6998
|
* In DatoCMS you can create filters to help you (and other editors) quickly search for uploads
|
|
6999
6999
|
*
|
|
7000
7000
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7001
7001
|
* via the `definition` "upload_filter".
|
|
7002
7002
|
*/
|
|
7003
|
-
export
|
|
7003
|
+
export declare type UploadFilter = {
|
|
7004
7004
|
id: UploadFilterIdentity;
|
|
7005
7005
|
type: UploadFilterType;
|
|
7006
7006
|
/**
|
|
@@ -7017,7 +7017,7 @@ export interface UploadFilter {
|
|
|
7017
7017
|
* Whether it's a shared filter or not
|
|
7018
7018
|
*/
|
|
7019
7019
|
shared: boolean;
|
|
7020
|
-
}
|
|
7020
|
+
};
|
|
7021
7021
|
export declare type UploadFilterCreateTargetSchema = UploadFilter;
|
|
7022
7022
|
export declare type UploadFilterUpdateTargetSchema = UploadFilter;
|
|
7023
7023
|
export declare type UploadFilterSelfTargetSchema = UploadFilter;
|
|
@@ -7028,17 +7028,17 @@ export declare type UploadFilterDestroyTargetSchema = UploadFilter;
|
|
|
7028
7028
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
7029
7029
|
* via the `definition` "data".
|
|
7030
7030
|
*/
|
|
7031
|
-
export
|
|
7031
|
+
export declare type UploadFilterData = {
|
|
7032
7032
|
type: UploadFilterType;
|
|
7033
7033
|
id: UploadFilterIdentity;
|
|
7034
|
-
}
|
|
7034
|
+
};
|
|
7035
7035
|
/**
|
|
7036
7036
|
* JSON API attributes
|
|
7037
7037
|
*
|
|
7038
7038
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
7039
7039
|
* via the `definition` "attributes".
|
|
7040
7040
|
*/
|
|
7041
|
-
export
|
|
7041
|
+
export declare type UploadFilterAttributes = {
|
|
7042
7042
|
/**
|
|
7043
7043
|
* The name of the filter
|
|
7044
7044
|
*/
|
|
@@ -7053,12 +7053,12 @@ export interface UploadFilterAttributes {
|
|
|
7053
7053
|
* Whether it's a shared filter or not
|
|
7054
7054
|
*/
|
|
7055
7055
|
shared: boolean;
|
|
7056
|
-
}
|
|
7056
|
+
};
|
|
7057
7057
|
/**
|
|
7058
7058
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
7059
7059
|
* via the `create.schema` link.
|
|
7060
7060
|
*/
|
|
7061
|
-
export
|
|
7061
|
+
export declare type UploadFilterCreateSchema = {
|
|
7062
7062
|
type?: UploadFilterType;
|
|
7063
7063
|
/**
|
|
7064
7064
|
* The name of the filter
|
|
@@ -7074,12 +7074,12 @@ export interface UploadFilterCreateSchema {
|
|
|
7074
7074
|
* Whether it's a shared filter or not
|
|
7075
7075
|
*/
|
|
7076
7076
|
shared: boolean;
|
|
7077
|
-
}
|
|
7077
|
+
};
|
|
7078
7078
|
/**
|
|
7079
7079
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
7080
7080
|
* via the `update.schema` link.
|
|
7081
7081
|
*/
|
|
7082
|
-
export
|
|
7082
|
+
export declare type UploadFilterUpdateSchema = {
|
|
7083
7083
|
id?: UploadFilterIdentity;
|
|
7084
7084
|
type?: UploadFilterType;
|
|
7085
7085
|
/**
|
|
@@ -7096,14 +7096,14 @@ export interface UploadFilterUpdateSchema {
|
|
|
7096
7096
|
filter: {
|
|
7097
7097
|
[k: string]: unknown;
|
|
7098
7098
|
};
|
|
7099
|
-
}
|
|
7099
|
+
};
|
|
7100
7100
|
/**
|
|
7101
7101
|
* A DatoCMS administrative area can be accessed by multiple people. Every invitation is linked to a specific Role, which describes what actions it will be able to perform once the user will register.
|
|
7102
7102
|
*
|
|
7103
7103
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7104
7104
|
* via the `definition` "site_invitation".
|
|
7105
7105
|
*/
|
|
7106
|
-
export
|
|
7106
|
+
export declare type SiteInvitation = {
|
|
7107
7107
|
id: SiteInvitationIdentity;
|
|
7108
7108
|
type: SiteInvitationType;
|
|
7109
7109
|
/**
|
|
@@ -7111,7 +7111,7 @@ export interface SiteInvitation {
|
|
|
7111
7111
|
*/
|
|
7112
7112
|
email: string;
|
|
7113
7113
|
role: RoleData;
|
|
7114
|
-
}
|
|
7114
|
+
};
|
|
7115
7115
|
export declare type SiteInvitationCreateTargetSchema = SiteInvitation;
|
|
7116
7116
|
export declare type SiteInvitationUpdateTargetSchema = SiteInvitation;
|
|
7117
7117
|
export declare type SiteInvitationSelfTargetSchema = SiteInvitation;
|
|
@@ -7122,60 +7122,60 @@ export declare type SiteInvitationDestroyTargetSchema = SiteInvitation;
|
|
|
7122
7122
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
7123
7123
|
* via the `definition` "data".
|
|
7124
7124
|
*/
|
|
7125
|
-
export
|
|
7125
|
+
export declare type SiteInvitationData = {
|
|
7126
7126
|
type: SiteInvitationType;
|
|
7127
7127
|
id: SiteInvitationIdentity;
|
|
7128
|
-
}
|
|
7128
|
+
};
|
|
7129
7129
|
/**
|
|
7130
7130
|
* JSON API attributes
|
|
7131
7131
|
*
|
|
7132
7132
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
7133
7133
|
* via the `definition` "attributes".
|
|
7134
7134
|
*/
|
|
7135
|
-
export
|
|
7135
|
+
export declare type SiteInvitationAttributes = {
|
|
7136
7136
|
/**
|
|
7137
7137
|
* Email
|
|
7138
7138
|
*/
|
|
7139
7139
|
email: string;
|
|
7140
|
-
}
|
|
7140
|
+
};
|
|
7141
7141
|
/**
|
|
7142
7142
|
* JSON API links
|
|
7143
7143
|
*
|
|
7144
7144
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
7145
7145
|
* via the `definition` "relationships".
|
|
7146
7146
|
*/
|
|
7147
|
-
export
|
|
7147
|
+
export declare type SiteInvitationRelationships = {
|
|
7148
7148
|
role: RoleData;
|
|
7149
|
-
}
|
|
7149
|
+
};
|
|
7150
7150
|
/**
|
|
7151
7151
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
7152
7152
|
* via the `create.schema` link.
|
|
7153
7153
|
*/
|
|
7154
|
-
export
|
|
7154
|
+
export declare type SiteInvitationCreateSchema = {
|
|
7155
7155
|
type?: SiteInvitationType;
|
|
7156
7156
|
/**
|
|
7157
7157
|
* Email
|
|
7158
7158
|
*/
|
|
7159
7159
|
email: string;
|
|
7160
7160
|
role: RoleData;
|
|
7161
|
-
}
|
|
7161
|
+
};
|
|
7162
7162
|
/**
|
|
7163
7163
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
7164
7164
|
* via the `update.schema` link.
|
|
7165
7165
|
*/
|
|
7166
|
-
export
|
|
7166
|
+
export declare type SiteInvitationUpdateSchema = {
|
|
7167
7167
|
id?: SiteInvitationIdentity;
|
|
7168
7168
|
type?: SiteInvitationType;
|
|
7169
7169
|
role?: RoleData;
|
|
7170
7170
|
[k: string]: unknown;
|
|
7171
|
-
}
|
|
7171
|
+
};
|
|
7172
7172
|
/**
|
|
7173
7173
|
* Session track users movements in the administrative area, and allows locking a record when editing it.
|
|
7174
7174
|
*
|
|
7175
7175
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7176
7176
|
* via the `definition` "editing_session".
|
|
7177
7177
|
*/
|
|
7178
|
-
export
|
|
7178
|
+
export declare type EditingSession = {
|
|
7179
7179
|
id: EditingSessionIdentity;
|
|
7180
7180
|
type: EditingSessionType;
|
|
7181
7181
|
/**
|
|
@@ -7189,7 +7189,7 @@ export interface EditingSession {
|
|
|
7189
7189
|
active_item: ItemData;
|
|
7190
7190
|
active_item_type: ItemTypeData;
|
|
7191
7191
|
editor: AccountData | AccessTokenData | UserData;
|
|
7192
|
-
}
|
|
7192
|
+
};
|
|
7193
7193
|
export declare type EditingSessionUpdateTargetSchema = EditingSession;
|
|
7194
7194
|
export declare type EditingSessionDestroyTargetSchema = EditingSession;
|
|
7195
7195
|
/**
|
|
@@ -7198,17 +7198,17 @@ export declare type EditingSessionDestroyTargetSchema = EditingSession;
|
|
|
7198
7198
|
* This interface was referenced by `EditingSession`'s JSON-Schema
|
|
7199
7199
|
* via the `definition` "data".
|
|
7200
7200
|
*/
|
|
7201
|
-
export
|
|
7201
|
+
export declare type EditingSessionData = {
|
|
7202
7202
|
type: EditingSessionType;
|
|
7203
7203
|
id: EditingSessionIdentity;
|
|
7204
|
-
}
|
|
7204
|
+
};
|
|
7205
7205
|
/**
|
|
7206
7206
|
* JSON API attributes
|
|
7207
7207
|
*
|
|
7208
7208
|
* This interface was referenced by `EditingSession`'s JSON-Schema
|
|
7209
7209
|
* via the `definition` "attributes".
|
|
7210
7210
|
*/
|
|
7211
|
-
export
|
|
7211
|
+
export declare type EditingSessionAttributes = {
|
|
7212
7212
|
/**
|
|
7213
7213
|
* User entered at
|
|
7214
7214
|
*/
|
|
@@ -7217,25 +7217,25 @@ export interface EditingSessionAttributes {
|
|
|
7217
7217
|
* User locked record at
|
|
7218
7218
|
*/
|
|
7219
7219
|
locked_at: string | null;
|
|
7220
|
-
}
|
|
7220
|
+
};
|
|
7221
7221
|
/**
|
|
7222
7222
|
* JSON API links
|
|
7223
7223
|
*
|
|
7224
7224
|
* This interface was referenced by `EditingSession`'s JSON-Schema
|
|
7225
7225
|
* via the `definition` "relationships".
|
|
7226
7226
|
*/
|
|
7227
|
-
export
|
|
7227
|
+
export declare type EditingSessionRelationships = {
|
|
7228
7228
|
active_item: ItemData;
|
|
7229
7229
|
active_item_type: ItemTypeData;
|
|
7230
7230
|
editor: AccountData | AccessTokenData | UserData;
|
|
7231
|
-
}
|
|
7231
|
+
};
|
|
7232
7232
|
/**
|
|
7233
7233
|
* A Single Sign-On group exists when a DatoCMS project is connected to an Identity Provider. These groups can be used to link DatoCMS roles to the Identity Provider's groups.
|
|
7234
7234
|
*
|
|
7235
7235
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7236
7236
|
* via the `definition` "sso_group".
|
|
7237
7237
|
*/
|
|
7238
|
-
export
|
|
7238
|
+
export declare type SsoGroup = {
|
|
7239
7239
|
id: SsoGroupIdentity;
|
|
7240
7240
|
type: SsoGroupType;
|
|
7241
7241
|
/**
|
|
@@ -7248,7 +7248,7 @@ export interface SsoGroup {
|
|
|
7248
7248
|
priority: number;
|
|
7249
7249
|
role: RoleData;
|
|
7250
7250
|
users: SsoUserData[];
|
|
7251
|
-
}
|
|
7251
|
+
};
|
|
7252
7252
|
export declare type SsoGroupCopyRolesTargetSchema = SsoGroup;
|
|
7253
7253
|
export declare type SsoGroupUpdateTargetSchema = SsoGroup;
|
|
7254
7254
|
export declare type SsoGroupDestroyTargetSchema = SsoGroup;
|
|
@@ -7258,7 +7258,7 @@ export declare type SsoGroupDestroyTargetSchema = SsoGroup;
|
|
|
7258
7258
|
* This interface was referenced by `SsoGroup`'s JSON-Schema
|
|
7259
7259
|
* via the `definition` "attributes".
|
|
7260
7260
|
*/
|
|
7261
|
-
export
|
|
7261
|
+
export declare type SsoGroupAttributes = {
|
|
7262
7262
|
/**
|
|
7263
7263
|
* Name of the group
|
|
7264
7264
|
*/
|
|
@@ -7267,22 +7267,22 @@ export interface SsoGroupAttributes {
|
|
|
7267
7267
|
* When an user belongs to multiple groups, the role associated to the group with the highest priority will be used
|
|
7268
7268
|
*/
|
|
7269
7269
|
priority: number;
|
|
7270
|
-
}
|
|
7270
|
+
};
|
|
7271
7271
|
/**
|
|
7272
7272
|
* JSON API links
|
|
7273
7273
|
*
|
|
7274
7274
|
* This interface was referenced by `SsoGroup`'s JSON-Schema
|
|
7275
7275
|
* via the `definition` "relationships".
|
|
7276
7276
|
*/
|
|
7277
|
-
export
|
|
7277
|
+
export declare type SsoGroupRelationships = {
|
|
7278
7278
|
role: RoleData;
|
|
7279
7279
|
users: SsoUserData[];
|
|
7280
|
-
}
|
|
7280
|
+
};
|
|
7281
7281
|
/**
|
|
7282
7282
|
* This interface was referenced by `SsoGroup`'s JSON-Schema
|
|
7283
7283
|
* via the `update.schema` link.
|
|
7284
7284
|
*/
|
|
7285
|
-
export
|
|
7285
|
+
export declare type SsoGroupUpdateSchema = {
|
|
7286
7286
|
id?: SsoGroupIdentity;
|
|
7287
7287
|
type?: SsoGroupType;
|
|
7288
7288
|
/**
|
|
@@ -7290,14 +7290,14 @@ export interface SsoGroupUpdateSchema {
|
|
|
7290
7290
|
*/
|
|
7291
7291
|
priority: number;
|
|
7292
7292
|
role: RoleData;
|
|
7293
|
-
}
|
|
7293
|
+
};
|
|
7294
7294
|
/**
|
|
7295
7295
|
* Represents the Single Sign-on settings of the current DatoCMS project
|
|
7296
7296
|
*
|
|
7297
7297
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7298
7298
|
* via the `definition` "sso_settings".
|
|
7299
7299
|
*/
|
|
7300
|
-
export
|
|
7300
|
+
export declare type SsoSettings = {
|
|
7301
7301
|
id: SsoSettingsIdentity;
|
|
7302
7302
|
type: SsoSettingsType;
|
|
7303
7303
|
/**
|
|
@@ -7329,7 +7329,7 @@ export interface SsoSettings {
|
|
|
7329
7329
|
*/
|
|
7330
7330
|
scim_api_token?: string;
|
|
7331
7331
|
default_role: null | RoleData;
|
|
7332
|
-
}
|
|
7332
|
+
};
|
|
7333
7333
|
export declare type SsoSettingsSelfTargetSchema = SsoSettings;
|
|
7334
7334
|
export declare type SsoSettingsUpdateTargetSchema = SsoSettings;
|
|
7335
7335
|
/**
|
|
@@ -7338,17 +7338,17 @@ export declare type SsoSettingsUpdateTargetSchema = SsoSettings;
|
|
|
7338
7338
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
7339
7339
|
* via the `definition` "data".
|
|
7340
7340
|
*/
|
|
7341
|
-
export
|
|
7341
|
+
export declare type SsoSettingsData = {
|
|
7342
7342
|
type: SsoSettingsType;
|
|
7343
7343
|
id: SsoSettingsIdentity;
|
|
7344
|
-
}
|
|
7344
|
+
};
|
|
7345
7345
|
/**
|
|
7346
7346
|
* JSON API attributes
|
|
7347
7347
|
*
|
|
7348
7348
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
7349
7349
|
* via the `definition` "attributes".
|
|
7350
7350
|
*/
|
|
7351
|
-
export
|
|
7351
|
+
export declare type SsoSettingsAttributes = {
|
|
7352
7352
|
/**
|
|
7353
7353
|
* URL of Identity Provider SAML Metadata endpoint
|
|
7354
7354
|
*/
|
|
@@ -7377,21 +7377,21 @@ export interface SsoSettingsAttributes {
|
|
|
7377
7377
|
* DatoCMS SCIM API Token
|
|
7378
7378
|
*/
|
|
7379
7379
|
scim_api_token?: string;
|
|
7380
|
-
}
|
|
7380
|
+
};
|
|
7381
7381
|
/**
|
|
7382
7382
|
* JSON API links
|
|
7383
7383
|
*
|
|
7384
7384
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
7385
7385
|
* via the `definition` "relationships".
|
|
7386
7386
|
*/
|
|
7387
|
-
export
|
|
7387
|
+
export declare type SsoSettingsRelationships = {
|
|
7388
7388
|
default_role: null | RoleData;
|
|
7389
|
-
}
|
|
7389
|
+
};
|
|
7390
7390
|
/**
|
|
7391
7391
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
7392
7392
|
* via the `generate_token.targetSchema` link.
|
|
7393
7393
|
*/
|
|
7394
|
-
export
|
|
7394
|
+
export declare type SsoSettingsGenerateTokenTargetSchema = {
|
|
7395
7395
|
id: SsoSettingsIdentity;
|
|
7396
7396
|
/**
|
|
7397
7397
|
* JSON API type field
|
|
@@ -7404,12 +7404,12 @@ export interface SsoSettingsGenerateTokenTargetSchema {
|
|
|
7404
7404
|
scim_api_token: string;
|
|
7405
7405
|
};
|
|
7406
7406
|
[k: string]: unknown;
|
|
7407
|
-
}
|
|
7407
|
+
};
|
|
7408
7408
|
/**
|
|
7409
7409
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
7410
7410
|
* via the `update.schema` link.
|
|
7411
7411
|
*/
|
|
7412
|
-
export
|
|
7412
|
+
export declare type SsoSettingsUpdateSchema = {
|
|
7413
7413
|
id?: SsoSettingsIdentity;
|
|
7414
7414
|
type?: SsoSettingsType;
|
|
7415
7415
|
/**
|
|
@@ -7417,21 +7417,21 @@ export interface SsoSettingsUpdateSchema {
|
|
|
7417
7417
|
*/
|
|
7418
7418
|
idp_saml_metadata_url?: null | string;
|
|
7419
7419
|
default_role: RoleData;
|
|
7420
|
-
}
|
|
7420
|
+
};
|
|
7421
7421
|
/**
|
|
7422
7422
|
* Represents the white-label settings of the current DatoCMS project
|
|
7423
7423
|
*
|
|
7424
7424
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7425
7425
|
* via the `definition` "white_label_settings".
|
|
7426
7426
|
*/
|
|
7427
|
-
export
|
|
7427
|
+
export declare type WhiteLabelSettings = {
|
|
7428
7428
|
id: WhiteLabelSettingsIdentity;
|
|
7429
7429
|
type: WhiteLabelSettingsType;
|
|
7430
7430
|
/**
|
|
7431
7431
|
* URL of custom I18n messages. The :locale placeholder represents the current DatoCMS UI locale.
|
|
7432
7432
|
*/
|
|
7433
7433
|
custom_i18n_messages_template_url: null | string;
|
|
7434
|
-
}
|
|
7434
|
+
};
|
|
7435
7435
|
export declare type WhiteLabelSettingsSelfTargetSchema = WhiteLabelSettings;
|
|
7436
7436
|
export declare type WhiteLabelSettingsUpdateTargetSchema = WhiteLabelSettings;
|
|
7437
7437
|
/**
|
|
@@ -7440,41 +7440,41 @@ export declare type WhiteLabelSettingsUpdateTargetSchema = WhiteLabelSettings;
|
|
|
7440
7440
|
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema
|
|
7441
7441
|
* via the `definition` "data".
|
|
7442
7442
|
*/
|
|
7443
|
-
export
|
|
7443
|
+
export declare type WhiteLabelSettingsData = {
|
|
7444
7444
|
type: WhiteLabelSettingsType;
|
|
7445
7445
|
id: WhiteLabelSettingsIdentity;
|
|
7446
|
-
}
|
|
7446
|
+
};
|
|
7447
7447
|
/**
|
|
7448
7448
|
* JSON API attributes
|
|
7449
7449
|
*
|
|
7450
7450
|
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema
|
|
7451
7451
|
* via the `definition` "attributes".
|
|
7452
7452
|
*/
|
|
7453
|
-
export
|
|
7453
|
+
export declare type WhiteLabelSettingsAttributes = {
|
|
7454
7454
|
/**
|
|
7455
7455
|
* URL of custom I18n messages. The :locale placeholder represents the current DatoCMS UI locale.
|
|
7456
7456
|
*/
|
|
7457
7457
|
custom_i18n_messages_template_url: null | string;
|
|
7458
|
-
}
|
|
7458
|
+
};
|
|
7459
7459
|
/**
|
|
7460
7460
|
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema
|
|
7461
7461
|
* via the `update.schema` link.
|
|
7462
7462
|
*/
|
|
7463
|
-
export
|
|
7463
|
+
export declare type WhiteLabelSettingsUpdateSchema = {
|
|
7464
7464
|
id?: WhiteLabelSettingsIdentity;
|
|
7465
7465
|
type?: WhiteLabelSettingsType;
|
|
7466
7466
|
/**
|
|
7467
7467
|
* URL of custom I18n messages. The :locale placeholder represents the current DatoCMS UI locale.
|
|
7468
7468
|
*/
|
|
7469
7469
|
custom_i18n_messages_template_url?: null | string;
|
|
7470
|
-
}
|
|
7470
|
+
};
|
|
7471
7471
|
/**
|
|
7472
7472
|
* Info that can be accessed by unauthorized users
|
|
7473
7473
|
*
|
|
7474
7474
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7475
7475
|
* via the `definition` "public_info".
|
|
7476
7476
|
*/
|
|
7477
|
-
export
|
|
7477
|
+
export declare type PublicInfo = {
|
|
7478
7478
|
id: PublicInfoIdentity;
|
|
7479
7479
|
type: PublicInfoType;
|
|
7480
7480
|
/**
|
|
@@ -7539,7 +7539,7 @@ export interface PublicInfo {
|
|
|
7539
7539
|
blocks_per_item: number;
|
|
7540
7540
|
[k: string]: unknown;
|
|
7541
7541
|
};
|
|
7542
|
-
}
|
|
7542
|
+
};
|
|
7543
7543
|
export declare type PublicInfoSelfTargetSchema = PublicInfo;
|
|
7544
7544
|
/**
|
|
7545
7545
|
* JSON API data
|
|
@@ -7547,17 +7547,17 @@ export declare type PublicInfoSelfTargetSchema = PublicInfo;
|
|
|
7547
7547
|
* This interface was referenced by `PublicInfo`'s JSON-Schema
|
|
7548
7548
|
* via the `definition` "data".
|
|
7549
7549
|
*/
|
|
7550
|
-
export
|
|
7550
|
+
export declare type PublicInfoData = {
|
|
7551
7551
|
type: PublicInfoType;
|
|
7552
7552
|
id: PublicInfoIdentity;
|
|
7553
|
-
}
|
|
7553
|
+
};
|
|
7554
7554
|
/**
|
|
7555
7555
|
* JSON API attributes
|
|
7556
7556
|
*
|
|
7557
7557
|
* This interface was referenced by `PublicInfo`'s JSON-Schema
|
|
7558
7558
|
* via the `definition` "attributes".
|
|
7559
7559
|
*/
|
|
7560
|
-
export
|
|
7560
|
+
export declare type PublicInfoAttributes = {
|
|
7561
7561
|
/**
|
|
7562
7562
|
* Site name
|
|
7563
7563
|
*/
|
|
@@ -7620,14 +7620,14 @@ export interface PublicInfoAttributes {
|
|
|
7620
7620
|
blocks_per_item: number;
|
|
7621
7621
|
[k: string]: unknown;
|
|
7622
7622
|
};
|
|
7623
|
-
}
|
|
7623
|
+
};
|
|
7624
7624
|
/**
|
|
7625
7625
|
* DatoCMS resources usage organized by day
|
|
7626
7626
|
*
|
|
7627
7627
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7628
7628
|
* via the `definition` "daily_usage".
|
|
7629
7629
|
*/
|
|
7630
|
-
export
|
|
7630
|
+
export declare type DailyUsage = {
|
|
7631
7631
|
id: DailyUsageIdentity;
|
|
7632
7632
|
type: DailyUsageType;
|
|
7633
7633
|
/**
|
|
@@ -7654,7 +7654,7 @@ export interface DailyUsage {
|
|
|
7654
7654
|
* Video streaming seconds
|
|
7655
7655
|
*/
|
|
7656
7656
|
mux_delivered_seconds: number;
|
|
7657
|
-
}
|
|
7657
|
+
};
|
|
7658
7658
|
export declare type DailyUsageInstancesTargetSchema = DailyUsage;
|
|
7659
7659
|
/**
|
|
7660
7660
|
* JSON API data
|
|
@@ -7662,17 +7662,17 @@ export declare type DailyUsageInstancesTargetSchema = DailyUsage;
|
|
|
7662
7662
|
* This interface was referenced by `DailyUsage`'s JSON-Schema
|
|
7663
7663
|
* via the `definition` "data".
|
|
7664
7664
|
*/
|
|
7665
|
-
export
|
|
7665
|
+
export declare type DailyUsageData = {
|
|
7666
7666
|
type: DailyUsageType;
|
|
7667
7667
|
id: DailyUsageIdentity;
|
|
7668
|
-
}
|
|
7668
|
+
};
|
|
7669
7669
|
/**
|
|
7670
7670
|
* JSON API attributes
|
|
7671
7671
|
*
|
|
7672
7672
|
* This interface was referenced by `DailyUsage`'s JSON-Schema
|
|
7673
7673
|
* via the `definition` "attributes".
|
|
7674
7674
|
*/
|
|
7675
|
-
export
|
|
7675
|
+
export declare type DailyUsageAttributes = {
|
|
7676
7676
|
/**
|
|
7677
7677
|
* The date the data are referring to
|
|
7678
7678
|
*/
|
|
@@ -7697,14 +7697,14 @@ export interface DailyUsageAttributes {
|
|
|
7697
7697
|
* Video streaming seconds
|
|
7698
7698
|
*/
|
|
7699
7699
|
mux_delivered_seconds: number;
|
|
7700
|
-
}
|
|
7700
|
+
};
|
|
7701
7701
|
/**
|
|
7702
7702
|
* You can use counters to analyze your project's data consumption over a period of time. Counters are especially useful if your project is exceeding its API calls/traffic quota limits, to better understand where and how requests are originating. Counters are updated every minute, so you can debug in real-time the results of your changes.
|
|
7703
7703
|
*
|
|
7704
7704
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7705
7705
|
* via the `definition` "usage_counter".
|
|
7706
7706
|
*/
|
|
7707
|
-
export
|
|
7707
|
+
export declare type UsageCounter = {
|
|
7708
7708
|
id: UsageCounterIdentity;
|
|
7709
7709
|
type: UsageCounterType;
|
|
7710
7710
|
result: {
|
|
@@ -7717,7 +7717,7 @@ export interface UsageCounter {
|
|
|
7717
7717
|
*/
|
|
7718
7718
|
counter: number;
|
|
7719
7719
|
}[];
|
|
7720
|
-
}
|
|
7720
|
+
};
|
|
7721
7721
|
export declare type UsageCounterSelfTargetSchema = UsageCounter;
|
|
7722
7722
|
/**
|
|
7723
7723
|
* JSON API data
|
|
@@ -7725,17 +7725,17 @@ export declare type UsageCounterSelfTargetSchema = UsageCounter;
|
|
|
7725
7725
|
* This interface was referenced by `UsageCounter`'s JSON-Schema
|
|
7726
7726
|
* via the `definition` "data".
|
|
7727
7727
|
*/
|
|
7728
|
-
export
|
|
7728
|
+
export declare type UsageCounterData = {
|
|
7729
7729
|
type: UsageCounterType;
|
|
7730
7730
|
id: UsageCounterIdentity;
|
|
7731
|
-
}
|
|
7731
|
+
};
|
|
7732
7732
|
/**
|
|
7733
7733
|
* JSON API attributes
|
|
7734
7734
|
*
|
|
7735
7735
|
* This interface was referenced by `UsageCounter`'s JSON-Schema
|
|
7736
7736
|
* via the `definition` "attributes".
|
|
7737
7737
|
*/
|
|
7738
|
-
export
|
|
7738
|
+
export declare type UsageCounterAttributes = {
|
|
7739
7739
|
result: {
|
|
7740
7740
|
/**
|
|
7741
7741
|
* Occurrence
|
|
@@ -7746,21 +7746,21 @@ export interface UsageCounterAttributes {
|
|
|
7746
7746
|
*/
|
|
7747
7747
|
counter: number;
|
|
7748
7748
|
}[];
|
|
7749
|
-
}
|
|
7749
|
+
};
|
|
7750
7750
|
/**
|
|
7751
7751
|
* All the project's upload tags
|
|
7752
7752
|
*
|
|
7753
7753
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7754
7754
|
* via the `definition` "upload_tag".
|
|
7755
7755
|
*/
|
|
7756
|
-
export
|
|
7756
|
+
export declare type UploadTag = {
|
|
7757
7757
|
id: UploadTagIdentity;
|
|
7758
7758
|
type: UploadTagType;
|
|
7759
7759
|
/**
|
|
7760
7760
|
* The tag name
|
|
7761
7761
|
*/
|
|
7762
7762
|
name: string;
|
|
7763
|
-
}
|
|
7763
|
+
};
|
|
7764
7764
|
export declare type UploadTagCreateTargetSchema = UploadTag;
|
|
7765
7765
|
/**
|
|
7766
7766
|
* JSON API data
|
|
@@ -7768,76 +7768,76 @@ export declare type UploadTagCreateTargetSchema = UploadTag;
|
|
|
7768
7768
|
* This interface was referenced by `UploadTag`'s JSON-Schema
|
|
7769
7769
|
* via the `definition` "data".
|
|
7770
7770
|
*/
|
|
7771
|
-
export
|
|
7771
|
+
export declare type UploadTagData = {
|
|
7772
7772
|
type: UploadTagType;
|
|
7773
7773
|
id: UploadTagIdentity;
|
|
7774
|
-
}
|
|
7774
|
+
};
|
|
7775
7775
|
/**
|
|
7776
7776
|
* JSON API attributes
|
|
7777
7777
|
*
|
|
7778
7778
|
* This interface was referenced by `UploadTag`'s JSON-Schema
|
|
7779
7779
|
* via the `definition` "attributes".
|
|
7780
7780
|
*/
|
|
7781
|
-
export
|
|
7781
|
+
export declare type UploadTagAttributes = {
|
|
7782
7782
|
/**
|
|
7783
7783
|
* The tag name
|
|
7784
7784
|
*/
|
|
7785
7785
|
name: string;
|
|
7786
|
-
}
|
|
7786
|
+
};
|
|
7787
7787
|
/**
|
|
7788
7788
|
* This interface was referenced by `UploadTag`'s JSON-Schema
|
|
7789
7789
|
* via the `create.schema` link.
|
|
7790
7790
|
*/
|
|
7791
|
-
export
|
|
7791
|
+
export declare type UploadTagCreateSchema = {
|
|
7792
7792
|
type?: UploadTagType;
|
|
7793
7793
|
/**
|
|
7794
7794
|
* The tag name
|
|
7795
7795
|
*/
|
|
7796
7796
|
name: string;
|
|
7797
|
-
}
|
|
7797
|
+
};
|
|
7798
7798
|
/**
|
|
7799
7799
|
* All the site's upload automatically generated tags
|
|
7800
7800
|
*
|
|
7801
7801
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7802
7802
|
* via the `definition` "upload_smart_tag".
|
|
7803
7803
|
*/
|
|
7804
|
-
export
|
|
7804
|
+
export declare type UploadSmartTag = {
|
|
7805
7805
|
id: UploadSmartTagIdentity;
|
|
7806
7806
|
type: UploadSmartTagType;
|
|
7807
7807
|
/**
|
|
7808
7808
|
* The tag name
|
|
7809
7809
|
*/
|
|
7810
7810
|
name: string;
|
|
7811
|
-
}
|
|
7811
|
+
};
|
|
7812
7812
|
/**
|
|
7813
7813
|
* JSON API data
|
|
7814
7814
|
*
|
|
7815
7815
|
* This interface was referenced by `UploadSmartTag`'s JSON-Schema
|
|
7816
7816
|
* via the `definition` "data".
|
|
7817
7817
|
*/
|
|
7818
|
-
export
|
|
7818
|
+
export declare type UploadSmartTagData = {
|
|
7819
7819
|
type: UploadSmartTagType;
|
|
7820
7820
|
id: UploadSmartTagIdentity;
|
|
7821
|
-
}
|
|
7821
|
+
};
|
|
7822
7822
|
/**
|
|
7823
7823
|
* JSON API attributes
|
|
7824
7824
|
*
|
|
7825
7825
|
* This interface was referenced by `UploadSmartTag`'s JSON-Schema
|
|
7826
7826
|
* via the `definition` "attributes".
|
|
7827
7827
|
*/
|
|
7828
|
-
export
|
|
7828
|
+
export declare type UploadSmartTagAttributes = {
|
|
7829
7829
|
/**
|
|
7830
7830
|
* The tag name
|
|
7831
7831
|
*/
|
|
7832
7832
|
name: string;
|
|
7833
|
-
}
|
|
7833
|
+
};
|
|
7834
7834
|
/**
|
|
7835
7835
|
* A site represents a specific DatoCMS administrative area
|
|
7836
7836
|
*
|
|
7837
7837
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
7838
7838
|
* via the `definition` "site".
|
|
7839
7839
|
*/
|
|
7840
|
-
export
|
|
7840
|
+
export declare type Site = {
|
|
7841
7841
|
id: SiteIdentity;
|
|
7842
7842
|
type: SiteType;
|
|
7843
7843
|
/**
|
|
@@ -7994,7 +7994,7 @@ export interface Site {
|
|
|
7994
7994
|
* The list of site roles
|
|
7995
7995
|
*/
|
|
7996
7996
|
roles: RoleData[];
|
|
7997
|
-
}
|
|
7997
|
+
};
|
|
7998
7998
|
export declare type SiteSelfTargetSchema = Site;
|
|
7999
7999
|
export declare type SiteUpdateJobSchema = Site;
|
|
8000
8000
|
/**
|
|
@@ -8003,17 +8003,17 @@ export declare type SiteUpdateJobSchema = Site;
|
|
|
8003
8003
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
8004
8004
|
* via the `definition` "data".
|
|
8005
8005
|
*/
|
|
8006
|
-
export
|
|
8006
|
+
export declare type SiteData = {
|
|
8007
8007
|
type: SiteType;
|
|
8008
8008
|
id: SiteIdentity;
|
|
8009
|
-
}
|
|
8009
|
+
};
|
|
8010
8010
|
/**
|
|
8011
8011
|
* JSON API attributes
|
|
8012
8012
|
*
|
|
8013
8013
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
8014
8014
|
* via the `definition` "attributes".
|
|
8015
8015
|
*/
|
|
8016
|
-
export
|
|
8016
|
+
export declare type SiteAttributes = {
|
|
8017
8017
|
/**
|
|
8018
8018
|
* Site name
|
|
8019
8019
|
*/
|
|
@@ -8139,14 +8139,14 @@ export interface SiteAttributes {
|
|
|
8139
8139
|
twitter_account?: null | string;
|
|
8140
8140
|
[k: string]: unknown;
|
|
8141
8141
|
} | null;
|
|
8142
|
-
}
|
|
8142
|
+
};
|
|
8143
8143
|
/**
|
|
8144
8144
|
* JSON API links
|
|
8145
8145
|
*
|
|
8146
8146
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
8147
8147
|
* via the `definition` "relationships".
|
|
8148
8148
|
*/
|
|
8149
|
-
export
|
|
8149
|
+
export declare type SiteRelationships = {
|
|
8150
8150
|
account: AccountData;
|
|
8151
8151
|
/**
|
|
8152
8152
|
* The list of build trigger
|
|
@@ -8176,12 +8176,12 @@ export interface SiteRelationships {
|
|
|
8176
8176
|
* The list of site roles
|
|
8177
8177
|
*/
|
|
8178
8178
|
roles: RoleData[];
|
|
8179
|
-
}
|
|
8179
|
+
};
|
|
8180
8180
|
/**
|
|
8181
8181
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
8182
8182
|
* via the `update.schema` link.
|
|
8183
8183
|
*/
|
|
8184
|
-
export
|
|
8184
|
+
export declare type SiteUpdateSchema = {
|
|
8185
8185
|
id?: SiteIdentity;
|
|
8186
8186
|
type?: SiteType;
|
|
8187
8187
|
/**
|
|
@@ -8286,14 +8286,14 @@ export interface SiteUpdateSchema {
|
|
|
8286
8286
|
*/
|
|
8287
8287
|
ip_tracking_enabled?: boolean;
|
|
8288
8288
|
sso_default_role?: RoleData;
|
|
8289
|
-
}
|
|
8289
|
+
};
|
|
8290
8290
|
/**
|
|
8291
8291
|
* Through workflows it is possible to set up a precise state machine able to bring a draft content up to the final publication (and beyond), through a series of intermediate, fully customizable approval steps.
|
|
8292
8292
|
*
|
|
8293
8293
|
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
8294
8294
|
* via the `definition` "workflow".
|
|
8295
8295
|
*/
|
|
8296
|
-
export
|
|
8296
|
+
export declare type Workflow = {
|
|
8297
8297
|
id: WorkflowIdentity;
|
|
8298
8298
|
type: WorkflowType;
|
|
8299
8299
|
/**
|
|
@@ -8341,7 +8341,7 @@ export interface Workflow {
|
|
|
8341
8341
|
initial?: boolean;
|
|
8342
8342
|
}[]
|
|
8343
8343
|
];
|
|
8344
|
-
}
|
|
8344
|
+
};
|
|
8345
8345
|
export declare type WorkflowCreateTargetSchema = Workflow;
|
|
8346
8346
|
export declare type WorkflowUpdateTargetSchema = Workflow;
|
|
8347
8347
|
export declare type WorkflowSelfTargetSchema = Workflow;
|
|
@@ -8351,7 +8351,7 @@ export declare type WorkflowSelfTargetSchema = Workflow;
|
|
|
8351
8351
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
8352
8352
|
* via the `definition` "attributes".
|
|
8353
8353
|
*/
|
|
8354
|
-
export
|
|
8354
|
+
export declare type WorkflowAttributes = {
|
|
8355
8355
|
/**
|
|
8356
8356
|
* The name of the workflow
|
|
8357
8357
|
*/
|
|
@@ -8397,12 +8397,12 @@ export interface WorkflowAttributes {
|
|
|
8397
8397
|
initial?: boolean;
|
|
8398
8398
|
}[]
|
|
8399
8399
|
];
|
|
8400
|
-
}
|
|
8400
|
+
};
|
|
8401
8401
|
/**
|
|
8402
8402
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
8403
8403
|
* via the `create.schema` link.
|
|
8404
8404
|
*/
|
|
8405
|
-
export
|
|
8405
|
+
export declare type WorkflowCreateSchema = {
|
|
8406
8406
|
id?: WorkflowIdentity;
|
|
8407
8407
|
type?: WorkflowType;
|
|
8408
8408
|
/**
|
|
@@ -8450,12 +8450,12 @@ export interface WorkflowCreateSchema {
|
|
|
8450
8450
|
initial?: boolean;
|
|
8451
8451
|
}[]
|
|
8452
8452
|
];
|
|
8453
|
-
}
|
|
8453
|
+
};
|
|
8454
8454
|
/**
|
|
8455
8455
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
8456
8456
|
* via the `update.schema` link.
|
|
8457
8457
|
*/
|
|
8458
|
-
export
|
|
8458
|
+
export declare type WorkflowUpdateSchema = {
|
|
8459
8459
|
id?: WorkflowIdentity;
|
|
8460
8460
|
type?: WorkflowType;
|
|
8461
8461
|
/**
|
|
@@ -8503,4 +8503,4 @@ export interface WorkflowUpdateSchema {
|
|
|
8503
8503
|
initial?: boolean;
|
|
8504
8504
|
}[]
|
|
8505
8505
|
];
|
|
8506
|
-
}
|
|
8506
|
+
};
|