@resolution/confluence-api-client 0.13.5 → 0.14.1
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/lib/openapi/core/CommonHttpClient.d.ts +1 -1
- package/lib/openapi/core/CommonHttpClient.js +1 -1
- package/lib/openapi/core/CommonHttpClient.js.map +1 -1
- package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +6 -37
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js +3 -71
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
- package/lib/openapi/v1/models/audit.js +2 -2
- package/lib/openapi/v1/models/audit.js.map +1 -1
- package/lib/openapi/v1/models/common.d.ts +1 -1
- package/lib/openapi/v1/models/common.js +3 -3
- package/lib/openapi/v1/models/common.js.map +1 -1
- package/lib/openapi/v1/models/content.d.ts +0 -543
- package/lib/openapi/v1/models/content.js +2 -309
- package/lib/openapi/v1/models/content.js.map +1 -1
- package/lib/openapi/v1/models/contentRestrictions.js +1 -1
- package/lib/openapi/v1/models/contentRestrictions.js.map +1 -1
- package/lib/openapi/v1/models/contentStates.d.ts +322 -0
- package/lib/openapi/v1/models/contentStates.js +219 -0
- package/lib/openapi/v1/models/contentStates.js.map +1 -1
- package/lib/openapi/v1/models/contentVersions.d.ts +0 -9
- package/lib/openapi/v1/models/contentVersions.js +1 -10
- package/lib/openapi/v1/models/contentVersions.js.map +1 -1
- package/lib/openapi/v1/models/dynamicModules.d.ts +3 -3
- package/lib/openapi/v1/models/space.d.ts +1 -9
- package/lib/openapi/v1/models/space.js +1 -8
- package/lib/openapi/v1/models/space.js.map +1 -1
- package/lib/openapi/v1/models/template.js +1 -1
- package/lib/openapi/v1/models/template.js.map +1 -1
- package/lib/openapi/v1/services/AnalyticsService.d.ts +4 -0
- package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +0 -130
- package/lib/openapi/v1/services/ContentAttachmentsService.js +0 -52
- package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentBodyService.d.ts +1 -102
- package/lib/openapi/v1/services/ContentBodyService.js +1 -65
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +3 -220
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +2 -144
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentLabelsService.d.ts +1 -44
- package/lib/openapi/v1/services/ContentLabelsService.js +0 -41
- package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentService.d.ts +2 -560
- package/lib/openapi/v1/services/ContentService.js +1 -300
- package/lib/openapi/v1/services/ContentService.js.map +1 -1
- package/lib/openapi/v1/services/ContentVersionsService.d.ts +1 -72
- package/lib/openapi/v1/services/ContentVersionsService.js +1 -97
- package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
- package/lib/openapi/v1/services/GroupService.d.ts +1 -1
- package/lib/openapi/v1/services/GroupService.js +1 -1
- package/lib/openapi/v1/services/SettingsService.d.ts +0 -26
- package/lib/openapi/v1/services/SettingsService.js +0 -38
- package/lib/openapi/v1/services/SettingsService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceService.d.ts +2 -406
- package/lib/openapi/v1/services/SpaceService.js +1 -215
- package/lib/openapi/v1/services/SpaceService.js.map +1 -1
- package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +28 -3
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js +31 -1
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
- package/lib/openapi/v2/models/adminKey.d.ts +13 -0
- package/lib/openapi/v2/models/adminKey.js +12 -0
- package/lib/openapi/v2/models/adminKey.js.map +1 -0
- package/lib/openapi/v2/models/children.d.ts +21 -6
- package/lib/openapi/v2/models/children.js +10 -1
- package/lib/openapi/v2/models/children.js.map +1 -1
- package/lib/openapi/v2/models/common.d.ts +6 -0
- package/lib/openapi/v2/models/common.js +1 -0
- package/lib/openapi/v2/models/common.js.map +1 -1
- package/lib/openapi/v2/models/descendants.d.ts +29 -0
- package/lib/openapi/v2/models/descendants.js +19 -0
- package/lib/openapi/v2/models/descendants.js.map +1 -0
- package/lib/openapi/v2/models/page.d.ts +2 -0
- package/lib/openapi/v2/models/page.js +1 -0
- package/lib/openapi/v2/models/page.js.map +1 -1
- package/lib/openapi/v2/services/AdminKeyService.d.ts +77 -0
- package/lib/openapi/v2/services/AdminKeyService.js +117 -0
- package/lib/openapi/v2/services/AdminKeyService.js.map +1 -0
- package/lib/openapi/v2/services/AttachmentService.d.ts +6 -5
- package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
- package/lib/openapi/v2/services/BlogPostService.d.ts +5 -4
- package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
- package/lib/openapi/v2/services/ChildrenService.d.ts +307 -1
- package/lib/openapi/v2/services/ChildrenService.js +321 -0
- package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
- package/lib/openapi/v2/services/CommentService.d.ts +10 -8
- package/lib/openapi/v2/services/CommentService.js.map +1 -1
- package/lib/openapi/v2/services/ContentPropertiesService.d.ts +1 -1
- package/lib/openapi/v2/services/CustomContentService.d.ts +18 -1
- package/lib/openapi/v2/services/CustomContentService.js +5 -0
- package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
- package/lib/openapi/v2/services/DatabaseService.d.ts +4 -6
- package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
- package/lib/openapi/v2/services/DescendantsService.d.ts +346 -0
- package/lib/openapi/v2/services/DescendantsService.js +362 -0
- package/lib/openapi/v2/services/DescendantsService.js.map +1 -0
- package/lib/openapi/v2/services/FolderService.d.ts +4 -6
- package/lib/openapi/v2/services/FolderService.js.map +1 -1
- package/lib/openapi/v2/services/PageService.d.ts +57 -7
- package/lib/openapi/v2/services/PageService.js +44 -3
- package/lib/openapi/v2/services/PageService.js.map +1 -1
- package/lib/openapi/v2/services/SmartLinkService.d.ts +4 -6
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
- package/lib/openapi/v2/services/SpaceService.d.ts +2 -1
- package/lib/openapi/v2/services/SpaceService.js.map +1 -1
- package/lib/openapi/v2/services/WhiteboardService.d.ts +6 -8
- package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
- package/package.json +3 -3
- package/lib/openapi/v1/models/contentProperties.d.ts +0 -78
- package/lib/openapi/v1/models/contentProperties.js +0 -48
- package/lib/openapi/v1/models/contentProperties.js.map +0 -1
- package/lib/openapi/v1/models/inlineTasks.d.ts +0 -33
- package/lib/openapi/v1/models/inlineTasks.js +0 -36
- package/lib/openapi/v1/models/inlineTasks.js.map +0 -1
- package/lib/openapi/v1/models/spaceProperties.d.ts +0 -103
- package/lib/openapi/v1/models/spaceProperties.js +0 -48
- package/lib/openapi/v1/models/spaceProperties.js.map +0 -1
- package/lib/openapi/v1/services/ContentCommentsService.d.ts +0 -153
- package/lib/openapi/v1/services/ContentCommentsService.js +0 -81
- package/lib/openapi/v1/services/ContentCommentsService.js.map +0 -1
- package/lib/openapi/v1/services/ContentPropertiesService.d.ts +0 -203
- package/lib/openapi/v1/services/ContentPropertiesService.js +0 -279
- package/lib/openapi/v1/services/ContentPropertiesService.js.map +0 -1
- package/lib/openapi/v1/services/InlineTasksService.d.ts +0 -101
- package/lib/openapi/v1/services/InlineTasksService.js +0 -145
- package/lib/openapi/v1/services/InlineTasksService.js.map +0 -1
- package/lib/openapi/v1/services/SpacePropertiesService.d.ts +0 -177
- package/lib/openapi/v1/services/SpacePropertiesService.js +0 -269
- package/lib/openapi/v1/services/SpacePropertiesService.js.map +0 -1
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DescendantsService = void 0;
|
|
4
|
+
// DO NOT EDIT!
|
|
5
|
+
// This file is generated by "api-typescript-generator".
|
|
6
|
+
// To update this file run "yarn build:openapi".
|
|
7
|
+
const commonHttpClient = require("../../core/CommonHttpClient");
|
|
8
|
+
const CommonHttpService_1 = require("../../core/CommonHttpService");
|
|
9
|
+
const common_1 = require("../models/common");
|
|
10
|
+
const descendants_1 = require("../models/descendants");
|
|
11
|
+
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
|
+
const zod_1 = require("zod");
|
|
13
|
+
/**
|
|
14
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants
|
|
15
|
+
* @category Services
|
|
16
|
+
*/
|
|
17
|
+
class DescendantsService extends CommonHttpService_1.CommonHttpService {
|
|
18
|
+
constructor() {
|
|
19
|
+
super(...arguments);
|
|
20
|
+
/**
|
|
21
|
+
* Returns descendants in the content tree for a given database by ID in
|
|
22
|
+
* top-to-bottom order (that is, the highest descendant is the first
|
|
23
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
24
|
+
* parameter and additional results (if available)
|
|
25
|
+
* will be available by calling this endpoint with the cursor in the response
|
|
26
|
+
* payload. There is also a `depth` parameter specifying depth
|
|
27
|
+
* of descendants to be fetched.
|
|
28
|
+
*
|
|
29
|
+
* The following types of content will be returned:
|
|
30
|
+
* - Database
|
|
31
|
+
* - Embed
|
|
32
|
+
* - Folder
|
|
33
|
+
* - Page
|
|
34
|
+
* - Whiteboard
|
|
35
|
+
*
|
|
36
|
+
* This endpoint returns minimal information about each descendant. To fetch more
|
|
37
|
+
* details, use a related endpoint based on the content type, such
|
|
38
|
+
* as:
|
|
39
|
+
*
|
|
40
|
+
* - [Get database by
|
|
41
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
|
|
42
|
+
* - [Get embed by
|
|
43
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
|
|
44
|
+
* - [Get folder by
|
|
45
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
|
|
46
|
+
* - [Get page by
|
|
47
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
|
|
48
|
+
* - [Get whiteboard by
|
|
49
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
|
|
50
|
+
*
|
|
51
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
52
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
53
|
+
* Permission to view the database and its corresponding space
|
|
54
|
+
*
|
|
55
|
+
* @returns Returned if the requested descendants are returned.
|
|
56
|
+
* @path GET `/databases/{id}/descendants`
|
|
57
|
+
* @scopes-current read:hierarchical-content:confluence
|
|
58
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-databases-id-descendants-get
|
|
59
|
+
* @param params
|
|
60
|
+
*/
|
|
61
|
+
this.getDatabaseDescendants = ({ id, limit, depth, cursor }) => {
|
|
62
|
+
return this.getClientInstance().request({
|
|
63
|
+
path: "/databases/{id}/descendants",
|
|
64
|
+
method: "GET",
|
|
65
|
+
pathParams: {
|
|
66
|
+
id
|
|
67
|
+
},
|
|
68
|
+
query: {
|
|
69
|
+
limit,
|
|
70
|
+
depth,
|
|
71
|
+
cursor
|
|
72
|
+
}
|
|
73
|
+
}).then(this.getClientInstance().responseHandler({
|
|
74
|
+
200: {
|
|
75
|
+
"application/json": "json"
|
|
76
|
+
}
|
|
77
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("DescendantsService.getDatabaseDescendants.response"))).then(commonHttpClient.getBody);
|
|
78
|
+
};
|
|
79
|
+
/**
|
|
80
|
+
* Returns descendants in the content tree for a given folder by ID in
|
|
81
|
+
* top-to-bottom order (that is, the highest descendant is the first
|
|
82
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
83
|
+
* parameter and additional results (if available)
|
|
84
|
+
* will be available by calling this endpoint with the cursor in the response
|
|
85
|
+
* payload. There is also a `depth` parameter specifying depth
|
|
86
|
+
* of descendants to be fetched.
|
|
87
|
+
*
|
|
88
|
+
* The following types of content will be returned:
|
|
89
|
+
* - Database
|
|
90
|
+
* - Embed
|
|
91
|
+
* - Folder
|
|
92
|
+
* - Page
|
|
93
|
+
* - Whiteboard
|
|
94
|
+
*
|
|
95
|
+
* This endpoint returns minimal information about each descendant. To fetch more
|
|
96
|
+
* details, use a related endpoint based on the content type, such
|
|
97
|
+
* as:
|
|
98
|
+
*
|
|
99
|
+
* - [Get database by
|
|
100
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
|
|
101
|
+
* - [Get embed by
|
|
102
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
|
|
103
|
+
* - [Get folder by
|
|
104
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
|
|
105
|
+
* - [Get page by
|
|
106
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
|
|
107
|
+
* - [Get whiteboard by
|
|
108
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
|
|
109
|
+
*
|
|
110
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
111
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
112
|
+
* Permission to view the and its corresponding space
|
|
113
|
+
*
|
|
114
|
+
* @returns Returned if the requested descendants are returned.
|
|
115
|
+
* @path GET `/folders/{id}/descendants`
|
|
116
|
+
* @scopes-current read:hierarchical-content:confluence
|
|
117
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-folders-id-descendants-get
|
|
118
|
+
* @param params
|
|
119
|
+
*/
|
|
120
|
+
this.getFolderDescendants = ({ id, limit, depth, cursor }) => {
|
|
121
|
+
return this.getClientInstance().request({
|
|
122
|
+
path: "/folders/{id}/descendants",
|
|
123
|
+
method: "GET",
|
|
124
|
+
pathParams: {
|
|
125
|
+
id
|
|
126
|
+
},
|
|
127
|
+
query: {
|
|
128
|
+
limit,
|
|
129
|
+
depth,
|
|
130
|
+
cursor
|
|
131
|
+
}
|
|
132
|
+
}).then(this.getClientInstance().responseHandler({
|
|
133
|
+
200: {
|
|
134
|
+
"application/json": "json"
|
|
135
|
+
}
|
|
136
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("DescendantsService.getFolderDescendants.response"))).then(commonHttpClient.getBody);
|
|
137
|
+
};
|
|
138
|
+
/**
|
|
139
|
+
* Returns descendants in the content tree for a given page by ID in top-to-bottom
|
|
140
|
+
* order (that is, the highest descendant is the first
|
|
141
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
142
|
+
* parameter and additional results (if available)
|
|
143
|
+
* will be available by calling this endpoint with the cursor in the response
|
|
144
|
+
* payload. There is also a `depth` parameter specifying depth
|
|
145
|
+
* of descendants to be fetched.
|
|
146
|
+
*
|
|
147
|
+
* The following types of content will be returned:
|
|
148
|
+
* - Database
|
|
149
|
+
* - Embed
|
|
150
|
+
* - Folder
|
|
151
|
+
* - Page
|
|
152
|
+
* - Whiteboard
|
|
153
|
+
*
|
|
154
|
+
* This endpoint returns minimal information about each descendant. To fetch more
|
|
155
|
+
* details, use a related endpoint based on the content type, such
|
|
156
|
+
* as:
|
|
157
|
+
*
|
|
158
|
+
* - [Get database by
|
|
159
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
|
|
160
|
+
* - [Get embed by
|
|
161
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
|
|
162
|
+
* - [Get folder by
|
|
163
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
|
|
164
|
+
* - [Get page by
|
|
165
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
|
|
166
|
+
* - [Get whiteboard by
|
|
167
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
|
|
168
|
+
*
|
|
169
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
170
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
171
|
+
* Permission to view the page and its corresponding space
|
|
172
|
+
*
|
|
173
|
+
* @returns Returned if the requested descendants are returned.
|
|
174
|
+
* @path GET `/pages/{id}/descendants`
|
|
175
|
+
* @scopes-current read:hierarchical-content:confluence
|
|
176
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-pages-id-descendants-get
|
|
177
|
+
* @param params
|
|
178
|
+
*/
|
|
179
|
+
this.getPageDescendants = ({ id, limit, depth, cursor }) => {
|
|
180
|
+
return this.getClientInstance().request({
|
|
181
|
+
path: "/pages/{id}/descendants",
|
|
182
|
+
method: "GET",
|
|
183
|
+
pathParams: {
|
|
184
|
+
id
|
|
185
|
+
},
|
|
186
|
+
query: {
|
|
187
|
+
limit,
|
|
188
|
+
depth,
|
|
189
|
+
cursor
|
|
190
|
+
}
|
|
191
|
+
}).then(this.getClientInstance().responseHandler({
|
|
192
|
+
200: {
|
|
193
|
+
"application/json": "json"
|
|
194
|
+
}
|
|
195
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("DescendantsService.getPageDescendants.response"))).then(commonHttpClient.getBody);
|
|
196
|
+
};
|
|
197
|
+
/**
|
|
198
|
+
* Returns descendants in the content tree for a given smart link by ID in
|
|
199
|
+
* top-to-bottom order (that is, the highest descendant is the first
|
|
200
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
201
|
+
* parameter and additional results (if available)
|
|
202
|
+
* will be available by calling this endpoint with the cursor in the response
|
|
203
|
+
* payload. There is also a `depth` parameter specifying depth
|
|
204
|
+
* of descendants to be fetched.
|
|
205
|
+
*
|
|
206
|
+
* The following types of content will be returned:
|
|
207
|
+
* - Database
|
|
208
|
+
* - Embed
|
|
209
|
+
* - Folder
|
|
210
|
+
* - Page
|
|
211
|
+
* - Whiteboard
|
|
212
|
+
*
|
|
213
|
+
*
|
|
214
|
+
* This endpoint returns minimal information about each descendant. To fetch more
|
|
215
|
+
* details, use a related endpoint based on the content type, such
|
|
216
|
+
* as:
|
|
217
|
+
*
|
|
218
|
+
* - [Get database by
|
|
219
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
|
|
220
|
+
* - [Get embed by
|
|
221
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
|
|
222
|
+
* - [Get folder by
|
|
223
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
|
|
224
|
+
* - [Get page by
|
|
225
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
|
|
226
|
+
* - [Get whiteboard by
|
|
227
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
|
|
228
|
+
*
|
|
229
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
230
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
231
|
+
* Permission to view the smart link and its corresponding space
|
|
232
|
+
*
|
|
233
|
+
* @returns Returned if the requested descendants are returned.
|
|
234
|
+
* @path GET `/embeds/{id}/descendants`
|
|
235
|
+
* @scopes-current read:hierarchical-content:confluence
|
|
236
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-embeds-id-descendants-get
|
|
237
|
+
* @param params
|
|
238
|
+
*/
|
|
239
|
+
this.getSmartLinkDescendants = ({ id, limit, depth, cursor }) => {
|
|
240
|
+
return this.getClientInstance().request({
|
|
241
|
+
path: "/embeds/{id}/descendants",
|
|
242
|
+
method: "GET",
|
|
243
|
+
pathParams: {
|
|
244
|
+
id
|
|
245
|
+
},
|
|
246
|
+
query: {
|
|
247
|
+
limit,
|
|
248
|
+
depth,
|
|
249
|
+
cursor
|
|
250
|
+
}
|
|
251
|
+
}).then(this.getClientInstance().responseHandler({
|
|
252
|
+
200: {
|
|
253
|
+
"application/json": "json"
|
|
254
|
+
}
|
|
255
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("DescendantsService.getSmartLinkDescendants.response"))).then(commonHttpClient.getBody);
|
|
256
|
+
};
|
|
257
|
+
/**
|
|
258
|
+
* Returns descendants in the content tree for a given whiteboard by ID in
|
|
259
|
+
* top-to-bottom order (that is, the highest descendant is the first
|
|
260
|
+
* item in the response payload). The number of results is limited by the `limit`
|
|
261
|
+
* parameter and additional results (if available)
|
|
262
|
+
* will be available by calling this endpoint with the cursor in the response
|
|
263
|
+
* payload. There is also a `depth` parameter specifying depth
|
|
264
|
+
* of descendants to be fetched.
|
|
265
|
+
*
|
|
266
|
+
* The following types of content will be returned:
|
|
267
|
+
* - Database
|
|
268
|
+
* - Embed
|
|
269
|
+
* - Folder
|
|
270
|
+
* - Page
|
|
271
|
+
* - Whiteboard
|
|
272
|
+
*
|
|
273
|
+
* This endpoint returns minimal information about each descendant. To fetch more
|
|
274
|
+
* details, use a related endpoint based on the content type, such
|
|
275
|
+
* as:
|
|
276
|
+
*
|
|
277
|
+
* - [Get database by
|
|
278
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get)
|
|
279
|
+
* - [Get embed by
|
|
280
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get)
|
|
281
|
+
* - [Get folder by
|
|
282
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-folder/#api-folders-id-get)
|
|
283
|
+
* - [Get page by
|
|
284
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get)
|
|
285
|
+
* - [Get whiteboard by
|
|
286
|
+
* id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
|
|
287
|
+
*
|
|
288
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
289
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
290
|
+
* Permission to view the whiteboard and its corresponding space
|
|
291
|
+
*
|
|
292
|
+
* @returns Returned if the requested descendants are returned.
|
|
293
|
+
* @path GET `/whiteboards/{id}/descendants`
|
|
294
|
+
* @scopes-current read:hierarchical-content:confluence
|
|
295
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-descendants#api-whiteboards-id-descendants-get
|
|
296
|
+
* @param params
|
|
297
|
+
*/
|
|
298
|
+
this.getWhiteboardDescendants = ({ id, limit, depth, cursor }) => {
|
|
299
|
+
return this.getClientInstance().request({
|
|
300
|
+
path: "/whiteboards/{id}/descendants",
|
|
301
|
+
method: "GET",
|
|
302
|
+
pathParams: {
|
|
303
|
+
id
|
|
304
|
+
},
|
|
305
|
+
query: {
|
|
306
|
+
limit,
|
|
307
|
+
depth,
|
|
308
|
+
cursor
|
|
309
|
+
}
|
|
310
|
+
}).then(this.getClientInstance().responseHandler({
|
|
311
|
+
200: {
|
|
312
|
+
"application/json": "json"
|
|
313
|
+
}
|
|
314
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("DescendantsService.getWhiteboardDescendants.response"))).then(commonHttpClient.getBody);
|
|
315
|
+
};
|
|
316
|
+
}
|
|
317
|
+
static initialize() {
|
|
318
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DescendantsService.getDatabaseDescendants.response", zod_1.z.object({
|
|
319
|
+
status: zod_1.z.literal(200),
|
|
320
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
321
|
+
body: zod_1.z.object({
|
|
322
|
+
results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("DescendantsResponse")).optional(),
|
|
323
|
+
_links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
|
|
324
|
+
}).catchall(zod_1.z.unknown())
|
|
325
|
+
}).describe("DescendantsService.getDatabaseDescendants.response"));
|
|
326
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DescendantsService.getSmartLinkDescendants.response", zod_1.z.object({
|
|
327
|
+
status: zod_1.z.literal(200),
|
|
328
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
329
|
+
body: zod_1.z.object({
|
|
330
|
+
results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("DescendantsResponse")).optional(),
|
|
331
|
+
_links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
|
|
332
|
+
}).catchall(zod_1.z.unknown())
|
|
333
|
+
}).describe("DescendantsService.getSmartLinkDescendants.response"));
|
|
334
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DescendantsService.getFolderDescendants.response", zod_1.z.object({
|
|
335
|
+
status: zod_1.z.literal(200),
|
|
336
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
337
|
+
body: zod_1.z.object({
|
|
338
|
+
results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("DescendantsResponse")).optional(),
|
|
339
|
+
_links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
|
|
340
|
+
}).catchall(zod_1.z.unknown())
|
|
341
|
+
}).describe("DescendantsService.getFolderDescendants.response"));
|
|
342
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DescendantsService.getPageDescendants.response", zod_1.z.object({
|
|
343
|
+
status: zod_1.z.literal(200),
|
|
344
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
345
|
+
body: zod_1.z.object({
|
|
346
|
+
results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("DescendantsResponse")).optional(),
|
|
347
|
+
_links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
|
|
348
|
+
}).catchall(zod_1.z.unknown())
|
|
349
|
+
}).describe("DescendantsService.getPageDescendants.response"));
|
|
350
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("DescendantsService.getWhiteboardDescendants.response", zod_1.z.object({
|
|
351
|
+
status: zod_1.z.literal(200),
|
|
352
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
353
|
+
body: zod_1.z.object({
|
|
354
|
+
results: zod_1.z.array(validationSchemaStorage_1.validationSchemaStorage.lazy("DescendantsResponse")).optional(),
|
|
355
|
+
_links: validationSchemaStorage_1.validationSchemaStorage.lazy("MultiEntityLinks").optional()
|
|
356
|
+
}).catchall(zod_1.z.unknown())
|
|
357
|
+
}).describe("DescendantsService.getWhiteboardDescendants.response"));
|
|
358
|
+
validationSchemaStorage_1.validationSchemaStorage.registerOnce([descendants_1.registerDescendantsValidationSchemas, common_1.registerCommonValidationSchemas]);
|
|
359
|
+
}
|
|
360
|
+
}
|
|
361
|
+
exports.DescendantsService = DescendantsService;
|
|
362
|
+
//# sourceMappingURL=DescendantsService.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"DescendantsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/DescendantsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAA0F;AAC1F,uDAAuG;AACvG,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,kBAAmB,SAAQ,qCAAiB;IAAzD;;QACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwCG;QACH,2BAAsB,GAAG,CAAC,EACxB,EAAE,EACF,KAAK,EACL,KAAK,EACL,MAAM,EAqBP,EAKE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,6BAA6B;gBACnC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,KAAK;oBACL,KAAK;oBACL,MAAM;iBACP;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EASlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,oDAAoD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1K,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwCG;QACH,yBAAoB,GAAG,CAAC,EACtB,EAAE,EACF,KAAK,EACL,KAAK,EACL,MAAM,EAqBP,EAKE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,2BAA2B;gBACjC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,KAAK;oBACL,KAAK;oBACL,MAAM;iBACP;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EASlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,kDAAkD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACxK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwCG;QACH,uBAAkB,GAAG,CAAC,EACpB,EAAE,EACF,KAAK,EACL,KAAK,EACL,MAAM,EAqBP,EAKE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,yBAAyB;gBAC/B,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,KAAK;oBACL,KAAK;oBACL,MAAM;iBACP;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EASlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,gDAAgD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACtK,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAyCG;QACH,4BAAuB,GAAG,CAAC,EACzB,EAAE,EACF,KAAK,EACL,KAAK,EACL,MAAM,EAqBP,EAKE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,0BAA0B;gBAChC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,KAAK;oBACL,KAAK;oBACL,MAAM;iBACP;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EASlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,qDAAqD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3K,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAwCG;QACH,6BAAwB,GAAG,CAAC,EAC1B,EAAE,EACF,KAAK,EACL,KAAK,EACL,MAAM,EAqBP,EAKE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,KAAK;oBACL,KAAK;oBACL,MAAM;iBACP;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EASlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,sDAAsD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC5K,CAAC,CAAC;IA4CJ,CAAC;IA3CW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,oDAAoD,EAAE,OAAC,CAAC,MAAM,CAAC;YACxG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,EAAE;gBAChF,MAAM,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;aACpE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC,CAAC,QAAQ,CAAC,oDAAoD,CAAC,CAAC,CAAC;QACnE,iDAAuB,CAAC,kBAAkB,CAAC,qDAAqD,EAAE,OAAC,CAAC,MAAM,CAAC;YACzG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,EAAE;gBAChF,MAAM,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;aACpE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC,CAAC,QAAQ,CAAC,qDAAqD,CAAC,CAAC,CAAC;QACpE,iDAAuB,CAAC,kBAAkB,CAAC,kDAAkD,EAAE,OAAC,CAAC,MAAM,CAAC;YACtG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,EAAE;gBAChF,MAAM,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;aACpE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC,CAAC,QAAQ,CAAC,kDAAkD,CAAC,CAAC,CAAC;QACjE,iDAAuB,CAAC,kBAAkB,CAAC,gDAAgD,EAAE,OAAC,CAAC,MAAM,CAAC;YACpG,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,EAAE;gBAChF,MAAM,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;aACpE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC,CAAC,QAAQ,CAAC,gDAAgD,CAAC,CAAC,CAAC;QAC/D,iDAAuB,CAAC,kBAAkB,CAAC,sDAAsD,EAAE,OAAC,CAAC,MAAM,CAAC;YAC1G,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,MAAM,CAAC;gBACb,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC,QAAQ,EAAE;gBAChF,MAAM,EAAE,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,QAAQ,EAAE;aACpE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC,CAAC,QAAQ,CAAC,sDAAsD,CAAC,CAAC,CAAC;QACrE,iDAAuB,CAAC,YAAY,CAAC,CAAC,kDAAoC,EAAE,wCAA+B,CAAC,CAAC,CAAC;IAChH,CAAC;CACF;AAvhBD,gDAuhBC"}
|
|
@@ -75,15 +75,13 @@ export declare class FolderService extends CommonHttpService {
|
|
|
75
75
|
/** Includes collaborators on the folder. */
|
|
76
76
|
includeCollaborators?: boolean | undefined;
|
|
77
77
|
/**
|
|
78
|
-
* Includes direct children of the folder
|
|
79
|
-
*
|
|
80
|
-
* order.
|
|
81
|
-
* A `meta` and `_links` property will be present to indicate if more results are
|
|
82
|
-
* available and a link to retrieve the rest of the results.
|
|
78
|
+
* Includes direct children of the folder, as defined in the `ChildrenResponse`
|
|
79
|
+
* object.
|
|
83
80
|
*/
|
|
84
81
|
includeDirectChildren?: boolean | undefined;
|
|
85
82
|
/**
|
|
86
|
-
* Includes operations associated with this folder in the response
|
|
83
|
+
* Includes operations associated with this folder in the response, as defined in
|
|
84
|
+
* the `Operation` object.
|
|
87
85
|
* The number of results will be limited to 50 and sorted in the default sort
|
|
88
86
|
* order.
|
|
89
87
|
* A `meta` and `_links` property will be present to indicate if more results are
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"FolderService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/FolderService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAAsF;AACtF,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,aAAc,SAAQ,qCAAiB;IAApD;;QACE;;;;;;;;;;;;WAYG;QACH,iBAAY,GAAG,CAAC,EACd,WAAW,EAYZ,EASG,EAAE;YACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAYlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3J,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,iBAAY,GAAG,CAAC,EACd,EAAE,EAIH,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,kBAAa,GAAG,CAAC,EACf,EAAE,EACF,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,
|
|
1
|
+
{"version":3,"file":"FolderService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/FolderService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAAsF;AACtF,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,aAAc,SAAQ,qCAAiB;IAApD;;QACE;;;;;;;;;;;;WAYG;QACH,iBAAY,GAAG,CAAC,EACd,WAAW,EAYZ,EASG,EAAE;YACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,UAAU;gBAChB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,WAAW;aAClB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAYlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,qCAAqC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3J,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,iBAAY,GAAG,CAAC,EACd,EAAE,EAIH,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;iBACH;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,kBAAa,GAAG,CAAC,EACf,EAAE,EACF,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACjB,iBAAiB,EA4BlB,EASG,EAAE;YACJ,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,eAAe;gBACrB,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,uBAAuB,EAAE,oBAAoB;oBAC7C,yBAAyB,EAAE,qBAAqB;oBAChD,oBAAoB,EAAE,iBAAiB;oBACvC,oBAAoB,EAAE,iBAAiB;iBACxC;aACF,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAYlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,sCAAsC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC5J,CAAC,CAAC;IAsBJ,CAAC;IArBW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,qCAAqC,EAAE,OAAC,CAAC,MAAM,CAAC;YACzF,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC;gBAC1E,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;oBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;aACpC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1B,CAAC,CAAC,QAAQ,CAAC,qCAAqC,CAAC,CAAC,CAAC;QACpD,iDAAuB,CAAC,kBAAkB,CAAC,sCAAsC,EAAE,OAAC,CAAC,MAAM,CAAC;YAC1F,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,YAAY,CAAC,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC,EAAE,OAAC,CAAC,MAAM,CAAC;gBAC1E,MAAM,EAAE,OAAC,CAAC,MAAM,CAAC;oBACf,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE;aACpC,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CAAC;SAC1B,CAAC,CAAC,QAAQ,CAAC,sCAAsC,CAAC,CAAC,CAAC;QACrD,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AApMD,sCAoMC"}
|
|
@@ -52,6 +52,11 @@ export declare class PageService extends CommonHttpService {
|
|
|
52
52
|
*/
|
|
53
53
|
parentId?: string | undefined;
|
|
54
54
|
body?: PageBodyWrite | PageNestedBodyWrite | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* The subtype of the page. Provide the subtype live to create a live doc or no
|
|
57
|
+
* subtype to create a page.
|
|
58
|
+
*/
|
|
59
|
+
subtype?: "live" | undefined;
|
|
55
60
|
} & {
|
|
56
61
|
[key: string]: unknown;
|
|
57
62
|
};
|
|
@@ -156,7 +161,7 @@ export declare class PageService extends CommonHttpService {
|
|
|
156
161
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page#api-pages-id-get
|
|
157
162
|
* @param params
|
|
158
163
|
*/
|
|
159
|
-
getPageById: ({ id, bodyFormat, getDraft, status, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, includeWebresources, includeCollaborators }: {
|
|
164
|
+
getPageById: ({ id, bodyFormat, getDraft, status, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, includeWebresources, includeCollaborators, includeDirectChildren }: {
|
|
160
165
|
/**
|
|
161
166
|
* The ID of the page to be returned. If you don't know the page ID, use Get pages
|
|
162
167
|
* and filter the results.
|
|
@@ -171,7 +176,7 @@ export declare class PageService extends CommonHttpService {
|
|
|
171
176
|
/** Retrieve the draft version of this page. */
|
|
172
177
|
getDraft?: boolean | undefined;
|
|
173
178
|
/** Filter the page being retrieved by its status. */
|
|
174
|
-
status?: ("current" | "
|
|
179
|
+
status?: ("current" | "draft" | "archived" | "historical" | "trashed" | "deleted")[] | undefined;
|
|
175
180
|
/**
|
|
176
181
|
* Allows you to retrieve a previously published version. Specify the previous
|
|
177
182
|
* version's number to retrieve its details.
|
|
@@ -194,7 +199,8 @@ export declare class PageService extends CommonHttpService {
|
|
|
194
199
|
*/
|
|
195
200
|
includeProperties?: boolean | undefined;
|
|
196
201
|
/**
|
|
197
|
-
* Includes operations associated with this page in the response
|
|
202
|
+
* Includes operations associated with this page in the response, as defined in
|
|
203
|
+
* the `Operation` object.
|
|
198
204
|
* The number of results will be limited to 50 and sorted in the default sort
|
|
199
205
|
* order.
|
|
200
206
|
* A `meta` and `_links` property will be present to indicate if more results are
|
|
@@ -228,6 +234,11 @@ export declare class PageService extends CommonHttpService {
|
|
|
228
234
|
includeWebresources?: boolean | undefined;
|
|
229
235
|
/** Includes collaborators on the page. */
|
|
230
236
|
includeCollaborators?: boolean | undefined;
|
|
237
|
+
/**
|
|
238
|
+
* Includes direct children of the page, as defined in the `ChildrenResponse`
|
|
239
|
+
* object.
|
|
240
|
+
*/
|
|
241
|
+
includeDirectChildren?: boolean | undefined;
|
|
231
242
|
}) => Promise<PageSingle & {
|
|
232
243
|
_links?: ({
|
|
233
244
|
/** Base url of the Confluence site. */
|
|
@@ -253,7 +264,7 @@ export declare class PageService extends CommonHttpService {
|
|
|
253
264
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page#api-pages-get
|
|
254
265
|
* @param params
|
|
255
266
|
*/
|
|
256
|
-
getPages: ({ id, spaceId, sort, status, title, bodyFormat, cursor, limit }?: {
|
|
267
|
+
getPages: ({ id, spaceId, sort, status, title, bodyFormat, subtype, cursor, limit }?: {
|
|
257
268
|
/**
|
|
258
269
|
* Filter the results based on page ids. Multiple page ids can be specified as a
|
|
259
270
|
* comma-separated list.
|
|
@@ -270,7 +281,7 @@ export declare class PageService extends CommonHttpService {
|
|
|
270
281
|
* Filter the results to pages based on their status. By default, `current` and
|
|
271
282
|
* `archived` are used.
|
|
272
283
|
*/
|
|
273
|
-
status?: ("current" | "
|
|
284
|
+
status?: ("current" | "archived" | "trashed" | "deleted")[] | undefined;
|
|
274
285
|
/** Filter the results to pages based on their title. */
|
|
275
286
|
title?: string | undefined;
|
|
276
287
|
/**
|
|
@@ -279,6 +290,8 @@ export declare class PageService extends CommonHttpService {
|
|
|
279
290
|
* same name under the `body` field.
|
|
280
291
|
*/
|
|
281
292
|
bodyFormat?: PrimaryBodyRepresentation | undefined;
|
|
293
|
+
/** Filter the results to pages based on their subtype. */
|
|
294
|
+
subtype?: "page" | "live" | undefined;
|
|
282
295
|
/**
|
|
283
296
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
284
297
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
@@ -327,7 +340,7 @@ export declare class PageService extends CommonHttpService {
|
|
|
327
340
|
* Filter the results to pages based on their status. By default, `current` and
|
|
328
341
|
* `archived` are used.
|
|
329
342
|
*/
|
|
330
|
-
status?: ("current" | "
|
|
343
|
+
status?: ("current" | "archived" | "trashed" | "deleted")[] | undefined;
|
|
331
344
|
/** Filter the results to pages based on their title. */
|
|
332
345
|
title?: string | undefined;
|
|
333
346
|
/**
|
|
@@ -403,7 +416,7 @@ export declare class PageService extends CommonHttpService {
|
|
|
403
416
|
*/
|
|
404
417
|
spaceId?: unknown;
|
|
405
418
|
/**
|
|
406
|
-
* ID of the parent
|
|
419
|
+
* ID of the parent content.
|
|
407
420
|
*
|
|
408
421
|
* This allows the page to be moved under a different parent within the same space.
|
|
409
422
|
*/
|
|
@@ -442,5 +455,42 @@ export declare class PageService extends CommonHttpService {
|
|
|
442
455
|
} & {
|
|
443
456
|
[key: string]: unknown;
|
|
444
457
|
}>;
|
|
458
|
+
/**
|
|
459
|
+
* Updates the title of a specified page.
|
|
460
|
+
*
|
|
461
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
462
|
+
* Permission to view the page and its corresponding space. Permission to update
|
|
463
|
+
* pages in the space.
|
|
464
|
+
*
|
|
465
|
+
* @returns Returned if the requested page is successfully updated.
|
|
466
|
+
* @path PUT `/pages/{id}/title`
|
|
467
|
+
* @scopes-current write:page:confluence
|
|
468
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page#api-pages-id-title-put
|
|
469
|
+
* @param params
|
|
470
|
+
*/
|
|
471
|
+
updatePageTitle: ({ id, requestBody }: {
|
|
472
|
+
/**
|
|
473
|
+
* The ID of the page to be updated. If you don't know the page ID, use Get Pages
|
|
474
|
+
* and filter the results
|
|
475
|
+
*/
|
|
476
|
+
id: number;
|
|
477
|
+
requestBody: {
|
|
478
|
+
/** The status of the page, current or draft. */
|
|
479
|
+
status: "current" | "draft";
|
|
480
|
+
/** The updated title for the page */
|
|
481
|
+
title: string;
|
|
482
|
+
} & {
|
|
483
|
+
[key: string]: unknown;
|
|
484
|
+
};
|
|
485
|
+
}) => Promise<PageSingle & {
|
|
486
|
+
_links?: ({
|
|
487
|
+
/** Base url of the Confluence site. */
|
|
488
|
+
base?: string | undefined;
|
|
489
|
+
} & {
|
|
490
|
+
[key: string]: unknown;
|
|
491
|
+
}) | undefined;
|
|
492
|
+
} & {
|
|
493
|
+
[key: string]: unknown;
|
|
494
|
+
}>;
|
|
445
495
|
protected static initialize(): void;
|
|
446
496
|
}
|
|
@@ -134,7 +134,7 @@ class PageService extends CommonHttpService_1.CommonHttpService {
|
|
|
134
134
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page#api-pages-id-get
|
|
135
135
|
* @param params
|
|
136
136
|
*/
|
|
137
|
-
this.getPageById = ({ id, bodyFormat, getDraft, status, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, includeWebresources, includeCollaborators }) => {
|
|
137
|
+
this.getPageById = ({ id, bodyFormat, getDraft, status, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, includeWebresources, includeCollaborators, includeDirectChildren }) => {
|
|
138
138
|
return this.getClientInstance().request({
|
|
139
139
|
path: "/pages/{id}",
|
|
140
140
|
method: "GET",
|
|
@@ -154,7 +154,8 @@ class PageService extends CommonHttpService_1.CommonHttpService {
|
|
|
154
154
|
"include-version": includeVersion,
|
|
155
155
|
"include-favorited-by-current-user-status": includeFavoritedByCurrentUserStatus,
|
|
156
156
|
"include-webresources": includeWebresources,
|
|
157
|
-
"include-collaborators": includeCollaborators
|
|
157
|
+
"include-collaborators": includeCollaborators,
|
|
158
|
+
"include-direct-children": includeDirectChildren
|
|
158
159
|
}
|
|
159
160
|
}).then(this.getClientInstance().responseHandler({
|
|
160
161
|
200: {
|
|
@@ -177,7 +178,7 @@ class PageService extends CommonHttpService_1.CommonHttpService {
|
|
|
177
178
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page#api-pages-get
|
|
178
179
|
* @param params
|
|
179
180
|
*/
|
|
180
|
-
this.getPages = ({ id, spaceId, sort, status, title, bodyFormat, cursor, limit } = {}) => {
|
|
181
|
+
this.getPages = ({ id, spaceId, sort, status, title, bodyFormat, subtype, cursor, limit } = {}) => {
|
|
181
182
|
return this.getClientInstance().request({
|
|
182
183
|
path: "/pages",
|
|
183
184
|
method: "GET",
|
|
@@ -188,6 +189,7 @@ class PageService extends CommonHttpService_1.CommonHttpService {
|
|
|
188
189
|
status,
|
|
189
190
|
title,
|
|
190
191
|
"body-format": bodyFormat,
|
|
192
|
+
subtype,
|
|
191
193
|
cursor,
|
|
192
194
|
limit
|
|
193
195
|
}
|
|
@@ -272,6 +274,36 @@ class PageService extends CommonHttpService_1.CommonHttpService {
|
|
|
272
274
|
}
|
|
273
275
|
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("PageService.updatePage.response"))).then(commonHttpClient.getBody);
|
|
274
276
|
};
|
|
277
|
+
/**
|
|
278
|
+
* Updates the title of a specified page.
|
|
279
|
+
*
|
|
280
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
281
|
+
* Permission to view the page and its corresponding space. Permission to update
|
|
282
|
+
* pages in the space.
|
|
283
|
+
*
|
|
284
|
+
* @returns Returned if the requested page is successfully updated.
|
|
285
|
+
* @path PUT `/pages/{id}/title`
|
|
286
|
+
* @scopes-current write:page:confluence
|
|
287
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page#api-pages-id-title-put
|
|
288
|
+
* @param params
|
|
289
|
+
*/
|
|
290
|
+
this.updatePageTitle = ({ id, requestBody }) => {
|
|
291
|
+
return this.getClientInstance().request({
|
|
292
|
+
path: "/pages/{id}/title",
|
|
293
|
+
method: "PUT",
|
|
294
|
+
pathParams: {
|
|
295
|
+
id
|
|
296
|
+
},
|
|
297
|
+
headers: {
|
|
298
|
+
"Content-Type": "application/json"
|
|
299
|
+
},
|
|
300
|
+
body: requestBody
|
|
301
|
+
}).then(this.getClientInstance().responseHandler({
|
|
302
|
+
200: {
|
|
303
|
+
"application/json": "json"
|
|
304
|
+
}
|
|
305
|
+
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("PageService.updatePageTitle.response"))).then(commonHttpClient.getBody);
|
|
306
|
+
};
|
|
275
307
|
}
|
|
276
308
|
static initialize() {
|
|
277
309
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.getLabelPages.response", zod_1.z.object({
|
|
@@ -317,6 +349,15 @@ class PageService extends CommonHttpService_1.CommonHttpService {
|
|
|
317
349
|
}).catchall(zod_1.z.unknown()).optional()
|
|
318
350
|
}).catchall(zod_1.z.unknown()))
|
|
319
351
|
}).describe("PageService.updatePage.response"));
|
|
352
|
+
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.updatePageTitle.response", zod_1.z.object({
|
|
353
|
+
status: zod_1.z.literal(200),
|
|
354
|
+
mediaType: zod_1.z.literal("application/json"),
|
|
355
|
+
body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("PageSingle"), zod_1.z.object({
|
|
356
|
+
_links: zod_1.z.object({
|
|
357
|
+
base: zod_1.z.string().optional()
|
|
358
|
+
}).catchall(zod_1.z.unknown()).optional()
|
|
359
|
+
}).catchall(zod_1.z.unknown()))
|
|
360
|
+
}).describe("PageService.updatePageTitle.response"));
|
|
320
361
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("PageService.getPagesInSpace.response", zod_1.z.object({
|
|
321
362
|
status: zod_1.z.literal(200),
|
|
322
363
|
mediaType: zod_1.z.literal("application/json"),
|