@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
|
@@ -14,8 +14,6 @@
|
|
|
14
14
|
*/
|
|
15
15
|
export type RoleIdentity = string;
|
|
16
16
|
/**
|
|
17
|
-
* JSON API type field
|
|
18
|
-
*
|
|
19
17
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
20
18
|
* via the `definition` "type".
|
|
21
19
|
*/
|
|
@@ -76,8 +74,6 @@ export type RoleInstancesTargetSchema = Role[];
|
|
|
76
74
|
*/
|
|
77
75
|
export type UserIdentity = string;
|
|
78
76
|
/**
|
|
79
|
-
* JSON API type field
|
|
80
|
-
*
|
|
81
77
|
* This interface was referenced by `User`'s JSON-Schema
|
|
82
78
|
* via the `definition` "type".
|
|
83
79
|
*/
|
|
@@ -114,15 +110,11 @@ export type UserMeTargetSchema = User | SsoUser | AccessToken | Account;
|
|
|
114
110
|
*/
|
|
115
111
|
export type SsoUserIdentity = string;
|
|
116
112
|
/**
|
|
117
|
-
* JSON API type field
|
|
118
|
-
*
|
|
119
113
|
* This interface was referenced by `SsoUser`'s JSON-Schema
|
|
120
114
|
* via the `definition` "type".
|
|
121
115
|
*/
|
|
122
116
|
export type SsoUserType = 'sso_user';
|
|
123
117
|
/**
|
|
124
|
-
* JSON API type field
|
|
125
|
-
*
|
|
126
118
|
* This interface was referenced by `SsoGroup`'s JSON-Schema
|
|
127
119
|
* via the `definition` "type".
|
|
128
120
|
*/
|
|
@@ -173,8 +165,6 @@ export type SsoUserDestroyHrefSchema = {
|
|
|
173
165
|
*/
|
|
174
166
|
export type AccessTokenIdentity = string;
|
|
175
167
|
/**
|
|
176
|
-
* JSON API type field
|
|
177
|
-
*
|
|
178
168
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
179
169
|
* via the `definition` "type".
|
|
180
170
|
*/
|
|
@@ -210,8 +200,6 @@ export type AccessTokenDestroyHrefSchema = {
|
|
|
210
200
|
*/
|
|
211
201
|
export type AccountIdentity = string;
|
|
212
202
|
/**
|
|
213
|
-
* JSON API type field
|
|
214
|
-
*
|
|
215
203
|
* This interface was referenced by `Account`'s JSON-Schema
|
|
216
204
|
* via the `definition` "type".
|
|
217
205
|
*/
|
|
@@ -253,8 +241,6 @@ export type UserDestroyHrefSchema = {
|
|
|
253
241
|
*/
|
|
254
242
|
export type AuditLogEventIdentity = string;
|
|
255
243
|
/**
|
|
256
|
-
* JSON API type field
|
|
257
|
-
*
|
|
258
244
|
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
259
245
|
* via the `definition` "type".
|
|
260
246
|
*/
|
|
@@ -275,8 +261,6 @@ export type AuditLogEventQueryTargetSchema = AuditLogEvent[];
|
|
|
275
261
|
*/
|
|
276
262
|
export type OrganizationIdentity = string;
|
|
277
263
|
/**
|
|
278
|
-
* JSON API type field
|
|
279
|
-
*
|
|
280
264
|
* This interface was referenced by `Organization`'s JSON-Schema
|
|
281
265
|
* via the `definition` "type".
|
|
282
266
|
*/
|
|
@@ -292,8 +276,6 @@ export type OrganizationType = 'organization';
|
|
|
292
276
|
*/
|
|
293
277
|
export type SitePlanIdentity = string;
|
|
294
278
|
/**
|
|
295
|
-
* JSON API type field
|
|
296
|
-
*
|
|
297
279
|
* This interface was referenced by `SitePlan`'s JSON-Schema
|
|
298
280
|
* via the `definition` "type".
|
|
299
281
|
*/
|
|
@@ -309,22 +291,16 @@ export type SitePlanType = 'site_plan';
|
|
|
309
291
|
*/
|
|
310
292
|
export type MenuItemIdentity = string;
|
|
311
293
|
/**
|
|
312
|
-
* JSON API type field
|
|
313
|
-
*
|
|
314
294
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
315
295
|
* via the `definition` "type".
|
|
316
296
|
*/
|
|
317
297
|
export type MenuItemType = 'menu_item';
|
|
318
298
|
/**
|
|
319
|
-
* JSON API type field
|
|
320
|
-
*
|
|
321
299
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
322
300
|
* via the `definition` "type".
|
|
323
301
|
*/
|
|
324
302
|
export type ItemTypeType = 'item_type';
|
|
325
303
|
/**
|
|
326
|
-
* JSON API type field
|
|
327
|
-
*
|
|
328
304
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
329
305
|
* via the `definition` "type".
|
|
330
306
|
*/
|
|
@@ -356,9 +332,41 @@ export type MenuItemInstancesHrefSchema = {
|
|
|
356
332
|
ids: string;
|
|
357
333
|
};
|
|
358
334
|
};
|
|
335
|
+
/**
|
|
336
|
+
* RFC 4122 UUID of schema menu item expressed in URL-safe base64 format
|
|
337
|
+
*
|
|
338
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
339
|
+
* via the `definition` "identity".
|
|
340
|
+
*
|
|
341
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
342
|
+
* via the `definition` "id".
|
|
343
|
+
*/
|
|
344
|
+
export type SchemaMenuItemIdentity = string;
|
|
359
345
|
/**
|
|
360
346
|
* JSON API type field
|
|
361
347
|
*
|
|
348
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
349
|
+
* via the `definition` "type".
|
|
350
|
+
*/
|
|
351
|
+
export type SchemaMenuItemType = 'schema_menu_item';
|
|
352
|
+
/**
|
|
353
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
354
|
+
* via the `instances.targetSchema` link.
|
|
355
|
+
*/
|
|
356
|
+
export type SchemaMenuItemInstancesTargetSchema = SchemaMenuItem[];
|
|
357
|
+
/**
|
|
358
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
359
|
+
* via the `instances.hrefSchema` link.
|
|
360
|
+
*/
|
|
361
|
+
export type SchemaMenuItemInstancesHrefSchema = {
|
|
362
|
+
filter?: {
|
|
363
|
+
/**
|
|
364
|
+
* IDs to fetch, comma separated
|
|
365
|
+
*/
|
|
366
|
+
ids: string;
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
/**
|
|
362
370
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
363
371
|
* via the `definition` "type".
|
|
364
372
|
*/
|
|
@@ -374,8 +382,6 @@ export type ItemType1 = 'item';
|
|
|
374
382
|
*/
|
|
375
383
|
export type ItemIdentity = string;
|
|
376
384
|
/**
|
|
377
|
-
* JSON API type field
|
|
378
|
-
*
|
|
379
385
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
380
386
|
* via the `definition` "type".
|
|
381
387
|
*/
|
|
@@ -391,8 +397,6 @@ export type FieldType = 'field';
|
|
|
391
397
|
*/
|
|
392
398
|
export type FieldIdentity = string;
|
|
393
399
|
/**
|
|
394
|
-
* JSON API type fieldset
|
|
395
|
-
*
|
|
396
400
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
397
401
|
* via the `definition` "type".
|
|
398
402
|
*/
|
|
@@ -408,8 +412,6 @@ export type FieldsetType = 'fieldset';
|
|
|
408
412
|
*/
|
|
409
413
|
export type FieldsetIdentity = string;
|
|
410
414
|
/**
|
|
411
|
-
* JSON API type field
|
|
412
|
-
*
|
|
413
415
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
414
416
|
* via the `definition` "type".
|
|
415
417
|
*/
|
|
@@ -436,8 +438,6 @@ export type ItemTypeCreateHrefSchema = {
|
|
|
436
438
|
*/
|
|
437
439
|
export type JobIdentity = string;
|
|
438
440
|
/**
|
|
439
|
-
* JSON API type field
|
|
440
|
-
*
|
|
441
441
|
* This interface was referenced by `Job`'s JSON-Schema
|
|
442
442
|
* via the `definition` "type".
|
|
443
443
|
*/
|
|
@@ -489,8 +489,6 @@ export type FieldsetInstancesTargetSchema = Fieldset[];
|
|
|
489
489
|
*/
|
|
490
490
|
export type SessionIdentity = string;
|
|
491
491
|
/**
|
|
492
|
-
* JSON API type field
|
|
493
|
-
*
|
|
494
492
|
* This interface was referenced by `Session`'s JSON-Schema
|
|
495
493
|
* via the `definition` "type".
|
|
496
494
|
*/
|
|
@@ -506,8 +504,6 @@ export type SessionType = 'session';
|
|
|
506
504
|
*/
|
|
507
505
|
export type PluginIdentity = string;
|
|
508
506
|
/**
|
|
509
|
-
* JSON API type field
|
|
510
|
-
*
|
|
511
507
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
512
508
|
* via the `definition` "type".
|
|
513
509
|
*/
|
|
@@ -533,8 +529,6 @@ export type PluginFieldsTargetSchema = Field[];
|
|
|
533
529
|
*/
|
|
534
530
|
export type JobResultIdentity = string;
|
|
535
531
|
/**
|
|
536
|
-
* JSON API type field
|
|
537
|
-
*
|
|
538
532
|
* This interface was referenced by `JobResult`'s JSON-Schema
|
|
539
533
|
* via the `definition` "type".
|
|
540
534
|
*/
|
|
@@ -550,8 +544,6 @@ export type JobResultType = 'job_result';
|
|
|
550
544
|
*/
|
|
551
545
|
export type SubscriptionLimitIdentity = string;
|
|
552
546
|
/**
|
|
553
|
-
* JSON API type field
|
|
554
|
-
*
|
|
555
547
|
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema
|
|
556
548
|
* via the `definition` "type".
|
|
557
549
|
*/
|
|
@@ -572,8 +564,6 @@ export type SubscriptionLimitInstancesTargetSchema = SubscriptionLimit[];
|
|
|
572
564
|
*/
|
|
573
565
|
export type SubscriptionFeatureIdentity = string;
|
|
574
566
|
/**
|
|
575
|
-
* JSON API type field
|
|
576
|
-
*
|
|
577
567
|
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema
|
|
578
568
|
* via the `definition` "type".
|
|
579
569
|
*/
|
|
@@ -594,15 +584,11 @@ export type SubscriptionFeatureInstancesTargetSchema = SubscriptionFeature[];
|
|
|
594
584
|
*/
|
|
595
585
|
export type BuildEventIdentity = string;
|
|
596
586
|
/**
|
|
597
|
-
* JSON API type field
|
|
598
|
-
*
|
|
599
587
|
* This interface was referenced by `BuildEvent`'s JSON-Schema
|
|
600
588
|
* via the `definition` "type".
|
|
601
589
|
*/
|
|
602
590
|
export type BuildEventType = 'build_event';
|
|
603
591
|
/**
|
|
604
|
-
* JSON API type field
|
|
605
|
-
*
|
|
606
592
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
607
593
|
* via the `definition` "type".
|
|
608
594
|
*/
|
|
@@ -728,15 +714,11 @@ export type ItemSelfHrefSchema = {
|
|
|
728
714
|
*/
|
|
729
715
|
export type ItemCurrentVsPublishedStateIdentity = string;
|
|
730
716
|
/**
|
|
731
|
-
* JSON API type field
|
|
732
|
-
*
|
|
733
717
|
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
734
718
|
* via the `definition` "type".
|
|
735
719
|
*/
|
|
736
720
|
export type ItemCurrentVsPublishedStateType = 'item_current_vs_published_state';
|
|
737
721
|
/**
|
|
738
|
-
* JSON API type field
|
|
739
|
-
*
|
|
740
722
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
741
723
|
* via the `definition` "type".
|
|
742
724
|
*/
|
|
@@ -752,8 +734,6 @@ export type ScheduledPublicationType = 'scheduled_publication';
|
|
|
752
734
|
*/
|
|
753
735
|
export type ScheduledPublicationIdentity = string;
|
|
754
736
|
/**
|
|
755
|
-
* JSON API type field
|
|
756
|
-
*
|
|
757
737
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
758
738
|
* via the `definition` "type".
|
|
759
739
|
*/
|
|
@@ -769,8 +749,6 @@ export type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
|
769
749
|
*/
|
|
770
750
|
export type ScheduledUnpublishingIdentity = string;
|
|
771
751
|
/**
|
|
772
|
-
* JSON API type field
|
|
773
|
-
*
|
|
774
752
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
775
753
|
* via the `definition` "type".
|
|
776
754
|
*/
|
|
@@ -836,15 +814,15 @@ export type ItemBatchUnpublishHrefSchema = {
|
|
|
836
814
|
*/
|
|
837
815
|
export type ItemPublishSchema = {
|
|
838
816
|
/**
|
|
839
|
-
*
|
|
817
|
+
* 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.
|
|
840
818
|
*/
|
|
841
819
|
type?: 'selective_publish_operation';
|
|
842
820
|
/**
|
|
843
|
-
*
|
|
821
|
+
* Array of [valid locale codes in this project](/product-updates/get-locales-list-from-graphql) to publish.
|
|
844
822
|
*/
|
|
845
823
|
content_in_locales: string[];
|
|
846
824
|
/**
|
|
847
|
-
* Whether non-localized content
|
|
825
|
+
* Whether non-localized content will be published
|
|
848
826
|
*/
|
|
849
827
|
non_localized_content: boolean;
|
|
850
828
|
} | null;
|
|
@@ -854,7 +832,7 @@ export type ItemPublishSchema = {
|
|
|
854
832
|
*/
|
|
855
833
|
export type ItemPublishHrefSchema = {
|
|
856
834
|
/**
|
|
857
|
-
*
|
|
835
|
+
* 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.
|
|
858
836
|
*/
|
|
859
837
|
recursive?: boolean;
|
|
860
838
|
[k: string]: unknown;
|
|
@@ -864,12 +842,9 @@ export type ItemPublishHrefSchema = {
|
|
|
864
842
|
* via the `unpublish.schema` link.
|
|
865
843
|
*/
|
|
866
844
|
export type ItemUnpublishSchema = {
|
|
867
|
-
/**
|
|
868
|
-
* JSON API type field
|
|
869
|
-
*/
|
|
870
845
|
type?: 'selective_unpublish_operation';
|
|
871
846
|
/**
|
|
872
|
-
*
|
|
847
|
+
* 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).
|
|
873
848
|
*/
|
|
874
849
|
content_in_locales: string[];
|
|
875
850
|
} | null;
|
|
@@ -879,7 +854,7 @@ export type ItemUnpublishSchema = {
|
|
|
879
854
|
*/
|
|
880
855
|
export type ItemUnpublishHrefSchema = {
|
|
881
856
|
/**
|
|
882
|
-
*
|
|
857
|
+
* 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.
|
|
883
858
|
*/
|
|
884
859
|
recursive?: boolean;
|
|
885
860
|
[k: string]: unknown;
|
|
@@ -950,8 +925,6 @@ export type ItemVersionInstancesHrefSchema = {
|
|
|
950
925
|
*/
|
|
951
926
|
export type UploadIdentity = string;
|
|
952
927
|
/**
|
|
953
|
-
* JSON API type upload
|
|
954
|
-
*
|
|
955
928
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
956
929
|
* via the `definition` "type".
|
|
957
930
|
*/
|
|
@@ -1083,8 +1056,6 @@ export type UploadBulkDestroyJobSchema = unknown[];
|
|
|
1083
1056
|
*/
|
|
1084
1057
|
export type UploadRequestIdentity = string;
|
|
1085
1058
|
/**
|
|
1086
|
-
* JSON API type field
|
|
1087
|
-
*
|
|
1088
1059
|
* This interface was referenced by `UploadRequest`'s JSON-Schema
|
|
1089
1060
|
* via the `definition` "type".
|
|
1090
1061
|
*/
|
|
@@ -1100,8 +1071,6 @@ export type UploadRequestType = 'upload_request';
|
|
|
1100
1071
|
*/
|
|
1101
1072
|
export type SearchResultIdentity = string;
|
|
1102
1073
|
/**
|
|
1103
|
-
* JSON API type field
|
|
1104
|
-
*
|
|
1105
1074
|
* This interface was referenced by `SearchResult`'s JSON-Schema
|
|
1106
1075
|
* via the `definition` "type".
|
|
1107
1076
|
*/
|
|
@@ -1155,8 +1124,6 @@ export type SearchResultInstancesHrefSchema = {
|
|
|
1155
1124
|
[k: string]: unknown;
|
|
1156
1125
|
};
|
|
1157
1126
|
/**
|
|
1158
|
-
* JSON API type field
|
|
1159
|
-
*
|
|
1160
1127
|
* This interface was referenced by `Environment`'s JSON-Schema
|
|
1161
1128
|
* via the `definition` "type".
|
|
1162
1129
|
*/
|
|
@@ -1206,8 +1173,6 @@ export type EnvironmentDestroyTargetSchema = Job | Environment;
|
|
|
1206
1173
|
*/
|
|
1207
1174
|
export type MaintenanceModeIdentity = string;
|
|
1208
1175
|
/**
|
|
1209
|
-
* JSON API type field
|
|
1210
|
-
*
|
|
1211
1176
|
* This interface was referenced by `MaintenanceMode`'s JSON-Schema
|
|
1212
1177
|
* via the `definition` "type".
|
|
1213
1178
|
*/
|
|
@@ -1234,8 +1199,6 @@ export type MaintenanceModeActivateHrefSchema = {
|
|
|
1234
1199
|
*/
|
|
1235
1200
|
export type WebhookIdentity = string;
|
|
1236
1201
|
/**
|
|
1237
|
-
* JSON API type field
|
|
1238
|
-
*
|
|
1239
1202
|
* This interface was referenced by `Webhook`'s JSON-Schema
|
|
1240
1203
|
* via the `definition` "type".
|
|
1241
1204
|
*/
|
|
@@ -1256,8 +1219,6 @@ export type WebhookInstancesTargetSchema = Webhook[];
|
|
|
1256
1219
|
*/
|
|
1257
1220
|
export type WebhookCallIdentity = string;
|
|
1258
1221
|
/**
|
|
1259
|
-
* JSON API type field
|
|
1260
|
-
*
|
|
1261
1222
|
* This interface was referenced by `WebhookCall`'s JSON-Schema
|
|
1262
1223
|
* via the `definition` "type".
|
|
1263
1224
|
*/
|
|
@@ -1309,8 +1270,6 @@ export type ItemTypeFilterInstancesTargetSchema = ItemTypeFilter[];
|
|
|
1309
1270
|
*/
|
|
1310
1271
|
export type UploadFilterIdentity = string;
|
|
1311
1272
|
/**
|
|
1312
|
-
* JSON API type field
|
|
1313
|
-
*
|
|
1314
1273
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
1315
1274
|
* via the `definition` "type".
|
|
1316
1275
|
*/
|
|
@@ -1331,8 +1290,6 @@ export type UploadFilterInstancesTargetSchema = UploadFilter[];
|
|
|
1331
1290
|
*/
|
|
1332
1291
|
export type SiteInvitationIdentity = string;
|
|
1333
1292
|
/**
|
|
1334
|
-
* JSON API type field
|
|
1335
|
-
*
|
|
1336
1293
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
1337
1294
|
* via the `definition` "type".
|
|
1338
1295
|
*/
|
|
@@ -1353,8 +1310,6 @@ export type SiteInvitationInstancesTargetSchema = SiteInvitation[];
|
|
|
1353
1310
|
*/
|
|
1354
1311
|
export type EditingSessionIdentity = string;
|
|
1355
1312
|
/**
|
|
1356
|
-
* JSON API type field
|
|
1357
|
-
*
|
|
1358
1313
|
* This interface was referenced by `EditingSession`'s JSON-Schema
|
|
1359
1314
|
* via the `definition` "type".
|
|
1360
1315
|
*/
|
|
@@ -1418,8 +1373,6 @@ export type EditingSessionUpdateTargetSchema =
|
|
|
1418
1373
|
*/
|
|
1419
1374
|
export type FormDataIdentity = 'form_data';
|
|
1420
1375
|
/**
|
|
1421
|
-
* JSON API type field
|
|
1422
|
-
*
|
|
1423
1376
|
* This interface was referenced by `FormData`'s JSON-Schema
|
|
1424
1377
|
* via the `definition` "type".
|
|
1425
1378
|
*/
|
|
@@ -1440,8 +1393,6 @@ export type SsoGroupInstancesTargetSchema = SsoGroup[];
|
|
|
1440
1393
|
*/
|
|
1441
1394
|
export type SsoSettingsIdentity = string;
|
|
1442
1395
|
/**
|
|
1443
|
-
* JSON API type field
|
|
1444
|
-
*
|
|
1445
1396
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
1446
1397
|
* via the `definition` "type".
|
|
1447
1398
|
*/
|
|
@@ -1457,8 +1408,6 @@ export type SsoSettingsType = 'sso_settings';
|
|
|
1457
1408
|
*/
|
|
1458
1409
|
export type WhiteLabelSettingsIdentity = string;
|
|
1459
1410
|
/**
|
|
1460
|
-
* JSON API type field
|
|
1461
|
-
*
|
|
1462
1411
|
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema
|
|
1463
1412
|
* via the `definition` "type".
|
|
1464
1413
|
*/
|
|
@@ -1474,8 +1423,6 @@ export type WhiteLabelSettingsType = 'white_label_settings';
|
|
|
1474
1423
|
*/
|
|
1475
1424
|
export type PublicInfoIdentity = string;
|
|
1476
1425
|
/**
|
|
1477
|
-
* JSON API type field
|
|
1478
|
-
*
|
|
1479
1426
|
* This interface was referenced by `PublicInfo`'s JSON-Schema
|
|
1480
1427
|
* via the `definition` "type".
|
|
1481
1428
|
*/
|
|
@@ -1491,8 +1438,6 @@ export type PublicInfoType = 'public_info';
|
|
|
1491
1438
|
*/
|
|
1492
1439
|
export type DailyUsageIdentity = string;
|
|
1493
1440
|
/**
|
|
1494
|
-
* JSON API type field
|
|
1495
|
-
*
|
|
1496
1441
|
* This interface was referenced by `DailyUsage`'s JSON-Schema
|
|
1497
1442
|
* via the `definition` "type".
|
|
1498
1443
|
*/
|
|
@@ -1532,8 +1477,6 @@ export type UsageCounterIdentity =
|
|
|
1532
1477
|
| 'cma_ip_requests'
|
|
1533
1478
|
| 'video_path_seconds';
|
|
1534
1479
|
/**
|
|
1535
|
-
* JSON API type field
|
|
1536
|
-
*
|
|
1537
1480
|
* This interface was referenced by `UsageCounter`'s JSON-Schema
|
|
1538
1481
|
* via the `definition` "type".
|
|
1539
1482
|
*/
|
|
@@ -1559,8 +1502,6 @@ export type UsageCounterSelfHrefSchema = {
|
|
|
1559
1502
|
*/
|
|
1560
1503
|
export type UploadTagIdentity = string;
|
|
1561
1504
|
/**
|
|
1562
|
-
* JSON API type field
|
|
1563
|
-
*
|
|
1564
1505
|
* This interface was referenced by `UploadTag`'s JSON-Schema
|
|
1565
1506
|
* via the `definition` "type".
|
|
1566
1507
|
*/
|
|
@@ -1612,8 +1553,6 @@ export type UploadTagInstancesHrefSchema = {
|
|
|
1612
1553
|
*/
|
|
1613
1554
|
export type UploadSmartTagIdentity = string;
|
|
1614
1555
|
/**
|
|
1615
|
-
* JSON API type field
|
|
1616
|
-
*
|
|
1617
1556
|
* This interface was referenced by `UploadSmartTag`'s JSON-Schema
|
|
1618
1557
|
* via the `definition` "type".
|
|
1619
1558
|
*/
|
|
@@ -1665,8 +1604,6 @@ export type UploadSmartTagInstancesHrefSchema = {
|
|
|
1665
1604
|
*/
|
|
1666
1605
|
export type SiteIdentity = string;
|
|
1667
1606
|
/**
|
|
1668
|
-
* JSON API type field
|
|
1669
|
-
*
|
|
1670
1607
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
1671
1608
|
* via the `definition` "type".
|
|
1672
1609
|
*/
|
|
@@ -1697,6 +1634,7 @@ export type DatoApi = {
|
|
|
1697
1634
|
organization?: Organization;
|
|
1698
1635
|
site_plan?: SitePlan;
|
|
1699
1636
|
menu_item?: MenuItem;
|
|
1637
|
+
schema_menu_item?: SchemaMenuItem;
|
|
1700
1638
|
item_type?: ItemType;
|
|
1701
1639
|
field?: Field;
|
|
1702
1640
|
fieldset?: Fieldset;
|
|
@@ -3542,9 +3480,6 @@ export type AuditLogEventAttributes = {
|
|
|
3542
3480
|
* via the `query.schema` link.
|
|
3543
3481
|
*/
|
|
3544
3482
|
export type AuditLogEventQuerySchema = {
|
|
3545
|
-
/**
|
|
3546
|
-
* JSON API type field
|
|
3547
|
-
*/
|
|
3548
3483
|
type?: 'audit_log_query';
|
|
3549
3484
|
/**
|
|
3550
3485
|
* An SQL-like expression to filter the events
|
|
@@ -4219,6 +4154,126 @@ export type MenuItemUpdateSchema = {
|
|
|
4219
4154
|
parent?: null | MenuItemData;
|
|
4220
4155
|
};
|
|
4221
4156
|
|
|
4157
|
+
/**
|
|
4158
|
+
* 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.
|
|
4159
|
+
*
|
|
4160
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
4161
|
+
* via the `definition` "schema_menu_item".
|
|
4162
|
+
*/
|
|
4163
|
+
export type SchemaMenuItem = {
|
|
4164
|
+
id: SchemaMenuItemIdentity;
|
|
4165
|
+
type: SchemaMenuItemType;
|
|
4166
|
+
/**
|
|
4167
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
4168
|
+
*/
|
|
4169
|
+
label: null | string;
|
|
4170
|
+
/**
|
|
4171
|
+
* Ordering index
|
|
4172
|
+
*/
|
|
4173
|
+
position: number;
|
|
4174
|
+
/**
|
|
4175
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
4176
|
+
*/
|
|
4177
|
+
kind: 'item_type' | 'modular_block';
|
|
4178
|
+
item_type: ItemTypeData | null;
|
|
4179
|
+
parent: null | SchemaMenuItemData;
|
|
4180
|
+
children: SchemaMenuItemData[];
|
|
4181
|
+
};
|
|
4182
|
+
export type SchemaMenuItemCreateTargetSchema = SchemaMenuItem;
|
|
4183
|
+
export type SchemaMenuItemUpdateTargetSchema = SchemaMenuItem;
|
|
4184
|
+
export type SchemaMenuItemSelfTargetSchema = SchemaMenuItem;
|
|
4185
|
+
export type SchemaMenuItemDestroyTargetSchema = SchemaMenuItem;
|
|
4186
|
+
/**
|
|
4187
|
+
* JSON API data
|
|
4188
|
+
*
|
|
4189
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
4190
|
+
* via the `definition` "data".
|
|
4191
|
+
*/
|
|
4192
|
+
export type SchemaMenuItemData = {
|
|
4193
|
+
type: SchemaMenuItemType;
|
|
4194
|
+
id: SchemaMenuItemIdentity;
|
|
4195
|
+
};
|
|
4196
|
+
|
|
4197
|
+
/**
|
|
4198
|
+
* JSON API attributes
|
|
4199
|
+
*
|
|
4200
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
4201
|
+
* via the `definition` "attributes".
|
|
4202
|
+
*/
|
|
4203
|
+
export type SchemaMenuItemAttributes = {
|
|
4204
|
+
/**
|
|
4205
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
4206
|
+
*/
|
|
4207
|
+
label: null | string;
|
|
4208
|
+
/**
|
|
4209
|
+
* Ordering index
|
|
4210
|
+
*/
|
|
4211
|
+
position: number;
|
|
4212
|
+
/**
|
|
4213
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
4214
|
+
*/
|
|
4215
|
+
kind: 'item_type' | 'modular_block';
|
|
4216
|
+
};
|
|
4217
|
+
|
|
4218
|
+
/**
|
|
4219
|
+
* JSON API links
|
|
4220
|
+
*
|
|
4221
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
4222
|
+
* via the `definition` "relationships".
|
|
4223
|
+
*/
|
|
4224
|
+
export type SchemaMenuItemRelationships = {
|
|
4225
|
+
item_type: ItemTypeData | null;
|
|
4226
|
+
parent: null | SchemaMenuItemData;
|
|
4227
|
+
children: SchemaMenuItemData[];
|
|
4228
|
+
};
|
|
4229
|
+
|
|
4230
|
+
/**
|
|
4231
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
4232
|
+
* via the `create.schema` link.
|
|
4233
|
+
*/
|
|
4234
|
+
export type SchemaMenuItemCreateSchema = {
|
|
4235
|
+
id?: SchemaMenuItemIdentity;
|
|
4236
|
+
type?: SchemaMenuItemType;
|
|
4237
|
+
/**
|
|
4238
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
4239
|
+
*/
|
|
4240
|
+
label: null | string;
|
|
4241
|
+
/**
|
|
4242
|
+
* Ordering index
|
|
4243
|
+
*/
|
|
4244
|
+
position?: number;
|
|
4245
|
+
/**
|
|
4246
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
4247
|
+
*/
|
|
4248
|
+
kind: 'item_type' | 'modular_block';
|
|
4249
|
+
item_type?: ItemTypeData | null;
|
|
4250
|
+
parent?: null | SchemaMenuItemData;
|
|
4251
|
+
};
|
|
4252
|
+
|
|
4253
|
+
/**
|
|
4254
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
4255
|
+
* via the `update.schema` link.
|
|
4256
|
+
*/
|
|
4257
|
+
export type SchemaMenuItemUpdateSchema = {
|
|
4258
|
+
id?: SchemaMenuItemIdentity;
|
|
4259
|
+
type?: SchemaMenuItemType;
|
|
4260
|
+
/**
|
|
4261
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
4262
|
+
*/
|
|
4263
|
+
label?: null | string;
|
|
4264
|
+
/**
|
|
4265
|
+
* Ordering index
|
|
4266
|
+
*/
|
|
4267
|
+
position?: number;
|
|
4268
|
+
/**
|
|
4269
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
4270
|
+
*/
|
|
4271
|
+
kind?: 'item_type' | 'modular_block';
|
|
4272
|
+
item_type?: ItemTypeData | null;
|
|
4273
|
+
parent?: null | SchemaMenuItemData;
|
|
4274
|
+
children?: SchemaMenuItemData[];
|
|
4275
|
+
};
|
|
4276
|
+
|
|
4222
4277
|
/**
|
|
4223
4278
|
* 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".
|
|
4224
4279
|
*
|
|
@@ -5554,6 +5609,18 @@ export type JobData = {
|
|
|
5554
5609
|
* </details>
|
|
5555
5610
|
*
|
|
5556
5611
|
* <details>
|
|
5612
|
+
* <summary><code>seo</code></summary>
|
|
5613
|
+
*
|
|
5614
|
+
* Built-in editor for _seo_ fields.
|
|
5615
|
+
*
|
|
5616
|
+
* | Parameter | Type | Required | Description |
|
|
5617
|
+
* | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5618
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5619
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"` |
|
|
5620
|
+
*
|
|
5621
|
+
* </details>
|
|
5622
|
+
*
|
|
5623
|
+
* <details>
|
|
5557
5624
|
* <summary><code>rich_text</code></summary>
|
|
5558
5625
|
*
|
|
5559
5626
|
* Built-in editor for _Modular content_ fields.
|
|
@@ -6263,9 +6330,6 @@ export type SessionRelationships = {
|
|
|
6263
6330
|
* via the `create.schema` link.
|
|
6264
6331
|
*/
|
|
6265
6332
|
export type SessionCreateSchema = {
|
|
6266
|
-
/**
|
|
6267
|
-
* JSON API type field
|
|
6268
|
-
*/
|
|
6269
6333
|
type?: 'email_credentials';
|
|
6270
6334
|
/**
|
|
6271
6335
|
* Email
|
|
@@ -7211,9 +7275,6 @@ export type ItemCurrentVsPublishedStateRelationships = {
|
|
|
7211
7275
|
* via the `bulk_publish.schema` link.
|
|
7212
7276
|
*/
|
|
7213
7277
|
export type ItemBulkPublishSchema = {
|
|
7214
|
-
/**
|
|
7215
|
-
* JSON API type field
|
|
7216
|
-
*/
|
|
7217
7278
|
type?: 'item_bulk_publish_operation';
|
|
7218
7279
|
items: ItemData[];
|
|
7219
7280
|
minItems?: unknown;
|
|
@@ -7225,9 +7286,6 @@ export type ItemBulkPublishSchema = {
|
|
|
7225
7286
|
* via the `bulk_unpublish.schema` link.
|
|
7226
7287
|
*/
|
|
7227
7288
|
export type ItemBulkUnpublishSchema = {
|
|
7228
|
-
/**
|
|
7229
|
-
* JSON API type field
|
|
7230
|
-
*/
|
|
7231
7289
|
type?: 'item_bulk_unpublish_operation';
|
|
7232
7290
|
items: ItemData[];
|
|
7233
7291
|
minItems?: unknown;
|
|
@@ -7239,9 +7297,6 @@ export type ItemBulkUnpublishSchema = {
|
|
|
7239
7297
|
* via the `bulk_destroy.schema` link.
|
|
7240
7298
|
*/
|
|
7241
7299
|
export type ItemBulkDestroySchema = {
|
|
7242
|
-
/**
|
|
7243
|
-
* JSON API type field
|
|
7244
|
-
*/
|
|
7245
7300
|
type?: 'item_bulk_destroy_operation';
|
|
7246
7301
|
items: ItemData[];
|
|
7247
7302
|
minItems?: unknown;
|
|
@@ -7253,9 +7308,6 @@ export type ItemBulkDestroySchema = {
|
|
|
7253
7308
|
* via the `bulk_move_to_stage.schema` link.
|
|
7254
7309
|
*/
|
|
7255
7310
|
export type ItemBulkMoveToStageSchema = {
|
|
7256
|
-
/**
|
|
7257
|
-
* JSON API type field
|
|
7258
|
-
*/
|
|
7259
7311
|
type?: 'item_bulk_move_to_stage_operation';
|
|
7260
7312
|
/**
|
|
7261
7313
|
* Stage to be moved to
|
|
@@ -7876,9 +7928,6 @@ export type UploadBatchAddTagsSchema = {
|
|
|
7876
7928
|
* via the `bulk_tag.schema` link.
|
|
7877
7929
|
*/
|
|
7878
7930
|
export type UploadBulkTagSchema = {
|
|
7879
|
-
/**
|
|
7880
|
-
* JSON API type field
|
|
7881
|
-
*/
|
|
7882
7931
|
type?: 'upload_bulk_tag_operation';
|
|
7883
7932
|
/**
|
|
7884
7933
|
* The tags to add to the assets
|
|
@@ -7892,9 +7941,6 @@ export type UploadBulkTagSchema = {
|
|
|
7892
7941
|
* via the `bulk_destroy.schema` link.
|
|
7893
7942
|
*/
|
|
7894
7943
|
export type UploadBulkDestroySchema = {
|
|
7895
|
-
/**
|
|
7896
|
-
* JSON API type field
|
|
7897
|
-
*/
|
|
7898
7944
|
type?: 'upload_bulk_destroy_operation';
|
|
7899
7945
|
uploads: UploadData[];
|
|
7900
7946
|
[k: string]: unknown;
|
|
@@ -9562,9 +9608,6 @@ export type SsoSettingsRelationships = {
|
|
|
9562
9608
|
*/
|
|
9563
9609
|
export type SsoSettingsGenerateTokenTargetSchema = {
|
|
9564
9610
|
id: SsoSettingsIdentity;
|
|
9565
|
-
/**
|
|
9566
|
-
* JSON API type field
|
|
9567
|
-
*/
|
|
9568
9611
|
type: 'sso_token';
|
|
9569
9612
|
attributes: {
|
|
9570
9613
|
/**
|
|
@@ -9679,35 +9722,31 @@ export type PublicInfo = {
|
|
|
9679
9722
|
* Specifies the color-scheme for the project
|
|
9680
9723
|
*/
|
|
9681
9724
|
theme: {
|
|
9682
|
-
primary_color
|
|
9725
|
+
primary_color: {
|
|
9683
9726
|
red: number;
|
|
9684
9727
|
green: number;
|
|
9685
9728
|
blue: number;
|
|
9686
9729
|
alpha: number;
|
|
9687
9730
|
[k: string]: unknown;
|
|
9688
9731
|
};
|
|
9689
|
-
light_color
|
|
9732
|
+
light_color: {
|
|
9690
9733
|
red: number;
|
|
9691
9734
|
green: number;
|
|
9692
9735
|
blue: number;
|
|
9693
9736
|
alpha: number;
|
|
9694
|
-
[k: string]: unknown;
|
|
9695
9737
|
};
|
|
9696
|
-
accent_color
|
|
9738
|
+
accent_color: {
|
|
9697
9739
|
red: number;
|
|
9698
9740
|
green: number;
|
|
9699
9741
|
blue: number;
|
|
9700
9742
|
alpha: number;
|
|
9701
|
-
[k: string]: unknown;
|
|
9702
9743
|
};
|
|
9703
|
-
dark_color
|
|
9744
|
+
dark_color: {
|
|
9704
9745
|
red: number;
|
|
9705
9746
|
green: number;
|
|
9706
9747
|
blue: number;
|
|
9707
9748
|
alpha: number;
|
|
9708
|
-
[k: string]: unknown;
|
|
9709
9749
|
};
|
|
9710
|
-
[k: string]: unknown;
|
|
9711
9750
|
};
|
|
9712
9751
|
/**
|
|
9713
9752
|
* Additional information (only returned on authenticated requests)
|
|
@@ -9762,35 +9801,31 @@ export type PublicInfoAttributes = {
|
|
|
9762
9801
|
* Specifies the color-scheme for the project
|
|
9763
9802
|
*/
|
|
9764
9803
|
theme: {
|
|
9765
|
-
primary_color
|
|
9804
|
+
primary_color: {
|
|
9766
9805
|
red: number;
|
|
9767
9806
|
green: number;
|
|
9768
9807
|
blue: number;
|
|
9769
9808
|
alpha: number;
|
|
9770
9809
|
[k: string]: unknown;
|
|
9771
9810
|
};
|
|
9772
|
-
light_color
|
|
9811
|
+
light_color: {
|
|
9773
9812
|
red: number;
|
|
9774
9813
|
green: number;
|
|
9775
9814
|
blue: number;
|
|
9776
9815
|
alpha: number;
|
|
9777
|
-
[k: string]: unknown;
|
|
9778
9816
|
};
|
|
9779
|
-
accent_color
|
|
9817
|
+
accent_color: {
|
|
9780
9818
|
red: number;
|
|
9781
9819
|
green: number;
|
|
9782
9820
|
blue: number;
|
|
9783
9821
|
alpha: number;
|
|
9784
|
-
[k: string]: unknown;
|
|
9785
9822
|
};
|
|
9786
|
-
dark_color
|
|
9823
|
+
dark_color: {
|
|
9787
9824
|
red: number;
|
|
9788
9825
|
green: number;
|
|
9789
9826
|
blue: number;
|
|
9790
9827
|
alpha: number;
|
|
9791
|
-
[k: string]: unknown;
|
|
9792
9828
|
};
|
|
9793
|
-
[k: string]: unknown;
|
|
9794
9829
|
};
|
|
9795
9830
|
/**
|
|
9796
9831
|
* Additional information (only returned on authenticated requests)
|
|
@@ -10088,39 +10123,42 @@ export type Site = {
|
|
|
10088
10123
|
* Specifies the theme to use in administrative area
|
|
10089
10124
|
*/
|
|
10090
10125
|
theme: {
|
|
10126
|
+
/**
|
|
10127
|
+
* 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
|
|
10128
|
+
*/
|
|
10129
|
+
type: 'custom' | 'monochromatic';
|
|
10130
|
+
/**
|
|
10131
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
10132
|
+
*/
|
|
10133
|
+
hue: number | null;
|
|
10091
10134
|
primary_color: {
|
|
10092
10135
|
red: number;
|
|
10093
10136
|
green: number;
|
|
10094
10137
|
blue: number;
|
|
10095
10138
|
alpha: number;
|
|
10096
|
-
[k: string]: unknown;
|
|
10097
10139
|
};
|
|
10098
10140
|
light_color: {
|
|
10099
10141
|
red: number;
|
|
10100
10142
|
green: number;
|
|
10101
10143
|
blue: number;
|
|
10102
10144
|
alpha: number;
|
|
10103
|
-
[k: string]: unknown;
|
|
10104
10145
|
};
|
|
10105
10146
|
accent_color: {
|
|
10106
10147
|
red: number;
|
|
10107
10148
|
green: number;
|
|
10108
10149
|
blue: number;
|
|
10109
10150
|
alpha: number;
|
|
10110
|
-
[k: string]: unknown;
|
|
10111
10151
|
};
|
|
10112
10152
|
dark_color: {
|
|
10113
10153
|
red: number;
|
|
10114
10154
|
green: number;
|
|
10115
10155
|
blue: number;
|
|
10116
10156
|
alpha: number;
|
|
10117
|
-
[k: string]: unknown;
|
|
10118
10157
|
};
|
|
10119
10158
|
/**
|
|
10120
|
-
* The
|
|
10159
|
+
* The upload ID that is used as the logo for the project
|
|
10121
10160
|
*/
|
|
10122
10161
|
logo: string | null;
|
|
10123
|
-
[k: string]: unknown;
|
|
10124
10162
|
};
|
|
10125
10163
|
/**
|
|
10126
10164
|
* Specifies default global settings
|
|
@@ -10170,6 +10208,8 @@ export type SiteUpdateJobSchema = Site;
|
|
|
10170
10208
|
export type SiteActivateImprovedTimezoneManagementJobSchema = Site;
|
|
10171
10209
|
export type SiteActivateImprovedHexManagementTargetSchema = Site;
|
|
10172
10210
|
export type SiteActivateImprovedGqlMultilocaleFieldsTargetSchema = Site;
|
|
10211
|
+
export type SiteActivateImprovedGqlVisibilityControlTargetSchema = Site;
|
|
10212
|
+
export type SiteActivateImprovedBooleanFieldsTargetSchema = Site;
|
|
10173
10213
|
/**
|
|
10174
10214
|
* Meta attributes
|
|
10175
10215
|
*
|
|
@@ -10189,6 +10229,14 @@ export type SiteMeta = {
|
|
|
10189
10229
|
* Whether the Improved GraphQL multi-locale fields option is active or not
|
|
10190
10230
|
*/
|
|
10191
10231
|
improved_gql_multilocale_fields: boolean;
|
|
10232
|
+
/**
|
|
10233
|
+
* Whether the Improved GraphQL visibility control option is active or not
|
|
10234
|
+
*/
|
|
10235
|
+
improved_gql_visibility_control: boolean;
|
|
10236
|
+
/**
|
|
10237
|
+
* Whether the Improved boolean fields option is active or not
|
|
10238
|
+
*/
|
|
10239
|
+
improved_boolean_fields: boolean;
|
|
10192
10240
|
};
|
|
10193
10241
|
|
|
10194
10242
|
/**
|
|
@@ -10265,39 +10313,42 @@ export type SiteAttributes = {
|
|
|
10265
10313
|
* Specifies the theme to use in administrative area
|
|
10266
10314
|
*/
|
|
10267
10315
|
theme: {
|
|
10316
|
+
/**
|
|
10317
|
+
* 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
|
|
10318
|
+
*/
|
|
10319
|
+
type: 'custom' | 'monochromatic';
|
|
10320
|
+
/**
|
|
10321
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
10322
|
+
*/
|
|
10323
|
+
hue: number | null;
|
|
10268
10324
|
primary_color: {
|
|
10269
10325
|
red: number;
|
|
10270
10326
|
green: number;
|
|
10271
10327
|
blue: number;
|
|
10272
10328
|
alpha: number;
|
|
10273
|
-
[k: string]: unknown;
|
|
10274
10329
|
};
|
|
10275
10330
|
light_color: {
|
|
10276
10331
|
red: number;
|
|
10277
10332
|
green: number;
|
|
10278
10333
|
blue: number;
|
|
10279
10334
|
alpha: number;
|
|
10280
|
-
[k: string]: unknown;
|
|
10281
10335
|
};
|
|
10282
10336
|
accent_color: {
|
|
10283
10337
|
red: number;
|
|
10284
10338
|
green: number;
|
|
10285
10339
|
blue: number;
|
|
10286
10340
|
alpha: number;
|
|
10287
|
-
[k: string]: unknown;
|
|
10288
10341
|
};
|
|
10289
10342
|
dark_color: {
|
|
10290
10343
|
red: number;
|
|
10291
10344
|
green: number;
|
|
10292
10345
|
blue: number;
|
|
10293
10346
|
alpha: number;
|
|
10294
|
-
[k: string]: unknown;
|
|
10295
10347
|
};
|
|
10296
10348
|
/**
|
|
10297
|
-
* The
|
|
10349
|
+
* The upload ID that is used as the logo for the project
|
|
10298
10350
|
*/
|
|
10299
10351
|
logo: string | null;
|
|
10300
|
-
[k: string]: unknown;
|
|
10301
10352
|
};
|
|
10302
10353
|
/**
|
|
10303
10354
|
* Specifies default global settings
|
|
@@ -10405,44 +10456,57 @@ export type SiteUpdateSchema = {
|
|
|
10405
10456
|
* Site name
|
|
10406
10457
|
*/
|
|
10407
10458
|
name?: string;
|
|
10408
|
-
|
|
10409
|
-
|
|
10410
|
-
|
|
10411
|
-
|
|
10412
|
-
|
|
10413
|
-
|
|
10414
|
-
|
|
10415
|
-
|
|
10416
|
-
|
|
10417
|
-
|
|
10418
|
-
|
|
10419
|
-
|
|
10420
|
-
|
|
10421
|
-
|
|
10422
|
-
|
|
10423
|
-
|
|
10424
|
-
|
|
10425
|
-
|
|
10426
|
-
|
|
10427
|
-
|
|
10428
|
-
|
|
10429
|
-
|
|
10430
|
-
|
|
10431
|
-
|
|
10432
|
-
|
|
10433
|
-
|
|
10434
|
-
|
|
10435
|
-
|
|
10436
|
-
|
|
10437
|
-
|
|
10438
|
-
|
|
10439
|
-
|
|
10440
|
-
|
|
10441
|
-
|
|
10442
|
-
|
|
10443
|
-
|
|
10444
|
-
|
|
10445
|
-
|
|
10459
|
+
theme?:
|
|
10460
|
+
| {
|
|
10461
|
+
/**
|
|
10462
|
+
* Type of theme color palette
|
|
10463
|
+
*/
|
|
10464
|
+
type: 'monochromatic';
|
|
10465
|
+
/**
|
|
10466
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
10467
|
+
*/
|
|
10468
|
+
hue: number | null;
|
|
10469
|
+
/**
|
|
10470
|
+
* The upload ID that is used as the logo for the project
|
|
10471
|
+
*/
|
|
10472
|
+
logo: string | null;
|
|
10473
|
+
[k: string]: unknown;
|
|
10474
|
+
}
|
|
10475
|
+
| {
|
|
10476
|
+
/**
|
|
10477
|
+
* Type of theme color palette
|
|
10478
|
+
*/
|
|
10479
|
+
type?: 'custom';
|
|
10480
|
+
/**
|
|
10481
|
+
* The upload ID that is used as the logo for the project
|
|
10482
|
+
*/
|
|
10483
|
+
logo: string | null;
|
|
10484
|
+
primary_color: {
|
|
10485
|
+
red: number;
|
|
10486
|
+
green: number;
|
|
10487
|
+
blue: number;
|
|
10488
|
+
alpha: number;
|
|
10489
|
+
};
|
|
10490
|
+
light_color: {
|
|
10491
|
+
red: number;
|
|
10492
|
+
green: number;
|
|
10493
|
+
blue: number;
|
|
10494
|
+
alpha: number;
|
|
10495
|
+
};
|
|
10496
|
+
accent_color: {
|
|
10497
|
+
red: number;
|
|
10498
|
+
green: number;
|
|
10499
|
+
blue: number;
|
|
10500
|
+
alpha: number;
|
|
10501
|
+
};
|
|
10502
|
+
dark_color?: {
|
|
10503
|
+
red: number;
|
|
10504
|
+
green: number;
|
|
10505
|
+
blue: number;
|
|
10506
|
+
alpha: number;
|
|
10507
|
+
};
|
|
10508
|
+
[k: string]: unknown;
|
|
10509
|
+
};
|
|
10446
10510
|
/**
|
|
10447
10511
|
* Available locales
|
|
10448
10512
|
*/
|
|
@@ -10477,6 +10541,14 @@ export type SiteUpdateSchema = {
|
|
|
10477
10541
|
* Whether the Improved GraphQL multi-locale fields option is active or not
|
|
10478
10542
|
*/
|
|
10479
10543
|
improved_gql_multilocale_fields?: boolean;
|
|
10544
|
+
/**
|
|
10545
|
+
* Whether the Improved GraphQL visibility control option is active or not
|
|
10546
|
+
*/
|
|
10547
|
+
improved_gql_visibility_control?: boolean;
|
|
10548
|
+
/**
|
|
10549
|
+
* Whether the Improved boolean fields option is active or not
|
|
10550
|
+
*/
|
|
10551
|
+
improved_boolean_fields?: boolean;
|
|
10480
10552
|
};
|
|
10481
10553
|
};
|
|
10482
10554
|
|