@resolution/confluence-api-client 0.4.4 → 0.4.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +60 -1
- package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +32 -33
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js +151 -88
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
- package/lib/openapi/v1/core/CommonHttpService.d.ts +2 -0
- package/lib/openapi/v1/core/CommonHttpService.js +9 -0
- package/lib/openapi/v1/core/CommonHttpService.js.map +1 -1
- package/lib/openapi/v1/services/AnalyticsService.d.ts +10 -10
- package/lib/openapi/v1/services/AnalyticsService.js +62 -59
- package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
- package/lib/openapi/v1/services/AuditService.d.ts +25 -25
- package/lib/openapi/v1/services/AuditService.js +205 -202
- package/lib/openapi/v1/services/AuditService.js.map +1 -1
- package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +20 -20
- package/lib/openapi/v1/services/ContentAttachmentsService.js +317 -314
- package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentBodyService.d.ts +15 -15
- package/lib/openapi/v1/services/ContentBodyService.js +140 -137
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +27 -27
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +391 -388
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentCommentsService.d.ts +8 -8
- package/lib/openapi/v1/services/ContentCommentsService.js +49 -46
- package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentLabelsService.d.ts +11 -11
- package/lib/openapi/v1/services/ContentLabelsService.js +150 -147
- package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +13 -13
- package/lib/openapi/v1/services/ContentMacroBodyService.js +155 -152
- package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -2
- package/lib/openapi/v1/services/ContentPermissionsService.js +48 -45
- package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPropertiesService.d.ts +18 -18
- package/lib/openapi/v1/services/ContentPropertiesService.js +237 -234
- package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +49 -49
- package/lib/openapi/v1/services/ContentRestrictionsService.js +505 -502
- package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentService.d.ts +50 -50
- package/lib/openapi/v1/services/ContentService.js +475 -472
- package/lib/openapi/v1/services/ContentService.js.map +1 -1
- package/lib/openapi/v1/services/ContentStatesService.d.ts +25 -25
- package/lib/openapi/v1/services/ContentStatesService.js +359 -356
- package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentVersionsService.d.ts +13 -13
- package/lib/openapi/v1/services/ContentVersionsService.js +144 -141
- package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentWatchesService.d.ts +57 -57
- package/lib/openapi/v1/services/ContentWatchesService.js +454 -451
- package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
- package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -5
- package/lib/openapi/v1/services/DynamicModulesService.js +70 -67
- package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
- package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -12
- package/lib/openapi/v1/services/ExperimentalService.js +151 -148
- package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
- package/lib/openapi/v1/services/GroupService.d.ts +52 -52
- package/lib/openapi/v1/services/GroupService.js +445 -442
- package/lib/openapi/v1/services/GroupService.js.map +1 -1
- package/lib/openapi/v1/services/InlineTasksService.d.ts +20 -20
- package/lib/openapi/v1/services/InlineTasksService.js +118 -115
- package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
- package/lib/openapi/v1/services/LabelInfoService.d.ts +5 -5
- package/lib/openapi/v1/services/LabelInfoService.js +37 -34
- package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
- package/lib/openapi/v1/services/LongRunningTaskService.d.ts +8 -6
- package/lib/openapi/v1/services/LongRunningTaskService.js +67 -63
- package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
- package/lib/openapi/v1/services/RelationService.d.ts +37 -37
- package/lib/openapi/v1/services/RelationService.js +231 -228
- package/lib/openapi/v1/services/RelationService.js.map +1 -1
- package/lib/openapi/v1/services/SearchService.d.ts +20 -20
- package/lib/openapi/v1/services/SearchService.js +136 -133
- package/lib/openapi/v1/services/SearchService.js.map +1 -1
- package/lib/openapi/v1/services/SettingsService.d.ts +15 -15
- package/lib/openapi/v1/services/SettingsService.js +204 -201
- package/lib/openapi/v1/services/SettingsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -6
- package/lib/openapi/v1/services/SpacePermissionsService.js +99 -96
- package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePropertiesService.d.ts +16 -16
- package/lib/openapi/v1/services/SpacePropertiesService.js +227 -224
- package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceService.d.ts +38 -38
- package/lib/openapi/v1/services/SpaceService.js +320 -317
- package/lib/openapi/v1/services/SpaceService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -4
- package/lib/openapi/v1/services/SpaceSettingsService.js +68 -65
- package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
- package/lib/openapi/v1/services/TemplateService.d.ts +20 -20
- package/lib/openapi/v1/services/TemplateService.js +214 -211
- package/lib/openapi/v1/services/TemplateService.js.map +1 -1
- package/lib/openapi/v1/services/ThemesService.d.ts +13 -13
- package/lib/openapi/v1/services/ThemesService.js +179 -176
- package/lib/openapi/v1/services/ThemesService.js.map +1 -1
- package/lib/openapi/v1/services/UserPropertiesService.d.ts +12 -12
- package/lib/openapi/v1/services/UserPropertiesService.js +165 -162
- package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/UsersService.d.ts +21 -21
- package/lib/openapi/v1/services/UsersService.js +229 -226
- package/lib/openapi/v1/services/UsersService.js.map +1 -1
- package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +23 -24
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js +92 -47
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
- package/lib/openapi/v2/core/CommonHttpService.d.ts +2 -0
- package/lib/openapi/v2/core/CommonHttpService.js +9 -0
- package/lib/openapi/v2/core/CommonHttpService.js.map +1 -1
- package/lib/openapi/v2/models/user.d.ts +0 -2
- package/lib/openapi/v2/models/user.js +0 -2
- package/lib/openapi/v2/models/user.js.map +1 -1
- package/lib/openapi/v2/services/AncestorsService.d.ts +17 -17
- package/lib/openapi/v2/services/AncestorsService.js +174 -171
- package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
- package/lib/openapi/v2/services/AttachmentService.d.ts +62 -62
- package/lib/openapi/v2/services/AttachmentService.js +261 -258
- package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
- package/lib/openapi/v2/services/BlogPostService.d.ts +70 -70
- package/lib/openapi/v2/services/BlogPostService.js +270 -267
- package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
- package/lib/openapi/v2/services/ChildrenService.d.ts +14 -14
- package/lib/openapi/v2/services/ChildrenService.js +77 -74
- package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
- package/lib/openapi/v2/services/ClassificationLevelService.d.ts +21 -21
- package/lib/openapi/v2/services/ClassificationLevelService.js +304 -301
- package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
- package/lib/openapi/v2/services/CommentService.d.ts +136 -136
- package/lib/openapi/v2/services/CommentService.js +635 -632
- package/lib/openapi/v2/services/CommentService.js.map +1 -1
- package/lib/openapi/v2/services/ContentPropertiesService.d.ts +128 -128
- package/lib/openapi/v2/services/ContentPropertiesService.js +1242 -1239
- package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/ContentService.d.ts +2 -2
- package/lib/openapi/v2/services/ContentService.js +40 -37
- package/lib/openapi/v2/services/ContentService.js.map +1 -1
- package/lib/openapi/v2/services/CustomContentService.d.ts +72 -72
- package/lib/openapi/v2/services/CustomContentService.js +299 -296
- package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
- package/lib/openapi/v2/services/DataPoliciesService.d.ts +10 -10
- package/lib/openapi/v2/services/DataPoliciesService.js +67 -64
- package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
- package/lib/openapi/v2/services/DatabaseService.d.ts +17 -17
- package/lib/openapi/v2/services/DatabaseService.js +90 -87
- package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
- package/lib/openapi/v2/services/LabelService.d.ts +57 -57
- package/lib/openapi/v2/services/LabelService.js +263 -260
- package/lib/openapi/v2/services/LabelService.js.map +1 -1
- package/lib/openapi/v2/services/LikeService.d.ts +36 -36
- package/lib/openapi/v2/services/LikeService.js +250 -247
- package/lib/openapi/v2/services/LikeService.js.map +1 -1
- package/lib/openapi/v2/services/OperationService.d.ts +20 -20
- package/lib/openapi/v2/services/OperationService.js +298 -295
- package/lib/openapi/v2/services/OperationService.js.map +1 -1
- package/lib/openapi/v2/services/PageService.d.ts +73 -73
- package/lib/openapi/v2/services/PageService.js +272 -269
- package/lib/openapi/v2/services/PageService.js.map +1 -1
- package/lib/openapi/v2/services/SmartLinkService.d.ts +19 -17
- package/lib/openapi/v2/services/SmartLinkService.js +92 -89
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePermissionsService.d.ts +6 -6
- package/lib/openapi/v2/services/SpacePermissionsService.js +35 -32
- package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePropertiesService.d.ts +15 -15
- package/lib/openapi/v2/services/SpacePropertiesService.js +165 -162
- package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/SpaceService.d.ts +28 -28
- package/lib/openapi/v2/services/SpaceService.js +83 -80
- package/lib/openapi/v2/services/SpaceService.js.map +1 -1
- package/lib/openapi/v2/services/TaskService.d.ts +40 -40
- package/lib/openapi/v2/services/TaskService.js +120 -117
- package/lib/openapi/v2/services/TaskService.js.map +1 -1
- package/lib/openapi/v2/services/UserService.d.ts +11 -11
- package/lib/openapi/v2/services/UserService.js +91 -88
- package/lib/openapi/v2/services/UserService.js.map +1 -1
- package/lib/openapi/v2/services/VersionService.d.ts +59 -59
- package/lib/openapi/v2/services/VersionService.js +395 -392
- package/lib/openapi/v2/services/VersionService.js.map +1 -1
- package/lib/openapi/v2/services/WhiteboardService.d.ts +17 -17
- package/lib/openapi/v2/services/WhiteboardService.js +90 -87
- package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
- package/package.json +4 -3
|
@@ -14,32 +14,34 @@ export declare class SmartLinkService extends CommonHttpService {
|
|
|
14
14
|
* @scopes-current write:embed:confluence
|
|
15
15
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-post
|
|
16
16
|
*/
|
|
17
|
-
createSmartLink({ private: privateQuery, requestBody, }: {
|
|
17
|
+
createSmartLink: ({ private: privateQuery, requestBody, }: {
|
|
18
18
|
/**
|
|
19
19
|
* The Smart Link will be private. Only the user who creates this Smart Link in
|
|
20
20
|
* the content tree will have permission to view and edit one.
|
|
21
21
|
*/
|
|
22
|
-
private?: boolean;
|
|
22
|
+
private?: boolean | undefined;
|
|
23
23
|
requestBody: {
|
|
24
24
|
/** ID of the space. */
|
|
25
25
|
spaceId: string;
|
|
26
26
|
/** Title of the Smart Link in the content tree. */
|
|
27
|
-
title?: string;
|
|
27
|
+
title?: string | undefined;
|
|
28
28
|
/** The parent content ID of the Smart Link in the content tree. */
|
|
29
|
-
parentId?: string;
|
|
29
|
+
parentId?: string | undefined;
|
|
30
|
+
/** The URL that the Smart Link in the content tree should be populated with. */
|
|
31
|
+
embedUrl?: string | undefined;
|
|
30
32
|
} & {
|
|
31
33
|
[key: string]: unknown;
|
|
32
34
|
};
|
|
33
|
-
})
|
|
34
|
-
_links?: {
|
|
35
|
+
}) => Promise<SmartLinkSingle & {
|
|
36
|
+
_links?: ({
|
|
35
37
|
/** Base url of the Confluence site. */
|
|
36
|
-
base?: string;
|
|
38
|
+
base?: string | undefined;
|
|
37
39
|
} & {
|
|
38
40
|
[key: string]: unknown;
|
|
39
|
-
};
|
|
41
|
+
}) | undefined;
|
|
40
42
|
} & {
|
|
41
43
|
[key: string]: unknown;
|
|
42
|
-
}
|
|
44
|
+
}>;
|
|
43
45
|
/**
|
|
44
46
|
* Delete a Smart Link in the content tree by id.
|
|
45
47
|
*
|
|
@@ -55,10 +57,10 @@ export declare class SmartLinkService extends CommonHttpService {
|
|
|
55
57
|
* @scopes-current delete:embed:confluence
|
|
56
58
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-id-delete
|
|
57
59
|
*/
|
|
58
|
-
deleteSmartLink({ id, }: {
|
|
60
|
+
deleteSmartLink: ({ id, }: {
|
|
59
61
|
/** The ID of the Smart Link in the content tree to be deleted. */
|
|
60
62
|
id: number;
|
|
61
|
-
})
|
|
63
|
+
}) => Promise<void>;
|
|
62
64
|
/**
|
|
63
65
|
* Returns a specific Smart Link in the content tree.
|
|
64
66
|
*
|
|
@@ -71,18 +73,18 @@ export declare class SmartLinkService extends CommonHttpService {
|
|
|
71
73
|
* @scopes-current read:embed:confluence
|
|
72
74
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-id-get
|
|
73
75
|
*/
|
|
74
|
-
getSmartLinkById({ id, }: {
|
|
76
|
+
getSmartLinkById: ({ id, }: {
|
|
75
77
|
/** The ID of the Smart Link in the content tree to be returned. */
|
|
76
78
|
id: number;
|
|
77
|
-
})
|
|
78
|
-
_links?: {
|
|
79
|
+
}) => Promise<SmartLinkSingle & {
|
|
80
|
+
_links?: ({
|
|
79
81
|
/** Base url of the Confluence site. */
|
|
80
|
-
base?: string;
|
|
82
|
+
base?: string | undefined;
|
|
81
83
|
} & {
|
|
82
84
|
[key: string]: unknown;
|
|
83
|
-
};
|
|
85
|
+
}) | undefined;
|
|
84
86
|
} & {
|
|
85
87
|
[key: string]: unknown;
|
|
86
|
-
}
|
|
88
|
+
}>;
|
|
87
89
|
static initialize(): void;
|
|
88
90
|
}
|
|
@@ -11,95 +11,98 @@ const smartLink_1 = require("../models/smartLink");
|
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
12
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link */
|
|
13
13
|
class SmartLinkService extends CommonHttpService_1.CommonHttpService {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
/**
|
|
17
|
+
* Creates a Smart Link in the content tree in the space.
|
|
18
|
+
*
|
|
19
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
20
|
+
* Permission to view the corresponding space. Permission to create a Smart Link
|
|
21
|
+
* in the content tree in the space.
|
|
22
|
+
*
|
|
23
|
+
* @returns Returned if the Smart Link was successfully created in the content tree.
|
|
24
|
+
* @path {POST} /embeds
|
|
25
|
+
* @scopes-current write:embed:confluence
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-post
|
|
27
|
+
*/
|
|
28
|
+
this.createSmartLink = ({ private: privateQuery, requestBody, }) => {
|
|
29
|
+
return this.getClientInstance()
|
|
30
|
+
.request({
|
|
31
|
+
path: "/embeds",
|
|
32
|
+
method: "POST",
|
|
33
|
+
query: {
|
|
34
|
+
private: privateQuery,
|
|
35
|
+
},
|
|
36
|
+
headers: {
|
|
37
|
+
"Content-Type": "application/json",
|
|
38
|
+
},
|
|
39
|
+
body: requestBody,
|
|
40
|
+
})
|
|
41
|
+
.then(this.getClientInstance().responseHandler({
|
|
42
|
+
200: {
|
|
43
|
+
"application/json": "json",
|
|
44
|
+
},
|
|
45
|
+
}))
|
|
46
|
+
.then(commonHttpClient.castResponse())
|
|
47
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SmartLinkService.createSmartLink.response"))
|
|
48
|
+
.then(commonHttpClient.getBody);
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* Delete a Smart Link in the content tree by id.
|
|
52
|
+
*
|
|
53
|
+
* Deleting a Smart Link in the content tree moves the Smart Link to the trash,
|
|
54
|
+
* where it can be restored later
|
|
55
|
+
*
|
|
56
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
57
|
+
* Permission to view the Smart Link in the content tree and its corresponding
|
|
58
|
+
* space.
|
|
59
|
+
* Permission to delete Smart Links in the content tree in the space.
|
|
60
|
+
*
|
|
61
|
+
* @path {DELETE} /embeds/{id}
|
|
62
|
+
* @scopes-current delete:embed:confluence
|
|
63
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-id-delete
|
|
64
|
+
*/
|
|
65
|
+
this.deleteSmartLink = ({ id, }) => {
|
|
66
|
+
return this.getClientInstance()
|
|
67
|
+
.request({
|
|
68
|
+
path: "/embeds/{id}",
|
|
69
|
+
method: "DELETE",
|
|
70
|
+
pathParams: {
|
|
71
|
+
id,
|
|
72
|
+
},
|
|
73
|
+
})
|
|
74
|
+
.then(commonHttpClient.discardResult);
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* Returns a specific Smart Link in the content tree.
|
|
78
|
+
*
|
|
79
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
80
|
+
* Permission to view the Smart Link in the content tree and its corresponding
|
|
81
|
+
* space.
|
|
82
|
+
*
|
|
83
|
+
* @returns Returned if the requested Smart Link in the content tree is returned.
|
|
84
|
+
* @path {GET} /embeds/{id}
|
|
85
|
+
* @scopes-current read:embed:confluence
|
|
86
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link#api-embeds-id-get
|
|
87
|
+
*/
|
|
88
|
+
this.getSmartLinkById = ({ id, }) => {
|
|
89
|
+
return this.getClientInstance()
|
|
90
|
+
.request({
|
|
91
|
+
path: "/embeds/{id}",
|
|
92
|
+
method: "GET",
|
|
93
|
+
pathParams: {
|
|
94
|
+
id,
|
|
95
|
+
},
|
|
96
|
+
})
|
|
97
|
+
.then(this.getClientInstance().responseHandler({
|
|
98
|
+
200: {
|
|
99
|
+
"application/json": "json",
|
|
100
|
+
},
|
|
101
|
+
}))
|
|
102
|
+
.then(commonHttpClient.castResponse())
|
|
103
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SmartLinkService.getSmartLinkById.response"))
|
|
104
|
+
.then(commonHttpClient.getBody);
|
|
105
|
+
};
|
|
103
106
|
}
|
|
104
107
|
static initialize() {
|
|
105
108
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SmartLinkService.createSmartLink.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SmartLinkService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SmartLinkService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mDAG6B;AAC7B,wEAAqE;AACrE,yFAAyF;AACzF,MAAa,gBAAiB,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"SmartLinkService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SmartLinkService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mDAG6B;AAC7B,wEAAqE;AACrE,yFAAyF;AACzF,MAAa,gBAAiB,SAAQ,qCAAiB;IAAvD;;QACE;;;;;;;;;;;WAWG;QACH,oBAAe,GAAG,CAAC,EACjB,OAAO,EAAE,YAAY,EACrB,WAAW,GAmBZ,EAYC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,SAAS;gBACf,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE;oBACL,OAAO,EAAE,YAAY;iBACtB;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,EAazB,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,oBAAe,GAAG,CAAC,EACjB,EAAE,GAIH,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,cAAc;gBACpB,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,qBAAgB,GAAG,CAAC,EAClB,EAAE,GAIH,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;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,CAC/B,4CAA4C,CAC7C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAgDJ,CAAC;IA/CC,MAAM,CAAC,UAAU;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,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,EAC/C,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,2CAA2C,CAAC,CACzD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,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,iBAAiB,CAAC,EAC/C,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,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,8CAAkC,CAAC,CAAC,CAAC;IAC7E,CAAC;CACF;AA3OD,4CA2OC"}
|
|
@@ -13,7 +13,7 @@ export declare class SpacePermissionsService extends CommonHttpService {
|
|
|
13
13
|
* @scopes-current read:space:confluence
|
|
14
14
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-spaces-id-permissions-get
|
|
15
15
|
*/
|
|
16
|
-
getSpacePermissions({ id, cursor, limit, }: {
|
|
16
|
+
getSpacePermissions: ({ id, cursor, limit, }: {
|
|
17
17
|
/** The ID of the space to be returned. */
|
|
18
18
|
id: number;
|
|
19
19
|
/**
|
|
@@ -21,16 +21,16 @@ export declare class SpacePermissionsService extends CommonHttpService {
|
|
|
21
21
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
22
22
|
* retrieve the `next` set of results.
|
|
23
23
|
*/
|
|
24
|
-
cursor?: string;
|
|
24
|
+
cursor?: string | undefined;
|
|
25
25
|
/**
|
|
26
26
|
* Maximum number of spaces per result to return. If more results exist, use the
|
|
27
27
|
* `Link` response header to retrieve a relative URL that will return the next set
|
|
28
28
|
* of results.
|
|
29
29
|
*/
|
|
30
|
-
limit?: number;
|
|
31
|
-
})
|
|
32
|
-
results?: SpacePermission[];
|
|
33
|
-
_links?: MultiEntityLinks;
|
|
30
|
+
limit?: number | undefined;
|
|
31
|
+
}) => Promise<{
|
|
32
|
+
results?: SpacePermission[] | undefined;
|
|
33
|
+
_links?: MultiEntityLinks | undefined;
|
|
34
34
|
} & {
|
|
35
35
|
[key: string]: unknown;
|
|
36
36
|
}>;
|
|
@@ -11,38 +11,41 @@ const common_1 = require("../models/common");
|
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
12
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions */
|
|
13
13
|
class SpacePermissionsService extends CommonHttpService_1.CommonHttpService {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
/**
|
|
17
|
+
* Returns space permissions for a specific space.
|
|
18
|
+
*
|
|
19
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
20
|
+
* Permission to view the space.
|
|
21
|
+
*
|
|
22
|
+
* @returns Returned if the requested space permissions are returned.
|
|
23
|
+
* @path {GET} /spaces/{id}/permissions
|
|
24
|
+
* @scopes-current read:space:confluence
|
|
25
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-permissions#api-spaces-id-permissions-get
|
|
26
|
+
*/
|
|
27
|
+
this.getSpacePermissions = ({ id, cursor, limit, }) => {
|
|
28
|
+
return this.getClientInstance()
|
|
29
|
+
.request({
|
|
30
|
+
path: "/spaces/{id}/permissions",
|
|
31
|
+
method: "GET",
|
|
32
|
+
pathParams: {
|
|
33
|
+
id,
|
|
34
|
+
},
|
|
35
|
+
query: {
|
|
36
|
+
cursor,
|
|
37
|
+
limit,
|
|
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("SpacePermissionsService.getSpacePermissions.response"))
|
|
47
|
+
.then(commonHttpClient.getBody);
|
|
48
|
+
};
|
|
46
49
|
}
|
|
47
50
|
static initialize() {
|
|
48
51
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePermissionsService.getSpacePermissions.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SpacePermissionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePermissionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,wEAAqE;AACrE,gGAAgG;AAChG,MAAa,uBAAwB,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"SpacePermissionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePermissionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAC1B,wEAAqE;AACrE,gGAAgG;AAChG,MAAa,uBAAwB,SAAQ,qCAAiB;IAA9D;;QACE;;;;;;;;;;WAUG;QACH,wBAAmB,GAAG,CAAC,EACrB,EAAE,EACF,MAAM,EACN,KAAK,GAgBN,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,0BAA0B;gBAChC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,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,CAC/B,sDAAsD,CACvD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAuBJ,CAAC;IAtBC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,sDAAsD,EACtD,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,iBAAiB,CAAC,CAAC;qBACtD,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,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAnGD,0DAmGC"}
|
|
@@ -15,12 +15,12 @@ export declare class SpacePropertiesService extends CommonHttpService {
|
|
|
15
15
|
* @scopes-current read:space:confluence, write:space:confluence
|
|
16
16
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-post
|
|
17
17
|
*/
|
|
18
|
-
createSpaceProperty({ spaceId, spacePropertyCreateRequest, }: {
|
|
18
|
+
createSpaceProperty: ({ spaceId, spacePropertyCreateRequest, }: {
|
|
19
19
|
/** The ID of the space for which space properties should be returned. */
|
|
20
20
|
spaceId: number;
|
|
21
21
|
/** The space property to be created */
|
|
22
22
|
spacePropertyCreateRequest: SpacePropertyCreateRequest;
|
|
23
|
-
})
|
|
23
|
+
}) => Promise<SpaceProperty>;
|
|
24
24
|
/**
|
|
25
25
|
* Deletes a space property by its id.
|
|
26
26
|
*
|
|
@@ -32,12 +32,12 @@ export declare class SpacePropertiesService extends CommonHttpService {
|
|
|
32
32
|
* @scopes-current read:space:confluence, write:space:confluence
|
|
33
33
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-delete
|
|
34
34
|
*/
|
|
35
|
-
deleteSpacePropertyById({ spaceId, propertyId, }: {
|
|
35
|
+
deleteSpacePropertyById: ({ spaceId, propertyId, }: {
|
|
36
36
|
/** The ID of the space the property belongs to. */
|
|
37
37
|
spaceId: number;
|
|
38
38
|
/** The ID of the property to be deleted. */
|
|
39
39
|
propertyId: number;
|
|
40
|
-
})
|
|
40
|
+
}) => Promise<void>;
|
|
41
41
|
/**
|
|
42
42
|
* Returns all properties for the given space. Space properties are a key-value
|
|
43
43
|
* storage associated with a space.
|
|
@@ -55,7 +55,7 @@ export declare class SpacePropertiesService extends CommonHttpService {
|
|
|
55
55
|
* @scopes-current read:space:confluence
|
|
56
56
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-get
|
|
57
57
|
*/
|
|
58
|
-
getSpaceProperties({ spaceId, key, cursor, limit, }: {
|
|
58
|
+
getSpaceProperties: ({ spaceId, key, cursor, limit, }: {
|
|
59
59
|
/** The ID of the space for which space properties should be returned. */
|
|
60
60
|
spaceId: number;
|
|
61
61
|
/**
|
|
@@ -63,22 +63,22 @@ export declare class SpacePropertiesService extends CommonHttpService {
|
|
|
63
63
|
* knows the key of their property, but needs to retrieve the id for use in other
|
|
64
64
|
* methods.
|
|
65
65
|
*/
|
|
66
|
-
key?: string;
|
|
66
|
+
key?: string | undefined;
|
|
67
67
|
/**
|
|
68
68
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
69
69
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
70
70
|
* retrieve the `next` set of results.
|
|
71
71
|
*/
|
|
72
|
-
cursor?: string;
|
|
72
|
+
cursor?: string | undefined;
|
|
73
73
|
/**
|
|
74
74
|
* Maximum number of pages per result to return. If more results exist, use the
|
|
75
75
|
* `Link` header to retrieve a relative URL that will return the next set of
|
|
76
76
|
* results.
|
|
77
77
|
*/
|
|
78
|
-
limit?: number;
|
|
79
|
-
})
|
|
80
|
-
results?: SpaceProperty[];
|
|
81
|
-
_links?: MultiEntityLinks;
|
|
78
|
+
limit?: number | undefined;
|
|
79
|
+
}) => Promise<{
|
|
80
|
+
results?: SpaceProperty[] | undefined;
|
|
81
|
+
_links?: MultiEntityLinks | undefined;
|
|
82
82
|
} & {
|
|
83
83
|
[key: string]: unknown;
|
|
84
84
|
}>;
|
|
@@ -94,12 +94,12 @@ export declare class SpacePropertiesService extends CommonHttpService {
|
|
|
94
94
|
* @scopes-current read:space:confluence
|
|
95
95
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-get
|
|
96
96
|
*/
|
|
97
|
-
getSpacePropertyById({ spaceId, propertyId, }: {
|
|
97
|
+
getSpacePropertyById: ({ spaceId, propertyId, }: {
|
|
98
98
|
/** The ID of the space the property belongs to. */
|
|
99
99
|
spaceId: number;
|
|
100
100
|
/** The ID of the property to be retrieved. */
|
|
101
101
|
propertyId: number;
|
|
102
|
-
})
|
|
102
|
+
}) => Promise<SpaceProperty>;
|
|
103
103
|
/**
|
|
104
104
|
* Update a space property by its id.
|
|
105
105
|
*
|
|
@@ -112,13 +112,13 @@ export declare class SpacePropertiesService extends CommonHttpService {
|
|
|
112
112
|
* @scopes-current read:space:confluence, write:space:confluence
|
|
113
113
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-put
|
|
114
114
|
*/
|
|
115
|
-
updateSpacePropertyById({ spaceId, propertyId, spacePropertyUpdateRequest, }: {
|
|
115
|
+
updateSpacePropertyById: ({ spaceId, propertyId, spacePropertyUpdateRequest, }: {
|
|
116
116
|
/** The ID of the space the property belongs to. */
|
|
117
117
|
spaceId: number;
|
|
118
118
|
/** The ID of the property to be updated. */
|
|
119
119
|
propertyId: number;
|
|
120
120
|
/** The space property to be updated. */
|
|
121
121
|
spacePropertyUpdateRequest: SpacePropertyUpdateRequest;
|
|
122
|
-
})
|
|
122
|
+
}) => Promise<SpaceProperty>;
|
|
123
123
|
static initialize(): void;
|
|
124
124
|
}
|