@datocms/cma-client 1.1.1 → 1.1.3
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.map +1 -1
- package/dist/cjs/generated/resources/AccessToken.js +36 -0
- package/dist/cjs/generated/resources/AccessToken.js.map +1 -1
- package/dist/cjs/generated/resources/AuditLogEvent.js +6 -0
- package/dist/cjs/generated/resources/AuditLogEvent.js.map +1 -1
- package/dist/cjs/generated/resources/BuildEvent.js +12 -0
- package/dist/cjs/generated/resources/BuildEvent.js.map +1 -1
- package/dist/cjs/generated/resources/BuildTrigger.js +54 -0
- package/dist/cjs/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/cjs/generated/resources/DailyUsage.js +6 -0
- package/dist/cjs/generated/resources/DailyUsage.js.map +1 -1
- package/dist/cjs/generated/resources/EditingSession.js +15 -0
- package/dist/cjs/generated/resources/EditingSession.js.map +1 -1
- package/dist/cjs/generated/resources/Environment.js +30 -0
- package/dist/cjs/generated/resources/Environment.js.map +1 -1
- package/dist/cjs/generated/resources/Field.js +48 -0
- package/dist/cjs/generated/resources/Field.js.map +1 -1
- package/dist/cjs/generated/resources/Fieldset.js +30 -0
- package/dist/cjs/generated/resources/Fieldset.js.map +1 -1
- package/dist/cjs/generated/resources/Item.js +114 -0
- package/dist/cjs/generated/resources/Item.js.map +1 -1
- package/dist/cjs/generated/resources/ItemType.js +36 -0
- package/dist/cjs/generated/resources/ItemType.js.map +1 -1
- package/dist/cjs/generated/resources/ItemTypeFilter.js +33 -3
- package/dist/cjs/generated/resources/ItemTypeFilter.js.map +1 -1
- package/dist/cjs/generated/resources/ItemVersion.js +24 -0
- package/dist/cjs/generated/resources/ItemVersion.js.map +1 -1
- package/dist/cjs/generated/resources/JobResult.js +6 -0
- package/dist/cjs/generated/resources/JobResult.js.map +1 -1
- package/dist/cjs/generated/resources/MaintenanceMode.js +18 -0
- package/dist/cjs/generated/resources/MaintenanceMode.js.map +1 -1
- package/dist/cjs/generated/resources/MenuItem.js +32 -2
- package/dist/cjs/generated/resources/MenuItem.js.map +1 -1
- package/dist/cjs/generated/resources/Plugin.js +36 -0
- package/dist/cjs/generated/resources/Plugin.js.map +1 -1
- package/dist/cjs/generated/resources/PublicInfo.js +6 -0
- package/dist/cjs/generated/resources/PublicInfo.js.map +1 -1
- package/dist/cjs/generated/resources/Role.js +30 -0
- package/dist/cjs/generated/resources/Role.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledPublication.js +12 -0
- package/dist/cjs/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js +12 -0
- package/dist/cjs/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/cjs/generated/resources/SearchResult.js +12 -0
- package/dist/cjs/generated/resources/SearchResult.js.map +1 -1
- package/dist/cjs/generated/resources/Session.js +6 -0
- package/dist/cjs/generated/resources/Session.js.map +1 -1
- package/dist/cjs/generated/resources/Site.js +18 -0
- package/dist/cjs/generated/resources/Site.js.map +1 -1
- package/dist/cjs/generated/resources/SiteInvitation.js +36 -0
- package/dist/cjs/generated/resources/SiteInvitation.js.map +1 -1
- package/dist/cjs/generated/resources/SsoGroup.js +24 -0
- package/dist/cjs/generated/resources/SsoGroup.js.map +1 -1
- package/dist/cjs/generated/resources/SsoSettings.js +18 -0
- package/dist/cjs/generated/resources/SsoSettings.js.map +1 -1
- package/dist/cjs/generated/resources/SsoUser.js +24 -0
- package/dist/cjs/generated/resources/SsoUser.js.map +1 -1
- package/dist/cjs/generated/resources/SubscriptionFeature.js +6 -0
- package/dist/cjs/generated/resources/SubscriptionFeature.js.map +1 -1
- package/dist/cjs/generated/resources/SubscriptionLimit.js +12 -0
- package/dist/cjs/generated/resources/SubscriptionLimit.js.map +1 -1
- package/dist/cjs/generated/resources/Upload.js +66 -0
- package/dist/cjs/generated/resources/Upload.js.map +1 -1
- package/dist/cjs/generated/resources/UploadFilter.js +30 -0
- package/dist/cjs/generated/resources/UploadFilter.js.map +1 -1
- package/dist/cjs/generated/resources/UploadRequest.js +6 -0
- package/dist/cjs/generated/resources/UploadRequest.js.map +1 -1
- package/dist/cjs/generated/resources/UploadSmartTag.js +12 -0
- package/dist/cjs/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/cjs/generated/resources/UploadTag.js +18 -0
- package/dist/cjs/generated/resources/UploadTag.js.map +1 -1
- package/dist/cjs/generated/resources/UsageCounter.js +6 -0
- package/dist/cjs/generated/resources/UsageCounter.js.map +1 -1
- package/dist/cjs/generated/resources/User.js +30 -0
- package/dist/cjs/generated/resources/User.js.map +1 -1
- package/dist/cjs/generated/resources/Webhook.js +30 -0
- package/dist/cjs/generated/resources/Webhook.js.map +1 -1
- package/dist/cjs/generated/resources/WebhookCall.js +18 -0
- package/dist/cjs/generated/resources/WebhookCall.js.map +1 -1
- package/dist/cjs/generated/resources/WhiteLabelSettings.js +12 -0
- package/dist/cjs/generated/resources/WhiteLabelSettings.js.map +1 -1
- package/dist/cjs/generated/resources/Workflow.js +30 -0
- package/dist/cjs/generated/resources/Workflow.js.map +1 -1
- package/dist/cjs/index.js +2 -1
- package/dist/cjs/index.js.map +1 -1
- package/dist/esm/buildBlockRecord.d.ts +2 -0
- package/dist/esm/generated/Client.d.ts +9 -0
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +185 -44
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +190 -41
- package/dist/esm/generated/resources/AccessToken.d.ts +36 -0
- package/dist/esm/generated/resources/AccessToken.js +36 -0
- package/dist/esm/generated/resources/AccessToken.js.map +1 -1
- package/dist/esm/generated/resources/AuditLogEvent.d.ts +6 -0
- package/dist/esm/generated/resources/AuditLogEvent.js +6 -0
- package/dist/esm/generated/resources/AuditLogEvent.js.map +1 -1
- package/dist/esm/generated/resources/BuildEvent.d.ts +12 -0
- package/dist/esm/generated/resources/BuildEvent.js +12 -0
- package/dist/esm/generated/resources/BuildEvent.js.map +1 -1
- package/dist/esm/generated/resources/BuildTrigger.d.ts +54 -0
- package/dist/esm/generated/resources/BuildTrigger.js +54 -0
- package/dist/esm/generated/resources/BuildTrigger.js.map +1 -1
- package/dist/esm/generated/resources/DailyUsage.d.ts +6 -0
- package/dist/esm/generated/resources/DailyUsage.js +6 -0
- package/dist/esm/generated/resources/DailyUsage.js.map +1 -1
- package/dist/esm/generated/resources/EditingSession.d.ts +15 -0
- package/dist/esm/generated/resources/EditingSession.js +15 -0
- package/dist/esm/generated/resources/EditingSession.js.map +1 -1
- package/dist/esm/generated/resources/Environment.d.ts +30 -0
- package/dist/esm/generated/resources/Environment.js +30 -0
- package/dist/esm/generated/resources/Environment.js.map +1 -1
- package/dist/esm/generated/resources/Field.d.ts +48 -0
- package/dist/esm/generated/resources/Field.js +48 -0
- package/dist/esm/generated/resources/Field.js.map +1 -1
- package/dist/esm/generated/resources/Fieldset.d.ts +30 -0
- package/dist/esm/generated/resources/Fieldset.js +30 -0
- package/dist/esm/generated/resources/Fieldset.js.map +1 -1
- package/dist/esm/generated/resources/Item.d.ts +114 -0
- package/dist/esm/generated/resources/Item.js +114 -0
- package/dist/esm/generated/resources/Item.js.map +1 -1
- package/dist/esm/generated/resources/ItemType.d.ts +36 -0
- package/dist/esm/generated/resources/ItemType.js +36 -0
- package/dist/esm/generated/resources/ItemType.js.map +1 -1
- package/dist/esm/generated/resources/ItemTypeFilter.d.ts +30 -0
- package/dist/esm/generated/resources/ItemTypeFilter.js +33 -3
- package/dist/esm/generated/resources/ItemTypeFilter.js.map +1 -1
- package/dist/esm/generated/resources/ItemVersion.d.ts +24 -0
- package/dist/esm/generated/resources/ItemVersion.js +24 -0
- package/dist/esm/generated/resources/ItemVersion.js.map +1 -1
- package/dist/esm/generated/resources/JobResult.d.ts +6 -0
- package/dist/esm/generated/resources/JobResult.js +6 -0
- package/dist/esm/generated/resources/JobResult.js.map +1 -1
- package/dist/esm/generated/resources/MaintenanceMode.d.ts +18 -0
- package/dist/esm/generated/resources/MaintenanceMode.js +18 -0
- package/dist/esm/generated/resources/MaintenanceMode.js.map +1 -1
- package/dist/esm/generated/resources/MenuItem.d.ts +30 -0
- package/dist/esm/generated/resources/MenuItem.js +32 -2
- package/dist/esm/generated/resources/MenuItem.js.map +1 -1
- package/dist/esm/generated/resources/Plugin.d.ts +36 -0
- package/dist/esm/generated/resources/Plugin.js +36 -0
- package/dist/esm/generated/resources/Plugin.js.map +1 -1
- package/dist/esm/generated/resources/PublicInfo.d.ts +6 -0
- package/dist/esm/generated/resources/PublicInfo.js +6 -0
- package/dist/esm/generated/resources/PublicInfo.js.map +1 -1
- package/dist/esm/generated/resources/Role.d.ts +30 -0
- package/dist/esm/generated/resources/Role.js +30 -0
- package/dist/esm/generated/resources/Role.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledPublication.d.ts +12 -0
- package/dist/esm/generated/resources/ScheduledPublication.js +12 -0
- package/dist/esm/generated/resources/ScheduledPublication.js.map +1 -1
- package/dist/esm/generated/resources/ScheduledUnpublishing.d.ts +12 -0
- package/dist/esm/generated/resources/ScheduledUnpublishing.js +12 -0
- package/dist/esm/generated/resources/ScheduledUnpublishing.js.map +1 -1
- package/dist/esm/generated/resources/SearchResult.d.ts +12 -0
- package/dist/esm/generated/resources/SearchResult.js +12 -0
- package/dist/esm/generated/resources/SearchResult.js.map +1 -1
- package/dist/esm/generated/resources/Session.d.ts +6 -0
- package/dist/esm/generated/resources/Session.js +6 -0
- package/dist/esm/generated/resources/Session.js.map +1 -1
- package/dist/esm/generated/resources/Site.d.ts +18 -0
- package/dist/esm/generated/resources/Site.js +18 -0
- package/dist/esm/generated/resources/Site.js.map +1 -1
- package/dist/esm/generated/resources/SiteInvitation.d.ts +36 -0
- package/dist/esm/generated/resources/SiteInvitation.js +36 -0
- package/dist/esm/generated/resources/SiteInvitation.js.map +1 -1
- package/dist/esm/generated/resources/SsoGroup.d.ts +24 -0
- package/dist/esm/generated/resources/SsoGroup.js +24 -0
- package/dist/esm/generated/resources/SsoGroup.js.map +1 -1
- package/dist/esm/generated/resources/SsoSettings.d.ts +18 -0
- package/dist/esm/generated/resources/SsoSettings.js +18 -0
- package/dist/esm/generated/resources/SsoSettings.js.map +1 -1
- package/dist/esm/generated/resources/SsoUser.d.ts +24 -0
- package/dist/esm/generated/resources/SsoUser.js +24 -0
- package/dist/esm/generated/resources/SsoUser.js.map +1 -1
- package/dist/esm/generated/resources/SubscriptionFeature.d.ts +6 -0
- package/dist/esm/generated/resources/SubscriptionFeature.js +6 -0
- package/dist/esm/generated/resources/SubscriptionFeature.js.map +1 -1
- package/dist/esm/generated/resources/SubscriptionLimit.d.ts +12 -0
- package/dist/esm/generated/resources/SubscriptionLimit.js +12 -0
- package/dist/esm/generated/resources/SubscriptionLimit.js.map +1 -1
- package/dist/esm/generated/resources/Upload.d.ts +66 -0
- package/dist/esm/generated/resources/Upload.js +66 -0
- package/dist/esm/generated/resources/Upload.js.map +1 -1
- package/dist/esm/generated/resources/UploadFilter.d.ts +30 -0
- package/dist/esm/generated/resources/UploadFilter.js +30 -0
- package/dist/esm/generated/resources/UploadFilter.js.map +1 -1
- package/dist/esm/generated/resources/UploadRequest.d.ts +6 -0
- package/dist/esm/generated/resources/UploadRequest.js +6 -0
- package/dist/esm/generated/resources/UploadRequest.js.map +1 -1
- package/dist/esm/generated/resources/UploadSmartTag.d.ts +12 -0
- package/dist/esm/generated/resources/UploadSmartTag.js +12 -0
- package/dist/esm/generated/resources/UploadSmartTag.js.map +1 -1
- package/dist/esm/generated/resources/UploadTag.d.ts +18 -0
- package/dist/esm/generated/resources/UploadTag.js +18 -0
- package/dist/esm/generated/resources/UploadTag.js.map +1 -1
- package/dist/esm/generated/resources/UsageCounter.d.ts +6 -0
- package/dist/esm/generated/resources/UsageCounter.js +6 -0
- package/dist/esm/generated/resources/UsageCounter.js.map +1 -1
- package/dist/esm/generated/resources/User.d.ts +30 -0
- package/dist/esm/generated/resources/User.js +30 -0
- package/dist/esm/generated/resources/User.js.map +1 -1
- package/dist/esm/generated/resources/Webhook.d.ts +30 -0
- package/dist/esm/generated/resources/Webhook.js +30 -0
- package/dist/esm/generated/resources/Webhook.js.map +1 -1
- package/dist/esm/generated/resources/WebhookCall.d.ts +18 -0
- package/dist/esm/generated/resources/WebhookCall.js +18 -0
- package/dist/esm/generated/resources/WebhookCall.js.map +1 -1
- package/dist/esm/generated/resources/WhiteLabelSettings.d.ts +12 -0
- package/dist/esm/generated/resources/WhiteLabelSettings.js +12 -0
- package/dist/esm/generated/resources/WhiteLabelSettings.js.map +1 -1
- package/dist/esm/generated/resources/Workflow.d.ts +30 -0
- package/dist/esm/generated/resources/Workflow.js +30 -0
- package/dist/esm/generated/resources/Workflow.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/types/buildBlockRecord.d.ts +2 -0
- package/dist/types/generated/Client.d.ts +9 -0
- package/dist/types/generated/SchemaTypes.d.ts +185 -44
- package/dist/types/generated/SimpleSchemaTypes.d.ts +190 -41
- package/dist/types/generated/resources/AccessToken.d.ts +36 -0
- package/dist/types/generated/resources/AuditLogEvent.d.ts +6 -0
- package/dist/types/generated/resources/BuildEvent.d.ts +12 -0
- package/dist/types/generated/resources/BuildTrigger.d.ts +54 -0
- package/dist/types/generated/resources/DailyUsage.d.ts +6 -0
- package/dist/types/generated/resources/EditingSession.d.ts +15 -0
- package/dist/types/generated/resources/Environment.d.ts +30 -0
- package/dist/types/generated/resources/Field.d.ts +48 -0
- package/dist/types/generated/resources/Fieldset.d.ts +30 -0
- package/dist/types/generated/resources/Item.d.ts +114 -0
- package/dist/types/generated/resources/ItemType.d.ts +36 -0
- package/dist/types/generated/resources/ItemTypeFilter.d.ts +30 -0
- package/dist/types/generated/resources/ItemVersion.d.ts +24 -0
- package/dist/types/generated/resources/JobResult.d.ts +6 -0
- package/dist/types/generated/resources/MaintenanceMode.d.ts +18 -0
- package/dist/types/generated/resources/MenuItem.d.ts +30 -0
- package/dist/types/generated/resources/Plugin.d.ts +36 -0
- package/dist/types/generated/resources/PublicInfo.d.ts +6 -0
- package/dist/types/generated/resources/Role.d.ts +30 -0
- package/dist/types/generated/resources/ScheduledPublication.d.ts +12 -0
- package/dist/types/generated/resources/ScheduledUnpublishing.d.ts +12 -0
- package/dist/types/generated/resources/SearchResult.d.ts +12 -0
- package/dist/types/generated/resources/Session.d.ts +6 -0
- package/dist/types/generated/resources/Site.d.ts +18 -0
- package/dist/types/generated/resources/SiteInvitation.d.ts +36 -0
- package/dist/types/generated/resources/SsoGroup.d.ts +24 -0
- package/dist/types/generated/resources/SsoSettings.d.ts +18 -0
- package/dist/types/generated/resources/SsoUser.d.ts +24 -0
- package/dist/types/generated/resources/SubscriptionFeature.d.ts +6 -0
- package/dist/types/generated/resources/SubscriptionLimit.d.ts +12 -0
- package/dist/types/generated/resources/Upload.d.ts +66 -0
- package/dist/types/generated/resources/UploadFilter.d.ts +30 -0
- package/dist/types/generated/resources/UploadRequest.d.ts +6 -0
- package/dist/types/generated/resources/UploadSmartTag.d.ts +12 -0
- package/dist/types/generated/resources/UploadTag.d.ts +18 -0
- package/dist/types/generated/resources/UsageCounter.d.ts +6 -0
- package/dist/types/generated/resources/User.d.ts +30 -0
- package/dist/types/generated/resources/Webhook.d.ts +30 -0
- package/dist/types/generated/resources/WebhookCall.d.ts +18 -0
- package/dist/types/generated/resources/WhiteLabelSettings.d.ts +12 -0
- package/dist/types/generated/resources/Workflow.d.ts +30 -0
- package/dist/types/index.d.ts +1 -1
- package/package.json +4 -4
- package/src/generated/Client.ts +9 -0
- package/src/generated/SchemaTypes.ts +192 -45
- package/src/generated/SimpleSchemaTypes.ts +199 -42
- package/src/generated/resources/AccessToken.ts +36 -0
- package/src/generated/resources/AuditLogEvent.ts +6 -0
- package/src/generated/resources/BuildEvent.ts +12 -0
- package/src/generated/resources/BuildTrigger.ts +54 -0
- package/src/generated/resources/DailyUsage.ts +6 -0
- package/src/generated/resources/EditingSession.ts +15 -0
- package/src/generated/resources/Environment.ts +30 -0
- package/src/generated/resources/Field.ts +48 -0
- package/src/generated/resources/Fieldset.ts +30 -0
- package/src/generated/resources/Item.ts +114 -0
- package/src/generated/resources/ItemType.ts +36 -0
- package/src/generated/resources/ItemTypeFilter.ts +33 -3
- package/src/generated/resources/ItemVersion.ts +24 -0
- package/src/generated/resources/JobResult.ts +6 -0
- package/src/generated/resources/MaintenanceMode.ts +18 -0
- package/src/generated/resources/MenuItem.ts +32 -2
- package/src/generated/resources/Plugin.ts +36 -0
- package/src/generated/resources/PublicInfo.ts +6 -0
- package/src/generated/resources/Role.ts +30 -0
- package/src/generated/resources/ScheduledPublication.ts +12 -0
- package/src/generated/resources/ScheduledUnpublishing.ts +12 -0
- package/src/generated/resources/SearchResult.ts +12 -0
- package/src/generated/resources/Session.ts +6 -0
- package/src/generated/resources/Site.ts +18 -0
- package/src/generated/resources/SiteInvitation.ts +36 -0
- package/src/generated/resources/SsoGroup.ts +24 -0
- package/src/generated/resources/SsoSettings.ts +18 -0
- package/src/generated/resources/SsoUser.ts +24 -0
- package/src/generated/resources/SubscriptionFeature.ts +6 -0
- package/src/generated/resources/SubscriptionLimit.ts +12 -0
- package/src/generated/resources/Upload.ts +66 -0
- package/src/generated/resources/UploadFilter.ts +30 -0
- package/src/generated/resources/UploadRequest.ts +6 -0
- package/src/generated/resources/UploadSmartTag.ts +12 -0
- package/src/generated/resources/UploadTag.ts +18 -0
- package/src/generated/resources/UsageCounter.ts +6 -0
- package/src/generated/resources/User.ts +30 -0
- package/src/generated/resources/Webhook.ts +30 -0
- package/src/generated/resources/WebhookCall.ts +18 -0
- package/src/generated/resources/WhiteLabelSettings.ts +12 -0
- package/src/generated/resources/Workflow.ts +30 -0
- package/src/index.ts +1 -1
|
@@ -7,36 +7,54 @@ export default class MaintenanceMode extends BaseResource {
|
|
|
7
7
|
* Retrieve maintenence mode
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
find(): Promise<SimpleSchemaTypes.MaintenanceMode>;
|
|
12
15
|
/**
|
|
13
16
|
* Retrieve maintenence mode
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/self
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawFind(): Promise<SchemaTypes.MaintenanceModeSelfTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Activate maintenance mode: this means that the primary environment will be read-only
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
activate(queryParams?: SimpleSchemaTypes.MaintenanceModeActivateHrefSchema): Promise<SimpleSchemaTypes.MaintenanceMode>;
|
|
24
33
|
/**
|
|
25
34
|
* Activate maintenance mode: this means that the primary environment will be read-only
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/activate
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawActivate(queryParams?: SchemaTypes.MaintenanceModeActivateHrefSchema): Promise<SchemaTypes.MaintenanceModeActivateTargetSchema>;
|
|
30
42
|
/**
|
|
31
43
|
* De-activate maintenance mode
|
|
32
44
|
*
|
|
33
45
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
|
|
46
|
+
*
|
|
47
|
+
* @throws {ApiError}
|
|
48
|
+
* @throws {TimeoutError}
|
|
34
49
|
*/
|
|
35
50
|
deactivate(): Promise<SimpleSchemaTypes.MaintenanceMode>;
|
|
36
51
|
/**
|
|
37
52
|
* De-activate maintenance mode
|
|
38
53
|
*
|
|
39
54
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/maintenance-mode/deactivate
|
|
55
|
+
*
|
|
56
|
+
* @throws {ApiError}
|
|
57
|
+
* @throws {TimeoutError}
|
|
40
58
|
*/
|
|
41
59
|
rawDeactivate(): Promise<SchemaTypes.MaintenanceModeDeactivateTargetSchema>;
|
|
42
60
|
}
|
|
@@ -7,60 +7,90 @@ export default class MenuItem extends BaseResource {
|
|
|
7
7
|
* Create a new menu item
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/create
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
create(body: SimpleSchemaTypes.MenuItemCreateSchema): Promise<SimpleSchemaTypes.MenuItem>;
|
|
12
15
|
/**
|
|
13
16
|
* Create a new menu item
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/create
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawCreate(body: SchemaTypes.MenuItemCreateSchema): Promise<SchemaTypes.MenuItemCreateTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Update a menu item
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/update
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
update(menuItemId: string | SimpleSchemaTypes.MenuItemData, body: SimpleSchemaTypes.MenuItemUpdateSchema): Promise<SimpleSchemaTypes.MenuItem>;
|
|
24
33
|
/**
|
|
25
34
|
* Update a menu item
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/update
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawUpdate(menuItemId: string, body: SchemaTypes.MenuItemUpdateSchema): Promise<SchemaTypes.MenuItemUpdateTargetSchema>;
|
|
30
42
|
/**
|
|
31
43
|
* List all menu items
|
|
32
44
|
*
|
|
33
45
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/instances
|
|
46
|
+
*
|
|
47
|
+
* @throws {ApiError}
|
|
48
|
+
* @throws {TimeoutError}
|
|
34
49
|
*/
|
|
35
50
|
list(queryParams?: SimpleSchemaTypes.MenuItemInstancesHrefSchema): Promise<SimpleSchemaTypes.MenuItemInstancesTargetSchema>;
|
|
36
51
|
/**
|
|
37
52
|
* List all menu items
|
|
38
53
|
*
|
|
39
54
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/instances
|
|
55
|
+
*
|
|
56
|
+
* @throws {ApiError}
|
|
57
|
+
* @throws {TimeoutError}
|
|
40
58
|
*/
|
|
41
59
|
rawList(queryParams?: SchemaTypes.MenuItemInstancesHrefSchema): Promise<SchemaTypes.MenuItemInstancesTargetSchema>;
|
|
42
60
|
/**
|
|
43
61
|
* Retrieve a menu item
|
|
44
62
|
*
|
|
45
63
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/self
|
|
64
|
+
*
|
|
65
|
+
* @throws {ApiError}
|
|
66
|
+
* @throws {TimeoutError}
|
|
46
67
|
*/
|
|
47
68
|
find(menuItemId: string | SimpleSchemaTypes.MenuItemData): Promise<SimpleSchemaTypes.MenuItem>;
|
|
48
69
|
/**
|
|
49
70
|
* Retrieve a menu item
|
|
50
71
|
*
|
|
51
72
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/self
|
|
73
|
+
*
|
|
74
|
+
* @throws {ApiError}
|
|
75
|
+
* @throws {TimeoutError}
|
|
52
76
|
*/
|
|
53
77
|
rawFind(menuItemId: string): Promise<SchemaTypes.MenuItemSelfTargetSchema>;
|
|
54
78
|
/**
|
|
55
79
|
* Delete a menu item
|
|
56
80
|
*
|
|
57
81
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy
|
|
82
|
+
*
|
|
83
|
+
* @throws {ApiError}
|
|
84
|
+
* @throws {TimeoutError}
|
|
58
85
|
*/
|
|
59
86
|
destroy(menuItemId: string | SimpleSchemaTypes.MenuItemData): Promise<SimpleSchemaTypes.MenuItem>;
|
|
60
87
|
/**
|
|
61
88
|
* Delete a menu item
|
|
62
89
|
*
|
|
63
90
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/menu-item/destroy
|
|
91
|
+
*
|
|
92
|
+
* @throws {ApiError}
|
|
93
|
+
* @throws {TimeoutError}
|
|
64
94
|
*/
|
|
65
95
|
rawDestroy(menuItemId: string): Promise<SchemaTypes.MenuItemDestroyTargetSchema>;
|
|
66
96
|
}
|
|
@@ -7,72 +7,108 @@ export default class Plugin extends BaseResource {
|
|
|
7
7
|
* Create a new plugin
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/create
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
create(body: SimpleSchemaTypes.PluginCreateSchema): Promise<SimpleSchemaTypes.Plugin>;
|
|
12
15
|
/**
|
|
13
16
|
* Create a new plugin
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/create
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawCreate(body: SchemaTypes.PluginCreateSchema): Promise<SchemaTypes.PluginCreateTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Update a plugin
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/update
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
update(pluginId: string | SimpleSchemaTypes.PluginData, body: SimpleSchemaTypes.PluginUpdateSchema): Promise<SimpleSchemaTypes.Plugin>;
|
|
24
33
|
/**
|
|
25
34
|
* Update a plugin
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/update
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawUpdate(pluginId: string, body: SchemaTypes.PluginUpdateSchema): Promise<SchemaTypes.PluginUpdateTargetSchema>;
|
|
30
42
|
/**
|
|
31
43
|
* List all plugins
|
|
32
44
|
*
|
|
33
45
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/instances
|
|
46
|
+
*
|
|
47
|
+
* @throws {ApiError}
|
|
48
|
+
* @throws {TimeoutError}
|
|
34
49
|
*/
|
|
35
50
|
list(): Promise<SimpleSchemaTypes.PluginInstancesTargetSchema>;
|
|
36
51
|
/**
|
|
37
52
|
* List all plugins
|
|
38
53
|
*
|
|
39
54
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/instances
|
|
55
|
+
*
|
|
56
|
+
* @throws {ApiError}
|
|
57
|
+
* @throws {TimeoutError}
|
|
40
58
|
*/
|
|
41
59
|
rawList(): Promise<SchemaTypes.PluginInstancesTargetSchema>;
|
|
42
60
|
/**
|
|
43
61
|
* Retrieve a plugins
|
|
44
62
|
*
|
|
45
63
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
|
|
64
|
+
*
|
|
65
|
+
* @throws {ApiError}
|
|
66
|
+
* @throws {TimeoutError}
|
|
46
67
|
*/
|
|
47
68
|
find(pluginId: string | SimpleSchemaTypes.PluginData): Promise<SimpleSchemaTypes.Plugin>;
|
|
48
69
|
/**
|
|
49
70
|
* Retrieve a plugins
|
|
50
71
|
*
|
|
51
72
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/self
|
|
73
|
+
*
|
|
74
|
+
* @throws {ApiError}
|
|
75
|
+
* @throws {TimeoutError}
|
|
52
76
|
*/
|
|
53
77
|
rawFind(pluginId: string): Promise<SchemaTypes.PluginSelfTargetSchema>;
|
|
54
78
|
/**
|
|
55
79
|
* Delete a plugin
|
|
56
80
|
*
|
|
57
81
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/destroy
|
|
82
|
+
*
|
|
83
|
+
* @throws {ApiError}
|
|
84
|
+
* @throws {TimeoutError}
|
|
58
85
|
*/
|
|
59
86
|
destroy(pluginId: string | SimpleSchemaTypes.PluginData): Promise<SimpleSchemaTypes.Plugin>;
|
|
60
87
|
/**
|
|
61
88
|
* Delete a plugin
|
|
62
89
|
*
|
|
63
90
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/destroy
|
|
91
|
+
*
|
|
92
|
+
* @throws {ApiError}
|
|
93
|
+
* @throws {TimeoutError}
|
|
64
94
|
*/
|
|
65
95
|
rawDestroy(pluginId: string): Promise<SchemaTypes.PluginDestroyTargetSchema>;
|
|
66
96
|
/**
|
|
67
97
|
* Retrieve all fields using the plugin
|
|
68
98
|
*
|
|
69
99
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/fields
|
|
100
|
+
*
|
|
101
|
+
* @throws {ApiError}
|
|
102
|
+
* @throws {TimeoutError}
|
|
70
103
|
*/
|
|
71
104
|
fields(pluginId: string | SimpleSchemaTypes.PluginData): Promise<SimpleSchemaTypes.PluginFieldsTargetSchema>;
|
|
72
105
|
/**
|
|
73
106
|
* Retrieve all fields using the plugin
|
|
74
107
|
*
|
|
75
108
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/plugin/fields
|
|
109
|
+
*
|
|
110
|
+
* @throws {ApiError}
|
|
111
|
+
* @throws {TimeoutError}
|
|
76
112
|
*/
|
|
77
113
|
rawFields(pluginId: string): Promise<SchemaTypes.PluginFieldsTargetSchema>;
|
|
78
114
|
}
|
|
@@ -7,12 +7,18 @@ export default class PublicInfo extends BaseResource {
|
|
|
7
7
|
* Retrieve public site info
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/public-info/self
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
find(): Promise<SimpleSchemaTypes.PublicInfo>;
|
|
12
15
|
/**
|
|
13
16
|
* Retrieve public site info
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/public-info/self
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawFind(): Promise<SchemaTypes.PublicInfoSelfTargetSchema>;
|
|
18
24
|
}
|
|
@@ -7,60 +7,90 @@ export default class Role extends BaseResource {
|
|
|
7
7
|
* Create a new role
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
create(body: SimpleSchemaTypes.RoleCreateSchema): Promise<SimpleSchemaTypes.Role>;
|
|
12
15
|
/**
|
|
13
16
|
* Create a new role
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/create
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawCreate(body: SchemaTypes.RoleCreateSchema): Promise<SchemaTypes.RoleCreateTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Update a role
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
update(roleId: string | SimpleSchemaTypes.RoleData, body: SimpleSchemaTypes.RoleUpdateSchema): Promise<SimpleSchemaTypes.Role>;
|
|
24
33
|
/**
|
|
25
34
|
* Update a role
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/update
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawUpdate(roleId: string, body: SchemaTypes.RoleUpdateSchema): Promise<SchemaTypes.RoleUpdateTargetSchema>;
|
|
30
42
|
/**
|
|
31
43
|
* List all roles
|
|
32
44
|
*
|
|
33
45
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
|
|
46
|
+
*
|
|
47
|
+
* @throws {ApiError}
|
|
48
|
+
* @throws {TimeoutError}
|
|
34
49
|
*/
|
|
35
50
|
list(): Promise<SimpleSchemaTypes.RoleInstancesTargetSchema>;
|
|
36
51
|
/**
|
|
37
52
|
* List all roles
|
|
38
53
|
*
|
|
39
54
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/instances
|
|
55
|
+
*
|
|
56
|
+
* @throws {ApiError}
|
|
57
|
+
* @throws {TimeoutError}
|
|
40
58
|
*/
|
|
41
59
|
rawList(): Promise<SchemaTypes.RoleInstancesTargetSchema>;
|
|
42
60
|
/**
|
|
43
61
|
* Retrieve a role
|
|
44
62
|
*
|
|
45
63
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
|
|
64
|
+
*
|
|
65
|
+
* @throws {ApiError}
|
|
66
|
+
* @throws {TimeoutError}
|
|
46
67
|
*/
|
|
47
68
|
find(roleId: string | SimpleSchemaTypes.RoleData): Promise<SimpleSchemaTypes.Role>;
|
|
48
69
|
/**
|
|
49
70
|
* Retrieve a role
|
|
50
71
|
*
|
|
51
72
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/self
|
|
73
|
+
*
|
|
74
|
+
* @throws {ApiError}
|
|
75
|
+
* @throws {TimeoutError}
|
|
52
76
|
*/
|
|
53
77
|
rawFind(roleId: string): Promise<SchemaTypes.RoleSelfTargetSchema>;
|
|
54
78
|
/**
|
|
55
79
|
* Delete a role
|
|
56
80
|
*
|
|
57
81
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
|
|
82
|
+
*
|
|
83
|
+
* @throws {ApiError}
|
|
84
|
+
* @throws {TimeoutError}
|
|
58
85
|
*/
|
|
59
86
|
destroy(roleId: string | SimpleSchemaTypes.RoleData): Promise<SimpleSchemaTypes.Role>;
|
|
60
87
|
/**
|
|
61
88
|
* Delete a role
|
|
62
89
|
*
|
|
63
90
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/role/destroy
|
|
91
|
+
*
|
|
92
|
+
* @throws {ApiError}
|
|
93
|
+
* @throws {TimeoutError}
|
|
64
94
|
*/
|
|
65
95
|
rawDestroy(roleId: string): Promise<SchemaTypes.RoleDestroyTargetSchema>;
|
|
66
96
|
}
|
|
@@ -7,24 +7,36 @@ export default class ScheduledPublication extends BaseResource {
|
|
|
7
7
|
* Create a new scheduled publication
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
create(itemId: string | SimpleSchemaTypes.ItemData, body: SimpleSchemaTypes.ScheduledPublicationCreateSchema): Promise<SimpleSchemaTypes.ScheduledPublication>;
|
|
12
15
|
/**
|
|
13
16
|
* Create a new scheduled publication
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/create
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawCreate(itemId: string, body: SchemaTypes.ScheduledPublicationCreateSchema): Promise<SchemaTypes.ScheduledPublicationCreateTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Delete a scheduled publication
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
destroy(itemId: string | SimpleSchemaTypes.ItemData): Promise<SimpleSchemaTypes.Item>;
|
|
24
33
|
/**
|
|
25
34
|
* Delete a scheduled publication
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-publication/destroy
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawDestroy(itemId: string): Promise<SchemaTypes.ScheduledPublicationDestroyTargetSchema>;
|
|
30
42
|
}
|
|
@@ -7,24 +7,36 @@ export default class ScheduledUnpublishing extends BaseResource {
|
|
|
7
7
|
* Create a new scheduled unpublishing
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
create(itemId: string | SimpleSchemaTypes.ItemData, body: SimpleSchemaTypes.ScheduledUnpublishingCreateSchema): Promise<SimpleSchemaTypes.ScheduledUnpublishing>;
|
|
12
15
|
/**
|
|
13
16
|
* Create a new scheduled unpublishing
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/create
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawCreate(itemId: string, body: SchemaTypes.ScheduledUnpublishingCreateSchema): Promise<SchemaTypes.ScheduledUnpublishingCreateTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Delete a scheduled unpublishing
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
destroy(itemId: string | SimpleSchemaTypes.ItemData): Promise<SimpleSchemaTypes.Item>;
|
|
24
33
|
/**
|
|
25
34
|
* Delete a scheduled unpublishing
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/scheduled-unpublishing/destroy
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawDestroy(itemId: string): Promise<SchemaTypes.ScheduledUnpublishingDestroyTargetSchema>;
|
|
30
42
|
}
|
|
@@ -8,24 +8,36 @@ export default class SearchResult extends BaseResource {
|
|
|
8
8
|
* Search for results
|
|
9
9
|
*
|
|
10
10
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
11
|
+
*
|
|
12
|
+
* @throws {ApiError}
|
|
13
|
+
* @throws {TimeoutError}
|
|
11
14
|
*/
|
|
12
15
|
list(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema): Promise<SimpleSchemaTypes.SearchResultInstancesTargetSchema>;
|
|
13
16
|
/**
|
|
14
17
|
* Search for results
|
|
15
18
|
*
|
|
16
19
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
20
|
+
*
|
|
21
|
+
* @throws {ApiError}
|
|
22
|
+
* @throws {TimeoutError}
|
|
17
23
|
*/
|
|
18
24
|
rawList(queryParams: SchemaTypes.SearchResultInstancesHrefSchema): Promise<SchemaTypes.SearchResultInstancesTargetSchema>;
|
|
19
25
|
/**
|
|
20
26
|
* Async iterator to auto-paginate over elements returned by list()
|
|
21
27
|
*
|
|
22
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
23
32
|
*/
|
|
24
33
|
listPagedIterator(queryParams: SimpleSchemaTypes.SearchResultInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SimpleSchemaTypes.SearchResult, void, unknown>;
|
|
25
34
|
/**
|
|
26
35
|
* Async iterator to auto-paginate over elements returned by rawList()
|
|
27
36
|
*
|
|
28
37
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/search-result/instances
|
|
38
|
+
*
|
|
39
|
+
* @throws {ApiError}
|
|
40
|
+
* @throws {TimeoutError}
|
|
29
41
|
*/
|
|
30
42
|
rawListPagedIterator(queryParams: SchemaTypes.SearchResultInstancesHrefSchema, iteratorOptions?: Utils.IteratorOptions): AsyncGenerator<SchemaTypes.SearchResult, void, unknown>;
|
|
31
43
|
}
|
|
@@ -8,6 +8,9 @@ export default class Session extends BaseResource {
|
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
|
|
10
10
|
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
13
|
+
*
|
|
11
14
|
* @deprecated This API call is to be considered private and might change without notice
|
|
12
15
|
*/
|
|
13
16
|
create(body: SimpleSchemaTypes.SessionCreateSchema): Promise<SimpleSchemaTypes.Session>;
|
|
@@ -16,6 +19,9 @@ export default class Session extends BaseResource {
|
|
|
16
19
|
*
|
|
17
20
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/session/create
|
|
18
21
|
*
|
|
22
|
+
* @throws {ApiError}
|
|
23
|
+
* @throws {TimeoutError}
|
|
24
|
+
*
|
|
19
25
|
* @deprecated This API call is to be considered private and might change without notice
|
|
20
26
|
*/
|
|
21
27
|
rawCreate(body: SchemaTypes.SessionCreateSchema): Promise<SchemaTypes.SessionCreateTargetSchema>;
|
|
@@ -7,36 +7,54 @@ export default class Site extends BaseResource {
|
|
|
7
7
|
* Retrieve the site
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
find(queryParams?: SimpleSchemaTypes.SiteSelfHrefSchema): Promise<SimpleSchemaTypes.Site>;
|
|
12
15
|
/**
|
|
13
16
|
* Retrieve the site
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawFind(queryParams?: SchemaTypes.SiteSelfHrefSchema): Promise<SchemaTypes.SiteSelfTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Update the site's settings
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
update(body: SimpleSchemaTypes.SiteUpdateSchema): Promise<SimpleSchemaTypes.Site>;
|
|
24
33
|
/**
|
|
25
34
|
* Update the site's settings
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawUpdate(body: SchemaTypes.SiteUpdateSchema): Promise<SchemaTypes.SiteUpdateJobSchema>;
|
|
30
42
|
/**
|
|
31
43
|
* Activate improved timezone management
|
|
32
44
|
*
|
|
33
45
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
|
|
46
|
+
*
|
|
47
|
+
* @throws {ApiError}
|
|
48
|
+
* @throws {TimeoutError}
|
|
34
49
|
*/
|
|
35
50
|
activateImprovedTimezoneManagement(): Promise<SimpleSchemaTypes.Site>;
|
|
36
51
|
/**
|
|
37
52
|
* Activate improved timezone management
|
|
38
53
|
*
|
|
39
54
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
|
|
55
|
+
*
|
|
56
|
+
* @throws {ApiError}
|
|
57
|
+
* @throws {TimeoutError}
|
|
40
58
|
*/
|
|
41
59
|
rawActivateImprovedTimezoneManagement(): Promise<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema>;
|
|
42
60
|
}
|
|
@@ -7,72 +7,108 @@ export default class SiteInvitation extends BaseResource {
|
|
|
7
7
|
* Invite a new user
|
|
8
8
|
*
|
|
9
9
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/create
|
|
10
|
+
*
|
|
11
|
+
* @throws {ApiError}
|
|
12
|
+
* @throws {TimeoutError}
|
|
10
13
|
*/
|
|
11
14
|
create(body: SimpleSchemaTypes.SiteInvitationCreateSchema): Promise<SimpleSchemaTypes.SiteInvitation>;
|
|
12
15
|
/**
|
|
13
16
|
* Invite a new user
|
|
14
17
|
*
|
|
15
18
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/create
|
|
19
|
+
*
|
|
20
|
+
* @throws {ApiError}
|
|
21
|
+
* @throws {TimeoutError}
|
|
16
22
|
*/
|
|
17
23
|
rawCreate(body: SchemaTypes.SiteInvitationCreateSchema): Promise<SchemaTypes.SiteInvitationCreateTargetSchema>;
|
|
18
24
|
/**
|
|
19
25
|
* Update an invitation
|
|
20
26
|
*
|
|
21
27
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/update
|
|
28
|
+
*
|
|
29
|
+
* @throws {ApiError}
|
|
30
|
+
* @throws {TimeoutError}
|
|
22
31
|
*/
|
|
23
32
|
update(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData, body: SimpleSchemaTypes.SiteInvitationUpdateSchema): Promise<SimpleSchemaTypes.SiteInvitation>;
|
|
24
33
|
/**
|
|
25
34
|
* Update an invitation
|
|
26
35
|
*
|
|
27
36
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/update
|
|
37
|
+
*
|
|
38
|
+
* @throws {ApiError}
|
|
39
|
+
* @throws {TimeoutError}
|
|
28
40
|
*/
|
|
29
41
|
rawUpdate(siteInvitationId: string, body: SchemaTypes.SiteInvitationUpdateSchema): Promise<SchemaTypes.SiteInvitationUpdateTargetSchema>;
|
|
30
42
|
/**
|
|
31
43
|
* List all invitations
|
|
32
44
|
*
|
|
33
45
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances
|
|
46
|
+
*
|
|
47
|
+
* @throws {ApiError}
|
|
48
|
+
* @throws {TimeoutError}
|
|
34
49
|
*/
|
|
35
50
|
list(): Promise<SimpleSchemaTypes.SiteInvitationInstancesTargetSchema>;
|
|
36
51
|
/**
|
|
37
52
|
* List all invitations
|
|
38
53
|
*
|
|
39
54
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances
|
|
55
|
+
*
|
|
56
|
+
* @throws {ApiError}
|
|
57
|
+
* @throws {TimeoutError}
|
|
40
58
|
*/
|
|
41
59
|
rawList(): Promise<SchemaTypes.SiteInvitationInstancesTargetSchema>;
|
|
42
60
|
/**
|
|
43
61
|
* Retrieve an invitation
|
|
44
62
|
*
|
|
45
63
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/self
|
|
64
|
+
*
|
|
65
|
+
* @throws {ApiError}
|
|
66
|
+
* @throws {TimeoutError}
|
|
46
67
|
*/
|
|
47
68
|
find(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData): Promise<SimpleSchemaTypes.SiteInvitation>;
|
|
48
69
|
/**
|
|
49
70
|
* Retrieve an invitation
|
|
50
71
|
*
|
|
51
72
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/self
|
|
73
|
+
*
|
|
74
|
+
* @throws {ApiError}
|
|
75
|
+
* @throws {TimeoutError}
|
|
52
76
|
*/
|
|
53
77
|
rawFind(siteInvitationId: string): Promise<SchemaTypes.SiteInvitationSelfTargetSchema>;
|
|
54
78
|
/**
|
|
55
79
|
* Delete an invitation
|
|
56
80
|
*
|
|
57
81
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy
|
|
82
|
+
*
|
|
83
|
+
* @throws {ApiError}
|
|
84
|
+
* @throws {TimeoutError}
|
|
58
85
|
*/
|
|
59
86
|
destroy(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData): Promise<SimpleSchemaTypes.SiteInvitation>;
|
|
60
87
|
/**
|
|
61
88
|
* Delete an invitation
|
|
62
89
|
*
|
|
63
90
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy
|
|
91
|
+
*
|
|
92
|
+
* @throws {ApiError}
|
|
93
|
+
* @throws {TimeoutError}
|
|
64
94
|
*/
|
|
65
95
|
rawDestroy(siteInvitationId: string): Promise<SchemaTypes.SiteInvitationDestroyTargetSchema>;
|
|
66
96
|
/**
|
|
67
97
|
* Resend an invitation
|
|
68
98
|
*
|
|
69
99
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend
|
|
100
|
+
*
|
|
101
|
+
* @throws {ApiError}
|
|
102
|
+
* @throws {TimeoutError}
|
|
70
103
|
*/
|
|
71
104
|
resend(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData): Promise<void>;
|
|
72
105
|
/**
|
|
73
106
|
* Resend an invitation
|
|
74
107
|
*
|
|
75
108
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend
|
|
109
|
+
*
|
|
110
|
+
* @throws {ApiError}
|
|
111
|
+
* @throws {TimeoutError}
|
|
76
112
|
*/
|
|
77
113
|
rawResend(siteInvitationId: string): Promise<void>;
|
|
78
114
|
}
|