@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
|
@@ -12,182 +12,185 @@ const themes_1 = require("../models/themes");
|
|
|
12
12
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
13
13
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes */
|
|
14
14
|
class ThemesService extends CommonHttpService_1.CommonHttpService {
|
|
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
|
-
|
|
15
|
+
constructor() {
|
|
16
|
+
super(...arguments);
|
|
17
|
+
/**
|
|
18
|
+
* Returns the globally assigned theme.
|
|
19
|
+
*
|
|
20
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
|
|
21
|
+
*
|
|
22
|
+
* @returns Returned if the global theme is returned.
|
|
23
|
+
* @path {GET} /wiki/rest/api/settings/theme/selected
|
|
24
|
+
* @scopes-current manage:confluence-configuration
|
|
25
|
+
* @scopes-beta read:configuration:confluence
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-settings-theme-selected-get
|
|
27
|
+
*/
|
|
28
|
+
this.getGlobalTheme = () => {
|
|
29
|
+
return this.getClientInstance()
|
|
30
|
+
.request({
|
|
31
|
+
path: "/wiki/rest/api/settings/theme/selected",
|
|
32
|
+
method: "GET",
|
|
33
|
+
})
|
|
34
|
+
.then(this.getClientInstance().responseHandler({
|
|
35
|
+
200: {
|
|
36
|
+
"application/json": "json",
|
|
37
|
+
},
|
|
38
|
+
}))
|
|
39
|
+
.then(commonHttpClient.castResponse())
|
|
40
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getGlobalTheme.response"))
|
|
41
|
+
.then(commonHttpClient.getBody);
|
|
42
|
+
};
|
|
43
|
+
/**
|
|
44
|
+
* Returns the theme selected for a space, if one is set. If no space
|
|
45
|
+
* theme is set, this means that the space is inheriting the global look
|
|
46
|
+
* and feel settings.
|
|
47
|
+
*
|
|
48
|
+
* **[Permissions required](https://confluence.atlassian.com/x/_AozKw)**: ‘View’
|
|
49
|
+
* permission for the space.
|
|
50
|
+
*
|
|
51
|
+
* @returns Returned if the requested theme is returned.
|
|
52
|
+
* @path {GET} /wiki/rest/api/space/{spaceKey}/theme
|
|
53
|
+
* @scopes-current read:confluence-space.summary
|
|
54
|
+
* @scopes-beta read:space.setting:confluence
|
|
55
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-space-spacekey-theme-get
|
|
56
|
+
*/
|
|
57
|
+
this.getSpaceTheme = ({ spaceKey, }) => {
|
|
58
|
+
return this.getClientInstance()
|
|
59
|
+
.request({
|
|
60
|
+
path: "/wiki/rest/api/space/{spaceKey}/theme",
|
|
61
|
+
method: "GET",
|
|
62
|
+
pathParams: {
|
|
63
|
+
spaceKey,
|
|
64
|
+
},
|
|
65
|
+
})
|
|
66
|
+
.then(this.getClientInstance().responseHandler({
|
|
67
|
+
200: {
|
|
68
|
+
"application/json": "json",
|
|
69
|
+
},
|
|
70
|
+
}))
|
|
71
|
+
.then(commonHttpClient.castResponse())
|
|
72
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getSpaceTheme.response"))
|
|
73
|
+
.then(commonHttpClient.getBody);
|
|
74
|
+
};
|
|
75
|
+
/**
|
|
76
|
+
* Returns a theme. This includes information about the theme name,
|
|
77
|
+
* description, and icon.
|
|
78
|
+
*
|
|
79
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
|
|
80
|
+
*
|
|
81
|
+
* @returns Returned if the requested theme is returned.
|
|
82
|
+
* @path {GET} /wiki/rest/api/settings/theme/{themeKey}
|
|
83
|
+
* @scopes-current manage:confluence-configuration
|
|
84
|
+
* @scopes-beta read:configuration:confluence
|
|
85
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-settings-theme-themekey-get
|
|
86
|
+
*/
|
|
87
|
+
this.getTheme = ({ themeKey, }) => {
|
|
88
|
+
return this.getClientInstance()
|
|
89
|
+
.request({
|
|
90
|
+
path: "/wiki/rest/api/settings/theme/{themeKey}",
|
|
91
|
+
method: "GET",
|
|
92
|
+
pathParams: {
|
|
93
|
+
themeKey,
|
|
94
|
+
},
|
|
95
|
+
})
|
|
96
|
+
.then(this.getClientInstance().responseHandler({
|
|
97
|
+
200: {
|
|
98
|
+
"application/json": "json",
|
|
99
|
+
},
|
|
100
|
+
}))
|
|
101
|
+
.then(commonHttpClient.castResponse())
|
|
102
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getTheme.response"))
|
|
103
|
+
.then(commonHttpClient.getBody);
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
* Returns all themes, not including the default theme.
|
|
107
|
+
*
|
|
108
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: None
|
|
109
|
+
*
|
|
110
|
+
* @returns Returned if the requested themes are returned.
|
|
111
|
+
* @path {GET} /wiki/rest/api/settings/theme
|
|
112
|
+
* @scopes-current manage:confluence-configuration
|
|
113
|
+
* @scopes-beta read:configuration:confluence
|
|
114
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-settings-theme-get
|
|
115
|
+
*/
|
|
116
|
+
this.getThemes = ({ start, limit, } = {}) => {
|
|
117
|
+
return this.getClientInstance()
|
|
118
|
+
.request({
|
|
119
|
+
path: "/wiki/rest/api/settings/theme",
|
|
120
|
+
method: "GET",
|
|
121
|
+
query: {
|
|
122
|
+
start,
|
|
123
|
+
limit,
|
|
124
|
+
},
|
|
125
|
+
})
|
|
126
|
+
.then(this.getClientInstance().responseHandler({
|
|
127
|
+
200: {
|
|
128
|
+
"application/json": "json",
|
|
129
|
+
},
|
|
130
|
+
}))
|
|
131
|
+
.then(commonHttpClient.castResponse())
|
|
132
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.getThemes.response"))
|
|
133
|
+
.then(commonHttpClient.getBody);
|
|
134
|
+
};
|
|
135
|
+
/**
|
|
136
|
+
* Resets the space theme. This means that the space will inherit the
|
|
137
|
+
* global look and feel settings
|
|
138
|
+
*
|
|
139
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
140
|
+
* 'Admin' permission for the space.
|
|
141
|
+
*
|
|
142
|
+
* @path {DELETE} /wiki/rest/api/space/{spaceKey}/theme
|
|
143
|
+
* @scopes-current write:confluence-space
|
|
144
|
+
* @scopes-beta write:space.setting:confluence
|
|
145
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-space-spacekey-theme-delete
|
|
146
|
+
*/
|
|
147
|
+
this.resetSpaceTheme = ({ spaceKey, }) => {
|
|
148
|
+
return this.getClientInstance()
|
|
149
|
+
.request({
|
|
150
|
+
path: "/wiki/rest/api/space/{spaceKey}/theme",
|
|
151
|
+
method: "DELETE",
|
|
152
|
+
pathParams: {
|
|
153
|
+
spaceKey,
|
|
154
|
+
},
|
|
155
|
+
})
|
|
156
|
+
.then(commonHttpClient.discardResult);
|
|
157
|
+
};
|
|
158
|
+
/**
|
|
159
|
+
* Sets the theme for a space. Note, if you want to reset the space theme to
|
|
160
|
+
* the default Confluence theme, use the 'Reset space theme' method instead
|
|
161
|
+
* of this method.
|
|
162
|
+
*
|
|
163
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
164
|
+
* 'Admin' permission for the space.
|
|
165
|
+
*
|
|
166
|
+
* @returns Returned if the theme was set for the space.
|
|
167
|
+
* @path {PUT} /wiki/rest/api/space/{spaceKey}/theme
|
|
168
|
+
* @scopes-current write:confluence-space
|
|
169
|
+
* @scopes-beta read:space.setting:confluence, write:space.setting:confluence
|
|
170
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes#api-wiki-rest-api-space-spacekey-theme-put
|
|
171
|
+
*/
|
|
172
|
+
this.setSpaceTheme = ({ spaceKey, themeUpdate, }) => {
|
|
173
|
+
return this.getClientInstance()
|
|
174
|
+
.request({
|
|
175
|
+
path: "/wiki/rest/api/space/{spaceKey}/theme",
|
|
176
|
+
method: "PUT",
|
|
177
|
+
pathParams: {
|
|
178
|
+
spaceKey,
|
|
179
|
+
},
|
|
180
|
+
headers: {
|
|
181
|
+
"Content-Type": "application/json",
|
|
182
|
+
},
|
|
183
|
+
body: themeUpdate,
|
|
184
|
+
})
|
|
185
|
+
.then(this.getClientInstance().responseHandler({
|
|
186
|
+
200: {
|
|
187
|
+
"application/json": "json",
|
|
188
|
+
},
|
|
189
|
+
}))
|
|
190
|
+
.then(commonHttpClient.castResponse())
|
|
191
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("ThemesService.setSpaceTheme.response"))
|
|
192
|
+
.then(commonHttpClient.getBody);
|
|
193
|
+
};
|
|
191
194
|
}
|
|
192
195
|
static initialize() {
|
|
193
196
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ThemesService.getThemes.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ThemesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ThemesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAA+E;AAC/E,6CAI0B;AAC1B,wEAAqE;AACrE,qFAAqF;AACrF,MAAa,aAAc,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"ThemesService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ThemesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAA+E;AAC/E,6CAI0B;AAC1B,wEAAqE;AACrE,qFAAqF;AACrF,MAAa,aAAc,SAAQ,qCAAiB;IAApD;;QACE;;;;;;;;;;WAUG;QACH,mBAAc,GAAG,GAAmB,EAAE;YACpC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,wCAAwC;gBAC9C,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,uCAAuC,CACxC,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,kBAAa,GAAG,CAAC,EACf,QAAQ,GAIT,EAAkB,EAAE;YACnB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uCAAuC;gBAC7C,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,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,sCAAsC,CACvC,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,aAAQ,GAAG,CAAC,EACV,QAAQ,GAIT,EAAkB,EAAE;YACnB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,0CAA0C;gBAChD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,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,CAAC,iCAAiC,CAAC,CACrE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;WAUG;QACH,cAAS,GAAG,CAAC,EACX,KAAK,EACL,KAAK,MASH,EAAE,EAAuB,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,KAAK;oBACL,KAAK;iBACN;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,CAAC,kCAAkC,CAAC,CACtE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,oBAAe,GAAG,CAAC,EACjB,QAAQ,GAIT,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uCAAuC;gBAC7C,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,kBAAa,GAAG,CAAC,EACf,QAAQ,EACR,WAAW,GAKZ,EAAkB,EAAE;YACnB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uCAAuC;gBAC7C,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,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,sCAAsC,CACvC,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAyDJ,CAAC;IAxDC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,kCAAkC,EAClC,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,YAAY,CAAC;SACjD,CAAC;aACD,QAAQ,CAAC,kCAAkC,CAAC,CAChD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iCAAiC,EACjC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,iCAAiC,CAAC,CAC/C,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,uCAAuC,EACvC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sCAAsC,EACtC,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,OAAO,CAAC;SAC5C,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,wCAA+B;YAC/B,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AAnUD,sCAmUC"}
|
|
@@ -19,7 +19,7 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
19
19
|
* @scopes-current write:user.property:confluence
|
|
20
20
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-post
|
|
21
21
|
*/
|
|
22
|
-
createUserProperty({ userId, key, userPropertyCreate, }: {
|
|
22
|
+
createUserProperty: ({ userId, key, userPropertyCreate, }: {
|
|
23
23
|
/**
|
|
24
24
|
* The account ID of the user. The accountId uniquely identifies the user across
|
|
25
25
|
* all Atlassian
|
|
@@ -30,7 +30,7 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
30
30
|
key: string;
|
|
31
31
|
/** The user property to be created. */
|
|
32
32
|
userPropertyCreate: UserPropertyCreate;
|
|
33
|
-
})
|
|
33
|
+
}) => Promise<void>;
|
|
34
34
|
/**
|
|
35
35
|
* Deletes a property for the given user.
|
|
36
36
|
* For more information about user properties, see
|
|
@@ -46,7 +46,7 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
46
46
|
* @scopes-current write:user.property:confluence
|
|
47
47
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-delete
|
|
48
48
|
*/
|
|
49
|
-
deleteUserProperty({ userId, key, }: {
|
|
49
|
+
deleteUserProperty: ({ userId, key, }: {
|
|
50
50
|
/**
|
|
51
51
|
* The account ID of the user. The accountId uniquely identifies the user across
|
|
52
52
|
* all Atlassian
|
|
@@ -55,7 +55,7 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
55
55
|
userId: string;
|
|
56
56
|
/** The key of the user property. */
|
|
57
57
|
key: string;
|
|
58
|
-
})
|
|
58
|
+
}) => Promise<void>;
|
|
59
59
|
/**
|
|
60
60
|
* Returns the properties for a user as list of property keys. For more information
|
|
61
61
|
* about user properties, see [Confluence entity
|
|
@@ -71,17 +71,17 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
71
71
|
* @scopes-current read:user.property:confluence
|
|
72
72
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-get
|
|
73
73
|
*/
|
|
74
|
-
getUserProperties({ userId, start, limit, }: {
|
|
74
|
+
getUserProperties: ({ userId, start, limit, }: {
|
|
75
75
|
/** The account ID of the user to be queried for its properties. */
|
|
76
76
|
userId: string;
|
|
77
77
|
/** The starting index of the returned properties. */
|
|
78
|
-
start?: number;
|
|
78
|
+
start?: number | undefined;
|
|
79
79
|
/**
|
|
80
80
|
* The maximum number of properties to return per page.
|
|
81
81
|
* Note, this may be restricted by fixed system limits.
|
|
82
82
|
*/
|
|
83
|
-
limit?: number;
|
|
84
|
-
})
|
|
83
|
+
limit?: number | undefined;
|
|
84
|
+
}) => Promise<UserPropertyKeyArray>;
|
|
85
85
|
/**
|
|
86
86
|
* Returns the property corresponding to `key` for a user. For more information
|
|
87
87
|
* about user properties, see [Confluence entity
|
|
@@ -97,12 +97,12 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
97
97
|
* @scopes-current read:user.property:confluence
|
|
98
98
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-get
|
|
99
99
|
*/
|
|
100
|
-
getUserProperty({ userId, key, }: {
|
|
100
|
+
getUserProperty: ({ userId, key, }: {
|
|
101
101
|
/** The account ID of the user to be queried for its properties. */
|
|
102
102
|
userId: string;
|
|
103
103
|
/** The key of the user property. */
|
|
104
104
|
key: string;
|
|
105
|
-
})
|
|
105
|
+
}) => Promise<UserProperty>;
|
|
106
106
|
/**
|
|
107
107
|
* Updates a property for the given user. Note, you cannot update the key of a
|
|
108
108
|
* user property, only the value.
|
|
@@ -119,7 +119,7 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
119
119
|
* @scopes-current write:user.property:confluence
|
|
120
120
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties#api-wiki-rest-api-user-userid-property-key-put
|
|
121
121
|
*/
|
|
122
|
-
updateUserProperty({ userId, key, userPropertyUpdate, }: {
|
|
122
|
+
updateUserProperty: ({ userId, key, userPropertyUpdate, }: {
|
|
123
123
|
/**
|
|
124
124
|
* The account ID of the user. The accountId uniquely identifies the user across
|
|
125
125
|
* all Atlassian
|
|
@@ -130,6 +130,6 @@ export declare class UserPropertiesService extends CommonHttpService {
|
|
|
130
130
|
key: string;
|
|
131
131
|
/** The user property to be updated. */
|
|
132
132
|
userPropertyUpdate: UserPropertyUpdate;
|
|
133
|
-
})
|
|
133
|
+
}) => Promise<void>;
|
|
134
134
|
static initialize(): void;
|
|
135
135
|
}
|