@resolution/confluence-api-client 0.4.4 → 0.4.6
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 +22 -0
- package/README.md +60 -1
- package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +32 -33
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js +151 -88
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
- package/lib/openapi/v1/core/CommonHttpService.d.ts +2 -0
- package/lib/openapi/v1/core/CommonHttpService.js +9 -0
- package/lib/openapi/v1/core/CommonHttpService.js.map +1 -1
- package/lib/openapi/v1/services/AnalyticsService.d.ts +10 -10
- package/lib/openapi/v1/services/AnalyticsService.js +62 -59
- package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
- package/lib/openapi/v1/services/AuditService.d.ts +25 -25
- package/lib/openapi/v1/services/AuditService.js +205 -202
- package/lib/openapi/v1/services/AuditService.js.map +1 -1
- package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +20 -20
- package/lib/openapi/v1/services/ContentAttachmentsService.js +317 -314
- package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentBodyService.d.ts +15 -15
- package/lib/openapi/v1/services/ContentBodyService.js +140 -137
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +27 -27
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +391 -388
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentCommentsService.d.ts +8 -8
- package/lib/openapi/v1/services/ContentCommentsService.js +49 -46
- package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentLabelsService.d.ts +11 -11
- package/lib/openapi/v1/services/ContentLabelsService.js +150 -147
- package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +13 -13
- package/lib/openapi/v1/services/ContentMacroBodyService.js +155 -152
- package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -2
- package/lib/openapi/v1/services/ContentPermissionsService.js +48 -45
- package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPropertiesService.d.ts +18 -18
- package/lib/openapi/v1/services/ContentPropertiesService.js +237 -234
- package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +49 -49
- package/lib/openapi/v1/services/ContentRestrictionsService.js +505 -502
- package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentService.d.ts +50 -50
- package/lib/openapi/v1/services/ContentService.js +475 -472
- package/lib/openapi/v1/services/ContentService.js.map +1 -1
- package/lib/openapi/v1/services/ContentStatesService.d.ts +25 -25
- package/lib/openapi/v1/services/ContentStatesService.js +359 -356
- package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentVersionsService.d.ts +13 -13
- package/lib/openapi/v1/services/ContentVersionsService.js +144 -141
- package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentWatchesService.d.ts +57 -57
- package/lib/openapi/v1/services/ContentWatchesService.js +454 -451
- package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
- package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -5
- package/lib/openapi/v1/services/DynamicModulesService.js +70 -67
- package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
- package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -12
- package/lib/openapi/v1/services/ExperimentalService.js +151 -148
- package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
- package/lib/openapi/v1/services/GroupService.d.ts +52 -52
- package/lib/openapi/v1/services/GroupService.js +445 -442
- package/lib/openapi/v1/services/GroupService.js.map +1 -1
- package/lib/openapi/v1/services/InlineTasksService.d.ts +20 -20
- package/lib/openapi/v1/services/InlineTasksService.js +118 -115
- package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
- package/lib/openapi/v1/services/LabelInfoService.d.ts +5 -5
- package/lib/openapi/v1/services/LabelInfoService.js +37 -34
- package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
- package/lib/openapi/v1/services/LongRunningTaskService.d.ts +8 -6
- package/lib/openapi/v1/services/LongRunningTaskService.js +67 -63
- package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
- package/lib/openapi/v1/services/RelationService.d.ts +37 -37
- package/lib/openapi/v1/services/RelationService.js +231 -228
- package/lib/openapi/v1/services/RelationService.js.map +1 -1
- package/lib/openapi/v1/services/SearchService.d.ts +20 -20
- package/lib/openapi/v1/services/SearchService.js +136 -133
- package/lib/openapi/v1/services/SearchService.js.map +1 -1
- package/lib/openapi/v1/services/SettingsService.d.ts +15 -15
- package/lib/openapi/v1/services/SettingsService.js +204 -201
- package/lib/openapi/v1/services/SettingsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -6
- package/lib/openapi/v1/services/SpacePermissionsService.js +99 -96
- package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePropertiesService.d.ts +16 -16
- package/lib/openapi/v1/services/SpacePropertiesService.js +227 -224
- package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceService.d.ts +38 -38
- package/lib/openapi/v1/services/SpaceService.js +320 -317
- package/lib/openapi/v1/services/SpaceService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -4
- package/lib/openapi/v1/services/SpaceSettingsService.js +68 -65
- package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
- package/lib/openapi/v1/services/TemplateService.d.ts +20 -20
- package/lib/openapi/v1/services/TemplateService.js +214 -211
- package/lib/openapi/v1/services/TemplateService.js.map +1 -1
- package/lib/openapi/v1/services/ThemesService.d.ts +13 -13
- package/lib/openapi/v1/services/ThemesService.js +179 -176
- package/lib/openapi/v1/services/ThemesService.js.map +1 -1
- package/lib/openapi/v1/services/UserPropertiesService.d.ts +12 -12
- package/lib/openapi/v1/services/UserPropertiesService.js +165 -162
- package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/UsersService.d.ts +21 -21
- package/lib/openapi/v1/services/UsersService.js +229 -226
- package/lib/openapi/v1/services/UsersService.js.map +1 -1
- package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +23 -24
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js +92 -47
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
- package/lib/openapi/v2/core/CommonHttpService.d.ts +2 -0
- package/lib/openapi/v2/core/CommonHttpService.js +9 -0
- package/lib/openapi/v2/core/CommonHttpService.js.map +1 -1
- package/lib/openapi/v2/models/user.d.ts +0 -2
- package/lib/openapi/v2/models/user.js +0 -2
- package/lib/openapi/v2/models/user.js.map +1 -1
- package/lib/openapi/v2/services/AncestorsService.d.ts +17 -17
- package/lib/openapi/v2/services/AncestorsService.js +174 -171
- package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
- package/lib/openapi/v2/services/AttachmentService.d.ts +62 -62
- package/lib/openapi/v2/services/AttachmentService.js +261 -258
- package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
- package/lib/openapi/v2/services/BlogPostService.d.ts +70 -70
- package/lib/openapi/v2/services/BlogPostService.js +270 -267
- package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
- package/lib/openapi/v2/services/ChildrenService.d.ts +14 -14
- package/lib/openapi/v2/services/ChildrenService.js +77 -74
- package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
- package/lib/openapi/v2/services/ClassificationLevelService.d.ts +21 -21
- package/lib/openapi/v2/services/ClassificationLevelService.js +304 -301
- package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
- package/lib/openapi/v2/services/CommentService.d.ts +136 -136
- package/lib/openapi/v2/services/CommentService.js +635 -632
- package/lib/openapi/v2/services/CommentService.js.map +1 -1
- package/lib/openapi/v2/services/ContentPropertiesService.d.ts +128 -128
- package/lib/openapi/v2/services/ContentPropertiesService.js +1242 -1239
- package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/ContentService.d.ts +2 -2
- package/lib/openapi/v2/services/ContentService.js +40 -37
- package/lib/openapi/v2/services/ContentService.js.map +1 -1
- package/lib/openapi/v2/services/CustomContentService.d.ts +72 -72
- package/lib/openapi/v2/services/CustomContentService.js +299 -296
- package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
- package/lib/openapi/v2/services/DataPoliciesService.d.ts +10 -10
- package/lib/openapi/v2/services/DataPoliciesService.js +67 -64
- package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
- package/lib/openapi/v2/services/DatabaseService.d.ts +17 -17
- package/lib/openapi/v2/services/DatabaseService.js +90 -87
- package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
- package/lib/openapi/v2/services/LabelService.d.ts +57 -57
- package/lib/openapi/v2/services/LabelService.js +263 -260
- package/lib/openapi/v2/services/LabelService.js.map +1 -1
- package/lib/openapi/v2/services/LikeService.d.ts +36 -36
- package/lib/openapi/v2/services/LikeService.js +250 -247
- package/lib/openapi/v2/services/LikeService.js.map +1 -1
- package/lib/openapi/v2/services/OperationService.d.ts +20 -20
- package/lib/openapi/v2/services/OperationService.js +298 -295
- package/lib/openapi/v2/services/OperationService.js.map +1 -1
- package/lib/openapi/v2/services/PageService.d.ts +73 -73
- package/lib/openapi/v2/services/PageService.js +272 -269
- package/lib/openapi/v2/services/PageService.js.map +1 -1
- package/lib/openapi/v2/services/SmartLinkService.d.ts +19 -17
- package/lib/openapi/v2/services/SmartLinkService.js +92 -89
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePermissionsService.d.ts +6 -6
- package/lib/openapi/v2/services/SpacePermissionsService.js +35 -32
- package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePropertiesService.d.ts +15 -15
- package/lib/openapi/v2/services/SpacePropertiesService.js +165 -162
- package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/SpaceService.d.ts +28 -28
- package/lib/openapi/v2/services/SpaceService.js +83 -80
- package/lib/openapi/v2/services/SpaceService.js.map +1 -1
- package/lib/openapi/v2/services/TaskService.d.ts +40 -40
- package/lib/openapi/v2/services/TaskService.js +120 -117
- package/lib/openapi/v2/services/TaskService.js.map +1 -1
- package/lib/openapi/v2/services/UserService.d.ts +11 -11
- package/lib/openapi/v2/services/UserService.js +91 -88
- package/lib/openapi/v2/services/UserService.js.map +1 -1
- package/lib/openapi/v2/services/VersionService.d.ts +59 -59
- package/lib/openapi/v2/services/VersionService.js +395 -392
- package/lib/openapi/v2/services/VersionService.js.map +1 -1
- package/lib/openapi/v2/services/WhiteboardService.d.ts +17 -17
- package/lib/openapi/v2/services/WhiteboardService.js +90 -87
- package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
- package/package.json +4 -3
|
@@ -11,207 +11,210 @@ const settings_1 = require("../models/settings");
|
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
12
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings */
|
|
13
13
|
class SettingsService extends CommonHttpService_1.CommonHttpService {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
/**
|
|
17
|
+
* Returns the look and feel settings for the site or a single space. This
|
|
18
|
+
* includes attributes such as the color scheme, padding, and border radius.
|
|
19
|
+
*
|
|
20
|
+
* The look and feel settings for a space can be inherited from the global
|
|
21
|
+
* look and feel settings or provided by a theme.
|
|
22
|
+
*
|
|
23
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
24
|
+
* None
|
|
25
|
+
*
|
|
26
|
+
* @returns Returned if the requested look and feel settings are returned.
|
|
27
|
+
* @path {GET} /wiki/rest/api/settings/lookandfeel
|
|
28
|
+
* @scopes-current manage:confluence-configuration
|
|
29
|
+
* @scopes-beta read:configuration:confluence, read:space.setting:confluence
|
|
30
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-get
|
|
31
|
+
*/
|
|
32
|
+
this.getLookAndFeelSettings = ({ spaceKey, } = {}) => {
|
|
33
|
+
return this.getClientInstance()
|
|
34
|
+
.request({
|
|
35
|
+
path: "/wiki/rest/api/settings/lookandfeel",
|
|
36
|
+
method: "GET",
|
|
37
|
+
query: {
|
|
38
|
+
spaceKey,
|
|
39
|
+
},
|
|
40
|
+
})
|
|
41
|
+
.then(this.getClientInstance().responseHandler({
|
|
42
|
+
200: {
|
|
43
|
+
"application/json": "json",
|
|
44
|
+
},
|
|
45
|
+
}))
|
|
46
|
+
.then(commonHttpClient.castResponse())
|
|
47
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.getLookAndFeelSettings.response"))
|
|
48
|
+
.then(commonHttpClient.getBody);
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* Returns the system information for the Confluence Cloud tenant. This
|
|
52
|
+
* information is used by Atlassian.
|
|
53
|
+
*
|
|
54
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
55
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
56
|
+
*
|
|
57
|
+
* @returns Returned if the system information for the Confluence Cloud tenant
|
|
58
|
+
* is returned.
|
|
59
|
+
* @path {GET} /wiki/rest/api/settings/systemInfo
|
|
60
|
+
* @scopes-current manage:confluence-configuration
|
|
61
|
+
* @scopes-beta read:configuration:confluence
|
|
62
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-systeminfo-get
|
|
63
|
+
*/
|
|
64
|
+
this.getSystemInfo = () => {
|
|
65
|
+
return this.getClientInstance()
|
|
66
|
+
.request({
|
|
67
|
+
path: "/wiki/rest/api/settings/systemInfo",
|
|
68
|
+
method: "GET",
|
|
69
|
+
})
|
|
70
|
+
.then(this.getClientInstance().responseHandler({
|
|
71
|
+
200: {
|
|
72
|
+
"application/json": "json",
|
|
73
|
+
},
|
|
74
|
+
}))
|
|
75
|
+
.then(commonHttpClient.castResponse())
|
|
76
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.getSystemInfo.response"))
|
|
77
|
+
.then(commonHttpClient.getBody);
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Resets the custom look and feel settings for the site or a single space.
|
|
81
|
+
* This changes the values of the custom settings to be the same as the
|
|
82
|
+
* default settings. It does not change which settings (default or custom)
|
|
83
|
+
* are selected. Note, the default space settings are inherited from the
|
|
84
|
+
* current global settings.
|
|
85
|
+
*
|
|
86
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
87
|
+
* 'Admin' permission for the space.
|
|
88
|
+
*
|
|
89
|
+
* @path {DELETE} /wiki/rest/api/settings/lookandfeel/custom
|
|
90
|
+
* @scopes-current manage:confluence-configuration
|
|
91
|
+
* @scopes-beta write:configuration:confluence, write:space.setting:confluence
|
|
92
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-delete
|
|
93
|
+
*/
|
|
94
|
+
this.resetLookAndFeelSettings = ({ spaceKey, } = {}) => {
|
|
95
|
+
return this.getClientInstance()
|
|
96
|
+
.request({
|
|
97
|
+
path: "/wiki/rest/api/settings/lookandfeel/custom",
|
|
98
|
+
method: "DELETE",
|
|
99
|
+
query: {
|
|
100
|
+
spaceKey,
|
|
101
|
+
},
|
|
102
|
+
})
|
|
103
|
+
.then(commonHttpClient.discardResult);
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
* Sets the look and feel settings to either the default settings or the
|
|
107
|
+
* custom settings, for the site or a single space. Note, the default
|
|
108
|
+
* space settings are inherited from the current global settings.
|
|
109
|
+
*
|
|
110
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
111
|
+
* 'Admin' permission for the space.
|
|
112
|
+
*
|
|
113
|
+
* @deprecated
|
|
114
|
+
* @returns Returned if the look and feel settings were set.
|
|
115
|
+
* @path {PUT} /wiki/rest/api/settings/lookandfeel/selected
|
|
116
|
+
* @scopes-current manage:confluence-configuration
|
|
117
|
+
* @scopes-beta read:configuration:confluence, read:space.setting:confluence,
|
|
118
|
+
* write:configuration:confluence, write:space.setting:confluence
|
|
119
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-selected-put
|
|
120
|
+
*/
|
|
121
|
+
this.setLookAndFeelSettings = ({ spaceKey, requestBody, }) => {
|
|
122
|
+
return this.getClientInstance()
|
|
123
|
+
.request({
|
|
124
|
+
path: "/wiki/rest/api/settings/lookandfeel/selected",
|
|
125
|
+
method: "PUT",
|
|
126
|
+
query: {
|
|
127
|
+
spaceKey,
|
|
128
|
+
},
|
|
129
|
+
headers: {
|
|
130
|
+
"Content-Type": "application/json",
|
|
131
|
+
},
|
|
132
|
+
body: requestBody,
|
|
133
|
+
})
|
|
134
|
+
.then(this.getClientInstance().responseHandler({
|
|
135
|
+
200: {
|
|
136
|
+
"application/json": "json",
|
|
137
|
+
},
|
|
138
|
+
}))
|
|
139
|
+
.then(commonHttpClient.castResponse())
|
|
140
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.setLookAndFeelSettings.response"))
|
|
141
|
+
.then(commonHttpClient.getBody);
|
|
142
|
+
};
|
|
143
|
+
/**
|
|
144
|
+
* Sets the look and feel settings to the default (global) settings, the
|
|
145
|
+
* custom settings, or the current theme's settings for a space.
|
|
146
|
+
* The custom and theme settings can only be selected if there is already
|
|
147
|
+
* a theme set for a space. Note, the default space settings are inherited
|
|
148
|
+
* from the current global settings.
|
|
149
|
+
*
|
|
150
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
151
|
+
* 'Admin' permission for the space.
|
|
152
|
+
*
|
|
153
|
+
* @returns Returned if the look and feel settings were set.
|
|
154
|
+
* @path {PUT} /wiki/rest/api/settings/lookandfeel
|
|
155
|
+
* @scopes-current manage:confluence-configuration
|
|
156
|
+
* @scopes-beta read:space.setting:confluence, write:space.setting:confluence
|
|
157
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-put
|
|
158
|
+
*/
|
|
159
|
+
this.updateLookAndFeel = ({ lookAndFeelSelection, }) => {
|
|
160
|
+
return this.getClientInstance()
|
|
161
|
+
.request({
|
|
162
|
+
path: "/wiki/rest/api/settings/lookandfeel",
|
|
163
|
+
method: "PUT",
|
|
164
|
+
headers: {
|
|
165
|
+
"Content-Type": "application/json",
|
|
166
|
+
},
|
|
167
|
+
body: lookAndFeelSelection,
|
|
168
|
+
})
|
|
169
|
+
.then(this.getClientInstance().responseHandler({
|
|
170
|
+
200: {
|
|
171
|
+
"application/json": "json",
|
|
172
|
+
},
|
|
173
|
+
}))
|
|
174
|
+
.then(commonHttpClient.castResponse())
|
|
175
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.updateLookAndFeel.response"))
|
|
176
|
+
.then(commonHttpClient.getBody);
|
|
177
|
+
};
|
|
178
|
+
/**
|
|
179
|
+
* Updates the look and feel settings for the site or for a single space.
|
|
180
|
+
* If custom settings exist, they are updated. If no custom settings exist,
|
|
181
|
+
* then a set of custom settings is created.
|
|
182
|
+
*
|
|
183
|
+
* Note, if a theme is selected for a space, the space look and feel settings
|
|
184
|
+
* are provided by the theme and cannot be overridden.
|
|
185
|
+
*
|
|
186
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
187
|
+
* 'Admin' permission for the space.
|
|
188
|
+
*
|
|
189
|
+
* @returns Returned if the look and feel settings are updated.
|
|
190
|
+
* @path {POST} /wiki/rest/api/settings/lookandfeel/custom
|
|
191
|
+
* @scopes-current manage:confluence-configuration
|
|
192
|
+
* @scopes-beta read:configuration:confluence, read:space.setting:confluence,
|
|
193
|
+
* write:configuration:confluence, write:space.setting:confluence
|
|
194
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-post
|
|
195
|
+
*/
|
|
196
|
+
this.updateLookAndFeelSettings = ({ spaceKey, lookAndFeel, }) => {
|
|
197
|
+
return this.getClientInstance()
|
|
198
|
+
.request({
|
|
199
|
+
path: "/wiki/rest/api/settings/lookandfeel/custom",
|
|
200
|
+
method: "POST",
|
|
201
|
+
query: {
|
|
202
|
+
spaceKey,
|
|
203
|
+
},
|
|
204
|
+
headers: {
|
|
205
|
+
"Content-Type": "application/json",
|
|
206
|
+
},
|
|
207
|
+
body: lookAndFeel,
|
|
208
|
+
})
|
|
209
|
+
.then(this.getClientInstance().responseHandler({
|
|
210
|
+
200: {
|
|
211
|
+
"application/json": "json",
|
|
212
|
+
},
|
|
213
|
+
}))
|
|
214
|
+
.then(commonHttpClient.castResponse())
|
|
215
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SettingsService.updateLookAndFeelSettings.response"))
|
|
216
|
+
.then(commonHttpClient.getBody);
|
|
217
|
+
};
|
|
215
218
|
}
|
|
216
219
|
static initialize() {
|
|
217
220
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SettingsService.getLookAndFeelSettings.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SettingsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SettingsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAE9D,iDAM4B;AAC5B,wEAAqE;AACrE,uFAAuF;AACvF,MAAa,eAAgB,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"SettingsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SettingsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAE9D,iDAM4B;AAC5B,wEAAqE;AACrE,uFAAuF;AACvF,MAAa,eAAgB,SAAQ,qCAAiB;IAAtD;;QACE;;;;;;;;;;;;;;;WAeG;QACH,2BAAsB,GAAG,CAAC,EACxB,QAAQ,MAQN,EAAE,EAAgC,EAAE;YACtC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qCAAqC;gBAC3C,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,iDAAiD,CAClD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,kBAAa,GAAG,GAAqC,EAAE;YACrD,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,KAAK;aACd,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wCAAwC,CACzC,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,6BAAwB,GAAG,CAAC,EAC1B,QAAQ,MAQN,EAAE,EAAiB,EAAE;YACvB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;WAeG;QACH,2BAAsB,GAAG,CAAC,EACxB,QAAQ,EACR,WAAW,GAUZ,EAAmB,EAAE;YACpB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8CAA8C;gBACpD,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,iDAAiD,CAClD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;WAeG;QACH,sBAAiB,GAAG,CAAC,EACnB,oBAAoB,GAIrB,EAAiC,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qCAAqC;gBAC3C,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,oBAAoB;aAC3B,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,4CAA4C,CAC7C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,8BAAyB,GAAG,CAAC,EAC3B,QAAQ,EACR,WAAW,GAiBZ,EAAiC,EAAE;YAClC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4CAA4C;gBAClD,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE;oBACL,QAAQ;iBACT;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAsDJ,CAAC;IArDC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,iDAAiD,EACjD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC;SAC1D,CAAC;aACD,QAAQ,CAAC,iDAAiD,CAAC,CAC/D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC3D,CAAC;aACD,QAAQ,CAAC,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,sBAAsB,CAAC;SAC3D,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iDAAiD,EACjD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;SACjB,CAAC;aACD,QAAQ,CAAC,iDAAiD,CAAC,CAC/D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wCAAwC,EACxC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SACnE,CAAC;aACD,QAAQ,CAAC,wCAAwC,CAAC,CACtD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AAlXD,0CAkXC"}
|
|
@@ -18,12 +18,12 @@ export declare class SpacePermissionsService extends CommonHttpService {
|
|
|
18
18
|
* @scopes-current read:space.permission:confluence, write:space.permission:confluence
|
|
19
19
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-custom-content-post
|
|
20
20
|
*/
|
|
21
|
-
addCustomContentPermissions({ spaceKey, spacePermissionCustomContent, }: {
|
|
21
|
+
addCustomContentPermissions: ({ spaceKey, spacePermissionCustomContent, }: {
|
|
22
22
|
/** The key of the space to be queried for its content. */
|
|
23
23
|
spaceKey: string;
|
|
24
24
|
/** The permissions to be created. */
|
|
25
25
|
spacePermissionCustomContent: SpacePermissionCustomContent;
|
|
26
|
-
})
|
|
26
|
+
}) => Promise<void>;
|
|
27
27
|
/**
|
|
28
28
|
* Adds new permission to space.
|
|
29
29
|
*
|
|
@@ -41,12 +41,12 @@ export declare class SpacePermissionsService extends CommonHttpService {
|
|
|
41
41
|
* @scopes-current read:space.permission:confluence, write:space.permission:confluence
|
|
42
42
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-post
|
|
43
43
|
*/
|
|
44
|
-
addPermissionToSpace({ spaceKey, spacePermissionRequest, }: {
|
|
44
|
+
addPermissionToSpace: ({ spaceKey, spacePermissionRequest, }: {
|
|
45
45
|
/** The key of the space to be queried for its content. */
|
|
46
46
|
spaceKey: string;
|
|
47
47
|
/** The permission to be created. */
|
|
48
48
|
spacePermissionRequest: SpacePermissionRequest;
|
|
49
|
-
})
|
|
49
|
+
}) => Promise<SpacePermissionV2>;
|
|
50
50
|
/**
|
|
51
51
|
* Removes a space permission. Note that removing Read Space permission for a user
|
|
52
52
|
* or group will remove all
|
|
@@ -62,11 +62,11 @@ export declare class SpacePermissionsService extends CommonHttpService {
|
|
|
62
62
|
* @scopes-current write:space.permission:confluence
|
|
63
63
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions#api-wiki-rest-api-space-spacekey-permission-id-delete
|
|
64
64
|
*/
|
|
65
|
-
removePermission({ spaceKey, id, }: {
|
|
65
|
+
removePermission: ({ spaceKey, id, }: {
|
|
66
66
|
/** The key of the space to be queried for its content. */
|
|
67
67
|
spaceKey: string;
|
|
68
68
|
/** Id of the permission to be deleted. */
|
|
69
69
|
id: number;
|
|
70
|
-
})
|
|
70
|
+
}) => Promise<void>;
|
|
71
71
|
static initialize(): void;
|
|
72
72
|
}
|