@resolution/confluence-api-client 0.4.3 → 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 +22 -0
- package/README.md +4 -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
|
@@ -12,86 +12,89 @@ const space_1 = require("../models/space");
|
|
|
12
12
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
13
13
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space */
|
|
14
14
|
class SpaceService extends CommonHttpService_1.CommonHttpService {
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
15
|
+
constructor() {
|
|
16
|
+
super(...arguments);
|
|
17
|
+
/**
|
|
18
|
+
* Returns a specific space.
|
|
19
|
+
*
|
|
20
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
21
|
+
* Permission to view the space.
|
|
22
|
+
*
|
|
23
|
+
* @returns Returned if the requested space is returned.
|
|
24
|
+
* @path {GET} /spaces/{id}
|
|
25
|
+
* @scopes-current read:space:confluence
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space#api-spaces-id-get
|
|
27
|
+
*/
|
|
28
|
+
this.getSpaceById = ({ id, descriptionFormat, includeIcon, includeOperations, includeProperties, includePermissions, includeLabels, }) => {
|
|
29
|
+
return this.getClientInstance()
|
|
30
|
+
.request({
|
|
31
|
+
path: "/spaces/{id}",
|
|
32
|
+
method: "GET",
|
|
33
|
+
pathParams: {
|
|
34
|
+
id,
|
|
35
|
+
},
|
|
36
|
+
query: {
|
|
37
|
+
"description-format": descriptionFormat,
|
|
38
|
+
"include-icon": includeIcon,
|
|
39
|
+
"include-operations": includeOperations,
|
|
40
|
+
"include-properties": includeProperties,
|
|
41
|
+
"include-permissions": includePermissions,
|
|
42
|
+
"include-labels": includeLabels,
|
|
43
|
+
},
|
|
44
|
+
})
|
|
45
|
+
.then(this.getClientInstance().responseHandler({
|
|
46
|
+
200: {
|
|
47
|
+
"application/json": "json",
|
|
48
|
+
},
|
|
49
|
+
}))
|
|
50
|
+
.then(commonHttpClient.castResponse())
|
|
51
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getSpaceById.response"))
|
|
52
|
+
.then(commonHttpClient.getBody);
|
|
53
|
+
};
|
|
54
|
+
/**
|
|
55
|
+
* Returns all spaces. The results will be sorted by id ascending. The number of
|
|
56
|
+
* results is limited by the `limit` parameter and
|
|
57
|
+
* additional results (if available) will be available through the `next` URL
|
|
58
|
+
* present in the `Link` response header.
|
|
59
|
+
*
|
|
60
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
61
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
62
|
+
* Only spaces that the user has permission to view will be returned.
|
|
63
|
+
*
|
|
64
|
+
* @returns Returned if the requested spaces are returned.
|
|
65
|
+
* @path {GET} /spaces
|
|
66
|
+
* @scopes-current read:space:confluence
|
|
67
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space#api-spaces-get
|
|
68
|
+
*/
|
|
69
|
+
this.getSpaces = ({ ids, keys, type, status, labels, favoritedBy, notFavoritedBy, sort, descriptionFormat, includeIcon, cursor, limit, } = {}) => {
|
|
70
|
+
return this.getClientInstance()
|
|
71
|
+
.request({
|
|
72
|
+
path: "/spaces",
|
|
73
|
+
method: "GET",
|
|
74
|
+
query: {
|
|
75
|
+
ids,
|
|
76
|
+
keys,
|
|
77
|
+
type,
|
|
78
|
+
status,
|
|
79
|
+
labels,
|
|
80
|
+
"favorited-by": favoritedBy,
|
|
81
|
+
"not-favorited-by": notFavoritedBy,
|
|
82
|
+
sort,
|
|
83
|
+
"description-format": descriptionFormat,
|
|
84
|
+
"include-icon": includeIcon,
|
|
85
|
+
cursor,
|
|
86
|
+
limit,
|
|
87
|
+
},
|
|
88
|
+
})
|
|
89
|
+
.then(this.getClientInstance().responseHandler({
|
|
90
|
+
200: {
|
|
91
|
+
"application/json": "json",
|
|
92
|
+
},
|
|
93
|
+
}))
|
|
94
|
+
.then(commonHttpClient.castResponse())
|
|
95
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SpaceService.getSpaces.response"))
|
|
96
|
+
.then(commonHttpClient.getBody);
|
|
97
|
+
};
|
|
95
98
|
}
|
|
96
99
|
static initialize() {
|
|
97
100
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpaceService.getSpaces.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SpaceService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpaceService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,2CAKyB;AACzB,wEAAqE;AACrE,oFAAoF;AACpF,MAAa,YAAa,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"SpaceService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpaceService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,2CAKyB;AACzB,wEAAqE;AACrE,oFAAoF;AACpF,MAAa,YAAa,SAAQ,qCAAiB;IAAnD;;QACE;;;;;;;;;;WAUG;QACH,iBAAY,GAAG,CAAC,EACd,EAAE,EACF,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,aAAa,GA4Cd,EAYC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,oBAAoB,EAAE,iBAAiB;oBACvC,cAAc,EAAE,WAAW;oBAC3B,oBAAoB,EAAE,iBAAiB;oBACvC,oBAAoB,EAAE,iBAAiB;oBACvC,qBAAqB,EAAE,kBAAkB;oBACzC,gBAAgB,EAAE,aAAa;iBAChC;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,EAazB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,oCAAoC,CAAC,CACxE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,cAAS,GAAG,CAAC,EACX,GAAG,EACH,IAAI,EACJ,IAAI,EACJ,MAAM,EACN,MAAM,EACN,WAAW,EACX,cAAc,EACd,IAAI,EACJ,iBAAiB,EACjB,WAAW,EACX,MAAM,EACN,KAAK,MAqDH,EAAE,EAOJ,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,SAAS;gBACf,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;oBACH,IAAI;oBACJ,IAAI;oBACJ,MAAM;oBACN,MAAM;oBACN,cAAc,EAAE,WAAW;oBAC3B,kBAAkB,EAAE,cAAc;oBAClC,IAAI;oBACJ,oBAAoB,EAAE,iBAAiB;oBACvC,cAAc,EAAE,WAAW;oBAC3B,MAAM;oBACN,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,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,iCAAiC,CAAC,CACrE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAgDJ,CAAC;IA/CC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,iCAAiC,EACjC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;qBAChD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,iCAAiC,CAAC,CAC/C,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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,aAAa,CAAC,EAC3C,OAAC;iBACE,MAAM,CAAC;gBACN,MAAM,EAAE,OAAC;qBACN,MAAM,CAAC;oBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC;qBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;qBACrB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;SACF,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,sCAA8B;YAC9B,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA1SD,oCA0SC"}
|
|
@@ -14,7 +14,7 @@ export declare class TaskService extends CommonHttpService {
|
|
|
14
14
|
* @scopes-current read:task:confluence
|
|
15
15
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task#api-tasks-id-get
|
|
16
16
|
*/
|
|
17
|
-
getTaskById({ id, bodyFormat, }: {
|
|
17
|
+
getTaskById: ({ id, bodyFormat, }: {
|
|
18
18
|
/**
|
|
19
19
|
* The ID of the task to be returned. If you don't know the task ID, use Get tasks
|
|
20
20
|
* and filter the results.
|
|
@@ -25,8 +25,8 @@ export declare class TaskService extends CommonHttpService {
|
|
|
25
25
|
* available, the representation will be available under a response field of the
|
|
26
26
|
* same name under the `body` field.
|
|
27
27
|
*/
|
|
28
|
-
bodyFormat?: PrimaryBodyRepresentation;
|
|
29
|
-
})
|
|
28
|
+
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
29
|
+
}) => Promise<Task>;
|
|
30
30
|
/**
|
|
31
31
|
* Returns all tasks. The number of results is limited by the `limit` parameter
|
|
32
32
|
* and additional results (if available)
|
|
@@ -41,91 +41,91 @@ export declare class TaskService extends CommonHttpService {
|
|
|
41
41
|
* @scopes-current read:task:confluence
|
|
42
42
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task#api-tasks-get
|
|
43
43
|
*/
|
|
44
|
-
getTasks({ bodyFormat, includeBlankTasks, status, taskId, spaceId, pageId, blogpostId, createdBy, assignedTo, completedBy, createdAtFrom, createdAtTo, dueAtFrom, dueAtTo, completedAtFrom, completedAtTo, cursor, limit, }?: {
|
|
44
|
+
getTasks: ({ bodyFormat, includeBlankTasks, status, taskId, spaceId, pageId, blogpostId, createdBy, assignedTo, completedBy, createdAtFrom, createdAtTo, dueAtFrom, dueAtTo, completedAtFrom, completedAtTo, cursor, limit, }?: {
|
|
45
45
|
/**
|
|
46
46
|
* The content format types to be returned in the `body` field of the response. If
|
|
47
47
|
* available, the representation will be available under a response field of the
|
|
48
48
|
* same name under the `body` field.
|
|
49
49
|
*/
|
|
50
|
-
bodyFormat?: PrimaryBodyRepresentation;
|
|
50
|
+
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
51
51
|
/** Specifies whether to include blank tasks in the response. Defaults to `true`. */
|
|
52
|
-
includeBlankTasks?: boolean;
|
|
52
|
+
includeBlankTasks?: boolean | undefined;
|
|
53
53
|
/** Filters on the status of the task. */
|
|
54
|
-
status?: "complete" | "incomplete";
|
|
54
|
+
status?: "complete" | "incomplete" | undefined;
|
|
55
55
|
/** Filters on task ID. Multiple IDs can be specified. */
|
|
56
|
-
taskId?: number[];
|
|
56
|
+
taskId?: number[] | undefined;
|
|
57
57
|
/** Filters on the space ID of the task. Multiple IDs can be specified. */
|
|
58
|
-
spaceId?: number[];
|
|
58
|
+
spaceId?: number[] | undefined;
|
|
59
59
|
/**
|
|
60
60
|
* Filters on the page ID of the task. Multiple IDs can be specified. Note - page
|
|
61
61
|
* and blog post filters can be used in conjunction.
|
|
62
62
|
*/
|
|
63
|
-
pageId?: number[];
|
|
63
|
+
pageId?: number[] | undefined;
|
|
64
64
|
/**
|
|
65
65
|
* Filters on the blog post ID of the task. Multiple IDs can be specified. Note -
|
|
66
66
|
* page and blog post filters can be used in conjunction.
|
|
67
67
|
*/
|
|
68
|
-
blogpostId?: number[];
|
|
68
|
+
blogpostId?: number[] | undefined;
|
|
69
69
|
/**
|
|
70
70
|
* Filters on the Account ID of the user who created this task. Multiple IDs can
|
|
71
71
|
* be specified.
|
|
72
72
|
*/
|
|
73
|
-
createdBy?: string[];
|
|
73
|
+
createdBy?: string[] | undefined;
|
|
74
74
|
/**
|
|
75
75
|
* Filters on the Account ID of the user to whom this task is assigned. Multiple
|
|
76
76
|
* IDs can be specified.
|
|
77
77
|
*/
|
|
78
|
-
assignedTo?: string[];
|
|
78
|
+
assignedTo?: string[] | undefined;
|
|
79
79
|
/**
|
|
80
80
|
* Filters on the Account ID of the user who completed this task. Multiple IDs can
|
|
81
81
|
* be specified.
|
|
82
82
|
*/
|
|
83
|
-
completedBy?: string[];
|
|
83
|
+
completedBy?: string[] | undefined;
|
|
84
84
|
/**
|
|
85
85
|
* Filters on start of date-time range of task based on creation date (inclusive).
|
|
86
86
|
* Input is epoch time in milliseconds.
|
|
87
87
|
*/
|
|
88
|
-
createdAtFrom?: number;
|
|
88
|
+
createdAtFrom?: number | undefined;
|
|
89
89
|
/**
|
|
90
90
|
* Filters on end of date-time range of task based on creation date (inclusive).
|
|
91
91
|
* Input is epoch time in milliseconds.
|
|
92
92
|
*/
|
|
93
|
-
createdAtTo?: number;
|
|
93
|
+
createdAtTo?: number | undefined;
|
|
94
94
|
/**
|
|
95
95
|
* Filters on start of date-time range of task based on due date (inclusive).
|
|
96
96
|
* Input is epoch time in milliseconds.
|
|
97
97
|
*/
|
|
98
|
-
dueAtFrom?: number;
|
|
98
|
+
dueAtFrom?: number | undefined;
|
|
99
99
|
/**
|
|
100
100
|
* Filters on end of date-time range of task based on due date (inclusive). Input
|
|
101
101
|
* is epoch time in milliseconds.
|
|
102
102
|
*/
|
|
103
|
-
dueAtTo?: number;
|
|
103
|
+
dueAtTo?: number | undefined;
|
|
104
104
|
/**
|
|
105
105
|
* Filters on start of date-time range of task based on completion date
|
|
106
106
|
* (inclusive). Input is epoch time in milliseconds.
|
|
107
107
|
*/
|
|
108
|
-
completedAtFrom?: number;
|
|
108
|
+
completedAtFrom?: number | undefined;
|
|
109
109
|
/**
|
|
110
110
|
* Filters on end of date-time range of task based on completion date (inclusive).
|
|
111
111
|
* Input is epoch time in milliseconds.
|
|
112
112
|
*/
|
|
113
|
-
completedAtTo?: number;
|
|
113
|
+
completedAtTo?: number | undefined;
|
|
114
114
|
/**
|
|
115
115
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
116
116
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
117
117
|
* retrieve the `next` set of results.
|
|
118
118
|
*/
|
|
119
|
-
cursor?: string;
|
|
119
|
+
cursor?: string | undefined;
|
|
120
120
|
/**
|
|
121
121
|
* Maximum number of tasks per result to return. If more results exist, use the
|
|
122
122
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
123
123
|
* results.
|
|
124
124
|
*/
|
|
125
|
-
limit?: number;
|
|
126
|
-
})
|
|
127
|
-
results?: Task[];
|
|
128
|
-
_links?: MultiEntityLinks;
|
|
125
|
+
limit?: number | undefined;
|
|
126
|
+
}) => Promise<{
|
|
127
|
+
results?: Task[] | undefined;
|
|
128
|
+
_links?: MultiEntityLinks | undefined;
|
|
129
129
|
} & {
|
|
130
130
|
[key: string]: unknown;
|
|
131
131
|
}>;
|
|
@@ -141,7 +141,7 @@ export declare class TaskService extends CommonHttpService {
|
|
|
141
141
|
* @scopes-current write:task:confluence
|
|
142
142
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task#api-tasks-id-put
|
|
143
143
|
*/
|
|
144
|
-
updateTask({ id, bodyFormat, requestBody, }: {
|
|
144
|
+
updateTask: ({ id, bodyFormat, requestBody, }: {
|
|
145
145
|
/**
|
|
146
146
|
* The ID of the task to be updated. If you don't know the task ID, use Get tasks
|
|
147
147
|
* and filter the results.
|
|
@@ -152,37 +152,37 @@ export declare class TaskService extends CommonHttpService {
|
|
|
152
152
|
* available, the representation will be available under a response field of the
|
|
153
153
|
* same name under the `body` field.
|
|
154
154
|
*/
|
|
155
|
-
bodyFormat?: PrimaryBodyRepresentation;
|
|
155
|
+
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
156
156
|
requestBody: {
|
|
157
157
|
/** ID of the task. */
|
|
158
|
-
id?: string;
|
|
158
|
+
id?: string | undefined;
|
|
159
159
|
/** Local ID of the task. This ID is local to the corresponding page or blog post. */
|
|
160
|
-
localId?: string;
|
|
160
|
+
localId?: string | undefined;
|
|
161
161
|
/** ID of the space the task is in. */
|
|
162
|
-
spaceId?: string;
|
|
162
|
+
spaceId?: string | undefined;
|
|
163
163
|
/** ID of the page the task is in. */
|
|
164
|
-
pageId?: string;
|
|
164
|
+
pageId?: string | undefined;
|
|
165
165
|
/** ID of the blog post the task is in. */
|
|
166
|
-
blogPostId?: string;
|
|
166
|
+
blogPostId?: string | undefined;
|
|
167
167
|
/** Status of the task. */
|
|
168
168
|
status: "complete" | "incomplete";
|
|
169
169
|
/** Account ID of the user who created this task. */
|
|
170
|
-
createdBy?: string;
|
|
170
|
+
createdBy?: string | undefined;
|
|
171
171
|
/** Account ID of the user to whom this task is assigned. */
|
|
172
|
-
assignedTo?: string;
|
|
172
|
+
assignedTo?: string | undefined;
|
|
173
173
|
/** Account ID of the user who completed this task. */
|
|
174
|
-
completedBy?: string;
|
|
174
|
+
completedBy?: string | undefined;
|
|
175
175
|
/** Date and time when the task was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ". */
|
|
176
|
-
createdAt?: string;
|
|
176
|
+
createdAt?: string | undefined;
|
|
177
177
|
/** Date and time when the task was updated. In format "YYYY-MM-DDTHH:mm:ss.sssZ". */
|
|
178
|
-
updatedAt?: string;
|
|
178
|
+
updatedAt?: string | undefined;
|
|
179
179
|
/** Date and time when the task is due. In format "YYYY-MM-DDTHH:mm:ss.sssZ". */
|
|
180
|
-
dueAt?: string;
|
|
180
|
+
dueAt?: string | undefined;
|
|
181
181
|
/** Date and time when the task was completed. In format "YYYY-MM-DDTHH:mm:ss.sssZ". */
|
|
182
|
-
completedAt?: string;
|
|
182
|
+
completedAt?: string | undefined;
|
|
183
183
|
} & {
|
|
184
184
|
[key: string]: unknown;
|
|
185
185
|
};
|
|
186
|
-
})
|
|
186
|
+
}) => Promise<Task>;
|
|
187
187
|
static initialize(): void;
|
|
188
188
|
}
|
|
@@ -12,123 +12,126 @@ const task_1 = require("../models/task");
|
|
|
12
12
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
13
13
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task */
|
|
14
14
|
class TaskService extends CommonHttpService_1.CommonHttpService {
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
"
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
15
|
+
constructor() {
|
|
16
|
+
super(...arguments);
|
|
17
|
+
/**
|
|
18
|
+
* Returns a specific task.
|
|
19
|
+
*
|
|
20
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
21
|
+
* Permission to view the containing page or blog post and its corresponding space.
|
|
22
|
+
*
|
|
23
|
+
* @returns Returned if the requested task is returned.
|
|
24
|
+
* @path {GET} /tasks/{id}
|
|
25
|
+
* @scopes-current read:task:confluence
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task#api-tasks-id-get
|
|
27
|
+
*/
|
|
28
|
+
this.getTaskById = ({ id, bodyFormat, }) => {
|
|
29
|
+
return this.getClientInstance()
|
|
30
|
+
.request({
|
|
31
|
+
path: "/tasks/{id}",
|
|
32
|
+
method: "GET",
|
|
33
|
+
pathParams: {
|
|
34
|
+
id,
|
|
35
|
+
},
|
|
36
|
+
query: {
|
|
37
|
+
"body-format": bodyFormat,
|
|
38
|
+
},
|
|
39
|
+
})
|
|
40
|
+
.then(this.getClientInstance().responseHandler({
|
|
41
|
+
200: {
|
|
42
|
+
"application/json": "json",
|
|
43
|
+
},
|
|
44
|
+
}))
|
|
45
|
+
.then(commonHttpClient.castResponse())
|
|
46
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("TaskService.getTaskById.response"))
|
|
47
|
+
.then(commonHttpClient.getBody);
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* Returns all tasks. The number of results is limited by the `limit` parameter
|
|
51
|
+
* and additional results (if available)
|
|
52
|
+
* will be available through the `next` URL present in the `Link` response header.
|
|
53
|
+
*
|
|
54
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
55
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
56
|
+
* Only tasks that the user has permission to view will be returned.
|
|
57
|
+
*
|
|
58
|
+
* @returns Returned if the requested tasks are returned.
|
|
59
|
+
* @path {GET} /tasks
|
|
60
|
+
* @scopes-current read:task:confluence
|
|
61
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task#api-tasks-get
|
|
62
|
+
*/
|
|
63
|
+
this.getTasks = ({ bodyFormat, includeBlankTasks, status, taskId, spaceId, pageId, blogpostId, createdBy, assignedTo, completedBy, createdAtFrom, createdAtTo, dueAtFrom, dueAtTo, completedAtFrom, completedAtTo, cursor, limit, } = {}) => {
|
|
64
|
+
return this.getClientInstance()
|
|
65
|
+
.request({
|
|
66
|
+
path: "/tasks",
|
|
67
|
+
method: "GET",
|
|
68
|
+
query: {
|
|
69
|
+
"body-format": bodyFormat,
|
|
70
|
+
"include-blank-tasks": includeBlankTasks,
|
|
71
|
+
status,
|
|
72
|
+
"task-id": taskId,
|
|
73
|
+
"space-id": spaceId,
|
|
74
|
+
"page-id": pageId,
|
|
75
|
+
"blogpost-id": blogpostId,
|
|
76
|
+
"created-by": createdBy,
|
|
77
|
+
"assigned-to": assignedTo,
|
|
78
|
+
"completed-by": completedBy,
|
|
79
|
+
"created-at-from": createdAtFrom,
|
|
80
|
+
"created-at-to": createdAtTo,
|
|
81
|
+
"due-at-from": dueAtFrom,
|
|
82
|
+
"due-at-to": dueAtTo,
|
|
83
|
+
"completed-at-from": completedAtFrom,
|
|
84
|
+
"completed-at-to": completedAtTo,
|
|
85
|
+
cursor,
|
|
86
|
+
limit,
|
|
87
|
+
},
|
|
88
|
+
})
|
|
89
|
+
.then(this.getClientInstance().responseHandler({
|
|
90
|
+
200: {
|
|
91
|
+
"application/json": "json",
|
|
92
|
+
},
|
|
93
|
+
}))
|
|
94
|
+
.then(commonHttpClient.castResponse())
|
|
95
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("TaskService.getTasks.response"))
|
|
96
|
+
.then(commonHttpClient.getBody);
|
|
97
|
+
};
|
|
98
|
+
/**
|
|
99
|
+
* Update a task by id.
|
|
100
|
+
*
|
|
101
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
102
|
+
* Permission to edit the containing page or blog post and view its corresponding
|
|
103
|
+
* space.
|
|
104
|
+
*
|
|
105
|
+
* @returns Returned if the requested task is updated.
|
|
106
|
+
* @path {PUT} /tasks/{id}
|
|
107
|
+
* @scopes-current write:task:confluence
|
|
108
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-task#api-tasks-id-put
|
|
109
|
+
*/
|
|
110
|
+
this.updateTask = ({ id, bodyFormat, requestBody, }) => {
|
|
111
|
+
return this.getClientInstance()
|
|
112
|
+
.request({
|
|
113
|
+
path: "/tasks/{id}",
|
|
114
|
+
method: "PUT",
|
|
115
|
+
pathParams: {
|
|
116
|
+
id,
|
|
117
|
+
},
|
|
118
|
+
query: {
|
|
119
|
+
"body-format": bodyFormat,
|
|
120
|
+
},
|
|
121
|
+
headers: {
|
|
122
|
+
"Content-Type": "application/json",
|
|
123
|
+
},
|
|
124
|
+
body: requestBody,
|
|
125
|
+
})
|
|
126
|
+
.then(this.getClientInstance().responseHandler({
|
|
127
|
+
200: {
|
|
128
|
+
"application/json": "json",
|
|
129
|
+
},
|
|
130
|
+
}))
|
|
131
|
+
.then(commonHttpClient.castResponse())
|
|
132
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("TaskService.updateTask.response"))
|
|
133
|
+
.then(commonHttpClient.getBody);
|
|
134
|
+
};
|
|
132
135
|
}
|
|
133
136
|
static initialize() {
|
|
134
137
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("TaskService.getTasks.response", zod_1.z
|