@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
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,28 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [0.4.6](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.5...v0.4.6) (2024-06-14)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* use more optimized / lightweight api client version ([8c628d3](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/8c628d3c80ca6c89572eb003ae6f7cb5c634b4d5))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
## [0.4.5](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.4...v0.4.5) (2024-06-14)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
### Bug Fixes
|
|
21
|
+
|
|
22
|
+
* missing packages changes ([2c1f946](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/2c1f946e7c96f955fa88464f0c673081209616c6))
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
|
|
6
28
|
## [0.4.4](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.3...v0.4.4) (2024-06-11)
|
|
7
29
|
|
|
8
30
|
|
package/README.md
CHANGED
|
@@ -57,7 +57,11 @@ const ace = atlassianConnectExpress(app);
|
|
|
57
57
|
app.use(ace.authenticate());
|
|
58
58
|
|
|
59
59
|
app.get('/current-user', async () => {
|
|
60
|
-
const confluenceApiV1 = new ConfluenceApiV1({
|
|
60
|
+
const confluenceApiV1 = new ConfluenceApiV1({
|
|
61
|
+
ace,
|
|
62
|
+
clientKey: req.context.clientKey,
|
|
63
|
+
userAccountId: req.context.userAccountId
|
|
64
|
+
});
|
|
61
65
|
const currentUser = await confluenceApiV1.users.getCurrentUser();
|
|
62
66
|
res.status(200).send(currentUser);
|
|
63
67
|
});
|
|
@@ -128,6 +132,61 @@ export const handler = async ({ payload }) => {
|
|
|
128
132
|
}
|
|
129
133
|
```
|
|
130
134
|
|
|
135
|
+
### Impersonalization
|
|
136
|
+
|
|
137
|
+
When using API on the server side, you can impersonalize the API client.
|
|
138
|
+
This is useful when you need to access API resources on behalf of a different user or app.
|
|
139
|
+
|
|
140
|
+
### `atlassian-connect-express`
|
|
141
|
+
|
|
142
|
+
By default, `atlassian-connect-express` makes requests on behalf of the app.
|
|
143
|
+
To impersonalize the API client, you need to provide the `userAccountId` to the API client:
|
|
144
|
+
|
|
145
|
+
```typescript
|
|
146
|
+
// ...
|
|
147
|
+
app.get('/current-user', async () => {
|
|
148
|
+
const confluenceApiV1 = new ConfluenceApiV1({
|
|
149
|
+
ace,
|
|
150
|
+
clientKey: req.context.clientKey,
|
|
151
|
+
userAccountId: req.context.userAccountId
|
|
152
|
+
});
|
|
153
|
+
const currentUser = await confluenceApiV1.users.getCurrentUser();
|
|
154
|
+
res.status(200).send(currentUser);
|
|
155
|
+
});
|
|
156
|
+
// ...
|
|
157
|
+
```
|
|
158
|
+
|
|
159
|
+
This can also be achieved by calling `asUser` method on the API client:
|
|
160
|
+
|
|
161
|
+
```typescript
|
|
162
|
+
const confluenceApiV1 = new ConfluenceApiV1({
|
|
163
|
+
ace,
|
|
164
|
+
clientKey: req.context.clientKey
|
|
165
|
+
});
|
|
166
|
+
const currentUser = await confluenceApiV1.asUser(req.context.userAccountId).users.getCurrentUser();
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
### `@forge/api`
|
|
170
|
+
|
|
171
|
+
By default, `@forge/api` makes requests on behalf of the current user.
|
|
172
|
+
To perform requests on behalf of the app, you need to provide the `asApp` to the API client:
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
// ...
|
|
176
|
+
export const handler = async ({ payload }) => {
|
|
177
|
+
const confluenceApiV2 = new ConfluenceApiV2({ forgeApi, asApp: true });
|
|
178
|
+
const spaces = await confluenceApiV2.space.getSpaces({ keys: [payload.spaceKey] });
|
|
179
|
+
return spaces.results[0];
|
|
180
|
+
};
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
This can also be achieved by calling `asApp` method on the API client:
|
|
184
|
+
|
|
185
|
+
```typescript
|
|
186
|
+
const confluenceApiV2 = new ConfluenceApiV2({ forgeApi });
|
|
187
|
+
const spaces = await confluenceApiV2.asApp().space.getSpaces({ keys: ["SPACE"] });
|
|
188
|
+
```
|
|
189
|
+
|
|
131
190
|
## References
|
|
132
191
|
|
|
133
192
|
* [Confluence API V1](https://developer.atlassian.com/cloud/confluence/rest/v1/intro/)
|
|
@@ -85,49 +85,49 @@ export declare class BaseConfluenceApiV1Client extends CommonHttpService {
|
|
|
85
85
|
client: commonHttpClient.CommonHttpClient;
|
|
86
86
|
getClient: () => commonHttpClient.CommonHttpClient;
|
|
87
87
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics */
|
|
88
|
-
analytics: AnalyticsService;
|
|
88
|
+
get analytics(): AnalyticsService;
|
|
89
89
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit */
|
|
90
|
-
audit: AuditService;
|
|
90
|
+
get audit(): AuditService;
|
|
91
91
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments */
|
|
92
|
-
contentAttachments: ContentAttachmentsService;
|
|
92
|
+
get contentAttachments(): ContentAttachmentsService;
|
|
93
93
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body */
|
|
94
|
-
contentBody: ContentBodyService;
|
|
94
|
+
get contentBody(): ContentBodyService;
|
|
95
95
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants */
|
|
96
|
-
contentChildrenAndDescendants: ContentChildrenAndDescendantsService;
|
|
96
|
+
get contentChildrenAndDescendants(): ContentChildrenAndDescendantsService;
|
|
97
97
|
/**
|
|
98
98
|
* @deprecated
|
|
99
99
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments
|
|
100
100
|
*/
|
|
101
|
-
contentComments: ContentCommentsService;
|
|
101
|
+
get contentComments(): ContentCommentsService;
|
|
102
102
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels */
|
|
103
|
-
contentLabels: ContentLabelsService;
|
|
103
|
+
get contentLabels(): ContentLabelsService;
|
|
104
104
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-macro-body */
|
|
105
|
-
contentMacroBody: ContentMacroBodyService;
|
|
105
|
+
get contentMacroBody(): ContentMacroBodyService;
|
|
106
106
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-permissions */
|
|
107
|
-
contentPermissions: ContentPermissionsService;
|
|
107
|
+
get contentPermissions(): ContentPermissionsService;
|
|
108
108
|
/**
|
|
109
109
|
* @deprecated
|
|
110
110
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties
|
|
111
111
|
*/
|
|
112
|
-
contentProperties: ContentPropertiesService;
|
|
112
|
+
get contentProperties(): ContentPropertiesService;
|
|
113
113
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions */
|
|
114
|
-
contentRestrictions: ContentRestrictionsService;
|
|
114
|
+
get contentRestrictions(): ContentRestrictionsService;
|
|
115
115
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content */
|
|
116
|
-
content: ContentService;
|
|
116
|
+
get content(): ContentService;
|
|
117
117
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states */
|
|
118
|
-
contentStates: ContentStatesService;
|
|
118
|
+
get contentStates(): ContentStatesService;
|
|
119
119
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions */
|
|
120
|
-
contentVersions: ContentVersionsService;
|
|
120
|
+
get contentVersions(): ContentVersionsService;
|
|
121
121
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches */
|
|
122
|
-
contentWatches: ContentWatchesService;
|
|
122
|
+
get contentWatches(): ContentWatchesService;
|
|
123
123
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules */
|
|
124
|
-
dynamicModules: DynamicModulesService;
|
|
124
|
+
get dynamicModules(): DynamicModulesService;
|
|
125
125
|
/**
|
|
126
126
|
* APIs in this section can change without any prior deprecation notice.
|
|
127
127
|
*
|
|
128
128
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental
|
|
129
129
|
*/
|
|
130
|
-
experimental: ExperimentalService;
|
|
130
|
+
get experimental(): ExperimentalService;
|
|
131
131
|
/**
|
|
132
132
|
* **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
|
|
133
133
|
* The standard Atlassian group names are default names only and can be edited or
|
|
@@ -136,42 +136,41 @@ export declare class BaseConfluenceApiV1Client extends CommonHttpService {
|
|
|
136
136
|
*
|
|
137
137
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group
|
|
138
138
|
*/
|
|
139
|
-
group: GroupService;
|
|
139
|
+
get group(): GroupService;
|
|
140
140
|
/**
|
|
141
141
|
* @deprecated
|
|
142
142
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks
|
|
143
143
|
*/
|
|
144
|
-
inlineTasks: InlineTasksService;
|
|
144
|
+
get inlineTasks(): InlineTasksService;
|
|
145
145
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info */
|
|
146
|
-
labelInfo: LabelInfoService;
|
|
146
|
+
get labelInfo(): LabelInfoService;
|
|
147
147
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task */
|
|
148
|
-
longRunningTask: LongRunningTaskService;
|
|
148
|
+
get longRunningTask(): LongRunningTaskService;
|
|
149
149
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation */
|
|
150
|
-
relation: RelationService;
|
|
150
|
+
get relation(): RelationService;
|
|
151
151
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search */
|
|
152
|
-
search: SearchService;
|
|
152
|
+
get search(): SearchService;
|
|
153
153
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings */
|
|
154
|
-
settings: SettingsService;
|
|
154
|
+
get settings(): SettingsService;
|
|
155
155
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions */
|
|
156
|
-
spacePermissions: SpacePermissionsService;
|
|
156
|
+
get spacePermissions(): SpacePermissionsService;
|
|
157
157
|
/**
|
|
158
158
|
* @deprecated
|
|
159
159
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties
|
|
160
160
|
*/
|
|
161
|
-
spaceProperties: SpacePropertiesService;
|
|
161
|
+
get spaceProperties(): SpacePropertiesService;
|
|
162
162
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space */
|
|
163
|
-
space: SpaceService;
|
|
163
|
+
get space(): SpaceService;
|
|
164
164
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings */
|
|
165
|
-
spaceSettings: SpaceSettingsService;
|
|
165
|
+
get spaceSettings(): SpaceSettingsService;
|
|
166
166
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template */
|
|
167
|
-
template: TemplateService;
|
|
167
|
+
get template(): TemplateService;
|
|
168
168
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes */
|
|
169
|
-
themes: ThemesService;
|
|
169
|
+
get themes(): ThemesService;
|
|
170
170
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties */
|
|
171
|
-
userProperties: UserPropertiesService;
|
|
171
|
+
get userProperties(): UserPropertiesService;
|
|
172
172
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users */
|
|
173
|
-
users: UsersService;
|
|
173
|
+
get users(): UsersService;
|
|
174
174
|
constructor(options?: BaseConfluenceApiV1ClientOptions);
|
|
175
|
-
static createClientWithServices: typeof commonHttpClient.createClientWithServices;
|
|
176
175
|
}
|
|
177
176
|
export type { AccountId, GroupName, AccountIdEmailRecord, AccountIdEmailRecordArray, BulkUserLookup, BulkUserLookupArray, UserAnonymous, AffectedObject, AuditRecord, AuditRecordArray, AuditRecordCreate, ChangedValue, RetentionPeriod, AsyncContentBody, AsyncId, Container, Content, ContentArray, ContentBody, ContentBodyCreate, ContentChildren, ContentId, ContentRestriction, EmbeddedContent, GenericAccountId, GenericLinks, GenericUserKey, GenericUserName, Group, GroupArrayWithLinks, IconV1, LabelArray, LabelCreate, LabelV1, LongTask, LookAndFeel, Message, OperationCheckResult, Space, SpaceSettings, Theme, UserArray, UserDetails, UserV1, VersionV1, WebResourceDependencies, AttachmentPropertiesUpdateBody, AvailableContentStates, ContentState, ContentStateBulkSetTaskUpdate, ContentStateFailure, ContentStateResponse, ContentStateRestInput, ContentStateSettings, BlueprintTemplate, BlueprintTemplateArray, ContentTemplate, ContentTemplateArray, ContentTemplateBody, ContentTemplateBodyCreate, ContentTemplateCreate, ContentTemplateUpdate, Breadcrumb, ContainerSummary, SearchPageResponseSearchResult, SearchResult, ButtonLookAndFeel, ContainerLookAndFeel, ContentBlueprintDraft, ContentBodyCreateStorage, ContentChildType, ContentCreate, ContentHistory, ContentLookAndFeel, ContentMetadata, ContentUpdate, Embeddable, GlobalSpaceIdentifier, GroupArray, HeaderLookAndFeel, HorizontalHeaderLookAndFeel, MenusLookAndFeel, NavigationLookAndFeel, ScreenLookAndFeel, SearchFieldLookAndFeel, SpaceDescriptionV1, SpacePermissionV1, SuperBatchWebResources, TopNavigationLookAndFeel, UsersUserKeys, ConnectModule, ConnectModules, DynamicModulesErrorMessage, ContentPermissionRequest, PermissionCheckResponse, PermissionSubjectWithGroupId, ContentPropertyArray, ContentPropertyCreate, ContentPropertyCreateNoKey, ContentPropertyUpdate, ContentPropertyV1, ContentRestrictionAddOrUpdateArray, ContentRestrictionArray, ContentRestrictionUpdate, CopyPageHierarchyRequest, CopyPageHierarchyTitleOptions, CopyPageRequest, CopyPageRequestDestination, GroupCreate, SpaceArray, SpaceCreate, SpaceDescriptionCreate, SpacePermissionCreate, SpaceUpdate, LabelCreateArray, LabelDetails, LabeledContent, LabeledContentPageResponse, LabeledContentType, LongTaskStatus, LongTaskStatusArray, LongTaskStatusWithLinks, LookAndFeelSelection, LookAndFeelSettings, LookAndFeelWithLinks, SystemInfoEntity, MacroInstance, PermissionSubject, SpacePermissionCustomContent, SpacePermissionRequest, SpacePermissionV2, PropertyValue, SpacePropertyArray, SpacePropertyCreate, SpacePropertyCreateNoKey, SpacePropertyUpdate, SpacePropertyV1, Relation, RelationArray, RelationData, SpaceSettingsUpdate, SpaceWatch, SpaceWatchArray, UserWatch, Watch, WatchArray, WatchUser, TaskPageResponse, TaskStatusUpdate, TaskV1, ThemeArray, ThemeNoLinks, ThemeUpdate, UserProperty, UserPropertyCreate, UserPropertyKeyArray, UserPropertyUpdate, VersionArray, VersionRestore, };
|
|
@@ -62,6 +62,157 @@ exports.BaseConfluenceApiV1ClientError = BaseConfluenceApiV1ClientError;
|
|
|
62
62
|
* @version 1.0.0
|
|
63
63
|
*/
|
|
64
64
|
class BaseConfluenceApiV1Client extends CommonHttpService_1.CommonHttpService {
|
|
65
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics */
|
|
66
|
+
get analytics() {
|
|
67
|
+
return this.getServiceInstance(AnalyticsService_1.AnalyticsService);
|
|
68
|
+
}
|
|
69
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit */
|
|
70
|
+
get audit() {
|
|
71
|
+
return this.getServiceInstance(AuditService_1.AuditService);
|
|
72
|
+
}
|
|
73
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments */
|
|
74
|
+
get contentAttachments() {
|
|
75
|
+
return this.getServiceInstance(ContentAttachmentsService_1.ContentAttachmentsService);
|
|
76
|
+
}
|
|
77
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body */
|
|
78
|
+
get contentBody() {
|
|
79
|
+
return this.getServiceInstance(ContentBodyService_1.ContentBodyService);
|
|
80
|
+
}
|
|
81
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants */
|
|
82
|
+
get contentChildrenAndDescendants() {
|
|
83
|
+
return this.getServiceInstance(ContentChildrenAndDescendantsService_1.ContentChildrenAndDescendantsService);
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* @deprecated
|
|
87
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments
|
|
88
|
+
*/
|
|
89
|
+
get contentComments() {
|
|
90
|
+
return this.getServiceInstance(ContentCommentsService_1.ContentCommentsService);
|
|
91
|
+
}
|
|
92
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels */
|
|
93
|
+
get contentLabels() {
|
|
94
|
+
return this.getServiceInstance(ContentLabelsService_1.ContentLabelsService);
|
|
95
|
+
}
|
|
96
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-macro-body */
|
|
97
|
+
get contentMacroBody() {
|
|
98
|
+
return this.getServiceInstance(ContentMacroBodyService_1.ContentMacroBodyService);
|
|
99
|
+
}
|
|
100
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-permissions */
|
|
101
|
+
get contentPermissions() {
|
|
102
|
+
return this.getServiceInstance(ContentPermissionsService_1.ContentPermissionsService);
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* @deprecated
|
|
106
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties
|
|
107
|
+
*/
|
|
108
|
+
get contentProperties() {
|
|
109
|
+
return this.getServiceInstance(ContentPropertiesService_1.ContentPropertiesService);
|
|
110
|
+
}
|
|
111
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions */
|
|
112
|
+
get contentRestrictions() {
|
|
113
|
+
return this.getServiceInstance(ContentRestrictionsService_1.ContentRestrictionsService);
|
|
114
|
+
}
|
|
115
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content */
|
|
116
|
+
get content() {
|
|
117
|
+
return this.getServiceInstance(ContentService_1.ContentService);
|
|
118
|
+
}
|
|
119
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states */
|
|
120
|
+
get contentStates() {
|
|
121
|
+
return this.getServiceInstance(ContentStatesService_1.ContentStatesService);
|
|
122
|
+
}
|
|
123
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions */
|
|
124
|
+
get contentVersions() {
|
|
125
|
+
return this.getServiceInstance(ContentVersionsService_1.ContentVersionsService);
|
|
126
|
+
}
|
|
127
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches */
|
|
128
|
+
get contentWatches() {
|
|
129
|
+
return this.getServiceInstance(ContentWatchesService_1.ContentWatchesService);
|
|
130
|
+
}
|
|
131
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules */
|
|
132
|
+
get dynamicModules() {
|
|
133
|
+
return this.getServiceInstance(DynamicModulesService_1.DynamicModulesService);
|
|
134
|
+
}
|
|
135
|
+
/**
|
|
136
|
+
* APIs in this section can change without any prior deprecation notice.
|
|
137
|
+
*
|
|
138
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental
|
|
139
|
+
*/
|
|
140
|
+
get experimental() {
|
|
141
|
+
return this.getServiceInstance(ExperimentalService_1.ExperimentalService);
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
|
|
145
|
+
* The standard Atlassian group names are default names only and can be edited or
|
|
146
|
+
* deleted.** For example, an admin or Atlassian support could delete the default
|
|
147
|
+
* group jira-software-users or rename it to jsw-users at any point.
|
|
148
|
+
*
|
|
149
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group
|
|
150
|
+
*/
|
|
151
|
+
get group() {
|
|
152
|
+
return this.getServiceInstance(GroupService_1.GroupService);
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* @deprecated
|
|
156
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks
|
|
157
|
+
*/
|
|
158
|
+
get inlineTasks() {
|
|
159
|
+
return this.getServiceInstance(InlineTasksService_1.InlineTasksService);
|
|
160
|
+
}
|
|
161
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info */
|
|
162
|
+
get labelInfo() {
|
|
163
|
+
return this.getServiceInstance(LabelInfoService_1.LabelInfoService);
|
|
164
|
+
}
|
|
165
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task */
|
|
166
|
+
get longRunningTask() {
|
|
167
|
+
return this.getServiceInstance(LongRunningTaskService_1.LongRunningTaskService);
|
|
168
|
+
}
|
|
169
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation */
|
|
170
|
+
get relation() {
|
|
171
|
+
return this.getServiceInstance(RelationService_1.RelationService);
|
|
172
|
+
}
|
|
173
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search */
|
|
174
|
+
get search() {
|
|
175
|
+
return this.getServiceInstance(SearchService_1.SearchService);
|
|
176
|
+
}
|
|
177
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings */
|
|
178
|
+
get settings() {
|
|
179
|
+
return this.getServiceInstance(SettingsService_1.SettingsService);
|
|
180
|
+
}
|
|
181
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions */
|
|
182
|
+
get spacePermissions() {
|
|
183
|
+
return this.getServiceInstance(SpacePermissionsService_1.SpacePermissionsService);
|
|
184
|
+
}
|
|
185
|
+
/**
|
|
186
|
+
* @deprecated
|
|
187
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties
|
|
188
|
+
*/
|
|
189
|
+
get spaceProperties() {
|
|
190
|
+
return this.getServiceInstance(SpacePropertiesService_1.SpacePropertiesService);
|
|
191
|
+
}
|
|
192
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space */
|
|
193
|
+
get space() {
|
|
194
|
+
return this.getServiceInstance(SpaceService_1.SpaceService);
|
|
195
|
+
}
|
|
196
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings */
|
|
197
|
+
get spaceSettings() {
|
|
198
|
+
return this.getServiceInstance(SpaceSettingsService_1.SpaceSettingsService);
|
|
199
|
+
}
|
|
200
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template */
|
|
201
|
+
get template() {
|
|
202
|
+
return this.getServiceInstance(TemplateService_1.TemplateService);
|
|
203
|
+
}
|
|
204
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes */
|
|
205
|
+
get themes() {
|
|
206
|
+
return this.getServiceInstance(ThemesService_1.ThemesService);
|
|
207
|
+
}
|
|
208
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties */
|
|
209
|
+
get userProperties() {
|
|
210
|
+
return this.getServiceInstance(UserPropertiesService_1.UserPropertiesService);
|
|
211
|
+
}
|
|
212
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users */
|
|
213
|
+
get users() {
|
|
214
|
+
return this.getServiceInstance(UsersService_1.UsersService);
|
|
215
|
+
}
|
|
65
216
|
constructor(options) {
|
|
66
217
|
super(() => this.client);
|
|
67
218
|
this.client = new commonHttpClient.CommonHttpClient({
|
|
@@ -70,97 +221,9 @@ class BaseConfluenceApiV1Client extends CommonHttpService_1.CommonHttpService {
|
|
|
70
221
|
errorClass: BaseConfluenceApiV1ClientError,
|
|
71
222
|
});
|
|
72
223
|
this.getClient = () => this.client;
|
|
73
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics */
|
|
74
|
-
this.analytics = new AnalyticsService_1.AnalyticsService(this.getClient);
|
|
75
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit */
|
|
76
|
-
this.audit = new AuditService_1.AuditService(this.getClient);
|
|
77
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-attachments */
|
|
78
|
-
this.contentAttachments = new ContentAttachmentsService_1.ContentAttachmentsService(this.getClient);
|
|
79
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-body */
|
|
80
|
-
this.contentBody = new ContentBodyService_1.ContentBodyService(this.getClient);
|
|
81
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants */
|
|
82
|
-
this.contentChildrenAndDescendants = new ContentChildrenAndDescendantsService_1.ContentChildrenAndDescendantsService(this.getClient);
|
|
83
|
-
/**
|
|
84
|
-
* @deprecated
|
|
85
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-comments
|
|
86
|
-
*/
|
|
87
|
-
this.contentComments = new ContentCommentsService_1.ContentCommentsService(this.getClient);
|
|
88
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels */
|
|
89
|
-
this.contentLabels = new ContentLabelsService_1.ContentLabelsService(this.getClient);
|
|
90
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-macro-body */
|
|
91
|
-
this.contentMacroBody = new ContentMacroBodyService_1.ContentMacroBodyService(this.getClient);
|
|
92
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-permissions */
|
|
93
|
-
this.contentPermissions = new ContentPermissionsService_1.ContentPermissionsService(this.getClient);
|
|
94
|
-
/**
|
|
95
|
-
* @deprecated
|
|
96
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-properties
|
|
97
|
-
*/
|
|
98
|
-
this.contentProperties = new ContentPropertiesService_1.ContentPropertiesService(this.getClient);
|
|
99
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions */
|
|
100
|
-
this.contentRestrictions = new ContentRestrictionsService_1.ContentRestrictionsService(this.getClient);
|
|
101
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content */
|
|
102
|
-
this.content = new ContentService_1.ContentService(this.getClient);
|
|
103
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-states */
|
|
104
|
-
this.contentStates = new ContentStatesService_1.ContentStatesService(this.getClient);
|
|
105
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-versions */
|
|
106
|
-
this.contentVersions = new ContentVersionsService_1.ContentVersionsService(this.getClient);
|
|
107
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-watches */
|
|
108
|
-
this.contentWatches = new ContentWatchesService_1.ContentWatchesService(this.getClient);
|
|
109
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-dynamic-modules */
|
|
110
|
-
this.dynamicModules = new DynamicModulesService_1.DynamicModulesService(this.getClient);
|
|
111
|
-
/**
|
|
112
|
-
* APIs in this section can change without any prior deprecation notice.
|
|
113
|
-
*
|
|
114
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-experimental
|
|
115
|
-
*/
|
|
116
|
-
this.experimental = new ExperimentalService_1.ExperimentalService(this.getClient);
|
|
117
|
-
/**
|
|
118
|
-
* **[WARNING](https://support.atlassian.com/user-management/docs/create-and-update-groups/)
|
|
119
|
-
* The standard Atlassian group names are default names only and can be edited or
|
|
120
|
-
* deleted.** For example, an admin or Atlassian support could delete the default
|
|
121
|
-
* group jira-software-users or rename it to jsw-users at any point.
|
|
122
|
-
*
|
|
123
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group
|
|
124
|
-
*/
|
|
125
|
-
this.group = new GroupService_1.GroupService(this.getClient);
|
|
126
|
-
/**
|
|
127
|
-
* @deprecated
|
|
128
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-inline-tasks
|
|
129
|
-
*/
|
|
130
|
-
this.inlineTasks = new InlineTasksService_1.InlineTasksService(this.getClient);
|
|
131
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-label-info */
|
|
132
|
-
this.labelInfo = new LabelInfoService_1.LabelInfoService(this.getClient);
|
|
133
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-long-running-task */
|
|
134
|
-
this.longRunningTask = new LongRunningTaskService_1.LongRunningTaskService(this.getClient);
|
|
135
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation */
|
|
136
|
-
this.relation = new RelationService_1.RelationService(this.getClient);
|
|
137
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search */
|
|
138
|
-
this.search = new SearchService_1.SearchService(this.getClient);
|
|
139
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings */
|
|
140
|
-
this.settings = new SettingsService_1.SettingsService(this.getClient);
|
|
141
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-permissions */
|
|
142
|
-
this.spacePermissions = new SpacePermissionsService_1.SpacePermissionsService(this.getClient);
|
|
143
|
-
/**
|
|
144
|
-
* @deprecated
|
|
145
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-properties
|
|
146
|
-
*/
|
|
147
|
-
this.spaceProperties = new SpacePropertiesService_1.SpacePropertiesService(this.getClient);
|
|
148
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space */
|
|
149
|
-
this.space = new SpaceService_1.SpaceService(this.getClient);
|
|
150
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-space-settings */
|
|
151
|
-
this.spaceSettings = new SpaceSettingsService_1.SpaceSettingsService(this.getClient);
|
|
152
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-template */
|
|
153
|
-
this.template = new TemplateService_1.TemplateService(this.getClient);
|
|
154
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-themes */
|
|
155
|
-
this.themes = new ThemesService_1.ThemesService(this.getClient);
|
|
156
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-user-properties */
|
|
157
|
-
this.userProperties = new UserPropertiesService_1.UserPropertiesService(this.getClient);
|
|
158
|
-
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-users */
|
|
159
|
-
this.users = new UsersService_1.UsersService(this.getClient);
|
|
160
224
|
this.client.setOptions(Object.assign(Object.assign({}, this.client.getOptions()), options));
|
|
161
225
|
}
|
|
162
226
|
}
|
|
163
227
|
exports.BaseConfluenceApiV1Client = BaseConfluenceApiV1Client;
|
|
164
|
-
BaseConfluenceApiV1Client.createClientWithServices = commonHttpClient.createClientWithServices;
|
|
165
228
|
validationSchemaStorage_1.validationSchemaStorage.setErrorClass(BaseConfluenceApiV1ClientError);
|
|
166
229
|
//# sourceMappingURL=BaseConfluenceApiV1Client.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"BaseConfluenceApiV1Client.js","sourceRoot":"","sources":["../../../src/openapi/v1/BaseConfluenceApiV1Client.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,4DAA4D;AAC5D,gEAA6D;AAoM7D,kEAA+D;AAC/D,0DAAuD;AACvD,oFAAiF;AACjF,sEAAmE;AACnE,0GAAuG;AACvG,8EAA2E;AAC3E,0EAAuE;AACvE,gFAA6E;AAC7E,oFAAiF;AACjF,kFAA+E;AAC/E,sFAAmF;AACnF,8DAA2D;AAC3D,0EAAuE;AACvE,8EAA2E;AAC3E,4EAAyE;AACzE,4EAAyE;AACzE,wEAAqE;AACrE,0DAAuD;AACvD,sEAAmE;AACnE,kEAA+D;AAC/D,8EAA2E;AAC3E,gEAA6D;AAC7D,4DAAyD;AACzD,gEAA6D;AAC7D,gFAA6E;AAC7E,8EAA2E;AAC3E,0DAAuD;AACvD,0EAAuE;AACvE,gEAA6D;AAC7D,4DAAyD;AACzD,4EAAyE;AACzE,0DAAuD;AACvD,uEAAoE;AAGpE,MAAa,8BAA+B,SAAQ,gBAAgB,CAAC,qBAAqB;IAA1F;;QACE,SAAI,GAAG,gCAAgC,CAAC;IAC1C,CAAC;CAAA;AAFD,wEAEC;AACD;;;;;;;;;;;;;;GAcG;AACH,MAAa,yBAA0B,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"BaseConfluenceApiV1Client.js","sourceRoot":"","sources":["../../../src/openapi/v1/BaseConfluenceApiV1Client.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,4DAA4D;AAC5D,gEAA6D;AAoM7D,kEAA+D;AAC/D,0DAAuD;AACvD,oFAAiF;AACjF,sEAAmE;AACnE,0GAAuG;AACvG,8EAA2E;AAC3E,0EAAuE;AACvE,gFAA6E;AAC7E,oFAAiF;AACjF,kFAA+E;AAC/E,sFAAmF;AACnF,8DAA2D;AAC3D,0EAAuE;AACvE,8EAA2E;AAC3E,4EAAyE;AACzE,4EAAyE;AACzE,wEAAqE;AACrE,0DAAuD;AACvD,sEAAmE;AACnE,kEAA+D;AAC/D,8EAA2E;AAC3E,gEAA6D;AAC7D,4DAAyD;AACzD,gEAA6D;AAC7D,gFAA6E;AAC7E,8EAA2E;AAC3E,0DAAuD;AACvD,0EAAuE;AACvE,gEAA6D;AAC7D,4DAAyD;AACzD,4EAAyE;AACzE,0DAAuD;AACvD,uEAAoE;AAGpE,MAAa,8BAA+B,SAAQ,gBAAgB,CAAC,qBAAqB;IAA1F;;QACE,SAAI,GAAG,gCAAgC,CAAC;IAC1C,CAAC;CAAA;AAFD,wEAEC;AACD;;;;;;;;;;;;;;GAcG;AACH,MAAa,yBAA0B,SAAQ,qCAAiB;IAO9D,wFAAwF;IACxF,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,kBAAkB,CAAC,mCAAgB,CAAC,CAAC;IACnD,CAAC;IACD,oFAAoF;IACpF,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD,kGAAkG;IAClG,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,kBAAkB,CAAC,qDAAyB,CAAC,CAAC;IAC5D,CAAC;IACD,2FAA2F;IAC3F,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,kBAAkB,CAAC,uCAAkB,CAAC,CAAC;IACrD,CAAC;IACD,+GAA+G;IAC/G,IAAI,6BAA6B;QAC/B,OAAO,IAAI,CAAC,kBAAkB,CAAC,2EAAoC,CAAC,CAAC;IACvE,CAAC;IACD;;;OAGG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD,6FAA6F;IAC7F,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,2CAAoB,CAAC,CAAC;IACvD,CAAC;IACD,iGAAiG;IACjG,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,kBAAkB,CAAC,iDAAuB,CAAC,CAAC;IAC1D,CAAC;IACD,kGAAkG;IAClG,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,kBAAkB,CAAC,qDAAyB,CAAC,CAAC;IAC5D,CAAC;IACD;;;OAGG;IACH,IAAI,iBAAiB;QACnB,OAAO,IAAI,CAAC,kBAAkB,CAAC,mDAAwB,CAAC,CAAC;IAC3D,CAAC;IACD,mGAAmG;IACnG,IAAI,mBAAmB;QACrB,OAAO,IAAI,CAAC,kBAAkB,CAAC,uDAA0B,CAAC,CAAC;IAC7D,CAAC;IACD,sFAAsF;IACtF,IAAI,OAAO;QACT,OAAO,IAAI,CAAC,kBAAkB,CAAC,+BAAc,CAAC,CAAC;IACjD,CAAC;IACD,6FAA6F;IAC7F,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,2CAAoB,CAAC,CAAC;IACvD,CAAC;IACD,+FAA+F;IAC/F,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD,8FAA8F;IAC9F,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,6CAAqB,CAAC,CAAC;IACxD,CAAC;IACD,8FAA8F;IAC9F,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,6CAAqB,CAAC,CAAC;IACxD,CAAC;IACD;;;;OAIG;IACH,IAAI,YAAY;QACd,OAAO,IAAI,CAAC,kBAAkB,CAAC,yCAAmB,CAAC,CAAC;IACtD,CAAC;IACD;;;;;;;OAOG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD;;;OAGG;IACH,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,kBAAkB,CAAC,uCAAkB,CAAC,CAAC;IACrD,CAAC;IACD,yFAAyF;IACzF,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,kBAAkB,CAAC,mCAAgB,CAAC,CAAC;IACnD,CAAC;IACD,gGAAgG;IAChG,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD,uFAAuF;IACvF,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD,qFAAqF;IACrF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,kBAAkB,CAAC,6BAAa,CAAC,CAAC;IAChD,CAAC;IACD,uFAAuF;IACvF,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD,gGAAgG;IAChG,IAAI,gBAAgB;QAClB,OAAO,IAAI,CAAC,kBAAkB,CAAC,iDAAuB,CAAC,CAAC;IAC1D,CAAC;IACD;;;OAGG;IACH,IAAI,eAAe;QACjB,OAAO,IAAI,CAAC,kBAAkB,CAAC,+CAAsB,CAAC,CAAC;IACzD,CAAC;IACD,oFAAoF;IACpF,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD,6FAA6F;IAC7F,IAAI,aAAa;QACf,OAAO,IAAI,CAAC,kBAAkB,CAAC,2CAAoB,CAAC,CAAC;IACvD,CAAC;IACD,uFAAuF;IACvF,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,kBAAkB,CAAC,iCAAe,CAAC,CAAC;IAClD,CAAC;IACD,qFAAqF;IACrF,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,kBAAkB,CAAC,6BAAa,CAAC,CAAC;IAChD,CAAC;IACD,8FAA8F;IAC9F,IAAI,cAAc;QAChB,OAAO,IAAI,CAAC,kBAAkB,CAAC,6CAAqB,CAAC,CAAC;IACxD,CAAC;IACD,oFAAoF;IACpF,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,kBAAkB,CAAC,2BAAY,CAAC,CAAC;IAC/C,CAAC;IACD,YAAY,OAA0C;QACpD,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QA9J3B,WAAM,GAAG,IAAI,gBAAgB,CAAC,gBAAgB,CAAC;YAC7C,OAAO,EAAE,6BAA6B;YACtC,kBAAkB,EAAE,MAAM;YAC1B,UAAU,EAAE,8BAA8B;SAC3C,CAAC,CAAC;QACH,cAAS,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC;QA0J5B,IAAI,CAAC,MAAM,CAAC,UAAU,iCACjB,IAAI,CAAC,MAAM,CAAC,UAAU,EAAE,GACxB,OAAO,EACV,CAAC;IACL,CAAC;CACF;AArKD,8DAqKC;AACD,iDAAuB,CAAC,aAAa,CAAC,8BAA8B,CAAC,CAAC"}
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
import type * as commonHttpClient from "./CommonHttpClient";
|
|
2
2
|
export declare class CommonHttpService {
|
|
3
|
+
protected serviceInstancesMap: Map<new (getClientInstance: () => commonHttpClient.CommonHttpClient) => CommonHttpService, CommonHttpService>;
|
|
4
|
+
protected getServiceInstance<T extends CommonHttpService>(serviceClass: new (getClientInstance: () => commonHttpClient.CommonHttpClient) => T): T;
|
|
3
5
|
protected getClientInstance: () => commonHttpClient.CommonHttpClient;
|
|
4
6
|
constructor(getClientInstance: () => commonHttpClient.CommonHttpClient);
|
|
5
7
|
protected static initialized: boolean | undefined;
|
|
@@ -2,7 +2,16 @@
|
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.CommonHttpService = void 0;
|
|
4
4
|
class CommonHttpService {
|
|
5
|
+
getServiceInstance(serviceClass) {
|
|
6
|
+
let serviceInstance = this.serviceInstancesMap.get(serviceClass);
|
|
7
|
+
if (!serviceInstance) {
|
|
8
|
+
serviceInstance = new serviceClass(this.getClientInstance);
|
|
9
|
+
this.serviceInstancesMap.set(serviceClass, serviceInstance);
|
|
10
|
+
}
|
|
11
|
+
return serviceInstance;
|
|
12
|
+
}
|
|
5
13
|
constructor(getClientInstance) {
|
|
14
|
+
this.serviceInstancesMap = new Map();
|
|
6
15
|
this.getClientInstance = () => {
|
|
7
16
|
const classInstance = this.constructor;
|
|
8
17
|
if (classInstance.initialized !== true) {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"CommonHttpService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/core/CommonHttpService.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;
|
|
1
|
+
{"version":3,"file":"CommonHttpService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/core/CommonHttpService.ts"],"names":[],"mappings":";;;AAIA,MAAa,iBAAiB;IAOlB,kBAAkB,CAC1B,YAEM;QAEN,IAAI,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,eAAe,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAC3D,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,YAAY,EAAE,eAAe,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,eAAoB,CAAC;IAC9B,CAAC;IAED,YAAY,iBAA0D;QAnB5D,wBAAmB,GAKzB,IAAI,GAAG,EAAE,CAAC;QAeZ,IAAI,CAAC,iBAAiB,GAAG,GAAG,EAAE;YAC5B,MAAM,aAAa,GAAG,IAAI,CAAC,WAAuC,CAAC;YACnE,IAAI,aAAa,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;gBACvC,aAAa,CAAC,WAAW,GAAG,IAAI,CAAC;gBACjC,IAAI,aAAa,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;oBAC3C,aAAa,CAAC,UAAU,EAAE,CAAC;gBAC7B,CAAC;YACH,CAAC;YACD,IAAI,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;YAC3C,OAAO,iBAAiB,EAAE,CAAC;QAC7B,CAAC,CAAC;IACJ,CAAC;CAGF;AAnCD,8CAmCC"}
|
|
@@ -10,7 +10,7 @@ export declare class AnalyticsService extends CommonHttpService {
|
|
|
10
10
|
* @scopes-beta read:analytics.content:confluence
|
|
11
11
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-viewers-get
|
|
12
12
|
*/
|
|
13
|
-
getViewers({ contentId, fromDate, }: {
|
|
13
|
+
getViewers: ({ contentId, fromDate, }: {
|
|
14
14
|
/** The ID of the content to get the viewers for. */
|
|
15
15
|
contentId: string;
|
|
16
16
|
/**
|
|
@@ -18,12 +18,12 @@ export declare class AnalyticsService extends CommonHttpService {
|
|
|
18
18
|
*
|
|
19
19
|
* @example 2021-03-21T00:00:00.000Z
|
|
20
20
|
*/
|
|
21
|
-
fromDate?: string;
|
|
22
|
-
})
|
|
21
|
+
fromDate?: string | undefined;
|
|
22
|
+
}) => Promise<{
|
|
23
23
|
/** The content ID. */
|
|
24
|
-
id?: number;
|
|
24
|
+
id?: number | undefined;
|
|
25
25
|
/** The total number of distinct viewers for the content. */
|
|
26
|
-
count?: number;
|
|
26
|
+
count?: number | undefined;
|
|
27
27
|
} & {
|
|
28
28
|
[key: string]: unknown;
|
|
29
29
|
}>;
|
|
@@ -36,7 +36,7 @@ export declare class AnalyticsService extends CommonHttpService {
|
|
|
36
36
|
* @scopes-beta read:analytics.content:confluence
|
|
37
37
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-views-get
|
|
38
38
|
*/
|
|
39
|
-
getViews({ contentId, fromDate, }: {
|
|
39
|
+
getViews: ({ contentId, fromDate, }: {
|
|
40
40
|
/** The ID of the content to get the views for. */
|
|
41
41
|
contentId: string;
|
|
42
42
|
/**
|
|
@@ -44,12 +44,12 @@ export declare class AnalyticsService extends CommonHttpService {
|
|
|
44
44
|
*
|
|
45
45
|
* @example 2021-03-21T00:00:00.000Z
|
|
46
46
|
*/
|
|
47
|
-
fromDate?: string;
|
|
48
|
-
})
|
|
47
|
+
fromDate?: string | undefined;
|
|
48
|
+
}) => Promise<{
|
|
49
49
|
/** The content ID. */
|
|
50
|
-
id?: number;
|
|
50
|
+
id?: number | undefined;
|
|
51
51
|
/** The total number of views for the content. */
|
|
52
|
-
count?: number;
|
|
52
|
+
count?: number | undefined;
|
|
53
53
|
} & {
|
|
54
54
|
[key: string]: unknown;
|
|
55
55
|
}>;
|