@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 AccessToken extends BaseResource {
|
|
|
10
10
|
* Create a new API token
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/create
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
create(body: SimpleSchemaTypes.AccessTokenCreateSchema) {
|
|
15
18
|
return this.rawCreate(
|
|
@@ -34,6 +37,9 @@ export default class AccessToken extends BaseResource {
|
|
|
34
37
|
* Create a new API token
|
|
35
38
|
*
|
|
36
39
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/create
|
|
40
|
+
*
|
|
41
|
+
* @throws {ApiError}
|
|
42
|
+
* @throws {TimeoutError}
|
|
37
43
|
*/
|
|
38
44
|
rawCreate(
|
|
39
45
|
body: SchemaTypes.AccessTokenCreateSchema,
|
|
@@ -49,6 +55,9 @@ export default class AccessToken extends BaseResource {
|
|
|
49
55
|
* Update an API token
|
|
50
56
|
*
|
|
51
57
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/update
|
|
58
|
+
*
|
|
59
|
+
* @throws {ApiError}
|
|
60
|
+
* @throws {TimeoutError}
|
|
52
61
|
*/
|
|
53
62
|
update(
|
|
54
63
|
accessTokenId: string | SimpleSchemaTypes.AccessTokenData,
|
|
@@ -78,6 +87,9 @@ export default class AccessToken extends BaseResource {
|
|
|
78
87
|
* Update an API token
|
|
79
88
|
*
|
|
80
89
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/update
|
|
90
|
+
*
|
|
91
|
+
* @throws {ApiError}
|
|
92
|
+
* @throws {TimeoutError}
|
|
81
93
|
*/
|
|
82
94
|
rawUpdate(
|
|
83
95
|
accessTokenId: string,
|
|
@@ -94,6 +106,9 @@ export default class AccessToken extends BaseResource {
|
|
|
94
106
|
* List all API tokens
|
|
95
107
|
*
|
|
96
108
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/instances
|
|
109
|
+
*
|
|
110
|
+
* @throws {ApiError}
|
|
111
|
+
* @throws {TimeoutError}
|
|
97
112
|
*/
|
|
98
113
|
list() {
|
|
99
114
|
return this.rawList().then((body) =>
|
|
@@ -107,6 +122,9 @@ export default class AccessToken extends BaseResource {
|
|
|
107
122
|
* List all API tokens
|
|
108
123
|
*
|
|
109
124
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/instances
|
|
125
|
+
*
|
|
126
|
+
* @throws {ApiError}
|
|
127
|
+
* @throws {TimeoutError}
|
|
110
128
|
*/
|
|
111
129
|
rawList(): Promise<SchemaTypes.AccessTokenInstancesTargetSchema> {
|
|
112
130
|
return this.client.request<SchemaTypes.AccessTokenInstancesTargetSchema>({
|
|
@@ -119,6 +137,9 @@ export default class AccessToken extends BaseResource {
|
|
|
119
137
|
* Retrieve an API token
|
|
120
138
|
*
|
|
121
139
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/self
|
|
140
|
+
*
|
|
141
|
+
* @throws {ApiError}
|
|
142
|
+
* @throws {TimeoutError}
|
|
122
143
|
*/
|
|
123
144
|
find(accessTokenId: string | SimpleSchemaTypes.AccessTokenData) {
|
|
124
145
|
return this.rawFind(Utils.toId(accessTokenId)).then((body) =>
|
|
@@ -132,6 +153,9 @@ export default class AccessToken extends BaseResource {
|
|
|
132
153
|
* Retrieve an API token
|
|
133
154
|
*
|
|
134
155
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/self
|
|
156
|
+
*
|
|
157
|
+
* @throws {ApiError}
|
|
158
|
+
* @throws {TimeoutError}
|
|
135
159
|
*/
|
|
136
160
|
rawFind(
|
|
137
161
|
accessTokenId: string,
|
|
@@ -146,6 +170,9 @@ export default class AccessToken extends BaseResource {
|
|
|
146
170
|
* Rotate API token
|
|
147
171
|
*
|
|
148
172
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token
|
|
173
|
+
*
|
|
174
|
+
* @throws {ApiError}
|
|
175
|
+
* @throws {TimeoutError}
|
|
149
176
|
*/
|
|
150
177
|
regenerateToken(accessTokenId: string | SimpleSchemaTypes.AccessTokenData) {
|
|
151
178
|
return this.rawRegenerateToken(Utils.toId(accessTokenId)).then((body) =>
|
|
@@ -159,6 +186,9 @@ export default class AccessToken extends BaseResource {
|
|
|
159
186
|
* Rotate API token
|
|
160
187
|
*
|
|
161
188
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/regenerate_token
|
|
189
|
+
*
|
|
190
|
+
* @throws {ApiError}
|
|
191
|
+
* @throws {TimeoutError}
|
|
162
192
|
*/
|
|
163
193
|
rawRegenerateToken(
|
|
164
194
|
accessTokenId: string,
|
|
@@ -175,6 +205,9 @@ export default class AccessToken extends BaseResource {
|
|
|
175
205
|
* Delete an API token
|
|
176
206
|
*
|
|
177
207
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/destroy
|
|
208
|
+
*
|
|
209
|
+
* @throws {ApiError}
|
|
210
|
+
* @throws {TimeoutError}
|
|
178
211
|
*/
|
|
179
212
|
destroy(
|
|
180
213
|
accessTokenId: string | SimpleSchemaTypes.AccessTokenData,
|
|
@@ -192,6 +225,9 @@ export default class AccessToken extends BaseResource {
|
|
|
192
225
|
* Delete an API token
|
|
193
226
|
*
|
|
194
227
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/access-token/destroy
|
|
228
|
+
*
|
|
229
|
+
* @throws {ApiError}
|
|
230
|
+
* @throws {TimeoutError}
|
|
195
231
|
*/
|
|
196
232
|
rawDestroy(
|
|
197
233
|
accessTokenId: string,
|
|
@@ -10,6 +10,9 @@ export default class AuditLogEvent extends BaseResource {
|
|
|
10
10
|
* List Audit Log events
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
query(body: SimpleSchemaTypes.AuditLogEventQuerySchema) {
|
|
15
18
|
return this.rawQuery(
|
|
@@ -29,6 +32,9 @@ export default class AuditLogEvent extends BaseResource {
|
|
|
29
32
|
* List Audit Log events
|
|
30
33
|
*
|
|
31
34
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/audit-log_event/query
|
|
35
|
+
*
|
|
36
|
+
* @throws {ApiError}
|
|
37
|
+
* @throws {TimeoutError}
|
|
32
38
|
*/
|
|
33
39
|
rawQuery(
|
|
34
40
|
body: SchemaTypes.AuditLogEventQuerySchema,
|
|
@@ -10,6 +10,9 @@ export default class BuildEvent extends BaseResource {
|
|
|
10
10
|
* List all deploy events
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/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 BuildEvent extends BaseResource {
|
|
|
23
26
|
* List all deploy events
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawList(): Promise<SchemaTypes.BuildEventInstancesTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.BuildEventInstancesTargetSchema>({
|
|
@@ -35,6 +41,9 @@ export default class BuildEvent extends BaseResource {
|
|
|
35
41
|
* Retrieve a deploy event
|
|
36
42
|
*
|
|
37
43
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
|
|
44
|
+
*
|
|
45
|
+
* @throws {ApiError}
|
|
46
|
+
* @throws {TimeoutError}
|
|
38
47
|
*/
|
|
39
48
|
find(buildEventId: string | SimpleSchemaTypes.BuildEventData) {
|
|
40
49
|
return this.rawFind(Utils.toId(buildEventId)).then((body) =>
|
|
@@ -48,6 +57,9 @@ export default class BuildEvent extends BaseResource {
|
|
|
48
57
|
* Retrieve a deploy event
|
|
49
58
|
*
|
|
50
59
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-event/self
|
|
60
|
+
*
|
|
61
|
+
* @throws {ApiError}
|
|
62
|
+
* @throws {TimeoutError}
|
|
51
63
|
*/
|
|
52
64
|
rawFind(
|
|
53
65
|
buildEventId: string,
|
|
@@ -10,6 +10,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
10
10
|
* List all build triggers for a site
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/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 BuildTrigger extends BaseResource {
|
|
|
23
26
|
* List all build triggers for a site
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawList(): Promise<SchemaTypes.BuildTriggerInstancesTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.BuildTriggerInstancesTargetSchema>({
|
|
@@ -35,6 +41,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
35
41
|
* Retrieve a build trigger
|
|
36
42
|
*
|
|
37
43
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/self
|
|
44
|
+
*
|
|
45
|
+
* @throws {ApiError}
|
|
46
|
+
* @throws {TimeoutError}
|
|
38
47
|
*/
|
|
39
48
|
find(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
|
|
40
49
|
return this.rawFind(Utils.toId(buildTriggerId)).then((body) =>
|
|
@@ -48,6 +57,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
48
57
|
* Retrieve a build trigger
|
|
49
58
|
*
|
|
50
59
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/self
|
|
60
|
+
*
|
|
61
|
+
* @throws {ApiError}
|
|
62
|
+
* @throws {TimeoutError}
|
|
51
63
|
*/
|
|
52
64
|
rawFind(
|
|
53
65
|
buildTriggerId: string,
|
|
@@ -62,6 +74,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
62
74
|
* Create build trigger
|
|
63
75
|
*
|
|
64
76
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/create
|
|
77
|
+
*
|
|
78
|
+
* @throws {ApiError}
|
|
79
|
+
* @throws {TimeoutError}
|
|
65
80
|
*/
|
|
66
81
|
create(body: SimpleSchemaTypes.BuildTriggerCreateSchema) {
|
|
67
82
|
return this.rawCreate(
|
|
@@ -89,6 +104,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
89
104
|
* Create build trigger
|
|
90
105
|
*
|
|
91
106
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/create
|
|
107
|
+
*
|
|
108
|
+
* @throws {ApiError}
|
|
109
|
+
* @throws {TimeoutError}
|
|
92
110
|
*/
|
|
93
111
|
rawCreate(
|
|
94
112
|
body: SchemaTypes.BuildTriggerCreateSchema,
|
|
@@ -104,6 +122,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
104
122
|
* Update build trigger
|
|
105
123
|
*
|
|
106
124
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/update
|
|
125
|
+
*
|
|
126
|
+
* @throws {ApiError}
|
|
127
|
+
* @throws {TimeoutError}
|
|
107
128
|
*/
|
|
108
129
|
update(
|
|
109
130
|
buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData,
|
|
@@ -135,6 +156,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
135
156
|
* Update build trigger
|
|
136
157
|
*
|
|
137
158
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/update
|
|
159
|
+
*
|
|
160
|
+
* @throws {ApiError}
|
|
161
|
+
* @throws {TimeoutError}
|
|
138
162
|
*/
|
|
139
163
|
rawUpdate(
|
|
140
164
|
buildTriggerId: string,
|
|
@@ -151,6 +175,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
151
175
|
* Trigger a deploy
|
|
152
176
|
*
|
|
153
177
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger
|
|
178
|
+
*
|
|
179
|
+
* @throws {ApiError}
|
|
180
|
+
* @throws {TimeoutError}
|
|
154
181
|
*/
|
|
155
182
|
trigger(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
|
|
156
183
|
return this.rawTrigger(Utils.toId(buildTriggerId));
|
|
@@ -160,6 +187,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
160
187
|
* Trigger a deploy
|
|
161
188
|
*
|
|
162
189
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/trigger
|
|
190
|
+
*
|
|
191
|
+
* @throws {ApiError}
|
|
192
|
+
* @throws {TimeoutError}
|
|
163
193
|
*/
|
|
164
194
|
rawTrigger(buildTriggerId: string): Promise<void> {
|
|
165
195
|
return this.client.request<void>({
|
|
@@ -172,6 +202,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
172
202
|
* Abort a deploy and mark it as failed
|
|
173
203
|
*
|
|
174
204
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort
|
|
205
|
+
*
|
|
206
|
+
* @throws {ApiError}
|
|
207
|
+
* @throws {TimeoutError}
|
|
175
208
|
*/
|
|
176
209
|
abort(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
|
|
177
210
|
return this.rawAbort(Utils.toId(buildTriggerId));
|
|
@@ -181,6 +214,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
181
214
|
* Abort a deploy and mark it as failed
|
|
182
215
|
*
|
|
183
216
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort
|
|
217
|
+
*
|
|
218
|
+
* @throws {ApiError}
|
|
219
|
+
* @throws {TimeoutError}
|
|
184
220
|
*/
|
|
185
221
|
rawAbort(buildTriggerId: string): Promise<void> {
|
|
186
222
|
return this.client.request<void>({
|
|
@@ -193,6 +229,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
193
229
|
* Abort a site search spidering and mark it as failed
|
|
194
230
|
*
|
|
195
231
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort_indexing
|
|
232
|
+
*
|
|
233
|
+
* @throws {ApiError}
|
|
234
|
+
* @throws {TimeoutError}
|
|
196
235
|
*/
|
|
197
236
|
abortIndexing(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
|
|
198
237
|
return this.rawAbortIndexing(Utils.toId(buildTriggerId));
|
|
@@ -202,6 +241,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
202
241
|
* Abort a site search spidering and mark it as failed
|
|
203
242
|
*
|
|
204
243
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/abort_indexing
|
|
244
|
+
*
|
|
245
|
+
* @throws {ApiError}
|
|
246
|
+
* @throws {TimeoutError}
|
|
205
247
|
*/
|
|
206
248
|
rawAbortIndexing(buildTriggerId: string): Promise<void> {
|
|
207
249
|
return this.client.request<void>({
|
|
@@ -214,6 +256,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
214
256
|
* Trigger a new site search spidering of the website
|
|
215
257
|
*
|
|
216
258
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
|
|
259
|
+
*
|
|
260
|
+
* @throws {ApiError}
|
|
261
|
+
* @throws {TimeoutError}
|
|
217
262
|
*/
|
|
218
263
|
reindex(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
|
|
219
264
|
return this.rawReindex(Utils.toId(buildTriggerId));
|
|
@@ -223,6 +268,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
223
268
|
* Trigger a new site search spidering of the website
|
|
224
269
|
*
|
|
225
270
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/reindex
|
|
271
|
+
*
|
|
272
|
+
* @throws {ApiError}
|
|
273
|
+
* @throws {TimeoutError}
|
|
226
274
|
*/
|
|
227
275
|
rawReindex(buildTriggerId: string): Promise<void> {
|
|
228
276
|
return this.client.request<void>({
|
|
@@ -235,6 +283,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
235
283
|
* Delete a build trigger
|
|
236
284
|
*
|
|
237
285
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy
|
|
286
|
+
*
|
|
287
|
+
* @throws {ApiError}
|
|
288
|
+
* @throws {TimeoutError}
|
|
238
289
|
*/
|
|
239
290
|
destroy(buildTriggerId: string | SimpleSchemaTypes.BuildTriggerData) {
|
|
240
291
|
return this.rawDestroy(Utils.toId(buildTriggerId)).then((body) =>
|
|
@@ -248,6 +299,9 @@ export default class BuildTrigger extends BaseResource {
|
|
|
248
299
|
* Delete a build trigger
|
|
249
300
|
*
|
|
250
301
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/build-trigger/destroy
|
|
302
|
+
*
|
|
303
|
+
* @throws {ApiError}
|
|
304
|
+
* @throws {TimeoutError}
|
|
251
305
|
*/
|
|
252
306
|
rawDestroy(
|
|
253
307
|
buildTriggerId: string,
|
|
@@ -10,6 +10,9 @@ export default class DailyUsage extends BaseResource {
|
|
|
10
10
|
* Retrieve project's daily usage info
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/daily-usage/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 DailyUsage extends BaseResource {
|
|
|
23
26
|
* Retrieve project's daily usage info
|
|
24
27
|
*
|
|
25
28
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/daily-usage/instances
|
|
29
|
+
*
|
|
30
|
+
* @throws {ApiError}
|
|
31
|
+
* @throws {TimeoutError}
|
|
26
32
|
*/
|
|
27
33
|
rawList(): Promise<SchemaTypes.DailyUsageInstancesTargetSchema> {
|
|
28
34
|
return this.client.request<SchemaTypes.DailyUsageInstancesTargetSchema>({
|
|
@@ -11,6 +11,9 @@ export default class EditingSession extends BaseResource {
|
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/instances
|
|
13
13
|
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
16
|
+
*
|
|
14
17
|
* @deprecated This API call is to be considered private and might change without notice
|
|
15
18
|
*/
|
|
16
19
|
list() {
|
|
@@ -26,6 +29,9 @@ export default class EditingSession extends BaseResource {
|
|
|
26
29
|
*
|
|
27
30
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/instances
|
|
28
31
|
*
|
|
32
|
+
* @throws {ApiError}
|
|
33
|
+
* @throws {TimeoutError}
|
|
34
|
+
*
|
|
29
35
|
* @deprecated This API call is to be considered private and might change without notice
|
|
30
36
|
*/
|
|
31
37
|
rawList(): Promise<SchemaTypes.EditingSessionInstancesTargetSchema> {
|
|
@@ -42,6 +48,9 @@ export default class EditingSession extends BaseResource {
|
|
|
42
48
|
*
|
|
43
49
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/update
|
|
44
50
|
*
|
|
51
|
+
* @throws {ApiError}
|
|
52
|
+
* @throws {TimeoutError}
|
|
53
|
+
*
|
|
45
54
|
* @deprecated This API call is to be considered private and might change without notice
|
|
46
55
|
*/
|
|
47
56
|
rawUpdate(
|
|
@@ -60,6 +69,9 @@ export default class EditingSession extends BaseResource {
|
|
|
60
69
|
*
|
|
61
70
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy
|
|
62
71
|
*
|
|
72
|
+
* @throws {ApiError}
|
|
73
|
+
* @throws {TimeoutError}
|
|
74
|
+
*
|
|
63
75
|
* @deprecated This API call is to be considered private and might change without notice
|
|
64
76
|
*/
|
|
65
77
|
destroy(editingSessionId: string | SimpleSchemaTypes.EditingSessionData) {
|
|
@@ -75,6 +87,9 @@ export default class EditingSession extends BaseResource {
|
|
|
75
87
|
*
|
|
76
88
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/editing-session/destroy
|
|
77
89
|
*
|
|
90
|
+
* @throws {ApiError}
|
|
91
|
+
* @throws {TimeoutError}
|
|
92
|
+
*
|
|
78
93
|
* @deprecated This API call is to be considered private and might change without notice
|
|
79
94
|
*/
|
|
80
95
|
rawDestroy(
|
|
@@ -10,6 +10,9 @@ export default class Environment extends BaseResource {
|
|
|
10
10
|
* Fork an existing environment
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
fork(
|
|
15
18
|
environmentId: string | SimpleSchemaTypes.EnvironmentData,
|
|
@@ -34,6 +37,9 @@ export default class Environment extends BaseResource {
|
|
|
34
37
|
* Fork an existing environment
|
|
35
38
|
*
|
|
36
39
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/fork
|
|
40
|
+
*
|
|
41
|
+
* @throws {ApiError}
|
|
42
|
+
* @throws {TimeoutError}
|
|
37
43
|
*/
|
|
38
44
|
rawFork(
|
|
39
45
|
environmentId: string,
|
|
@@ -50,6 +56,9 @@ export default class Environment extends BaseResource {
|
|
|
50
56
|
* Promote an environment to primary
|
|
51
57
|
*
|
|
52
58
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
|
|
59
|
+
*
|
|
60
|
+
* @throws {ApiError}
|
|
61
|
+
* @throws {TimeoutError}
|
|
53
62
|
*/
|
|
54
63
|
promote(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
|
|
55
64
|
return this.rawPromote(Utils.toId(environmentId)).then((body) =>
|
|
@@ -63,6 +72,9 @@ export default class Environment extends BaseResource {
|
|
|
63
72
|
* Promote an environment to primary
|
|
64
73
|
*
|
|
65
74
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/promote
|
|
75
|
+
*
|
|
76
|
+
* @throws {ApiError}
|
|
77
|
+
* @throws {TimeoutError}
|
|
66
78
|
*/
|
|
67
79
|
rawPromote(
|
|
68
80
|
environmentId: string,
|
|
@@ -77,6 +89,9 @@ export default class Environment extends BaseResource {
|
|
|
77
89
|
* List all environments
|
|
78
90
|
*
|
|
79
91
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
|
|
92
|
+
*
|
|
93
|
+
* @throws {ApiError}
|
|
94
|
+
* @throws {TimeoutError}
|
|
80
95
|
*/
|
|
81
96
|
list() {
|
|
82
97
|
return this.rawList().then((body) =>
|
|
@@ -90,6 +105,9 @@ export default class Environment extends BaseResource {
|
|
|
90
105
|
* List all environments
|
|
91
106
|
*
|
|
92
107
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/instances
|
|
108
|
+
*
|
|
109
|
+
* @throws {ApiError}
|
|
110
|
+
* @throws {TimeoutError}
|
|
93
111
|
*/
|
|
94
112
|
rawList(): Promise<SchemaTypes.EnvironmentInstancesTargetSchema> {
|
|
95
113
|
return this.client.request<SchemaTypes.EnvironmentInstancesTargetSchema>({
|
|
@@ -102,6 +120,9 @@ export default class Environment extends BaseResource {
|
|
|
102
120
|
* Retrieve a environment
|
|
103
121
|
*
|
|
104
122
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
|
|
123
|
+
*
|
|
124
|
+
* @throws {ApiError}
|
|
125
|
+
* @throws {TimeoutError}
|
|
105
126
|
*/
|
|
106
127
|
find(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
|
|
107
128
|
return this.rawFind(Utils.toId(environmentId)).then((body) =>
|
|
@@ -115,6 +136,9 @@ export default class Environment extends BaseResource {
|
|
|
115
136
|
* Retrieve a environment
|
|
116
137
|
*
|
|
117
138
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/self
|
|
139
|
+
*
|
|
140
|
+
* @throws {ApiError}
|
|
141
|
+
* @throws {TimeoutError}
|
|
118
142
|
*/
|
|
119
143
|
rawFind(
|
|
120
144
|
environmentId: string,
|
|
@@ -129,6 +153,9 @@ export default class Environment extends BaseResource {
|
|
|
129
153
|
* Delete a environment
|
|
130
154
|
*
|
|
131
155
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
|
|
156
|
+
*
|
|
157
|
+
* @throws {ApiError}
|
|
158
|
+
* @throws {TimeoutError}
|
|
132
159
|
*/
|
|
133
160
|
destroy(environmentId: string | SimpleSchemaTypes.EnvironmentData) {
|
|
134
161
|
return this.rawDestroy(Utils.toId(environmentId)).then((body) =>
|
|
@@ -142,6 +169,9 @@ export default class Environment extends BaseResource {
|
|
|
142
169
|
* Delete a environment
|
|
143
170
|
*
|
|
144
171
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/environment/destroy
|
|
172
|
+
*
|
|
173
|
+
* @throws {ApiError}
|
|
174
|
+
* @throws {TimeoutError}
|
|
145
175
|
*/
|
|
146
176
|
rawDestroy(
|
|
147
177
|
environmentId: string,
|
|
@@ -10,6 +10,9 @@ export default class Field extends BaseResource {
|
|
|
10
10
|
* Create a new field
|
|
11
11
|
*
|
|
12
12
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
|
|
13
|
+
*
|
|
14
|
+
* @throws {ApiError}
|
|
15
|
+
* @throws {TimeoutError}
|
|
13
16
|
*/
|
|
14
17
|
create(
|
|
15
18
|
itemTypeId: string | SimpleSchemaTypes.ItemTypeData,
|
|
@@ -44,6 +47,9 @@ export default class Field extends BaseResource {
|
|
|
44
47
|
* Create a new field
|
|
45
48
|
*
|
|
46
49
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/create
|
|
50
|
+
*
|
|
51
|
+
* @throws {ApiError}
|
|
52
|
+
* @throws {TimeoutError}
|
|
47
53
|
*/
|
|
48
54
|
rawCreate(
|
|
49
55
|
itemTypeId: string,
|
|
@@ -60,6 +66,9 @@ export default class Field extends BaseResource {
|
|
|
60
66
|
* Update a field
|
|
61
67
|
*
|
|
62
68
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
|
|
69
|
+
*
|
|
70
|
+
* @throws {ApiError}
|
|
71
|
+
* @throws {TimeoutError}
|
|
63
72
|
*/
|
|
64
73
|
update(
|
|
65
74
|
fieldId: string | SimpleSchemaTypes.FieldData,
|
|
@@ -95,6 +104,9 @@ export default class Field extends BaseResource {
|
|
|
95
104
|
* Update a field
|
|
96
105
|
*
|
|
97
106
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/update
|
|
107
|
+
*
|
|
108
|
+
* @throws {ApiError}
|
|
109
|
+
* @throws {TimeoutError}
|
|
98
110
|
*/
|
|
99
111
|
rawUpdate(
|
|
100
112
|
fieldId: string,
|
|
@@ -111,6 +123,9 @@ export default class Field extends BaseResource {
|
|
|
111
123
|
* List all fields
|
|
112
124
|
*
|
|
113
125
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/instances
|
|
126
|
+
*
|
|
127
|
+
* @throws {ApiError}
|
|
128
|
+
* @throws {TimeoutError}
|
|
114
129
|
*/
|
|
115
130
|
list(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
|
|
116
131
|
return this.rawList(Utils.toId(itemTypeId)).then((body) =>
|
|
@@ -124,6 +139,9 @@ export default class Field extends BaseResource {
|
|
|
124
139
|
* List all fields
|
|
125
140
|
*
|
|
126
141
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/instances
|
|
142
|
+
*
|
|
143
|
+
* @throws {ApiError}
|
|
144
|
+
* @throws {TimeoutError}
|
|
127
145
|
*/
|
|
128
146
|
rawList(itemTypeId: string): Promise<SchemaTypes.FieldInstancesTargetSchema> {
|
|
129
147
|
return this.client.request<SchemaTypes.FieldInstancesTargetSchema>({
|
|
@@ -137,6 +155,9 @@ export default class Field extends BaseResource {
|
|
|
137
155
|
*
|
|
138
156
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
|
|
139
157
|
*
|
|
158
|
+
* @throws {ApiError}
|
|
159
|
+
* @throws {TimeoutError}
|
|
160
|
+
*
|
|
140
161
|
* @deprecated This API call is to be considered private and might change without notice
|
|
141
162
|
*/
|
|
142
163
|
referencing(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
|
|
@@ -152,6 +173,9 @@ export default class Field extends BaseResource {
|
|
|
152
173
|
*
|
|
153
174
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/referencing
|
|
154
175
|
*
|
|
176
|
+
* @throws {ApiError}
|
|
177
|
+
* @throws {TimeoutError}
|
|
178
|
+
*
|
|
155
179
|
* @deprecated This API call is to be considered private and might change without notice
|
|
156
180
|
*/
|
|
157
181
|
rawReferencing(
|
|
@@ -168,6 +192,9 @@ export default class Field extends BaseResource {
|
|
|
168
192
|
*
|
|
169
193
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/related
|
|
170
194
|
*
|
|
195
|
+
* @throws {ApiError}
|
|
196
|
+
* @throws {TimeoutError}
|
|
197
|
+
*
|
|
171
198
|
* @deprecated This API call is to be considered private and might change without notice
|
|
172
199
|
*/
|
|
173
200
|
related(itemTypeId: string | SimpleSchemaTypes.ItemTypeData) {
|
|
@@ -183,6 +210,9 @@ export default class Field extends BaseResource {
|
|
|
183
210
|
*
|
|
184
211
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/related
|
|
185
212
|
*
|
|
213
|
+
* @throws {ApiError}
|
|
214
|
+
* @throws {TimeoutError}
|
|
215
|
+
*
|
|
186
216
|
* @deprecated This API call is to be considered private and might change without notice
|
|
187
217
|
*/
|
|
188
218
|
rawRelated(
|
|
@@ -198,6 +228,9 @@ export default class Field extends BaseResource {
|
|
|
198
228
|
* Retrieve a field
|
|
199
229
|
*
|
|
200
230
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/self
|
|
231
|
+
*
|
|
232
|
+
* @throws {ApiError}
|
|
233
|
+
* @throws {TimeoutError}
|
|
201
234
|
*/
|
|
202
235
|
find(fieldId: string | SimpleSchemaTypes.FieldData) {
|
|
203
236
|
return this.rawFind(Utils.toId(fieldId)).then((body) =>
|
|
@@ -211,6 +244,9 @@ export default class Field extends BaseResource {
|
|
|
211
244
|
* Retrieve a field
|
|
212
245
|
*
|
|
213
246
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/self
|
|
247
|
+
*
|
|
248
|
+
* @throws {ApiError}
|
|
249
|
+
* @throws {TimeoutError}
|
|
214
250
|
*/
|
|
215
251
|
rawFind(fieldId: string): Promise<SchemaTypes.FieldSelfTargetSchema> {
|
|
216
252
|
return this.client.request<SchemaTypes.FieldSelfTargetSchema>({
|
|
@@ -223,6 +259,9 @@ export default class Field extends BaseResource {
|
|
|
223
259
|
* Delete a field
|
|
224
260
|
*
|
|
225
261
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/destroy
|
|
262
|
+
*
|
|
263
|
+
* @throws {ApiError}
|
|
264
|
+
* @throws {TimeoutError}
|
|
226
265
|
*/
|
|
227
266
|
destroy(fieldId: string | SimpleSchemaTypes.FieldData) {
|
|
228
267
|
return this.rawDestroy(Utils.toId(fieldId)).then((body) =>
|
|
@@ -236,6 +275,9 @@ export default class Field extends BaseResource {
|
|
|
236
275
|
* Delete a field
|
|
237
276
|
*
|
|
238
277
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/destroy
|
|
278
|
+
*
|
|
279
|
+
* @throws {ApiError}
|
|
280
|
+
* @throws {TimeoutError}
|
|
239
281
|
*/
|
|
240
282
|
rawDestroy(fieldId: string): Promise<SchemaTypes.FieldDestroyJobSchema> {
|
|
241
283
|
return this.client.request<SchemaTypes.FieldDestroyJobSchema>({
|
|
@@ -248,6 +290,9 @@ export default class Field extends BaseResource {
|
|
|
248
290
|
* Duplicate a field
|
|
249
291
|
*
|
|
250
292
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/duplicate
|
|
293
|
+
*
|
|
294
|
+
* @throws {ApiError}
|
|
295
|
+
* @throws {TimeoutError}
|
|
251
296
|
*/
|
|
252
297
|
duplicate(fieldId: string | SimpleSchemaTypes.FieldData) {
|
|
253
298
|
return this.rawDuplicate(Utils.toId(fieldId)).then((body) =>
|
|
@@ -261,6 +306,9 @@ export default class Field extends BaseResource {
|
|
|
261
306
|
* Duplicate a field
|
|
262
307
|
*
|
|
263
308
|
* Read more: https://www.datocms.com/docs/content-management-api/resources/field/duplicate
|
|
309
|
+
*
|
|
310
|
+
* @throws {ApiError}
|
|
311
|
+
* @throws {TimeoutError}
|
|
264
312
|
*/
|
|
265
313
|
rawDuplicate(fieldId: string): Promise<SchemaTypes.FieldDuplicateJobSchema> {
|
|
266
314
|
return this.client.request<SchemaTypes.FieldDuplicateJobSchema>({
|