@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
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"TaskService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/TaskService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,yCAA0E;AAC1E,wEAAqE;AACrE,mFAAmF;AACnF,MAAa,WAAY,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"TaskService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/TaskService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,yCAA0E;AAC1E,wEAAqE;AACrE,mFAAmF;AACnF,MAAa,WAAY,SAAQ,qCAAiB;IAAlD;;QACE;;;;;;;;;;WAUG;QACH,gBAAW,GAAG,CAAC,EACb,EAAE,EACF,UAAU,GAaX,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,aAAa;gBACnB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,aAAa,EAAE,UAAU;iBAC1B;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,kCAAkC,CAAC,CACtE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,aAAQ,GAAG,CAAC,EACV,UAAU,EACV,iBAAiB,EACjB,MAAM,EACN,MAAM,EACN,OAAO,EACP,MAAM,EACN,UAAU,EACV,SAAS,EACT,UAAU,EACV,WAAW,EACX,aAAa,EACb,WAAW,EACX,SAAS,EACT,OAAO,EACP,eAAe,EACf,aAAa,EACb,MAAM,EACN,KAAK,MAmFH,EAAE,EAOJ,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,QAAQ;gBACd,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,aAAa,EAAE,UAAU;oBACzB,qBAAqB,EAAE,iBAAiB;oBACxC,MAAM;oBACN,SAAS,EAAE,MAAM;oBACjB,UAAU,EAAE,OAAO;oBACnB,SAAS,EAAE,MAAM;oBACjB,aAAa,EAAE,UAAU;oBACzB,YAAY,EAAE,SAAS;oBACvB,aAAa,EAAE,UAAU;oBACzB,cAAc,EAAE,WAAW;oBAC3B,iBAAiB,EAAE,aAAa;oBAChC,eAAe,EAAE,WAAW;oBAC5B,aAAa,EAAE,SAAS;oBACxB,WAAW,EAAE,OAAO;oBACpB,mBAAmB,EAAE,eAAe;oBACpC,iBAAiB,EAAE,aAAa;oBAChC,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,CAAC,iDAAuB,CAAC,SAAS,CAAC,+BAA+B,CAAC,CAAC;iBACxE,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,eAAU,GAAG,CAAC,EACZ,EAAE,EACF,UAAU,EACV,WAAW,GA2CZ,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,aAAa;gBACnB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,aAAa,EAAE,UAAU;iBAC1B;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAAC,iCAAiC,CAAC,CACrE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA4CJ,CAAC;IA3CC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,+BAA+B,EAC/B,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,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;gBACjE,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,+BAA+B,CAAC,CAC7C,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kCAAkC,EAClC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC;SAC3C,CAAC;aACD,QAAQ,CAAC,kCAAkC,CAAC,CAChD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iCAAiC,EACjC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC;SAC3C,CAAC;aACD,QAAQ,CAAC,iCAAiC,CAAC,CAC/C,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,oCAA6B;YAC7B,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA5WD,kCA4WC"}
|
|
@@ -14,18 +14,18 @@ export declare class UserService extends CommonHttpService {
|
|
|
14
14
|
* @scopes-current read:configuration:confluence
|
|
15
15
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-user-access-check-access-by-email-post
|
|
16
16
|
*/
|
|
17
|
-
checkAccessByEmail({ requestBody, }: {
|
|
17
|
+
checkAccessByEmail: ({ requestBody, }: {
|
|
18
18
|
requestBody: {
|
|
19
19
|
/** List of emails to check access to site. */
|
|
20
20
|
emails: string[];
|
|
21
21
|
} & {
|
|
22
22
|
[key: string]: unknown;
|
|
23
23
|
};
|
|
24
|
-
})
|
|
24
|
+
}) => Promise<{
|
|
25
25
|
/** List of emails that do not have access to site. */
|
|
26
|
-
emailsWithoutAccess?: string[];
|
|
26
|
+
emailsWithoutAccess?: string[] | undefined;
|
|
27
27
|
/** List of invalid emails provided in the request. */
|
|
28
|
-
invalidEmails?: string[];
|
|
28
|
+
invalidEmails?: string[] | undefined;
|
|
29
29
|
} & {
|
|
30
30
|
[key: string]: unknown;
|
|
31
31
|
}>;
|
|
@@ -42,16 +42,16 @@ export declare class UserService extends CommonHttpService {
|
|
|
42
42
|
* @scopes-current read:user:confluence
|
|
43
43
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-users-bulk-post
|
|
44
44
|
*/
|
|
45
|
-
createBulkUserLookup({ requestBody, }: {
|
|
45
|
+
createBulkUserLookup: ({ requestBody, }: {
|
|
46
46
|
requestBody: {
|
|
47
47
|
/** List of accountIds to retrieve user info for. */
|
|
48
|
-
|
|
48
|
+
accountIds: string[];
|
|
49
49
|
} & {
|
|
50
50
|
[key: string]: unknown;
|
|
51
51
|
};
|
|
52
|
-
})
|
|
53
|
-
results?: User[];
|
|
54
|
-
_links?: MultiEntityLinks;
|
|
52
|
+
}) => Promise<{
|
|
53
|
+
results?: User[] | undefined;
|
|
54
|
+
_links?: MultiEntityLinks | undefined;
|
|
55
55
|
} & {
|
|
56
56
|
[key: string]: unknown;
|
|
57
57
|
}>;
|
|
@@ -70,13 +70,13 @@ export declare class UserService extends CommonHttpService {
|
|
|
70
70
|
* @scopes-current read:configuration:confluence
|
|
71
71
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-user-access-invite-by-email-post
|
|
72
72
|
*/
|
|
73
|
-
inviteByEmail({ requestBody, }: {
|
|
73
|
+
inviteByEmail: ({ requestBody, }: {
|
|
74
74
|
requestBody: {
|
|
75
75
|
/** List of emails to check access to site. */
|
|
76
76
|
emails: string[];
|
|
77
77
|
} & {
|
|
78
78
|
[key: string]: unknown;
|
|
79
79
|
};
|
|
80
|
-
})
|
|
80
|
+
}) => Promise<void>;
|
|
81
81
|
static initialize(): void;
|
|
82
82
|
}
|
|
@@ -12,94 +12,97 @@ const user_1 = require("../models/user");
|
|
|
12
12
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
13
13
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user */
|
|
14
14
|
class UserService 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
|
-
|
|
15
|
+
constructor() {
|
|
16
|
+
super(...arguments);
|
|
17
|
+
/**
|
|
18
|
+
* Returns the list of emails from the input list that do not have access to site.
|
|
19
|
+
*
|
|
20
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
21
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
22
|
+
*
|
|
23
|
+
* @returns Returns object with list of emails without access to site.
|
|
24
|
+
* @path {POST} /user/access/check-access-by-email
|
|
25
|
+
* @scopes-current read:configuration:confluence
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-user-access-check-access-by-email-post
|
|
27
|
+
*/
|
|
28
|
+
this.checkAccessByEmail = ({ requestBody, }) => {
|
|
29
|
+
return this.getClientInstance()
|
|
30
|
+
.request({
|
|
31
|
+
path: "/user/access/check-access-by-email",
|
|
32
|
+
method: "POST",
|
|
33
|
+
headers: {
|
|
34
|
+
"Content-Type": "application/json",
|
|
35
|
+
},
|
|
36
|
+
body: requestBody,
|
|
37
|
+
})
|
|
38
|
+
.then(this.getClientInstance().responseHandler({
|
|
39
|
+
200: {
|
|
40
|
+
"application/json": "json",
|
|
41
|
+
},
|
|
42
|
+
}))
|
|
43
|
+
.then(commonHttpClient.castResponse())
|
|
44
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("UserService.checkAccessByEmail.response"))
|
|
45
|
+
.then(commonHttpClient.getBody);
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* Returns user details for the ids provided in the request body.
|
|
49
|
+
*
|
|
50
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
51
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
52
|
+
* The user must be able to view user profiles in the Confluence site.
|
|
53
|
+
*
|
|
54
|
+
* @returns Returned if the user info is returned for the account IDs. `results` may be
|
|
55
|
+
* empty if no account IDs were found.
|
|
56
|
+
* @path {POST} /users-bulk
|
|
57
|
+
* @scopes-current read:user:confluence
|
|
58
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-users-bulk-post
|
|
59
|
+
*/
|
|
60
|
+
this.createBulkUserLookup = ({ requestBody, }) => {
|
|
61
|
+
return this.getClientInstance()
|
|
62
|
+
.request({
|
|
63
|
+
path: "/users-bulk",
|
|
64
|
+
method: "POST",
|
|
65
|
+
headers: {
|
|
66
|
+
"Content-Type": "application/json",
|
|
67
|
+
},
|
|
68
|
+
body: requestBody,
|
|
69
|
+
})
|
|
70
|
+
.then(this.getClientInstance().responseHandler({
|
|
71
|
+
200: {
|
|
72
|
+
"application/json": "json",
|
|
73
|
+
},
|
|
74
|
+
}))
|
|
75
|
+
.then(commonHttpClient.castResponse())
|
|
76
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("UserService.createBulkUserLookup.response"))
|
|
77
|
+
.then(commonHttpClient.getBody);
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Invite a list of emails to the site.
|
|
81
|
+
*
|
|
82
|
+
* Ignores all invalid emails and no action is taken for the emails that already
|
|
83
|
+
* have access to the site.
|
|
84
|
+
*
|
|
85
|
+
* <b>NOTE:</b> This API is asynchronous and may take some time to complete.
|
|
86
|
+
*
|
|
87
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
88
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
89
|
+
*
|
|
90
|
+
* @path {POST} /user/access/invite-by-email
|
|
91
|
+
* @scopes-current read:configuration:confluence
|
|
92
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-user#api-user-access-invite-by-email-post
|
|
93
|
+
*/
|
|
94
|
+
this.inviteByEmail = ({ requestBody, }) => {
|
|
95
|
+
return this.getClientInstance()
|
|
96
|
+
.request({
|
|
97
|
+
path: "/user/access/invite-by-email",
|
|
98
|
+
method: "POST",
|
|
99
|
+
headers: {
|
|
100
|
+
"Content-Type": "application/json",
|
|
101
|
+
},
|
|
102
|
+
body: requestBody,
|
|
103
|
+
})
|
|
104
|
+
.then(commonHttpClient.discardResult);
|
|
105
|
+
};
|
|
103
106
|
}
|
|
104
107
|
static initialize() {
|
|
105
108
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("UserService.checkAccessByEmail.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/UserService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,yCAA0E;AAC1E,wEAAqE;AACrE,mFAAmF;AACnF,MAAa,WAAY,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"UserService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/UserService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,yCAA0E;AAC1E,wEAAqE;AACrE,mFAAmF;AACnF,MAAa,WAAY,SAAQ,qCAAiB;IAAlD;;QACE;;;;;;;;;;WAUG;QACH,uBAAkB,GAAG,CAAC,EACpB,WAAW,GAQZ,EASC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oCAAoC;gBAC1C,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yCAAyC,CAC1C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,yBAAoB,GAAG,CAAC,EACtB,WAAW,GAQZ,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,aAAa;gBACnB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,2CAA2C,CAC5C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,kBAAa,GAAG,CAAC,EACf,WAAW,GAQZ,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,8BAA8B;gBACpC,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;IAuCJ,CAAC;IAtCC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,yCAAyC,EACzC,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,mBAAmB,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;gBACnD,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;aAC9C,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,yCAAyC,CAAC,CACvD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,2CAA2C,EAC3C,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,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE;gBACjE,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,2CAA2C,CAAC,CACzD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,oCAA6B;YAC7B,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA7MD,kCA6MC"}
|
|
@@ -14,12 +14,12 @@ export declare class VersionService extends CommonHttpService {
|
|
|
14
14
|
* @scopes-current read:attachment:confluence
|
|
15
15
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-attachments-attachment-id-versions-version-number-get
|
|
16
16
|
*/
|
|
17
|
-
getAttachmentVersionDetails({ attachmentId, versionNumber, }: {
|
|
17
|
+
getAttachmentVersionDetails: ({ attachmentId, versionNumber, }: {
|
|
18
18
|
/** The ID of the attachment for which version details should be returned. */
|
|
19
19
|
attachmentId: string;
|
|
20
20
|
/** The version number of the attachment to be returned. */
|
|
21
21
|
versionNumber: number;
|
|
22
|
-
})
|
|
22
|
+
}) => Promise<DetailedVersion>;
|
|
23
23
|
/**
|
|
24
24
|
* Returns the versions of specific attachment.
|
|
25
25
|
*
|
|
@@ -31,7 +31,7 @@ export declare class VersionService extends CommonHttpService {
|
|
|
31
31
|
* @scopes-current read:attachment:confluence
|
|
32
32
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-attachments-id-versions-get
|
|
33
33
|
*/
|
|
34
|
-
getAttachmentVersions({ id, cursor, limit, sort, }: {
|
|
34
|
+
getAttachmentVersions: ({ id, cursor, limit, sort, }: {
|
|
35
35
|
/**
|
|
36
36
|
* The ID of the attachment to be queried for its versions. If you don't know the
|
|
37
37
|
* attachment ID, use Get attachments and filter the results.
|
|
@@ -42,18 +42,18 @@ export declare class VersionService extends CommonHttpService {
|
|
|
42
42
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
43
43
|
* retrieve the `next` set of results.
|
|
44
44
|
*/
|
|
45
|
-
cursor?: string;
|
|
45
|
+
cursor?: string | undefined;
|
|
46
46
|
/**
|
|
47
47
|
* Maximum number of versions per result to return. If more results exist, use the
|
|
48
48
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
49
49
|
* results.
|
|
50
50
|
*/
|
|
51
|
-
limit?: number;
|
|
51
|
+
limit?: number | undefined;
|
|
52
52
|
/** Used to sort the result by a particular field. */
|
|
53
|
-
sort?: VersionSortOrder;
|
|
54
|
-
})
|
|
55
|
-
results?: AttachmentVersion[];
|
|
56
|
-
_links?: MultiEntityLinks;
|
|
53
|
+
sort?: VersionSortOrder | undefined;
|
|
54
|
+
}) => Promise<{
|
|
55
|
+
results?: AttachmentVersion[] | undefined;
|
|
56
|
+
_links?: MultiEntityLinks | undefined;
|
|
57
57
|
} & {
|
|
58
58
|
[key: string]: unknown;
|
|
59
59
|
}>;
|
|
@@ -68,12 +68,12 @@ export declare class VersionService extends CommonHttpService {
|
|
|
68
68
|
* @scopes-current read:page:confluence
|
|
69
69
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-blogposts-blogpost-id-versions-version-number-get
|
|
70
70
|
*/
|
|
71
|
-
getBlogPostVersionDetails({ blogpostId, versionNumber, }: {
|
|
71
|
+
getBlogPostVersionDetails: ({ blogpostId, versionNumber, }: {
|
|
72
72
|
/** The ID of the blog post for which version details should be returned. */
|
|
73
73
|
blogpostId: number;
|
|
74
74
|
/** The version number of the blog post to be returned. */
|
|
75
75
|
versionNumber: number;
|
|
76
|
-
})
|
|
76
|
+
}) => Promise<DetailedVersion>;
|
|
77
77
|
/**
|
|
78
78
|
* Returns the versions of specific blog post.
|
|
79
79
|
*
|
|
@@ -85,7 +85,7 @@ export declare class VersionService extends CommonHttpService {
|
|
|
85
85
|
* @scopes-current read:page:confluence
|
|
86
86
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-blogposts-id-versions-get
|
|
87
87
|
*/
|
|
88
|
-
getBlogPostVersions({ id, bodyFormat, cursor, limit, sort, }: {
|
|
88
|
+
getBlogPostVersions: ({ id, bodyFormat, cursor, limit, sort, }: {
|
|
89
89
|
/**
|
|
90
90
|
* The ID of the blog post to be queried for its versions. If you don't know the
|
|
91
91
|
* blog post ID, use Get blog posts and filter the results.
|
|
@@ -96,24 +96,24 @@ export declare class VersionService extends CommonHttpService {
|
|
|
96
96
|
* available, the representation will be available under a response field of the
|
|
97
97
|
* same name under the `body` field.
|
|
98
98
|
*/
|
|
99
|
-
bodyFormat?: PrimaryBodyRepresentation;
|
|
99
|
+
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
100
100
|
/**
|
|
101
101
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
102
102
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
103
103
|
* retrieve the `next` set of results.
|
|
104
104
|
*/
|
|
105
|
-
cursor?: string;
|
|
105
|
+
cursor?: string | undefined;
|
|
106
106
|
/**
|
|
107
107
|
* Maximum number of versions per result to return. If more results exist, use the
|
|
108
108
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
109
109
|
* results.
|
|
110
110
|
*/
|
|
111
|
-
limit?: number;
|
|
111
|
+
limit?: number | undefined;
|
|
112
112
|
/** Used to sort the result by a particular field. */
|
|
113
|
-
sort?: VersionSortOrder;
|
|
114
|
-
})
|
|
115
|
-
results?: BlogPostVersion[];
|
|
116
|
-
_links?: MultiEntityLinks;
|
|
113
|
+
sort?: VersionSortOrder | undefined;
|
|
114
|
+
}) => Promise<{
|
|
115
|
+
results?: BlogPostVersion[] | undefined;
|
|
116
|
+
_links?: MultiEntityLinks | undefined;
|
|
117
117
|
} & {
|
|
118
118
|
[key: string]: unknown;
|
|
119
119
|
}>;
|
|
@@ -128,12 +128,12 @@ export declare class VersionService extends CommonHttpService {
|
|
|
128
128
|
* @scopes-current read:custom-content:confluence
|
|
129
129
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-custom-content-custom-content-id-versions-version-number-get
|
|
130
130
|
*/
|
|
131
|
-
getCustomContentVersionDetails({ customContentId, versionNumber, }: {
|
|
131
|
+
getCustomContentVersionDetails: ({ customContentId, versionNumber, }: {
|
|
132
132
|
/** The ID of the custom content for which version details should be returned. */
|
|
133
133
|
customContentId: number;
|
|
134
134
|
/** The version number of the custom content to be returned. */
|
|
135
135
|
versionNumber: number;
|
|
136
|
-
})
|
|
136
|
+
}) => Promise<DetailedVersion>;
|
|
137
137
|
/**
|
|
138
138
|
* Returns the versions of specific custom content.
|
|
139
139
|
*
|
|
@@ -145,7 +145,7 @@ export declare class VersionService extends CommonHttpService {
|
|
|
145
145
|
* @scopes-current read:custom-content:confluence
|
|
146
146
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-custom-content-custom-content-id-versions-get
|
|
147
147
|
*/
|
|
148
|
-
getCustomContentVersions({ customContentId, bodyFormat, cursor, limit, sort, }: {
|
|
148
|
+
getCustomContentVersions: ({ customContentId, bodyFormat, cursor, limit, sort, }: {
|
|
149
149
|
/**
|
|
150
150
|
* The ID of the custom content to be queried for its versions. If you don't know
|
|
151
151
|
* the custom content ID, use Get custom-content by type and filter the results.
|
|
@@ -160,24 +160,24 @@ export declare class VersionService extends CommonHttpService {
|
|
|
160
160
|
* `atlas_doc_format` body formats are able to be returned. If the custom content
|
|
161
161
|
* body type is `raw`, only the `raw` body format is able to be returned.
|
|
162
162
|
*/
|
|
163
|
-
bodyFormat?: CustomContentBodyRepresentation;
|
|
163
|
+
bodyFormat?: CustomContentBodyRepresentation | undefined;
|
|
164
164
|
/**
|
|
165
165
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
166
166
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
167
167
|
* retrieve the `next` set of results.
|
|
168
168
|
*/
|
|
169
|
-
cursor?: string;
|
|
169
|
+
cursor?: string | undefined;
|
|
170
170
|
/**
|
|
171
171
|
* Maximum number of versions per result to return. If more results exist, use the
|
|
172
172
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
173
173
|
* results.
|
|
174
174
|
*/
|
|
175
|
-
limit?: number;
|
|
175
|
+
limit?: number | undefined;
|
|
176
176
|
/** Used to sort the result by a particular field. */
|
|
177
|
-
sort?: VersionSortOrder;
|
|
178
|
-
})
|
|
179
|
-
results?: CustomContentVersion[];
|
|
180
|
-
_links?: MultiEntityLinks;
|
|
177
|
+
sort?: VersionSortOrder | undefined;
|
|
178
|
+
}) => Promise<{
|
|
179
|
+
results?: CustomContentVersion[] | undefined;
|
|
180
|
+
_links?: MultiEntityLinks | undefined;
|
|
181
181
|
} & {
|
|
182
182
|
[key: string]: unknown;
|
|
183
183
|
}>;
|
|
@@ -193,12 +193,12 @@ export declare class VersionService extends CommonHttpService {
|
|
|
193
193
|
* @scopes-current read:comment:confluence
|
|
194
194
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-footer-comments-id-versions-version-number-get
|
|
195
195
|
*/
|
|
196
|
-
getFooterCommentVersionDetails({ id, versionNumber, }: {
|
|
196
|
+
getFooterCommentVersionDetails: ({ id, versionNumber, }: {
|
|
197
197
|
/** The ID of the footer comment for which version details should be returned. */
|
|
198
198
|
id: number;
|
|
199
199
|
/** The version number of the footer comment to be returned. */
|
|
200
200
|
versionNumber: number;
|
|
201
|
-
})
|
|
201
|
+
}) => Promise<DetailedVersion>;
|
|
202
202
|
/**
|
|
203
203
|
* Retrieves the versions of the specified footer comment.
|
|
204
204
|
*
|
|
@@ -211,7 +211,7 @@ export declare class VersionService extends CommonHttpService {
|
|
|
211
211
|
* @scopes-current read:comment:confluence
|
|
212
212
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-footer-comments-id-versions-get
|
|
213
213
|
*/
|
|
214
|
-
getFooterCommentVersions({ id, bodyFormat, cursor, limit, sort, }: {
|
|
214
|
+
getFooterCommentVersions: ({ id, bodyFormat, cursor, limit, sort, }: {
|
|
215
215
|
/** The ID of the footer comment for which versions should be returned */
|
|
216
216
|
id: number;
|
|
217
217
|
/**
|
|
@@ -219,24 +219,24 @@ export declare class VersionService extends CommonHttpService {
|
|
|
219
219
|
* available, the representation will be available under a response field of the
|
|
220
220
|
* same name under the `body` field.
|
|
221
221
|
*/
|
|
222
|
-
bodyFormat?: PrimaryBodyRepresentation;
|
|
222
|
+
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
223
223
|
/**
|
|
224
224
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
225
225
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
226
226
|
* retrieve the `next` set of results.
|
|
227
227
|
*/
|
|
228
|
-
cursor?: string;
|
|
228
|
+
cursor?: string | undefined;
|
|
229
229
|
/**
|
|
230
230
|
* Maximum number of versions per result to return. If more results exist, use the
|
|
231
231
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
232
232
|
* results.
|
|
233
233
|
*/
|
|
234
|
-
limit?: number;
|
|
234
|
+
limit?: number | undefined;
|
|
235
235
|
/** Used to sort the result by a particular field. */
|
|
236
|
-
sort?: VersionSortOrder;
|
|
237
|
-
})
|
|
238
|
-
results?: CommentVersion[];
|
|
239
|
-
_links?: MultiEntityLinks;
|
|
236
|
+
sort?: VersionSortOrder | undefined;
|
|
237
|
+
}) => Promise<{
|
|
238
|
+
results?: CommentVersion[] | undefined;
|
|
239
|
+
_links?: MultiEntityLinks | undefined;
|
|
240
240
|
} & {
|
|
241
241
|
[key: string]: unknown;
|
|
242
242
|
}>;
|
|
@@ -252,12 +252,12 @@ export declare class VersionService extends CommonHttpService {
|
|
|
252
252
|
* @scopes-current read:comment:confluence
|
|
253
253
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-inline-comments-id-versions-version-number-get
|
|
254
254
|
*/
|
|
255
|
-
getInlineCommentVersionDetails({ id, versionNumber, }: {
|
|
255
|
+
getInlineCommentVersionDetails: ({ id, versionNumber, }: {
|
|
256
256
|
/** The ID of the inline comment for which version details should be returned. */
|
|
257
257
|
id: number;
|
|
258
258
|
/** The version number of the inline comment to be returned. */
|
|
259
259
|
versionNumber: number;
|
|
260
|
-
})
|
|
260
|
+
}) => Promise<DetailedVersion>;
|
|
261
261
|
/**
|
|
262
262
|
* Retrieves the versions of the specified inline comment.
|
|
263
263
|
*
|
|
@@ -270,7 +270,7 @@ export declare class VersionService extends CommonHttpService {
|
|
|
270
270
|
* @scopes-current read:comment:confluence
|
|
271
271
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-inline-comments-id-versions-get
|
|
272
272
|
*/
|
|
273
|
-
getInlineCommentVersions({ id, bodyFormat, cursor, limit, sort, }: {
|
|
273
|
+
getInlineCommentVersions: ({ id, bodyFormat, cursor, limit, sort, }: {
|
|
274
274
|
/** The ID of the inline comment for which versions should be returned */
|
|
275
275
|
id: number;
|
|
276
276
|
/**
|
|
@@ -278,24 +278,24 @@ export declare class VersionService extends CommonHttpService {
|
|
|
278
278
|
* available, the representation will be available under a response field of the
|
|
279
279
|
* same name under the `body` field.
|
|
280
280
|
*/
|
|
281
|
-
bodyFormat?: PrimaryBodyRepresentation;
|
|
281
|
+
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
282
282
|
/**
|
|
283
283
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
284
284
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
285
285
|
* retrieve the `next` set of results.
|
|
286
286
|
*/
|
|
287
|
-
cursor?: string;
|
|
287
|
+
cursor?: string | undefined;
|
|
288
288
|
/**
|
|
289
289
|
* Maximum number of versions per result to return. If more results exist, use the
|
|
290
290
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
291
291
|
* results.
|
|
292
292
|
*/
|
|
293
|
-
limit?: number;
|
|
293
|
+
limit?: number | undefined;
|
|
294
294
|
/** Used to sort the result by a particular field. */
|
|
295
|
-
sort?: VersionSortOrder;
|
|
296
|
-
})
|
|
297
|
-
results?: CommentVersion[];
|
|
298
|
-
_links?: MultiEntityLinks;
|
|
295
|
+
sort?: VersionSortOrder | undefined;
|
|
296
|
+
}) => Promise<{
|
|
297
|
+
results?: CommentVersion[] | undefined;
|
|
298
|
+
_links?: MultiEntityLinks | undefined;
|
|
299
299
|
} & {
|
|
300
300
|
[key: string]: unknown;
|
|
301
301
|
}>;
|
|
@@ -310,12 +310,12 @@ export declare class VersionService extends CommonHttpService {
|
|
|
310
310
|
* @scopes-current read:page:confluence
|
|
311
311
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-pages-page-id-versions-version-number-get
|
|
312
312
|
*/
|
|
313
|
-
getPageVersionDetails({ pageId, versionNumber, }: {
|
|
313
|
+
getPageVersionDetails: ({ pageId, versionNumber, }: {
|
|
314
314
|
/** The ID of the page for which version details should be returned. */
|
|
315
315
|
pageId: number;
|
|
316
316
|
/** The version number of the page to be returned. */
|
|
317
317
|
versionNumber: number;
|
|
318
|
-
})
|
|
318
|
+
}) => Promise<DetailedVersion>;
|
|
319
319
|
/**
|
|
320
320
|
* Returns the versions of specific page.
|
|
321
321
|
*
|
|
@@ -327,7 +327,7 @@ export declare class VersionService extends CommonHttpService {
|
|
|
327
327
|
* @scopes-current read:page:confluence
|
|
328
328
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-pages-id-versions-get
|
|
329
329
|
*/
|
|
330
|
-
getPageVersions({ id, bodyFormat, cursor, limit, sort, }: {
|
|
330
|
+
getPageVersions: ({ id, bodyFormat, cursor, limit, sort, }: {
|
|
331
331
|
/**
|
|
332
332
|
* The ID of the page to be queried for its versions. If you don't know the page
|
|
333
333
|
* ID, use Get pages and filter the results.
|
|
@@ -338,24 +338,24 @@ export declare class VersionService extends CommonHttpService {
|
|
|
338
338
|
* available, the representation will be available under a response field of the
|
|
339
339
|
* same name under the `body` field.
|
|
340
340
|
*/
|
|
341
|
-
bodyFormat?: PrimaryBodyRepresentation;
|
|
341
|
+
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
342
342
|
/**
|
|
343
343
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
344
344
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
345
345
|
* retrieve the `next` set of results.
|
|
346
346
|
*/
|
|
347
|
-
cursor?: string;
|
|
347
|
+
cursor?: string | undefined;
|
|
348
348
|
/**
|
|
349
349
|
* Maximum number of versions per result to return. If more results exist, use the
|
|
350
350
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
351
351
|
* results.
|
|
352
352
|
*/
|
|
353
|
-
limit?: number;
|
|
353
|
+
limit?: number | undefined;
|
|
354
354
|
/** Used to sort the result by a particular field. */
|
|
355
|
-
sort?: VersionSortOrder;
|
|
356
|
-
})
|
|
357
|
-
results?: PageVersion[];
|
|
358
|
-
_links?: MultiEntityLinks;
|
|
355
|
+
sort?: VersionSortOrder | undefined;
|
|
356
|
+
}) => Promise<{
|
|
357
|
+
results?: PageVersion[] | undefined;
|
|
358
|
+
_links?: MultiEntityLinks | undefined;
|
|
359
359
|
} & {
|
|
360
360
|
[key: string]: unknown;
|
|
361
361
|
}>;
|