@datocms/cma-client 3.0.9 → 3.1.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/generated/Client.js +2 -1
- package/dist/cjs/generated/Client.js.map +1 -1
- package/dist/cjs/generated/resources/AccessToken.js.map +1 -1
- package/dist/cjs/generated/resources/AuditLogEvent.js.map +1 -1
- package/dist/cjs/generated/resources/BuildEvent.js.map +1 -1
- package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/cjs/generated/resources/DailyUsage.js.map +1 -1
- package/dist/cjs/generated/resources/EditingSession.js.map +1 -1
- package/dist/cjs/generated/resources/Environment.js.map +1 -1
- package/dist/cjs/generated/resources/Field.js.map +1 -1
- package/dist/cjs/generated/resources/Fieldset.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/ItemType.js.map +1 -1
- package/dist/cjs/generated/resources/ItemTypeFilter.js.map +1 -1
- package/dist/cjs/generated/resources/ItemVersion.js.map +1 -1
- package/dist/cjs/generated/resources/JobResult.js.map +1 -1
- package/dist/cjs/generated/resources/MaintenanceMode.js.map +1 -1
- package/dist/cjs/generated/resources/MenuItem.js.map +1 -1
- package/dist/cjs/generated/resources/Plugin.js.map +1 -1
- package/dist/cjs/generated/resources/PublicInfo.js.map +1 -1
- package/dist/cjs/generated/resources/Role.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/cjs/generated/resources/SchemaMenuItem.js +202 -0
- package/dist/cjs/generated/resources/SchemaMenuItem.js.map +1 -0
- package/dist/cjs/generated/resources/SearchResult.js.map +1 -1
- package/dist/cjs/generated/resources/Session.js.map +1 -1
- package/dist/cjs/generated/resources/Site.js +62 -0
- package/dist/cjs/generated/resources/Site.js.map +1 -1
- package/dist/cjs/generated/resources/SiteInvitation.js.map +1 -1
- package/dist/cjs/generated/resources/SsoGroup.js.map +1 -1
- package/dist/cjs/generated/resources/SsoSettings.js.map +1 -1
- package/dist/cjs/generated/resources/SsoUser.js.map +1 -1
- package/dist/cjs/generated/resources/SubscriptionFeature.js.map +1 -1
- package/dist/cjs/generated/resources/SubscriptionLimit.js.map +1 -1
- package/dist/cjs/generated/resources/Upload.js.map +1 -1
- package/dist/cjs/generated/resources/UploadFilter.js.map +1 -1
- package/dist/cjs/generated/resources/UploadRequest.js.map +1 -1
- package/dist/cjs/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/cjs/generated/resources/UploadTag.js.map +1 -1
- package/dist/cjs/generated/resources/UsageCounter.js.map +1 -1
- package/dist/cjs/generated/resources/User.js.map +1 -1
- package/dist/cjs/generated/resources/Webhook.js.map +1 -1
- package/dist/cjs/generated/resources/WebhookCall.js.map +1 -1
- package/dist/cjs/generated/resources/WhiteLabelSettings.js.map +1 -1
- package/dist/cjs/generated/resources/Workflow.js.map +1 -1
- package/dist/cjs/generated/resources/index.js +3 -1
- package/dist/cjs/generated/resources/index.js.map +1 -1
- package/dist/esm/generated/Client.d.ts +1 -0
- package/dist/esm/generated/Client.js +2 -1
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +303 -154
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +233 -168
- package/dist/esm/generated/resources/AccessToken.d.ts +1 -1
- package/dist/esm/generated/resources/AccessToken.js.map +1 -1
- package/dist/esm/generated/resources/AuditLogEvent.d.ts +1 -1
- package/dist/esm/generated/resources/AuditLogEvent.js.map +1 -1
- package/dist/esm/generated/resources/BuildEvent.d.ts +1 -1
- package/dist/esm/generated/resources/BuildEvent.js.map +1 -1
- package/dist/esm/generated/resources/BuildTrigger.d.ts +1 -1
- package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/esm/generated/resources/DailyUsage.d.ts +1 -1
- package/dist/esm/generated/resources/DailyUsage.js.map +1 -1
- package/dist/esm/generated/resources/EditingSession.d.ts +1 -1
- package/dist/esm/generated/resources/EditingSession.js.map +1 -1
- package/dist/esm/generated/resources/Environment.d.ts +1 -1
- package/dist/esm/generated/resources/Environment.js.map +1 -1
- package/dist/esm/generated/resources/Field.d.ts +1 -1
- package/dist/esm/generated/resources/Field.js.map +1 -1
- package/dist/esm/generated/resources/Fieldset.d.ts +1 -1
- package/dist/esm/generated/resources/Fieldset.js.map +1 -1
- package/dist/esm/generated/resources/Item.d.ts +1 -1
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/ItemType.d.ts +1 -1
- package/dist/esm/generated/resources/ItemType.js.map +1 -1
- package/dist/esm/generated/resources/ItemTypeFilter.d.ts +1 -1
- package/dist/esm/generated/resources/ItemTypeFilter.js.map +1 -1
- package/dist/esm/generated/resources/ItemVersion.d.ts +1 -1
- package/dist/esm/generated/resources/ItemVersion.js.map +1 -1
- package/dist/esm/generated/resources/JobResult.d.ts +1 -1
- package/dist/esm/generated/resources/JobResult.js.map +1 -1
- package/dist/esm/generated/resources/MaintenanceMode.d.ts +1 -1
- package/dist/esm/generated/resources/MaintenanceMode.js.map +1 -1
- package/dist/esm/generated/resources/MenuItem.d.ts +1 -1
- package/dist/esm/generated/resources/MenuItem.js.map +1 -1
- package/dist/esm/generated/resources/Plugin.d.ts +1 -1
- package/dist/esm/generated/resources/Plugin.js.map +1 -1
- package/dist/esm/generated/resources/PublicInfo.d.ts +1 -1
- package/dist/esm/generated/resources/PublicInfo.js.map +1 -1
- package/dist/esm/generated/resources/Role.d.ts +1 -1
- package/dist/esm/generated/resources/Role.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledPublication.d.ts +1 -1
- package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.d.ts +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/esm/generated/resources/SchemaMenuItem.d.ts +96 -0
- package/dist/esm/generated/resources/SchemaMenuItem.js +174 -0
- package/dist/esm/generated/resources/SchemaMenuItem.js.map +1 -0
- package/dist/esm/generated/resources/SearchResult.d.ts +1 -1
- package/dist/esm/generated/resources/SearchResult.js.map +1 -1
- package/dist/esm/generated/resources/Session.d.ts +1 -1
- package/dist/esm/generated/resources/Session.js.map +1 -1
- package/dist/esm/generated/resources/Site.d.ts +45 -1
- package/dist/esm/generated/resources/Site.js +62 -0
- package/dist/esm/generated/resources/Site.js.map +1 -1
- package/dist/esm/generated/resources/SiteInvitation.d.ts +1 -1
- package/dist/esm/generated/resources/SiteInvitation.js.map +1 -1
- package/dist/esm/generated/resources/SsoGroup.d.ts +1 -1
- package/dist/esm/generated/resources/SsoGroup.js.map +1 -1
- package/dist/esm/generated/resources/SsoSettings.d.ts +1 -1
- package/dist/esm/generated/resources/SsoSettings.js.map +1 -1
- package/dist/esm/generated/resources/SsoUser.d.ts +1 -1
- package/dist/esm/generated/resources/SsoUser.js.map +1 -1
- package/dist/esm/generated/resources/SubscriptionFeature.d.ts +1 -1
- package/dist/esm/generated/resources/SubscriptionFeature.js.map +1 -1
- package/dist/esm/generated/resources/SubscriptionLimit.d.ts +1 -1
- package/dist/esm/generated/resources/SubscriptionLimit.js.map +1 -1
- package/dist/esm/generated/resources/Upload.d.ts +1 -1
- package/dist/esm/generated/resources/Upload.js.map +1 -1
- package/dist/esm/generated/resources/UploadFilter.d.ts +1 -1
- package/dist/esm/generated/resources/UploadFilter.js.map +1 -1
- package/dist/esm/generated/resources/UploadRequest.d.ts +1 -1
- package/dist/esm/generated/resources/UploadRequest.js.map +1 -1
- package/dist/esm/generated/resources/UploadSmartTag.d.ts +1 -1
- package/dist/esm/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/esm/generated/resources/UploadTag.d.ts +1 -1
- package/dist/esm/generated/resources/UploadTag.js.map +1 -1
- package/dist/esm/generated/resources/UsageCounter.d.ts +1 -1
- package/dist/esm/generated/resources/UsageCounter.js.map +1 -1
- package/dist/esm/generated/resources/User.d.ts +1 -1
- package/dist/esm/generated/resources/User.js.map +1 -1
- package/dist/esm/generated/resources/Webhook.d.ts +1 -1
- package/dist/esm/generated/resources/Webhook.js.map +1 -1
- package/dist/esm/generated/resources/WebhookCall.d.ts +1 -1
- package/dist/esm/generated/resources/WebhookCall.js.map +1 -1
- package/dist/esm/generated/resources/WhiteLabelSettings.d.ts +1 -1
- package/dist/esm/generated/resources/WhiteLabelSettings.js.map +1 -1
- package/dist/esm/generated/resources/Workflow.d.ts +1 -1
- package/dist/esm/generated/resources/Workflow.js.map +1 -1
- package/dist/esm/generated/resources/index.d.ts +1 -0
- package/dist/esm/generated/resources/index.js +1 -0
- package/dist/esm/generated/resources/index.js.map +1 -1
- package/dist/types/generated/Client.d.ts +1 -0
- package/dist/types/generated/SchemaTypes.d.ts +303 -154
- package/dist/types/generated/SimpleSchemaTypes.d.ts +233 -168
- package/dist/types/generated/resources/AccessToken.d.ts +1 -1
- package/dist/types/generated/resources/AuditLogEvent.d.ts +1 -1
- package/dist/types/generated/resources/BuildEvent.d.ts +1 -1
- package/dist/types/generated/resources/BuildTrigger.d.ts +1 -1
- package/dist/types/generated/resources/DailyUsage.d.ts +1 -1
- package/dist/types/generated/resources/EditingSession.d.ts +1 -1
- package/dist/types/generated/resources/Environment.d.ts +1 -1
- package/dist/types/generated/resources/Field.d.ts +1 -1
- package/dist/types/generated/resources/Fieldset.d.ts +1 -1
- package/dist/types/generated/resources/Item.d.ts +1 -1
- package/dist/types/generated/resources/ItemType.d.ts +1 -1
- package/dist/types/generated/resources/ItemTypeFilter.d.ts +1 -1
- package/dist/types/generated/resources/ItemVersion.d.ts +1 -1
- package/dist/types/generated/resources/JobResult.d.ts +1 -1
- package/dist/types/generated/resources/MaintenanceMode.d.ts +1 -1
- package/dist/types/generated/resources/MenuItem.d.ts +1 -1
- package/dist/types/generated/resources/Plugin.d.ts +1 -1
- package/dist/types/generated/resources/PublicInfo.d.ts +1 -1
- package/dist/types/generated/resources/Role.d.ts +1 -1
- package/dist/types/generated/resources/ScheduledPublication.d.ts +1 -1
- package/dist/types/generated/resources/ScheduledUnpublishing.d.ts +1 -1
- package/dist/types/generated/resources/SchemaMenuItem.d.ts +96 -0
- package/dist/types/generated/resources/SearchResult.d.ts +1 -1
- package/dist/types/generated/resources/Session.d.ts +1 -1
- package/dist/types/generated/resources/Site.d.ts +45 -1
- package/dist/types/generated/resources/SiteInvitation.d.ts +1 -1
- package/dist/types/generated/resources/SsoGroup.d.ts +1 -1
- package/dist/types/generated/resources/SsoSettings.d.ts +1 -1
- package/dist/types/generated/resources/SsoUser.d.ts +1 -1
- package/dist/types/generated/resources/SubscriptionFeature.d.ts +1 -1
- package/dist/types/generated/resources/SubscriptionLimit.d.ts +1 -1
- package/dist/types/generated/resources/Upload.d.ts +1 -1
- package/dist/types/generated/resources/UploadFilter.d.ts +1 -1
- package/dist/types/generated/resources/UploadRequest.d.ts +1 -1
- package/dist/types/generated/resources/UploadSmartTag.d.ts +1 -1
- package/dist/types/generated/resources/UploadTag.d.ts +1 -1
- package/dist/types/generated/resources/UsageCounter.d.ts +1 -1
- package/dist/types/generated/resources/User.d.ts +1 -1
- package/dist/types/generated/resources/Webhook.d.ts +1 -1
- package/dist/types/generated/resources/WebhookCall.d.ts +1 -1
- package/dist/types/generated/resources/WhiteLabelSettings.d.ts +1 -1
- package/dist/types/generated/resources/Workflow.d.ts +1 -1
- package/dist/types/generated/resources/index.d.ts +1 -0
- package/package.json +3 -3
- package/resources.json +144 -0
- package/src/generated/Client.ts +3 -1
- package/src/generated/SchemaTypes.ts +344 -180
- package/src/generated/SimpleSchemaTypes.ts +266 -194
- package/src/generated/resources/AccessToken.ts +1 -1
- package/src/generated/resources/AuditLogEvent.ts +1 -1
- package/src/generated/resources/BuildEvent.ts +1 -1
- package/src/generated/resources/BuildTrigger.ts +1 -1
- package/src/generated/resources/DailyUsage.ts +1 -1
- package/src/generated/resources/EditingSession.ts +1 -1
- package/src/generated/resources/Environment.ts +1 -1
- package/src/generated/resources/Field.ts +1 -1
- package/src/generated/resources/Fieldset.ts +1 -1
- package/src/generated/resources/Item.ts +1 -1
- package/src/generated/resources/ItemType.ts +1 -1
- package/src/generated/resources/ItemTypeFilter.ts +1 -1
- package/src/generated/resources/ItemVersion.ts +1 -1
- package/src/generated/resources/JobResult.ts +1 -1
- package/src/generated/resources/MaintenanceMode.ts +1 -1
- package/src/generated/resources/MenuItem.ts +1 -1
- package/src/generated/resources/Plugin.ts +1 -1
- package/src/generated/resources/PublicInfo.ts +1 -1
- package/src/generated/resources/Role.ts +1 -1
- package/src/generated/resources/ScheduledPublication.ts +1 -1
- package/src/generated/resources/ScheduledUnpublishing.ts +1 -1
- package/src/generated/resources/SchemaMenuItem.ts +196 -0
- package/src/generated/resources/SearchResult.ts +1 -1
- package/src/generated/resources/Session.ts +1 -1
- package/src/generated/resources/Site.ts +75 -1
- package/src/generated/resources/SiteInvitation.ts +1 -1
- package/src/generated/resources/SsoGroup.ts +1 -1
- package/src/generated/resources/SsoSettings.ts +1 -1
- package/src/generated/resources/SsoUser.ts +1 -1
- package/src/generated/resources/SubscriptionFeature.ts +1 -1
- package/src/generated/resources/SubscriptionLimit.ts +1 -1
- package/src/generated/resources/Upload.ts +1 -1
- package/src/generated/resources/UploadFilter.ts +1 -1
- package/src/generated/resources/UploadRequest.ts +1 -1
- package/src/generated/resources/UploadSmartTag.ts +1 -1
- package/src/generated/resources/UploadTag.ts +1 -1
- package/src/generated/resources/UsageCounter.ts +1 -1
- package/src/generated/resources/User.ts +1 -1
- package/src/generated/resources/Webhook.ts +1 -1
- package/src/generated/resources/WebhookCall.ts +1 -1
- package/src/generated/resources/WhiteLabelSettings.ts +1 -1
- package/src/generated/resources/Workflow.ts +1 -1
- package/src/generated/resources/index.ts +1 -0
|
@@ -2,8 +2,6 @@
|
|
|
2
2
|
* This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT BY HAND.
|
|
3
3
|
*/
|
|
4
4
|
/**
|
|
5
|
-
* JSON API type field
|
|
6
|
-
*
|
|
7
5
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
8
6
|
* via the `definition` "type".
|
|
9
7
|
*/
|
|
@@ -59,8 +57,6 @@ export declare type EnvironmentIdentity = string;
|
|
|
59
57
|
*/
|
|
60
58
|
export declare type BuildTriggerIdentity = string;
|
|
61
59
|
/**
|
|
62
|
-
* JSON API type field
|
|
63
|
-
*
|
|
64
60
|
* This interface was referenced by `User`'s JSON-Schema
|
|
65
61
|
* via the `definition` "type".
|
|
66
62
|
*/
|
|
@@ -87,8 +83,6 @@ export declare type UserSelfHrefSchema = {
|
|
|
87
83
|
[k: string]: unknown;
|
|
88
84
|
};
|
|
89
85
|
/**
|
|
90
|
-
* JSON API type field
|
|
91
|
-
*
|
|
92
86
|
* This interface was referenced by `SsoUser`'s JSON-Schema
|
|
93
87
|
* via the `definition` "type".
|
|
94
88
|
*/
|
|
@@ -104,8 +98,6 @@ export declare type SsoUserType = 'sso_user';
|
|
|
104
98
|
*/
|
|
105
99
|
export declare type SsoUserIdentity = string;
|
|
106
100
|
/**
|
|
107
|
-
* JSON API type field
|
|
108
|
-
*
|
|
109
101
|
* This interface was referenced by `SsoGroup`'s JSON-Schema
|
|
110
102
|
* via the `definition` "type".
|
|
111
103
|
*/
|
|
@@ -136,8 +128,6 @@ export declare type SsoUserDestroyHrefSchema = {
|
|
|
136
128
|
[k: string]: unknown;
|
|
137
129
|
};
|
|
138
130
|
/**
|
|
139
|
-
* JSON API type field
|
|
140
|
-
*
|
|
141
131
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
142
132
|
* via the `definition` "type".
|
|
143
133
|
*/
|
|
@@ -168,8 +158,6 @@ export declare type AccessTokenDestroyHrefSchema = {
|
|
|
168
158
|
[k: string]: unknown;
|
|
169
159
|
};
|
|
170
160
|
/**
|
|
171
|
-
* JSON API type field
|
|
172
|
-
*
|
|
173
161
|
* This interface was referenced by `Account`'s JSON-Schema
|
|
174
162
|
* via the `definition` "type".
|
|
175
163
|
*/
|
|
@@ -211,8 +199,6 @@ export declare type UserDestroyHrefSchema = {
|
|
|
211
199
|
[k: string]: unknown;
|
|
212
200
|
};
|
|
213
201
|
/**
|
|
214
|
-
* JSON API type field
|
|
215
|
-
*
|
|
216
202
|
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
217
203
|
* via the `definition` "type".
|
|
218
204
|
*/
|
|
@@ -228,8 +214,6 @@ export declare type AuditLogEventType = 'audit_log_event';
|
|
|
228
214
|
*/
|
|
229
215
|
export declare type AuditLogEventIdentity = string;
|
|
230
216
|
/**
|
|
231
|
-
* JSON API type field
|
|
232
|
-
*
|
|
233
217
|
* This interface was referenced by `Organization`'s JSON-Schema
|
|
234
218
|
* via the `definition` "type".
|
|
235
219
|
*/
|
|
@@ -245,8 +229,6 @@ export declare type OrganizationType = 'organization';
|
|
|
245
229
|
*/
|
|
246
230
|
export declare type OrganizationIdentity = string;
|
|
247
231
|
/**
|
|
248
|
-
* JSON API type field
|
|
249
|
-
*
|
|
250
232
|
* This interface was referenced by `SitePlan`'s JSON-Schema
|
|
251
233
|
* via the `definition` "type".
|
|
252
234
|
*/
|
|
@@ -262,8 +244,6 @@ export declare type SitePlanType = 'site_plan';
|
|
|
262
244
|
*/
|
|
263
245
|
export declare type SitePlanIdentity = string;
|
|
264
246
|
/**
|
|
265
|
-
* JSON API type field
|
|
266
|
-
*
|
|
267
247
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
268
248
|
* via the `definition` "type".
|
|
269
249
|
*/
|
|
@@ -279,15 +259,11 @@ export declare type MenuItemType = 'menu_item';
|
|
|
279
259
|
*/
|
|
280
260
|
export declare type MenuItemIdentity = string;
|
|
281
261
|
/**
|
|
282
|
-
* JSON API type field
|
|
283
|
-
*
|
|
284
262
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
285
263
|
* via the `definition` "type".
|
|
286
264
|
*/
|
|
287
265
|
export declare type ItemTypeType = 'item_type';
|
|
288
266
|
/**
|
|
289
|
-
* JSON API type field
|
|
290
|
-
*
|
|
291
267
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
292
268
|
* via the `definition` "type".
|
|
293
269
|
*/
|
|
@@ -317,6 +293,33 @@ export declare type MenuItemInstancesHrefSchema = {
|
|
|
317
293
|
/**
|
|
318
294
|
* JSON API type field
|
|
319
295
|
*
|
|
296
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
297
|
+
* via the `definition` "type".
|
|
298
|
+
*/
|
|
299
|
+
export declare type SchemaMenuItemType = 'schema_menu_item';
|
|
300
|
+
/**
|
|
301
|
+
* RFC 4122 UUID of schema menu item expressed in URL-safe base64 format
|
|
302
|
+
*
|
|
303
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
304
|
+
* via the `definition` "identity".
|
|
305
|
+
*
|
|
306
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
307
|
+
* via the `definition` "id".
|
|
308
|
+
*/
|
|
309
|
+
export declare type SchemaMenuItemIdentity = string;
|
|
310
|
+
/**
|
|
311
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
312
|
+
* via the `instances.hrefSchema` link.
|
|
313
|
+
*/
|
|
314
|
+
export declare type SchemaMenuItemInstancesHrefSchema = {
|
|
315
|
+
filter?: {
|
|
316
|
+
/**
|
|
317
|
+
* IDs to fetch, comma separated
|
|
318
|
+
*/
|
|
319
|
+
ids: string;
|
|
320
|
+
};
|
|
321
|
+
};
|
|
322
|
+
/**
|
|
320
323
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
321
324
|
* via the `definition` "type".
|
|
322
325
|
*/
|
|
@@ -332,8 +335,6 @@ export declare type ItemType1 = 'item';
|
|
|
332
335
|
*/
|
|
333
336
|
export declare type ItemIdentity = string;
|
|
334
337
|
/**
|
|
335
|
-
* JSON API type field
|
|
336
|
-
*
|
|
337
338
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
338
339
|
* via the `definition` "type".
|
|
339
340
|
*/
|
|
@@ -349,8 +350,6 @@ export declare type FieldType = 'field';
|
|
|
349
350
|
*/
|
|
350
351
|
export declare type FieldIdentity = string;
|
|
351
352
|
/**
|
|
352
|
-
* JSON API type fieldset
|
|
353
|
-
*
|
|
354
353
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
355
354
|
* via the `definition` "type".
|
|
356
355
|
*/
|
|
@@ -366,8 +365,6 @@ export declare type FieldsetType = 'fieldset';
|
|
|
366
365
|
*/
|
|
367
366
|
export declare type FieldsetIdentity = string;
|
|
368
367
|
/**
|
|
369
|
-
* JSON API type field
|
|
370
|
-
*
|
|
371
368
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
372
369
|
* via the `definition` "type".
|
|
373
370
|
*/
|
|
@@ -384,8 +381,6 @@ export declare type ItemTypeCreateHrefSchema = {
|
|
|
384
381
|
[k: string]: unknown;
|
|
385
382
|
};
|
|
386
383
|
/**
|
|
387
|
-
* JSON API type field
|
|
388
|
-
*
|
|
389
384
|
* This interface was referenced by `Job`'s JSON-Schema
|
|
390
385
|
* via the `definition` "type".
|
|
391
386
|
*/
|
|
@@ -412,8 +407,6 @@ export declare type ItemTypeDestroyHrefSchema = {
|
|
|
412
407
|
[k: string]: unknown;
|
|
413
408
|
};
|
|
414
409
|
/**
|
|
415
|
-
* JSON API type field
|
|
416
|
-
*
|
|
417
410
|
* This interface was referenced by `Session`'s JSON-Schema
|
|
418
411
|
* via the `definition` "type".
|
|
419
412
|
*/
|
|
@@ -429,8 +422,6 @@ export declare type SessionType = 'session';
|
|
|
429
422
|
*/
|
|
430
423
|
export declare type SessionIdentity = string;
|
|
431
424
|
/**
|
|
432
|
-
* JSON API type field
|
|
433
|
-
*
|
|
434
425
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
435
426
|
* via the `definition` "type".
|
|
436
427
|
*/
|
|
@@ -446,8 +437,6 @@ export declare type PluginType = 'plugin';
|
|
|
446
437
|
*/
|
|
447
438
|
export declare type PluginIdentity = string;
|
|
448
439
|
/**
|
|
449
|
-
* JSON API type field
|
|
450
|
-
*
|
|
451
440
|
* This interface was referenced by `JobResult`'s JSON-Schema
|
|
452
441
|
* via the `definition` "type".
|
|
453
442
|
*/
|
|
@@ -463,8 +452,6 @@ export declare type JobResultType = 'job_result';
|
|
|
463
452
|
*/
|
|
464
453
|
export declare type JobResultIdentity = string;
|
|
465
454
|
/**
|
|
466
|
-
* JSON API type field
|
|
467
|
-
*
|
|
468
455
|
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema
|
|
469
456
|
* via the `definition` "type".
|
|
470
457
|
*/
|
|
@@ -480,8 +467,6 @@ export declare type SubscriptionLimitType = 'subscription_limit';
|
|
|
480
467
|
*/
|
|
481
468
|
export declare type SubscriptionLimitIdentity = string;
|
|
482
469
|
/**
|
|
483
|
-
* JSON API type field
|
|
484
|
-
*
|
|
485
470
|
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema
|
|
486
471
|
* via the `definition` "type".
|
|
487
472
|
*/
|
|
@@ -497,8 +482,6 @@ export declare type SubscriptionFeatureType = 'subscription_feature';
|
|
|
497
482
|
*/
|
|
498
483
|
export declare type SubscriptionFeatureIdentity = string;
|
|
499
484
|
/**
|
|
500
|
-
* JSON API type field
|
|
501
|
-
*
|
|
502
485
|
* This interface was referenced by `BuildEvent`'s JSON-Schema
|
|
503
486
|
* via the `definition` "type".
|
|
504
487
|
*/
|
|
@@ -514,8 +497,6 @@ export declare type BuildEventType = 'build_event';
|
|
|
514
497
|
*/
|
|
515
498
|
export declare type BuildEventIdentity = string;
|
|
516
499
|
/**
|
|
517
|
-
* JSON API type field
|
|
518
|
-
*
|
|
519
500
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
520
501
|
* via the `definition` "type".
|
|
521
502
|
*/
|
|
@@ -616,8 +597,6 @@ export declare type ItemSelfHrefSchema = {
|
|
|
616
597
|
[k: string]: unknown;
|
|
617
598
|
};
|
|
618
599
|
/**
|
|
619
|
-
* JSON API type field
|
|
620
|
-
*
|
|
621
600
|
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
622
601
|
* via the `definition` "type".
|
|
623
602
|
*/
|
|
@@ -633,8 +612,6 @@ export declare type ItemCurrentVsPublishedStateType = 'item_current_vs_published
|
|
|
633
612
|
*/
|
|
634
613
|
export declare type ItemCurrentVsPublishedStateIdentity = string;
|
|
635
614
|
/**
|
|
636
|
-
* JSON API type field
|
|
637
|
-
*
|
|
638
615
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
639
616
|
* via the `definition` "type".
|
|
640
617
|
*/
|
|
@@ -650,8 +627,6 @@ export declare type ScheduledPublicationType = 'scheduled_publication';
|
|
|
650
627
|
*/
|
|
651
628
|
export declare type ScheduledPublicationIdentity = string;
|
|
652
629
|
/**
|
|
653
|
-
* JSON API type field
|
|
654
|
-
*
|
|
655
630
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
656
631
|
* via the `definition` "type".
|
|
657
632
|
*/
|
|
@@ -667,8 +642,6 @@ export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
|
667
642
|
*/
|
|
668
643
|
export declare type ScheduledUnpublishingIdentity = string;
|
|
669
644
|
/**
|
|
670
|
-
* JSON API type field
|
|
671
|
-
*
|
|
672
645
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
673
646
|
* via the `definition` "type".
|
|
674
647
|
*/
|
|
@@ -745,16 +718,16 @@ export declare type ItemBatchUnpublishHrefSchema = {
|
|
|
745
718
|
export declare type ItemPublishSchema = {
|
|
746
719
|
data: {
|
|
747
720
|
/**
|
|
748
|
-
*
|
|
721
|
+
* Publish only the specified locales & non-localized content (see following attributes). To publish the entire record, simply avoid passing a request body to the endpoint.
|
|
749
722
|
*/
|
|
750
723
|
type: 'selective_publish_operation';
|
|
751
724
|
attributes: {
|
|
752
725
|
/**
|
|
753
|
-
*
|
|
726
|
+
* Array of [valid locale codes in this project](/product-updates/get-locales-list-from-graphql) to publish.
|
|
754
727
|
*/
|
|
755
728
|
content_in_locales: string[];
|
|
756
729
|
/**
|
|
757
|
-
* Whether non-localized content
|
|
730
|
+
* Whether non-localized content will be published
|
|
758
731
|
*/
|
|
759
732
|
non_localized_content: boolean;
|
|
760
733
|
};
|
|
@@ -766,7 +739,7 @@ export declare type ItemPublishSchema = {
|
|
|
766
739
|
*/
|
|
767
740
|
export declare type ItemPublishHrefSchema = {
|
|
768
741
|
/**
|
|
769
|
-
*
|
|
742
|
+
* When `recursive` is `true`, if the record belongs to a [tree-like collection](https://www.datocms.com/docs/content-modelling/trees), and any of the parent records aren't published, those parent records will published as well. When `recursive` is `false` or not specified, an `UNPUBLISHED_PARENT` error will occur in such cases.
|
|
770
743
|
*/
|
|
771
744
|
recursive?: boolean;
|
|
772
745
|
[k: string]: unknown;
|
|
@@ -777,13 +750,10 @@ export declare type ItemPublishHrefSchema = {
|
|
|
777
750
|
*/
|
|
778
751
|
export declare type ItemUnpublishSchema = {
|
|
779
752
|
data: {
|
|
780
|
-
/**
|
|
781
|
-
* JSON API type field
|
|
782
|
-
*/
|
|
783
753
|
type: 'selective_unpublish_operation';
|
|
784
754
|
attributes: {
|
|
785
755
|
/**
|
|
786
|
-
*
|
|
756
|
+
* Array of locales to publish. They must be currently published in this record. To unpublish all locales, do NOT use this parameter, but instead unpublish the entire record by leaving the body blank (see example above).
|
|
787
757
|
*/
|
|
788
758
|
content_in_locales: string[];
|
|
789
759
|
};
|
|
@@ -795,14 +765,12 @@ export declare type ItemUnpublishSchema = {
|
|
|
795
765
|
*/
|
|
796
766
|
export declare type ItemUnpublishHrefSchema = {
|
|
797
767
|
/**
|
|
798
|
-
*
|
|
768
|
+
* When `recursive` is `true`, if the record belongs to a [tree-like collection](https://www.datocms.com/docs/content-modelling/trees), and any of the children records are published, those children records will unpublished as well. When `recursive` is `false` or not specified, a `PUBLISHED_CHILDREN` error will occur in such cases.
|
|
799
769
|
*/
|
|
800
770
|
recursive?: boolean;
|
|
801
771
|
[k: string]: unknown;
|
|
802
772
|
};
|
|
803
773
|
/**
|
|
804
|
-
* JSON API type upload
|
|
805
|
-
*
|
|
806
774
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
807
775
|
* via the `definition` "type".
|
|
808
776
|
*/
|
|
@@ -904,8 +872,6 @@ export declare type UploadReferencesHrefSchema = {
|
|
|
904
872
|
[k: string]: unknown;
|
|
905
873
|
};
|
|
906
874
|
/**
|
|
907
|
-
* JSON API type field
|
|
908
|
-
*
|
|
909
875
|
* This interface was referenced by `UploadRequest`'s JSON-Schema
|
|
910
876
|
* via the `definition` "type".
|
|
911
877
|
*/
|
|
@@ -921,8 +887,6 @@ export declare type UploadRequestType = 'upload_request';
|
|
|
921
887
|
*/
|
|
922
888
|
export declare type UploadRequestIdentity = string;
|
|
923
889
|
/**
|
|
924
|
-
* JSON API type field
|
|
925
|
-
*
|
|
926
890
|
* This interface was referenced by `SearchResult`'s JSON-Schema
|
|
927
891
|
* via the `definition` "type".
|
|
928
892
|
*/
|
|
@@ -981,8 +945,6 @@ export declare type SearchResultInstancesHrefSchema = {
|
|
|
981
945
|
[k: string]: unknown;
|
|
982
946
|
};
|
|
983
947
|
/**
|
|
984
|
-
* JSON API type field
|
|
985
|
-
*
|
|
986
948
|
* This interface was referenced by `Environment`'s JSON-Schema
|
|
987
949
|
* via the `definition` "type".
|
|
988
950
|
*/
|
|
@@ -1007,8 +969,6 @@ export declare type EnvironmentForkHrefSchema = {
|
|
|
1007
969
|
[k: string]: unknown;
|
|
1008
970
|
};
|
|
1009
971
|
/**
|
|
1010
|
-
* JSON API type field
|
|
1011
|
-
*
|
|
1012
972
|
* This interface was referenced by `MaintenanceMode`'s JSON-Schema
|
|
1013
973
|
* via the `definition` "type".
|
|
1014
974
|
*/
|
|
@@ -1035,8 +995,6 @@ export declare type MaintenanceModeActivateHrefSchema = {
|
|
|
1035
995
|
[k: string]: unknown;
|
|
1036
996
|
};
|
|
1037
997
|
/**
|
|
1038
|
-
* JSON API type field
|
|
1039
|
-
*
|
|
1040
998
|
* This interface was referenced by `Webhook`'s JSON-Schema
|
|
1041
999
|
* via the `definition` "type".
|
|
1042
1000
|
*/
|
|
@@ -1052,8 +1010,6 @@ export declare type WebhookType = 'webhook';
|
|
|
1052
1010
|
*/
|
|
1053
1011
|
export declare type WebhookIdentity = string;
|
|
1054
1012
|
/**
|
|
1055
|
-
* JSON API type field
|
|
1056
|
-
*
|
|
1057
1013
|
* This interface was referenced by `WebhookCall`'s JSON-Schema
|
|
1058
1014
|
* via the `definition` "type".
|
|
1059
1015
|
*/
|
|
@@ -1090,8 +1046,6 @@ export declare type WebhookCallInstancesHrefSchema = {
|
|
|
1090
1046
|
[k: string]: unknown;
|
|
1091
1047
|
};
|
|
1092
1048
|
/**
|
|
1093
|
-
* JSON API type field
|
|
1094
|
-
*
|
|
1095
1049
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
1096
1050
|
* via the `definition` "type".
|
|
1097
1051
|
*/
|
|
@@ -1107,8 +1061,6 @@ export declare type UploadFilterType = 'upload_filter';
|
|
|
1107
1061
|
*/
|
|
1108
1062
|
export declare type UploadFilterIdentity = string;
|
|
1109
1063
|
/**
|
|
1110
|
-
* JSON API type field
|
|
1111
|
-
*
|
|
1112
1064
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
1113
1065
|
* via the `definition` "type".
|
|
1114
1066
|
*/
|
|
@@ -1124,8 +1076,6 @@ export declare type SiteInvitationType = 'site_invitation';
|
|
|
1124
1076
|
*/
|
|
1125
1077
|
export declare type SiteInvitationIdentity = string;
|
|
1126
1078
|
/**
|
|
1127
|
-
* JSON API type field
|
|
1128
|
-
*
|
|
1129
1079
|
* This interface was referenced by `EditingSession`'s JSON-Schema
|
|
1130
1080
|
* via the `definition` "type".
|
|
1131
1081
|
*/
|
|
@@ -1141,8 +1091,6 @@ export declare type EditingSessionType = 'editing_session';
|
|
|
1141
1091
|
*/
|
|
1142
1092
|
export declare type EditingSessionIdentity = string;
|
|
1143
1093
|
/**
|
|
1144
|
-
* JSON API type field
|
|
1145
|
-
*
|
|
1146
1094
|
* This interface was referenced by `FormData`'s JSON-Schema
|
|
1147
1095
|
* via the `definition` "type".
|
|
1148
1096
|
*/
|
|
@@ -1158,8 +1106,6 @@ export declare type FormDataType = 'form_data';
|
|
|
1158
1106
|
*/
|
|
1159
1107
|
export declare type FormDataIdentity = 'form_data';
|
|
1160
1108
|
/**
|
|
1161
|
-
* JSON API type field
|
|
1162
|
-
*
|
|
1163
1109
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
1164
1110
|
* via the `definition` "type".
|
|
1165
1111
|
*/
|
|
@@ -1175,8 +1121,6 @@ export declare type SsoSettingsType = 'sso_settings';
|
|
|
1175
1121
|
*/
|
|
1176
1122
|
export declare type SsoSettingsIdentity = string;
|
|
1177
1123
|
/**
|
|
1178
|
-
* JSON API type field
|
|
1179
|
-
*
|
|
1180
1124
|
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema
|
|
1181
1125
|
* via the `definition` "type".
|
|
1182
1126
|
*/
|
|
@@ -1192,8 +1136,6 @@ export declare type WhiteLabelSettingsType = 'white_label_settings';
|
|
|
1192
1136
|
*/
|
|
1193
1137
|
export declare type WhiteLabelSettingsIdentity = string;
|
|
1194
1138
|
/**
|
|
1195
|
-
* JSON API type field
|
|
1196
|
-
*
|
|
1197
1139
|
* This interface was referenced by `PublicInfo`'s JSON-Schema
|
|
1198
1140
|
* via the `definition` "type".
|
|
1199
1141
|
*/
|
|
@@ -1209,8 +1151,6 @@ export declare type PublicInfoType = 'public_info';
|
|
|
1209
1151
|
*/
|
|
1210
1152
|
export declare type PublicInfoIdentity = string;
|
|
1211
1153
|
/**
|
|
1212
|
-
* JSON API type field
|
|
1213
|
-
*
|
|
1214
1154
|
* This interface was referenced by `DailyUsage`'s JSON-Schema
|
|
1215
1155
|
* via the `definition` "type".
|
|
1216
1156
|
*/
|
|
@@ -1226,8 +1166,6 @@ export declare type DailyUsageType = 'daily_usage';
|
|
|
1226
1166
|
*/
|
|
1227
1167
|
export declare type DailyUsageIdentity = string;
|
|
1228
1168
|
/**
|
|
1229
|
-
* JSON API type field
|
|
1230
|
-
*
|
|
1231
1169
|
* This interface was referenced by `UsageCounter`'s JSON-Schema
|
|
1232
1170
|
* via the `definition` "type".
|
|
1233
1171
|
*/
|
|
@@ -1253,8 +1191,6 @@ export declare type UsageCounterSelfHrefSchema = {
|
|
|
1253
1191
|
period?: 'today' | 'current_month' | 'last_month';
|
|
1254
1192
|
};
|
|
1255
1193
|
/**
|
|
1256
|
-
* JSON API type field
|
|
1257
|
-
*
|
|
1258
1194
|
* This interface was referenced by `UploadTag`'s JSON-Schema
|
|
1259
1195
|
* via the `definition` "type".
|
|
1260
1196
|
*/
|
|
@@ -1301,8 +1237,6 @@ export declare type UploadTagInstancesHrefSchema = {
|
|
|
1301
1237
|
[k: string]: unknown;
|
|
1302
1238
|
};
|
|
1303
1239
|
/**
|
|
1304
|
-
* JSON API type field
|
|
1305
|
-
*
|
|
1306
1240
|
* This interface was referenced by `UploadSmartTag`'s JSON-Schema
|
|
1307
1241
|
* via the `definition` "type".
|
|
1308
1242
|
*/
|
|
@@ -1349,8 +1283,6 @@ export declare type UploadSmartTagInstancesHrefSchema = {
|
|
|
1349
1283
|
[k: string]: unknown;
|
|
1350
1284
|
};
|
|
1351
1285
|
/**
|
|
1352
|
-
* JSON API type field
|
|
1353
|
-
*
|
|
1354
1286
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
1355
1287
|
* via the `definition` "type".
|
|
1356
1288
|
*/
|
|
@@ -1385,6 +1317,7 @@ export declare type DatoApi = {
|
|
|
1385
1317
|
organization?: Organization;
|
|
1386
1318
|
site_plan?: SitePlan;
|
|
1387
1319
|
menu_item?: MenuItem;
|
|
1320
|
+
schema_menu_item?: SchemaMenuItem;
|
|
1388
1321
|
item_type?: ItemType;
|
|
1389
1322
|
field?: Field;
|
|
1390
1323
|
fieldset?: Fieldset;
|
|
@@ -2915,9 +2848,6 @@ export declare type AuditLogEventData = {
|
|
|
2915
2848
|
*/
|
|
2916
2849
|
export declare type AuditLogEventQuerySchema = {
|
|
2917
2850
|
data: {
|
|
2918
|
-
/**
|
|
2919
|
-
* JSON API type field
|
|
2920
|
-
*/
|
|
2921
2851
|
type: 'audit_log_query';
|
|
2922
2852
|
attributes: {
|
|
2923
2853
|
/**
|
|
@@ -3459,6 +3389,197 @@ export declare type MenuItemSelfTargetSchema = {
|
|
|
3459
3389
|
export declare type MenuItemDestroyTargetSchema = {
|
|
3460
3390
|
data: MenuItem;
|
|
3461
3391
|
};
|
|
3392
|
+
/**
|
|
3393
|
+
* In DatoCMS you can organize the different models and blocks present in your administrative area reordering and grouping them, so that their purpose will be more clear to the final editor.
|
|
3394
|
+
*
|
|
3395
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3396
|
+
* via the `definition` "schema_menu_item".
|
|
3397
|
+
*/
|
|
3398
|
+
export declare type SchemaMenuItem = {
|
|
3399
|
+
type: SchemaMenuItemType;
|
|
3400
|
+
id: SchemaMenuItemIdentity;
|
|
3401
|
+
attributes: SchemaMenuItemAttributes;
|
|
3402
|
+
relationships: SchemaMenuItemRelationships;
|
|
3403
|
+
};
|
|
3404
|
+
/**
|
|
3405
|
+
* JSON API attributes
|
|
3406
|
+
*
|
|
3407
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3408
|
+
* via the `definition` "attributes".
|
|
3409
|
+
*/
|
|
3410
|
+
export declare type SchemaMenuItemAttributes = {
|
|
3411
|
+
/**
|
|
3412
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
3413
|
+
*/
|
|
3414
|
+
label: null | string;
|
|
3415
|
+
/**
|
|
3416
|
+
* Ordering index
|
|
3417
|
+
*/
|
|
3418
|
+
position: number;
|
|
3419
|
+
/**
|
|
3420
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
3421
|
+
*/
|
|
3422
|
+
kind: 'item_type' | 'modular_block';
|
|
3423
|
+
};
|
|
3424
|
+
/**
|
|
3425
|
+
* JSON API links
|
|
3426
|
+
*
|
|
3427
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3428
|
+
* via the `definition` "relationships".
|
|
3429
|
+
*/
|
|
3430
|
+
export declare type SchemaMenuItemRelationships = {
|
|
3431
|
+
/**
|
|
3432
|
+
* Item type associated with the schema menu item
|
|
3433
|
+
*/
|
|
3434
|
+
item_type: {
|
|
3435
|
+
data: ItemTypeData | null;
|
|
3436
|
+
};
|
|
3437
|
+
/**
|
|
3438
|
+
* Parent schema menu item
|
|
3439
|
+
*/
|
|
3440
|
+
parent: {
|
|
3441
|
+
data: null | SchemaMenuItemData;
|
|
3442
|
+
};
|
|
3443
|
+
/**
|
|
3444
|
+
* Underlying schema menu items
|
|
3445
|
+
*/
|
|
3446
|
+
children: {
|
|
3447
|
+
data: SchemaMenuItemData[];
|
|
3448
|
+
};
|
|
3449
|
+
};
|
|
3450
|
+
/**
|
|
3451
|
+
* JSON API data
|
|
3452
|
+
*
|
|
3453
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3454
|
+
* via the `definition` "data".
|
|
3455
|
+
*/
|
|
3456
|
+
export declare type SchemaMenuItemData = {
|
|
3457
|
+
type: SchemaMenuItemType;
|
|
3458
|
+
id: SchemaMenuItemIdentity;
|
|
3459
|
+
};
|
|
3460
|
+
/**
|
|
3461
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3462
|
+
* via the `create.schema` link.
|
|
3463
|
+
*/
|
|
3464
|
+
export declare type SchemaMenuItemCreateSchema = {
|
|
3465
|
+
data: {
|
|
3466
|
+
id?: SchemaMenuItemIdentity;
|
|
3467
|
+
type: SchemaMenuItemType;
|
|
3468
|
+
/**
|
|
3469
|
+
* JSON API attributes
|
|
3470
|
+
*/
|
|
3471
|
+
attributes: {
|
|
3472
|
+
/**
|
|
3473
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
3474
|
+
*/
|
|
3475
|
+
label: null | string;
|
|
3476
|
+
/**
|
|
3477
|
+
* Ordering index
|
|
3478
|
+
*/
|
|
3479
|
+
position?: number;
|
|
3480
|
+
/**
|
|
3481
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
3482
|
+
*/
|
|
3483
|
+
kind: 'item_type' | 'modular_block';
|
|
3484
|
+
};
|
|
3485
|
+
relationships?: {
|
|
3486
|
+
/**
|
|
3487
|
+
* Item type associated with the menu item
|
|
3488
|
+
*/
|
|
3489
|
+
item_type?: {
|
|
3490
|
+
data: ItemTypeData | null;
|
|
3491
|
+
};
|
|
3492
|
+
/**
|
|
3493
|
+
* Parent schema menu item
|
|
3494
|
+
*/
|
|
3495
|
+
parent?: {
|
|
3496
|
+
data: null | SchemaMenuItemData;
|
|
3497
|
+
};
|
|
3498
|
+
};
|
|
3499
|
+
};
|
|
3500
|
+
};
|
|
3501
|
+
/**
|
|
3502
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3503
|
+
* via the `create.targetSchema` link.
|
|
3504
|
+
*/
|
|
3505
|
+
export declare type SchemaMenuItemCreateTargetSchema = {
|
|
3506
|
+
data: SchemaMenuItem;
|
|
3507
|
+
};
|
|
3508
|
+
/**
|
|
3509
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3510
|
+
* via the `update.schema` link.
|
|
3511
|
+
*/
|
|
3512
|
+
export declare type SchemaMenuItemUpdateSchema = {
|
|
3513
|
+
data: {
|
|
3514
|
+
type: SchemaMenuItemType;
|
|
3515
|
+
id: SchemaMenuItemIdentity;
|
|
3516
|
+
/**
|
|
3517
|
+
* JSON API attributes
|
|
3518
|
+
*/
|
|
3519
|
+
attributes?: {
|
|
3520
|
+
/**
|
|
3521
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
3522
|
+
*/
|
|
3523
|
+
label?: null | string;
|
|
3524
|
+
/**
|
|
3525
|
+
* Ordering index
|
|
3526
|
+
*/
|
|
3527
|
+
position?: number;
|
|
3528
|
+
/**
|
|
3529
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
3530
|
+
*/
|
|
3531
|
+
kind?: 'item_type' | 'modular_block';
|
|
3532
|
+
};
|
|
3533
|
+
relationships?: {
|
|
3534
|
+
/**
|
|
3535
|
+
* Item type associated with the menu item
|
|
3536
|
+
*/
|
|
3537
|
+
item_type?: {
|
|
3538
|
+
data: ItemTypeData | null;
|
|
3539
|
+
};
|
|
3540
|
+
/**
|
|
3541
|
+
* Parent schema menu item
|
|
3542
|
+
*/
|
|
3543
|
+
parent?: {
|
|
3544
|
+
data: null | SchemaMenuItemData;
|
|
3545
|
+
};
|
|
3546
|
+
/**
|
|
3547
|
+
* Underlying schema menu items
|
|
3548
|
+
*/
|
|
3549
|
+
children?: {
|
|
3550
|
+
data: SchemaMenuItemData[];
|
|
3551
|
+
};
|
|
3552
|
+
};
|
|
3553
|
+
};
|
|
3554
|
+
};
|
|
3555
|
+
/**
|
|
3556
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3557
|
+
* via the `update.targetSchema` link.
|
|
3558
|
+
*/
|
|
3559
|
+
export declare type SchemaMenuItemUpdateTargetSchema = {
|
|
3560
|
+
data: SchemaMenuItem;
|
|
3561
|
+
};
|
|
3562
|
+
/**
|
|
3563
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3564
|
+
* via the `instances.targetSchema` link.
|
|
3565
|
+
*/
|
|
3566
|
+
export declare type SchemaMenuItemInstancesTargetSchema = {
|
|
3567
|
+
data: SchemaMenuItem[];
|
|
3568
|
+
};
|
|
3569
|
+
/**
|
|
3570
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3571
|
+
* via the `self.targetSchema` link.
|
|
3572
|
+
*/
|
|
3573
|
+
export declare type SchemaMenuItemSelfTargetSchema = {
|
|
3574
|
+
data: SchemaMenuItem;
|
|
3575
|
+
};
|
|
3576
|
+
/**
|
|
3577
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3578
|
+
* via the `destroy.targetSchema` link.
|
|
3579
|
+
*/
|
|
3580
|
+
export declare type SchemaMenuItemDestroyTargetSchema = {
|
|
3581
|
+
data: SchemaMenuItem;
|
|
3582
|
+
};
|
|
3462
3583
|
/**
|
|
3463
3584
|
* 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".
|
|
3464
3585
|
*
|
|
@@ -4762,6 +4883,18 @@ export declare type ItemTypeDestroyJobSchema = {
|
|
|
4762
4883
|
* </details>
|
|
4763
4884
|
*
|
|
4764
4885
|
* <details>
|
|
4886
|
+
* <summary><code>seo</code></summary>
|
|
4887
|
+
*
|
|
4888
|
+
* Built-in editor for _seo_ fields.
|
|
4889
|
+
*
|
|
4890
|
+
* | Parameter | Type | Required | Description |
|
|
4891
|
+
* | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
4892
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
4893
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"` |
|
|
4894
|
+
*
|
|
4895
|
+
* </details>
|
|
4896
|
+
*
|
|
4897
|
+
* <details>
|
|
4765
4898
|
* <summary><code>rich_text</code></summary>
|
|
4766
4899
|
*
|
|
4767
4900
|
* Built-in editor for _Modular content_ fields.
|
|
@@ -5436,9 +5569,6 @@ export declare type SessionData = {
|
|
|
5436
5569
|
*/
|
|
5437
5570
|
export declare type SessionCreateSchema = {
|
|
5438
5571
|
data: {
|
|
5439
|
-
/**
|
|
5440
|
-
* JSON API type field
|
|
5441
|
-
*/
|
|
5442
5572
|
type: 'email_credentials';
|
|
5443
5573
|
/**
|
|
5444
5574
|
* JSON API attributes
|
|
@@ -6761,9 +6891,6 @@ export declare type ItemUnpublishTargetSchema = {
|
|
|
6761
6891
|
*/
|
|
6762
6892
|
export declare type ItemBulkPublishSchema = {
|
|
6763
6893
|
data: {
|
|
6764
|
-
/**
|
|
6765
|
-
* JSON API type field
|
|
6766
|
-
*/
|
|
6767
6894
|
type: 'item_bulk_publish_operation';
|
|
6768
6895
|
relationships: {
|
|
6769
6896
|
/**
|
|
@@ -6800,9 +6927,6 @@ export declare type ItemBulkPublishJobSchema = {
|
|
|
6800
6927
|
*/
|
|
6801
6928
|
export declare type ItemBulkUnpublishSchema = {
|
|
6802
6929
|
data: {
|
|
6803
|
-
/**
|
|
6804
|
-
* JSON API type field
|
|
6805
|
-
*/
|
|
6806
6930
|
type: 'item_bulk_unpublish_operation';
|
|
6807
6931
|
relationships: {
|
|
6808
6932
|
/**
|
|
@@ -6839,9 +6963,6 @@ export declare type ItemBulkUnpublishJobSchema = {
|
|
|
6839
6963
|
*/
|
|
6840
6964
|
export declare type ItemBulkDestroySchema = {
|
|
6841
6965
|
data: {
|
|
6842
|
-
/**
|
|
6843
|
-
* JSON API type field
|
|
6844
|
-
*/
|
|
6845
6966
|
type: 'item_bulk_destroy_operation';
|
|
6846
6967
|
relationships: {
|
|
6847
6968
|
/**
|
|
@@ -6878,9 +6999,6 @@ export declare type ItemBulkDestroyJobSchema = {
|
|
|
6878
6999
|
*/
|
|
6879
7000
|
export declare type ItemBulkMoveToStageSchema = {
|
|
6880
7001
|
data: {
|
|
6881
|
-
/**
|
|
6882
|
-
* JSON API type field
|
|
6883
|
-
*/
|
|
6884
7002
|
type: 'item_bulk_move_to_stage_operation';
|
|
6885
7003
|
attributes: {
|
|
6886
7004
|
/**
|
|
@@ -7392,9 +7510,6 @@ export declare type UploadReferencesTargetSchema = {
|
|
|
7392
7510
|
*/
|
|
7393
7511
|
export declare type UploadBulkTagSchema = {
|
|
7394
7512
|
data: {
|
|
7395
|
-
/**
|
|
7396
|
-
* JSON API type field
|
|
7397
|
-
*/
|
|
7398
7513
|
type: 'upload_bulk_tag_operation';
|
|
7399
7514
|
/**
|
|
7400
7515
|
* JSON API attributes
|
|
@@ -7439,9 +7554,6 @@ export declare type UploadBulkTagJobSchema = {
|
|
|
7439
7554
|
*/
|
|
7440
7555
|
export declare type UploadBulkDestroySchema = {
|
|
7441
7556
|
data: {
|
|
7442
|
-
/**
|
|
7443
|
-
* JSON API type field
|
|
7444
|
-
*/
|
|
7445
7557
|
type: 'upload_bulk_destroy_operation';
|
|
7446
7558
|
relationships: {
|
|
7447
7559
|
/**
|
|
@@ -9158,9 +9270,6 @@ export declare type SsoSettingsSelfTargetSchema = {
|
|
|
9158
9270
|
export declare type SsoSettingsGenerateTokenTargetSchema = {
|
|
9159
9271
|
data: {
|
|
9160
9272
|
id: SsoSettingsIdentity;
|
|
9161
|
-
/**
|
|
9162
|
-
* JSON API type field
|
|
9163
|
-
*/
|
|
9164
9273
|
type: 'sso_token';
|
|
9165
9274
|
attributes: {
|
|
9166
9275
|
/**
|
|
@@ -9311,35 +9420,31 @@ export declare type PublicInfoAttributes = {
|
|
|
9311
9420
|
* Specifies the color-scheme for the project
|
|
9312
9421
|
*/
|
|
9313
9422
|
theme: {
|
|
9314
|
-
primary_color
|
|
9423
|
+
primary_color: {
|
|
9315
9424
|
red: number;
|
|
9316
9425
|
green: number;
|
|
9317
9426
|
blue: number;
|
|
9318
9427
|
alpha: number;
|
|
9319
9428
|
[k: string]: unknown;
|
|
9320
9429
|
};
|
|
9321
|
-
light_color
|
|
9430
|
+
light_color: {
|
|
9322
9431
|
red: number;
|
|
9323
9432
|
green: number;
|
|
9324
9433
|
blue: number;
|
|
9325
9434
|
alpha: number;
|
|
9326
|
-
[k: string]: unknown;
|
|
9327
9435
|
};
|
|
9328
|
-
accent_color
|
|
9436
|
+
accent_color: {
|
|
9329
9437
|
red: number;
|
|
9330
9438
|
green: number;
|
|
9331
9439
|
blue: number;
|
|
9332
9440
|
alpha: number;
|
|
9333
|
-
[k: string]: unknown;
|
|
9334
9441
|
};
|
|
9335
|
-
dark_color
|
|
9442
|
+
dark_color: {
|
|
9336
9443
|
red: number;
|
|
9337
9444
|
green: number;
|
|
9338
9445
|
blue: number;
|
|
9339
9446
|
alpha: number;
|
|
9340
|
-
[k: string]: unknown;
|
|
9341
9447
|
};
|
|
9342
|
-
[k: string]: unknown;
|
|
9343
9448
|
};
|
|
9344
9449
|
/**
|
|
9345
9450
|
* Additional information (only returned on authenticated requests)
|
|
@@ -9658,39 +9763,42 @@ export declare type SiteAttributes = {
|
|
|
9658
9763
|
* Specifies the theme to use in administrative area
|
|
9659
9764
|
*/
|
|
9660
9765
|
theme: {
|
|
9766
|
+
/**
|
|
9767
|
+
* If type is monochromatic, the hue will determine the color palette. Dark color is a legacy property, and it won't be used on the interface
|
|
9768
|
+
*/
|
|
9769
|
+
type: 'custom' | 'monochromatic';
|
|
9770
|
+
/**
|
|
9771
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
9772
|
+
*/
|
|
9773
|
+
hue: number | null;
|
|
9661
9774
|
primary_color: {
|
|
9662
9775
|
red: number;
|
|
9663
9776
|
green: number;
|
|
9664
9777
|
blue: number;
|
|
9665
9778
|
alpha: number;
|
|
9666
|
-
[k: string]: unknown;
|
|
9667
9779
|
};
|
|
9668
9780
|
light_color: {
|
|
9669
9781
|
red: number;
|
|
9670
9782
|
green: number;
|
|
9671
9783
|
blue: number;
|
|
9672
9784
|
alpha: number;
|
|
9673
|
-
[k: string]: unknown;
|
|
9674
9785
|
};
|
|
9675
9786
|
accent_color: {
|
|
9676
9787
|
red: number;
|
|
9677
9788
|
green: number;
|
|
9678
9789
|
blue: number;
|
|
9679
9790
|
alpha: number;
|
|
9680
|
-
[k: string]: unknown;
|
|
9681
9791
|
};
|
|
9682
9792
|
dark_color: {
|
|
9683
9793
|
red: number;
|
|
9684
9794
|
green: number;
|
|
9685
9795
|
blue: number;
|
|
9686
9796
|
alpha: number;
|
|
9687
|
-
[k: string]: unknown;
|
|
9688
9797
|
};
|
|
9689
9798
|
/**
|
|
9690
|
-
* The
|
|
9799
|
+
* The upload ID that is used as the logo for the project
|
|
9691
9800
|
*/
|
|
9692
9801
|
logo: string | null;
|
|
9693
|
-
[k: string]: unknown;
|
|
9694
9802
|
};
|
|
9695
9803
|
/**
|
|
9696
9804
|
* Specifies default global settings
|
|
@@ -9767,6 +9875,14 @@ export declare type SiteMeta = {
|
|
|
9767
9875
|
* Whether the Improved GraphQL multi-locale fields option is active or not
|
|
9768
9876
|
*/
|
|
9769
9877
|
improved_gql_multilocale_fields: boolean;
|
|
9878
|
+
/**
|
|
9879
|
+
* Whether the Improved GraphQL visibility control option is active or not
|
|
9880
|
+
*/
|
|
9881
|
+
improved_gql_visibility_control: boolean;
|
|
9882
|
+
/**
|
|
9883
|
+
* Whether the Improved boolean fields option is active or not
|
|
9884
|
+
*/
|
|
9885
|
+
improved_boolean_fields: boolean;
|
|
9770
9886
|
};
|
|
9771
9887
|
/**
|
|
9772
9888
|
* JSON API data
|
|
@@ -9842,42 +9958,53 @@ export declare type SiteUpdateSchema = {
|
|
|
9842
9958
|
* Site name
|
|
9843
9959
|
*/
|
|
9844
9960
|
name?: string;
|
|
9845
|
-
/**
|
|
9846
|
-
* Specifies the theme to use in administrative area
|
|
9847
|
-
*/
|
|
9848
9961
|
theme?: {
|
|
9962
|
+
/**
|
|
9963
|
+
* Type of theme color palette
|
|
9964
|
+
*/
|
|
9965
|
+
type: 'monochromatic';
|
|
9966
|
+
/**
|
|
9967
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
9968
|
+
*/
|
|
9969
|
+
hue: number | null;
|
|
9970
|
+
/**
|
|
9971
|
+
* The upload ID that is used as the logo for the project
|
|
9972
|
+
*/
|
|
9973
|
+
logo: string | null;
|
|
9974
|
+
[k: string]: unknown;
|
|
9975
|
+
} | {
|
|
9976
|
+
/**
|
|
9977
|
+
* Type of theme color palette
|
|
9978
|
+
*/
|
|
9979
|
+
type?: 'custom';
|
|
9980
|
+
/**
|
|
9981
|
+
* The upload ID that is used as the logo for the project
|
|
9982
|
+
*/
|
|
9983
|
+
logo: string | null;
|
|
9849
9984
|
primary_color: {
|
|
9850
9985
|
red: number;
|
|
9851
9986
|
green: number;
|
|
9852
9987
|
blue: number;
|
|
9853
9988
|
alpha: number;
|
|
9854
|
-
[k: string]: unknown;
|
|
9855
9989
|
};
|
|
9856
9990
|
light_color: {
|
|
9857
9991
|
red: number;
|
|
9858
9992
|
green: number;
|
|
9859
9993
|
blue: number;
|
|
9860
9994
|
alpha: number;
|
|
9861
|
-
[k: string]: unknown;
|
|
9862
9995
|
};
|
|
9863
9996
|
accent_color: {
|
|
9864
9997
|
red: number;
|
|
9865
9998
|
green: number;
|
|
9866
9999
|
blue: number;
|
|
9867
10000
|
alpha: number;
|
|
9868
|
-
[k: string]: unknown;
|
|
9869
10001
|
};
|
|
9870
|
-
dark_color
|
|
10002
|
+
dark_color?: {
|
|
9871
10003
|
red: number;
|
|
9872
10004
|
green: number;
|
|
9873
10005
|
blue: number;
|
|
9874
10006
|
alpha: number;
|
|
9875
|
-
[k: string]: unknown;
|
|
9876
10007
|
};
|
|
9877
|
-
/**
|
|
9878
|
-
* The site logo
|
|
9879
|
-
*/
|
|
9880
|
-
logo: string | null;
|
|
9881
10008
|
[k: string]: unknown;
|
|
9882
10009
|
};
|
|
9883
10010
|
/**
|
|
@@ -9914,6 +10041,14 @@ export declare type SiteUpdateSchema = {
|
|
|
9914
10041
|
* Whether the Improved GraphQL multi-locale fields option is active or not
|
|
9915
10042
|
*/
|
|
9916
10043
|
improved_gql_multilocale_fields?: boolean;
|
|
10044
|
+
/**
|
|
10045
|
+
* Whether the Improved GraphQL visibility control option is active or not
|
|
10046
|
+
*/
|
|
10047
|
+
improved_gql_visibility_control?: boolean;
|
|
10048
|
+
/**
|
|
10049
|
+
* Whether the Improved boolean fields option is active or not
|
|
10050
|
+
*/
|
|
10051
|
+
improved_boolean_fields?: boolean;
|
|
9917
10052
|
};
|
|
9918
10053
|
relationships?: {
|
|
9919
10054
|
sso_default_role?: {
|
|
@@ -9964,6 +10099,20 @@ export declare type SiteActivateImprovedHexManagementTargetSchema = {
|
|
|
9964
10099
|
export declare type SiteActivateImprovedGqlMultilocaleFieldsTargetSchema = {
|
|
9965
10100
|
data: Site;
|
|
9966
10101
|
};
|
|
10102
|
+
/**
|
|
10103
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
10104
|
+
* via the `activate_improved_gql_visibility_control.targetSchema` link.
|
|
10105
|
+
*/
|
|
10106
|
+
export declare type SiteActivateImprovedGqlVisibilityControlTargetSchema = {
|
|
10107
|
+
data: Site;
|
|
10108
|
+
};
|
|
10109
|
+
/**
|
|
10110
|
+
* This interface was referenced by `Site`'s JSON-Schema
|
|
10111
|
+
* via the `activate_improved_boolean_fields.targetSchema` link.
|
|
10112
|
+
*/
|
|
10113
|
+
export declare type SiteActivateImprovedBooleanFieldsTargetSchema = {
|
|
10114
|
+
data: Site;
|
|
10115
|
+
};
|
|
9967
10116
|
/**
|
|
9968
10117
|
* 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.
|
|
9969
10118
|
*
|