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 Settings {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -82,6 +82,8 @@ export declare class Settings {
|
|
|
82
82
|
* space. Note, the default space settings are inherited from the current global settings.
|
|
83
83
|
*
|
|
84
84
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
|
|
85
|
+
*
|
|
86
|
+
* @deprecated Will be removed in next major version.
|
|
85
87
|
*/
|
|
86
88
|
setLookAndFeelSettings<T = unknown>(parameters: Parameters.SetLookAndFeelSettings | undefined, callback: Callback<T>): Promise<void>;
|
|
87
89
|
/**
|
|
@@ -89,6 +91,8 @@ export declare class Settings {
|
|
|
89
91
|
* space. Note, the default space settings are inherited from the current global settings.
|
|
90
92
|
*
|
|
91
93
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
|
|
94
|
+
*
|
|
95
|
+
* @deprecated Will be removed in next major version.
|
|
92
96
|
*/
|
|
93
97
|
setLookAndFeelSettings<T = unknown>(parameters?: Parameters.SetLookAndFeelSettings, callback?: never): Promise<T>;
|
|
94
98
|
/**
|
|
@@ -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 Space {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -11,6 +11,8 @@ export declare class Space {
|
|
|
11
11
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
12
12
|
* ('Can use' global permission). Note, the returned list will only contain spaces that the current user has
|
|
13
13
|
* permission to view.
|
|
14
|
+
*
|
|
15
|
+
* @deprecated Will be removed in next major version.
|
|
14
16
|
*/
|
|
15
17
|
getSpaces<T = Models.SpaceArray>(parameters: Parameters.GetSpaces | undefined, callback: Callback<T>): Promise<void>;
|
|
16
18
|
/**
|
|
@@ -19,6 +21,8 @@ export declare class Space {
|
|
|
19
21
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
20
22
|
* ('Can use' global permission). Note, the returned list will only contain spaces that the current user has
|
|
21
23
|
* permission to view.
|
|
24
|
+
*
|
|
25
|
+
* @deprecated Will be removed in next major version.
|
|
22
26
|
*/
|
|
23
27
|
getSpaces<T = Models.SpaceArray>(parameters?: Parameters.GetSpaces, callback?: never): Promise<T>;
|
|
24
28
|
/**
|
|
@@ -54,6 +58,8 @@ export declare class Space {
|
|
|
54
58
|
* space.
|
|
55
59
|
*
|
|
56
60
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
|
|
61
|
+
*
|
|
62
|
+
* @deprecated Will be removed in next major version.
|
|
57
63
|
*/
|
|
58
64
|
getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback: Callback<T>): Promise<void>;
|
|
59
65
|
/**
|
|
@@ -61,6 +67,8 @@ export declare class Space {
|
|
|
61
67
|
* space.
|
|
62
68
|
*
|
|
63
69
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space.
|
|
70
|
+
*
|
|
71
|
+
* @deprecated Will be removed in next major version.
|
|
64
72
|
*/
|
|
65
73
|
getSpace<T = Models.Space>(parameters: Parameters.GetSpace, callback?: never): Promise<T>;
|
|
66
74
|
/**
|
|
@@ -82,17 +90,17 @@ export declare class Space {
|
|
|
82
90
|
*/
|
|
83
91
|
updateSpace<T = Models.Space>(parameters: Parameters.UpdateSpace, callback?: never): Promise<T>;
|
|
84
92
|
/**
|
|
85
|
-
*
|
|
86
|
-
* yet when this method has returned. Clients should poll the status
|
|
87
|
-
* task completes.
|
|
93
|
+
* Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running
|
|
94
|
+
* task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status
|
|
95
|
+
* link that is returned in the response until the task completes.
|
|
88
96
|
*
|
|
89
97
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
|
|
90
98
|
*/
|
|
91
99
|
deleteSpace<T = Models.LongTask>(parameters: Parameters.DeleteSpace, callback: Callback<T>): Promise<void>;
|
|
92
100
|
/**
|
|
93
|
-
*
|
|
94
|
-
* yet when this method has returned. Clients should poll the status
|
|
95
|
-
* task completes.
|
|
101
|
+
* Permanently deletes a space without sending it to the trash. Note, the space will be deleted in a long running
|
|
102
|
+
* task. Therefore, the space may not be deleted yet when this method has returned. Clients should poll the status
|
|
103
|
+
* link that is returned in the response until the task completes.
|
|
96
104
|
*
|
|
97
105
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Admin' permission for the space.
|
|
98
106
|
*/
|
|
@@ -103,6 +111,8 @@ export declare class Space {
|
|
|
103
111
|
*
|
|
104
112
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
|
|
105
113
|
* returned list will only contain content that the current user has permission to view.
|
|
114
|
+
*
|
|
115
|
+
* @deprecated Will be removed in next major version.
|
|
106
116
|
*/
|
|
107
117
|
getContentForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentForSpace, callback: Callback<T>): Promise<void>;
|
|
108
118
|
/**
|
|
@@ -111,6 +121,8 @@ export declare class Space {
|
|
|
111
121
|
*
|
|
112
122
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
|
|
113
123
|
* returned list will only contain content that the current user has permission to view.
|
|
124
|
+
*
|
|
125
|
+
* @deprecated Will be removed in next major version.
|
|
114
126
|
*/
|
|
115
127
|
getContentForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentForSpace, callback?: never): Promise<T>;
|
|
116
128
|
/**
|
|
@@ -118,6 +130,8 @@ export declare class Space {
|
|
|
118
130
|
*
|
|
119
131
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
|
|
120
132
|
* returned list will only contain content that the current user has permission to view.
|
|
133
|
+
*
|
|
134
|
+
* @deprecated Will be removed in next major version.
|
|
121
135
|
*/
|
|
122
136
|
getContentByTypeForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentByTypeForSpace, callback: Callback<T>): Promise<void>;
|
|
123
137
|
/**
|
|
@@ -125,6 +139,8 @@ export declare class Space {
|
|
|
125
139
|
*
|
|
126
140
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View' permission for the space. Note, the
|
|
127
141
|
* returned list will only contain content that the current user has permission to view.
|
|
142
|
+
*
|
|
143
|
+
* @deprecated Will be removed in next major version.
|
|
128
144
|
*/
|
|
129
145
|
getContentByTypeForSpace<T = Models.ContentArray>(parameters: Parameters.GetContentByTypeForSpace, callback?: never): Promise<T>;
|
|
130
146
|
}
|
|
@@ -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 SpacePermissions {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -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 SpaceProperties {
|
|
6
7
|
private client;
|
|
7
8
|
constructor(client: Client);
|
|
@@ -9,36 +10,48 @@ export declare class SpaceProperties {
|
|
|
9
10
|
* Returns all properties for the given space. Space properties are a key-value storage associated with a space.
|
|
10
11
|
*
|
|
11
12
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
|
|
13
|
+
*
|
|
14
|
+
* @deprecated Will be removed in next major version.
|
|
12
15
|
*/
|
|
13
16
|
getSpaceProperties<T = Models.SpacePropertyArray>(parameters: Parameters.GetSpaceProperties, callback: Callback<T>): Promise<void>;
|
|
14
17
|
/**
|
|
15
18
|
* Returns all properties for the given space. Space properties are a key-value storage associated with a space.
|
|
16
19
|
*
|
|
17
20
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
|
|
21
|
+
*
|
|
22
|
+
* @deprecated Will be removed in next major version.
|
|
18
23
|
*/
|
|
19
24
|
getSpaceProperties<T = Models.SpacePropertyArray>(parameters: Parameters.GetSpaceProperties, callback?: never): Promise<T>;
|
|
20
25
|
/**
|
|
21
26
|
* Creates a new space property.
|
|
22
27
|
*
|
|
23
28
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
29
|
+
*
|
|
30
|
+
* @deprecated Will be removed in next major version.
|
|
24
31
|
*/
|
|
25
32
|
createSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.CreateSpaceProperty, callback: Callback<T>): Promise<void>;
|
|
26
33
|
/**
|
|
27
34
|
* Creates a new space property.
|
|
28
35
|
*
|
|
29
36
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
37
|
+
*
|
|
38
|
+
* @deprecated Will be removed in next major version.
|
|
30
39
|
*/
|
|
31
40
|
createSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.CreateSpaceProperty, callback?: never): Promise<T>;
|
|
32
41
|
/**
|
|
33
42
|
* Returns a space property.
|
|
34
43
|
*
|
|
35
44
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
|
|
45
|
+
*
|
|
46
|
+
* @deprecated Will be removed in next major version.
|
|
36
47
|
*/
|
|
37
48
|
getSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.GetSpaceProperty, callback: Callback<T>): Promise<void>;
|
|
38
49
|
/**
|
|
39
50
|
* Returns a space property.
|
|
40
51
|
*
|
|
41
52
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’ permission for the space.
|
|
53
|
+
*
|
|
54
|
+
* @deprecated Will be removed in next major version.
|
|
42
55
|
*/
|
|
43
56
|
getSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.GetSpaceProperty, callback?: never): Promise<T>;
|
|
44
57
|
/**
|
|
@@ -46,6 +59,8 @@ export declare class SpaceProperties {
|
|
|
46
59
|
* property is passed as a path parameter, rather than in the request body.
|
|
47
60
|
*
|
|
48
61
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
62
|
+
*
|
|
63
|
+
* @deprecated Will be removed in next major version.
|
|
49
64
|
*/
|
|
50
65
|
createSpacePropertyForKey<T = Models.SpaceProperty>(parameters: Parameters.CreateSpacePropertyForKey, callback: Callback<T>): Promise<void>;
|
|
51
66
|
/**
|
|
@@ -53,30 +68,40 @@ export declare class SpaceProperties {
|
|
|
53
68
|
* property is passed as a path parameter, rather than in the request body.
|
|
54
69
|
*
|
|
55
70
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
71
|
+
*
|
|
72
|
+
* @deprecated Will be removed in next major version.
|
|
56
73
|
*/
|
|
57
74
|
createSpacePropertyForKey<T = Models.SpaceProperty>(parameters: Parameters.CreateSpacePropertyForKey, callback?: never): Promise<T>;
|
|
58
75
|
/**
|
|
59
76
|
* Updates a space property. Note, you cannot update the key of a space property, only the value.
|
|
60
77
|
*
|
|
61
78
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
79
|
+
*
|
|
80
|
+
* @deprecated Will be removed in next major version.
|
|
62
81
|
*/
|
|
63
82
|
updateSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.UpdateSpaceProperty, callback: Callback<T>): Promise<void>;
|
|
64
83
|
/**
|
|
65
84
|
* Updates a space property. Note, you cannot update the key of a space property, only the value.
|
|
66
85
|
*
|
|
67
86
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
87
|
+
*
|
|
88
|
+
* @deprecated Will be removed in next major version.
|
|
68
89
|
*/
|
|
69
90
|
updateSpaceProperty<T = Models.SpaceProperty>(parameters: Parameters.UpdateSpaceProperty, callback?: never): Promise<T>;
|
|
70
91
|
/**
|
|
71
92
|
* Deletes a space property.
|
|
72
93
|
*
|
|
73
94
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
95
|
+
*
|
|
96
|
+
* @deprecated Will be removed in next major version.
|
|
74
97
|
*/
|
|
75
98
|
deleteSpaceProperty<T = void>(parameters: Parameters.DeleteSpaceProperty, callback: Callback<T>): Promise<void>;
|
|
76
99
|
/**
|
|
77
100
|
* Deletes a space property.
|
|
78
101
|
*
|
|
79
102
|
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘Admin’ permission for the space.
|
|
103
|
+
*
|
|
104
|
+
* @deprecated Will be removed in next major version.
|
|
80
105
|
*/
|
|
81
106
|
deleteSpaceProperty<T = void>(parameters: Parameters.DeleteSpaceProperty, callback?: never): Promise<T>;
|
|
82
107
|
}
|
|
@@ -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 SpaceSettings {
|
|
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 Template {
|
|
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 Themes {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import type * as Models from "./models/index.js";
|
|
2
|
+
import type * as Parameters from "./parameters/index.js";
|
|
3
|
+
import type { Client } from "../clients/index.js";
|
|
4
|
+
import type { Callback } from "../callback.js";
|
|
5
|
+
export declare class UserProperties {
|
|
6
|
+
private client;
|
|
7
|
+
constructor(client: Client);
|
|
8
|
+
/**
|
|
9
|
+
* Returns the properties for a user as list of property keys. For more information about user properties, see
|
|
10
|
+
* [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
|
|
11
|
+
* `Note`, these properties stored against a user are on a Confluence site level and not space/content level.
|
|
12
|
+
*
|
|
13
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
14
|
+
* ('Can use' global permission).
|
|
15
|
+
*/
|
|
16
|
+
getUserProperties<T = Models.UserPropertyKeyArray>(parameters: Parameters.GetUserProperties, callback: Callback<T>): Promise<void>;
|
|
17
|
+
/**
|
|
18
|
+
* Returns the properties for a user as list of property keys. For more information about user properties, see
|
|
19
|
+
* [Confluence entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/).
|
|
20
|
+
* `Note`, these properties stored against a user are on a Confluence site level and not space/content level.
|
|
21
|
+
*
|
|
22
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
23
|
+
* ('Can use' global permission).
|
|
24
|
+
*/
|
|
25
|
+
getUserProperties<T = Models.UserPropertyKeyArray>(parameters: Parameters.GetUserProperties, callback?: never): Promise<T>;
|
|
26
|
+
/**
|
|
27
|
+
* Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence
|
|
28
|
+
* entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
29
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
30
|
+
*
|
|
31
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
32
|
+
* ('Can use' global permission).
|
|
33
|
+
*/
|
|
34
|
+
getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback: Callback<T>): Promise<void>;
|
|
35
|
+
/**
|
|
36
|
+
* Returns the property corresponding to `key` for a user. For more information about user properties, see [Confluence
|
|
37
|
+
* entity properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
38
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
39
|
+
*
|
|
40
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
41
|
+
* ('Can use' global permission).
|
|
42
|
+
*/
|
|
43
|
+
getUserProperty<T = Models.UserProperty>(parameters: Parameters.GetUserProperty, callback?: never): Promise<T>;
|
|
44
|
+
/**
|
|
45
|
+
* Creates a property for a user. For more information about user properties, see [Confluence entity properties]
|
|
46
|
+
* (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored
|
|
47
|
+
* against a user are on a Confluence site level and not space/content level.
|
|
48
|
+
*
|
|
49
|
+
* `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
|
|
50
|
+
* fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
|
|
51
|
+
* the Confluence site ('Can use' global permission).
|
|
52
|
+
*/
|
|
53
|
+
createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback: Callback<T>): Promise<void>;
|
|
54
|
+
/**
|
|
55
|
+
* Creates a property for a user. For more information about user properties, see [Confluence entity properties]
|
|
56
|
+
* (https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these properties stored
|
|
57
|
+
* against a user are on a Confluence site level and not space/content level.
|
|
58
|
+
*
|
|
59
|
+
* `Note:` the number of properties which could be created per app in a tenant for each user might be restricted by
|
|
60
|
+
* fixed system limits. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access
|
|
61
|
+
* the Confluence site ('Can use' global permission).
|
|
62
|
+
*/
|
|
63
|
+
createUserProperty<T = unknown>(parameters: Parameters.CreateUserProperty, callback?: never): Promise<T>;
|
|
64
|
+
/**
|
|
65
|
+
* Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more
|
|
66
|
+
* information about user properties, see [Confluence entity
|
|
67
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
68
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
69
|
+
*
|
|
70
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
71
|
+
* ('Can use' global permission).
|
|
72
|
+
*/
|
|
73
|
+
updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback: Callback<T>): Promise<void>;
|
|
74
|
+
/**
|
|
75
|
+
* Updates a property for the given user. Note, you cannot update the key of a user property, only the value. For more
|
|
76
|
+
* information about user properties, see [Confluence entity
|
|
77
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
78
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
79
|
+
*
|
|
80
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
81
|
+
* ('Can use' global permission).
|
|
82
|
+
*/
|
|
83
|
+
updateUserProperty<T = void>(parameters: Parameters.UpdateUserProperty, callback?: never): Promise<T>;
|
|
84
|
+
/**
|
|
85
|
+
* Deletes a property for the given user. For more information about user properties, see [Confluence entity
|
|
86
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
87
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
88
|
+
*
|
|
89
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
90
|
+
* ('Can use' global permission).
|
|
91
|
+
*/
|
|
92
|
+
deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback: Callback<T>): Promise<void>;
|
|
93
|
+
/**
|
|
94
|
+
* Deletes a property for the given user. For more information about user properties, see [Confluence entity
|
|
95
|
+
* properties](https://developer.atlassian.com/cloud/confluence/confluence-entity-properties/). `Note`, these
|
|
96
|
+
* properties stored against a user are on a Confluence site level and not space/content level.
|
|
97
|
+
*
|
|
98
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
99
|
+
* ('Can use' global permission).
|
|
100
|
+
*/
|
|
101
|
+
deleteUserProperty<T = void>(parameters: Parameters.DeleteUserProperty, callback?: never): Promise<T>;
|
|
102
|
+
}
|
|
@@ -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 Users {
|
|
6
6
|
private client;
|
|
7
7
|
constructor(client: Client);
|
|
@@ -72,39 +72,46 @@ export declare class Users {
|
|
|
72
72
|
*/
|
|
73
73
|
getGroupMembershipsForUser<T = Models.GroupArrayWithLinks>(parameters: Parameters.GetGroupMembershipsForUser, callback?: never): Promise<T>;
|
|
74
74
|
/**
|
|
75
|
-
* Returns user details for the ids provided in request.
|
|
75
|
+
* Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If
|
|
76
|
+
* more than 100 account ids are passed in, then the first 100 will be returned.
|
|
76
77
|
*
|
|
77
78
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
78
79
|
* ('Can use' global permission).
|
|
79
80
|
*/
|
|
80
81
|
getBulkUserLookup<T = Models.BulkUserLookupArray>(parameters: Parameters.GetBulkUserLookup, callback: Callback<T>): Promise<void>;
|
|
81
82
|
/**
|
|
82
|
-
* Returns user details for the ids provided in request.
|
|
83
|
+
* Returns user details for the ids provided in the request. Currently this API returns a maximum of 100 results. If
|
|
84
|
+
* more than 100 account ids are passed in, then the first 100 will be returned.
|
|
83
85
|
*
|
|
84
86
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
85
87
|
* ('Can use' global permission).
|
|
86
88
|
*/
|
|
87
89
|
getBulkUserLookup<T = Models.BulkUserLookupArray>(parameters: Parameters.GetBulkUserLookup, callback?: never): Promise<T>;
|
|
88
90
|
/**
|
|
89
|
-
* Returns a user's email address
|
|
91
|
+
* Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is
|
|
92
|
+
* only available to apps approved by Atlassian, according to these
|
|
90
93
|
* [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
|
|
94
|
+
* For Forge apps, this API only supports access via asApp() requests.
|
|
91
95
|
*
|
|
92
96
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
93
97
|
* ('Can use' global permission).
|
|
94
98
|
*/
|
|
95
99
|
getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(parameters: Parameters.GetPrivacyUnsafeUserEmail, callback: Callback<T>): Promise<void>;
|
|
96
100
|
/**
|
|
97
|
-
* Returns a user's email address
|
|
101
|
+
* Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is
|
|
102
|
+
* only available to apps approved by Atlassian, according to these
|
|
98
103
|
* [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
|
|
104
|
+
* For Forge apps, this API only supports access via asApp() requests.
|
|
99
105
|
*
|
|
100
106
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
101
107
|
* ('Can use' global permission).
|
|
102
108
|
*/
|
|
103
109
|
getPrivacyUnsafeUserEmail<T = Models.AccountIdEmailRecord>(parameters: Parameters.GetPrivacyUnsafeUserEmail, callback?: never): Promise<T>;
|
|
104
110
|
/**
|
|
105
|
-
* Returns user email
|
|
106
|
-
* according to these
|
|
111
|
+
* Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is
|
|
112
|
+
* only available to apps approved by Atlassian, according to these
|
|
107
113
|
* [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
|
|
114
|
+
* For Forge apps, this API only supports access via asApp() requests.
|
|
108
115
|
*
|
|
109
116
|
* Any accounts which are not available will not be included in the result.
|
|
110
117
|
*
|
|
@@ -113,9 +120,10 @@ export declare class Users {
|
|
|
113
120
|
*/
|
|
114
121
|
getPrivacyUnsafeUserEmailBulk<T = Models.AccountIdEmailRecordArray>(parameters: Parameters.GetPrivacyUnsafeUserEmailBulk, callback: Callback<T>): Promise<void>;
|
|
115
122
|
/**
|
|
116
|
-
* Returns user email
|
|
117
|
-
* according to these
|
|
123
|
+
* Returns a user's email address regardless of the user’s profile visibility settings. For Connect apps, this API is
|
|
124
|
+
* only available to apps approved by Atlassian, according to these
|
|
118
125
|
* [guidelines](https://community.developer.atlassian.com/t/guidelines-for-requesting-access-to-email-address/27603).
|
|
126
|
+
* For Forge apps, this API only supports access via asApp() requests.
|
|
119
127
|
*
|
|
120
128
|
* Any accounts which are not available will not be included in the result.
|
|
121
129
|
*
|
|
@@ -129,6 +137,8 @@ export declare class Users {
|
|
|
129
137
|
*
|
|
130
138
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
|
|
131
139
|
* if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
|
|
140
|
+
*
|
|
141
|
+
* @deprecated Will be removed in next major version.
|
|
132
142
|
*/
|
|
133
143
|
getBulkUserMigration<T = Models.MigratedUserArray>(parameters: Parameters.GetBulkUserMigration, callback: Callback<T>): Promise<void>;
|
|
134
144
|
/**
|
|
@@ -137,6 +147,8 @@ export declare class Users {
|
|
|
137
147
|
*
|
|
138
148
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Confluence Administrator' global permission
|
|
139
149
|
* if specifying a user, otherwise permission to access the Confluence site ('Can use' global permission).
|
|
150
|
+
*
|
|
151
|
+
* @deprecated Will be removed in next major version.
|
|
140
152
|
*/
|
|
141
153
|
getBulkUserMigration<T = Models.MigratedUserArray>(parameters: Parameters.GetBulkUserMigration, callback?: never): Promise<T>;
|
|
142
154
|
}
|
|
@@ -6,6 +6,7 @@ export declare class BaseClient implements Client {
|
|
|
6
6
|
#private;
|
|
7
7
|
protected readonly config: Config;
|
|
8
8
|
constructor(config: Config);
|
|
9
|
+
private warnIfNonEmailBasicAuthLogin;
|
|
9
10
|
protected paramSerializer(parameters: Record<string, any>): string;
|
|
10
11
|
protected encode(value: string): string;
|
|
11
12
|
protected removeUndefinedProperties(obj: Record<string, any>): Record<string, any>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseClient } from "./baseClient.js";
|
|
2
2
|
import type { Config } from "../config.js";
|
|
3
|
-
import { Analytics, Audit, Content, ContentAttachments, ContentBody, ContentChildrenAndDescendants, ContentComments, ContentLabels, ContentMacroBody, ContentPermissions, ContentProperties, ContentRestrictions, ContentStates, ContentVersions, ContentWatches, DynamicModules, Experimental, Group, InlineTasks, LabelInfo, LongRunningTask, Relation, Search, Settings, Space, SpacePermissions, SpaceProperties, SpaceSettings, Template, Themes, Users } from "../api/index.js";
|
|
3
|
+
import { Analytics, Audit, Content, ContentAttachments, ContentBody, ContentChildrenAndDescendants, ContentComments, ContentLabels, ContentMacroBody, ContentPermissions, ContentProperties, ContentRestrictions, ContentStates, ContentVersions, ContentWatches, DynamicModules, Experimental, Group, InlineTasks, LabelInfo, LongRunningTask, Relation, Search, Settings, Space, SpacePermissions, SpaceProperties, SpaceSettings, Template, Themes, Users, UserProperties } from "../api/index.js";
|
|
4
4
|
export declare class ConfluenceClient extends BaseClient {
|
|
5
5
|
constructor(config: Config);
|
|
6
6
|
analytics: Analytics;
|
|
@@ -9,10 +9,12 @@ export declare class ConfluenceClient extends BaseClient {
|
|
|
9
9
|
contentAttachments: ContentAttachments;
|
|
10
10
|
contentBody: ContentBody;
|
|
11
11
|
contentChildrenAndDescendants: ContentChildrenAndDescendants;
|
|
12
|
+
/** @deprecated Will be removed in next major version. */
|
|
12
13
|
contentComments: ContentComments;
|
|
13
14
|
contentLabels: ContentLabels;
|
|
14
15
|
contentMacroBody: ContentMacroBody;
|
|
15
16
|
contentPermissions: ContentPermissions;
|
|
17
|
+
/** @deprecated Will be removed in next major version. */
|
|
16
18
|
contentProperties: ContentProperties;
|
|
17
19
|
contentRestrictions: ContentRestrictions;
|
|
18
20
|
contentStates: ContentStates;
|
|
@@ -21,6 +23,7 @@ export declare class ConfluenceClient extends BaseClient {
|
|
|
21
23
|
dynamicModules: DynamicModules;
|
|
22
24
|
experimental: Experimental;
|
|
23
25
|
group: Group;
|
|
26
|
+
/** @deprecated Will be removed in next major version. */
|
|
24
27
|
inlineTasks: InlineTasks;
|
|
25
28
|
labelInfo: LabelInfo;
|
|
26
29
|
longRunningTask: LongRunningTask;
|
|
@@ -29,9 +32,11 @@ export declare class ConfluenceClient extends BaseClient {
|
|
|
29
32
|
settings: Settings;
|
|
30
33
|
space: Space;
|
|
31
34
|
spacePermissions: SpacePermissions;
|
|
35
|
+
/** @deprecated Will be removed in next major version. */
|
|
32
36
|
spaceProperties: SpaceProperties;
|
|
33
37
|
spaceSettings: SpaceSettings;
|
|
34
38
|
template: Template;
|
|
35
39
|
themes: Themes;
|
|
36
40
|
users: Users;
|
|
41
|
+
userProperties: UserProperties;
|
|
37
42
|
}
|