confluence.js 2.0.0 → 2.2.0-dev20260318121920
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/CHANGELOG.md +67 -2
- package/README.md +168 -181
- package/dist/cjs/api/analytics.cjs.map +1 -1
- package/dist/cjs/api/audit.cjs.map +1 -1
- package/dist/cjs/api/content.cjs +0 -5
- package/dist/cjs/api/content.cjs.map +1 -1
- package/dist/cjs/api/contentAttachments.cjs +1 -0
- package/dist/cjs/api/contentAttachments.cjs.map +1 -1
- package/dist/cjs/api/contentBody.cjs +18 -0
- package/dist/cjs/api/contentBody.cjs.map +1 -1
- package/dist/cjs/api/contentChildrenAndDescendants.cjs +2 -0
- package/dist/cjs/api/contentChildrenAndDescendants.cjs.map +1 -1
- package/dist/cjs/api/contentComments.cjs +1 -0
- package/dist/cjs/api/contentComments.cjs.map +1 -1
- package/dist/cjs/api/contentLabels.cjs.map +1 -1
- package/dist/cjs/api/contentMacroBody.cjs.map +1 -1
- package/dist/cjs/api/contentPermissions.cjs.map +1 -1
- package/dist/cjs/api/contentProperties.cjs +1 -0
- package/dist/cjs/api/contentProperties.cjs.map +1 -1
- package/dist/cjs/api/contentRestrictions.cjs.map +1 -1
- package/dist/cjs/api/contentStates.cjs +13 -0
- package/dist/cjs/api/contentStates.cjs.map +1 -1
- package/dist/cjs/api/contentVersions.cjs.map +1 -1
- package/dist/cjs/api/contentWatches.cjs.map +1 -1
- package/dist/cjs/api/dynamicModules.cjs.map +1 -1
- package/dist/cjs/api/experimental.cjs.map +1 -1
- package/dist/cjs/api/group.cjs +18 -17
- package/dist/cjs/api/group.cjs.map +1 -1
- package/dist/cjs/api/index.cjs +2 -0
- package/dist/cjs/api/index.cjs.map +1 -1
- package/dist/cjs/api/inlineTasks.cjs +1 -0
- package/dist/cjs/api/inlineTasks.cjs.map +1 -1
- package/dist/cjs/api/labelInfo.cjs.map +1 -1
- package/dist/cjs/api/longRunningTask.cjs +1 -0
- package/dist/cjs/api/longRunningTask.cjs.map +1 -1
- package/dist/cjs/api/models/labeledContentType.cjs.map +1 -1
- package/dist/cjs/api/relation.cjs.map +1 -1
- package/dist/cjs/api/search.cjs +1 -0
- package/dist/cjs/api/search.cjs.map +1 -1
- package/dist/cjs/api/settings.cjs.map +1 -1
- package/dist/cjs/api/space.cjs +4 -2
- package/dist/cjs/api/space.cjs.map +1 -1
- package/dist/cjs/api/spacePermissions.cjs.map +1 -1
- package/dist/cjs/api/spaceProperties.cjs +1 -0
- package/dist/cjs/api/spaceProperties.cjs.map +1 -1
- package/dist/cjs/api/spaceSettings.cjs.map +1 -1
- package/dist/cjs/api/template.cjs.map +1 -1
- package/dist/cjs/api/themes.cjs.map +1 -1
- package/dist/cjs/api/userProperties.cjs +56 -0
- package/dist/cjs/api/userProperties.cjs.map +1 -0
- package/dist/cjs/api/users.cjs.map +1 -1
- package/dist/cjs/clients/baseClient.cjs +17 -2
- package/dist/cjs/clients/baseClient.cjs.map +1 -1
- package/dist/cjs/clients/confluenceClient.cjs +6 -0
- package/dist/cjs/clients/confluenceClient.cjs.map +1 -1
- package/dist/cjs/config.cjs +7 -4
- package/dist/cjs/config.cjs.map +1 -1
- package/dist/cjs/paramSerializer.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/authenticationService.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/authentications/createBasicAuthenticationToken.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/authentications/createJWTAuthentication.cjs +1 -1
- package/dist/cjs/services/authenticationService/authentications/createJWTAuthentication.cjs.map +1 -1
- package/dist/cjs/services/authenticationService/base64Encoder.cjs.map +1 -1
- package/dist/esm/api/analytics.mjs.map +1 -1
- package/dist/esm/api/audit.mjs.map +1 -1
- package/dist/esm/api/content.mjs +0 -5
- package/dist/esm/api/content.mjs.map +1 -1
- package/dist/esm/api/contentAttachments.mjs +1 -0
- package/dist/esm/api/contentAttachments.mjs.map +1 -1
- package/dist/esm/api/contentBody.mjs +18 -0
- package/dist/esm/api/contentBody.mjs.map +1 -1
- package/dist/esm/api/contentChildrenAndDescendants.mjs +2 -0
- package/dist/esm/api/contentChildrenAndDescendants.mjs.map +1 -1
- package/dist/esm/api/contentComments.mjs +1 -0
- package/dist/esm/api/contentComments.mjs.map +1 -1
- package/dist/esm/api/contentLabels.mjs.map +1 -1
- package/dist/esm/api/contentMacroBody.mjs.map +1 -1
- package/dist/esm/api/contentPermissions.mjs.map +1 -1
- package/dist/esm/api/contentProperties.mjs +1 -0
- package/dist/esm/api/contentProperties.mjs.map +1 -1
- package/dist/esm/api/contentRestrictions.mjs.map +1 -1
- package/dist/esm/api/contentStates.mjs +13 -0
- package/dist/esm/api/contentStates.mjs.map +1 -1
- package/dist/esm/api/contentVersions.mjs.map +1 -1
- package/dist/esm/api/contentWatches.mjs.map +1 -1
- package/dist/esm/api/dynamicModules.mjs.map +1 -1
- package/dist/esm/api/experimental.mjs.map +1 -1
- package/dist/esm/api/group.mjs +18 -17
- package/dist/esm/api/group.mjs.map +1 -1
- package/dist/esm/api/index.mjs +1 -0
- package/dist/esm/api/index.mjs.map +1 -1
- package/dist/esm/api/inlineTasks.mjs +1 -0
- package/dist/esm/api/inlineTasks.mjs.map +1 -1
- package/dist/esm/api/labelInfo.mjs.map +1 -1
- package/dist/esm/api/longRunningTask.mjs +1 -0
- package/dist/esm/api/longRunningTask.mjs.map +1 -1
- package/dist/esm/api/models/labeledContentType.mjs.map +1 -1
- package/dist/esm/api/relation.mjs.map +1 -1
- package/dist/esm/api/search.mjs +1 -0
- package/dist/esm/api/search.mjs.map +1 -1
- package/dist/esm/api/settings.mjs.map +1 -1
- package/dist/esm/api/space.mjs +4 -2
- package/dist/esm/api/space.mjs.map +1 -1
- package/dist/esm/api/spacePermissions.mjs.map +1 -1
- package/dist/esm/api/spaceProperties.mjs +1 -0
- package/dist/esm/api/spaceProperties.mjs.map +1 -1
- package/dist/esm/api/spaceSettings.mjs.map +1 -1
- package/dist/esm/api/template.mjs.map +1 -1
- package/dist/esm/api/themes.mjs.map +1 -1
- package/dist/esm/api/userProperties.mjs +54 -0
- package/dist/esm/api/userProperties.mjs.map +1 -0
- package/dist/esm/api/users.mjs.map +1 -1
- package/dist/esm/clients/baseClient.mjs +18 -3
- package/dist/esm/clients/baseClient.mjs.map +1 -1
- package/dist/esm/clients/confluenceClient.mjs +6 -0
- package/dist/esm/clients/confluenceClient.mjs.map +1 -1
- package/dist/esm/config.mjs +7 -4
- package/dist/esm/config.mjs.map +1 -1
- package/dist/esm/paramSerializer.mjs.map +1 -1
- package/dist/esm/services/authenticationService/authenticationService.mjs.map +1 -1
- package/dist/esm/services/authenticationService/authentications/createBasicAuthenticationToken.mjs.map +1 -1
- package/dist/esm/services/authenticationService/authentications/createJWTAuthentication.mjs +1 -1
- package/dist/esm/services/authenticationService/authentications/createJWTAuthentication.mjs.map +1 -1
- package/dist/esm/services/authenticationService/base64Encoder.mjs.map +1 -1
- package/dist/esm/types/api/analytics.d.ts +1 -1
- package/dist/esm/types/api/audit.d.ts +3 -3
- package/dist/esm/types/api/content.d.ts +33 -7
- package/dist/esm/types/api/contentAttachments.d.ts +5 -1
- package/dist/esm/types/api/contentBody.d.ts +73 -7
- package/dist/esm/types/api/contentChildrenAndDescendants.d.ts +37 -5
- package/dist/esm/types/api/contentComments.d.ts +5 -0
- package/dist/esm/types/api/contentLabels.d.ts +17 -9
- package/dist/esm/types/api/contentMacroBody.d.ts +79 -1
- package/dist/esm/types/api/contentPermissions.d.ts +1 -1
- package/dist/esm/types/api/contentProperties.d.ts +25 -0
- package/dist/esm/types/api/contentRestrictions.d.ts +19 -7
- package/dist/esm/types/api/contentStates.d.ts +23 -5
- package/dist/esm/types/api/contentVersions.d.ts +9 -1
- package/dist/esm/types/api/contentWatches.d.ts +1 -1
- package/dist/esm/types/api/dynamicModules.d.ts +1 -1
- package/dist/esm/types/api/experimental.d.ts +21 -1
- package/dist/esm/types/api/group.d.ts +47 -27
- package/dist/esm/types/api/index.d.ts +1 -0
- package/dist/esm/types/api/inlineTasks.d.ts +13 -0
- package/dist/esm/types/api/labelInfo.d.ts +1 -1
- package/dist/esm/types/api/longRunningTask.d.ts +1 -1
- package/dist/esm/types/api/models/spaceCreate.d.ts +11 -2
- package/dist/esm/types/api/models/spacePrivateCreate.d.ts +11 -2
- package/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyRequest.d.ts +58 -0
- package/dist/esm/types/api/parameters/bulkAsyncConvertContentBodyResponse.d.ts +4 -0
- package/dist/esm/types/api/parameters/deleteGroupById.d.ts +4 -0
- package/dist/esm/types/api/parameters/downloadAttachment.d.ts +6 -0
- package/dist/esm/types/api/parameters/getContentChildren.d.ts +6 -1
- package/dist/esm/types/api/parameters/getContentsWithState.d.ts +17 -0
- package/dist/esm/types/api/parameters/getGroupMembersByGroupId.d.ts +7 -0
- package/dist/esm/types/api/parameters/getGroupMembershipsForUser.d.ts +4 -0
- package/dist/esm/types/api/parameters/getTasks.d.ts +2 -0
- package/dist/esm/types/api/parameters/getUser.d.ts +4 -0
- package/dist/esm/types/api/parameters/index.d.ts +4 -0
- package/dist/esm/types/api/parameters/searchUser.d.ts +7 -0
- package/dist/esm/types/api/relation.d.ts +13 -15
- package/dist/esm/types/api/search.d.ts +7 -1
- package/dist/esm/types/api/settings.d.ts +5 -1
- package/dist/esm/types/api/space.d.ts +23 -7
- package/dist/esm/types/api/spacePermissions.d.ts +1 -1
- package/dist/esm/types/api/spaceProperties.d.ts +25 -0
- package/dist/esm/types/api/spaceSettings.d.ts +1 -1
- package/dist/esm/types/api/template.d.ts +1 -1
- package/dist/esm/types/api/themes.d.ts +1 -1
- package/dist/esm/types/api/userProperties.d.ts +102 -0
- package/dist/esm/types/api/users.d.ts +21 -9
- package/dist/esm/types/clients/baseClient.d.ts +1 -0
- package/dist/esm/types/clients/confluenceClient.d.ts +6 -1
- package/dist/esm/types/config.d.ts +29 -240
- package/eslint.config.ts +11 -16
- package/package.json +34 -33
- package/rollup.config.ts +8 -8
- package/src/api/analytics.ts +1 -1
- package/src/api/audit.ts +3 -3
- package/src/api/content.ts +33 -12
- package/src/api/contentAttachments.ts +6 -1
- package/src/api/contentBody.ts +113 -7
- package/src/api/contentChildrenAndDescendants.ts +39 -5
- package/src/api/contentComments.ts +5 -0
- package/src/api/contentLabels.ts +17 -9
- package/src/api/contentMacroBody.ts +79 -1
- package/src/api/contentPermissions.ts +1 -1
- package/src/api/contentProperties.ts +25 -0
- package/src/api/contentRestrictions.ts +19 -7
- package/src/api/contentStates.ts +47 -5
- package/src/api/contentVersions.ts +9 -1
- package/src/api/contentWatches.ts +1 -1
- package/src/api/dynamicModules.ts +1 -1
- package/src/api/experimental.ts +21 -1
- package/src/api/group.ts +96 -75
- package/src/api/index.ts +1 -0
- package/src/api/inlineTasks.ts +13 -0
- package/src/api/labelInfo.ts +1 -1
- package/src/api/longRunningTask.ts +2 -1
- package/src/api/models/spaceCreate.ts +11 -2
- package/src/api/models/spacePrivateCreate.ts +11 -2
- package/src/api/parameters/bulkAsyncConvertContentBodyRequest.ts +88 -0
- package/src/api/parameters/bulkAsyncConvertContentBodyResponse.ts +4 -0
- package/src/api/parameters/deleteGroupById.ts +4 -0
- package/src/api/parameters/downloadAttachment.ts +6 -0
- package/src/api/parameters/getContentChildren.ts +7 -1
- package/src/api/parameters/getContentsWithState.ts +17 -0
- package/src/api/parameters/getGroupMembersByGroupId.ts +7 -0
- package/src/api/parameters/getGroupMembershipsForUser.ts +4 -0
- package/src/api/parameters/getTasks.ts +2 -0
- package/src/api/parameters/getUser.ts +4 -0
- package/src/api/parameters/index.ts +4 -0
- package/src/api/parameters/searchUser.ts +7 -0
- package/src/api/relation.ts +13 -15
- package/src/api/search.ts +8 -1
- package/src/api/settings.ts +5 -1
- package/src/api/space.ts +27 -9
- package/src/api/spacePermissions.ts +1 -1
- package/src/api/spaceProperties.ts +25 -0
- package/src/api/spaceSettings.ts +1 -1
- package/src/api/template.ts +1 -1
- package/src/api/themes.ts +1 -1
- package/src/api/userProperties.ts +185 -0
- package/src/api/users.ts +21 -9
- package/src/clients/baseClient.ts +24 -8
- package/src/clients/confluenceClient.ts +6 -0
- package/src/config.ts +8 -4
- package/src/services/authenticationService/authentications/createJWTAuthentication.ts +1 -1
- package/favicon.svg +0 -7
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type * as Models from "./models/index.js";
|
|
2
2
|
import type * as Parameters from "./parameters/index.js";
|
|
3
|
-
import type { Callback } from "../callback.js";
|
|
4
3
|
import type { Client } from "../clients/index.js";
|
|
4
|
+
import type { Callback } from "../callback.js";
|
|
5
5
|
export declare class Content {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -12,6 +12,8 @@ export declare class Content {
|
|
|
12
12
|
*
|
|
13
13
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
14
14
|
* ('Can use' global permission). Only content that the user has permission to view will be returned.
|
|
15
|
+
*
|
|
16
|
+
* @deprecated Will be removed in next major version.
|
|
15
17
|
*/
|
|
16
18
|
getContent<T = Models.ContentArray>(parameters: Parameters.GetContent | undefined, callback: Callback<T>): Promise<void>;
|
|
17
19
|
/**
|
|
@@ -21,6 +23,8 @@ export declare class Content {
|
|
|
21
23
|
*
|
|
22
24
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
23
25
|
* ('Can use' global permission). Only content that the user has permission to view will be returned.
|
|
26
|
+
*
|
|
27
|
+
* @deprecated Will be removed in next major version.
|
|
24
28
|
*/
|
|
25
29
|
getContent<T = Models.ContentArray>(parameters?: Parameters.GetContent, callback?: never): Promise<T>;
|
|
26
30
|
/**
|
|
@@ -34,6 +38,8 @@ export declare class Content {
|
|
|
34
38
|
*
|
|
35
39
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add' permission for the space that the
|
|
36
40
|
* content will be created in, and permission to view the draft if publishing a draft.
|
|
41
|
+
*
|
|
42
|
+
* @deprecated Will be removed in next major version.
|
|
37
43
|
*/
|
|
38
44
|
createContent<T = Models.Content>(parameters: Parameters.CreateContent | undefined, callback: Callback<T>): Promise<void>;
|
|
39
45
|
/**
|
|
@@ -47,6 +53,8 @@ export declare class Content {
|
|
|
47
53
|
*
|
|
48
54
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add' permission for the space that the
|
|
49
55
|
* content will be created in, and permission to view the draft if publishing a draft.
|
|
56
|
+
*
|
|
57
|
+
* @deprecated Will be removed in next major version.
|
|
50
58
|
*/
|
|
51
59
|
createContent<T = Models.Content>(parameters?: Parameters.CreateContent, callback?: never): Promise<T>;
|
|
52
60
|
/**
|
|
@@ -119,12 +127,13 @@ export declare class Content {
|
|
|
119
127
|
*
|
|
120
128
|
* When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
|
|
121
129
|
* URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
|
|
122
|
-
* results returned in each call.
|
|
123
|
-
*
|
|
124
|
-
* https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
|
|
130
|
+
* results returned in each call.
|
|
125
131
|
*
|
|
126
132
|
* The response to this will have a `prev` URL similar to the `next` in the example response.
|
|
127
133
|
*
|
|
134
|
+
* If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the
|
|
135
|
+
* query limit parameter will be restricted to a maximum value of 25.
|
|
136
|
+
*
|
|
128
137
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
129
138
|
* ('Can use' global permission). Only content that the user has permission to view will be returned.
|
|
130
139
|
*/
|
|
@@ -135,12 +144,13 @@ export declare class Content {
|
|
|
135
144
|
*
|
|
136
145
|
* When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The
|
|
137
146
|
* URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of
|
|
138
|
-
* results returned in each call.
|
|
139
|
-
*
|
|
140
|
-
* https://your-domain.atlassian.net/wiki/rest/api/content/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
|
|
147
|
+
* results returned in each call.
|
|
141
148
|
*
|
|
142
149
|
* The response to this will have a `prev` URL similar to the `next` in the example response.
|
|
143
150
|
*
|
|
151
|
+
* If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the
|
|
152
|
+
* query limit parameter will be restricted to a maximum value of 25.
|
|
153
|
+
*
|
|
144
154
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
145
155
|
* ('Can use' global permission). Only content that the user has permission to view will be returned.
|
|
146
156
|
*/
|
|
@@ -152,6 +162,8 @@ export declare class Content {
|
|
|
152
162
|
*
|
|
153
163
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
154
164
|
* content is a blog post, 'View' permission for the space is required.
|
|
165
|
+
*
|
|
166
|
+
* @deprecated Will be removed in next major version.
|
|
155
167
|
*/
|
|
156
168
|
getContentById<T = Models.Content>(parameters: Parameters.GetContentById, callback: Callback<T>): Promise<void>;
|
|
157
169
|
/**
|
|
@@ -161,6 +173,8 @@ export declare class Content {
|
|
|
161
173
|
*
|
|
162
174
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
163
175
|
* content is a blog post, 'View' permission for the space is required.
|
|
176
|
+
*
|
|
177
|
+
* @deprecated Will be removed in next major version.
|
|
164
178
|
*/
|
|
165
179
|
getContentById<T = Models.Content>(parameters: Parameters.GetContentById, callback?: never): Promise<T>;
|
|
166
180
|
/**
|
|
@@ -170,6 +184,8 @@ export declare class Content {
|
|
|
170
184
|
* Note, updating draft content is currently not supported.
|
|
171
185
|
*
|
|
172
186
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
|
|
187
|
+
*
|
|
188
|
+
* @deprecated Will be removed in next major version.
|
|
173
189
|
*/
|
|
174
190
|
updateContent<T = Models.Content>(parameters: Parameters.UpdateContent, callback: Callback<T>): Promise<void>;
|
|
175
191
|
/**
|
|
@@ -179,6 +195,8 @@ export declare class Content {
|
|
|
179
195
|
* Note, updating draft content is currently not supported.
|
|
180
196
|
*
|
|
181
197
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content.
|
|
198
|
+
*
|
|
199
|
+
* @deprecated Will be removed in next major version.
|
|
182
200
|
*/
|
|
183
201
|
updateContent<T = Models.Content>(parameters: Parameters.UpdateContent, callback?: never): Promise<T>;
|
|
184
202
|
/**
|
|
@@ -193,6 +211,8 @@ export declare class Content {
|
|
|
193
211
|
*
|
|
194
212
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
|
|
195
213
|
* content is in.
|
|
214
|
+
*
|
|
215
|
+
* @deprecated Will be removed in next major version.
|
|
196
216
|
*/
|
|
197
217
|
deleteContent<T = void>(parameters: Parameters.DeleteContent, callback: Callback<T>): Promise<void>;
|
|
198
218
|
/**
|
|
@@ -207,18 +227,24 @@ export declare class Content {
|
|
|
207
227
|
*
|
|
208
228
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
|
|
209
229
|
* content is in.
|
|
230
|
+
*
|
|
231
|
+
* @deprecated Will be removed in next major version.
|
|
210
232
|
*/
|
|
211
233
|
deleteContent<T = void>(parameters: Parameters.DeleteContent, callback?: never): Promise<T>;
|
|
212
234
|
/**
|
|
213
235
|
* Returns the most recent update for a piece of content.
|
|
214
236
|
*
|
|
215
237
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
|
|
238
|
+
*
|
|
239
|
+
* @deprecated Will be removed in next major version.
|
|
216
240
|
*/
|
|
217
241
|
getHistoryForContent<T = Models.ContentHistory>(parameters: Parameters.GetHistoryForContent, callback: Callback<T>): Promise<void>;
|
|
218
242
|
/**
|
|
219
243
|
* Returns the most recent update for a piece of content.
|
|
220
244
|
*
|
|
221
245
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
|
|
246
|
+
*
|
|
247
|
+
* @deprecated Will be removed in next major version.
|
|
222
248
|
*/
|
|
223
249
|
getHistoryForContent<T = Models.ContentHistory>(parameters: Parameters.GetHistoryForContent, callback?: never): Promise<T>;
|
|
224
250
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type * as Models from "./models/index.js";
|
|
2
2
|
import type * as Parameters from "./parameters/index.js";
|
|
3
|
-
import type { Callback } from "../callback.js";
|
|
4
3
|
import type { Client } from "../clients/index.js";
|
|
4
|
+
import type { Callback } from "../callback.js";
|
|
5
5
|
export declare class ContentAttachments {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -12,6 +12,8 @@ export declare class ContentAttachments {
|
|
|
12
12
|
*
|
|
13
13
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
14
14
|
* content is a blog post, 'View' permission for the space is required.
|
|
15
|
+
*
|
|
16
|
+
* @deprecated Will be removed in next major version.
|
|
15
17
|
*/
|
|
16
18
|
getAttachments<T = Models.ContentArray<Models.Attachment>>(parameters: Parameters.GetAttachments, callback: Callback<T>): Promise<void>;
|
|
17
19
|
/**
|
|
@@ -21,6 +23,8 @@ export declare class ContentAttachments {
|
|
|
21
23
|
*
|
|
22
24
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
23
25
|
* content is a blog post, 'View' permission for the space is required.
|
|
26
|
+
*
|
|
27
|
+
* @deprecated Will be removed in next major version.
|
|
24
28
|
*/
|
|
25
29
|
getAttachments<T = Models.ContentArray<Models.Attachment>>(parameters: Parameters.GetAttachments, callback?: never): Promise<T>;
|
|
26
30
|
/**
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type * as Models from "./models/index.js";
|
|
2
2
|
import type * as Parameters from "./parameters/index.js";
|
|
3
|
-
import type { Callback } from "../callback.js";
|
|
4
3
|
import type { Client } from "../clients/index.js";
|
|
4
|
+
import type { Callback } from "../callback.js";
|
|
5
5
|
export declare class ContentBody {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -18,6 +18,8 @@ export declare class ContentBody {
|
|
|
18
18
|
*
|
|
19
19
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
|
|
20
20
|
* 'View' permission for the space, and permission to view the content.
|
|
21
|
+
*
|
|
22
|
+
* @deprecated Will be removed in next major version.
|
|
21
23
|
*/
|
|
22
24
|
convertContentBody<T = Models.ContentBody>(parameters: Parameters.ConvertContentBody, callback: Callback<T>): Promise<void>;
|
|
23
25
|
/**
|
|
@@ -33,6 +35,8 @@ export declare class ContentBody {
|
|
|
33
35
|
*
|
|
34
36
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: If request specifies 'contentIdContext',
|
|
35
37
|
* 'View' permission for the space, and permission to view the content.
|
|
38
|
+
*
|
|
39
|
+
* @deprecated Will be removed in next major version.
|
|
36
40
|
*/
|
|
37
41
|
convertContentBody<T = Models.ContentBody>(parameters: Parameters.ConvertContentBody, callback?: never): Promise<T>;
|
|
38
42
|
/**
|
|
@@ -41,7 +45,9 @@ export declare class ContentBody {
|
|
|
41
45
|
*
|
|
42
46
|
* Supported conversions:
|
|
43
47
|
*
|
|
44
|
-
* -
|
|
48
|
+
* - Atlas_doc_format: editor, export_view, storage, styled_view, view
|
|
49
|
+
* - Storage: atlas_doc_format, editor, export_view, styled_view, view
|
|
50
|
+
* - Editor: storage
|
|
45
51
|
*
|
|
46
52
|
* No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5
|
|
47
53
|
* minutes at the result endpoint.
|
|
@@ -56,7 +62,9 @@ export declare class ContentBody {
|
|
|
56
62
|
*
|
|
57
63
|
* Supported conversions:
|
|
58
64
|
*
|
|
59
|
-
* -
|
|
65
|
+
* - Atlas_doc_format: editor, export_view, storage, styled_view, view
|
|
66
|
+
* - Storage: atlas_doc_format, editor, export_view, styled_view, view
|
|
67
|
+
* - Editor: storage
|
|
60
68
|
*
|
|
61
69
|
* No other conversions are supported at the moment. Once a conversion is completed, it will be available for 5
|
|
62
70
|
* minutes at the result endpoint.
|
|
@@ -66,8 +74,8 @@ export declare class ContentBody {
|
|
|
66
74
|
*/
|
|
67
75
|
asyncConvertContentBodyRequest<T = Models.AsyncId>(parameters: Parameters.AsyncConvertContentBodyRequest, callback?: never): Promise<T>;
|
|
68
76
|
/**
|
|
69
|
-
* Returns the
|
|
70
|
-
*
|
|
77
|
+
* Returns the asynchronous content body for the corresponding id if the task is complete or returns the status of the
|
|
78
|
+
* task.
|
|
71
79
|
*
|
|
72
80
|
* After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is
|
|
73
81
|
* made again, with allowCache query param set to false.
|
|
@@ -77,8 +85,8 @@ export declare class ContentBody {
|
|
|
77
85
|
*/
|
|
78
86
|
asyncConvertContentBodyResponse<T = Models.AsyncContentBody>(parameters: Parameters.AsyncConvertContentBodyResponse, callback: Callback<T>): Promise<void>;
|
|
79
87
|
/**
|
|
80
|
-
* Returns the
|
|
81
|
-
*
|
|
88
|
+
* Returns the asynchronous content body for the corresponding id if the task is complete or returns the status of the
|
|
89
|
+
* task.
|
|
82
90
|
*
|
|
83
91
|
* After the task is completed, the result can be obtained for 5 minutes, or until an identical conversion request is
|
|
84
92
|
* made again, with allowCache query param set to false.
|
|
@@ -87,4 +95,62 @@ export declare class ContentBody {
|
|
|
87
95
|
* 'View' permission for the space, and permission to view the content.
|
|
88
96
|
*/
|
|
89
97
|
asyncConvertContentBodyResponse<T = Models.AsyncContentBody>(parameters: Parameters.AsyncConvertContentBodyResponse, callback?: never): Promise<T>;
|
|
98
|
+
/**
|
|
99
|
+
* Returns the content body for the corresponding `asyncId` of a completed conversion task. If the task is not
|
|
100
|
+
* completed, the task status is returned instead.
|
|
101
|
+
*
|
|
102
|
+
* Once a conversion task is completed, the result can be obtained for up to 5 minutes, or until an identical
|
|
103
|
+
* conversion request is made again with the `allowCache` parameter set to false.
|
|
104
|
+
*
|
|
105
|
+
* Note that there is a maximum limit of 50 task results per request to this endpoint.
|
|
106
|
+
*
|
|
107
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
108
|
+
* ('Can use' global permission).
|
|
109
|
+
*/
|
|
110
|
+
bulkAsyncConvertContentBodyResponse<T = Models.AsyncContentBody[]>(parameters: Parameters.BulkAsyncConvertContentBodyResponse, callback: Callback<T>): Promise<void>;
|
|
111
|
+
/**
|
|
112
|
+
* Returns the content body for the corresponding `asyncId` of a completed conversion task. If the task is not
|
|
113
|
+
* completed, the task status is returned instead.
|
|
114
|
+
*
|
|
115
|
+
* Once a conversion task is completed, the result can be obtained for up to 5 minutes, or until an identical
|
|
116
|
+
* conversion request is made again with the `allowCache` parameter set to false.
|
|
117
|
+
*
|
|
118
|
+
* Note that there is a maximum limit of 50 task results per request to this endpoint.
|
|
119
|
+
*
|
|
120
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
121
|
+
* ('Can use' global permission).
|
|
122
|
+
*/
|
|
123
|
+
bulkAsyncConvertContentBodyResponse<T = Models.AsyncContentBody[]>(parameters: Parameters.BulkAsyncConvertContentBodyResponse, callback?: never): Promise<T>;
|
|
124
|
+
/**
|
|
125
|
+
* Asynchronously converts content bodies from one format to another format in bulk. Use the Content body REST API to
|
|
126
|
+
* get the status of conversion tasks. Note that there is a maximum limit of 10 conversions per request to this
|
|
127
|
+
* endpoint.
|
|
128
|
+
*
|
|
129
|
+
* Supported conversions:
|
|
130
|
+
*
|
|
131
|
+
* - Storage: editor, export_view, styled_view, view
|
|
132
|
+
* - Editor: storage
|
|
133
|
+
*
|
|
134
|
+
* Once a conversion task is completed, it is available for polling for up to 5 minutes.
|
|
135
|
+
*
|
|
136
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
137
|
+
* permission to view the content if the `spaceKeyContext` or `contentIdContext` are present.
|
|
138
|
+
*/
|
|
139
|
+
bulkAsyncConvertContentBodyRequest<T = Models.AsyncId[]>(parameters: Parameters.BulkAsyncConvertContentBodyRequest, callback: Callback<T>): Promise<void>;
|
|
140
|
+
/**
|
|
141
|
+
* Asynchronously converts content bodies from one format to another format in bulk. Use the Content body REST API to
|
|
142
|
+
* get the status of conversion tasks. Note that there is a maximum limit of 10 conversions per request to this
|
|
143
|
+
* endpoint.
|
|
144
|
+
*
|
|
145
|
+
* Supported conversions:
|
|
146
|
+
*
|
|
147
|
+
* - Storage: editor, export_view, styled_view, view
|
|
148
|
+
* - Editor: storage
|
|
149
|
+
*
|
|
150
|
+
* Once a conversion task is completed, it is available for polling for up to 5 minutes.
|
|
151
|
+
*
|
|
152
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
153
|
+
* permission to view the content if the `spaceKeyContext` or `contentIdContext` are present.
|
|
154
|
+
*/
|
|
155
|
+
bulkAsyncConvertContentBodyRequest<T = Models.AsyncId[]>(parameters: Parameters.BulkAsyncConvertContentBodyRequest, callback?: never): Promise<T>;
|
|
90
156
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type * as Models from "./models/index.js";
|
|
2
2
|
import type * as Parameters from "./parameters/index.js";
|
|
3
|
-
import type { Callback } from "../callback.js";
|
|
4
3
|
import type { Client } from "../clients/index.js";
|
|
4
|
+
import type { Callback } from "../callback.js";
|
|
5
5
|
export declare class ContentChildrenAndDescendants {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -22,6 +22,8 @@ export declare class ContentChildrenAndDescendants {
|
|
|
22
22
|
*
|
|
23
23
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
24
24
|
* permission to view the content if it is a page.
|
|
25
|
+
*
|
|
26
|
+
* @deprecated Will be removed in next major version.
|
|
25
27
|
*/
|
|
26
28
|
getContentChildren<T = Models.ContentChildren>(parameters: Parameters.GetContentChildren, callback: Callback<T>): Promise<void>;
|
|
27
29
|
/**
|
|
@@ -41,6 +43,8 @@ export declare class ContentChildrenAndDescendants {
|
|
|
41
43
|
*
|
|
42
44
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
43
45
|
* permission to view the content if it is a page.
|
|
46
|
+
*
|
|
47
|
+
* @deprecated Will be removed in next major version.
|
|
44
48
|
*/
|
|
45
49
|
getContentChildren<T = Models.ContentChildren>(parameters: Parameters.GetContentChildren, callback?: never): Promise<T>;
|
|
46
50
|
/**
|
|
@@ -83,6 +87,8 @@ export declare class ContentChildrenAndDescendants {
|
|
|
83
87
|
*
|
|
84
88
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
85
89
|
* permission to view the content if it is a page.
|
|
90
|
+
*
|
|
91
|
+
* @deprecated Will be removed in next major version.
|
|
86
92
|
*/
|
|
87
93
|
getContentChildrenByType<T = Models.ContentArray>(parameters: Parameters.GetContentChildrenByType, callback: Callback<T>): Promise<void>;
|
|
88
94
|
/**
|
|
@@ -101,6 +107,8 @@ export declare class ContentChildrenAndDescendants {
|
|
|
101
107
|
*
|
|
102
108
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
103
109
|
* permission to view the content if it is a page.
|
|
110
|
+
*
|
|
111
|
+
* @deprecated Will be removed in next major version.
|
|
104
112
|
*/
|
|
105
113
|
getContentChildrenByType<T = Models.ContentArray>(parameters: Parameters.GetContentChildrenByType, callback?: never): Promise<T>;
|
|
106
114
|
/**
|
|
@@ -110,7 +118,11 @@ export declare class ContentChildrenAndDescendants {
|
|
|
110
118
|
*
|
|
111
119
|
* A piece of content has different types of descendants, depending on its type:
|
|
112
120
|
*
|
|
113
|
-
* - `page`: descendant is `page`, `comment`, `attachment`
|
|
121
|
+
* - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
122
|
+
* - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
123
|
+
* - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
124
|
+
* - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
125
|
+
* - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
114
126
|
* - `blogpost`: descendant is `comment`, `attachment`
|
|
115
127
|
* - `attachment`: descendant is `comment`
|
|
116
128
|
* - `comment`: descendant is `attachment`
|
|
@@ -129,7 +141,11 @@ export declare class ContentChildrenAndDescendants {
|
|
|
129
141
|
*
|
|
130
142
|
* A piece of content has different types of descendants, depending on its type:
|
|
131
143
|
*
|
|
132
|
-
* - `page`: descendant is `page`, `comment`, `attachment`
|
|
144
|
+
* - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
145
|
+
* - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
146
|
+
* - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
147
|
+
* - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
148
|
+
* - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
133
149
|
* - `blogpost`: descendant is `comment`, `attachment`
|
|
134
150
|
* - `attachment`: descendant is `comment`
|
|
135
151
|
* - `comment`: descendant is `attachment`
|
|
@@ -148,13 +164,20 @@ export declare class ContentChildrenAndDescendants {
|
|
|
148
164
|
*
|
|
149
165
|
* A piece of content has different types of descendants, depending on its type:
|
|
150
166
|
*
|
|
151
|
-
* - `page`: descendant is `page`, `comment`, `attachment`
|
|
167
|
+
* - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
168
|
+
* - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
169
|
+
* - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
170
|
+
* - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
171
|
+
* - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
152
172
|
* - `blogpost`: descendant is `comment`, `attachment`
|
|
153
173
|
* - `attachment`: descendant is `comment`
|
|
154
174
|
* - `comment`: descendant is `attachment`
|
|
155
175
|
*
|
|
156
176
|
* Custom content types that are provided by apps can also be returned.
|
|
157
177
|
*
|
|
178
|
+
* If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the
|
|
179
|
+
* query limit parameter will be restricted to a maximum value of 25.
|
|
180
|
+
*
|
|
158
181
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
159
182
|
* permission to view the content if it is a page.
|
|
160
183
|
*/
|
|
@@ -166,13 +189,20 @@ export declare class ContentChildrenAndDescendants {
|
|
|
166
189
|
*
|
|
167
190
|
* A piece of content has different types of descendants, depending on its type:
|
|
168
191
|
*
|
|
169
|
-
* - `page`: descendant is `page`, `comment`, `attachment`
|
|
192
|
+
* - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
193
|
+
* - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
194
|
+
* - `database`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
195
|
+
* - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
196
|
+
* - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`, `comment`, `attachment`
|
|
170
197
|
* - `blogpost`: descendant is `comment`, `attachment`
|
|
171
198
|
* - `attachment`: descendant is `comment`
|
|
172
199
|
* - `comment`: descendant is `attachment`
|
|
173
200
|
*
|
|
174
201
|
* Custom content types that are provided by apps can also be returned.
|
|
175
202
|
*
|
|
203
|
+
* If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the
|
|
204
|
+
* query limit parameter will be restricted to a maximum value of 25.
|
|
205
|
+
*
|
|
176
206
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
177
207
|
* permission to view the content if it is a page.
|
|
178
208
|
*/
|
|
@@ -200,6 +230,7 @@ export declare class ContentChildrenAndDescendants {
|
|
|
200
230
|
*
|
|
201
231
|
* - `space`: page will be copied to the specified space as a root page on the space
|
|
202
232
|
* - `parent_page`: page will be copied as a child of the specified parent page
|
|
233
|
+
* - `parent_content`: page will be copied as a child of the specified parent content
|
|
203
234
|
* - `existing_page`: page will be copied and replace the specified page
|
|
204
235
|
*
|
|
205
236
|
* By default, the following objects are expanded: `space`, `history`, `version`.
|
|
@@ -215,6 +246,7 @@ export declare class ContentChildrenAndDescendants {
|
|
|
215
246
|
*
|
|
216
247
|
* - `space`: page will be copied to the specified space as a root page on the space
|
|
217
248
|
* - `parent_page`: page will be copied as a child of the specified parent page
|
|
249
|
+
* - `parent_content`: page will be copied as a child of the specified parent content
|
|
218
250
|
* - `existing_page`: page will be copied and replace the specified page
|
|
219
251
|
*
|
|
220
252
|
* By default, the following objects are expanded: `space`, `history`, `version`.
|
|
@@ -2,6 +2,7 @@ import type * as Models from "./models/index.js";
|
|
|
2
2
|
import type * as Parameters from "./parameters/index.js";
|
|
3
3
|
import type { Callback } from "../callback.js";
|
|
4
4
|
import type { Client } from "../clients/index.js";
|
|
5
|
+
/** @deprecated Will be removed in next major version. */
|
|
5
6
|
export declare class ContentComments {
|
|
6
7
|
private client;
|
|
7
8
|
constructor(client: Client);
|
|
@@ -10,6 +11,8 @@ export declare class ContentComments {
|
|
|
10
11
|
*
|
|
11
12
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
12
13
|
* permission to view the content if it is a page.
|
|
14
|
+
*
|
|
15
|
+
* @deprecated Will be removed in next major version.
|
|
13
16
|
*/
|
|
14
17
|
getContentComments<T = Models.ContentArray>(parameters: Parameters.GetContentComments, callback: Callback<T>): Promise<void>;
|
|
15
18
|
/**
|
|
@@ -17,6 +20,8 @@ export declare class ContentComments {
|
|
|
17
20
|
*
|
|
18
21
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space, and
|
|
19
22
|
* permission to view the content if it is a page.
|
|
23
|
+
*
|
|
24
|
+
* @deprecated Will be removed in next major version.
|
|
20
25
|
*/
|
|
21
26
|
getContentComments<T = Models.ContentArray>(parameters: Parameters.GetContentComments, callback?: never): Promise<T>;
|
|
22
27
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type * as Models from "./models/index.js";
|
|
2
2
|
import type * as Parameters from "./parameters/index.js";
|
|
3
|
-
import type { Callback } from "../callback.js";
|
|
4
3
|
import type { Client } from "../clients/index.js";
|
|
4
|
+
import type { Callback } from "../callback.js";
|
|
5
5
|
export declare class ContentLabels {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -10,6 +10,8 @@ export declare class ContentLabels {
|
|
|
10
10
|
*
|
|
11
11
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space and
|
|
12
12
|
* permission to view the content if it is a page.
|
|
13
|
+
*
|
|
14
|
+
* @deprecated Will be removed in next major version.
|
|
13
15
|
*/
|
|
14
16
|
getLabelsForContent<T = Models.LabelArray>(parameters: Parameters.GetLabelsForContent, callback: Callback<T>): Promise<void>;
|
|
15
17
|
/**
|
|
@@ -17,6 +19,8 @@ export declare class ContentLabels {
|
|
|
17
19
|
*
|
|
18
20
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space and
|
|
19
21
|
* permission to view the content if it is a page.
|
|
22
|
+
*
|
|
23
|
+
* @deprecated Will be removed in next major version.
|
|
20
24
|
*/
|
|
21
25
|
getLabelsForContent<T = Models.LabelArray>(parameters: Parameters.GetLabelsForContent, callback?: never): Promise<T>;
|
|
22
26
|
/**
|
|
@@ -44,8 +48,9 @@ export declare class ContentLabels {
|
|
|
44
48
|
*/
|
|
45
49
|
addLabelsToContent<T = Models.LabelArray>(parameters: Parameters.AddLabelsToContent, callback?: never): Promise<T>;
|
|
46
50
|
/**
|
|
47
|
-
* Removes a label from a piece of content. This is similar to [Remove
|
|
48
|
-
* content](#api-content-id-label-label-delete) except that the label name is specified via a query
|
|
51
|
+
* Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove
|
|
52
|
+
* label from content](#api-content-id-label-label-delete) except that the label name is specified via a query
|
|
53
|
+
* parameter.
|
|
49
54
|
*
|
|
50
55
|
* Use this method if the label name has "/" characters, as [Remove label from content using query
|
|
51
56
|
* parameter](#api-content-id-label-delete) does not accept "/" characters for the label name.
|
|
@@ -54,8 +59,9 @@ export declare class ContentLabels {
|
|
|
54
59
|
*/
|
|
55
60
|
removeLabelFromContentUsingQueryParameter<T = void>(parameters: Parameters.RemoveLabelFromContentUsingQueryParameter, callback: Callback<T>): Promise<void>;
|
|
56
61
|
/**
|
|
57
|
-
* Removes a label from a piece of content. This is similar to [Remove
|
|
58
|
-
* content](#api-content-id-label-label-delete) except that the label name is specified via a query
|
|
62
|
+
* Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove
|
|
63
|
+
* label from content](#api-content-id-label-label-delete) except that the label name is specified via a query
|
|
64
|
+
* parameter.
|
|
59
65
|
*
|
|
60
66
|
* Use this method if the label name has "/" characters, as [Remove label from content using query
|
|
61
67
|
* parameter](#api-content-id-label-delete) does not accept "/" characters for the label name.
|
|
@@ -64,8 +70,9 @@ export declare class ContentLabels {
|
|
|
64
70
|
*/
|
|
65
71
|
removeLabelFromContentUsingQueryParameter<T = void>(parameters: Parameters.RemoveLabelFromContentUsingQueryParameter, callback?: never): Promise<T>;
|
|
66
72
|
/**
|
|
67
|
-
* Removes a label from a piece of content. This is similar to [Remove
|
|
68
|
-
* parameter](#api-content-id-label-delete) except that the label name is specified via
|
|
73
|
+
* Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove
|
|
74
|
+
* label from content using query parameter](#api-content-id-label-delete) except that the label name is specified via
|
|
75
|
+
* a path parameter.
|
|
69
76
|
*
|
|
70
77
|
* Use this method if the label name does not have "/" characters, as the path parameter does not accept "/"
|
|
71
78
|
* characters for security reasons. Otherwise, use [Remove label from content using query
|
|
@@ -75,8 +82,9 @@ export declare class ContentLabels {
|
|
|
75
82
|
*/
|
|
76
83
|
removeLabelFromContent<T = void>(parameters: Parameters.RemoveLabelFromContent, callback: Callback<T>): Promise<void>;
|
|
77
84
|
/**
|
|
78
|
-
* Removes a label from a piece of content. This is similar to [Remove
|
|
79
|
-
* parameter](#api-content-id-label-delete) except that the label name is specified via
|
|
85
|
+
* Removes a label from a piece of content. Labels can't be deleted from archived content. This is similar to [Remove
|
|
86
|
+
* label from content using query parameter](#api-content-id-label-delete) except that the label name is specified via
|
|
87
|
+
* a path parameter.
|
|
80
88
|
*
|
|
81
89
|
* Use this method if the label name does not have "/" characters, as the path parameter does not accept "/"
|
|
82
90
|
* characters for security reasons. Otherwise, use [Remove label from content using query
|