@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
|
@@ -12,8 +12,6 @@
|
|
|
12
12
|
*/
|
|
13
13
|
export declare type RoleIdentity = string;
|
|
14
14
|
/**
|
|
15
|
-
* JSON API type field
|
|
16
|
-
*
|
|
17
15
|
* This interface was referenced by `Role`'s JSON-Schema
|
|
18
16
|
* via the `definition` "type".
|
|
19
17
|
*/
|
|
@@ -74,8 +72,6 @@ export declare type RoleInstancesTargetSchema = Role[];
|
|
|
74
72
|
*/
|
|
75
73
|
export declare type UserIdentity = string;
|
|
76
74
|
/**
|
|
77
|
-
* JSON API type field
|
|
78
|
-
*
|
|
79
75
|
* This interface was referenced by `User`'s JSON-Schema
|
|
80
76
|
* via the `definition` "type".
|
|
81
77
|
*/
|
|
@@ -112,15 +108,11 @@ export declare type UserMeTargetSchema = User | SsoUser | AccessToken | Account;
|
|
|
112
108
|
*/
|
|
113
109
|
export declare type SsoUserIdentity = string;
|
|
114
110
|
/**
|
|
115
|
-
* JSON API type field
|
|
116
|
-
*
|
|
117
111
|
* This interface was referenced by `SsoUser`'s JSON-Schema
|
|
118
112
|
* via the `definition` "type".
|
|
119
113
|
*/
|
|
120
114
|
export declare type SsoUserType = 'sso_user';
|
|
121
115
|
/**
|
|
122
|
-
* JSON API type field
|
|
123
|
-
*
|
|
124
116
|
* This interface was referenced by `SsoGroup`'s JSON-Schema
|
|
125
117
|
* via the `definition` "type".
|
|
126
118
|
*/
|
|
@@ -171,8 +163,6 @@ export declare type SsoUserDestroyHrefSchema = {
|
|
|
171
163
|
*/
|
|
172
164
|
export declare type AccessTokenIdentity = string;
|
|
173
165
|
/**
|
|
174
|
-
* JSON API type field
|
|
175
|
-
*
|
|
176
166
|
* This interface was referenced by `AccessToken`'s JSON-Schema
|
|
177
167
|
* via the `definition` "type".
|
|
178
168
|
*/
|
|
@@ -208,8 +198,6 @@ export declare type AccessTokenDestroyHrefSchema = {
|
|
|
208
198
|
*/
|
|
209
199
|
export declare type AccountIdentity = string;
|
|
210
200
|
/**
|
|
211
|
-
* JSON API type field
|
|
212
|
-
*
|
|
213
201
|
* This interface was referenced by `Account`'s JSON-Schema
|
|
214
202
|
* via the `definition` "type".
|
|
215
203
|
*/
|
|
@@ -251,8 +239,6 @@ export declare type UserDestroyHrefSchema = {
|
|
|
251
239
|
*/
|
|
252
240
|
export declare type AuditLogEventIdentity = string;
|
|
253
241
|
/**
|
|
254
|
-
* JSON API type field
|
|
255
|
-
*
|
|
256
242
|
* This interface was referenced by `AuditLogEvent`'s JSON-Schema
|
|
257
243
|
* via the `definition` "type".
|
|
258
244
|
*/
|
|
@@ -273,8 +259,6 @@ export declare type AuditLogEventQueryTargetSchema = AuditLogEvent[];
|
|
|
273
259
|
*/
|
|
274
260
|
export declare type OrganizationIdentity = string;
|
|
275
261
|
/**
|
|
276
|
-
* JSON API type field
|
|
277
|
-
*
|
|
278
262
|
* This interface was referenced by `Organization`'s JSON-Schema
|
|
279
263
|
* via the `definition` "type".
|
|
280
264
|
*/
|
|
@@ -290,8 +274,6 @@ export declare type OrganizationType = 'organization';
|
|
|
290
274
|
*/
|
|
291
275
|
export declare type SitePlanIdentity = string;
|
|
292
276
|
/**
|
|
293
|
-
* JSON API type field
|
|
294
|
-
*
|
|
295
277
|
* This interface was referenced by `SitePlan`'s JSON-Schema
|
|
296
278
|
* via the `definition` "type".
|
|
297
279
|
*/
|
|
@@ -307,22 +289,16 @@ export declare type SitePlanType = 'site_plan';
|
|
|
307
289
|
*/
|
|
308
290
|
export declare type MenuItemIdentity = string;
|
|
309
291
|
/**
|
|
310
|
-
* JSON API type field
|
|
311
|
-
*
|
|
312
292
|
* This interface was referenced by `MenuItem`'s JSON-Schema
|
|
313
293
|
* via the `definition` "type".
|
|
314
294
|
*/
|
|
315
295
|
export declare type MenuItemType = 'menu_item';
|
|
316
296
|
/**
|
|
317
|
-
* JSON API type field
|
|
318
|
-
*
|
|
319
297
|
* This interface was referenced by `ItemType`'s JSON-Schema
|
|
320
298
|
* via the `definition` "type".
|
|
321
299
|
*/
|
|
322
300
|
export declare type ItemTypeType = 'item_type';
|
|
323
301
|
/**
|
|
324
|
-
* JSON API type field
|
|
325
|
-
*
|
|
326
302
|
* This interface was referenced by `ItemTypeFilter`'s JSON-Schema
|
|
327
303
|
* via the `definition` "type".
|
|
328
304
|
*/
|
|
@@ -354,9 +330,41 @@ export declare type MenuItemInstancesHrefSchema = {
|
|
|
354
330
|
ids: string;
|
|
355
331
|
};
|
|
356
332
|
};
|
|
333
|
+
/**
|
|
334
|
+
* RFC 4122 UUID of schema menu item expressed in URL-safe base64 format
|
|
335
|
+
*
|
|
336
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
337
|
+
* via the `definition` "identity".
|
|
338
|
+
*
|
|
339
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
340
|
+
* via the `definition` "id".
|
|
341
|
+
*/
|
|
342
|
+
export declare type SchemaMenuItemIdentity = string;
|
|
357
343
|
/**
|
|
358
344
|
* JSON API type field
|
|
359
345
|
*
|
|
346
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
347
|
+
* via the `definition` "type".
|
|
348
|
+
*/
|
|
349
|
+
export declare type SchemaMenuItemType = 'schema_menu_item';
|
|
350
|
+
/**
|
|
351
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
352
|
+
* via the `instances.targetSchema` link.
|
|
353
|
+
*/
|
|
354
|
+
export declare type SchemaMenuItemInstancesTargetSchema = SchemaMenuItem[];
|
|
355
|
+
/**
|
|
356
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
357
|
+
* via the `instances.hrefSchema` link.
|
|
358
|
+
*/
|
|
359
|
+
export declare type SchemaMenuItemInstancesHrefSchema = {
|
|
360
|
+
filter?: {
|
|
361
|
+
/**
|
|
362
|
+
* IDs to fetch, comma separated
|
|
363
|
+
*/
|
|
364
|
+
ids: string;
|
|
365
|
+
};
|
|
366
|
+
};
|
|
367
|
+
/**
|
|
360
368
|
* This interface was referenced by `Item`'s JSON-Schema
|
|
361
369
|
* via the `definition` "type".
|
|
362
370
|
*/
|
|
@@ -372,8 +380,6 @@ export declare type ItemType1 = 'item';
|
|
|
372
380
|
*/
|
|
373
381
|
export declare type ItemIdentity = string;
|
|
374
382
|
/**
|
|
375
|
-
* JSON API type field
|
|
376
|
-
*
|
|
377
383
|
* This interface was referenced by `Field`'s JSON-Schema
|
|
378
384
|
* via the `definition` "type".
|
|
379
385
|
*/
|
|
@@ -389,8 +395,6 @@ export declare type FieldType = 'field';
|
|
|
389
395
|
*/
|
|
390
396
|
export declare type FieldIdentity = string;
|
|
391
397
|
/**
|
|
392
|
-
* JSON API type fieldset
|
|
393
|
-
*
|
|
394
398
|
* This interface was referenced by `Fieldset`'s JSON-Schema
|
|
395
399
|
* via the `definition` "type".
|
|
396
400
|
*/
|
|
@@ -406,8 +410,6 @@ export declare type FieldsetType = 'fieldset';
|
|
|
406
410
|
*/
|
|
407
411
|
export declare type FieldsetIdentity = string;
|
|
408
412
|
/**
|
|
409
|
-
* JSON API type field
|
|
410
|
-
*
|
|
411
413
|
* This interface was referenced by `Workflow`'s JSON-Schema
|
|
412
414
|
* via the `definition` "type".
|
|
413
415
|
*/
|
|
@@ -434,8 +436,6 @@ export declare type ItemTypeCreateHrefSchema = {
|
|
|
434
436
|
*/
|
|
435
437
|
export declare type JobIdentity = string;
|
|
436
438
|
/**
|
|
437
|
-
* JSON API type field
|
|
438
|
-
*
|
|
439
439
|
* This interface was referenced by `Job`'s JSON-Schema
|
|
440
440
|
* via the `definition` "type".
|
|
441
441
|
*/
|
|
@@ -487,8 +487,6 @@ export declare type FieldsetInstancesTargetSchema = Fieldset[];
|
|
|
487
487
|
*/
|
|
488
488
|
export declare type SessionIdentity = string;
|
|
489
489
|
/**
|
|
490
|
-
* JSON API type field
|
|
491
|
-
*
|
|
492
490
|
* This interface was referenced by `Session`'s JSON-Schema
|
|
493
491
|
* via the `definition` "type".
|
|
494
492
|
*/
|
|
@@ -504,8 +502,6 @@ export declare type SessionType = 'session';
|
|
|
504
502
|
*/
|
|
505
503
|
export declare type PluginIdentity = string;
|
|
506
504
|
/**
|
|
507
|
-
* JSON API type field
|
|
508
|
-
*
|
|
509
505
|
* This interface was referenced by `Plugin`'s JSON-Schema
|
|
510
506
|
* via the `definition` "type".
|
|
511
507
|
*/
|
|
@@ -531,8 +527,6 @@ export declare type PluginFieldsTargetSchema = Field[];
|
|
|
531
527
|
*/
|
|
532
528
|
export declare type JobResultIdentity = string;
|
|
533
529
|
/**
|
|
534
|
-
* JSON API type field
|
|
535
|
-
*
|
|
536
530
|
* This interface was referenced by `JobResult`'s JSON-Schema
|
|
537
531
|
* via the `definition` "type".
|
|
538
532
|
*/
|
|
@@ -548,8 +542,6 @@ export declare type JobResultType = 'job_result';
|
|
|
548
542
|
*/
|
|
549
543
|
export declare type SubscriptionLimitIdentity = string;
|
|
550
544
|
/**
|
|
551
|
-
* JSON API type field
|
|
552
|
-
*
|
|
553
545
|
* This interface was referenced by `SubscriptionLimit`'s JSON-Schema
|
|
554
546
|
* via the `definition` "type".
|
|
555
547
|
*/
|
|
@@ -570,8 +562,6 @@ export declare type SubscriptionLimitInstancesTargetSchema = SubscriptionLimit[]
|
|
|
570
562
|
*/
|
|
571
563
|
export declare type SubscriptionFeatureIdentity = string;
|
|
572
564
|
/**
|
|
573
|
-
* JSON API type field
|
|
574
|
-
*
|
|
575
565
|
* This interface was referenced by `SubscriptionFeature`'s JSON-Schema
|
|
576
566
|
* via the `definition` "type".
|
|
577
567
|
*/
|
|
@@ -592,15 +582,11 @@ export declare type SubscriptionFeatureInstancesTargetSchema = SubscriptionFeatu
|
|
|
592
582
|
*/
|
|
593
583
|
export declare type BuildEventIdentity = string;
|
|
594
584
|
/**
|
|
595
|
-
* JSON API type field
|
|
596
|
-
*
|
|
597
585
|
* This interface was referenced by `BuildEvent`'s JSON-Schema
|
|
598
586
|
* via the `definition` "type".
|
|
599
587
|
*/
|
|
600
588
|
export declare type BuildEventType = 'build_event';
|
|
601
589
|
/**
|
|
602
|
-
* JSON API type field
|
|
603
|
-
*
|
|
604
590
|
* This interface was referenced by `BuildTrigger`'s JSON-Schema
|
|
605
591
|
* via the `definition` "type".
|
|
606
592
|
*/
|
|
@@ -726,15 +712,11 @@ export declare type ItemSelfHrefSchema = {
|
|
|
726
712
|
*/
|
|
727
713
|
export declare type ItemCurrentVsPublishedStateIdentity = string;
|
|
728
714
|
/**
|
|
729
|
-
* JSON API type field
|
|
730
|
-
*
|
|
731
715
|
* This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
|
|
732
716
|
* via the `definition` "type".
|
|
733
717
|
*/
|
|
734
718
|
export declare type ItemCurrentVsPublishedStateType = 'item_current_vs_published_state';
|
|
735
719
|
/**
|
|
736
|
-
* JSON API type field
|
|
737
|
-
*
|
|
738
720
|
* This interface was referenced by `ScheduledPublication`'s JSON-Schema
|
|
739
721
|
* via the `definition` "type".
|
|
740
722
|
*/
|
|
@@ -750,8 +732,6 @@ export declare type ScheduledPublicationType = 'scheduled_publication';
|
|
|
750
732
|
*/
|
|
751
733
|
export declare type ScheduledPublicationIdentity = string;
|
|
752
734
|
/**
|
|
753
|
-
* JSON API type field
|
|
754
|
-
*
|
|
755
735
|
* This interface was referenced by `ScheduledUnpublishing`'s JSON-Schema
|
|
756
736
|
* via the `definition` "type".
|
|
757
737
|
*/
|
|
@@ -767,8 +747,6 @@ export declare type ScheduledUnpublishingType = 'scheduled_unpublishing';
|
|
|
767
747
|
*/
|
|
768
748
|
export declare type ScheduledUnpublishingIdentity = string;
|
|
769
749
|
/**
|
|
770
|
-
* JSON API type field
|
|
771
|
-
*
|
|
772
750
|
* This interface was referenced by `ItemVersion`'s JSON-Schema
|
|
773
751
|
* via the `definition` "type".
|
|
774
752
|
*/
|
|
@@ -834,15 +812,15 @@ export declare type ItemBatchUnpublishHrefSchema = {
|
|
|
834
812
|
*/
|
|
835
813
|
export declare type ItemPublishSchema = {
|
|
836
814
|
/**
|
|
837
|
-
*
|
|
815
|
+
* 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.
|
|
838
816
|
*/
|
|
839
817
|
type?: 'selective_publish_operation';
|
|
840
818
|
/**
|
|
841
|
-
*
|
|
819
|
+
* Array of [valid locale codes in this project](/product-updates/get-locales-list-from-graphql) to publish.
|
|
842
820
|
*/
|
|
843
821
|
content_in_locales: string[];
|
|
844
822
|
/**
|
|
845
|
-
* Whether non-localized content
|
|
823
|
+
* Whether non-localized content will be published
|
|
846
824
|
*/
|
|
847
825
|
non_localized_content: boolean;
|
|
848
826
|
} | null;
|
|
@@ -852,7 +830,7 @@ export declare type ItemPublishSchema = {
|
|
|
852
830
|
*/
|
|
853
831
|
export declare type ItemPublishHrefSchema = {
|
|
854
832
|
/**
|
|
855
|
-
*
|
|
833
|
+
* 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.
|
|
856
834
|
*/
|
|
857
835
|
recursive?: boolean;
|
|
858
836
|
[k: string]: unknown;
|
|
@@ -862,12 +840,9 @@ export declare type ItemPublishHrefSchema = {
|
|
|
862
840
|
* via the `unpublish.schema` link.
|
|
863
841
|
*/
|
|
864
842
|
export declare type ItemUnpublishSchema = {
|
|
865
|
-
/**
|
|
866
|
-
* JSON API type field
|
|
867
|
-
*/
|
|
868
843
|
type?: 'selective_unpublish_operation';
|
|
869
844
|
/**
|
|
870
|
-
*
|
|
845
|
+
* 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).
|
|
871
846
|
*/
|
|
872
847
|
content_in_locales: string[];
|
|
873
848
|
} | null;
|
|
@@ -877,7 +852,7 @@ export declare type ItemUnpublishSchema = {
|
|
|
877
852
|
*/
|
|
878
853
|
export declare type ItemUnpublishHrefSchema = {
|
|
879
854
|
/**
|
|
880
|
-
*
|
|
855
|
+
* 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.
|
|
881
856
|
*/
|
|
882
857
|
recursive?: boolean;
|
|
883
858
|
[k: string]: unknown;
|
|
@@ -948,8 +923,6 @@ export declare type ItemVersionInstancesHrefSchema = {
|
|
|
948
923
|
*/
|
|
949
924
|
export declare type UploadIdentity = string;
|
|
950
925
|
/**
|
|
951
|
-
* JSON API type upload
|
|
952
|
-
*
|
|
953
926
|
* This interface was referenced by `Upload`'s JSON-Schema
|
|
954
927
|
* via the `definition` "type".
|
|
955
928
|
*/
|
|
@@ -1081,8 +1054,6 @@ export declare type UploadBulkDestroyJobSchema = unknown[];
|
|
|
1081
1054
|
*/
|
|
1082
1055
|
export declare type UploadRequestIdentity = string;
|
|
1083
1056
|
/**
|
|
1084
|
-
* JSON API type field
|
|
1085
|
-
*
|
|
1086
1057
|
* This interface was referenced by `UploadRequest`'s JSON-Schema
|
|
1087
1058
|
* via the `definition` "type".
|
|
1088
1059
|
*/
|
|
@@ -1098,8 +1069,6 @@ export declare type UploadRequestType = 'upload_request';
|
|
|
1098
1069
|
*/
|
|
1099
1070
|
export declare type SearchResultIdentity = string;
|
|
1100
1071
|
/**
|
|
1101
|
-
* JSON API type field
|
|
1102
|
-
*
|
|
1103
1072
|
* This interface was referenced by `SearchResult`'s JSON-Schema
|
|
1104
1073
|
* via the `definition` "type".
|
|
1105
1074
|
*/
|
|
@@ -1153,8 +1122,6 @@ export declare type SearchResultInstancesHrefSchema = {
|
|
|
1153
1122
|
[k: string]: unknown;
|
|
1154
1123
|
};
|
|
1155
1124
|
/**
|
|
1156
|
-
* JSON API type field
|
|
1157
|
-
*
|
|
1158
1125
|
* This interface was referenced by `Environment`'s JSON-Schema
|
|
1159
1126
|
* via the `definition` "type".
|
|
1160
1127
|
*/
|
|
@@ -1204,8 +1171,6 @@ export declare type EnvironmentDestroyTargetSchema = Job | Environment;
|
|
|
1204
1171
|
*/
|
|
1205
1172
|
export declare type MaintenanceModeIdentity = string;
|
|
1206
1173
|
/**
|
|
1207
|
-
* JSON API type field
|
|
1208
|
-
*
|
|
1209
1174
|
* This interface was referenced by `MaintenanceMode`'s JSON-Schema
|
|
1210
1175
|
* via the `definition` "type".
|
|
1211
1176
|
*/
|
|
@@ -1232,8 +1197,6 @@ export declare type MaintenanceModeActivateHrefSchema = {
|
|
|
1232
1197
|
*/
|
|
1233
1198
|
export declare type WebhookIdentity = string;
|
|
1234
1199
|
/**
|
|
1235
|
-
* JSON API type field
|
|
1236
|
-
*
|
|
1237
1200
|
* This interface was referenced by `Webhook`'s JSON-Schema
|
|
1238
1201
|
* via the `definition` "type".
|
|
1239
1202
|
*/
|
|
@@ -1254,8 +1217,6 @@ export declare type WebhookInstancesTargetSchema = Webhook[];
|
|
|
1254
1217
|
*/
|
|
1255
1218
|
export declare type WebhookCallIdentity = string;
|
|
1256
1219
|
/**
|
|
1257
|
-
* JSON API type field
|
|
1258
|
-
*
|
|
1259
1220
|
* This interface was referenced by `WebhookCall`'s JSON-Schema
|
|
1260
1221
|
* via the `definition` "type".
|
|
1261
1222
|
*/
|
|
@@ -1307,8 +1268,6 @@ export declare type ItemTypeFilterInstancesTargetSchema = ItemTypeFilter[];
|
|
|
1307
1268
|
*/
|
|
1308
1269
|
export declare type UploadFilterIdentity = string;
|
|
1309
1270
|
/**
|
|
1310
|
-
* JSON API type field
|
|
1311
|
-
*
|
|
1312
1271
|
* This interface was referenced by `UploadFilter`'s JSON-Schema
|
|
1313
1272
|
* via the `definition` "type".
|
|
1314
1273
|
*/
|
|
@@ -1329,8 +1288,6 @@ export declare type UploadFilterInstancesTargetSchema = UploadFilter[];
|
|
|
1329
1288
|
*/
|
|
1330
1289
|
export declare type SiteInvitationIdentity = string;
|
|
1331
1290
|
/**
|
|
1332
|
-
* JSON API type field
|
|
1333
|
-
*
|
|
1334
1291
|
* This interface was referenced by `SiteInvitation`'s JSON-Schema
|
|
1335
1292
|
* via the `definition` "type".
|
|
1336
1293
|
*/
|
|
@@ -1351,8 +1308,6 @@ export declare type SiteInvitationInstancesTargetSchema = SiteInvitation[];
|
|
|
1351
1308
|
*/
|
|
1352
1309
|
export declare type EditingSessionIdentity = string;
|
|
1353
1310
|
/**
|
|
1354
|
-
* JSON API type field
|
|
1355
|
-
*
|
|
1356
1311
|
* This interface was referenced by `EditingSession`'s JSON-Schema
|
|
1357
1312
|
* via the `definition` "type".
|
|
1358
1313
|
*/
|
|
@@ -1410,8 +1365,6 @@ export declare type EditingSessionUpdateTargetSchema = EditingSession | [Editing
|
|
|
1410
1365
|
*/
|
|
1411
1366
|
export declare type FormDataIdentity = 'form_data';
|
|
1412
1367
|
/**
|
|
1413
|
-
* JSON API type field
|
|
1414
|
-
*
|
|
1415
1368
|
* This interface was referenced by `FormData`'s JSON-Schema
|
|
1416
1369
|
* via the `definition` "type".
|
|
1417
1370
|
*/
|
|
@@ -1432,8 +1385,6 @@ export declare type SsoGroupInstancesTargetSchema = SsoGroup[];
|
|
|
1432
1385
|
*/
|
|
1433
1386
|
export declare type SsoSettingsIdentity = string;
|
|
1434
1387
|
/**
|
|
1435
|
-
* JSON API type field
|
|
1436
|
-
*
|
|
1437
1388
|
* This interface was referenced by `SsoSettings`'s JSON-Schema
|
|
1438
1389
|
* via the `definition` "type".
|
|
1439
1390
|
*/
|
|
@@ -1449,8 +1400,6 @@ export declare type SsoSettingsType = 'sso_settings';
|
|
|
1449
1400
|
*/
|
|
1450
1401
|
export declare type WhiteLabelSettingsIdentity = string;
|
|
1451
1402
|
/**
|
|
1452
|
-
* JSON API type field
|
|
1453
|
-
*
|
|
1454
1403
|
* This interface was referenced by `WhiteLabelSettings`'s JSON-Schema
|
|
1455
1404
|
* via the `definition` "type".
|
|
1456
1405
|
*/
|
|
@@ -1466,8 +1415,6 @@ export declare type WhiteLabelSettingsType = 'white_label_settings';
|
|
|
1466
1415
|
*/
|
|
1467
1416
|
export declare type PublicInfoIdentity = string;
|
|
1468
1417
|
/**
|
|
1469
|
-
* JSON API type field
|
|
1470
|
-
*
|
|
1471
1418
|
* This interface was referenced by `PublicInfo`'s JSON-Schema
|
|
1472
1419
|
* via the `definition` "type".
|
|
1473
1420
|
*/
|
|
@@ -1483,8 +1430,6 @@ export declare type PublicInfoType = 'public_info';
|
|
|
1483
1430
|
*/
|
|
1484
1431
|
export declare type DailyUsageIdentity = string;
|
|
1485
1432
|
/**
|
|
1486
|
-
* JSON API type field
|
|
1487
|
-
*
|
|
1488
1433
|
* This interface was referenced by `DailyUsage`'s JSON-Schema
|
|
1489
1434
|
* via the `definition` "type".
|
|
1490
1435
|
*/
|
|
@@ -1505,8 +1450,6 @@ export declare type DailyUsageInstancesTargetSchema = DailyUsage[];
|
|
|
1505
1450
|
*/
|
|
1506
1451
|
export declare type UsageCounterIdentity = 'assets_path_bytes' | 'assets_referrer_bytes' | 'assets_ip_bytes' | 'assets_full_path_bytes' | 'assets_path_requests' | 'assets_full_path_requests' | 'cda_access_token_id_bytes' | 'cda_access_token_id_requests' | 'cda_referrer_bytes' | 'cda_referrer_requests' | 'cda_ip_bytes' | 'cda_ip_requests' | 'cma_endpoint_bytes' | 'cma_endpoint_requests' | 'cma_user_bytes' | 'cma_user_requests' | 'cma_ip_bytes' | 'cma_ip_requests' | 'video_path_seconds';
|
|
1507
1452
|
/**
|
|
1508
|
-
* JSON API type field
|
|
1509
|
-
*
|
|
1510
1453
|
* This interface was referenced by `UsageCounter`'s JSON-Schema
|
|
1511
1454
|
* via the `definition` "type".
|
|
1512
1455
|
*/
|
|
@@ -1532,8 +1475,6 @@ export declare type UsageCounterSelfHrefSchema = {
|
|
|
1532
1475
|
*/
|
|
1533
1476
|
export declare type UploadTagIdentity = string;
|
|
1534
1477
|
/**
|
|
1535
|
-
* JSON API type field
|
|
1536
|
-
*
|
|
1537
1478
|
* This interface was referenced by `UploadTag`'s JSON-Schema
|
|
1538
1479
|
* via the `definition` "type".
|
|
1539
1480
|
*/
|
|
@@ -1585,8 +1526,6 @@ export declare type UploadTagInstancesHrefSchema = {
|
|
|
1585
1526
|
*/
|
|
1586
1527
|
export declare type UploadSmartTagIdentity = string;
|
|
1587
1528
|
/**
|
|
1588
|
-
* JSON API type field
|
|
1589
|
-
*
|
|
1590
1529
|
* This interface was referenced by `UploadSmartTag`'s JSON-Schema
|
|
1591
1530
|
* via the `definition` "type".
|
|
1592
1531
|
*/
|
|
@@ -1638,8 +1577,6 @@ export declare type UploadSmartTagInstancesHrefSchema = {
|
|
|
1638
1577
|
*/
|
|
1639
1578
|
export declare type SiteIdentity = string;
|
|
1640
1579
|
/**
|
|
1641
|
-
* JSON API type field
|
|
1642
|
-
*
|
|
1643
1580
|
* This interface was referenced by `Site`'s JSON-Schema
|
|
1644
1581
|
* via the `definition` "type".
|
|
1645
1582
|
*/
|
|
@@ -1669,6 +1606,7 @@ export declare type DatoApi = {
|
|
|
1669
1606
|
organization?: Organization;
|
|
1670
1607
|
site_plan?: SitePlan;
|
|
1671
1608
|
menu_item?: MenuItem;
|
|
1609
|
+
schema_menu_item?: SchemaMenuItem;
|
|
1672
1610
|
item_type?: ItemType;
|
|
1673
1611
|
field?: Field;
|
|
1674
1612
|
fieldset?: Fieldset;
|
|
@@ -3315,9 +3253,6 @@ export declare type AuditLogEventAttributes = {
|
|
|
3315
3253
|
* via the `query.schema` link.
|
|
3316
3254
|
*/
|
|
3317
3255
|
export declare type AuditLogEventQuerySchema = {
|
|
3318
|
-
/**
|
|
3319
|
-
* JSON API type field
|
|
3320
|
-
*/
|
|
3321
3256
|
type?: 'audit_log_query';
|
|
3322
3257
|
/**
|
|
3323
3258
|
* An SQL-like expression to filter the events
|
|
@@ -3978,6 +3913,121 @@ export declare type MenuItemUpdateSchema = {
|
|
|
3978
3913
|
item_type_filter?: ItemTypeFilterData | null;
|
|
3979
3914
|
parent?: null | MenuItemData;
|
|
3980
3915
|
};
|
|
3916
|
+
/**
|
|
3917
|
+
* 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.
|
|
3918
|
+
*
|
|
3919
|
+
* This interface was referenced by `DatoApi`'s JSON-Schema
|
|
3920
|
+
* via the `definition` "schema_menu_item".
|
|
3921
|
+
*/
|
|
3922
|
+
export declare type SchemaMenuItem = {
|
|
3923
|
+
id: SchemaMenuItemIdentity;
|
|
3924
|
+
type: SchemaMenuItemType;
|
|
3925
|
+
/**
|
|
3926
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
3927
|
+
*/
|
|
3928
|
+
label: null | string;
|
|
3929
|
+
/**
|
|
3930
|
+
* Ordering index
|
|
3931
|
+
*/
|
|
3932
|
+
position: number;
|
|
3933
|
+
/**
|
|
3934
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
3935
|
+
*/
|
|
3936
|
+
kind: 'item_type' | 'modular_block';
|
|
3937
|
+
item_type: ItemTypeData | null;
|
|
3938
|
+
parent: null | SchemaMenuItemData;
|
|
3939
|
+
children: SchemaMenuItemData[];
|
|
3940
|
+
};
|
|
3941
|
+
export declare type SchemaMenuItemCreateTargetSchema = SchemaMenuItem;
|
|
3942
|
+
export declare type SchemaMenuItemUpdateTargetSchema = SchemaMenuItem;
|
|
3943
|
+
export declare type SchemaMenuItemSelfTargetSchema = SchemaMenuItem;
|
|
3944
|
+
export declare type SchemaMenuItemDestroyTargetSchema = SchemaMenuItem;
|
|
3945
|
+
/**
|
|
3946
|
+
* JSON API data
|
|
3947
|
+
*
|
|
3948
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3949
|
+
* via the `definition` "data".
|
|
3950
|
+
*/
|
|
3951
|
+
export declare type SchemaMenuItemData = {
|
|
3952
|
+
type: SchemaMenuItemType;
|
|
3953
|
+
id: SchemaMenuItemIdentity;
|
|
3954
|
+
};
|
|
3955
|
+
/**
|
|
3956
|
+
* JSON API attributes
|
|
3957
|
+
*
|
|
3958
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3959
|
+
* via the `definition` "attributes".
|
|
3960
|
+
*/
|
|
3961
|
+
export declare type SchemaMenuItemAttributes = {
|
|
3962
|
+
/**
|
|
3963
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
3964
|
+
*/
|
|
3965
|
+
label: null | string;
|
|
3966
|
+
/**
|
|
3967
|
+
* Ordering index
|
|
3968
|
+
*/
|
|
3969
|
+
position: number;
|
|
3970
|
+
/**
|
|
3971
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
3972
|
+
*/
|
|
3973
|
+
kind: 'item_type' | 'modular_block';
|
|
3974
|
+
};
|
|
3975
|
+
/**
|
|
3976
|
+
* JSON API links
|
|
3977
|
+
*
|
|
3978
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3979
|
+
* via the `definition` "relationships".
|
|
3980
|
+
*/
|
|
3981
|
+
export declare type SchemaMenuItemRelationships = {
|
|
3982
|
+
item_type: ItemTypeData | null;
|
|
3983
|
+
parent: null | SchemaMenuItemData;
|
|
3984
|
+
children: SchemaMenuItemData[];
|
|
3985
|
+
};
|
|
3986
|
+
/**
|
|
3987
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
3988
|
+
* via the `create.schema` link.
|
|
3989
|
+
*/
|
|
3990
|
+
export declare type SchemaMenuItemCreateSchema = {
|
|
3991
|
+
id?: SchemaMenuItemIdentity;
|
|
3992
|
+
type?: SchemaMenuItemType;
|
|
3993
|
+
/**
|
|
3994
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
3995
|
+
*/
|
|
3996
|
+
label: null | string;
|
|
3997
|
+
/**
|
|
3998
|
+
* Ordering index
|
|
3999
|
+
*/
|
|
4000
|
+
position?: number;
|
|
4001
|
+
/**
|
|
4002
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
4003
|
+
*/
|
|
4004
|
+
kind: 'item_type' | 'modular_block';
|
|
4005
|
+
item_type?: ItemTypeData | null;
|
|
4006
|
+
parent?: null | SchemaMenuItemData;
|
|
4007
|
+
};
|
|
4008
|
+
/**
|
|
4009
|
+
* This interface was referenced by `SchemaMenuItem`'s JSON-Schema
|
|
4010
|
+
* via the `update.schema` link.
|
|
4011
|
+
*/
|
|
4012
|
+
export declare type SchemaMenuItemUpdateSchema = {
|
|
4013
|
+
id?: SchemaMenuItemIdentity;
|
|
4014
|
+
type?: SchemaMenuItemType;
|
|
4015
|
+
/**
|
|
4016
|
+
* The label of the schema menu item (only present when the schema menu item is not linked to an item type)
|
|
4017
|
+
*/
|
|
4018
|
+
label?: null | string;
|
|
4019
|
+
/**
|
|
4020
|
+
* Ordering index
|
|
4021
|
+
*/
|
|
4022
|
+
position?: number;
|
|
4023
|
+
/**
|
|
4024
|
+
* Indicates if the schema menu item refers to an item type or a modular block
|
|
4025
|
+
*/
|
|
4026
|
+
kind?: 'item_type' | 'modular_block';
|
|
4027
|
+
item_type?: ItemTypeData | null;
|
|
4028
|
+
parent?: null | SchemaMenuItemData;
|
|
4029
|
+
children?: SchemaMenuItemData[];
|
|
4030
|
+
};
|
|
3981
4031
|
/**
|
|
3982
4032
|
* 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".
|
|
3983
4033
|
*
|
|
@@ -5283,6 +5333,18 @@ export declare type JobData = {
|
|
|
5283
5333
|
* </details>
|
|
5284
5334
|
*
|
|
5285
5335
|
* <details>
|
|
5336
|
+
* <summary><code>seo</code></summary>
|
|
5337
|
+
*
|
|
5338
|
+
* Built-in editor for _seo_ fields.
|
|
5339
|
+
*
|
|
5340
|
+
* | Parameter | Type | Required | Description |
|
|
5341
|
+
* | ---------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
5342
|
+
* | `fields` | `Array<String>` | ✅ | Specify which fields of the SEO input should be visible to editors. Valid values: `"title"`, `"description"`, `"image"`, `"no_index"`, `"twitter_card"` |
|
|
5343
|
+
* | `previews` | `Array<String>` | ✅ | Specify which previews should be visible to editors. Valid values: `"google_search"`, `"twitter"`, `"slack"`, `"whatsapp"`, `"telegram"`, `"facebook"` |
|
|
5344
|
+
*
|
|
5345
|
+
* </details>
|
|
5346
|
+
*
|
|
5347
|
+
* <details>
|
|
5286
5348
|
* <summary><code>rich_text</code></summary>
|
|
5287
5349
|
*
|
|
5288
5350
|
* Built-in editor for _Modular content_ fields.
|
|
@@ -5886,9 +5948,6 @@ export declare type SessionRelationships = {
|
|
|
5886
5948
|
* via the `create.schema` link.
|
|
5887
5949
|
*/
|
|
5888
5950
|
export declare type SessionCreateSchema = {
|
|
5889
|
-
/**
|
|
5890
|
-
* JSON API type field
|
|
5891
|
-
*/
|
|
5892
5951
|
type?: 'email_credentials';
|
|
5893
5952
|
/**
|
|
5894
5953
|
* Email
|
|
@@ -6694,9 +6753,6 @@ export declare type ItemCurrentVsPublishedStateRelationships = {
|
|
|
6694
6753
|
* via the `bulk_publish.schema` link.
|
|
6695
6754
|
*/
|
|
6696
6755
|
export declare type ItemBulkPublishSchema = {
|
|
6697
|
-
/**
|
|
6698
|
-
* JSON API type field
|
|
6699
|
-
*/
|
|
6700
6756
|
type?: 'item_bulk_publish_operation';
|
|
6701
6757
|
items: ItemData[];
|
|
6702
6758
|
minItems?: unknown;
|
|
@@ -6707,9 +6763,6 @@ export declare type ItemBulkPublishSchema = {
|
|
|
6707
6763
|
* via the `bulk_unpublish.schema` link.
|
|
6708
6764
|
*/
|
|
6709
6765
|
export declare type ItemBulkUnpublishSchema = {
|
|
6710
|
-
/**
|
|
6711
|
-
* JSON API type field
|
|
6712
|
-
*/
|
|
6713
6766
|
type?: 'item_bulk_unpublish_operation';
|
|
6714
6767
|
items: ItemData[];
|
|
6715
6768
|
minItems?: unknown;
|
|
@@ -6720,9 +6773,6 @@ export declare type ItemBulkUnpublishSchema = {
|
|
|
6720
6773
|
* via the `bulk_destroy.schema` link.
|
|
6721
6774
|
*/
|
|
6722
6775
|
export declare type ItemBulkDestroySchema = {
|
|
6723
|
-
/**
|
|
6724
|
-
* JSON API type field
|
|
6725
|
-
*/
|
|
6726
6776
|
type?: 'item_bulk_destroy_operation';
|
|
6727
6777
|
items: ItemData[];
|
|
6728
6778
|
minItems?: unknown;
|
|
@@ -6733,9 +6783,6 @@ export declare type ItemBulkDestroySchema = {
|
|
|
6733
6783
|
* via the `bulk_move_to_stage.schema` link.
|
|
6734
6784
|
*/
|
|
6735
6785
|
export declare type ItemBulkMoveToStageSchema = {
|
|
6736
|
-
/**
|
|
6737
|
-
* JSON API type field
|
|
6738
|
-
*/
|
|
6739
6786
|
type?: 'item_bulk_move_to_stage_operation';
|
|
6740
6787
|
/**
|
|
6741
6788
|
* Stage to be moved to
|
|
@@ -7321,9 +7368,6 @@ export declare type UploadBatchAddTagsSchema = {
|
|
|
7321
7368
|
* via the `bulk_tag.schema` link.
|
|
7322
7369
|
*/
|
|
7323
7370
|
export declare type UploadBulkTagSchema = {
|
|
7324
|
-
/**
|
|
7325
|
-
* JSON API type field
|
|
7326
|
-
*/
|
|
7327
7371
|
type?: 'upload_bulk_tag_operation';
|
|
7328
7372
|
/**
|
|
7329
7373
|
* The tags to add to the assets
|
|
@@ -7336,9 +7380,6 @@ export declare type UploadBulkTagSchema = {
|
|
|
7336
7380
|
* via the `bulk_destroy.schema` link.
|
|
7337
7381
|
*/
|
|
7338
7382
|
export declare type UploadBulkDestroySchema = {
|
|
7339
|
-
/**
|
|
7340
|
-
* JSON API type field
|
|
7341
|
-
*/
|
|
7342
7383
|
type?: 'upload_bulk_destroy_operation';
|
|
7343
7384
|
uploads: UploadData[];
|
|
7344
7385
|
[k: string]: unknown;
|
|
@@ -8944,9 +8985,6 @@ export declare type SsoSettingsRelationships = {
|
|
|
8944
8985
|
*/
|
|
8945
8986
|
export declare type SsoSettingsGenerateTokenTargetSchema = {
|
|
8946
8987
|
id: SsoSettingsIdentity;
|
|
8947
|
-
/**
|
|
8948
|
-
* JSON API type field
|
|
8949
|
-
*/
|
|
8950
8988
|
type: 'sso_token';
|
|
8951
8989
|
attributes: {
|
|
8952
8990
|
/**
|
|
@@ -9056,35 +9094,31 @@ export declare type PublicInfo = {
|
|
|
9056
9094
|
* Specifies the color-scheme for the project
|
|
9057
9095
|
*/
|
|
9058
9096
|
theme: {
|
|
9059
|
-
primary_color
|
|
9097
|
+
primary_color: {
|
|
9060
9098
|
red: number;
|
|
9061
9099
|
green: number;
|
|
9062
9100
|
blue: number;
|
|
9063
9101
|
alpha: number;
|
|
9064
9102
|
[k: string]: unknown;
|
|
9065
9103
|
};
|
|
9066
|
-
light_color
|
|
9104
|
+
light_color: {
|
|
9067
9105
|
red: number;
|
|
9068
9106
|
green: number;
|
|
9069
9107
|
blue: number;
|
|
9070
9108
|
alpha: number;
|
|
9071
|
-
[k: string]: unknown;
|
|
9072
9109
|
};
|
|
9073
|
-
accent_color
|
|
9110
|
+
accent_color: {
|
|
9074
9111
|
red: number;
|
|
9075
9112
|
green: number;
|
|
9076
9113
|
blue: number;
|
|
9077
9114
|
alpha: number;
|
|
9078
|
-
[k: string]: unknown;
|
|
9079
9115
|
};
|
|
9080
|
-
dark_color
|
|
9116
|
+
dark_color: {
|
|
9081
9117
|
red: number;
|
|
9082
9118
|
green: number;
|
|
9083
9119
|
blue: number;
|
|
9084
9120
|
alpha: number;
|
|
9085
|
-
[k: string]: unknown;
|
|
9086
9121
|
};
|
|
9087
|
-
[k: string]: unknown;
|
|
9088
9122
|
};
|
|
9089
9123
|
/**
|
|
9090
9124
|
* Additional information (only returned on authenticated requests)
|
|
@@ -9138,35 +9172,31 @@ export declare type PublicInfoAttributes = {
|
|
|
9138
9172
|
* Specifies the color-scheme for the project
|
|
9139
9173
|
*/
|
|
9140
9174
|
theme: {
|
|
9141
|
-
primary_color
|
|
9175
|
+
primary_color: {
|
|
9142
9176
|
red: number;
|
|
9143
9177
|
green: number;
|
|
9144
9178
|
blue: number;
|
|
9145
9179
|
alpha: number;
|
|
9146
9180
|
[k: string]: unknown;
|
|
9147
9181
|
};
|
|
9148
|
-
light_color
|
|
9182
|
+
light_color: {
|
|
9149
9183
|
red: number;
|
|
9150
9184
|
green: number;
|
|
9151
9185
|
blue: number;
|
|
9152
9186
|
alpha: number;
|
|
9153
|
-
[k: string]: unknown;
|
|
9154
9187
|
};
|
|
9155
|
-
accent_color
|
|
9188
|
+
accent_color: {
|
|
9156
9189
|
red: number;
|
|
9157
9190
|
green: number;
|
|
9158
9191
|
blue: number;
|
|
9159
9192
|
alpha: number;
|
|
9160
|
-
[k: string]: unknown;
|
|
9161
9193
|
};
|
|
9162
|
-
dark_color
|
|
9194
|
+
dark_color: {
|
|
9163
9195
|
red: number;
|
|
9164
9196
|
green: number;
|
|
9165
9197
|
blue: number;
|
|
9166
9198
|
alpha: number;
|
|
9167
|
-
[k: string]: unknown;
|
|
9168
9199
|
};
|
|
9169
|
-
[k: string]: unknown;
|
|
9170
9200
|
};
|
|
9171
9201
|
/**
|
|
9172
9202
|
* Additional information (only returned on authenticated requests)
|
|
@@ -9452,39 +9482,42 @@ export declare type Site = {
|
|
|
9452
9482
|
* Specifies the theme to use in administrative area
|
|
9453
9483
|
*/
|
|
9454
9484
|
theme: {
|
|
9485
|
+
/**
|
|
9486
|
+
* 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
|
|
9487
|
+
*/
|
|
9488
|
+
type: 'custom' | 'monochromatic';
|
|
9489
|
+
/**
|
|
9490
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
9491
|
+
*/
|
|
9492
|
+
hue: number | null;
|
|
9455
9493
|
primary_color: {
|
|
9456
9494
|
red: number;
|
|
9457
9495
|
green: number;
|
|
9458
9496
|
blue: number;
|
|
9459
9497
|
alpha: number;
|
|
9460
|
-
[k: string]: unknown;
|
|
9461
9498
|
};
|
|
9462
9499
|
light_color: {
|
|
9463
9500
|
red: number;
|
|
9464
9501
|
green: number;
|
|
9465
9502
|
blue: number;
|
|
9466
9503
|
alpha: number;
|
|
9467
|
-
[k: string]: unknown;
|
|
9468
9504
|
};
|
|
9469
9505
|
accent_color: {
|
|
9470
9506
|
red: number;
|
|
9471
9507
|
green: number;
|
|
9472
9508
|
blue: number;
|
|
9473
9509
|
alpha: number;
|
|
9474
|
-
[k: string]: unknown;
|
|
9475
9510
|
};
|
|
9476
9511
|
dark_color: {
|
|
9477
9512
|
red: number;
|
|
9478
9513
|
green: number;
|
|
9479
9514
|
blue: number;
|
|
9480
9515
|
alpha: number;
|
|
9481
|
-
[k: string]: unknown;
|
|
9482
9516
|
};
|
|
9483
9517
|
/**
|
|
9484
|
-
* The
|
|
9518
|
+
* The upload ID that is used as the logo for the project
|
|
9485
9519
|
*/
|
|
9486
9520
|
logo: string | null;
|
|
9487
|
-
[k: string]: unknown;
|
|
9488
9521
|
};
|
|
9489
9522
|
/**
|
|
9490
9523
|
* Specifies default global settings
|
|
@@ -9534,6 +9567,8 @@ export declare type SiteUpdateJobSchema = Site;
|
|
|
9534
9567
|
export declare type SiteActivateImprovedTimezoneManagementJobSchema = Site;
|
|
9535
9568
|
export declare type SiteActivateImprovedHexManagementTargetSchema = Site;
|
|
9536
9569
|
export declare type SiteActivateImprovedGqlMultilocaleFieldsTargetSchema = Site;
|
|
9570
|
+
export declare type SiteActivateImprovedGqlVisibilityControlTargetSchema = Site;
|
|
9571
|
+
export declare type SiteActivateImprovedBooleanFieldsTargetSchema = Site;
|
|
9537
9572
|
/**
|
|
9538
9573
|
* Meta attributes
|
|
9539
9574
|
*
|
|
@@ -9553,6 +9588,14 @@ export declare type SiteMeta = {
|
|
|
9553
9588
|
* Whether the Improved GraphQL multi-locale fields option is active or not
|
|
9554
9589
|
*/
|
|
9555
9590
|
improved_gql_multilocale_fields: boolean;
|
|
9591
|
+
/**
|
|
9592
|
+
* Whether the Improved GraphQL visibility control option is active or not
|
|
9593
|
+
*/
|
|
9594
|
+
improved_gql_visibility_control: boolean;
|
|
9595
|
+
/**
|
|
9596
|
+
* Whether the Improved boolean fields option is active or not
|
|
9597
|
+
*/
|
|
9598
|
+
improved_boolean_fields: boolean;
|
|
9556
9599
|
};
|
|
9557
9600
|
/**
|
|
9558
9601
|
* JSON API data
|
|
@@ -9627,39 +9670,42 @@ export declare type SiteAttributes = {
|
|
|
9627
9670
|
* Specifies the theme to use in administrative area
|
|
9628
9671
|
*/
|
|
9629
9672
|
theme: {
|
|
9673
|
+
/**
|
|
9674
|
+
* 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
|
|
9675
|
+
*/
|
|
9676
|
+
type: 'custom' | 'monochromatic';
|
|
9677
|
+
/**
|
|
9678
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
9679
|
+
*/
|
|
9680
|
+
hue: number | null;
|
|
9630
9681
|
primary_color: {
|
|
9631
9682
|
red: number;
|
|
9632
9683
|
green: number;
|
|
9633
9684
|
blue: number;
|
|
9634
9685
|
alpha: number;
|
|
9635
|
-
[k: string]: unknown;
|
|
9636
9686
|
};
|
|
9637
9687
|
light_color: {
|
|
9638
9688
|
red: number;
|
|
9639
9689
|
green: number;
|
|
9640
9690
|
blue: number;
|
|
9641
9691
|
alpha: number;
|
|
9642
|
-
[k: string]: unknown;
|
|
9643
9692
|
};
|
|
9644
9693
|
accent_color: {
|
|
9645
9694
|
red: number;
|
|
9646
9695
|
green: number;
|
|
9647
9696
|
blue: number;
|
|
9648
9697
|
alpha: number;
|
|
9649
|
-
[k: string]: unknown;
|
|
9650
9698
|
};
|
|
9651
9699
|
dark_color: {
|
|
9652
9700
|
red: number;
|
|
9653
9701
|
green: number;
|
|
9654
9702
|
blue: number;
|
|
9655
9703
|
alpha: number;
|
|
9656
|
-
[k: string]: unknown;
|
|
9657
9704
|
};
|
|
9658
9705
|
/**
|
|
9659
|
-
* The
|
|
9706
|
+
* The upload ID that is used as the logo for the project
|
|
9660
9707
|
*/
|
|
9661
9708
|
logo: string | null;
|
|
9662
|
-
[k: string]: unknown;
|
|
9663
9709
|
};
|
|
9664
9710
|
/**
|
|
9665
9711
|
* Specifies default global settings
|
|
@@ -9765,42 +9811,53 @@ export declare type SiteUpdateSchema = {
|
|
|
9765
9811
|
* Site name
|
|
9766
9812
|
*/
|
|
9767
9813
|
name?: string;
|
|
9768
|
-
/**
|
|
9769
|
-
* Specifies the theme to use in administrative area
|
|
9770
|
-
*/
|
|
9771
9814
|
theme?: {
|
|
9815
|
+
/**
|
|
9816
|
+
* Type of theme color palette
|
|
9817
|
+
*/
|
|
9818
|
+
type: 'monochromatic';
|
|
9819
|
+
/**
|
|
9820
|
+
* If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
|
|
9821
|
+
*/
|
|
9822
|
+
hue: number | null;
|
|
9823
|
+
/**
|
|
9824
|
+
* The upload ID that is used as the logo for the project
|
|
9825
|
+
*/
|
|
9826
|
+
logo: string | null;
|
|
9827
|
+
[k: string]: unknown;
|
|
9828
|
+
} | {
|
|
9829
|
+
/**
|
|
9830
|
+
* Type of theme color palette
|
|
9831
|
+
*/
|
|
9832
|
+
type?: 'custom';
|
|
9833
|
+
/**
|
|
9834
|
+
* The upload ID that is used as the logo for the project
|
|
9835
|
+
*/
|
|
9836
|
+
logo: string | null;
|
|
9772
9837
|
primary_color: {
|
|
9773
9838
|
red: number;
|
|
9774
9839
|
green: number;
|
|
9775
9840
|
blue: number;
|
|
9776
9841
|
alpha: number;
|
|
9777
|
-
[k: string]: unknown;
|
|
9778
9842
|
};
|
|
9779
9843
|
light_color: {
|
|
9780
9844
|
red: number;
|
|
9781
9845
|
green: number;
|
|
9782
9846
|
blue: number;
|
|
9783
9847
|
alpha: number;
|
|
9784
|
-
[k: string]: unknown;
|
|
9785
9848
|
};
|
|
9786
9849
|
accent_color: {
|
|
9787
9850
|
red: number;
|
|
9788
9851
|
green: number;
|
|
9789
9852
|
blue: number;
|
|
9790
9853
|
alpha: number;
|
|
9791
|
-
[k: string]: unknown;
|
|
9792
9854
|
};
|
|
9793
|
-
dark_color
|
|
9855
|
+
dark_color?: {
|
|
9794
9856
|
red: number;
|
|
9795
9857
|
green: number;
|
|
9796
9858
|
blue: number;
|
|
9797
9859
|
alpha: number;
|
|
9798
|
-
[k: string]: unknown;
|
|
9799
9860
|
};
|
|
9800
|
-
/**
|
|
9801
|
-
* The site logo
|
|
9802
|
-
*/
|
|
9803
|
-
logo: string | null;
|
|
9804
9861
|
[k: string]: unknown;
|
|
9805
9862
|
};
|
|
9806
9863
|
/**
|
|
@@ -9837,6 +9894,14 @@ export declare type SiteUpdateSchema = {
|
|
|
9837
9894
|
* Whether the Improved GraphQL multi-locale fields option is active or not
|
|
9838
9895
|
*/
|
|
9839
9896
|
improved_gql_multilocale_fields?: boolean;
|
|
9897
|
+
/**
|
|
9898
|
+
* Whether the Improved GraphQL visibility control option is active or not
|
|
9899
|
+
*/
|
|
9900
|
+
improved_gql_visibility_control?: boolean;
|
|
9901
|
+
/**
|
|
9902
|
+
* Whether the Improved boolean fields option is active or not
|
|
9903
|
+
*/
|
|
9904
|
+
improved_boolean_fields?: boolean;
|
|
9840
9905
|
};
|
|
9841
9906
|
};
|
|
9842
9907
|
/**
|