@datocms/cma-client 1.1.2 → 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/generated/Client.d.ts +9 -0
- package/dist/esm/generated/Client.js.map +1 -1
- package/dist/esm/generated/SchemaTypes.d.ts +153 -40
- package/dist/esm/generated/SimpleSchemaTypes.d.ts +157 -36
- 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/generated/Client.d.ts +9 -0
- package/dist/types/generated/SchemaTypes.d.ts +153 -40
- package/dist/types/generated/SimpleSchemaTypes.d.ts +157 -36
- 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 +160 -41
- package/src/generated/SimpleSchemaTypes.ts +166 -37
- 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
|
@@ -10,6 +10,9 @@ export default class Site extends BaseResource {
|
|
|
10
10
|
* Retrieve the site
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
find(queryParams?: SimpleSchemaTypes.SiteSelfHrefSchema) {
|
|
15
18
|
return this.rawFind(queryParams).then((body) =>
|
|
@@ -23,6 +26,9 @@ export default class Site extends BaseResource {
|
|
|
23
26
|
* Retrieve the site
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/self
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawFind(
|
|
28
34
|
queryParams?: SchemaTypes.SiteSelfHrefSchema,
|
|
@@ -38,6 +44,9 @@ export default class Site extends BaseResource {
|
|
|
38
44
|
* Update the site's settings
|
|
39
45
|
*
|
|
40
46
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
|
|
47
|
+
*
|
|
48
|
+
* @throws {ApiError}
|
|
49
|
+
* @throws {TimeoutError}
|
|
41
50
|
*/
|
|
42
51
|
update(body: SimpleSchemaTypes.SiteUpdateSchema) {
|
|
43
52
|
return this.rawUpdate(
|
|
@@ -67,6 +76,9 @@ export default class Site extends BaseResource {
|
|
|
67
76
|
* Update the site's settings
|
|
68
77
|
*
|
|
69
78
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/update
|
|
79
|
+
*
|
|
80
|
+
* @throws {ApiError}
|
|
81
|
+
* @throws {TimeoutError}
|
|
70
82
|
*/
|
|
71
83
|
rawUpdate(
|
|
72
84
|
body: SchemaTypes.SiteUpdateSchema,
|
|
@@ -82,6 +94,9 @@ export default class Site extends BaseResource {
|
|
|
82
94
|
* Activate improved timezone management
|
|
83
95
|
*
|
|
84
96
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
|
|
97
|
+
*
|
|
98
|
+
* @throws {ApiError}
|
|
99
|
+
* @throws {TimeoutError}
|
|
85
100
|
*/
|
|
86
101
|
activateImprovedTimezoneManagement() {
|
|
87
102
|
return this.rawActivateImprovedTimezoneManagement().then((body) =>
|
|
@@ -95,6 +110,9 @@ export default class Site extends BaseResource {
|
|
|
95
110
|
* Activate improved timezone management
|
|
96
111
|
*
|
|
97
112
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_improved_timezone_management
|
|
113
|
+
*
|
|
114
|
+
* @throws {ApiError}
|
|
115
|
+
* @throws {TimeoutError}
|
|
98
116
|
*/
|
|
99
117
|
rawActivateImprovedTimezoneManagement(): Promise<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema> {
|
|
100
118
|
return this.client.request<SchemaTypes.SiteActivateImprovedTimezoneManagementJobSchema>(
|
|
@@ -10,6 +10,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
10
10
|
* Invite a new user
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/create
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
create(body: SimpleSchemaTypes.SiteInvitationCreateSchema) {
|
|
15
18
|
return this.rawCreate(
|
|
@@ -29,6 +32,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
29
32
|
* Invite a new user
|
|
30
33
|
*
|
|
31
34
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/create
|
|
35
|
+
*
|
|
36
|
+
* @throws {ApiError}
|
|
37
|
+
* @throws {TimeoutError}
|
|
32
38
|
*/
|
|
33
39
|
rawCreate(
|
|
34
40
|
body: SchemaTypes.SiteInvitationCreateSchema,
|
|
@@ -44,6 +50,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
44
50
|
* Update an invitation
|
|
45
51
|
*
|
|
46
52
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/update
|
|
53
|
+
*
|
|
54
|
+
* @throws {ApiError}
|
|
55
|
+
* @throws {TimeoutError}
|
|
47
56
|
*/
|
|
48
57
|
update(
|
|
49
58
|
siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData,
|
|
@@ -68,6 +77,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
68
77
|
* Update an invitation
|
|
69
78
|
*
|
|
70
79
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/update
|
|
80
|
+
*
|
|
81
|
+
* @throws {ApiError}
|
|
82
|
+
* @throws {TimeoutError}
|
|
71
83
|
*/
|
|
72
84
|
rawUpdate(
|
|
73
85
|
siteInvitationId: string,
|
|
@@ -84,6 +96,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
84
96
|
* List all invitations
|
|
85
97
|
*
|
|
86
98
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances
|
|
99
|
+
*
|
|
100
|
+
* @throws {ApiError}
|
|
101
|
+
* @throws {TimeoutError}
|
|
87
102
|
*/
|
|
88
103
|
list() {
|
|
89
104
|
return this.rawList().then((body) =>
|
|
@@ -97,6 +112,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
97
112
|
* List all invitations
|
|
98
113
|
*
|
|
99
114
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/instances
|
|
115
|
+
*
|
|
116
|
+
* @throws {ApiError}
|
|
117
|
+
* @throws {TimeoutError}
|
|
100
118
|
*/
|
|
101
119
|
rawList(): Promise<SchemaTypes.SiteInvitationInstancesTargetSchema> {
|
|
102
120
|
return this.client.request<SchemaTypes.SiteInvitationInstancesTargetSchema>(
|
|
@@ -111,6 +129,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
111
129
|
* Retrieve an invitation
|
|
112
130
|
*
|
|
113
131
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/self
|
|
132
|
+
*
|
|
133
|
+
* @throws {ApiError}
|
|
134
|
+
* @throws {TimeoutError}
|
|
114
135
|
*/
|
|
115
136
|
find(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData) {
|
|
116
137
|
return this.rawFind(Utils.toId(siteInvitationId)).then((body) =>
|
|
@@ -124,6 +145,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
124
145
|
* Retrieve an invitation
|
|
125
146
|
*
|
|
126
147
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/self
|
|
148
|
+
*
|
|
149
|
+
* @throws {ApiError}
|
|
150
|
+
* @throws {TimeoutError}
|
|
127
151
|
*/
|
|
128
152
|
rawFind(
|
|
129
153
|
siteInvitationId: string,
|
|
@@ -138,6 +162,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
138
162
|
* Delete an invitation
|
|
139
163
|
*
|
|
140
164
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy
|
|
165
|
+
*
|
|
166
|
+
* @throws {ApiError}
|
|
167
|
+
* @throws {TimeoutError}
|
|
141
168
|
*/
|
|
142
169
|
destroy(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData) {
|
|
143
170
|
return this.rawDestroy(Utils.toId(siteInvitationId)).then((body) =>
|
|
@@ -151,6 +178,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
151
178
|
* Delete an invitation
|
|
152
179
|
*
|
|
153
180
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/destroy
|
|
181
|
+
*
|
|
182
|
+
* @throws {ApiError}
|
|
183
|
+
* @throws {TimeoutError}
|
|
154
184
|
*/
|
|
155
185
|
rawDestroy(
|
|
156
186
|
siteInvitationId: string,
|
|
@@ -165,6 +195,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
165
195
|
* Resend an invitation
|
|
166
196
|
*
|
|
167
197
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend
|
|
198
|
+
*
|
|
199
|
+
* @throws {ApiError}
|
|
200
|
+
* @throws {TimeoutError}
|
|
168
201
|
*/
|
|
169
202
|
resend(siteInvitationId: string | SimpleSchemaTypes.SiteInvitationData) {
|
|
170
203
|
return this.rawResend(Utils.toId(siteInvitationId));
|
|
@@ -174,6 +207,9 @@ export default class SiteInvitation extends BaseResource {
|
|
|
174
207
|
* Resend an invitation
|
|
175
208
|
*
|
|
176
209
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/site-invitation/resend
|
|
210
|
+
*
|
|
211
|
+
* @throws {ApiError}
|
|
212
|
+
* @throws {TimeoutError}
|
|
177
213
|
*/
|
|
178
214
|
rawResend(siteInvitationId: string): Promise<void> {
|
|
179
215
|
return this.client.request<void>({
|
|
@@ -10,6 +10,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
10
10
|
* List all SSO groups
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/instances
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
list() {
|
|
15
18
|
return this.rawList().then((body) =>
|
|
@@ -23,6 +26,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
23
26
|
* List all SSO groups
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawList(): Promise<SchemaTypes.SsoGroupInstancesTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.SsoGroupInstancesTargetSchema>({
|
|
@@ -35,6 +41,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
35
41
|
* Sync SSO provider groups to DatoCMS roles
|
|
36
42
|
*
|
|
37
43
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/copy_roles
|
|
44
|
+
*
|
|
45
|
+
* @throws {ApiError}
|
|
46
|
+
* @throws {TimeoutError}
|
|
38
47
|
*/
|
|
39
48
|
copyRoles(ssoGroupId: string | SimpleSchemaTypes.SsoGroupData) {
|
|
40
49
|
return this.rawCopyRoles(Utils.toId(ssoGroupId)).then((body) =>
|
|
@@ -48,6 +57,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
48
57
|
* Sync SSO provider groups to DatoCMS roles
|
|
49
58
|
*
|
|
50
59
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/copy_roles
|
|
60
|
+
*
|
|
61
|
+
* @throws {ApiError}
|
|
62
|
+
* @throws {TimeoutError}
|
|
51
63
|
*/
|
|
52
64
|
rawCopyRoles(
|
|
53
65
|
ssoGroupId: string,
|
|
@@ -62,6 +74,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
62
74
|
* Update a SSO group
|
|
63
75
|
*
|
|
64
76
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/update
|
|
77
|
+
*
|
|
78
|
+
* @throws {ApiError}
|
|
79
|
+
* @throws {TimeoutError}
|
|
65
80
|
*/
|
|
66
81
|
update(
|
|
67
82
|
ssoGroupId: string | SimpleSchemaTypes.SsoGroupData,
|
|
@@ -86,6 +101,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
86
101
|
* Update a SSO group
|
|
87
102
|
*
|
|
88
103
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/update
|
|
104
|
+
*
|
|
105
|
+
* @throws {ApiError}
|
|
106
|
+
* @throws {TimeoutError}
|
|
89
107
|
*/
|
|
90
108
|
rawUpdate(
|
|
91
109
|
ssoGroupId: string,
|
|
@@ -102,6 +120,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
102
120
|
* Delete a group
|
|
103
121
|
*
|
|
104
122
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/destroy
|
|
123
|
+
*
|
|
124
|
+
* @throws {ApiError}
|
|
125
|
+
* @throws {TimeoutError}
|
|
105
126
|
*/
|
|
106
127
|
destroy(ssoGroupId: string | SimpleSchemaTypes.SsoGroupData) {
|
|
107
128
|
return this.rawDestroy(Utils.toId(ssoGroupId)).then((body) =>
|
|
@@ -115,6 +136,9 @@ export default class SsoGroup extends BaseResource {
|
|
|
115
136
|
* Delete a group
|
|
116
137
|
*
|
|
117
138
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-group/destroy
|
|
139
|
+
*
|
|
140
|
+
* @throws {ApiError}
|
|
141
|
+
* @throws {TimeoutError}
|
|
118
142
|
*/
|
|
119
143
|
rawDestroy(
|
|
120
144
|
ssoGroupId: string,
|
|
@@ -10,6 +10,9 @@ export default class SsoSettings extends BaseResource {
|
|
|
10
10
|
* Retrieve SSO Settings
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/self
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
find() {
|
|
15
18
|
return this.rawFind().then((body) =>
|
|
@@ -23,6 +26,9 @@ export default class SsoSettings extends BaseResource {
|
|
|
23
26
|
* Retrieve SSO Settings
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/self
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawFind(): Promise<SchemaTypes.SsoSettingsSelfTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.SsoSettingsSelfTargetSchema>({
|
|
@@ -35,6 +41,9 @@ export default class SsoSettings extends BaseResource {
|
|
|
35
41
|
* Generate SSO token
|
|
36
42
|
*
|
|
37
43
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/generate_token
|
|
44
|
+
*
|
|
45
|
+
* @throws {ApiError}
|
|
46
|
+
* @throws {TimeoutError}
|
|
38
47
|
*/
|
|
39
48
|
generateToken() {
|
|
40
49
|
return this.rawGenerateToken().then((body) =>
|
|
@@ -48,6 +57,9 @@ export default class SsoSettings extends BaseResource {
|
|
|
48
57
|
* Generate SSO token
|
|
49
58
|
*
|
|
50
59
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/generate_token
|
|
60
|
+
*
|
|
61
|
+
* @throws {ApiError}
|
|
62
|
+
* @throws {TimeoutError}
|
|
51
63
|
*/
|
|
52
64
|
rawGenerateToken(): Promise<SchemaTypes.SsoSettingsGenerateTokenTargetSchema> {
|
|
53
65
|
return this.client.request<SchemaTypes.SsoSettingsGenerateTokenTargetSchema>(
|
|
@@ -62,6 +74,9 @@ export default class SsoSettings extends BaseResource {
|
|
|
62
74
|
* Update SSO Settings
|
|
63
75
|
*
|
|
64
76
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/update
|
|
77
|
+
*
|
|
78
|
+
* @throws {ApiError}
|
|
79
|
+
* @throws {TimeoutError}
|
|
65
80
|
*/
|
|
66
81
|
update(body: SimpleSchemaTypes.SsoSettingsUpdateSchema) {
|
|
67
82
|
return this.rawUpdate(
|
|
@@ -81,6 +96,9 @@ export default class SsoSettings extends BaseResource {
|
|
|
81
96
|
* Update SSO Settings
|
|
82
97
|
*
|
|
83
98
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-settings/update
|
|
99
|
+
*
|
|
100
|
+
* @throws {ApiError}
|
|
101
|
+
* @throws {TimeoutError}
|
|
84
102
|
*/
|
|
85
103
|
rawUpdate(
|
|
86
104
|
body: SchemaTypes.SsoSettingsUpdateSchema,
|
|
@@ -10,6 +10,9 @@ export default class SsoUser extends BaseResource {
|
|
|
10
10
|
* List all users
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/instances
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
list() {
|
|
15
18
|
return this.rawList().then((body) =>
|
|
@@ -23,6 +26,9 @@ export default class SsoUser extends BaseResource {
|
|
|
23
26
|
* List all users
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawList(): Promise<SchemaTypes.SsoUserInstancesTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.SsoUserInstancesTargetSchema>({
|
|
@@ -35,6 +41,9 @@ export default class SsoUser extends BaseResource {
|
|
|
35
41
|
* Returns a SSO user
|
|
36
42
|
*
|
|
37
43
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/self
|
|
44
|
+
*
|
|
45
|
+
* @throws {ApiError}
|
|
46
|
+
* @throws {TimeoutError}
|
|
38
47
|
*/
|
|
39
48
|
find(userId: string | SimpleSchemaTypes.UserData) {
|
|
40
49
|
return this.rawFind(Utils.toId(userId)).then((body) =>
|
|
@@ -48,6 +57,9 @@ export default class SsoUser extends BaseResource {
|
|
|
48
57
|
* Returns a SSO user
|
|
49
58
|
*
|
|
50
59
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/self
|
|
60
|
+
*
|
|
61
|
+
* @throws {ApiError}
|
|
62
|
+
* @throws {TimeoutError}
|
|
51
63
|
*/
|
|
52
64
|
rawFind(userId: string): Promise<SchemaTypes.SsoUserSelfTargetSchema> {
|
|
53
65
|
return this.client.request<SchemaTypes.SsoUserSelfTargetSchema>({
|
|
@@ -60,6 +72,9 @@ export default class SsoUser extends BaseResource {
|
|
|
60
72
|
* Copy editors as SSO users
|
|
61
73
|
*
|
|
62
74
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users
|
|
75
|
+
*
|
|
76
|
+
* @throws {ApiError}
|
|
77
|
+
* @throws {TimeoutError}
|
|
63
78
|
*/
|
|
64
79
|
copyUsers() {
|
|
65
80
|
return this.rawCopyUsers().then((body) =>
|
|
@@ -73,6 +88,9 @@ export default class SsoUser extends BaseResource {
|
|
|
73
88
|
* Copy editors as SSO users
|
|
74
89
|
*
|
|
75
90
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/copy_users
|
|
91
|
+
*
|
|
92
|
+
* @throws {ApiError}
|
|
93
|
+
* @throws {TimeoutError}
|
|
76
94
|
*/
|
|
77
95
|
rawCopyUsers(): Promise<SchemaTypes.SsoUserCopyUsersTargetSchema> {
|
|
78
96
|
return this.client.request<SchemaTypes.SsoUserCopyUsersTargetSchema>({
|
|
@@ -85,6 +103,9 @@ export default class SsoUser extends BaseResource {
|
|
|
85
103
|
* Delete a SSO user
|
|
86
104
|
*
|
|
87
105
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy
|
|
106
|
+
*
|
|
107
|
+
* @throws {ApiError}
|
|
108
|
+
* @throws {TimeoutError}
|
|
88
109
|
*/
|
|
89
110
|
destroy(
|
|
90
111
|
userId: string | SimpleSchemaTypes.UserData,
|
|
@@ -101,6 +122,9 @@ export default class SsoUser extends BaseResource {
|
|
|
101
122
|
* Delete a SSO user
|
|
102
123
|
*
|
|
103
124
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/sso-user/destroy
|
|
125
|
+
*
|
|
126
|
+
* @throws {ApiError}
|
|
127
|
+
* @throws {TimeoutError}
|
|
104
128
|
*/
|
|
105
129
|
rawDestroy(
|
|
106
130
|
userId: string,
|
|
@@ -10,6 +10,9 @@ export default class SubscriptionFeature extends BaseResource {
|
|
|
10
10
|
* Get all the subscription features
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-feature/instances
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
list() {
|
|
15
18
|
return this.rawList().then((body) =>
|
|
@@ -23,6 +26,9 @@ export default class SubscriptionFeature extends BaseResource {
|
|
|
23
26
|
* Get all the subscription features
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-feature/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawList(): Promise<SchemaTypes.SubscriptionFeatureInstancesTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.SubscriptionFeatureInstancesTargetSchema>(
|
|
@@ -10,6 +10,9 @@ export default class SubscriptionLimit extends BaseResource {
|
|
|
10
10
|
* Get all the subscription limits
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/instances
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
list() {
|
|
15
18
|
return this.rawList().then((body) =>
|
|
@@ -23,6 +26,9 @@ export default class SubscriptionLimit extends BaseResource {
|
|
|
23
26
|
* Get all the subscription limits
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawList(): Promise<SchemaTypes.SubscriptionLimitInstancesTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.SubscriptionLimitInstancesTargetSchema>(
|
|
@@ -37,6 +43,9 @@ export default class SubscriptionLimit extends BaseResource {
|
|
|
37
43
|
* Get a single subscription limit
|
|
38
44
|
*
|
|
39
45
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/self
|
|
46
|
+
*
|
|
47
|
+
* @throws {ApiError}
|
|
48
|
+
* @throws {TimeoutError}
|
|
40
49
|
*/
|
|
41
50
|
find(subscriptionLimitId: string | SimpleSchemaTypes.SubscriptionLimitData) {
|
|
42
51
|
return this.rawFind(Utils.toId(subscriptionLimitId)).then((body) =>
|
|
@@ -50,6 +59,9 @@ export default class SubscriptionLimit extends BaseResource {
|
|
|
50
59
|
* Get a single subscription limit
|
|
51
60
|
*
|
|
52
61
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/subscription-limit/self
|
|
62
|
+
*
|
|
63
|
+
* @throws {ApiError}
|
|
64
|
+
* @throws {TimeoutError}
|
|
53
65
|
*/
|
|
54
66
|
rawFind(
|
|
55
67
|
subscriptionLimitId: string,
|
|
@@ -10,6 +10,9 @@ export default class Upload extends BaseResource {
|
|
|
10
10
|
* Create a new upload
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/create
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
create(body: SimpleSchemaTypes.UploadCreateSchema) {
|
|
15
18
|
return this.rawCreate(
|
|
@@ -36,6 +39,9 @@ export default class Upload extends BaseResource {
|
|
|
36
39
|
* Create a new upload
|
|
37
40
|
*
|
|
38
41
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/create
|
|
42
|
+
*
|
|
43
|
+
* @throws {ApiError}
|
|
44
|
+
* @throws {TimeoutError}
|
|
39
45
|
*/
|
|
40
46
|
rawCreate(
|
|
41
47
|
body: SchemaTypes.UploadCreateSchema,
|
|
@@ -51,6 +57,9 @@ export default class Upload extends BaseResource {
|
|
|
51
57
|
* List all uploads
|
|
52
58
|
*
|
|
53
59
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
|
|
60
|
+
*
|
|
61
|
+
* @throws {ApiError}
|
|
62
|
+
* @throws {TimeoutError}
|
|
54
63
|
*/
|
|
55
64
|
list(queryParams?: SimpleSchemaTypes.UploadInstancesHrefSchema) {
|
|
56
65
|
return this.rawList(queryParams).then((body) =>
|
|
@@ -64,6 +73,9 @@ export default class Upload extends BaseResource {
|
|
|
64
73
|
* List all uploads
|
|
65
74
|
*
|
|
66
75
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
|
|
76
|
+
*
|
|
77
|
+
* @throws {ApiError}
|
|
78
|
+
* @throws {TimeoutError}
|
|
67
79
|
*/
|
|
68
80
|
rawList(
|
|
69
81
|
queryParams?: SchemaTypes.UploadInstancesHrefSchema,
|
|
@@ -79,6 +91,9 @@ export default class Upload extends BaseResource {
|
|
|
79
91
|
* Async iterator to auto-paginate over elements returned by list()
|
|
80
92
|
*
|
|
81
93
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
|
|
94
|
+
*
|
|
95
|
+
* @throws {ApiError}
|
|
96
|
+
* @throws {TimeoutError}
|
|
82
97
|
*/
|
|
83
98
|
async *listPagedIterator(
|
|
84
99
|
queryParams?: SimpleSchemaTypes.UploadInstancesHrefSchema,
|
|
@@ -98,6 +113,9 @@ export default class Upload extends BaseResource {
|
|
|
98
113
|
* Async iterator to auto-paginate over elements returned by rawList()
|
|
99
114
|
*
|
|
100
115
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/instances
|
|
116
|
+
*
|
|
117
|
+
* @throws {ApiError}
|
|
118
|
+
* @throws {TimeoutError}
|
|
101
119
|
*/
|
|
102
120
|
rawListPagedIterator(
|
|
103
121
|
queryParams?: SchemaTypes.UploadInstancesHrefSchema,
|
|
@@ -120,6 +138,9 @@ export default class Upload extends BaseResource {
|
|
|
120
138
|
* Retrieve an upload
|
|
121
139
|
*
|
|
122
140
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/self
|
|
141
|
+
*
|
|
142
|
+
* @throws {ApiError}
|
|
143
|
+
* @throws {TimeoutError}
|
|
123
144
|
*/
|
|
124
145
|
find(uploadId: string | SimpleSchemaTypes.UploadData) {
|
|
125
146
|
return this.rawFind(Utils.toId(uploadId)).then((body) =>
|
|
@@ -133,6 +154,9 @@ export default class Upload extends BaseResource {
|
|
|
133
154
|
* Retrieve an upload
|
|
134
155
|
*
|
|
135
156
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/self
|
|
157
|
+
*
|
|
158
|
+
* @throws {ApiError}
|
|
159
|
+
* @throws {TimeoutError}
|
|
136
160
|
*/
|
|
137
161
|
rawFind(uploadId: string): Promise<SchemaTypes.UploadSelfTargetSchema> {
|
|
138
162
|
return this.client.request<SchemaTypes.UploadSelfTargetSchema>({
|
|
@@ -145,6 +169,9 @@ export default class Upload extends BaseResource {
|
|
|
145
169
|
* Delete an upload
|
|
146
170
|
*
|
|
147
171
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/destroy
|
|
172
|
+
*
|
|
173
|
+
* @throws {ApiError}
|
|
174
|
+
* @throws {TimeoutError}
|
|
148
175
|
*/
|
|
149
176
|
destroy(uploadId: string | SimpleSchemaTypes.UploadData) {
|
|
150
177
|
return this.rawDestroy(Utils.toId(uploadId)).then((body) =>
|
|
@@ -158,6 +185,9 @@ export default class Upload extends BaseResource {
|
|
|
158
185
|
* Delete an upload
|
|
159
186
|
*
|
|
160
187
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/destroy
|
|
188
|
+
*
|
|
189
|
+
* @throws {ApiError}
|
|
190
|
+
* @throws {TimeoutError}
|
|
161
191
|
*/
|
|
162
192
|
rawDestroy(uploadId: string): Promise<SchemaTypes.UploadDestroyTargetSchema> {
|
|
163
193
|
return this.client.request<SchemaTypes.UploadDestroyTargetSchema>({
|
|
@@ -170,6 +200,9 @@ export default class Upload extends BaseResource {
|
|
|
170
200
|
* Update an upload
|
|
171
201
|
*
|
|
172
202
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/update
|
|
203
|
+
*
|
|
204
|
+
* @throws {ApiError}
|
|
205
|
+
* @throws {TimeoutError}
|
|
173
206
|
*/
|
|
174
207
|
update(
|
|
175
208
|
uploadId: string | SimpleSchemaTypes.UploadData,
|
|
@@ -202,6 +235,9 @@ export default class Upload extends BaseResource {
|
|
|
202
235
|
* Update an upload
|
|
203
236
|
*
|
|
204
237
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/update
|
|
238
|
+
*
|
|
239
|
+
* @throws {ApiError}
|
|
240
|
+
* @throws {TimeoutError}
|
|
205
241
|
*/
|
|
206
242
|
rawUpdate(
|
|
207
243
|
uploadId: string,
|
|
@@ -219,6 +255,9 @@ export default class Upload extends BaseResource {
|
|
|
219
255
|
*
|
|
220
256
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_add_tags
|
|
221
257
|
*
|
|
258
|
+
* @throws {ApiError}
|
|
259
|
+
* @throws {TimeoutError}
|
|
260
|
+
*
|
|
222
261
|
* @deprecated This API call is to be considered private and might change without notice
|
|
223
262
|
*/
|
|
224
263
|
batchAddTags(
|
|
@@ -244,6 +283,9 @@ export default class Upload extends BaseResource {
|
|
|
244
283
|
*
|
|
245
284
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_add_tags
|
|
246
285
|
*
|
|
286
|
+
* @throws {ApiError}
|
|
287
|
+
* @throws {TimeoutError}
|
|
288
|
+
*
|
|
247
289
|
* @deprecated This API call is to be considered private and might change without notice
|
|
248
290
|
*/
|
|
249
291
|
rawBatchAddTags(
|
|
@@ -263,6 +305,9 @@ export default class Upload extends BaseResource {
|
|
|
263
305
|
*
|
|
264
306
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_destroy
|
|
265
307
|
*
|
|
308
|
+
* @throws {ApiError}
|
|
309
|
+
* @throws {TimeoutError}
|
|
310
|
+
*
|
|
266
311
|
* @deprecated This API call is to be considered private and might change without notice
|
|
267
312
|
*/
|
|
268
313
|
batchDestroy(queryParams?: SimpleSchemaTypes.UploadBatchDestroyHrefSchema) {
|
|
@@ -278,6 +323,9 @@ export default class Upload extends BaseResource {
|
|
|
278
323
|
*
|
|
279
324
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/batch_destroy
|
|
280
325
|
*
|
|
326
|
+
* @throws {ApiError}
|
|
327
|
+
* @throws {TimeoutError}
|
|
328
|
+
*
|
|
281
329
|
* @deprecated This API call is to be considered private and might change without notice
|
|
282
330
|
*/
|
|
283
331
|
rawBatchDestroy(
|
|
@@ -294,6 +342,9 @@ export default class Upload extends BaseResource {
|
|
|
294
342
|
* Referenced records
|
|
295
343
|
*
|
|
296
344
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/references
|
|
345
|
+
*
|
|
346
|
+
* @throws {ApiError}
|
|
347
|
+
* @throws {TimeoutError}
|
|
297
348
|
*/
|
|
298
349
|
references(
|
|
299
350
|
uploadId: string | SimpleSchemaTypes.UploadData,
|
|
@@ -310,6 +361,9 @@ export default class Upload extends BaseResource {
|
|
|
310
361
|
* Referenced records
|
|
311
362
|
*
|
|
312
363
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/references
|
|
364
|
+
*
|
|
365
|
+
* @throws {ApiError}
|
|
366
|
+
* @throws {TimeoutError}
|
|
313
367
|
*/
|
|
314
368
|
rawReferences(
|
|
315
369
|
uploadId: string,
|
|
@@ -326,6 +380,9 @@ export default class Upload extends BaseResource {
|
|
|
326
380
|
* Add tags to assets in bulk
|
|
327
381
|
*
|
|
328
382
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_tag
|
|
383
|
+
*
|
|
384
|
+
* @throws {ApiError}
|
|
385
|
+
* @throws {TimeoutError}
|
|
329
386
|
*/
|
|
330
387
|
bulkTag(body: SimpleSchemaTypes.UploadBulkTagSchema) {
|
|
331
388
|
return this.rawBulkTag(
|
|
@@ -345,6 +402,9 @@ export default class Upload extends BaseResource {
|
|
|
345
402
|
* Add tags to assets in bulk
|
|
346
403
|
*
|
|
347
404
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_tag
|
|
405
|
+
*
|
|
406
|
+
* @throws {ApiError}
|
|
407
|
+
* @throws {TimeoutError}
|
|
348
408
|
*/
|
|
349
409
|
rawBulkTag(
|
|
350
410
|
body: SchemaTypes.UploadBulkTagSchema,
|
|
@@ -360,6 +420,9 @@ export default class Upload extends BaseResource {
|
|
|
360
420
|
* Destroy uploads
|
|
361
421
|
*
|
|
362
422
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy
|
|
423
|
+
*
|
|
424
|
+
* @throws {ApiError}
|
|
425
|
+
* @throws {TimeoutError}
|
|
363
426
|
*/
|
|
364
427
|
bulkDestroy(body: SimpleSchemaTypes.UploadBulkDestroySchema) {
|
|
365
428
|
return this.rawBulkDestroy(
|
|
@@ -379,6 +442,9 @@ export default class Upload extends BaseResource {
|
|
|
379
442
|
* Destroy uploads
|
|
380
443
|
*
|
|
381
444
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/upload/bulk_destroy
|
|
445
|
+
*
|
|
446
|
+
* @throws {ApiError}
|
|
447
|
+
* @throws {TimeoutError}
|
|
382
448
|
*/
|
|
383
449
|
rawBulkDestroy(
|
|
384
450
|
body: SchemaTypes.UploadBulkDestroySchema,
|