@resolution/confluence-api-client 0.4.4 → 0.4.5
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 +11 -0
- 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/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,17 @@
|
|
|
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.5](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.4...v0.4.5) (2024-06-14)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* missing packages changes ([2c1f946](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/2c1f946e7c96f955fa88464f0c673081209616c6))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
|
|
6
17
|
## [0.4.4](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.3...v0.4.4) (2024-06-11)
|
|
7
18
|
|
|
8
19
|
|
|
@@ -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
|
}>;
|
|
@@ -10,65 +10,68 @@ const CommonHttpService_1 = require("../core/CommonHttpService");
|
|
|
10
10
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
11
11
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics */
|
|
12
12
|
class AnalyticsService extends CommonHttpService_1.CommonHttpService {
|
|
13
|
-
|
|
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
|
-
|
|
13
|
+
constructor() {
|
|
14
|
+
super(...arguments);
|
|
15
|
+
/**
|
|
16
|
+
* Get the total number of distinct viewers a piece of content has.
|
|
17
|
+
*
|
|
18
|
+
* @returns Returns the total number of distinct viewers for the content.
|
|
19
|
+
* @path {GET} /wiki/rest/api/analytics/content/{contentId}/viewers
|
|
20
|
+
* @scopes-current read:confluence-content.summary
|
|
21
|
+
* @scopes-beta read:analytics.content:confluence
|
|
22
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-viewers-get
|
|
23
|
+
*/
|
|
24
|
+
this.getViewers = ({ contentId, fromDate, }) => {
|
|
25
|
+
return this.getClientInstance()
|
|
26
|
+
.request({
|
|
27
|
+
path: "/wiki/rest/api/analytics/content/{contentId}/viewers",
|
|
28
|
+
method: "GET",
|
|
29
|
+
pathParams: {
|
|
30
|
+
contentId,
|
|
31
|
+
},
|
|
32
|
+
query: {
|
|
33
|
+
fromDate,
|
|
34
|
+
},
|
|
35
|
+
})
|
|
36
|
+
.then(this.getClientInstance().responseHandler({
|
|
37
|
+
200: {
|
|
38
|
+
"application/json": "json",
|
|
39
|
+
},
|
|
40
|
+
}))
|
|
41
|
+
.then(commonHttpClient.castResponse())
|
|
42
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AnalyticsService.getViewers.response"))
|
|
43
|
+
.then(commonHttpClient.getBody);
|
|
44
|
+
};
|
|
45
|
+
/**
|
|
46
|
+
* Get the total number of views a piece of content has.
|
|
47
|
+
*
|
|
48
|
+
* @returns Returns the total number of views for the content.
|
|
49
|
+
* @path {GET} /wiki/rest/api/analytics/content/{contentId}/views
|
|
50
|
+
* @scopes-current read:confluence-content.summary
|
|
51
|
+
* @scopes-beta read:analytics.content:confluence
|
|
52
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-analytics#api-wiki-rest-api-analytics-content-contentid-views-get
|
|
53
|
+
*/
|
|
54
|
+
this.getViews = ({ contentId, fromDate, }) => {
|
|
55
|
+
return this.getClientInstance()
|
|
56
|
+
.request({
|
|
57
|
+
path: "/wiki/rest/api/analytics/content/{contentId}/views",
|
|
58
|
+
method: "GET",
|
|
59
|
+
pathParams: {
|
|
60
|
+
contentId,
|
|
61
|
+
},
|
|
62
|
+
query: {
|
|
63
|
+
fromDate,
|
|
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("AnalyticsService.getViews.response"))
|
|
73
|
+
.then(commonHttpClient.getBody);
|
|
74
|
+
};
|
|
72
75
|
}
|
|
73
76
|
static initialize() {
|
|
74
77
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AnalyticsService.getViewers.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AnalyticsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AnalyticsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,wEAAqE;AACrE,wFAAwF;AACxF,MAAa,gBAAiB,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"AnalyticsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/AnalyticsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,wEAAqE;AACrE,wFAAwF;AACxF,MAAa,gBAAiB,SAAQ,qCAAiB;IAAvD;;QACE;;;;;;;;WAQG;QACH,eAAU,GAAG,CAAC,EACZ,SAAS,EACT,QAAQ,GAUT,EASC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,sDAAsD;gBAC5D,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,sCAAsC,CACvC,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;WAQG;QACH,aAAQ,GAAG,CAAC,EACV,SAAS,EACT,QAAQ,GAUT,EASC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oDAAoD;gBAC1D,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,QAAQ;iBACT;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAiCJ,CAAC;IAhCC,MAAM,CAAC,UAAU;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,OAAC;iBACJ,MAAM,CAAC;gBACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,sCAAsC,CAAC,CACpD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;gBAC/B,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;aACnC,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;IACJ,CAAC;CACF;AAvKD,4CAuKC"}
|
|
@@ -14,10 +14,10 @@ export declare class AuditService extends CommonHttpService {
|
|
|
14
14
|
* @scopes-current read:audit-log:confluence, write:audit-log:confluence
|
|
15
15
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-post
|
|
16
16
|
*/
|
|
17
|
-
createAuditRecord({ auditRecordCreate, }: {
|
|
17
|
+
createAuditRecord: ({ auditRecordCreate, }: {
|
|
18
18
|
/** The record to be created in the audit log. */
|
|
19
19
|
auditRecordCreate: AuditRecordCreate;
|
|
20
|
-
})
|
|
20
|
+
}) => Promise<AuditRecord>;
|
|
21
21
|
/**
|
|
22
22
|
* Exports audit records as a CSV file or ZIP file.
|
|
23
23
|
*
|
|
@@ -35,27 +35,27 @@ export declare class AuditService extends CommonHttpService {
|
|
|
35
35
|
* @scopes-current read:audit-log:confluence
|
|
36
36
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-export-get
|
|
37
37
|
*/
|
|
38
|
-
exportAuditRecords({ startDate, endDate, searchString, format, }?: {
|
|
38
|
+
exportAuditRecords: ({ startDate, endDate, searchString, format, }?: {
|
|
39
39
|
/**
|
|
40
40
|
* Filters the exported results to the records on or after the `startDate`.
|
|
41
41
|
* The `startDate` must be specified as [epoch
|
|
42
42
|
* time](https://www.epochconverter.com/) in milliseconds.
|
|
43
43
|
*/
|
|
44
|
-
startDate?: string;
|
|
44
|
+
startDate?: string | undefined;
|
|
45
45
|
/**
|
|
46
46
|
* Filters the exported results to the records on or before the `endDate`.
|
|
47
47
|
* The `endDate` must be specified as [epoch
|
|
48
48
|
* time](https://www.epochconverter.com/) in milliseconds.
|
|
49
49
|
*/
|
|
50
|
-
endDate?: string;
|
|
50
|
+
endDate?: string | undefined;
|
|
51
51
|
/**
|
|
52
52
|
* Filters the exported results to records that have string property values
|
|
53
53
|
* matching the `searchString`.
|
|
54
54
|
*/
|
|
55
|
-
searchString?: string;
|
|
55
|
+
searchString?: string | undefined;
|
|
56
56
|
/** The format of the export file for the audit records. */
|
|
57
|
-
format?: "csv" | "zip";
|
|
58
|
-
})
|
|
57
|
+
format?: "csv" | "zip" | undefined;
|
|
58
|
+
}) => Promise<commonHttpClient.WithResponse<{
|
|
59
59
|
status: 200;
|
|
60
60
|
mediaType: "application/zip" | "text/csv";
|
|
61
61
|
body: Blob;
|
|
@@ -75,32 +75,32 @@ export declare class AuditService extends CommonHttpService {
|
|
|
75
75
|
* @scopes-current read:audit-log:confluence
|
|
76
76
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-get
|
|
77
77
|
*/
|
|
78
|
-
getAuditRecords({ startDate, endDate, searchString, start, limit, }?: {
|
|
78
|
+
getAuditRecords: ({ startDate, endDate, searchString, start, limit, }?: {
|
|
79
79
|
/**
|
|
80
80
|
* Filters the results to the records on or after the `startDate`.
|
|
81
81
|
* The `startDate` must be specified as [epoch
|
|
82
82
|
* time](https://www.epochconverter.com/) in milliseconds.
|
|
83
83
|
*/
|
|
84
|
-
startDate?: string;
|
|
84
|
+
startDate?: string | undefined;
|
|
85
85
|
/**
|
|
86
86
|
* Filters the results to the records on or before the `endDate`.
|
|
87
87
|
* The `endDate` must be specified as [epoch
|
|
88
88
|
* time](https://www.epochconverter.com/) in milliseconds.
|
|
89
89
|
*/
|
|
90
|
-
endDate?: string;
|
|
90
|
+
endDate?: string | undefined;
|
|
91
91
|
/**
|
|
92
92
|
* Filters the results to records that have string property values
|
|
93
93
|
* matching the `searchString`.
|
|
94
94
|
*/
|
|
95
|
-
searchString?: string;
|
|
95
|
+
searchString?: string | undefined;
|
|
96
96
|
/** The starting index of the returned records. */
|
|
97
|
-
start?: number;
|
|
97
|
+
start?: number | undefined;
|
|
98
98
|
/**
|
|
99
99
|
* The maximum number of records to return per page.
|
|
100
100
|
* Note, this may be restricted by fixed system limits.
|
|
101
101
|
*/
|
|
102
|
-
limit?: number;
|
|
103
|
-
})
|
|
102
|
+
limit?: number | undefined;
|
|
103
|
+
}) => Promise<AuditRecordArray>;
|
|
104
104
|
/**
|
|
105
105
|
* Returns records from the audit log, for a time period back from the current
|
|
106
106
|
* date. For example, you can use this method to get the last 3 months of records.
|
|
@@ -118,24 +118,24 @@ export declare class AuditService extends CommonHttpService {
|
|
|
118
118
|
* @scopes-current read:audit-log:confluence
|
|
119
119
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-since-get
|
|
120
120
|
*/
|
|
121
|
-
getAuditRecordsForTimePeriod({ number, units, searchString, start, limit, }?: {
|
|
121
|
+
getAuditRecordsForTimePeriod: ({ number, units, searchString, start, limit, }?: {
|
|
122
122
|
/** The number of units for the time period. */
|
|
123
|
-
number?: number;
|
|
123
|
+
number?: number | undefined;
|
|
124
124
|
/** The unit of time that the time period is measured in. */
|
|
125
|
-
units?: "NANOS" | "MICROS" | "MILLIS" | "SECONDS" | "MINUTES" | "HOURS" | "HALF_DAYS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "DECADES" | "CENTURIES";
|
|
125
|
+
units?: "NANOS" | "MICROS" | "MILLIS" | "SECONDS" | "MINUTES" | "HOURS" | "HALF_DAYS" | "DAYS" | "WEEKS" | "MONTHS" | "YEARS" | "DECADES" | "CENTURIES" | undefined;
|
|
126
126
|
/**
|
|
127
127
|
* Filters the results to records that have string property values
|
|
128
128
|
* matching the `searchString`.
|
|
129
129
|
*/
|
|
130
|
-
searchString?: string;
|
|
130
|
+
searchString?: string | undefined;
|
|
131
131
|
/** The starting index of the returned records. */
|
|
132
|
-
start?: number;
|
|
132
|
+
start?: number | undefined;
|
|
133
133
|
/**
|
|
134
134
|
* The maximum number of records to return per page.
|
|
135
135
|
* Note, this may be restricted by fixed system limits.
|
|
136
136
|
*/
|
|
137
|
-
limit?: number;
|
|
138
|
-
})
|
|
137
|
+
limit?: number | undefined;
|
|
138
|
+
}) => Promise<AuditRecordArray>;
|
|
139
139
|
/**
|
|
140
140
|
* Returns the retention period for records in the audit log. The retention
|
|
141
141
|
* period is how long an audit record is kept for, from creation date until
|
|
@@ -149,7 +149,7 @@ export declare class AuditService extends CommonHttpService {
|
|
|
149
149
|
* @scopes-current read:audit-log:confluence
|
|
150
150
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-get
|
|
151
151
|
*/
|
|
152
|
-
getRetentionPeriod()
|
|
152
|
+
getRetentionPeriod: () => Promise<RetentionPeriod>;
|
|
153
153
|
/**
|
|
154
154
|
* Sets the retention period for records in the audit log. The retention period
|
|
155
155
|
* can be set to a maximum of 1 year.
|
|
@@ -162,9 +162,9 @@ export declare class AuditService extends CommonHttpService {
|
|
|
162
162
|
* @scopes-current write:audit-log:confluence
|
|
163
163
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-audit#api-wiki-rest-api-audit-retention-put
|
|
164
164
|
*/
|
|
165
|
-
setRetentionPeriod({ retentionPeriod, }: {
|
|
165
|
+
setRetentionPeriod: ({ retentionPeriod, }: {
|
|
166
166
|
/** The updated retention period. */
|
|
167
167
|
retentionPeriod: RetentionPeriod;
|
|
168
|
-
})
|
|
168
|
+
}) => Promise<RetentionPeriod>;
|
|
169
169
|
static initialize(): void;
|
|
170
170
|
}
|