@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
|
@@ -12,177 +12,180 @@ const common_1 = require("../models/common");
|
|
|
12
12
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
13
13
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors */
|
|
14
14
|
class AncestorsService 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
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
15
|
+
constructor() {
|
|
16
|
+
super(...arguments);
|
|
17
|
+
/**
|
|
18
|
+
* Returns all ancestors for a given database by ID in top-to-bottom order (that
|
|
19
|
+
* is, the highest ancestor is the first
|
|
20
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
21
|
+
* parameter and additional results (if available)
|
|
22
|
+
* will be available by calling this endpoint with the ID of first ancestor in the
|
|
23
|
+
* response payload.
|
|
24
|
+
*
|
|
25
|
+
* This endpoint returns minimal information about each ancestor. To fetch more
|
|
26
|
+
* details, use a related endpoint, such
|
|
27
|
+
* as [Get database by
|
|
28
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get).
|
|
29
|
+
*
|
|
30
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
31
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
32
|
+
* Permission to view the database and its corresponding space
|
|
33
|
+
*
|
|
34
|
+
* @returns Returned if the requested ancestors are returned.
|
|
35
|
+
* @path {GET} /databases/{id}/ancestors
|
|
36
|
+
* @scopes-current read:content.metadata:confluence
|
|
37
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors#api-databases-id-ancestors-get
|
|
38
|
+
*/
|
|
39
|
+
this.getDatabaseAncestors = ({ id, limit, }) => {
|
|
40
|
+
return this.getClientInstance()
|
|
41
|
+
.request({
|
|
42
|
+
path: "/databases/{id}/ancestors",
|
|
43
|
+
method: "GET",
|
|
44
|
+
pathParams: {
|
|
45
|
+
id,
|
|
46
|
+
},
|
|
47
|
+
query: {
|
|
48
|
+
limit,
|
|
49
|
+
},
|
|
50
|
+
})
|
|
51
|
+
.then(this.getClientInstance().responseHandler({
|
|
52
|
+
200: {
|
|
53
|
+
"application/json": "json",
|
|
54
|
+
},
|
|
55
|
+
}))
|
|
56
|
+
.then(commonHttpClient.castResponse())
|
|
57
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getDatabaseAncestors.response"))
|
|
58
|
+
.then(commonHttpClient.getBody);
|
|
59
|
+
};
|
|
60
|
+
/**
|
|
61
|
+
* Returns all ancestors for a given page by ID in top-to-bottom order (that is,
|
|
62
|
+
* the highest ancestor is the first
|
|
63
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
64
|
+
* parameter and additional results (if available)
|
|
65
|
+
* will be available by calling this endpoint with the ID of first ancestor in the
|
|
66
|
+
* response payload.
|
|
67
|
+
*
|
|
68
|
+
* This endpoint returns minimal information about each ancestor. To fetch more
|
|
69
|
+
* details, use a related endpoint, such
|
|
70
|
+
* as [Get page by
|
|
71
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get).
|
|
72
|
+
*
|
|
73
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
74
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
75
|
+
*
|
|
76
|
+
* @returns Returned if the requested ancestors are returned.
|
|
77
|
+
* @path {GET} /pages/{id}/ancestors
|
|
78
|
+
* @scopes-current read:content.metadata:confluence
|
|
79
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors#api-pages-id-ancestors-get
|
|
80
|
+
*/
|
|
81
|
+
this.getPageAncestors = ({ id, limit, }) => {
|
|
82
|
+
return this.getClientInstance()
|
|
83
|
+
.request({
|
|
84
|
+
path: "/pages/{id}/ancestors",
|
|
85
|
+
method: "GET",
|
|
86
|
+
pathParams: {
|
|
87
|
+
id,
|
|
88
|
+
},
|
|
89
|
+
query: {
|
|
90
|
+
limit,
|
|
91
|
+
},
|
|
92
|
+
})
|
|
93
|
+
.then(this.getClientInstance().responseHandler({
|
|
94
|
+
200: {
|
|
95
|
+
"application/json": "json",
|
|
96
|
+
},
|
|
97
|
+
}))
|
|
98
|
+
.then(commonHttpClient.castResponse())
|
|
99
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getPageAncestors.response"))
|
|
100
|
+
.then(commonHttpClient.getBody);
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* Returns all ancestors for a given Smart Link in the content tree by ID in
|
|
104
|
+
* top-to-bottom order (that is, the highest ancestor is
|
|
105
|
+
* the first item in the response payload). The number of results is limited by
|
|
106
|
+
* the `limit` parameter and additional results
|
|
107
|
+
* (if available) will be available by calling this endpoint with the ID of first
|
|
108
|
+
* ancestor in the response payload.
|
|
109
|
+
*
|
|
110
|
+
* This endpoint returns minimal information about each ancestor. To fetch more
|
|
111
|
+
* details, use a related endpoint, such
|
|
112
|
+
* as [Get Smart Link in the content tree by
|
|
113
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get).
|
|
114
|
+
*
|
|
115
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
116
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
117
|
+
* Permission to view the Smart Link in the content tree and its corresponding
|
|
118
|
+
* space
|
|
119
|
+
*
|
|
120
|
+
* @returns Returned if the requested ancestors are returned.
|
|
121
|
+
* @path {GET} /embeds/{id}/ancestors
|
|
122
|
+
* @scopes-current read:content.metadata:confluence
|
|
123
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors#api-embeds-id-ancestors-get
|
|
124
|
+
*/
|
|
125
|
+
this.getSmartLinkAncestors = ({ id, limit, }) => {
|
|
126
|
+
return this.getClientInstance()
|
|
127
|
+
.request({
|
|
128
|
+
path: "/embeds/{id}/ancestors",
|
|
129
|
+
method: "GET",
|
|
130
|
+
pathParams: {
|
|
131
|
+
id,
|
|
132
|
+
},
|
|
133
|
+
query: {
|
|
134
|
+
limit,
|
|
135
|
+
},
|
|
136
|
+
})
|
|
137
|
+
.then(this.getClientInstance().responseHandler({
|
|
138
|
+
200: {
|
|
139
|
+
"application/json": "json",
|
|
140
|
+
},
|
|
141
|
+
}))
|
|
142
|
+
.then(commonHttpClient.castResponse())
|
|
143
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getSmartLinkAncestors.response"))
|
|
144
|
+
.then(commonHttpClient.getBody);
|
|
145
|
+
};
|
|
146
|
+
/**
|
|
147
|
+
* Returns all ancestors for a given whiteboard by ID in top-to-bottom order (that
|
|
148
|
+
* is, the highest ancestor is the first
|
|
149
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
150
|
+
* parameter and additional results (if available)
|
|
151
|
+
* will be available by calling this endpoint with the ID of first ancestor in the
|
|
152
|
+
* response payload.
|
|
153
|
+
*
|
|
154
|
+
* This endpoint returns minimal information about each ancestor. To fetch more
|
|
155
|
+
* details, use a related endpoint, such
|
|
156
|
+
* as [Get whiteboard by
|
|
157
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
|
|
158
|
+
*
|
|
159
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
160
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
161
|
+
* Permission to view the whiteboard and its corresponding space
|
|
162
|
+
*
|
|
163
|
+
* @returns Returned if the requested ancestors are returned.
|
|
164
|
+
* @path {GET} /whiteboards/{id}/ancestors
|
|
165
|
+
* @scopes-current read:content.metadata:confluence
|
|
166
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-ancestors#api-whiteboards-id-ancestors-get
|
|
167
|
+
*/
|
|
168
|
+
this.getWhiteboardAncestors = ({ id, limit, }) => {
|
|
169
|
+
return this.getClientInstance()
|
|
170
|
+
.request({
|
|
171
|
+
path: "/whiteboards/{id}/ancestors",
|
|
172
|
+
method: "GET",
|
|
173
|
+
pathParams: {
|
|
174
|
+
id,
|
|
175
|
+
},
|
|
176
|
+
query: {
|
|
177
|
+
limit,
|
|
178
|
+
},
|
|
179
|
+
})
|
|
180
|
+
.then(this.getClientInstance().responseHandler({
|
|
181
|
+
200: {
|
|
182
|
+
"application/json": "json",
|
|
183
|
+
},
|
|
184
|
+
}))
|
|
185
|
+
.then(commonHttpClient.castResponse())
|
|
186
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getWhiteboardAncestors.response"))
|
|
187
|
+
.then(commonHttpClient.getBody);
|
|
188
|
+
};
|
|
186
189
|
}
|
|
187
190
|
static initialize() {
|
|
188
191
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AncestorsService.getDatabaseAncestors.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"AncestorsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/AncestorsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mDAG6B;AAC7B,6CAG0B;AAC1B,wEAAqE;AACrE,wFAAwF;AACxF,MAAa,gBAAiB,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"AncestorsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/AncestorsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mDAG6B;AAC7B,6CAG0B;AAC1B,wEAAqE;AACrE,wFAAwF;AACxF,MAAa,gBAAiB,SAAQ,qCAAiB;IAAvD;;QACE;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,yBAAoB,GAAG,CAAC,EACtB,EAAE,EACF,KAAK,GASN,EAMC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,2BAA2B;gBACjC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,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,EAQzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,gDAAgD,CACjD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,qBAAgB,GAAG,CAAC,EAClB,EAAE,EACF,KAAK,GASN,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uBAAuB;gBAC7B,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,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,4CAA4C,CAC7C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;WAsBG;QACH,0BAAqB,GAAG,CAAC,EACvB,EAAE,EACF,KAAK,GASN,EAMC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,wBAAwB;gBAC9B,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,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,EAQzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,iDAAiD,CAClD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,2BAAsB,GAAG,CAAC,EACxB,EAAE,EACF,KAAK,GASN,EAMC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,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,EAQzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,kDAAkD,CACnD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA0EJ,CAAC;IAzEC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,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,UAAU,CAAC,CAAC;qBAC/C,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iDAAiD,EACjD,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,UAAU,CAAC,CAAC;qBAC/C,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,iDAAiD,CAAC,CAC/D,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;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;qBAC/C,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,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,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,UAAU,CAAC,CAAC;qBAC/C,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,8CAAkC;YAClC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA5XD,4CA4XC"}
|