datocms-plugin-sdk 0.3.7 → 0.3.24-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/connect.js +18 -7
- package/dist/cjs/connect.js.map +1 -1
- package/dist/cjs/guards.js +2 -1
- package/dist/cjs/guards.js.map +1 -1
- package/dist/esm/SiteApiSchema.d.ts +165 -81
- package/dist/esm/connect.d.ts +45 -26
- package/dist/esm/connect.js +19 -8
- package/dist/esm/connect.js.map +1 -1
- package/dist/esm/guards.d.ts +4 -1
- package/dist/esm/guards.js +1 -0
- package/dist/esm/guards.js.map +1 -1
- package/dist/esm/types.d.ts +591 -313
- package/dist/types/SiteApiSchema.d.ts +165 -81
- package/dist/types/connect.d.ts +45 -26
- package/dist/types/guards.d.ts +4 -1
- package/dist/types/types.d.ts +591 -313
- package/package.json +2 -2
- package/types.json +3079 -1488
|
@@ -283,8 +283,8 @@ export declare type SubscriptionLimitType = 'subscription_limit';
|
|
|
283
283
|
/**
|
|
284
284
|
* ID of limit
|
|
285
285
|
*
|
|
286
|
-
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
287
|
-
* "identity".
|
|
286
|
+
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
287
|
+
* `definition` "identity".
|
|
288
288
|
*
|
|
289
289
|
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the `definition` "id".
|
|
290
290
|
*/
|
|
@@ -292,7 +292,8 @@ export declare type SubscriptionLimitIdentity = string;
|
|
|
292
292
|
/**
|
|
293
293
|
* JSON API type field
|
|
294
294
|
*
|
|
295
|
-
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
295
|
+
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
296
|
+
* `definition` "type".
|
|
296
297
|
*/
|
|
297
298
|
export declare type SubscriptionFeatureType = 'subscription_feature';
|
|
298
299
|
/**
|
|
@@ -334,8 +335,8 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
334
335
|
/** Attributes to filter records */
|
|
335
336
|
filter?: {
|
|
336
337
|
/**
|
|
337
|
-
* Record (or block record) IDs to fetch, comma separated. If you use this filter,
|
|
338
|
-
* *must not* use `filter[type]` or `filter[fields]`
|
|
338
|
+
* Record (or block record) IDs to fetch, comma separated. If you use this filter,
|
|
339
|
+
* you *must not* use `filter[type]` or `filter[fields]`
|
|
339
340
|
*/
|
|
340
341
|
ids?: string;
|
|
341
342
|
/**
|
|
@@ -374,9 +375,9 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
374
375
|
[k: string]: unknown;
|
|
375
376
|
};
|
|
376
377
|
/**
|
|
377
|
-
* Fields used to order results. You *must* specify also `filter[type]` with one
|
|
378
|
-
* only to be able use this option. Format:
|
|
379
|
-
* can pass multiple comma separated rules
|
|
378
|
+
* Fields used to order results. You *must* specify also `filter[type]` with one
|
|
379
|
+
* element only to be able use this option. Format:
|
|
380
|
+
* `<field_name>_<DIRECTION(ASC|DESC)>`. You can pass multiple comma separated rules
|
|
380
381
|
*/
|
|
381
382
|
order_by?: string;
|
|
382
383
|
/**
|
|
@@ -389,8 +390,8 @@ export declare type ItemInstancesHrefSchema = {
|
|
|
389
390
|
/** This interface was referenced by `Item`'s JSON-Schema via the `references.hrefSchema` link. */
|
|
390
391
|
export declare type ItemReferencesHrefSchema = {
|
|
391
392
|
/**
|
|
392
|
-
* For Modular Content fields and Structured Text fields, return full payload for
|
|
393
|
-
* blocks instead of IDs
|
|
393
|
+
* For Modular Content fields and Structured Text fields, return full payload for
|
|
394
|
+
* nested blocks instead of IDs
|
|
394
395
|
*/
|
|
395
396
|
nested?: 'true';
|
|
396
397
|
/**
|
|
@@ -511,7 +512,10 @@ export declare type UploadInstancesHrefSchema = {
|
|
|
511
512
|
};
|
|
512
513
|
[k: string]: unknown;
|
|
513
514
|
};
|
|
514
|
-
/**
|
|
515
|
+
/**
|
|
516
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
517
|
+
* `batch_add_tags.hrefSchema` link.
|
|
518
|
+
*/
|
|
515
519
|
export declare type UploadBatchAddTagsHrefSchema = {
|
|
516
520
|
/** IDs to tag, comma separated */
|
|
517
521
|
'filter[ids]'?: string;
|
|
@@ -526,8 +530,8 @@ export declare type UploadBatchDestroyHrefSchema = {
|
|
|
526
530
|
/** This interface was referenced by `Upload`'s JSON-Schema via the `references.hrefSchema` link. */
|
|
527
531
|
export declare type UploadReferencesHrefSchema = {
|
|
528
532
|
/**
|
|
529
|
-
* For Modular Content fields and Structured Text fields, return full payload for
|
|
530
|
-
* blocks instead of IDs
|
|
533
|
+
* For Modular Content fields and Structured Text fields, return full payload for
|
|
534
|
+
* nested blocks instead of IDs
|
|
531
535
|
*/
|
|
532
536
|
nested?: string;
|
|
533
537
|
/**
|
|
@@ -580,7 +584,8 @@ export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
|
580
584
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
|
|
581
585
|
* `definition` "identity".
|
|
582
586
|
*
|
|
583
|
-
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
|
|
587
|
+
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema via the
|
|
588
|
+
* `definition` "id".
|
|
584
589
|
*/
|
|
585
590
|
export declare type ScheduledUnpublishingIdentity = string;
|
|
586
591
|
/**
|
|
@@ -629,7 +634,8 @@ export declare type MaintenanceModeType = 'maintenance_mode';
|
|
|
629
634
|
/**
|
|
630
635
|
* ID of maintenance_mode
|
|
631
636
|
*
|
|
632
|
-
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition`
|
|
637
|
+
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition`
|
|
638
|
+
* "identity".
|
|
633
639
|
*
|
|
634
640
|
* This interface was referenced by `MaintenanceMode`'s JSON-Schema via the `definition` "id".
|
|
635
641
|
*/
|
|
@@ -962,7 +968,10 @@ export interface RoleAttributes {
|
|
|
962
968
|
on_creator?: 'anyone' | 'self' | 'role' | null;
|
|
963
969
|
/** Permitted content scope */
|
|
964
970
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
965
|
-
/**
|
|
971
|
+
/**
|
|
972
|
+
* Permitted localized content in this locale. Required when `localization_scope` is
|
|
973
|
+
* `localized`
|
|
974
|
+
*/
|
|
966
975
|
locale?: string | null;
|
|
967
976
|
}[];
|
|
968
977
|
/** Prohibited actions on a model (or all) for a role */
|
|
@@ -978,7 +987,10 @@ export interface RoleAttributes {
|
|
|
978
987
|
on_creator?: 'anyone' | 'self' | 'role' | null;
|
|
979
988
|
/** Permitted content scope */
|
|
980
989
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
981
|
-
/**
|
|
990
|
+
/**
|
|
991
|
+
* Permitted localized content in this locale. Required when `localization_scope` is
|
|
992
|
+
* `localized`
|
|
993
|
+
*/
|
|
982
994
|
locale?: string | null;
|
|
983
995
|
}[];
|
|
984
996
|
/** Allowed actions on a model (or all) for a role */
|
|
@@ -990,7 +1002,10 @@ export interface RoleAttributes {
|
|
|
990
1002
|
on_creator?: 'anyone' | 'self' | 'role' | null;
|
|
991
1003
|
/** Permitted content scope */
|
|
992
1004
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
993
|
-
/**
|
|
1005
|
+
/**
|
|
1006
|
+
* Permitted localized content in this locale. Required when `localization_scope` is
|
|
1007
|
+
* `localized`
|
|
1008
|
+
*/
|
|
994
1009
|
locale?: string | null;
|
|
995
1010
|
}[];
|
|
996
1011
|
/** Prohibited actions on a model (or all) for a role */
|
|
@@ -1002,7 +1017,10 @@ export interface RoleAttributes {
|
|
|
1002
1017
|
on_creator?: 'anyone' | 'self' | 'role' | null;
|
|
1003
1018
|
/** Permitted content scope */
|
|
1004
1019
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1005
|
-
/**
|
|
1020
|
+
/**
|
|
1021
|
+
* Permitted localized content in this locale. Required when `localization_scope` is
|
|
1022
|
+
* `localized`
|
|
1023
|
+
*/
|
|
1006
1024
|
locale?: string | null;
|
|
1007
1025
|
}[];
|
|
1008
1026
|
/** Allowed build triggers for a role */
|
|
@@ -1092,8 +1110,8 @@ export interface RoleMeta {
|
|
|
1092
1110
|
/** Permitted content scope */
|
|
1093
1111
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1094
1112
|
/**
|
|
1095
|
-
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1096
|
-
* `localized`
|
|
1113
|
+
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1114
|
+
* is `localized`
|
|
1097
1115
|
*/
|
|
1098
1116
|
locale?: string | null;
|
|
1099
1117
|
}[];
|
|
@@ -1111,8 +1129,8 @@ export interface RoleMeta {
|
|
|
1111
1129
|
/** Permitted content scope */
|
|
1112
1130
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1113
1131
|
/**
|
|
1114
|
-
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1115
|
-
* `localized`
|
|
1132
|
+
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1133
|
+
* is `localized`
|
|
1116
1134
|
*/
|
|
1117
1135
|
locale?: string | null;
|
|
1118
1136
|
}[];
|
|
@@ -1126,8 +1144,8 @@ export interface RoleMeta {
|
|
|
1126
1144
|
/** Permitted content scope */
|
|
1127
1145
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1128
1146
|
/**
|
|
1129
|
-
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1130
|
-
* `localized`
|
|
1147
|
+
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1148
|
+
* is `localized`
|
|
1131
1149
|
*/
|
|
1132
1150
|
locale?: string | null;
|
|
1133
1151
|
}[];
|
|
@@ -1141,8 +1159,8 @@ export interface RoleMeta {
|
|
|
1141
1159
|
/** Permitted content scope */
|
|
1142
1160
|
localization_scope?: 'all' | 'localized' | 'not_localized' | null;
|
|
1143
1161
|
/**
|
|
1144
|
-
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1145
|
-
* `localized`
|
|
1162
|
+
* Permitted localized content in this locale. Required when `localization_scope`
|
|
1163
|
+
* is `localized`
|
|
1146
1164
|
*/
|
|
1147
1165
|
locale?: string | null;
|
|
1148
1166
|
}[];
|
|
@@ -1440,9 +1458,9 @@ export interface RoleDestroyTargetSchema {
|
|
|
1440
1458
|
data: Role;
|
|
1441
1459
|
}
|
|
1442
1460
|
/**
|
|
1443
|
-
* A DatoCMS administrative area can be accessed by multiple people. Every collaborator
|
|
1444
|
-
* linked to a specific Role, which describes what actions it will be able to perform
|
|
1445
|
-
* logged in.
|
|
1461
|
+
* A DatoCMS administrative area can be accessed by multiple people. Every collaborator
|
|
1462
|
+
* is linked to a specific Role, which describes what actions it will be able to perform
|
|
1463
|
+
* once logged in.
|
|
1446
1464
|
*
|
|
1447
1465
|
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "user".
|
|
1448
1466
|
*/
|
|
@@ -1638,7 +1656,8 @@ export interface AuditLogEvent {
|
|
|
1638
1656
|
/**
|
|
1639
1657
|
* JSON API attributes
|
|
1640
1658
|
*
|
|
1641
|
-
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition`
|
|
1659
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the `definition`
|
|
1660
|
+
* "attributes".
|
|
1642
1661
|
*/
|
|
1643
1662
|
export interface AuditLogEventAttributes {
|
|
1644
1663
|
/** The actual action performed */
|
|
@@ -1716,8 +1735,8 @@ export interface AuditLogEventQuerySchema {
|
|
|
1716
1735
|
/** An SQL-like expression to filter the events */
|
|
1717
1736
|
filter?: string;
|
|
1718
1737
|
/**
|
|
1719
|
-
* Set this value to get remaining results, if a meta.next_token was returned in
|
|
1720
|
-
* previous query response
|
|
1738
|
+
* Set this value to get remaining results, if a meta.next_token was returned in
|
|
1739
|
+
* the previous query response
|
|
1721
1740
|
*/
|
|
1722
1741
|
next_token?: string;
|
|
1723
1742
|
/**
|
|
@@ -1728,7 +1747,10 @@ export interface AuditLogEventQuerySchema {
|
|
|
1728
1747
|
};
|
|
1729
1748
|
};
|
|
1730
1749
|
}
|
|
1731
|
-
/**
|
|
1750
|
+
/**
|
|
1751
|
+
* This interface was referenced by `AuditLogEvent`'s JSON-Schema via the
|
|
1752
|
+
* `query.targetSchema` link.
|
|
1753
|
+
*/
|
|
1732
1754
|
export interface AuditLogEventQueryTargetSchema {
|
|
1733
1755
|
data: AuditLogEvent[];
|
|
1734
1756
|
meta: {
|
|
@@ -1779,7 +1801,8 @@ export interface AccountData {
|
|
|
1779
1801
|
/**
|
|
1780
1802
|
* Stores the information regarding the current plan for the project.
|
|
1781
1803
|
*
|
|
1782
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
1804
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
1805
|
+
* "site_plan".
|
|
1783
1806
|
*/
|
|
1784
1807
|
export interface SitePlan {
|
|
1785
1808
|
type: SitePlanType;
|
|
@@ -1932,7 +1955,8 @@ export interface SitePlanData {
|
|
|
1932
1955
|
* In DatoCMS you can organize the different Models present in your administrative area
|
|
1933
1956
|
* reordering and grouping them, so that their purpose will be more clear to the final editor.
|
|
1934
1957
|
*
|
|
1935
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
1958
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
1959
|
+
* "menu_item".
|
|
1936
1960
|
*/
|
|
1937
1961
|
export interface MenuItem {
|
|
1938
1962
|
type: MenuItemType;
|
|
@@ -2072,7 +2096,8 @@ export interface MenuItemDestroyTargetSchema {
|
|
|
2072
2096
|
* passes through the concept of Models, which are much like database tables. For
|
|
2073
2097
|
* backward-compatibility reasons, the API refers to models as "item types".
|
|
2074
2098
|
*
|
|
2075
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
2099
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
2100
|
+
* "item_type".
|
|
2076
2101
|
*/
|
|
2077
2102
|
export interface ModelBlock {
|
|
2078
2103
|
type: ItemTypeType;
|
|
@@ -2121,7 +2146,8 @@ export interface ItemTypeAttributes {
|
|
|
2121
2146
|
/**
|
|
2122
2147
|
* JSON API links
|
|
2123
2148
|
*
|
|
2124
|
-
* This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition`
|
|
2149
|
+
* This interface was referenced by `ModelBlock`'s JSON-Schema via the `definition`
|
|
2150
|
+
* "relationships".
|
|
2125
2151
|
*/
|
|
2126
2152
|
export interface ItemTypeRelationships {
|
|
2127
2153
|
/** The item instance related to this item type */
|
|
@@ -2331,8 +2357,8 @@ export interface ItemTypeDestroyJobSchema {
|
|
|
2331
2357
|
}
|
|
2332
2358
|
/**
|
|
2333
2359
|
* Each Model consists of a set of fields. Using the database metaphore, fields are like
|
|
2334
|
-
* table columns, and when creating them you need to specify their type (`string`,
|
|
2335
|
-
* `float`, etc.) and any required validation.
|
|
2360
|
+
* table columns, and when creating them you need to specify their type (`string`,
|
|
2361
|
+
* `file`, `float`, etc.) and any required validation.
|
|
2336
2362
|
*
|
|
2337
2363
|
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition` "field".
|
|
2338
2364
|
*/
|
|
@@ -2380,8 +2406,8 @@ export interface FieldAttributes {
|
|
|
2380
2406
|
/** Field appearance details, plugin configuration and field add-ons */
|
|
2381
2407
|
appearance: {
|
|
2382
2408
|
/**
|
|
2383
|
-
* A valid editor can be a DatoCMS default field editor type (ie. `"single_line"`),
|
|
2384
|
-
* a plugin ID offering a custom field editor
|
|
2409
|
+
* A valid editor can be a DatoCMS default field editor type (ie. `"single_line"`),
|
|
2410
|
+
* or a plugin ID offering a custom field editor
|
|
2385
2411
|
*/
|
|
2386
2412
|
editor: string;
|
|
2387
2413
|
/** The specific field extension to use for the field (only if the editor is a modern plugin) */
|
|
@@ -2463,7 +2489,10 @@ export interface FieldCreateSchema {
|
|
|
2463
2489
|
* `"single_line"`), or a plugin ID offering a custom field editor
|
|
2464
2490
|
*/
|
|
2465
2491
|
editor: string;
|
|
2466
|
-
/**
|
|
2492
|
+
/**
|
|
2493
|
+
* The specific field extension to use for the field (only if the editor is a
|
|
2494
|
+
* modern plugin)
|
|
2495
|
+
*/
|
|
2467
2496
|
field_extension?: string;
|
|
2468
2497
|
/** The editor plugin's parameters */
|
|
2469
2498
|
parameters: {
|
|
@@ -2553,7 +2582,10 @@ export interface FieldUpdateSchema {
|
|
|
2553
2582
|
* `"single_line"`), or a plugin ID offering a custom field editor
|
|
2554
2583
|
*/
|
|
2555
2584
|
editor: string;
|
|
2556
|
-
/**
|
|
2585
|
+
/**
|
|
2586
|
+
* The specific field extension to use for the field (only if the editor is a
|
|
2587
|
+
* modern plugin)
|
|
2588
|
+
*/
|
|
2557
2589
|
field_extension?: string;
|
|
2558
2590
|
/** The editor plugin's parameters */
|
|
2559
2591
|
parameters: {
|
|
@@ -2925,7 +2957,10 @@ export interface AccessTokenSelfTargetSchema {
|
|
|
2925
2957
|
export interface AccessTokenRegenerateTokenTargetSchema {
|
|
2926
2958
|
data: AccessToken;
|
|
2927
2959
|
}
|
|
2928
|
-
/**
|
|
2960
|
+
/**
|
|
2961
|
+
* This interface was referenced by `AccessToken`'s JSON-Schema via the
|
|
2962
|
+
* `destroy.targetSchema` link.
|
|
2963
|
+
*/
|
|
2929
2964
|
export interface AccessTokenDestroyTargetSchema {
|
|
2930
2965
|
data: AccessToken;
|
|
2931
2966
|
}
|
|
@@ -3010,7 +3045,10 @@ export interface PluginCreateSchema {
|
|
|
3010
3045
|
description?: string;
|
|
3011
3046
|
/** The entry point URL of the plugin. Only to be passed if package name key is not specified. */
|
|
3012
3047
|
url?: string;
|
|
3013
|
-
/**
|
|
3048
|
+
/**
|
|
3049
|
+
* Permissions granted to this plugin. Only to be passed if package name key is not
|
|
3050
|
+
* specified.
|
|
3051
|
+
*/
|
|
3014
3052
|
permissions?: 'currentUserAccessToken'[];
|
|
3015
3053
|
/**
|
|
3016
3054
|
* The type of field extension this legacy plugin implements. Only to be passed if
|
|
@@ -3132,8 +3170,8 @@ export interface SubscriptionLimit {
|
|
|
3132
3170
|
/**
|
|
3133
3171
|
* JSON API attributes
|
|
3134
3172
|
*
|
|
3135
|
-
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
3136
|
-
* "attributes".
|
|
3173
|
+
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema via the
|
|
3174
|
+
* `definition` "attributes".
|
|
3137
3175
|
*/
|
|
3138
3176
|
export interface SubscriptionLimitAttributes {
|
|
3139
3177
|
/** The codename for the limit */
|
|
@@ -3192,7 +3230,8 @@ export interface SubscriptionFeatureAttributes {
|
|
|
3192
3230
|
/**
|
|
3193
3231
|
* JSON API data
|
|
3194
3232
|
*
|
|
3195
|
-
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
3233
|
+
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema via the
|
|
3234
|
+
* `definition` "data".
|
|
3196
3235
|
*/
|
|
3197
3236
|
export interface SubscriptionFeatureData {
|
|
3198
3237
|
type: SubscriptionFeatureType;
|
|
@@ -3235,7 +3274,8 @@ export interface BuildEventAttributes {
|
|
|
3235
3274
|
/**
|
|
3236
3275
|
* JSON API links
|
|
3237
3276
|
*
|
|
3238
|
-
* This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition`
|
|
3277
|
+
* This interface was referenced by `BuildEvent`'s JSON-Schema via the `definition`
|
|
3278
|
+
* "relationships".
|
|
3239
3279
|
*/
|
|
3240
3280
|
export interface BuildEventRelationships {
|
|
3241
3281
|
/** Source build trigger */
|
|
@@ -3582,7 +3622,10 @@ export interface ItemBulkUnpublishSchema {
|
|
|
3582
3622
|
};
|
|
3583
3623
|
};
|
|
3584
3624
|
}
|
|
3585
|
-
/**
|
|
3625
|
+
/**
|
|
3626
|
+
* This interface was referenced by `Item`'s JSON-Schema via the
|
|
3627
|
+
* `bulk_unpublish.targetSchema` link.
|
|
3628
|
+
*/
|
|
3586
3629
|
export interface ItemBulkUnpublishTargetSchema {
|
|
3587
3630
|
data: Job;
|
|
3588
3631
|
}
|
|
@@ -3724,7 +3767,10 @@ export interface ItemVersionData {
|
|
|
3724
3767
|
type: ItemVersionType;
|
|
3725
3768
|
id: ItemVersionIdentity;
|
|
3726
3769
|
}
|
|
3727
|
-
/**
|
|
3770
|
+
/**
|
|
3771
|
+
* This interface was referenced by `ItemVersion`'s JSON-Schema via the
|
|
3772
|
+
* `restore.targetSchema` link.
|
|
3773
|
+
*/
|
|
3728
3774
|
export interface ItemVersionRestoreTargetSchema {
|
|
3729
3775
|
data: Job;
|
|
3730
3776
|
}
|
|
@@ -4100,7 +4146,10 @@ export interface UploadBulkDestroySchema {
|
|
|
4100
4146
|
};
|
|
4101
4147
|
};
|
|
4102
4148
|
}
|
|
4103
|
-
/**
|
|
4149
|
+
/**
|
|
4150
|
+
* This interface was referenced by `Upload`'s JSON-Schema via the
|
|
4151
|
+
* `bulk_destroy.targetSchema` link.
|
|
4152
|
+
*/
|
|
4104
4153
|
export interface UploadBulkDestroyTargetSchema {
|
|
4105
4154
|
data: Job;
|
|
4106
4155
|
}
|
|
@@ -4113,9 +4162,9 @@ export interface UploadBulkDestroyJobSchema {
|
|
|
4113
4162
|
};
|
|
4114
4163
|
}
|
|
4115
4164
|
/**
|
|
4116
|
-
* To upload a file in DatoCMS, first you need to obtain an upload permission through
|
|
4117
|
-
* API endpoint. The response will contain the S3 URL where you will be able to
|
|
4118
|
-
* file with a direct PUT request.
|
|
4165
|
+
* To upload a file in DatoCMS, first you need to obtain an upload permission through
|
|
4166
|
+
* this API endpoint. The response will contain the S3 URL where you will be able to
|
|
4167
|
+
* upload the file with a direct PUT request.
|
|
4119
4168
|
*
|
|
4120
4169
|
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
4121
4170
|
* "upload_request".
|
|
@@ -4128,7 +4177,8 @@ export interface UploadRequest {
|
|
|
4128
4177
|
/**
|
|
4129
4178
|
* JSON API attributes
|
|
4130
4179
|
*
|
|
4131
|
-
* This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition`
|
|
4180
|
+
* This interface was referenced by `UploadRequest`'s JSON-Schema via the `definition`
|
|
4181
|
+
* "attributes".
|
|
4132
4182
|
*/
|
|
4133
4183
|
export interface UploadRequestAttributes {
|
|
4134
4184
|
/** The URL to use to upload the file with a direct PUT request */
|
|
@@ -4348,10 +4398,10 @@ export interface SearchResultInstancesTargetSchema {
|
|
|
4348
4398
|
* once your content has been published**. You can think of environments like code
|
|
4349
4399
|
* branches: great for testing, development and pre-production environments.
|
|
4350
4400
|
*
|
|
4351
|
-
* By default, every project has one environment, called **primary environment**, which
|
|
4352
|
-
* meant to be used for the regular editorial workflow. Additionally, multiple
|
|
4353
|
-
* environments** can be created by developers to safely test/experiment new
|
|
4354
|
-
* the content.
|
|
4401
|
+
* By default, every project has one environment, called **primary environment**, which
|
|
4402
|
+
* is meant to be used for the regular editorial workflow. Additionally, multiple
|
|
4403
|
+
* **sandbox environments** can be created by developers to safely test/experiment new
|
|
4404
|
+
* changes in the content.
|
|
4355
4405
|
*
|
|
4356
4406
|
* Sandbox environments start out as **exact copies of one of the existing environments**
|
|
4357
4407
|
* (ie. the primary one). The process of creating a new sandbox starting off from an
|
|
@@ -4368,9 +4418,9 @@ export interface SearchResultInstancesTargetSchema {
|
|
|
4368
4418
|
* - Global SEO settings
|
|
4369
4419
|
* - The content navigation bar
|
|
4370
4420
|
*
|
|
4371
|
-
* When making changes to any of the aforementioned entities in any environment,
|
|
4372
|
-
* the primary environment, **the data in all other environments isn’t
|
|
4373
|
-
* stays the same.
|
|
4421
|
+
* When making changes to any of the aforementioned entities in any environment,
|
|
4422
|
+
* including the primary environment, **the data in all other environments isn’t
|
|
4423
|
+
* affected** and stays the same.
|
|
4374
4424
|
*
|
|
4375
4425
|
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
4376
4426
|
* "environment".
|
|
@@ -4420,7 +4470,10 @@ export interface EnvironmentForkTargetSchema {
|
|
|
4420
4470
|
export interface EnvironmentForkJobSchema {
|
|
4421
4471
|
data: Environment;
|
|
4422
4472
|
}
|
|
4423
|
-
/**
|
|
4473
|
+
/**
|
|
4474
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
4475
|
+
* `promote.targetSchema` link.
|
|
4476
|
+
*/
|
|
4424
4477
|
export interface EnvironmentPromoteTargetSchema {
|
|
4425
4478
|
data: Environment;
|
|
4426
4479
|
}
|
|
@@ -4435,7 +4488,10 @@ export interface EnvironmentInstancesTargetSchema {
|
|
|
4435
4488
|
export interface EnvironmentSelfTargetSchema {
|
|
4436
4489
|
data: Environment;
|
|
4437
4490
|
}
|
|
4438
|
-
/**
|
|
4491
|
+
/**
|
|
4492
|
+
* This interface was referenced by `Environment`'s JSON-Schema via the
|
|
4493
|
+
* `destroy.targetSchema` link.
|
|
4494
|
+
*/
|
|
4439
4495
|
export interface EnvironmentDestroyTargetSchema {
|
|
4440
4496
|
data: Job | Environment;
|
|
4441
4497
|
}
|
|
@@ -4769,7 +4825,10 @@ export interface BuildTriggerCreateSchema {
|
|
|
4769
4825
|
};
|
|
4770
4826
|
};
|
|
4771
4827
|
}
|
|
4772
|
-
/**
|
|
4828
|
+
/**
|
|
4829
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
4830
|
+
* `create.targetSchema` link.
|
|
4831
|
+
*/
|
|
4773
4832
|
export interface BuildTriggerCreateTargetSchema {
|
|
4774
4833
|
data: BuildTrigger;
|
|
4775
4834
|
}
|
|
@@ -4796,7 +4855,10 @@ export interface BuildTriggerUpdateSchema {
|
|
|
4796
4855
|
};
|
|
4797
4856
|
};
|
|
4798
4857
|
}
|
|
4799
|
-
/**
|
|
4858
|
+
/**
|
|
4859
|
+
* This interface was referenced by `BuildTrigger`'s JSON-Schema via the
|
|
4860
|
+
* `update.targetSchema` link.
|
|
4861
|
+
*/
|
|
4800
4862
|
export interface BuildTriggerUpdateTargetSchema {
|
|
4801
4863
|
data: BuildTrigger;
|
|
4802
4864
|
}
|
|
@@ -4912,7 +4974,10 @@ export interface ItemTypeFilterUpdateTargetSchema {
|
|
|
4912
4974
|
export interface ItemTypeFilterInstancesTargetSchema {
|
|
4913
4975
|
data: ItemTypeFilter[];
|
|
4914
4976
|
}
|
|
4915
|
-
/**
|
|
4977
|
+
/**
|
|
4978
|
+
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema via the
|
|
4979
|
+
* `self.targetSchema` link.
|
|
4980
|
+
*/
|
|
4916
4981
|
export interface ItemTypeFilterSelfTargetSchema {
|
|
4917
4982
|
data: ItemTypeFilter;
|
|
4918
4983
|
}
|
|
@@ -4975,7 +5040,10 @@ export interface UploadFilterCreateSchema {
|
|
|
4975
5040
|
};
|
|
4976
5041
|
};
|
|
4977
5042
|
}
|
|
4978
|
-
/**
|
|
5043
|
+
/**
|
|
5044
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5045
|
+
* `create.targetSchema` link.
|
|
5046
|
+
*/
|
|
4979
5047
|
export interface UploadFilterCreateTargetSchema {
|
|
4980
5048
|
data: UploadFilter;
|
|
4981
5049
|
}
|
|
@@ -4997,7 +5065,10 @@ export interface UploadFilterUpdateSchema {
|
|
|
4997
5065
|
};
|
|
4998
5066
|
};
|
|
4999
5067
|
}
|
|
5000
|
-
/**
|
|
5068
|
+
/**
|
|
5069
|
+
* This interface was referenced by `UploadFilter`'s JSON-Schema via the
|
|
5070
|
+
* `update.targetSchema` link.
|
|
5071
|
+
*/
|
|
5001
5072
|
export interface UploadFilterUpdateTargetSchema {
|
|
5002
5073
|
data: UploadFilter;
|
|
5003
5074
|
}
|
|
@@ -5021,8 +5092,8 @@ export interface UploadFilterDestroyTargetSchema {
|
|
|
5021
5092
|
}
|
|
5022
5093
|
/**
|
|
5023
5094
|
* A DatoCMS administrative area can be accessed by multiple people. Every invitation is
|
|
5024
|
-
* linked to a specific Role, which describes what actions it will be able to perform
|
|
5025
|
-
* the user will register.
|
|
5095
|
+
* linked to a specific Role, which describes what actions it will be able to perform
|
|
5096
|
+
* once the user will register.
|
|
5026
5097
|
*
|
|
5027
5098
|
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
5028
5099
|
* "site_invitation".
|
|
@@ -5114,7 +5185,10 @@ export interface SiteInvitationUpdateTargetSchema {
|
|
|
5114
5185
|
export interface SiteInvitationInstancesTargetSchema {
|
|
5115
5186
|
data: SiteInvitation[];
|
|
5116
5187
|
}
|
|
5117
|
-
/**
|
|
5188
|
+
/**
|
|
5189
|
+
* This interface was referenced by `SiteInvitation`'s JSON-Schema via the
|
|
5190
|
+
* `self.targetSchema` link.
|
|
5191
|
+
*/
|
|
5118
5192
|
export interface SiteInvitationSelfTargetSchema {
|
|
5119
5193
|
data: SiteInvitation;
|
|
5120
5194
|
}
|
|
@@ -5241,7 +5315,8 @@ export interface EditingSessionDestroyTargetSchema {
|
|
|
5241
5315
|
* A Single Sign-On group exists when a DatoCMS project is connected to an Identity
|
|
5242
5316
|
* Provider. These groups can be used to link DatoCMS roles to the Identity Provider's groups.
|
|
5243
5317
|
*
|
|
5244
|
-
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
5318
|
+
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
5319
|
+
* "sso_group".
|
|
5245
5320
|
*/
|
|
5246
5321
|
export interface SsoGroup {
|
|
5247
5322
|
type: SsoGroupType;
|
|
@@ -5282,7 +5357,10 @@ export interface SsoGroupRelationships {
|
|
|
5282
5357
|
export interface SsoGroupInstancesTargetSchema {
|
|
5283
5358
|
data: SsoGroup[];
|
|
5284
5359
|
}
|
|
5285
|
-
/**
|
|
5360
|
+
/**
|
|
5361
|
+
* This interface was referenced by `SsoGroup`'s JSON-Schema via the
|
|
5362
|
+
* `copy_roles.targetSchema` link.
|
|
5363
|
+
*/
|
|
5286
5364
|
export interface SsoGroupCopyRolesTargetSchema {
|
|
5287
5365
|
data: SsoGroup;
|
|
5288
5366
|
}
|
|
@@ -5446,7 +5524,10 @@ export interface WhiteLabelSettingsData {
|
|
|
5446
5524
|
export interface WhiteLabelSettingsSelfTargetSchema {
|
|
5447
5525
|
data: WhiteLabelSettings;
|
|
5448
5526
|
}
|
|
5449
|
-
/**
|
|
5527
|
+
/**
|
|
5528
|
+
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema via the
|
|
5529
|
+
* `update.schema` link.
|
|
5530
|
+
*/
|
|
5450
5531
|
export interface WhiteLabelSettingsUpdateSchema {
|
|
5451
5532
|
data: {
|
|
5452
5533
|
type: WhiteLabelSettingsType;
|
|
@@ -5594,9 +5675,9 @@ export interface DailyUsageInstancesTargetSchema {
|
|
|
5594
5675
|
}
|
|
5595
5676
|
/**
|
|
5596
5677
|
* You can use counters to analyze your project's data consumption over a period of time.
|
|
5597
|
-
* Counters are especially useful if your project is exceeding its API calls/traffic
|
|
5598
|
-
* limits, to better understand where and how requests are originating. Counters
|
|
5599
|
-
* updated every minute, so you can debug in real-time the results of your changes.
|
|
5678
|
+
* Counters are especially useful if your project is exceeding its API calls/traffic
|
|
5679
|
+
* quota limits, to better understand where and how requests are originating. Counters
|
|
5680
|
+
* are updated every minute, so you can debug in real-time the results of your changes.
|
|
5600
5681
|
*
|
|
5601
5682
|
* This interface was referenced by `DatoCMSSiteAPI`'s JSON-Schema via the `definition`
|
|
5602
5683
|
* "usage_counter".
|
|
@@ -5661,7 +5742,10 @@ export interface UploadTagData {
|
|
|
5661
5742
|
type: UploadTagType;
|
|
5662
5743
|
id: UploadTagIdentity;
|
|
5663
5744
|
}
|
|
5664
|
-
/**
|
|
5745
|
+
/**
|
|
5746
|
+
* This interface was referenced by `UploadTag`'s JSON-Schema via the
|
|
5747
|
+
* `instances.targetSchema` link.
|
|
5748
|
+
*/
|
|
5665
5749
|
export interface UploadTagInstancesTargetSchema {
|
|
5666
5750
|
data: UploadTag[];
|
|
5667
5751
|
}
|