confluence.js 2.0.0-dev20250512202536 → 2.1.0
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 +52 -2
- package/README.md +145 -183
- 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.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 +3 -1
- 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.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 +3 -1
- 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/confluenceClient.d.ts +6 -1
- package/eslint.config.ts +11 -16
- package/package.json +29 -28
- 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 +1 -5
- package/src/clients/confluenceClient.ts +6 -0
- package/src/config.ts +4 -1
- 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 ContentRestrictions {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -87,26 +87,30 @@ export declare class ContentRestrictions {
|
|
|
87
87
|
* Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
|
|
88
88
|
* `read` restriction for the `admins` group, the following request will return `true`:
|
|
89
89
|
*
|
|
90
|
-
* `https://your-domain.atlassian.net/
|
|
90
|
+
* `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/group/admins`
|
|
91
91
|
*
|
|
92
92
|
* Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
|
|
93
93
|
* account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
|
|
94
94
|
* permissions](https://confluence.atlassian.com/x/_AozKw).
|
|
95
95
|
*
|
|
96
96
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
|
|
97
|
+
*
|
|
98
|
+
* @deprecated Will be removed in next major version.
|
|
97
99
|
*/
|
|
98
100
|
getContentRestrictionStatusForGroup<T = unknown>(parameters: Parameters.GetContentRestrictionStatusForGroup, callback: Callback<T>): Promise<void>;
|
|
99
101
|
/**
|
|
100
102
|
* Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
|
|
101
103
|
* `read` restriction for the `admins` group, the following request will return `true`:
|
|
102
104
|
*
|
|
103
|
-
* `https://your-domain.atlassian.net/
|
|
105
|
+
* `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/group/admins`
|
|
104
106
|
*
|
|
105
107
|
* Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
|
|
106
108
|
* account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
|
|
107
109
|
* permissions](https://confluence.atlassian.com/x/_AozKw).
|
|
108
110
|
*
|
|
109
111
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content.
|
|
112
|
+
*
|
|
113
|
+
* @deprecated Will be removed in next major version.
|
|
110
114
|
*/
|
|
111
115
|
getContentRestrictionStatusForGroup<T = unknown>(parameters: Parameters.GetContentRestrictionStatusForGroup, callback?: never): Promise<T>;
|
|
112
116
|
/**
|
|
@@ -114,6 +118,8 @@ export declare class ContentRestrictions {
|
|
|
114
118
|
* content.
|
|
115
119
|
*
|
|
116
120
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
|
|
121
|
+
*
|
|
122
|
+
* @deprecated Will be removed in next major version.
|
|
117
123
|
*/
|
|
118
124
|
addGroupToContentRestriction<T = unknown>(parameters: Parameters.AddGroupToContentRestriction, callback: Callback<T>): Promise<void>;
|
|
119
125
|
/**
|
|
@@ -121,6 +127,8 @@ export declare class ContentRestrictions {
|
|
|
121
127
|
* content.
|
|
122
128
|
*
|
|
123
129
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
|
|
130
|
+
*
|
|
131
|
+
* @deprecated Will be removed in next major version.
|
|
124
132
|
*/
|
|
125
133
|
addGroupToContentRestriction<T = unknown>(parameters: Parameters.AddGroupToContentRestriction, callback?: never): Promise<T>;
|
|
126
134
|
/**
|
|
@@ -128,6 +136,8 @@ export declare class ContentRestrictions {
|
|
|
128
136
|
* content.
|
|
129
137
|
*
|
|
130
138
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
|
|
139
|
+
*
|
|
140
|
+
* @deprecated Will be removed in next major version.
|
|
131
141
|
*/
|
|
132
142
|
removeGroupByName<T = unknown>(parameters: Parameters.RemoveGroupByName, callback: Callback<T>): Promise<void>;
|
|
133
143
|
/**
|
|
@@ -135,13 +145,15 @@ export declare class ContentRestrictions {
|
|
|
135
145
|
* content.
|
|
136
146
|
*
|
|
137
147
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to edit the content.
|
|
148
|
+
*
|
|
149
|
+
* @deprecated Will be removed in next major version.
|
|
138
150
|
*/
|
|
139
151
|
removeGroupByName<T = unknown>(parameters: Parameters.RemoveGroupByName, callback?: never): Promise<T>;
|
|
140
152
|
/**
|
|
141
153
|
* Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
|
|
142
154
|
* `read` restriction for the `123456` group id, the following request will return `true`:
|
|
143
155
|
*
|
|
144
|
-
* `https://your-domain.atlassian.net/
|
|
156
|
+
* `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/byGroupId/123456`
|
|
145
157
|
*
|
|
146
158
|
* Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
|
|
147
159
|
* account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
|
|
@@ -154,7 +166,7 @@ export declare class ContentRestrictions {
|
|
|
154
166
|
* Returns whether the specified content restriction applies to a group. For example, if a page with `id=123` has a
|
|
155
167
|
* `read` restriction for the `123456` group id, the following request will return `true`:
|
|
156
168
|
*
|
|
157
|
-
* `https://your-domain.atlassian.net/
|
|
169
|
+
* `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/byGroupId/123456`
|
|
158
170
|
*
|
|
159
171
|
* Note that a response of `true` does not guarantee that the group can view the page, as it does not account for
|
|
160
172
|
* account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
|
|
@@ -196,7 +208,7 @@ export declare class ContentRestrictions {
|
|
|
196
208
|
* `read` restriction for a user with an account ID of `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following
|
|
197
209
|
* request will return `true`:
|
|
198
210
|
*
|
|
199
|
-
* `https://your-domain.atlassian.net/
|
|
211
|
+
* `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
|
|
200
212
|
*
|
|
201
213
|
* Note that a response of `true` does not guarantee that the user can view the page, as it does not account for
|
|
202
214
|
* account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
|
|
@@ -210,7 +222,7 @@ export declare class ContentRestrictions {
|
|
|
210
222
|
* `read` restriction for a user with an account ID of `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`, the following
|
|
211
223
|
* request will return `true`:
|
|
212
224
|
*
|
|
213
|
-
* `https://your-domain.atlassian.net/
|
|
225
|
+
* `https://your-domain.atlassian.net/api/content/123/restriction/byOperation/read/user?accountId=384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`
|
|
214
226
|
*
|
|
215
227
|
* Note that a response of `true` does not guarantee that the user can view the page, as it does not account for
|
|
216
228
|
* account-inherited restrictions, space permissions, or even product access. For more information, see [Confluence
|
|
@@ -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 ContentStates {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -94,27 +94,45 @@ export declare class ContentStates {
|
|
|
94
94
|
/**
|
|
95
95
|
* Get content states that are suggested in the space.
|
|
96
96
|
*
|
|
97
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
97
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
|
|
98
98
|
*/
|
|
99
99
|
getSpaceContentStates<T = Models.ContentState[]>(parameters: Parameters.GetSpaceContentStates, callback: Callback<T>): Promise<void>;
|
|
100
100
|
/**
|
|
101
101
|
* Get content states that are suggested in the space.
|
|
102
102
|
*
|
|
103
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
103
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
|
|
104
104
|
*/
|
|
105
105
|
getSpaceContentStates<T = Models.ContentState[]>(parameters: Parameters.GetSpaceContentStates, callback?: never): Promise<T>;
|
|
106
106
|
/**
|
|
107
107
|
* Get object describing whether content states are allowed at all, if custom content states or space content states
|
|
108
108
|
* are restricted, and a list of space content states allowed for the space if they are not restricted.
|
|
109
109
|
*
|
|
110
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
110
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
|
|
111
111
|
*/
|
|
112
112
|
getContentStateSettings<T = Models.ContentStateSettings>(parameters: Parameters.GetContentStateSettings, callback: Callback<T>): Promise<void>;
|
|
113
113
|
/**
|
|
114
114
|
* Get object describing whether content states are allowed at all, if custom content states or space content states
|
|
115
115
|
* are restricted, and a list of space content states allowed for the space if they are not restricted.
|
|
116
116
|
*
|
|
117
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
117
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
|
|
118
118
|
*/
|
|
119
119
|
getContentStateSettings<T = Models.ContentStateSettings>(parameters: Parameters.GetContentStateSettings, callback?: never): Promise<T>;
|
|
120
|
+
/**
|
|
121
|
+
* Returns all content that has the provided content state in a space.
|
|
122
|
+
*
|
|
123
|
+
* If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the
|
|
124
|
+
* query limit parameter will be restricted to a maximum value of 25.
|
|
125
|
+
*
|
|
126
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
|
|
127
|
+
*/
|
|
128
|
+
getContentsWithState<T = Models.ContentArray>(parameters: Parameters.GetContentsWithState, callback: Callback<T>): Promise<void>;
|
|
129
|
+
/**
|
|
130
|
+
* Returns all content that has the provided content state in a space.
|
|
131
|
+
*
|
|
132
|
+
* If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the
|
|
133
|
+
* query limit parameter will be restricted to a maximum value of 25.
|
|
134
|
+
*
|
|
135
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
|
|
136
|
+
*/
|
|
137
|
+
getContentsWithState<T = Models.ContentArray>(parameters: Parameters.GetContentsWithState, callback?: never): Promise<T>;
|
|
120
138
|
}
|
|
@@ -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 ContentVersions {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -10,6 +10,8 @@ export declare class ContentVersions {
|
|
|
10
10
|
*
|
|
11
11
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
12
12
|
* content is a blog post, 'View' permission for the space is required.
|
|
13
|
+
*
|
|
14
|
+
* @deprecated Will be removed in next major version.
|
|
13
15
|
*/
|
|
14
16
|
getContentVersions<T = Models.VersionArray>(parameters: Parameters.GetContentVersions, callback: Callback<T>): Promise<void>;
|
|
15
17
|
/**
|
|
@@ -17,6 +19,8 @@ export declare class ContentVersions {
|
|
|
17
19
|
*
|
|
18
20
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
19
21
|
* content is a blog post, 'View' permission for the space is required.
|
|
22
|
+
*
|
|
23
|
+
* @deprecated Will be removed in next major version.
|
|
20
24
|
*/
|
|
21
25
|
getContentVersions<T = Models.VersionArray>(parameters: Parameters.GetContentVersions, callback?: never): Promise<T>;
|
|
22
26
|
/**
|
|
@@ -38,6 +42,8 @@ export declare class ContentVersions {
|
|
|
38
42
|
*
|
|
39
43
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
40
44
|
* content is a blog post, 'View' permission for the space is required.
|
|
45
|
+
*
|
|
46
|
+
* @deprecated Will be removed in next major version.
|
|
41
47
|
*/
|
|
42
48
|
getContentVersion<T = Models.Version>(parameters: Parameters.GetContentVersion, callback: Callback<T>): Promise<void>;
|
|
43
49
|
/**
|
|
@@ -45,6 +51,8 @@ export declare class ContentVersions {
|
|
|
45
51
|
*
|
|
46
52
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content. If the
|
|
47
53
|
* content is a blog post, 'View' permission for the space is required.
|
|
54
|
+
*
|
|
55
|
+
* @deprecated Will be removed in next major version.
|
|
48
56
|
*/
|
|
49
57
|
getContentVersion<T = Models.Version>(parameters: Parameters.GetContentVersion, callback?: never): Promise<T>;
|
|
50
58
|
/**
|
|
@@ -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 ContentWatches {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type * as Parameters from "./parameters/index.js";
|
|
2
|
-
import type { Callback } from "../callback.js";
|
|
3
2
|
import type { Client } from "../clients/index.js";
|
|
3
|
+
import type { Callback } from "../callback.js";
|
|
4
4
|
export declare class DynamicModules {
|
|
5
5
|
private client;
|
|
6
6
|
constructor(client: Client);
|
|
@@ -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 Experimental {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -76,6 +76,8 @@ export declare class Experimental {
|
|
|
76
76
|
*
|
|
77
77
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
78
78
|
* ('Can use' global permission).
|
|
79
|
+
*
|
|
80
|
+
* @deprecated Will be removed in next major version. Use `userProperties.getUserProperties` instead.
|
|
79
81
|
*/
|
|
80
82
|
getUserProperties<T = Models.UserPropertyKeyArray>(parameters: Parameters.GetUserProperties, callback: Callback<T>): Promise<void>;
|
|
81
83
|
/**
|
|
@@ -85,6 +87,8 @@ export declare class Experimental {
|
|
|
85
87
|
*
|
|
86
88
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
87
89
|
* ('Can use' global permission).
|
|
90
|
+
*
|
|
91
|
+
* @deprecated Will be removed in next major version. Use `userProperties.getUserProperties` instead.
|
|
88
92
|
*/
|
|
89
93
|
getUserProperties<T = Models.UserPropertyKeyArray>(parameters: Parameters.GetUserProperties, callback?: never): Promise<T>;
|
|
90
94
|
/**
|
|
@@ -94,6 +98,8 @@ export declare class Experimental {
|
|
|
94
98
|
*
|
|
95
99
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
96
100
|
* ('Can use' global permission).
|
|
101
|
+
*
|
|
102
|
+
* @deprecated Will be removed in next major version. Use `userProperties.getUserProperty` instead.
|
|
97
103
|
*/
|
|
98
104
|
getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback: Callback<T>): Promise<void>;
|
|
99
105
|
/**
|
|
@@ -103,6 +109,8 @@ export declare class Experimental {
|
|
|
103
109
|
*
|
|
104
110
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
105
111
|
* ('Can use' global permission).
|
|
112
|
+
*
|
|
113
|
+
* @deprecated Will be removed in next major version. Use `userProperties.getUserProperty` instead.
|
|
106
114
|
*/
|
|
107
115
|
getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;
|
|
108
116
|
/**
|
|
@@ -113,6 +121,8 @@ export declare class Experimental {
|
|
|
113
121
|
* `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
|
|
114
122
|
* fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
|
|
115
123
|
* the Confluence site ('Can use' global permission).
|
|
124
|
+
*
|
|
125
|
+
* @deprecated Will be removed in next major version. Use `userProperties.createUserProperty` instead.
|
|
116
126
|
*/
|
|
117
127
|
createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback: Callback<T>): Promise<void>;
|
|
118
128
|
/**
|
|
@@ -123,6 +133,8 @@ export declare class Experimental {
|
|
|
123
133
|
* `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
|
|
124
134
|
* fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
|
|
125
135
|
* the Confluence site ('Can use' global permission).
|
|
136
|
+
*
|
|
137
|
+
* @deprecated Will be removed in next major version. Use `userProperties.createUserProperty` instead.
|
|
126
138
|
*/
|
|
127
139
|
createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;
|
|
128
140
|
/**
|
|
@@ -133,6 +145,8 @@ export declare class Experimental {
|
|
|
133
145
|
*
|
|
134
146
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
135
147
|
* ('Can use' global permission).
|
|
148
|
+
*
|
|
149
|
+
* @deprecated Will be removed in next major version. Use `userProperties.updateUserProperty` instead.
|
|
136
150
|
*/
|
|
137
151
|
updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;
|
|
138
152
|
/**
|
|
@@ -143,6 +157,8 @@ export declare class Experimental {
|
|
|
143
157
|
*
|
|
144
158
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
145
159
|
* ('Can use' global permission).
|
|
160
|
+
*
|
|
161
|
+
* @deprecated Will be removed in next major version. Use `userProperties.updateUserProperty` instead.
|
|
146
162
|
*/
|
|
147
163
|
updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;
|
|
148
164
|
/**
|
|
@@ -152,6 +168,8 @@ export declare class Experimental {
|
|
|
152
168
|
*
|
|
153
169
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
154
170
|
* ('Can use' global permission).
|
|
171
|
+
*
|
|
172
|
+
* @deprecated Will be removed in next major version. Use `userProperties.deleteUserProperty` instead.
|
|
155
173
|
*/
|
|
156
174
|
deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;
|
|
157
175
|
/**
|
|
@@ -161,6 +179,8 @@ export declare class Experimental {
|
|
|
161
179
|
*
|
|
162
180
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
163
181
|
* ('Can use' global permission).
|
|
182
|
+
*
|
|
183
|
+
* @deprecated Will be removed in next major version. Use `userProperties.deleteUserProperty` instead.
|
|
164
184
|
*/
|
|
165
185
|
deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;
|
|
166
186
|
}
|
|
@@ -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 Group {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -35,12 +35,16 @@ export declare class Group {
|
|
|
35
35
|
* Delete user group.
|
|
36
36
|
*
|
|
37
37
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
38
|
+
*
|
|
39
|
+
* @deprecated Will be removed in next major version.
|
|
38
40
|
*/
|
|
39
41
|
removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback: Callback<T>): Promise<void>;
|
|
40
42
|
/**
|
|
41
43
|
* Delete user group.
|
|
42
44
|
*
|
|
43
45
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
46
|
+
*
|
|
47
|
+
* @deprecated Will be removed in next major version.
|
|
44
48
|
*/
|
|
45
49
|
removeGroup<T = void>(parameters: Parameters.RemoveGroup, callback?: never): Promise<T>;
|
|
46
50
|
/**
|
|
@@ -48,6 +52,8 @@ export declare class Group {
|
|
|
48
52
|
*
|
|
49
53
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
50
54
|
* ('Can use' global permission).
|
|
55
|
+
*
|
|
56
|
+
* @deprecated Will be removed in next major version.
|
|
51
57
|
*/
|
|
52
58
|
getGroupByQueryParam<T = Models.Group>(parameters: Parameters.GetGroupByQueryParam, callback: Callback<T>): Promise<void>;
|
|
53
59
|
/**
|
|
@@ -55,6 +61,8 @@ export declare class Group {
|
|
|
55
61
|
*
|
|
56
62
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
57
63
|
* ('Can use' global permission).
|
|
64
|
+
*
|
|
65
|
+
* @deprecated Will be removed in next major version.
|
|
58
66
|
*/
|
|
59
67
|
getGroupByQueryParam<T = Models.Group>(parameters: Parameters.GetGroupByQueryParam, callback?: never): Promise<T>;
|
|
60
68
|
/**
|
|
@@ -76,13 +84,13 @@ export declare class Group {
|
|
|
76
84
|
*
|
|
77
85
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
78
86
|
*/
|
|
79
|
-
removeGroupById<T = void>(parameters: Parameters.
|
|
87
|
+
removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback: Callback<T>): Promise<void>;
|
|
80
88
|
/**
|
|
81
89
|
* Delete user group.
|
|
82
90
|
*
|
|
83
91
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
84
92
|
*/
|
|
85
|
-
removeGroupById<T = void>(parameters: Parameters.
|
|
93
|
+
removeGroupById<T = void>(parameters: Parameters.DeleteGroupById, callback?: never): Promise<T>;
|
|
86
94
|
/**
|
|
87
95
|
* Returns a user group for a given group name.
|
|
88
96
|
*
|
|
@@ -90,6 +98,8 @@ export declare class Group {
|
|
|
90
98
|
*
|
|
91
99
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
92
100
|
* ('Can use' global permission).
|
|
101
|
+
*
|
|
102
|
+
* @deprecated Will be removed in next major version.
|
|
93
103
|
*/
|
|
94
104
|
getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback: Callback<T>): Promise<void>;
|
|
95
105
|
/**
|
|
@@ -99,6 +109,8 @@ export declare class Group {
|
|
|
99
109
|
*
|
|
100
110
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
101
111
|
* ('Can use' global permission).
|
|
112
|
+
*
|
|
113
|
+
* @deprecated Will be removed in next major version.
|
|
102
114
|
*/
|
|
103
115
|
getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback?: never): Promise<T>;
|
|
104
116
|
/**
|
|
@@ -106,6 +118,8 @@ export declare class Group {
|
|
|
106
118
|
*
|
|
107
119
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
108
120
|
* ('Can use' global permission).
|
|
121
|
+
*
|
|
122
|
+
* @deprecated Will be removed in next major version.
|
|
109
123
|
*/
|
|
110
124
|
getMembersByQueryParam<T = Models.UserArray>(parameters: Parameters.GetMembersByQueryParam, callback: Callback<T>): Promise<void>;
|
|
111
125
|
/**
|
|
@@ -113,8 +127,14 @@ export declare class Group {
|
|
|
113
127
|
*
|
|
114
128
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
115
129
|
* ('Can use' global permission).
|
|
130
|
+
*
|
|
131
|
+
* @deprecated Will be removed in next major version.
|
|
116
132
|
*/
|
|
117
133
|
getMembersByQueryParam<T = Models.UserArray>(parameters: Parameters.GetMembersByQueryParam, callback?: never): Promise<T>;
|
|
134
|
+
/** Get search results of groups by partial query provided. */
|
|
135
|
+
searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback: Callback<T>): Promise<void>;
|
|
136
|
+
/** Get search results of groups by partial query provided. */
|
|
137
|
+
searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
|
|
118
138
|
/**
|
|
119
139
|
* Returns the users that are members of a group.
|
|
120
140
|
*
|
|
@@ -123,7 +143,7 @@ export declare class Group {
|
|
|
123
143
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
124
144
|
* ('Can use' global permission).
|
|
125
145
|
*/
|
|
126
|
-
|
|
146
|
+
getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback: Callback<T>): Promise<void>;
|
|
127
147
|
/**
|
|
128
148
|
* Returns the users that are members of a group.
|
|
129
149
|
*
|
|
@@ -132,11 +152,7 @@ export declare class Group {
|
|
|
132
152
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
133
153
|
* ('Can use' global permission).
|
|
134
154
|
*/
|
|
135
|
-
|
|
136
|
-
/** Get search results of groups by partial query provided. */
|
|
137
|
-
searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback: Callback<T>): Promise<void>;
|
|
138
|
-
/** Get search results of groups by partial query provided. */
|
|
139
|
-
searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
|
|
155
|
+
getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback?: never): Promise<T>;
|
|
140
156
|
/**
|
|
141
157
|
* Adds a user as a member in a group represented by its groupId
|
|
142
158
|
*
|
|
@@ -161,24 +177,6 @@ export declare class Group {
|
|
|
161
177
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
162
178
|
*/
|
|
163
179
|
removeMemberFromGroupByGroupId<T = void>(parameters: Parameters.RemoveMemberFromGroupByGroupId, callback?: never): Promise<T>;
|
|
164
|
-
/**
|
|
165
|
-
* Returns the users that are members of a group.
|
|
166
|
-
*
|
|
167
|
-
* Use updated Get group API
|
|
168
|
-
*
|
|
169
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
170
|
-
* ('Can use' global permission).
|
|
171
|
-
*/
|
|
172
|
-
getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback: Callback<T>): Promise<void>;
|
|
173
|
-
/**
|
|
174
|
-
* Returns the users that are members of a group.
|
|
175
|
-
*
|
|
176
|
-
* Use updated Get group API
|
|
177
|
-
*
|
|
178
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
179
|
-
* ('Can use' global permission).
|
|
180
|
-
*/
|
|
181
|
-
getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback?: never): Promise<T>;
|
|
182
180
|
/**
|
|
183
181
|
* Adds a user as a member in a group.
|
|
184
182
|
*
|
|
@@ -203,4 +201,26 @@ export declare class Group {
|
|
|
203
201
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
204
202
|
*/
|
|
205
203
|
removeMemberFromGroup<T = void>(parameters: Parameters.RemoveMemberFromGroup, callback?: never): Promise<T>;
|
|
204
|
+
/**
|
|
205
|
+
* Returns the users that are members of a group.
|
|
206
|
+
*
|
|
207
|
+
* Use updated Get group API
|
|
208
|
+
*
|
|
209
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
210
|
+
* ('Can use' global permission).
|
|
211
|
+
*
|
|
212
|
+
* @deprecated Will be removed in next major version. Use `group.getGroupMembersByGroupId`
|
|
213
|
+
*/
|
|
214
|
+
getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback: Callback<T>): Promise<void>;
|
|
215
|
+
/**
|
|
216
|
+
* Returns the users that are members of a group.
|
|
217
|
+
*
|
|
218
|
+
* Use updated Get group API
|
|
219
|
+
*
|
|
220
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
221
|
+
* ('Can use' global permission).
|
|
222
|
+
*
|
|
223
|
+
* @deprecated Will be removed in next major version. Use `group.getGroupMembersByGroupId`
|
|
224
|
+
*/
|
|
225
|
+
getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;
|
|
206
226
|
}
|
|
@@ -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 InlineTasks {
|
|
6
7
|
private client;
|
|
7
8
|
constructor(client: Client);
|
|
@@ -10,6 +11,8 @@ export declare class InlineTasks {
|
|
|
10
11
|
*
|
|
11
12
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
12
13
|
* ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
|
|
14
|
+
*
|
|
15
|
+
* @deprecated Will be removed in next major version.
|
|
13
16
|
*/
|
|
14
17
|
searchTasks<T = Models.TaskPageResponse>(parameters: Parameters.SearchTasks | undefined, callback: Callback<T>): Promise<void>;
|
|
15
18
|
/**
|
|
@@ -17,6 +20,8 @@ export declare class InlineTasks {
|
|
|
17
20
|
*
|
|
18
21
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
19
22
|
* ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
|
|
23
|
+
*
|
|
24
|
+
* @deprecated Will be removed in next major version.
|
|
20
25
|
*/
|
|
21
26
|
searchTasks<T = Models.TaskPageResponse>(parameters?: Parameters.SearchTasks, callback?: never): Promise<T>;
|
|
22
27
|
/**
|
|
@@ -24,6 +29,8 @@ export declare class InlineTasks {
|
|
|
24
29
|
*
|
|
25
30
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
|
|
26
31
|
* with the task.
|
|
32
|
+
*
|
|
33
|
+
* @deprecated Will be removed in next major version.
|
|
27
34
|
*/
|
|
28
35
|
getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback: Callback<T>): Promise<void>;
|
|
29
36
|
/**
|
|
@@ -31,6 +38,8 @@ export declare class InlineTasks {
|
|
|
31
38
|
*
|
|
32
39
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
|
|
33
40
|
* with the task.
|
|
41
|
+
*
|
|
42
|
+
* @deprecated Will be removed in next major version.
|
|
34
43
|
*/
|
|
35
44
|
getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;
|
|
36
45
|
/**
|
|
@@ -38,6 +47,8 @@ export declare class InlineTasks {
|
|
|
38
47
|
*
|
|
39
48
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
|
|
40
49
|
* with the task.
|
|
50
|
+
*
|
|
51
|
+
* @deprecated Will be removed in next major version.
|
|
41
52
|
*/
|
|
42
53
|
updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback: Callback<T>): Promise<void>;
|
|
43
54
|
/**
|
|
@@ -45,6 +56,8 @@ export declare class InlineTasks {
|
|
|
45
56
|
*
|
|
46
57
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
|
|
47
58
|
* with the task.
|
|
59
|
+
*
|
|
60
|
+
* @deprecated Will be removed in next major version.
|
|
48
61
|
*/
|
|
49
62
|
updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;
|
|
50
63
|
}
|
|
@@ -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 LabelInfo {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -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 LongRunningTask {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -2,10 +2,19 @@ import type { SpaceDescriptionCreate } from "./spaceDescriptionCreate.js";
|
|
|
2
2
|
import type { SpacePermission } from "./spacePermission.js";
|
|
3
3
|
/** This is the request object used when creating a new space. */
|
|
4
4
|
export interface SpaceCreate {
|
|
5
|
-
/** The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). */
|
|
6
|
-
key: string;
|
|
7
5
|
/** The name of the new space. */
|
|
8
6
|
name: string;
|
|
7
|
+
/**
|
|
8
|
+
* The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not
|
|
9
|
+
* provided, this is required.
|
|
10
|
+
*/
|
|
11
|
+
key?: string;
|
|
12
|
+
/**
|
|
13
|
+
* This field will be used as the new identifier for the space in confluence page URLs. If the property is not
|
|
14
|
+
* provided the alias will be the provided key. This property is experimental and may be changed or removed in the
|
|
15
|
+
* future.
|
|
16
|
+
*/
|
|
17
|
+
alias?: string;
|
|
9
18
|
description?: SpaceDescriptionCreate;
|
|
10
19
|
/**
|
|
11
20
|
* The permissions for the new space. If no permissions are provided, the [Confluence default space
|
|
@@ -2,10 +2,19 @@ import type { SpaceDescriptionCreate } from "./spaceDescriptionCreate.js";
|
|
|
2
2
|
import type { SpacePermissionCreate } from "./spacePermissionCreate.js";
|
|
3
3
|
/** This is the request object used when creating a new private space. */
|
|
4
4
|
export interface SpacePrivateCreate {
|
|
5
|
-
/** The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). */
|
|
6
|
-
key: string;
|
|
7
5
|
/** The name of the new space. */
|
|
8
6
|
name: string;
|
|
7
|
+
/**
|
|
8
|
+
* The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). If `alias` is not
|
|
9
|
+
* provided, this is required.
|
|
10
|
+
*/
|
|
11
|
+
key?: string;
|
|
12
|
+
/**
|
|
13
|
+
* This field will be used as the new identifier for the space in confluence page URLs. If the property is not
|
|
14
|
+
* provided the alias will be the provided key. This property is experimental and may be changed or removed in the
|
|
15
|
+
* future.
|
|
16
|
+
*/
|
|
17
|
+
alias?: string;
|
|
9
18
|
description?: SpaceDescriptionCreate;
|
|
10
19
|
/**
|
|
11
20
|
* The permissions for the new space. If no permissions are provided, the [Confluence default space
|