@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,208 +11,211 @@ const audit_1 = require("../models/audit");
|
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
12
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit */
|
|
13
13
|
class AuditService 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
|
-
|
|
215
|
-
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
/**
|
|
17
|
+
* Creates a record in the audit log.
|
|
18
|
+
*
|
|
19
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
20
|
+
* 'Confluence Administrator' global permission.
|
|
21
|
+
*
|
|
22
|
+
* @returns Returned if the record is created in the audit log.
|
|
23
|
+
* @path {POST} /wiki/rest/api/audit
|
|
24
|
+
* @scopes-current read:audit-log:confluence, write:audit-log:confluence
|
|
25
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-post
|
|
26
|
+
*/
|
|
27
|
+
this.createAuditRecord = ({ auditRecordCreate, }) => {
|
|
28
|
+
return this.getClientInstance()
|
|
29
|
+
.request({
|
|
30
|
+
path: "/wiki/rest/api/audit",
|
|
31
|
+
method: "POST",
|
|
32
|
+
headers: {
|
|
33
|
+
"Content-Type": "application/json",
|
|
34
|
+
},
|
|
35
|
+
body: auditRecordCreate,
|
|
36
|
+
})
|
|
37
|
+
.then(this.getClientInstance().responseHandler({
|
|
38
|
+
200: {
|
|
39
|
+
"application/json": "json",
|
|
40
|
+
},
|
|
41
|
+
}))
|
|
42
|
+
.then(commonHttpClient.castResponse())
|
|
43
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.createAuditRecord.response"))
|
|
44
|
+
.then(commonHttpClient.getBody);
|
|
45
|
+
};
|
|
46
|
+
/**
|
|
47
|
+
* Exports audit records as a CSV file or ZIP file.
|
|
48
|
+
*
|
|
49
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
50
|
+
* 'Confluence Administrator' global permission.
|
|
51
|
+
*
|
|
52
|
+
* @returns * status: 200, mediaType: application/zip
|
|
53
|
+
*
|
|
54
|
+
* Returned if the requested export of the audit records is returned.
|
|
55
|
+
*
|
|
56
|
+
* * status: 200, mediaType: text/csv
|
|
57
|
+
*
|
|
58
|
+
* Returned if the requested export of the audit records is returned.
|
|
59
|
+
* @path {GET} /wiki/rest/api/audit/export
|
|
60
|
+
* @scopes-current read:audit-log:confluence
|
|
61
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-export-get
|
|
62
|
+
*/
|
|
63
|
+
this.exportAuditRecords = ({ startDate, endDate, searchString, format, } = {}) => {
|
|
64
|
+
return this.getClientInstance()
|
|
65
|
+
.request({
|
|
66
|
+
path: "/wiki/rest/api/audit/export",
|
|
67
|
+
method: "GET",
|
|
68
|
+
query: {
|
|
69
|
+
startDate,
|
|
70
|
+
endDate,
|
|
71
|
+
searchString,
|
|
72
|
+
format,
|
|
73
|
+
},
|
|
74
|
+
})
|
|
75
|
+
.then(this.getClientInstance().responseHandler({
|
|
76
|
+
200: {
|
|
77
|
+
"application/zip": "blob",
|
|
78
|
+
"text/csv": "blob",
|
|
79
|
+
},
|
|
80
|
+
}))
|
|
81
|
+
.then(commonHttpClient.castResponse())
|
|
82
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.exportAuditRecords.response"));
|
|
83
|
+
};
|
|
84
|
+
/**
|
|
85
|
+
* Returns all records in the audit log, optionally for a certain date range.
|
|
86
|
+
* This contains information about events like space exports, group membership
|
|
87
|
+
* changes, app installations, etc. For more information, see
|
|
88
|
+
* [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)
|
|
89
|
+
* in the Confluence administrator's guide.
|
|
90
|
+
*
|
|
91
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
92
|
+
* 'Confluence Administrator' global permission.
|
|
93
|
+
*
|
|
94
|
+
* @returns Returned if the requested records are returned.
|
|
95
|
+
* @path {GET} /wiki/rest/api/audit
|
|
96
|
+
* @scopes-current read:audit-log:confluence
|
|
97
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-get
|
|
98
|
+
*/
|
|
99
|
+
this.getAuditRecords = ({ startDate, endDate, searchString, start, limit, } = {}) => {
|
|
100
|
+
return this.getClientInstance()
|
|
101
|
+
.request({
|
|
102
|
+
path: "/wiki/rest/api/audit",
|
|
103
|
+
method: "GET",
|
|
104
|
+
query: {
|
|
105
|
+
startDate,
|
|
106
|
+
endDate,
|
|
107
|
+
searchString,
|
|
108
|
+
start,
|
|
109
|
+
limit,
|
|
110
|
+
},
|
|
111
|
+
})
|
|
112
|
+
.then(this.getClientInstance().responseHandler({
|
|
113
|
+
200: {
|
|
114
|
+
"application/json": "json",
|
|
115
|
+
},
|
|
116
|
+
}))
|
|
117
|
+
.then(commonHttpClient.castResponse())
|
|
118
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.getAuditRecords.response"))
|
|
119
|
+
.then(commonHttpClient.getBody);
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* Returns records from the audit log, for a time period back from the current
|
|
123
|
+
* date. For example, you can use this method to get the last 3 months of records.
|
|
124
|
+
*
|
|
125
|
+
* This contains information about events like space exports, group membership
|
|
126
|
+
* changes, app installations, etc. For more information, see
|
|
127
|
+
* [Audit log](https://confluence.atlassian.com/confcloud/audit-log-802164269.html)
|
|
128
|
+
* in the Confluence administrator's guide.
|
|
129
|
+
*
|
|
130
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
131
|
+
* 'Confluence Administrator' global permission.
|
|
132
|
+
*
|
|
133
|
+
* @returns Returned if the requested records are returned.
|
|
134
|
+
* @path {GET} /wiki/rest/api/audit/since
|
|
135
|
+
* @scopes-current read:audit-log:confluence
|
|
136
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-since-get
|
|
137
|
+
*/
|
|
138
|
+
this.getAuditRecordsForTimePeriod = ({ number, units, searchString, start, limit, } = {}) => {
|
|
139
|
+
return this.getClientInstance()
|
|
140
|
+
.request({
|
|
141
|
+
path: "/wiki/rest/api/audit/since",
|
|
142
|
+
method: "GET",
|
|
143
|
+
query: {
|
|
144
|
+
number,
|
|
145
|
+
units,
|
|
146
|
+
searchString,
|
|
147
|
+
start,
|
|
148
|
+
limit,
|
|
149
|
+
},
|
|
150
|
+
})
|
|
151
|
+
.then(this.getClientInstance().responseHandler({
|
|
152
|
+
200: {
|
|
153
|
+
"application/json": "json",
|
|
154
|
+
},
|
|
155
|
+
}))
|
|
156
|
+
.then(commonHttpClient.castResponse())
|
|
157
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.getAuditRecordsForTimePeriod.response"))
|
|
158
|
+
.then(commonHttpClient.getBody);
|
|
159
|
+
};
|
|
160
|
+
/**
|
|
161
|
+
* Returns the retention period for records in the audit log. The retention
|
|
162
|
+
* period is how long an audit record is kept for, from creation date until
|
|
163
|
+
* it is deleted.
|
|
164
|
+
*
|
|
165
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
166
|
+
* 'Confluence Administrator' global permission.
|
|
167
|
+
*
|
|
168
|
+
* @returns Returned if the requested retention period is returned.
|
|
169
|
+
* @path {GET} /wiki/rest/api/audit/retention
|
|
170
|
+
* @scopes-current read:audit-log:confluence
|
|
171
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-get
|
|
172
|
+
*/
|
|
173
|
+
this.getRetentionPeriod = () => {
|
|
174
|
+
return this.getClientInstance()
|
|
175
|
+
.request({
|
|
176
|
+
path: "/wiki/rest/api/audit/retention",
|
|
177
|
+
method: "GET",
|
|
178
|
+
})
|
|
179
|
+
.then(this.getClientInstance().responseHandler({
|
|
180
|
+
200: {
|
|
181
|
+
"application/json": "json",
|
|
182
|
+
},
|
|
183
|
+
}))
|
|
184
|
+
.then(commonHttpClient.castResponse())
|
|
185
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.getRetentionPeriod.response"))
|
|
186
|
+
.then(commonHttpClient.getBody);
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Sets the retention period for records in the audit log. The retention period
|
|
190
|
+
* can be set to a maximum of 1 year.
|
|
191
|
+
*
|
|
192
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
193
|
+
* 'Confluence Administrator' global permission.
|
|
194
|
+
*
|
|
195
|
+
* @returns Returned if the retention period is updated.
|
|
196
|
+
* @path {PUT} /wiki/rest/api/audit/retention
|
|
197
|
+
* @scopes-current write:audit-log:confluence
|
|
198
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-put
|
|
199
|
+
*/
|
|
200
|
+
this.setRetentionPeriod = ({ retentionPeriod, }) => {
|
|
201
|
+
return this.getClientInstance()
|
|
202
|
+
.request({
|
|
203
|
+
path: "/wiki/rest/api/audit/retention",
|
|
204
|
+
method: "PUT",
|
|
205
|
+
headers: {
|
|
206
|
+
"Content-Type": "application/json",
|
|
207
|
+
},
|
|
208
|
+
body: retentionPeriod,
|
|
209
|
+
})
|
|
210
|
+
.then(this.getClientInstance().responseHandler({
|
|
211
|
+
200: {
|
|
212
|
+
"application/json": "json",
|
|
213
|
+
},
|
|
214
|
+
}))
|
|
215
|
+
.then(commonHttpClient.castResponse())
|
|
216
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AuditService.setRetentionPeriod.response"))
|
|
217
|
+
.then(commonHttpClient.getBody);
|
|
218
|
+
};
|
|
216
219
|
}
|
|
217
220
|
static initialize() {
|
|
218
221
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AuditService.getAuditRecords.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AuditService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AuditService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,2CAMyB;AACzB,wEAAqE;AACrE,oFAAoF;AACpF,MAAa,YAAa,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"AuditService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AuditService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,2CAMyB;AACzB,wEAAqE;AACrE,oFAAoF;AACpF,MAAa,YAAa,SAAQ,qCAAiB;IAAnD;;QACE;;;;;;;;;;WAUG;QACH,sBAAiB,GAAG,CAAC,EACnB,iBAAiB,GAIlB,EAAwB,EAAE;YACzB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,sBAAsB;gBAC5B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,iBAAiB;aACxB,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,yCAAyC,CAC1C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,uBAAkB,GAAG,CAAC,EACpB,SAAS,EACT,OAAO,EACP,YAAY,EACZ,MAAM,MAqBJ,EAAE,EAMJ,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,YAAY;oBACZ,MAAM;iBACP;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,iBAAiB,EAAE,MAAM;oBACzB,UAAU,EAAE,MAAM;iBACnB;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,0CAA0C,CAC3C,CACF,CAAC;QACN,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,oBAAe,GAAG,CAAC,EACjB,SAAS,EACT,OAAO,EACP,YAAY,EACZ,KAAK,EACL,KAAK,MA0BH,EAAE,EAA6B,EAAE;YACnC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,sBAAsB;gBAC5B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,SAAS;oBACT,OAAO;oBACP,YAAY;oBACZ,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,CAC/B,uCAAuC,CACxC,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,iCAA4B,GAAG,CAAC,EAC9B,MAAM,EACN,KAAK,EACL,YAAY,EACZ,KAAK,EACL,KAAK,MA+BH,EAAE,EAA6B,EAAE;YACnC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4BAA4B;gBAClC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;oBACL,YAAY;oBACZ,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,CAC/B,oDAAoD,CACrD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,uBAAkB,GAAG,GAA6B,EAAE;YAClD,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gCAAgC;gBACtC,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,0CAA0C,CAC3C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,uBAAkB,GAAG,CAAC,EACpB,eAAe,GAIhB,EAA4B,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,gCAAgC;gBACtC,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,eAAe;aACtB,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,0CAA0C,CAC3C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA2EJ,CAAC;IA1EC,MAAM,CAAC,UAAU;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,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,uCAAuC,CAAC,CACrD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,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,aAAa,CAAC;SAClD,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE;YAClB,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE;YACrB,IAAI,EAAE,OAAC,CAAC,OAAO,EAAE;SAClB,CAAC;aACD,WAAW,CAAC,CAAC,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,GAAG,EAAE,EAAE;YAC7C,IAAI,SAAS,KAAK,iBAAiB,IAAI,SAAS,KAAK,UAAU,EAAE,CAAC;gBAChE,OAAO;YACT,CAAC;iBAAM,CAAC;gBACN,GAAG,CAAC,QAAQ,CAAC;oBACX,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,MAAM;oBAC3B,IAAI,EAAE,CAAC,WAAW,CAAC;oBACnB,OAAO,EAAE,0BAA0B,SAAS,EAAE;iBAC/C,CAAC,CAAC;YACL,CAAC;QACH,CAAC,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,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,iBAAiB,CAAC;SACtD,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,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,kBAAkB,CAAC;SACvD,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,sCAA8B,CAAC,CAAC,CAAC;IACzE,CAAC;CACF;AA1cD,oCA0cC"}
|
|
@@ -48,13 +48,13 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
48
48
|
* @scopes-beta read:content-details:confluence, write:attachment:confluence
|
|
49
49
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments#api-wiki-rest-api-content-id-child-attachment-post
|
|
50
50
|
*/
|
|
51
|
-
createAttachment({ id, status, requestBody, }: {
|
|
51
|
+
createAttachment: ({ id, status, requestBody, }: {
|
|
52
52
|
/** The ID of the content to add the attachment to. */
|
|
53
53
|
id: string;
|
|
54
54
|
/** The status of the content that the attachment is being added to. */
|
|
55
|
-
status?: "current" | "draft";
|
|
55
|
+
status?: "current" | "draft" | undefined;
|
|
56
56
|
requestBody: unknown;
|
|
57
|
-
})
|
|
57
|
+
}) => Promise<ContentArray>;
|
|
58
58
|
/**
|
|
59
59
|
* Adds an attachment to a piece of content. If the attachment already exists
|
|
60
60
|
* for the content, then the attachment is updated (i.e. a new version of the
|
|
@@ -101,16 +101,16 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
101
101
|
* @scopes-beta read:content-details:confluence, write:attachment:confluence
|
|
102
102
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments#api-wiki-rest-api-content-id-child-attachment-put
|
|
103
103
|
*/
|
|
104
|
-
createOrUpdateAttachments({ id, status, requestBody, }: {
|
|
104
|
+
createOrUpdateAttachments: ({ id, status, requestBody, }: {
|
|
105
105
|
/** The ID of the content to add the attachment to. */
|
|
106
106
|
id: string;
|
|
107
107
|
/**
|
|
108
108
|
* The status of the content that the attachment is being added to.
|
|
109
109
|
* This should always be set to 'current'.
|
|
110
110
|
*/
|
|
111
|
-
status?: "current" | "draft";
|
|
111
|
+
status?: "current" | "draft" | undefined;
|
|
112
112
|
requestBody: unknown;
|
|
113
|
-
})
|
|
113
|
+
}) => Promise<ContentArray>;
|
|
114
114
|
/**
|
|
115
115
|
* Redirects the client to a URL that serves an attachment's binary data.
|
|
116
116
|
*
|
|
@@ -119,7 +119,7 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
119
119
|
* @scopes-beta read:attachment:confluence
|
|
120
120
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments#api-wiki-rest-api-content-id-child-attachment-attachmentid-download-get
|
|
121
121
|
*/
|
|
122
|
-
downloadAttatchment({ id, attachmentId, version, }: {
|
|
122
|
+
downloadAttatchment: ({ id, attachmentId, version, }: {
|
|
123
123
|
/** The ID of the content that the attachment is attached to. */
|
|
124
124
|
id: string;
|
|
125
125
|
/** The ID of the attachment to download. */
|
|
@@ -128,8 +128,8 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
128
128
|
* The version of the attachment. If this parameter is absent, the redirect URI
|
|
129
129
|
* will download the latest version of the attachment.
|
|
130
130
|
*/
|
|
131
|
-
version?: number;
|
|
132
|
-
})
|
|
131
|
+
version?: number | undefined;
|
|
132
|
+
}) => Promise<void>;
|
|
133
133
|
/**
|
|
134
134
|
* Deprecated, use [Confluence's v2
|
|
135
135
|
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
@@ -149,7 +149,7 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
149
149
|
* @scopes-beta read:content-details:confluence
|
|
150
150
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments#api-wiki-rest-api-content-id-child-attachment-get
|
|
151
151
|
*/
|
|
152
|
-
getAttachments({ id, expand, start, limit, filename, mediaType, }: {
|
|
152
|
+
getAttachments: ({ id, expand, start, limit, filename, mediaType, }: {
|
|
153
153
|
/** The ID of the content to be queried for its attachments. */
|
|
154
154
|
id: string;
|
|
155
155
|
/**
|
|
@@ -246,19 +246,19 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
246
246
|
* - `extensions.inlineProperties` returns inline comment-specific properties.
|
|
247
247
|
* - `extensions.resolution` returns the resolution status of each comment.
|
|
248
248
|
*/
|
|
249
|
-
expand?: string[];
|
|
249
|
+
expand?: string[] | undefined;
|
|
250
250
|
/** The starting index of the returned attachments. */
|
|
251
|
-
start?: number;
|
|
251
|
+
start?: number | undefined;
|
|
252
252
|
/**
|
|
253
253
|
* The maximum number of attachments to return per page.
|
|
254
254
|
* Note, this may be restricted by fixed system limits.
|
|
255
255
|
*/
|
|
256
|
-
limit?: number;
|
|
256
|
+
limit?: number | undefined;
|
|
257
257
|
/** Filter the results to attachments that match the filename. */
|
|
258
|
-
filename?: string;
|
|
258
|
+
filename?: string | undefined;
|
|
259
259
|
/** Filter the results to attachments that match the media type. */
|
|
260
|
-
mediaType?: string;
|
|
261
|
-
})
|
|
260
|
+
mediaType?: string | undefined;
|
|
261
|
+
}) => Promise<ContentArray>;
|
|
262
262
|
/**
|
|
263
263
|
* Updates the binary data of an attachment, given the attachment ID, and
|
|
264
264
|
* optionally the comment and the minor edit field.
|
|
@@ -307,13 +307,13 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
307
307
|
* @scopes-beta read:content-details:confluence, write:attachment:confluence
|
|
308
308
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments#api-wiki-rest-api-content-id-child-attachment-attachmentid-data-post
|
|
309
309
|
*/
|
|
310
|
-
updateAttachmentData({ id, attachmentId, requestBody, }: {
|
|
310
|
+
updateAttachmentData: ({ id, attachmentId, requestBody, }: {
|
|
311
311
|
/** The ID of the content that the attachment is attached to. */
|
|
312
312
|
id: string;
|
|
313
313
|
/** The ID of the attachment to update. */
|
|
314
314
|
attachmentId: string;
|
|
315
315
|
requestBody: unknown;
|
|
316
|
-
})
|
|
316
|
+
}) => Promise<Content | null>;
|
|
317
317
|
/**
|
|
318
318
|
* Updates the attachment properties, i.e. the non-binary data of an attachment
|
|
319
319
|
* like the filename, media-type, comment, and parent container.
|
|
@@ -327,13 +327,13 @@ export declare class ContentAttachmentsService extends CommonHttpService {
|
|
|
327
327
|
* @scopes-beta read:content-details:confluence, write:attachment:confluence
|
|
328
328
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments#api-wiki-rest-api-content-id-child-attachment-attachmentid-put
|
|
329
329
|
*/
|
|
330
|
-
updateAttachmentProperties({ id, attachmentId, attachmentPropertiesUpdateBody, }: {
|
|
330
|
+
updateAttachmentProperties: ({ id, attachmentId, attachmentPropertiesUpdateBody, }: {
|
|
331
331
|
/** The ID of the content that the attachment is attached to. */
|
|
332
332
|
id: string;
|
|
333
333
|
/** The ID of the attachment to update. */
|
|
334
334
|
attachmentId: string;
|
|
335
335
|
/** The details of the attachment to be updated. */
|
|
336
336
|
attachmentPropertiesUpdateBody: AttachmentPropertiesUpdateBody;
|
|
337
|
-
})
|
|
337
|
+
}) => Promise<Content | null>;
|
|
338
338
|
static initialize(): void;
|
|
339
339
|
}
|