confluence.js 1.3.1 → 1.4.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 +12 -0
- package/README.md +15 -0
- package/out/api/analytics.d.ts +16 -0
- package/out/api/analytics.js +34 -0
- package/out/api/audit.d.ts +1 -1
- package/out/api/audit.js +6 -6
- package/out/api/content.d.ts +1 -1
- package/out/api/content.js +10 -10
- package/out/api/contentAttachments.d.ts +1 -1
- package/out/api/contentAttachments.js +6 -6
- package/out/api/contentBody.d.ts +1 -1
- package/out/api/contentBody.js +1 -1
- package/out/api/contentChildrenAndDescendants.d.ts +3 -3
- package/out/api/contentChildrenAndDescendants.js +9 -8
- package/out/api/contentComments.d.ts +1 -1
- package/out/api/contentComments.js +1 -1
- package/out/api/contentContentState.d.ts +58 -0
- package/out/api/contentContentState.js +63 -0
- package/out/api/contentLabels.d.ts +1 -1
- package/out/api/contentLabels.js +4 -4
- package/out/api/contentMacroBody.d.ts +1 -1
- package/out/api/contentMacroBody.js +1 -1
- package/out/api/contentPermissions.d.ts +1 -1
- package/out/api/contentPermissions.js +2 -2
- package/out/api/contentProperties.d.ts +1 -1
- package/out/api/contentProperties.js +6 -6
- package/out/api/contentRestrictions.d.ts +1 -1
- package/out/api/contentRestrictions.js +15 -15
- package/out/api/contentVersions.d.ts +1 -1
- package/out/api/contentVersions.js +4 -4
- package/out/api/contentWatches.d.ts +1 -1
- package/out/api/contentWatches.js +12 -12
- package/out/api/dynamicModules.d.ts +1 -1
- package/out/api/dynamicModules.js +3 -3
- package/out/api/experimental.d.ts +123 -5
- package/out/api/experimental.js +60 -8
- package/out/api/group.d.ts +1 -1
- package/out/api/group.js +20 -17
- package/out/api/index.d.ts +2 -0
- package/out/api/index.js +31 -29
- package/out/api/inlineTasks.d.ts +1 -1
- package/out/api/inlineTasks.js +3 -3
- package/out/api/labelInfo.d.ts +1 -1
- package/out/api/labelInfo.js +1 -1
- package/out/api/longRunningTask.d.ts +1 -1
- package/out/api/longRunningTask.js +2 -2
- package/out/api/models/availableContentStates.d.ts +6 -0
- package/out/api/models/availableContentStates.js +2 -0
- package/out/api/models/blueprintTemplate.d.ts +1 -1
- package/out/api/models/bulkUserLookup.d.ts +2 -2
- package/out/api/models/content.d.ts +6 -6
- package/out/api/models/contentHistory.d.ts +2 -2
- package/out/api/models/contentLookAndFeel.d.ts +1 -1
- package/out/api/models/contentMetadata.d.ts +1 -1
- package/out/api/models/contentRestriction.d.ts +2 -2
- package/out/api/models/contentState.d.ts +8 -0
- package/out/api/models/contentState.js +2 -0
- package/out/api/models/contentStateContainer.d.ts +5 -0
- package/out/api/models/contentStateContainer.js +2 -0
- package/out/api/models/contentStateSettings.d.ts +11 -0
- package/out/api/models/contentStateSettings.js +2 -0
- package/out/api/models/contentTemplate.d.ts +1 -1
- package/out/api/models/copyPageHierarchyRequest.d.ts +2 -0
- package/out/api/models/copyPageRequest.d.ts +1 -1
- package/out/api/models/horizontalHeaderLookAndFeel.d.ts +1 -1
- package/out/api/models/index.d.ts +8 -0
- package/out/api/models/index.js +166 -158
- package/out/api/models/labelArray.d.ts +1 -1
- package/out/api/models/longTask.d.ts +8 -0
- package/out/api/models/longTask.js +2 -0
- package/out/api/models/longTaskStatusArray.d.ts +1 -1
- package/out/api/models/lookAndFeel.d.ts +2 -2
- package/out/api/models/migratedUserArray.d.ts +1 -1
- package/out/api/models/relation.d.ts +1 -1
- package/out/api/models/relationArray.d.ts +1 -1
- package/out/api/models/searchPageResponseSearchResult.d.ts +1 -1
- package/out/api/models/searchResult.d.ts +2 -2
- package/out/api/models/space.d.ts +4 -4
- package/out/api/models/spaceArray.d.ts +1 -1
- package/out/api/models/spacePermission.d.ts +1 -1
- package/out/api/models/spacePermissionCreate.d.ts +1 -1
- package/out/api/models/spacePermissionRequest.d.ts +1 -1
- package/out/api/models/spacePermissionV2.d.ts +1 -1
- package/out/api/models/spacePropertyArray.d.ts +1 -1
- package/out/api/models/spaceWatchArray.d.ts +1 -1
- package/out/api/models/themeArray.d.ts +1 -1
- package/out/api/models/user.d.ts +2 -2
- package/out/api/models/userAnonymous.d.ts +1 -1
- package/out/api/models/userProperty.d.ts +13 -0
- package/out/api/models/userProperty.js +2 -0
- package/out/api/models/userPropertyCreate.d.ts +4 -0
- package/out/api/models/userPropertyCreate.js +2 -0
- package/out/api/models/userPropertyKeyArray.d.ts +10 -0
- package/out/api/models/userPropertyKeyArray.js +2 -0
- package/out/api/models/userPropertyUpdate.d.ts +4 -0
- package/out/api/models/userPropertyUpdate.js +2 -0
- package/out/api/models/usersUserKeys.d.ts +1 -1
- package/out/api/models/version.d.ts +2 -2
- package/out/api/models/versionArray.d.ts +1 -1
- package/out/api/models/watchArray.d.ts +1 -1
- package/out/api/parameters/createUserProperty.d.ts +10 -0
- package/out/api/parameters/createUserProperty.js +2 -0
- package/out/api/parameters/deletePageTree.d.ts +4 -0
- package/out/api/parameters/deletePageTree.js +2 -0
- package/out/api/parameters/deleteUserProperty.d.ts +9 -0
- package/out/api/parameters/deleteUserProperty.js +2 -0
- package/out/api/parameters/getAvailableContentStates.d.ts +4 -0
- package/out/api/parameters/getAvailableContentStates.js +2 -0
- package/out/api/parameters/getContentState.d.ts +6 -0
- package/out/api/parameters/getContentState.js +2 -0
- package/out/api/parameters/getContentStateLastUpdated.d.ts +4 -0
- package/out/api/parameters/getContentStateLastUpdated.js +2 -0
- package/out/api/parameters/getContentStateSettings.d.ts +4 -0
- package/out/api/parameters/getContentStateSettings.js +2 -0
- package/out/api/parameters/getGroupMembersByGroupId.d.ts +5 -0
- package/out/api/parameters/getMembersByQueryParam.d.ts +5 -0
- package/out/api/parameters/getSpaces.d.ts +1 -1
- package/out/api/parameters/getUserProperties.d.ts +8 -0
- package/out/api/parameters/getUserProperties.js +2 -0
- package/out/api/parameters/getUserProperty.d.ts +6 -0
- package/out/api/parameters/getUserProperty.js +2 -0
- package/out/api/parameters/index.d.ts +12 -0
- package/out/api/parameters/index.js +170 -158
- package/out/api/parameters/removeContentState.d.ts +4 -0
- package/out/api/parameters/removeContentState.js +2 -0
- package/out/api/parameters/searchGroups.d.ts +5 -0
- package/out/api/parameters/setContentState.d.ts +8 -0
- package/out/api/parameters/setContentState.js +2 -0
- package/out/api/parameters/updateUserProperty.d.ts +10 -0
- package/out/api/parameters/updateUserProperty.js +2 -0
- package/out/api/relation.d.ts +1 -1
- package/out/api/relation.js +7 -7
- package/out/api/search.d.ts +1 -1
- package/out/api/search.js +4 -4
- package/out/api/settings.d.ts +5 -1
- package/out/api/settings.js +15 -6
- package/out/api/space.d.ts +1 -1
- package/out/api/space.js +13 -9
- package/out/api/spacePermissions.d.ts +1 -1
- package/out/api/spacePermissions.js +4 -4
- package/out/api/spaceProperties.d.ts +1 -1
- package/out/api/spaceProperties.js +6 -6
- package/out/api/spaceSettings.d.ts +1 -1
- package/out/api/spaceSettings.js +2 -2
- package/out/api/template.d.ts +1 -1
- package/out/api/template.js +6 -6
- package/out/api/themes.d.ts +1 -1
- package/out/api/themes.js +6 -6
- package/out/api/users.d.ts +3 -3
- package/out/api/users.js +8 -8
- package/out/clients/baseClient.d.ts +1 -1
- package/out/clients/baseClient.js +6 -6
- package/out/clients/confluenceClient.d.ts +3 -1
- package/out/clients/confluenceClient.js +2 -0
- package/out/clients/index.js +4 -4
- package/out/config.d.ts +5 -2
- package/out/index.js +4 -4
- package/out/paramSerializer.d.ts +1 -0
- package/out/paramSerializer.js +16 -0
- package/out/server/audit.d.ts +1 -1
- package/out/server/audit.js +6 -6
- package/out/server/content.d.ts +1 -1
- package/out/server/content.js +32 -32
- package/out/server/contentBody.d.ts +1 -1
- package/out/server/contentBody.js +1 -1
- package/out/server/group.d.ts +1 -1
- package/out/server/group.js +3 -3
- package/out/server/index.js +8 -8
- package/out/server/longTask.d.ts +1 -1
- package/out/server/longTask.js +2 -2
- package/out/server/models/content.d.ts +6 -6
- package/out/server/models/contentChildren.d.ts +1 -1
- package/out/server/models/contentHistory.d.ts +2 -2
- package/out/server/models/contentLookAndFeel.d.ts +1 -1
- package/out/server/models/contentRestriction.d.ts +2 -2
- package/out/server/models/index.js +60 -60
- package/out/server/models/lookAndFeel.d.ts +2 -2
- package/out/server/models/searchResult.d.ts +2 -2
- package/out/server/models/space.d.ts +3 -3
- package/out/server/models/spacePermission.d.ts +1 -1
- package/out/server/models/user.d.ts +1 -1
- package/out/server/models/version.d.ts +1 -1
- package/out/server/parameters/index.js +64 -64
- package/out/server/search.d.ts +1 -1
- package/out/server/search.js +1 -1
- package/out/server/space.d.ts +1 -1
- package/out/server/space.js +14 -14
- package/out/server/user.d.ts +1 -1
- package/out/server/user.js +10 -10
- package/out/services/authenticationService/authenticationService.js +4 -1
- package/out/services/authenticationService/authentications/createPATAuthenticationToken.d.ts +2 -0
- package/out/services/authenticationService/authentications/createPATAuthenticationToken.js +10 -0
- package/out/services/authenticationService/authentications/index.d.ts +1 -0
- package/out/services/authenticationService/authentications/index.js +4 -3
- package/out/services/authenticationService/index.js +1 -1
- package/package.json +30 -26
- package/src/api/analytics.ts +44 -0
- package/src/api/audit.ts +1 -1
- package/src/api/content.ts +1 -1
- package/src/api/contentAttachments.ts +1 -1
- package/src/api/contentBody.ts +1 -1
- package/src/api/contentChildrenAndDescendants.ts +8 -4
- package/src/api/contentComments.ts +1 -1
- package/src/api/contentContentState.ts +157 -0
- package/src/api/contentLabels.ts +1 -1
- package/src/api/contentMacroBody.ts +1 -1
- package/src/api/contentPermissions.ts +1 -1
- package/src/api/contentProperties.ts +1 -1
- package/src/api/contentRestrictions.ts +1 -1
- package/src/api/contentVersions.ts +1 -1
- package/src/api/contentWatches.ts +1 -1
- package/src/api/dynamicModules.ts +1 -1
- package/src/api/experimental.ts +211 -8
- package/src/api/group.ts +4 -1
- package/src/api/index.ts +2 -0
- package/src/api/inlineTasks.ts +1 -1
- package/src/api/labelInfo.ts +1 -1
- package/src/api/longRunningTask.ts +1 -1
- package/src/api/models/availableContentStates.ts +7 -0
- package/src/api/models/blueprintTemplate.ts +1 -1
- package/src/api/models/bulkUserLookup.ts +2 -2
- package/src/api/models/content.ts +6 -6
- package/src/api/models/contentHistory.ts +2 -2
- package/src/api/models/contentLookAndFeel.ts +1 -1
- package/src/api/models/contentMetadata.ts +1 -1
- package/src/api/models/contentRestriction.ts +2 -2
- package/src/api/models/contentState.ts +8 -0
- package/src/api/models/contentStateContainer.ts +6 -0
- package/src/api/models/contentStateSettings.ts +12 -0
- package/src/api/models/contentTemplate.ts +1 -1
- package/src/api/models/copyPageHierarchyRequest.ts +2 -0
- package/src/api/models/copyPageRequest.ts +1 -1
- package/src/api/models/horizontalHeaderLookAndFeel.ts +1 -1
- package/src/api/models/index.ts +8 -0
- package/src/api/models/labelArray.ts +1 -1
- package/src/api/models/longTask.ts +8 -0
- package/src/api/models/longTaskStatusArray.ts +1 -1
- package/src/api/models/lookAndFeel.ts +2 -2
- package/src/api/models/migratedUserArray.ts +1 -1
- package/src/api/models/relation.ts +1 -1
- package/src/api/models/relationArray.ts +1 -1
- package/src/api/models/searchPageResponseSearchResult.ts +1 -1
- package/src/api/models/searchResult.ts +2 -2
- package/src/api/models/space.ts +4 -4
- package/src/api/models/spaceArray.ts +1 -1
- package/src/api/models/spacePermission.ts +1 -1
- package/src/api/models/spacePermissionCreate.ts +1 -1
- package/src/api/models/spacePermissionRequest.ts +1 -1
- package/src/api/models/spacePermissionV2.ts +1 -1
- package/src/api/models/spacePropertyArray.ts +1 -1
- package/src/api/models/spaceWatchArray.ts +1 -1
- package/src/api/models/themeArray.ts +1 -1
- package/src/api/models/user.ts +2 -2
- package/src/api/models/userAnonymous.ts +1 -1
- package/src/api/models/userProperty.ts +14 -0
- package/src/api/models/userPropertyCreate.ts +4 -0
- package/src/api/models/userPropertyKeyArray.ts +11 -0
- package/src/api/models/userPropertyUpdate.ts +4 -0
- package/src/api/models/usersUserKeys.ts +1 -1
- package/src/api/models/version.ts +2 -2
- package/src/api/models/versionArray.ts +1 -1
- package/src/api/models/watchArray.ts +1 -1
- package/src/api/parameters/createUserProperty.ts +11 -0
- package/src/api/parameters/deletePageTree.ts +4 -0
- package/src/api/parameters/deleteUserProperty.ts +9 -0
- package/src/api/parameters/getAvailableContentStates.ts +4 -0
- package/src/api/parameters/getContentState.ts +6 -0
- package/src/api/parameters/getContentStateLastUpdated.ts +4 -0
- package/src/api/parameters/getContentStateSettings.ts +4 -0
- package/src/api/parameters/getGroupMembersByGroupId.ts +5 -0
- package/src/api/parameters/getMembersByQueryParam.ts +5 -0
- package/src/api/parameters/getSpaces.ts +31 -1
- package/src/api/parameters/getUserProperties.ts +8 -0
- package/src/api/parameters/getUserProperty.ts +6 -0
- package/src/api/parameters/index.ts +12 -0
- package/src/api/parameters/removeContentState.ts +4 -0
- package/src/api/parameters/searchGroups.ts +5 -0
- package/src/api/parameters/setContentState.ts +8 -0
- package/src/api/parameters/updateUserProperty.ts +11 -0
- package/src/api/relation.ts +1 -1
- package/src/api/search.ts +1 -1
- package/src/api/settings.ts +23 -1
- package/src/api/space.ts +6 -2
- package/src/api/spacePermissions.ts +1 -1
- package/src/api/spaceProperties.ts +1 -1
- package/src/api/spaceSettings.ts +1 -1
- package/src/api/template.ts +1 -1
- package/src/api/themes.ts +1 -1
- package/src/api/users.ts +4 -4
- package/src/clients/baseClient.ts +3 -3
- package/src/clients/confluenceClient.ts +4 -0
- package/src/config.ts +6 -2
- package/src/paramSerializer.ts +15 -0
- package/src/server/audit.ts +2 -2
- package/src/server/content.ts +2 -2
- package/src/server/contentBody.ts +1 -1
- package/src/server/group.ts +2 -2
- package/src/server/longTask.ts +2 -2
- package/src/server/models/content.ts +6 -6
- package/src/server/models/contentChildren.ts +1 -1
- package/src/server/models/contentHistory.ts +2 -2
- package/src/server/models/contentLookAndFeel.ts +1 -1
- package/src/server/models/contentRestriction.ts +2 -2
- package/src/server/models/lookAndFeel.ts +2 -2
- package/src/server/models/searchResult.ts +2 -2
- package/src/server/models/space.ts +3 -3
- package/src/server/models/spacePermission.ts +1 -1
- package/src/server/models/user.ts +1 -1
- package/src/server/models/version.ts +1 -1
- package/src/server/search.ts +2 -2
- package/src/server/space.ts +2 -2
- package/src/server/user.ts +2 -2
- package/src/services/authenticationService/authenticationService.ts +5 -0
- package/src/services/authenticationService/authentications/createBasicAuthenticationToken.ts +1 -1
- package/src/services/authenticationService/authentications/createPATAuthenticationToken.ts +5 -0
- package/src/services/authenticationService/authentications/index.ts +1 -0
- package/tsconfig.lint.json +7 -0
package/src/api/experimental.ts
CHANGED
|
@@ -1,12 +1,55 @@
|
|
|
1
1
|
import * as Models from './models';
|
|
2
2
|
import * as Parameters from './parameters';
|
|
3
|
-
import { Client } from '../clients';
|
|
4
3
|
import { Callback } from '../callback';
|
|
4
|
+
import { Client } from '../clients';
|
|
5
5
|
import { RequestConfig } from '../requestConfig';
|
|
6
6
|
|
|
7
7
|
export class Experimental {
|
|
8
8
|
constructor(private client: Client) {}
|
|
9
9
|
|
|
10
|
+
/**
|
|
11
|
+
* Moves a pagetree rooted at a page to the space's trash:
|
|
12
|
+
*
|
|
13
|
+
* - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.
|
|
14
|
+
* - For every other combination of content type and status, this API is not supported.
|
|
15
|
+
*
|
|
16
|
+
* This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.
|
|
17
|
+
*
|
|
18
|
+
* Use the `/longtask/<taskId>` REST API to get the copy task status.
|
|
19
|
+
*
|
|
20
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
|
|
21
|
+
* content is in.
|
|
22
|
+
*/
|
|
23
|
+
async deletePageTree<T = Models.LongTask>(
|
|
24
|
+
parameters: Parameters.DeletePageTree,
|
|
25
|
+
callback: Callback<T>
|
|
26
|
+
): Promise<void>;
|
|
27
|
+
/**
|
|
28
|
+
* Moves a pagetree rooted at a page to the space's trash:
|
|
29
|
+
*
|
|
30
|
+
* - If the content's type is `page` and its status is `current`, it will be trashed including all its descendants.
|
|
31
|
+
* - For every other combination of content type and status, this API is not supported.
|
|
32
|
+
*
|
|
33
|
+
* This API accepts the pageTree delete request and returns a task ID. The delete process happens asynchronously.
|
|
34
|
+
*
|
|
35
|
+
* Use the `/longtask/<taskId>` REST API to get the copy task status.
|
|
36
|
+
*
|
|
37
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Delete' permission for the space that the
|
|
38
|
+
* content is in.
|
|
39
|
+
*/
|
|
40
|
+
async deletePageTree<T = Models.LongTask>(parameters: Parameters.DeletePageTree, callback?: never): Promise<T>;
|
|
41
|
+
async deletePageTree<T = Models.LongTask>(
|
|
42
|
+
parameters: Parameters.DeletePageTree,
|
|
43
|
+
callback?: Callback<T>,
|
|
44
|
+
): Promise<void | T> {
|
|
45
|
+
const config: RequestConfig = {
|
|
46
|
+
url: `/api/content/${parameters.id}/pageTree`,
|
|
47
|
+
method: 'DELETE',
|
|
48
|
+
};
|
|
49
|
+
|
|
50
|
+
return this.client.sendRequest(config, callback);
|
|
51
|
+
}
|
|
52
|
+
|
|
10
53
|
/**
|
|
11
54
|
* Returns a list of labels associated with a space. Can provide a prefix as well as other filters to select different
|
|
12
55
|
* types of labels.
|
|
@@ -100,22 +143,182 @@ export class Experimental {
|
|
|
100
143
|
return this.client.sendRequest(config, callback);
|
|
101
144
|
}
|
|
102
145
|
|
|
103
|
-
/**
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
146
|
+
/**
|
|
147
|
+
* Returns the properties for a user as list of property keys. For more information about user properties, see
|
|
148
|
+
* [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
|
|
149
|
+
* `Note`, these properties stored against a user are on a Confluence site level and not space/content level.
|
|
150
|
+
*
|
|
151
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
152
|
+
* ('Can use' global permission).
|
|
153
|
+
*/
|
|
154
|
+
async getUserProperties<T = Models.UserPropertyKeyArray>(
|
|
155
|
+
parameters: Parameters.GetUserProperties,
|
|
156
|
+
callback: Callback<T>
|
|
157
|
+
): Promise<void>;
|
|
158
|
+
/**
|
|
159
|
+
* Returns the properties for a user as list of property keys. For more information about user properties, see
|
|
160
|
+
* [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
|
|
161
|
+
* `Note`, these properties stored against a user are on a Confluence site level and not space/content level.
|
|
162
|
+
*
|
|
163
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
164
|
+
* ('Can use' global permission).
|
|
165
|
+
*/
|
|
166
|
+
async getUserProperties<T = Models.UserPropertyKeyArray>(
|
|
167
|
+
parameters: Parameters.GetUserProperties,
|
|
168
|
+
callback?: never
|
|
169
|
+
): Promise<T>;
|
|
170
|
+
async getUserProperties<T = Models.UserPropertyKeyArray>(
|
|
171
|
+
parameters: Parameters.GetUserProperties,
|
|
172
|
+
callback?: Callback<T>,
|
|
173
|
+
): Promise<void | T> {
|
|
108
174
|
const config: RequestConfig = {
|
|
109
|
-
url: `/api/
|
|
175
|
+
url: `/api/user/${parameters.userId}/property`,
|
|
110
176
|
method: 'GET',
|
|
111
177
|
params: {
|
|
112
|
-
|
|
178
|
+
start: parameters.start,
|
|
179
|
+
limit: parameters.limit,
|
|
113
180
|
},
|
|
114
181
|
};
|
|
115
182
|
|
|
116
183
|
return this.client.sendRequest(config, callback);
|
|
117
184
|
}
|
|
118
185
|
|
|
186
|
+
/**
|
|
187
|
+
* Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence
|
|
188
|
+
* entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
189
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
190
|
+
*
|
|
191
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
192
|
+
* ('Can use' global permission).
|
|
193
|
+
*/
|
|
194
|
+
async getUserProperty<T = Models.UserProperty>(
|
|
195
|
+
parameters: Parameters.GetUserProperty,
|
|
196
|
+
callback: Callback<T>
|
|
197
|
+
): Promise<void>;
|
|
198
|
+
/**
|
|
199
|
+
* Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence
|
|
200
|
+
* entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
201
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
202
|
+
*
|
|
203
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
204
|
+
* ('Can use' global permission).
|
|
205
|
+
*/
|
|
206
|
+
async getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;
|
|
207
|
+
async getUserProperty<T = Models.UserProperty>(
|
|
208
|
+
parameters: Parameters.GetUserProperty,
|
|
209
|
+
callback?: Callback<T>,
|
|
210
|
+
): Promise<void | T> {
|
|
211
|
+
const config: RequestConfig = {
|
|
212
|
+
url: `/api/user/${parameters.userId}/property/${parameters.key}`,
|
|
213
|
+
method: 'GET',
|
|
214
|
+
};
|
|
215
|
+
|
|
216
|
+
return this.client.sendRequest(config, callback);
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
/**
|
|
220
|
+
* Creates a property for a user. For more information about user properties, see [Confluence entity properties]
|
|
221
|
+
* (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored
|
|
222
|
+
* against a user are on a Confluence site level and not space/content level.
|
|
223
|
+
*
|
|
224
|
+
* `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
|
|
225
|
+
* fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
|
|
226
|
+
* the Confluence site ('Can use' global permission).
|
|
227
|
+
*/
|
|
228
|
+
async createUserProperty<T = unknown>(
|
|
229
|
+
parameters: Parameters.CreateUserProperty,
|
|
230
|
+
callback: Callback<T>
|
|
231
|
+
): Promise<void>;
|
|
232
|
+
/**
|
|
233
|
+
* Creates a property for a user. For more information about user properties, see [Confluence entity properties]
|
|
234
|
+
* (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored
|
|
235
|
+
* against a user are on a Confluence site level and not space/content level.
|
|
236
|
+
*
|
|
237
|
+
* `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
|
|
238
|
+
* fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
|
|
239
|
+
* the Confluence site ('Can use' global permission).
|
|
240
|
+
*/
|
|
241
|
+
async createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;
|
|
242
|
+
async createUserProperty<T = unknown>(
|
|
243
|
+
parameters: Parameters.CreateUserProperty,
|
|
244
|
+
callback?: Callback<T>,
|
|
245
|
+
): Promise<void | T> {
|
|
246
|
+
const config: RequestConfig = {
|
|
247
|
+
url: `/api/user/${parameters.userId}/property/${parameters.key}`,
|
|
248
|
+
method: 'POST',
|
|
249
|
+
data: {
|
|
250
|
+
value: parameters.value,
|
|
251
|
+
},
|
|
252
|
+
};
|
|
253
|
+
|
|
254
|
+
return this.client.sendRequest(config, callback);
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
/**
|
|
258
|
+
* Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more
|
|
259
|
+
* information about user properties, see [Confluence entity
|
|
260
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
261
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
262
|
+
*
|
|
263
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
264
|
+
* ('Can use' global permission).
|
|
265
|
+
*/
|
|
266
|
+
async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;
|
|
267
|
+
/**
|
|
268
|
+
* Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more
|
|
269
|
+
* information about user properties, see [Confluence entity
|
|
270
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
271
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
272
|
+
*
|
|
273
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
274
|
+
* ('Can use' global permission).
|
|
275
|
+
*/
|
|
276
|
+
async updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;
|
|
277
|
+
async updateUserProperty<T = void>(
|
|
278
|
+
parameters: Parameters.UpdateUserProperty,
|
|
279
|
+
callback?: Callback<T>,
|
|
280
|
+
): Promise<void | T> {
|
|
281
|
+
const config: RequestConfig = {
|
|
282
|
+
url: `/api/user/${parameters.userId}/property/${parameters.key}`,
|
|
283
|
+
method: 'PUT',
|
|
284
|
+
data: {
|
|
285
|
+
value: parameters.value,
|
|
286
|
+
},
|
|
287
|
+
};
|
|
288
|
+
|
|
289
|
+
return this.client.sendRequest(config, callback);
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* Deletes a property for the given user. For more information about user properties, see [Confluence entity
|
|
294
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
295
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
296
|
+
*
|
|
297
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
298
|
+
* ('Can use' global permission).
|
|
299
|
+
*/
|
|
300
|
+
async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;
|
|
301
|
+
/**
|
|
302
|
+
* Deletes a property for the given user. For more information about user properties, see [Confluence entity
|
|
303
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
304
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
305
|
+
*
|
|
306
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
307
|
+
* ('Can use' global permission).
|
|
308
|
+
*/
|
|
309
|
+
async deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;
|
|
310
|
+
async deleteUserProperty<T = void>(
|
|
311
|
+
parameters: Parameters.DeleteUserProperty,
|
|
312
|
+
callback?: Callback<T>,
|
|
313
|
+
): Promise<void | T> {
|
|
314
|
+
const config: RequestConfig = {
|
|
315
|
+
url: `/api/user/${parameters.userId}/property/${parameters.key}`,
|
|
316
|
+
method: 'DELETE',
|
|
317
|
+
};
|
|
318
|
+
|
|
319
|
+
return this.client.sendRequest(config, callback);
|
|
320
|
+
}
|
|
321
|
+
|
|
119
322
|
/** Get the total number of distinct viewers a piece of content has. */
|
|
120
323
|
async getViewers<T = Models.GetViewers>(parameters: Parameters.GetViewers, callback: Callback<T>): Promise<void>;
|
|
121
324
|
/** Get the total number of distinct viewers a piece of content has. */
|
package/src/api/group.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as Models from './models';
|
|
2
2
|
import * as Parameters from './parameters';
|
|
3
|
-
import { Client } from '../clients';
|
|
4
3
|
import { Callback } from '../callback';
|
|
4
|
+
import { Client } from '../clients';
|
|
5
5
|
import { RequestConfig } from '../requestConfig';
|
|
6
6
|
|
|
7
7
|
export class Group {
|
|
@@ -252,6 +252,7 @@ export class Group {
|
|
|
252
252
|
name: parameters.name,
|
|
253
253
|
start: parameters.start,
|
|
254
254
|
limit: parameters.limit,
|
|
255
|
+
shouldReturnTotalSize: parameters.shouldReturnTotalSize,
|
|
255
256
|
},
|
|
256
257
|
};
|
|
257
258
|
|
|
@@ -330,6 +331,7 @@ export class Group {
|
|
|
330
331
|
query: parameters.query,
|
|
331
332
|
start: parameters.start,
|
|
332
333
|
limit: parameters.limit,
|
|
334
|
+
shouldReturnTotalSize: parameters.shouldReturnTotalSize,
|
|
333
335
|
},
|
|
334
336
|
};
|
|
335
337
|
|
|
@@ -440,6 +442,7 @@ export class Group {
|
|
|
440
442
|
params: {
|
|
441
443
|
start: parameters.start,
|
|
442
444
|
limit: parameters.limit,
|
|
445
|
+
shouldReturnTotalSize: parameters.shouldReturnTotalSize,
|
|
443
446
|
},
|
|
444
447
|
};
|
|
445
448
|
|
package/src/api/index.ts
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
1
|
+
export * from './analytics';
|
|
1
2
|
export * from './audit';
|
|
2
3
|
export * from './content';
|
|
3
4
|
export * from './contentAttachments';
|
|
4
5
|
export * from './contentBody';
|
|
5
6
|
export * from './contentChildrenAndDescendants';
|
|
6
7
|
export * from './contentComments';
|
|
8
|
+
export * from './contentContentState';
|
|
7
9
|
export * from './contentLabels';
|
|
8
10
|
export * from './contentMacroBody';
|
|
9
11
|
export * from './contentPermissions';
|
package/src/api/inlineTasks.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as Models from './models';
|
|
2
2
|
import * as Parameters from './parameters';
|
|
3
|
-
import { Client } from '../clients';
|
|
4
3
|
import { Callback } from '../callback';
|
|
4
|
+
import { Client } from '../clients';
|
|
5
5
|
import { RequestConfig } from '../requestConfig';
|
|
6
6
|
|
|
7
7
|
export class InlineTasks {
|
package/src/api/labelInfo.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as Models from './models';
|
|
2
2
|
import * as Parameters from './parameters';
|
|
3
|
-
import { Client } from '../clients';
|
|
4
3
|
import { Callback } from '../callback';
|
|
4
|
+
import { Client } from '../clients';
|
|
5
5
|
import { RequestConfig } from '../requestConfig';
|
|
6
6
|
|
|
7
7
|
export class LabelInfo {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import * as Models from './models';
|
|
2
2
|
import * as Parameters from './parameters';
|
|
3
|
-
import { Client } from '../clients';
|
|
4
3
|
import { Callback } from '../callback';
|
|
4
|
+
import { Client } from '../clients';
|
|
5
5
|
import { RequestConfig } from '../requestConfig';
|
|
6
6
|
|
|
7
7
|
export class LongRunningTask {
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
+
import { GenericLinks } from './genericLinks';
|
|
1
2
|
import { Icon } from './icon';
|
|
2
3
|
import { OperationCheckResult } from './operationCheckResult';
|
|
3
|
-
import { UserDetails } from './userDetails';
|
|
4
4
|
import { Space } from './space';
|
|
5
|
-
import {
|
|
5
|
+
import { UserDetails } from './userDetails';
|
|
6
6
|
|
|
7
7
|
export interface BulkUserLookup {
|
|
8
8
|
type: string;
|
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import { Space } from './space';
|
|
2
|
-
import { ContentHistory } from './contentHistory';
|
|
3
|
-
import { Version } from './version';
|
|
4
|
-
import { OperationCheckResult } from './operationCheckResult';
|
|
5
|
-
import { ContentChildren } from './contentChildren';
|
|
6
|
-
import { ContentChildType } from './contentChildType';
|
|
7
1
|
import { Container } from './container';
|
|
8
2
|
import { ContentBody } from './contentBody';
|
|
3
|
+
import { ContentChildren } from './contentChildren';
|
|
4
|
+
import { ContentChildType } from './contentChildType';
|
|
5
|
+
import { ContentHistory } from './contentHistory';
|
|
9
6
|
import { ContentRestriction } from './contentRestriction';
|
|
10
7
|
import { GenericLinks } from './genericLinks';
|
|
8
|
+
import { OperationCheckResult } from './operationCheckResult';
|
|
9
|
+
import { Space } from './space';
|
|
10
|
+
import { Version } from './version';
|
|
11
11
|
|
|
12
12
|
/** Base object for all content types. */
|
|
13
13
|
export interface Content {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
+
import { GenericLinks } from './genericLinks';
|
|
1
2
|
import { User } from './user';
|
|
2
|
-
import { Version } from './version';
|
|
3
3
|
import { UsersUserKeys } from './usersUserKeys';
|
|
4
|
-
import {
|
|
4
|
+
import { Version } from './version';
|
|
5
5
|
|
|
6
6
|
export interface ContentHistory {
|
|
7
7
|
latest: boolean;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Version } from './version';
|
|
2
1
|
import { GenericLinks } from './genericLinks';
|
|
3
2
|
import { LabelArray } from './labelArray';
|
|
3
|
+
import { Version } from './version';
|
|
4
4
|
|
|
5
5
|
/** Metadata object for page, blogpost, comment content */
|
|
6
6
|
export interface ContentMetadata {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { UserArray } from './userArray';
|
|
2
|
-
import { GroupArray } from './groupArray';
|
|
3
1
|
import { Content } from './content';
|
|
4
2
|
import { GenericLinks } from './genericLinks';
|
|
3
|
+
import { GroupArray } from './groupArray';
|
|
4
|
+
import { UserArray } from './userArray';
|
|
5
5
|
|
|
6
6
|
export interface ContentRestriction {
|
|
7
7
|
operation: string;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import { ContentState } from './contentState';
|
|
2
|
+
|
|
3
|
+
export interface ContentStateSettings {
|
|
4
|
+
/** Whether users can place content states on any pages and blog posts in the space */
|
|
5
|
+
contentStatesAllowed: boolean;
|
|
6
|
+
/** Whether users can create custom states on the fly on pages and blog posts */
|
|
7
|
+
customContentStatesAllowed: boolean;
|
|
8
|
+
/** Whether space content states are allowed */
|
|
9
|
+
spaceContentStatesAllowed: boolean;
|
|
10
|
+
/** Space content states that users in the space can choose from */
|
|
11
|
+
spaceContentStates?: ContentState[];
|
|
12
|
+
}
|
|
@@ -11,6 +11,8 @@ export interface CopyPageHierarchyRequest {
|
|
|
11
11
|
copyLabels?: boolean;
|
|
12
12
|
/** If set to `true`, custom contents are copied to the destination page. */
|
|
13
13
|
copyCustomContents?: boolean;
|
|
14
|
+
/** If set to `true`, descendants are copied to the destination page. */
|
|
15
|
+
copyDescendants?: boolean;
|
|
14
16
|
destinationPageId: string;
|
|
15
17
|
titleOptions?: CopyPageHierarchyTitleOptions;
|
|
16
18
|
}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { CopyPageRequestDestination } from './copyPageRequestDestination';
|
|
2
1
|
import { ContentBodyCreate } from './contentBodyCreate';
|
|
2
|
+
import { CopyPageRequestDestination } from './copyPageRequestDestination';
|
|
3
3
|
|
|
4
4
|
export interface CopyPageRequest {
|
|
5
5
|
/** If set to `true`, attachments are copied to the destination page. */
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { ButtonLookAndFeel } from './buttonLookAndFeel';
|
|
2
|
-
import { TopNavigationLookAndFeel } from './topNavigationLookAndFeel';
|
|
3
2
|
import { NavigationLookAndFeel } from './navigationLookAndFeel';
|
|
4
3
|
import { SearchFieldLookAndFeel } from './searchFieldLookAndFeel';
|
|
4
|
+
import { TopNavigationLookAndFeel } from './topNavigationLookAndFeel';
|
|
5
5
|
|
|
6
6
|
export interface HorizontalHeaderLookAndFeel {
|
|
7
7
|
backgroundColor: string;
|
package/src/api/models/index.ts
CHANGED
|
@@ -82,7 +82,15 @@ export * from './labelCreateArray';
|
|
|
82
82
|
export * from './labelDetails';
|
|
83
83
|
export * from './labeledContent';
|
|
84
84
|
export * from './labeledContentPageResponse';
|
|
85
|
+
export * from './contentStateSettings';
|
|
85
86
|
export * from './labeledContentType';
|
|
87
|
+
export * from './longTask';
|
|
88
|
+
export * from './userPropertyCreate';
|
|
89
|
+
export * from './userPropertyUpdate';
|
|
90
|
+
export * from './contentStateContainer';
|
|
91
|
+
export * from './availableContentStates';
|
|
92
|
+
export * from './userPropertyKeyArray';
|
|
93
|
+
export * from './userProperty';
|
|
86
94
|
export * from './longTaskStatus';
|
|
87
95
|
export * from './longTaskStatusArray';
|
|
88
96
|
export * from './longTaskStatusWithLinks';
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { MenusLookAndFeel } from './menusLookAndFeel';
|
|
2
|
-
import { HeaderLookAndFeel } from './headerLookAndFeel';
|
|
3
1
|
import { ContentLookAndFeel } from './contentLookAndFeel';
|
|
2
|
+
import { HeaderLookAndFeel } from './headerLookAndFeel';
|
|
4
3
|
import { HorizontalHeaderLookAndFeel } from './horizontalHeaderLookAndFeel';
|
|
4
|
+
import { MenusLookAndFeel } from './menusLookAndFeel';
|
|
5
5
|
|
|
6
6
|
export interface LookAndFeel {
|
|
7
7
|
headings: {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { Content } from './content';
|
|
2
|
-
import { ContainerSummary } from './containerSummary';
|
|
3
1
|
import { Breadcrumb } from './breadcrumb';
|
|
2
|
+
import { ContainerSummary } from './containerSummary';
|
|
3
|
+
import { Content } from './content';
|
|
4
4
|
|
|
5
5
|
export interface SearchResult {
|
|
6
6
|
content: Content;
|
package/src/api/models/space.ts
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import { Icon } from './icon';
|
|
2
|
-
import { SpaceDescription } from './spaceDescription';
|
|
3
1
|
import { Content } from './content';
|
|
2
|
+
import { GenericLinks } from './genericLinks';
|
|
3
|
+
import { Icon } from './icon';
|
|
4
4
|
import { LabelArray } from './labelArray';
|
|
5
|
+
import { LookAndFeel } from './lookAndFeel';
|
|
5
6
|
import { OperationCheckResult } from './operationCheckResult';
|
|
7
|
+
import { SpaceDescription } from './spaceDescription';
|
|
6
8
|
import { SpacePermission } from './spacePermission';
|
|
7
9
|
import { SpaceSettings } from './spaceSettings';
|
|
8
10
|
import { Theme } from './theme';
|
|
9
|
-
import { LookAndFeel } from './lookAndFeel';
|
|
10
|
-
import { GenericLinks } from './genericLinks';
|
|
11
11
|
|
|
12
12
|
export interface Space {
|
|
13
13
|
id: number;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { User } from './user';
|
|
2
1
|
import { Group } from './group';
|
|
3
2
|
import { OperationCheckResult } from './operationCheckResult';
|
|
3
|
+
import { User } from './user';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* This object represents a permission for given space. Permissions consist of* at least one operation object with an
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { User } from './user';
|
|
2
1
|
import { GroupCreate } from './groupCreate';
|
|
3
2
|
import { OperationCheckResult } from './operationCheckResult';
|
|
3
|
+
import { User } from './user';
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* This object represents a permission for given space. Permissions consist of* at least one operation object with an
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { PermissionSubject } from './permissionSubject';
|
|
2
1
|
import { GenericLinks } from './genericLinks';
|
|
2
|
+
import { PermissionSubject } from './permissionSubject';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* This object represents the request for the single space permission. Permissions consist of* at least one operation
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { PermissionSubject } from './permissionSubject';
|
|
2
1
|
import { GenericLinks } from './genericLinks';
|
|
2
|
+
import { PermissionSubject } from './permissionSubject';
|
|
3
3
|
|
|
4
4
|
/**
|
|
5
5
|
* This object represents a single space permission. Permissions consist of* at least one operation object with an
|