confluence.js 1.1.3 → 1.3.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 +49 -0
- package/README.md +1 -57
- package/out/api/content.d.ts +24 -52
- package/out/api/content.js +15 -0
- package/out/api/contentAttachments.d.ts +10 -6
- package/out/api/contentAttachments.js +13 -0
- package/out/api/contentChildrenAndDescendants.d.ts +6 -24
- package/out/api/contentChildrenAndDescendants.js +6 -0
- package/out/api/contentPermissions.d.ts +6 -2
- package/out/api/contentPermissions.js +6 -1
- package/out/api/contentProperties.js +2 -0
- package/out/api/contentWatches.d.ts +2 -2
- package/out/api/experimental.d.ts +52 -0
- package/out/api/experimental.js +70 -0
- package/out/api/group.d.ts +30 -10
- package/out/api/group.js +31 -2
- package/out/api/index.d.ts +1 -0
- package/out/api/index.js +1 -0
- package/out/api/inlineTasks.d.ts +28 -0
- package/out/api/inlineTasks.js +21 -0
- package/out/api/models/getViewers.d.ts +6 -0
- package/out/api/models/getViewers.js +2 -0
- package/out/api/models/getViews.d.ts +6 -0
- package/out/api/models/getViews.js +2 -0
- package/out/api/models/groupCreate.d.ts +4 -0
- package/out/api/models/groupCreate.js +2 -0
- package/out/api/models/horizontalHeaderLookAndFeel.d.ts +11 -0
- package/out/api/models/horizontalHeaderLookAndFeel.js +2 -0
- package/out/api/models/index.d.ts +13 -4
- package/out/api/models/index.js +13 -4
- package/out/api/models/lookAndFeel.d.ts +3 -0
- package/out/api/models/spacePermissionCreate.d.ts +33 -0
- package/out/api/models/spacePermissionCreate.js +2 -0
- package/out/api/models/spacePermissionCustomContent.d.ts +16 -0
- package/out/api/models/spacePermissionCustomContent.js +2 -0
- package/out/api/models/spacePermissionRequest.d.ts +41 -0
- package/out/api/models/spacePermissionRequest.js +2 -0
- package/out/api/models/spacePrivateCreate.d.ts +9 -0
- package/out/api/models/spacePropertyCreate.d.ts +4 -0
- package/out/api/models/spaceUpdate.d.ts +4 -0
- package/out/api/models/taskStatusUpdate.d.ts +3 -0
- package/out/api/models/taskStatusUpdate.js +2 -0
- package/out/api/models/topNavigationLookAndFeel.d.ts +8 -0
- package/out/api/models/topNavigationLookAndFeel.js +2 -0
- package/out/api/parameters/addCustomContentPermissions.d.ts +5 -0
- package/out/api/parameters/addCustomContentPermissions.js +2 -0
- package/out/api/parameters/addLabelsToSpace.d.ts +4 -0
- package/out/api/parameters/addLabelsToSpace.js +2 -0
- package/out/api/parameters/addPermissionToSpace.d.ts +5 -0
- package/out/api/parameters/addPermissionToSpace.js +2 -0
- package/out/api/parameters/addUserToGroup.d.ts +2 -1
- package/out/api/parameters/addUserToGroupByGroupId.d.ts +2 -1
- package/out/api/parameters/archivePages.d.ts +6 -0
- package/out/api/parameters/archivePages.js +2 -0
- package/out/api/parameters/checkContentPermission.d.ts +5 -0
- package/out/api/parameters/checkContentPermission.js +2 -0
- package/out/api/parameters/deleteLabelFromSpace.d.ts +8 -0
- package/out/api/parameters/deleteLabelFromSpace.js +2 -0
- package/out/api/parameters/deleteRelationship.d.ts +38 -0
- package/out/api/parameters/deleteRelationship.js +2 -0
- package/out/api/parameters/downloadAttachment.d.ts +11 -0
- package/out/api/parameters/downloadAttachment.js +2 -0
- package/out/api/parameters/getBulkUserLookup.d.ts +0 -6
- package/out/api/parameters/getContentById.d.ts +85 -1
- package/out/api/parameters/getContentById.js +87 -0
- package/out/api/parameters/getContentChildren.d.ts +1 -0
- package/out/api/parameters/getContentProperties.d.ts +2 -0
- package/out/api/parameters/getContentProperty.d.ts +12 -0
- package/out/api/parameters/getContentVersions.d.ts +1 -1
- package/out/api/parameters/getCurrentUser.d.ts +1 -6
- package/out/api/parameters/getDescendantsOfType.d.ts +101 -0
- package/out/api/parameters/getDescendantsOfType.js +89 -0
- package/out/api/parameters/getGroupByName.d.ts +4 -0
- package/out/api/parameters/getGroupByName.js +2 -0
- package/out/api/parameters/getGroups.d.ts +2 -0
- package/out/api/parameters/getHistoryForContent.d.ts +1 -1
- package/out/api/parameters/getLabelsForSpace.d.ts +18 -0
- package/out/api/parameters/getLabelsForSpace.js +2 -0
- package/out/api/parameters/getTaskById.d.ts +4 -0
- package/out/api/parameters/getTaskById.js +2 -0
- package/out/api/parameters/getViewers.d.ts +6 -0
- package/out/api/parameters/getViewers.js +2 -0
- package/out/api/parameters/getViews.d.ts +6 -0
- package/out/api/parameters/getViews.js +2 -0
- package/out/api/parameters/index.d.ts +134 -116
- package/out/api/parameters/index.js +134 -116
- package/out/api/parameters/publishLegacyDraft.d.ts +3 -1
- package/out/api/parameters/publishSharedDraft.d.ts +3 -1
- package/out/api/parameters/restoreContentVersion.d.ts +1 -1
- package/out/api/parameters/searchByCQL.d.ts +34 -0
- package/out/api/parameters/searchByCQL.js +2 -0
- package/out/api/parameters/searchGroups.d.ts +8 -0
- package/out/api/parameters/searchGroups.js +2 -0
- package/out/api/parameters/searchUser.d.ts +27 -0
- package/out/api/parameters/searchUser.js +2 -0
- package/out/api/parameters/updateTaskById.d.ts +5 -0
- package/out/api/parameters/updateTaskById.js +2 -0
- package/out/api/relation.d.ts +12 -4
- package/out/api/relation.js +12 -2
- package/out/api/search.d.ts +12 -64
- package/out/api/search.js +19 -2
- package/out/api/settings.d.ts +2 -2
- package/out/api/settings.js +3 -0
- package/out/api/space.js +5 -1
- package/out/api/spacePermissions.d.ts +26 -2
- package/out/api/spacePermissions.js +20 -3
- package/out/api/spaceProperties.d.ts +4 -4
- package/out/api/spaceProperties.js +1 -0
- package/out/api/template.d.ts +24 -16
- package/out/clients/baseClient.d.ts +2 -5
- package/out/clients/baseClient.js +4 -30
- package/out/clients/client.d.ts +2 -3
- package/out/clients/confluenceClient.d.ts +2 -1
- package/out/clients/confluenceClient.js +1 -0
- package/out/config.d.ts +3 -2
- package/out/index.d.ts +1 -0
- package/out/index.js +2 -1
- package/package.json +24 -24
- package/src/api/content.ts +58 -52
- package/src/api/contentAttachments.ts +29 -6
- package/src/api/contentChildrenAndDescendants.ts +24 -28
- package/src/api/contentPermissions.ts +24 -7
- package/src/api/contentProperties.ts +2 -0
- package/src/api/contentWatches.ts +3 -3
- package/src/api/experimental.ts +137 -0
- package/src/api/group.ts +71 -19
- package/src/api/index.ts +1 -0
- package/src/api/inlineTasks.ts +52 -0
- package/src/api/models/getViewers.ts +6 -0
- package/src/api/models/getViews.ts +6 -0
- package/src/api/models/groupCreate.ts +4 -0
- package/src/api/models/horizontalHeaderLookAndFeel.ts +12 -0
- package/src/api/models/index.ts +13 -4
- package/src/api/models/lookAndFeel.ts +3 -0
- package/src/api/models/spacePermissionCreate.ts +34 -0
- package/src/api/models/spacePermissionCustomContent.ts +17 -0
- package/src/api/models/spacePermissionRequest.ts +42 -0
- package/src/api/models/spacePrivateCreate.ts +9 -0
- package/src/api/models/spacePropertyCreate.ts +4 -0
- package/src/api/models/spaceUpdate.ts +4 -0
- package/src/api/models/taskStatusUpdate.ts +3 -0
- package/src/api/models/topNavigationLookAndFeel.ts +8 -0
- package/src/api/parameters/addCustomContentPermissions.ts +6 -0
- package/src/api/parameters/addLabelsToSpace.ts +4 -0
- package/src/api/parameters/addPermissionToSpace.ts +6 -0
- package/src/api/parameters/addUserToGroup.ts +3 -1
- package/src/api/parameters/addUserToGroupByGroupId.ts +3 -1
- package/src/api/parameters/archivePages.ts +6 -0
- package/src/api/parameters/checkContentPermission.ts +6 -0
- package/src/api/parameters/deleteLabelFromSpace.ts +8 -0
- package/src/api/parameters/deleteRelationship.ts +38 -0
- package/src/api/parameters/downloadAttachment.ts +11 -0
- package/src/api/parameters/getBulkUserLookup.ts +0 -6
- package/src/api/parameters/getContentById.ts +86 -1
- package/src/api/parameters/getContentChildren.ts +1 -0
- package/src/api/parameters/getContentProperties.ts +2 -0
- package/src/api/parameters/getContentProperty.ts +12 -0
- package/src/api/parameters/getContentVersions.ts +1 -1
- package/src/api/parameters/getCurrentUser.ts +1 -6
- package/src/api/parameters/getDescendantsOfType.ts +102 -0
- package/src/api/parameters/getGroupByName.ts +4 -0
- package/src/api/parameters/getGroups.ts +2 -0
- package/src/api/parameters/getHistoryForContent.ts +1 -1
- package/src/api/parameters/getLabelsForSpace.ts +18 -0
- package/src/api/parameters/getTaskById.ts +4 -0
- package/src/api/parameters/getViewers.ts +6 -0
- package/src/api/parameters/getViews.ts +6 -0
- package/src/api/parameters/index.ts +134 -116
- package/src/api/parameters/publishLegacyDraft.ts +4 -1
- package/src/api/parameters/publishSharedDraft.ts +4 -1
- package/src/api/parameters/restoreContentVersion.ts +1 -1
- package/src/api/parameters/searchByCQL.ts +34 -0
- package/src/api/parameters/searchGroups.ts +8 -0
- package/src/api/parameters/searchUser.ts +27 -0
- package/src/api/parameters/updateTaskById.ts +6 -0
- package/src/api/relation.ts +33 -8
- package/src/api/search.ts +53 -73
- package/src/api/settings.ts +6 -3
- package/src/api/space.ts +4 -1
- package/src/api/spacePermissions.ts +66 -8
- package/src/api/spaceProperties.ts +5 -4
- package/src/api/template.ts +24 -16
- package/src/clients/baseClient.ts +4 -60
- package/src/clients/client.ts +2 -3
- package/src/clients/confluenceClient.ts +2 -0
- package/src/config.ts +3 -2
- package/src/index.ts +1 -0
- package/tsconfig.json +2 -1
package/out/api/group.d.ts
CHANGED
|
@@ -71,6 +71,22 @@ export declare class Group {
|
|
|
71
71
|
* ('Can use' global permission).
|
|
72
72
|
*/
|
|
73
73
|
getGroupByGroupId<T = Models.Group>(parameters: Parameters.GetGroupByGroupId, callback?: never): Promise<T>;
|
|
74
|
+
/**
|
|
75
|
+
* Delete user group.
|
|
76
|
+
*
|
|
77
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
78
|
+
*/
|
|
79
|
+
removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback: Callback<T>): Promise<void>;
|
|
80
|
+
/**
|
|
81
|
+
* Delete user group.
|
|
82
|
+
*
|
|
83
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: User must be a site admin.
|
|
84
|
+
*/
|
|
85
|
+
removeGroupById<T = void>(parameters: Parameters.RemoveGroupById, callback?: never): Promise<T>;
|
|
86
|
+
/** @deprecated Will be removed in the next major version. Use `getGroupByName` instead. */
|
|
87
|
+
getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback: Callback<T>): Promise<void>;
|
|
88
|
+
/** @deprecated Will be removed in the next major version. Use `getGroupByName` instead. */
|
|
89
|
+
getGroup<T = Models.Group>(parameters: Parameters.GetGroup, callback?: never): Promise<T>;
|
|
74
90
|
/**
|
|
75
91
|
* Returns a user group for a given group name.
|
|
76
92
|
*
|
|
@@ -79,7 +95,7 @@ export declare class Group {
|
|
|
79
95
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
80
96
|
* ('Can use' global permission).
|
|
81
97
|
*/
|
|
82
|
-
|
|
98
|
+
getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback: Callback<T>): Promise<void>;
|
|
83
99
|
/**
|
|
84
100
|
* Returns a user group for a given group name.
|
|
85
101
|
*
|
|
@@ -88,21 +104,21 @@ export declare class Group {
|
|
|
88
104
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
89
105
|
* ('Can use' global permission).
|
|
90
106
|
*/
|
|
91
|
-
|
|
107
|
+
getGroupByName<T = Models.Group>(parameters: Parameters.GetGroupByName, callback?: never): Promise<T>;
|
|
92
108
|
/**
|
|
93
109
|
* Returns the users that are members of a group.
|
|
94
110
|
*
|
|
95
111
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
96
112
|
* ('Can use' global permission).
|
|
97
113
|
*/
|
|
98
|
-
getMembersByQueryParam<T = Models.
|
|
114
|
+
getMembersByQueryParam<T = Models.UserArray>(parameters: Parameters.GetMembersByQueryParam, callback: Callback<T>): Promise<void>;
|
|
99
115
|
/**
|
|
100
116
|
* Returns the users that are members of a group.
|
|
101
117
|
*
|
|
102
118
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
103
119
|
* ('Can use' global permission).
|
|
104
120
|
*/
|
|
105
|
-
getMembersByQueryParam<T = Models.
|
|
121
|
+
getMembersByQueryParam<T = Models.UserArray>(parameters: Parameters.GetMembersByQueryParam, callback?: never): Promise<T>;
|
|
106
122
|
/**
|
|
107
123
|
* Returns the users that are members of a group.
|
|
108
124
|
*
|
|
@@ -111,7 +127,7 @@ export declare class Group {
|
|
|
111
127
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
112
128
|
* ('Can use' global permission).
|
|
113
129
|
*/
|
|
114
|
-
getGroupMembers<T = Models.
|
|
130
|
+
getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback: Callback<T>): Promise<void>;
|
|
115
131
|
/**
|
|
116
132
|
* Returns the users that are members of a group.
|
|
117
133
|
*
|
|
@@ -120,11 +136,15 @@ export declare class Group {
|
|
|
120
136
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
121
137
|
* ('Can use' global permission).
|
|
122
138
|
*/
|
|
123
|
-
getGroupMembers<T = Models.
|
|
124
|
-
/**
|
|
139
|
+
getGroupMembers<T = Models.UserArray>(parameters: Parameters.GetGroupMembers, callback?: never): Promise<T>;
|
|
140
|
+
/** @deprecated Will be removed in the next major version. Use `searchGroups` instead. */
|
|
125
141
|
getGroupsSearch<T = Models.GroupArrayWithLinks>(parameters: Parameters.GetGroupsSearch, callback: Callback<T>): Promise<void>;
|
|
126
|
-
/**
|
|
142
|
+
/** @deprecated Will be removed in the next major version. Use `searchGroups` instead. */
|
|
127
143
|
getGroupsSearch<T = Models.GroupArrayWithLinks>(parameters: Parameters.GetGroupsSearch, callback?: never): Promise<T>;
|
|
144
|
+
/** Get search results of groups by partial query provided. */
|
|
145
|
+
searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback: Callback<T>): Promise<void>;
|
|
146
|
+
/** Get search results of groups by partial query provided. */
|
|
147
|
+
searchGroups<T = Models.GroupArrayWithLinks>(parameters: Parameters.SearchGroups, callback?: never): Promise<T>;
|
|
128
148
|
/**
|
|
129
149
|
* Adds a user as a member in a group represented by its groupId
|
|
130
150
|
*
|
|
@@ -157,7 +177,7 @@ export declare class Group {
|
|
|
157
177
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
158
178
|
* ('Can use' global permission).
|
|
159
179
|
*/
|
|
160
|
-
getGroupMembersByGroupId<T = Models.
|
|
180
|
+
getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback: Callback<T>): Promise<void>;
|
|
161
181
|
/**
|
|
162
182
|
* Returns the users that are members of a group.
|
|
163
183
|
*
|
|
@@ -166,7 +186,7 @@ export declare class Group {
|
|
|
166
186
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to access the Confluence site
|
|
167
187
|
* ('Can use' global permission).
|
|
168
188
|
*/
|
|
169
|
-
getGroupMembersByGroupId<T = Models.
|
|
189
|
+
getGroupMembersByGroupId<T = Models.UserArray>(parameters: Parameters.GetGroupMembersByGroupId, callback?: never): Promise<T>;
|
|
170
190
|
/**
|
|
171
191
|
* Adds a user as a member in a group.
|
|
172
192
|
*
|
package/out/api/group.js
CHANGED
|
@@ -14,6 +14,7 @@ class Group {
|
|
|
14
14
|
params: {
|
|
15
15
|
start: parameters === null || parameters === void 0 ? void 0 : parameters.start,
|
|
16
16
|
limit: parameters === null || parameters === void 0 ? void 0 : parameters.limit,
|
|
17
|
+
accessType: parameters === null || parameters === void 0 ? void 0 : parameters.accessType,
|
|
17
18
|
},
|
|
18
19
|
};
|
|
19
20
|
return this.client.sendRequest(config, callback, { methodName: 'getGroups' });
|
|
@@ -67,13 +68,30 @@ class Group {
|
|
|
67
68
|
return this.client.sendRequest(config, callback, { methodName: 'getGroupByGroupId' });
|
|
68
69
|
});
|
|
69
70
|
}
|
|
71
|
+
removeGroupById(parameters, callback) {
|
|
72
|
+
return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
|
|
73
|
+
const config = {
|
|
74
|
+
url: '/api/group/by-id',
|
|
75
|
+
method: 'DELETE',
|
|
76
|
+
params: {
|
|
77
|
+
id: parameters.id,
|
|
78
|
+
},
|
|
79
|
+
};
|
|
80
|
+
return this.client.sendRequest(config, callback, { methodName: 'removeGroupById' });
|
|
81
|
+
});
|
|
82
|
+
}
|
|
70
83
|
getGroup(parameters, callback) {
|
|
84
|
+
return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
|
|
85
|
+
return this.getGroupByName(parameters, callback);
|
|
86
|
+
});
|
|
87
|
+
}
|
|
88
|
+
getGroupByName(parameters, callback) {
|
|
71
89
|
return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
|
|
72
90
|
const config = {
|
|
73
91
|
url: `/api/group/${parameters.groupName}`,
|
|
74
92
|
method: 'GET',
|
|
75
93
|
};
|
|
76
|
-
return this.client.sendRequest(config, callback, { methodName: '
|
|
94
|
+
return this.client.sendRequest(config, callback, { methodName: 'getGroupByName' });
|
|
77
95
|
});
|
|
78
96
|
}
|
|
79
97
|
getMembersByQueryParam(parameters, callback) {
|
|
@@ -104,6 +122,11 @@ class Group {
|
|
|
104
122
|
});
|
|
105
123
|
}
|
|
106
124
|
getGroupsSearch(parameters, callback) {
|
|
125
|
+
return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
|
|
126
|
+
return this.searchGroups(parameters, callback);
|
|
127
|
+
});
|
|
128
|
+
}
|
|
129
|
+
searchGroups(parameters, callback) {
|
|
107
130
|
return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
|
|
108
131
|
const config = {
|
|
109
132
|
url: '/api/group/picker',
|
|
@@ -114,7 +137,7 @@ class Group {
|
|
|
114
137
|
limit: parameters.limit,
|
|
115
138
|
},
|
|
116
139
|
};
|
|
117
|
-
return this.client.sendRequest(config, callback, { methodName: '
|
|
140
|
+
return this.client.sendRequest(config, callback, { methodName: 'searchGroups' });
|
|
118
141
|
});
|
|
119
142
|
}
|
|
120
143
|
addUserToGroupByGroupId(parameters, callback) {
|
|
@@ -125,6 +148,9 @@ class Group {
|
|
|
125
148
|
params: {
|
|
126
149
|
groupId: parameters.groupId,
|
|
127
150
|
},
|
|
151
|
+
data: {
|
|
152
|
+
accountId: parameters.accountId,
|
|
153
|
+
},
|
|
128
154
|
};
|
|
129
155
|
return this.client.sendRequest(config, callback, { methodName: 'addUserToGroupByGroupId' });
|
|
130
156
|
});
|
|
@@ -163,6 +189,9 @@ class Group {
|
|
|
163
189
|
params: {
|
|
164
190
|
name: parameters.name,
|
|
165
191
|
},
|
|
192
|
+
data: {
|
|
193
|
+
accountId: parameters.accountId,
|
|
194
|
+
},
|
|
166
195
|
};
|
|
167
196
|
return this.client.sendRequest(config, callback, { methodName: 'addUserToGroup' });
|
|
168
197
|
});
|
package/out/api/index.d.ts
CHANGED
|
@@ -12,6 +12,7 @@ export * from './contentRestrictions';
|
|
|
12
12
|
export * from './contentVersions';
|
|
13
13
|
export * from './contentWatches';
|
|
14
14
|
export * from './dynamicModules';
|
|
15
|
+
export * from './experimental';
|
|
15
16
|
export * from './group';
|
|
16
17
|
export * from './inlineTasks';
|
|
17
18
|
export * from './labelInfo';
|
package/out/api/index.js
CHANGED
|
@@ -15,6 +15,7 @@ const tslib_1 = require("tslib");
|
|
|
15
15
|
(0, tslib_1.__exportStar)(require("./contentVersions"), exports);
|
|
16
16
|
(0, tslib_1.__exportStar)(require("./contentWatches"), exports);
|
|
17
17
|
(0, tslib_1.__exportStar)(require("./dynamicModules"), exports);
|
|
18
|
+
(0, tslib_1.__exportStar)(require("./experimental"), exports);
|
|
18
19
|
(0, tslib_1.__exportStar)(require("./group"), exports);
|
|
19
20
|
(0, tslib_1.__exportStar)(require("./inlineTasks"), exports);
|
|
20
21
|
(0, tslib_1.__exportStar)(require("./labelInfo"), exports);
|
package/out/api/inlineTasks.d.ts
CHANGED
|
@@ -19,4 +19,32 @@ export declare class InlineTasks {
|
|
|
19
19
|
* ('Can use' global permission). Only tasks in contents that the user has permission to view are returned.
|
|
20
20
|
*/
|
|
21
21
|
searchTasks<T = Models.TaskPageResponse>(parameters?: Parameters.SearchTasks, callback?: never): Promise<T>;
|
|
22
|
+
/**
|
|
23
|
+
* Returns inline task based on the global ID.
|
|
24
|
+
*
|
|
25
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
|
|
26
|
+
* with the task.
|
|
27
|
+
*/
|
|
28
|
+
getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback: Callback<T>): Promise<void>;
|
|
29
|
+
/**
|
|
30
|
+
* Returns inline task based on the global ID.
|
|
31
|
+
*
|
|
32
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the content associated
|
|
33
|
+
* with the task.
|
|
34
|
+
*/
|
|
35
|
+
getTaskById<T = Models.Task>(parameters: Parameters.GetTaskById, callback?: never): Promise<T>;
|
|
36
|
+
/**
|
|
37
|
+
* Updates an inline tasks status given its global ID
|
|
38
|
+
*
|
|
39
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
|
|
40
|
+
* with the task.
|
|
41
|
+
*/
|
|
42
|
+
updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback: Callback<T>): Promise<void>;
|
|
43
|
+
/**
|
|
44
|
+
* Updates an inline tasks status given its global ID
|
|
45
|
+
*
|
|
46
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to update the content associated
|
|
47
|
+
* with the task.
|
|
48
|
+
*/
|
|
49
|
+
updateTaskById<T = Models.Task>(parameters: Parameters.UpdateTaskById, callback?: never): Promise<T>;
|
|
22
50
|
}
|
package/out/api/inlineTasks.js
CHANGED
|
@@ -31,5 +31,26 @@ class InlineTasks {
|
|
|
31
31
|
return this.client.sendRequest(config, callback, { methodName: 'searchTasks' });
|
|
32
32
|
});
|
|
33
33
|
}
|
|
34
|
+
getTaskById(parameters, callback) {
|
|
35
|
+
return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
|
|
36
|
+
const config = {
|
|
37
|
+
url: `/api/inlinetasks/${parameters.inlineTaskId}`,
|
|
38
|
+
method: 'GET',
|
|
39
|
+
};
|
|
40
|
+
return this.client.sendRequest(config, callback, { methodName: 'getTaskById' });
|
|
41
|
+
});
|
|
42
|
+
}
|
|
43
|
+
updateTaskById(parameters, callback) {
|
|
44
|
+
return (0, tslib_1.__awaiter)(this, void 0, void 0, function* () {
|
|
45
|
+
const config = {
|
|
46
|
+
url: `/api/inlinetasks/${parameters.inlineTaskId}`,
|
|
47
|
+
method: 'PUT',
|
|
48
|
+
data: {
|
|
49
|
+
status: parameters.status,
|
|
50
|
+
},
|
|
51
|
+
};
|
|
52
|
+
return this.client.sendRequest(config, callback, { methodName: 'updateTaskById' });
|
|
53
|
+
});
|
|
54
|
+
}
|
|
34
55
|
}
|
|
35
56
|
exports.InlineTasks = InlineTasks;
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import { ButtonLookAndFeel } from './buttonLookAndFeel';
|
|
2
|
+
import { TopNavigationLookAndFeel } from './topNavigationLookAndFeel';
|
|
3
|
+
import { NavigationLookAndFeel } from './navigationLookAndFeel';
|
|
4
|
+
import { SearchFieldLookAndFeel } from './searchFieldLookAndFeel';
|
|
5
|
+
export interface HorizontalHeaderLookAndFeel {
|
|
6
|
+
backgroundColor: string;
|
|
7
|
+
button?: ButtonLookAndFeel;
|
|
8
|
+
primaryNavigation: TopNavigationLookAndFeel;
|
|
9
|
+
secondaryNavigation?: NavigationLookAndFeel;
|
|
10
|
+
search?: SearchFieldLookAndFeel;
|
|
11
|
+
}
|
|
@@ -14,8 +14,6 @@ export * from './breadcrumb';
|
|
|
14
14
|
export * from './bulkUserLookup';
|
|
15
15
|
export * from './bulkUserLookupArray';
|
|
16
16
|
export * from './buttonLookAndFeel';
|
|
17
|
-
export * from './cQLPersonalDataConvertedQueries';
|
|
18
|
-
export * from './cQLPersonalDataMigrationRequest';
|
|
19
17
|
export * from './changedValue';
|
|
20
18
|
export * from './connectModule';
|
|
21
19
|
export * from './connectModules';
|
|
@@ -30,8 +28,8 @@ export * from './contentBlueprintDraft';
|
|
|
30
28
|
export * from './contentBody';
|
|
31
29
|
export * from './contentBodyCreate';
|
|
32
30
|
export * from './contentBodyCreateStorage';
|
|
33
|
-
export * from './contentChildType';
|
|
34
31
|
export * from './contentChildren';
|
|
32
|
+
export * from './contentChildType';
|
|
35
33
|
export * from './contentComment';
|
|
36
34
|
export * from './contentCreate';
|
|
37
35
|
export * from './contentHistory';
|
|
@@ -59,17 +57,23 @@ export * from './copyPageHierarchyRequest';
|
|
|
59
57
|
export * from './copyPageHierarchyTitleOptions';
|
|
60
58
|
export * from './copyPageRequest';
|
|
61
59
|
export * from './copyPageRequestDestination';
|
|
60
|
+
export * from './cQLPersonalDataConvertedQueries';
|
|
61
|
+
export * from './cQLPersonalDataMigrationRequest';
|
|
62
62
|
export * from './deletedSpace';
|
|
63
63
|
export * from './dynamicModulesErrorMessage';
|
|
64
64
|
export * from './embeddable';
|
|
65
65
|
export * from './embeddedContent';
|
|
66
66
|
export * from './genericLinks';
|
|
67
67
|
export * from './getRestrictionsByOperation';
|
|
68
|
+
export * from './getViewers';
|
|
69
|
+
export * from './getViews';
|
|
68
70
|
export * from './group';
|
|
69
71
|
export * from './groupArray';
|
|
70
72
|
export * from './groupArrayWithLinks';
|
|
73
|
+
export * from './groupCreate';
|
|
71
74
|
export * from './groupName';
|
|
72
75
|
export * from './headerLookAndFeel';
|
|
76
|
+
export * from './horizontalHeaderLookAndFeel';
|
|
73
77
|
export * from './icon';
|
|
74
78
|
export * from './label';
|
|
75
79
|
export * from './labelArray';
|
|
@@ -112,6 +116,9 @@ export * from './spaceCreate';
|
|
|
112
116
|
export * from './spaceDescription';
|
|
113
117
|
export * from './spaceDescriptionCreate';
|
|
114
118
|
export * from './spacePermission';
|
|
119
|
+
export * from './spacePermissionCreate';
|
|
120
|
+
export * from './spacePermissionCustomContent';
|
|
121
|
+
export * from './spacePermissionRequest';
|
|
115
122
|
export * from './spacePermissionV2';
|
|
116
123
|
export * from './spacePrivateCreate';
|
|
117
124
|
export * from './spaceProperty';
|
|
@@ -129,17 +136,19 @@ export * from './superBatchWebResources';
|
|
|
129
136
|
export * from './systemInfoEntity';
|
|
130
137
|
export * from './task';
|
|
131
138
|
export * from './taskPageResponse';
|
|
139
|
+
export * from './taskStatusUpdate';
|
|
132
140
|
export * from './theme';
|
|
133
141
|
export * from './themeArray';
|
|
134
142
|
export * from './themeNoLinks';
|
|
135
143
|
export * from './themeUpdate';
|
|
144
|
+
export * from './topNavigationLookAndFeel';
|
|
136
145
|
export * from './user';
|
|
137
146
|
export * from './userAnonymous';
|
|
138
147
|
export * from './userArray';
|
|
139
148
|
export * from './userArrayWithLinks';
|
|
140
149
|
export * from './userDetails';
|
|
141
|
-
export * from './userWatch';
|
|
142
150
|
export * from './usersUserKeys';
|
|
151
|
+
export * from './userWatch';
|
|
143
152
|
export * from './version';
|
|
144
153
|
export * from './versionArray';
|
|
145
154
|
export * from './versionRestore';
|
package/out/api/models/index.js
CHANGED
|
@@ -17,8 +17,6 @@ const tslib_1 = require("tslib");
|
|
|
17
17
|
(0, tslib_1.__exportStar)(require("./bulkUserLookup"), exports);
|
|
18
18
|
(0, tslib_1.__exportStar)(require("./bulkUserLookupArray"), exports);
|
|
19
19
|
(0, tslib_1.__exportStar)(require("./buttonLookAndFeel"), exports);
|
|
20
|
-
(0, tslib_1.__exportStar)(require("./cQLPersonalDataConvertedQueries"), exports);
|
|
21
|
-
(0, tslib_1.__exportStar)(require("./cQLPersonalDataMigrationRequest"), exports);
|
|
22
20
|
(0, tslib_1.__exportStar)(require("./changedValue"), exports);
|
|
23
21
|
(0, tslib_1.__exportStar)(require("./connectModule"), exports);
|
|
24
22
|
(0, tslib_1.__exportStar)(require("./connectModules"), exports);
|
|
@@ -33,8 +31,8 @@ const tslib_1 = require("tslib");
|
|
|
33
31
|
(0, tslib_1.__exportStar)(require("./contentBody"), exports);
|
|
34
32
|
(0, tslib_1.__exportStar)(require("./contentBodyCreate"), exports);
|
|
35
33
|
(0, tslib_1.__exportStar)(require("./contentBodyCreateStorage"), exports);
|
|
36
|
-
(0, tslib_1.__exportStar)(require("./contentChildType"), exports);
|
|
37
34
|
(0, tslib_1.__exportStar)(require("./contentChildren"), exports);
|
|
35
|
+
(0, tslib_1.__exportStar)(require("./contentChildType"), exports);
|
|
38
36
|
(0, tslib_1.__exportStar)(require("./contentComment"), exports);
|
|
39
37
|
(0, tslib_1.__exportStar)(require("./contentCreate"), exports);
|
|
40
38
|
(0, tslib_1.__exportStar)(require("./contentHistory"), exports);
|
|
@@ -62,17 +60,23 @@ const tslib_1 = require("tslib");
|
|
|
62
60
|
(0, tslib_1.__exportStar)(require("./copyPageHierarchyTitleOptions"), exports);
|
|
63
61
|
(0, tslib_1.__exportStar)(require("./copyPageRequest"), exports);
|
|
64
62
|
(0, tslib_1.__exportStar)(require("./copyPageRequestDestination"), exports);
|
|
63
|
+
(0, tslib_1.__exportStar)(require("./cQLPersonalDataConvertedQueries"), exports);
|
|
64
|
+
(0, tslib_1.__exportStar)(require("./cQLPersonalDataMigrationRequest"), exports);
|
|
65
65
|
(0, tslib_1.__exportStar)(require("./deletedSpace"), exports);
|
|
66
66
|
(0, tslib_1.__exportStar)(require("./dynamicModulesErrorMessage"), exports);
|
|
67
67
|
(0, tslib_1.__exportStar)(require("./embeddable"), exports);
|
|
68
68
|
(0, tslib_1.__exportStar)(require("./embeddedContent"), exports);
|
|
69
69
|
(0, tslib_1.__exportStar)(require("./genericLinks"), exports);
|
|
70
70
|
(0, tslib_1.__exportStar)(require("./getRestrictionsByOperation"), exports);
|
|
71
|
+
(0, tslib_1.__exportStar)(require("./getViewers"), exports);
|
|
72
|
+
(0, tslib_1.__exportStar)(require("./getViews"), exports);
|
|
71
73
|
(0, tslib_1.__exportStar)(require("./group"), exports);
|
|
72
74
|
(0, tslib_1.__exportStar)(require("./groupArray"), exports);
|
|
73
75
|
(0, tslib_1.__exportStar)(require("./groupArrayWithLinks"), exports);
|
|
76
|
+
(0, tslib_1.__exportStar)(require("./groupCreate"), exports);
|
|
74
77
|
(0, tslib_1.__exportStar)(require("./groupName"), exports);
|
|
75
78
|
(0, tslib_1.__exportStar)(require("./headerLookAndFeel"), exports);
|
|
79
|
+
(0, tslib_1.__exportStar)(require("./horizontalHeaderLookAndFeel"), exports);
|
|
76
80
|
(0, tslib_1.__exportStar)(require("./icon"), exports);
|
|
77
81
|
(0, tslib_1.__exportStar)(require("./label"), exports);
|
|
78
82
|
(0, tslib_1.__exportStar)(require("./labelArray"), exports);
|
|
@@ -115,6 +119,9 @@ const tslib_1 = require("tslib");
|
|
|
115
119
|
(0, tslib_1.__exportStar)(require("./spaceDescription"), exports);
|
|
116
120
|
(0, tslib_1.__exportStar)(require("./spaceDescriptionCreate"), exports);
|
|
117
121
|
(0, tslib_1.__exportStar)(require("./spacePermission"), exports);
|
|
122
|
+
(0, tslib_1.__exportStar)(require("./spacePermissionCreate"), exports);
|
|
123
|
+
(0, tslib_1.__exportStar)(require("./spacePermissionCustomContent"), exports);
|
|
124
|
+
(0, tslib_1.__exportStar)(require("./spacePermissionRequest"), exports);
|
|
118
125
|
(0, tslib_1.__exportStar)(require("./spacePermissionV2"), exports);
|
|
119
126
|
(0, tslib_1.__exportStar)(require("./spacePrivateCreate"), exports);
|
|
120
127
|
(0, tslib_1.__exportStar)(require("./spaceProperty"), exports);
|
|
@@ -132,17 +139,19 @@ const tslib_1 = require("tslib");
|
|
|
132
139
|
(0, tslib_1.__exportStar)(require("./systemInfoEntity"), exports);
|
|
133
140
|
(0, tslib_1.__exportStar)(require("./task"), exports);
|
|
134
141
|
(0, tslib_1.__exportStar)(require("./taskPageResponse"), exports);
|
|
142
|
+
(0, tslib_1.__exportStar)(require("./taskStatusUpdate"), exports);
|
|
135
143
|
(0, tslib_1.__exportStar)(require("./theme"), exports);
|
|
136
144
|
(0, tslib_1.__exportStar)(require("./themeArray"), exports);
|
|
137
145
|
(0, tslib_1.__exportStar)(require("./themeNoLinks"), exports);
|
|
138
146
|
(0, tslib_1.__exportStar)(require("./themeUpdate"), exports);
|
|
147
|
+
(0, tslib_1.__exportStar)(require("./topNavigationLookAndFeel"), exports);
|
|
139
148
|
(0, tslib_1.__exportStar)(require("./user"), exports);
|
|
140
149
|
(0, tslib_1.__exportStar)(require("./userAnonymous"), exports);
|
|
141
150
|
(0, tslib_1.__exportStar)(require("./userArray"), exports);
|
|
142
151
|
(0, tslib_1.__exportStar)(require("./userArrayWithLinks"), exports);
|
|
143
152
|
(0, tslib_1.__exportStar)(require("./userDetails"), exports);
|
|
144
|
-
(0, tslib_1.__exportStar)(require("./userWatch"), exports);
|
|
145
153
|
(0, tslib_1.__exportStar)(require("./usersUserKeys"), exports);
|
|
154
|
+
(0, tslib_1.__exportStar)(require("./userWatch"), exports);
|
|
146
155
|
(0, tslib_1.__exportStar)(require("./version"), exports);
|
|
147
156
|
(0, tslib_1.__exportStar)(require("./versionArray"), exports);
|
|
148
157
|
(0, tslib_1.__exportStar)(require("./versionRestore"), exports);
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { MenusLookAndFeel } from './menusLookAndFeel';
|
|
2
2
|
import { HeaderLookAndFeel } from './headerLookAndFeel';
|
|
3
3
|
import { ContentLookAndFeel } from './contentLookAndFeel';
|
|
4
|
+
import { HorizontalHeaderLookAndFeel } from './horizontalHeaderLookAndFeel';
|
|
4
5
|
export interface LookAndFeel {
|
|
5
6
|
headings: {
|
|
6
7
|
color: string;
|
|
@@ -14,4 +15,6 @@ export interface LookAndFeel {
|
|
|
14
15
|
bordersAndDividers: {
|
|
15
16
|
color: string;
|
|
16
17
|
};
|
|
18
|
+
horizontalHeader?: HorizontalHeaderLookAndFeel;
|
|
19
|
+
spaceReference?: unknown;
|
|
17
20
|
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { User } from './user';
|
|
2
|
+
import { GroupCreate } from './groupCreate';
|
|
3
|
+
import { OperationCheckResult } from './operationCheckResult';
|
|
4
|
+
/**
|
|
5
|
+
* This object represents a permission for given space. Permissions consist of* at least one operation object with an
|
|
6
|
+
* accompanying subjects object.
|
|
7
|
+
*
|
|
8
|
+
* The following combinations of `operation` and `targetType` values are valid for the `operation` object:
|
|
9
|
+
*
|
|
10
|
+
* - 'create': 'page', 'blogpost', 'comment', 'attachment'
|
|
11
|
+
* - 'read': 'space'
|
|
12
|
+
* - 'delete': 'page', 'blogpost', 'comment', 'attachment'
|
|
13
|
+
* - 'export': 'space'
|
|
14
|
+
* - 'administer': 'space'
|
|
15
|
+
*/
|
|
16
|
+
export interface SpacePermissionCreate {
|
|
17
|
+
/** The users and/or groups that the permission applies to. */
|
|
18
|
+
subjects: {
|
|
19
|
+
user?: {
|
|
20
|
+
results: User[];
|
|
21
|
+
size: number;
|
|
22
|
+
};
|
|
23
|
+
group?: {
|
|
24
|
+
results: GroupCreate[];
|
|
25
|
+
size: number;
|
|
26
|
+
};
|
|
27
|
+
};
|
|
28
|
+
operation: OperationCheckResult;
|
|
29
|
+
/** Grant anonymous users permission to use the operation. */
|
|
30
|
+
anonymousAccess: boolean;
|
|
31
|
+
/** Grants access to unlicensed users from JIRA Service Desk when used with the 'read space' operation. */
|
|
32
|
+
unlicensedAccess: boolean;
|
|
33
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { PermissionSubject } from './permissionSubject';
|
|
2
|
+
/**
|
|
3
|
+
* This object represents a list of space permissions for custom content type for an individual user. Permissions
|
|
4
|
+
* consist of* a subjects object and a list with at least one operation object.
|
|
5
|
+
*/
|
|
6
|
+
export interface SpacePermissionCustomContent {
|
|
7
|
+
subject: PermissionSubject;
|
|
8
|
+
operations: {
|
|
9
|
+
/** The operation type */
|
|
10
|
+
key: string;
|
|
11
|
+
/** The custom content type */
|
|
12
|
+
target: string;
|
|
13
|
+
/** Grant or restrict access */
|
|
14
|
+
access: boolean;
|
|
15
|
+
}[];
|
|
16
|
+
}
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { PermissionSubject } from './permissionSubject';
|
|
2
|
+
import { GenericLinks } from './genericLinks';
|
|
3
|
+
/**
|
|
4
|
+
* This object represents the request for the single space permission. Permissions consist of* at least one operation
|
|
5
|
+
* object with an accompanying subjects object.
|
|
6
|
+
*
|
|
7
|
+
* The following combinations of `operation.key` and `operation.target` values are valid for the `operation` object:
|
|
8
|
+
*
|
|
9
|
+
* ```bash
|
|
10
|
+
* 'create': 'page', 'blogpost', 'comment', 'attachment'
|
|
11
|
+
* 'read': 'space'
|
|
12
|
+
* 'delete': 'page', 'blogpost', 'comment', 'attachment', 'space'
|
|
13
|
+
* 'export': 'space'
|
|
14
|
+
* 'administer': 'space'
|
|
15
|
+
* 'archive': 'page'
|
|
16
|
+
* 'restrict_content': 'space'
|
|
17
|
+
* ```
|
|
18
|
+
*
|
|
19
|
+
* For example, to enable Delete Own permission, set the `operation` object to the following:
|
|
20
|
+
*
|
|
21
|
+
* "operation": {
|
|
22
|
+
* "key": "delete",
|
|
23
|
+
* "target": "space"
|
|
24
|
+
* }
|
|
25
|
+
*
|
|
26
|
+
* To enable Add/Delete Restrictions permissions, set the `operation` object to the following:
|
|
27
|
+
*
|
|
28
|
+
* "operation": {
|
|
29
|
+
* "key": "restrict_content",
|
|
30
|
+
* "target": "space"
|
|
31
|
+
* }
|
|
32
|
+
*/
|
|
33
|
+
export interface SpacePermissionRequest {
|
|
34
|
+
subject: PermissionSubject;
|
|
35
|
+
operation: {
|
|
36
|
+
key: string;
|
|
37
|
+
/** The space or content type that the operation applies to. */
|
|
38
|
+
target: string;
|
|
39
|
+
};
|
|
40
|
+
links?: GenericLinks;
|
|
41
|
+
}
|
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import { SpaceDescriptionCreate } from './spaceDescriptionCreate';
|
|
2
|
+
import { SpacePermissionCreate } from './spacePermissionCreate';
|
|
2
3
|
/** This is the request object used when creating a new private space. */
|
|
3
4
|
export interface SpacePrivateCreate {
|
|
4
5
|
/** The key for the new space. Format: See [Space keys](https://confluence.atlassian.com/x/lqNMMQ). */
|
|
@@ -6,4 +7,12 @@ export interface SpacePrivateCreate {
|
|
|
6
7
|
/** The name of the new space. */
|
|
7
8
|
name: string;
|
|
8
9
|
description?: SpaceDescriptionCreate;
|
|
10
|
+
/**
|
|
11
|
+
* The permissions for the new space. If no permissions are provided, the [Confluence default space
|
|
12
|
+
* permissions](https://confluence.atlassian.com/x/UAgzKw#CreateaSpace-Spacepermissions) are applied. Note that if
|
|
13
|
+
* permissions are provided, the space is created with only the provided set of permissions, not including the default
|
|
14
|
+
* space permissions. Space permissions can be modified after creation using the space permissions endpoints, and a
|
|
15
|
+
* private space can be created using the create private space endpoint.
|
|
16
|
+
*/
|
|
17
|
+
permissions?: SpacePermissionCreate[];
|
|
9
18
|
}
|