@resolution/confluence-api-client 0.13.4 → 0.14.0
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/contentChildrenAndDescendants.d.ts +7 -3
- package/lib/openapi/v1/models/contentChildrenAndDescendants.js +1 -1
- package/lib/openapi/v1/models/contentChildrenAndDescendants.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 +5 -220
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +4 -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 +22 -3
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js +25 -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/services/AdminKeyService.d.ts +71 -0
- package/lib/openapi/v2/services/AdminKeyService.js +111 -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 +49 -6
- package/lib/openapi/v2/services/PageService.js +42 -2
- 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
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
|
-
import { type
|
|
2
|
+
import { type Content, type ContentChildren, type ContentArray, type LongTask } from "../models/common";
|
|
3
3
|
import { type CopyPageRequest, type CopyPageHierarchyRequest, type ContentId } from "../models/contentChildrenAndDescendants";
|
|
4
4
|
/**
|
|
5
5
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants
|
|
@@ -17,6 +17,8 @@ export declare class ContentChildrenAndDescendantsService extends CommonHttpServ
|
|
|
17
17
|
* - `space`: page will be copied to the specified space as a root page on the
|
|
18
18
|
* space
|
|
19
19
|
* - `parent_page`: page will be copied as a child of the specified parent page
|
|
20
|
+
* - `parent_content`: page will be copied as a child of the specified parent
|
|
21
|
+
* content
|
|
20
22
|
* - `existing_page`: page will be copied and replace the specified page
|
|
21
23
|
*
|
|
22
24
|
* By default, the following objects are expanded: `space`, `history`, `version`.
|
|
@@ -168,225 +170,6 @@ export declare class ContentChildrenAndDescendantsService extends CommonHttpServ
|
|
|
168
170
|
/** Request object from json post body */
|
|
169
171
|
copyPageHierarchyRequest: CopyPageHierarchyRequest;
|
|
170
172
|
}) => Promise<LongTask>;
|
|
171
|
-
/**
|
|
172
|
-
* Deprecated, use [Confluence's v2
|
|
173
|
-
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
174
|
-
*
|
|
175
|
-
* Returns a map of the direct children of a piece of content. A piece of content
|
|
176
|
-
* has different types of child content, depending on its type. These are
|
|
177
|
-
* the default parent-child content type relationships:
|
|
178
|
-
*
|
|
179
|
-
* - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
|
|
180
|
-
* `comment`, `attachment`
|
|
181
|
-
* - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
182
|
-
* `folder`, `comment`, `attachment`
|
|
183
|
-
* - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
184
|
-
* `folder`, `comment`, `attachment`
|
|
185
|
-
* - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
186
|
-
* `folder`, `comment`, `attachment`
|
|
187
|
-
* - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
188
|
-
* `folder`, `comment`, `attachment`
|
|
189
|
-
* - `blogpost`: child content is `comment`, `attachment`
|
|
190
|
-
* - `attachment`: child content is `comment`
|
|
191
|
-
* - `comment`: child content is `attachment`
|
|
192
|
-
*
|
|
193
|
-
* Apps can override these default relationships. Apps can also introduce
|
|
194
|
-
* new content types that create new parent-child content relationships.
|
|
195
|
-
*
|
|
196
|
-
* Note, the map will always include all child content types that are valid
|
|
197
|
-
* for the content. However, if the content has no instances of a child content
|
|
198
|
-
* type, the map will contain an empty array for that child content type.
|
|
199
|
-
*
|
|
200
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
|
|
201
|
-
* permission for the space,
|
|
202
|
-
* and permission to view the content if it is a page.
|
|
203
|
-
*
|
|
204
|
-
* @deprecated
|
|
205
|
-
* @returns Returned if the requested content children are returned.
|
|
206
|
-
* @path GET `/wiki/rest/api/content/{id}/child`
|
|
207
|
-
* @scopes-current read:confluence-content.summary
|
|
208
|
-
* @scopes-beta read:content-details:confluence
|
|
209
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants#api-wiki-rest-api-content-id-child-get
|
|
210
|
-
* @param params
|
|
211
|
-
*/
|
|
212
|
-
getContentChildren: ({ id, expand, parentVersion }: {
|
|
213
|
-
/** The ID of the content to be queried for its children. */
|
|
214
|
-
id: string;
|
|
215
|
-
/**
|
|
216
|
-
* A multi-value parameter indicating which properties of the children to expand,
|
|
217
|
-
* where:
|
|
218
|
-
*
|
|
219
|
-
* - `attachment` returns all attachments for the content.
|
|
220
|
-
* - `comments` returns all comments for the content.
|
|
221
|
-
* - `page` returns all child pages of the content.
|
|
222
|
-
* - `whiteboard` returns all child whiteboards of the content.
|
|
223
|
-
* - `database` returns all child databases of the content.
|
|
224
|
-
* - `embed` returns all child embeds of the content.
|
|
225
|
-
* - `folder` returns all child folders of the content.
|
|
226
|
-
* - Custom content types that are provided by apps are also supported.
|
|
227
|
-
*/
|
|
228
|
-
expand?: string[] | undefined;
|
|
229
|
-
/**
|
|
230
|
-
* The version of the parent content to retrieve children for.
|
|
231
|
-
* Currently, this only works for the latest version.
|
|
232
|
-
*/
|
|
233
|
-
parentVersion?: number | undefined;
|
|
234
|
-
}) => Promise<ContentChildren>;
|
|
235
|
-
/**
|
|
236
|
-
* Deprecated, use [Confluence's v2
|
|
237
|
-
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
238
|
-
*
|
|
239
|
-
* Returns all children of a given type, for a piece of content.
|
|
240
|
-
* A piece of content has different types of child content, depending on its type:
|
|
241
|
-
*
|
|
242
|
-
* - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
|
|
243
|
-
* `comment`, `attachment`
|
|
244
|
-
* - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
245
|
-
* `folder`, `comment`, `attachment`
|
|
246
|
-
* - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
247
|
-
* `folder`, `comment`, `attachment`
|
|
248
|
-
* - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
249
|
-
* `folder`, `comment`, `attachment`
|
|
250
|
-
* - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
251
|
-
* `folder`, `comment`, `attachment`
|
|
252
|
-
* - `blogpost`: child content is `comment`, `attachment`
|
|
253
|
-
* - `attachment`: child content is `comment`
|
|
254
|
-
* - `comment`: child content is `attachment`
|
|
255
|
-
*
|
|
256
|
-
* Custom content types that are provided by apps can also be returned.
|
|
257
|
-
*
|
|
258
|
-
* Note, this method only returns direct children. To return children at all
|
|
259
|
-
* levels, use [Get descendants by type](#api-content-id-descendant-type-get).
|
|
260
|
-
*
|
|
261
|
-
* If the expand query parameter is used with the `body.export_view` and/or
|
|
262
|
-
* `body.styled_view` properties, then the query limit parameter will be
|
|
263
|
-
* restricted to a maximum value of 25.
|
|
264
|
-
*
|
|
265
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
|
|
266
|
-
* permission for the space,
|
|
267
|
-
* and permission to view the content if it is a page.
|
|
268
|
-
*
|
|
269
|
-
* @deprecated
|
|
270
|
-
* @returns Returned if the requested content is returned.
|
|
271
|
-
* @path GET `/wiki/rest/api/content/{id}/child/{type}`
|
|
272
|
-
* @scopes-current read:confluence-content.summary
|
|
273
|
-
* @scopes-beta read:content-details:confluence
|
|
274
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants#api-wiki-rest-api-content-id-child-type-get
|
|
275
|
-
* @param params
|
|
276
|
-
*/
|
|
277
|
-
getContentChildrenByType: ({ id, type, expand, parentVersion, start, limit }: {
|
|
278
|
-
/** The ID of the content to be queried for its children. */
|
|
279
|
-
id: string;
|
|
280
|
-
/** The type of children to return. */
|
|
281
|
-
type: string;
|
|
282
|
-
/**
|
|
283
|
-
* A multi-value parameter indicating which properties of the content to expand.
|
|
284
|
-
*
|
|
285
|
-
* - `childTypes.all` returns whether the content has attachments, comments, or
|
|
286
|
-
* child pages/whiteboards.
|
|
287
|
-
* Use this if you only need to check whether the content has children of a
|
|
288
|
-
* particular type.
|
|
289
|
-
* - `childTypes.attachment` returns whether the content has attachments.
|
|
290
|
-
* - `childTypes.comment` returns whether the content has comments.
|
|
291
|
-
* - `childTypes.page` returns whether the content has child pages.
|
|
292
|
-
* - `childTypes.whiteboard` returns whether the content has child whiteboards.
|
|
293
|
-
* - `childTypes.database` returns whether the content has child databases.
|
|
294
|
-
* - `childTypes.embed` returns whether the content has child embeds (smartlinks).
|
|
295
|
-
* - `childTypes.folder` returns whether the content has child folders.
|
|
296
|
-
* - `container` returns the space that the content is in. This is the same as the
|
|
297
|
-
* information
|
|
298
|
-
* returned by [Get space](#api-space-spaceKey-get).
|
|
299
|
-
* - `metadata.currentuser` returns information about the current user in relation
|
|
300
|
-
* to the content,
|
|
301
|
-
* including when they last viewed it, modified it, contributed to it, or added it
|
|
302
|
-
* as a favorite.
|
|
303
|
-
* - `metadata.properties` returns content properties that have been set via the
|
|
304
|
-
* Confluence REST API.
|
|
305
|
-
* - `metadata.labels` returns the labels that have been added to the content.
|
|
306
|
-
* - `metadata.frontend` this property is only used by Atlassian.
|
|
307
|
-
* - `operations` returns the operations for the content, which are used when
|
|
308
|
-
* setting permissions.
|
|
309
|
-
* - `children.page` returns pages that are descendants at the level immediately
|
|
310
|
-
* below the content.
|
|
311
|
-
* - `children.whiteboard` returns whiteboards that are descendants at the level
|
|
312
|
-
* immediately below the content.
|
|
313
|
-
* - `children.database` returns databases that are descendants at the level
|
|
314
|
-
* immediately below the content.
|
|
315
|
-
* - `children.embed` returns embeds (smartlinks) that are descendants at the
|
|
316
|
-
* level immediately below the content.
|
|
317
|
-
* - `children.folder` returns folders that are descendants at the level
|
|
318
|
-
* immediately below the content.
|
|
319
|
-
* - `children.attachment` returns all attachments for the content.
|
|
320
|
-
* - `children.comment` returns all comments on the content.
|
|
321
|
-
* - `restrictions.read.restrictions.user` returns the users that have permission
|
|
322
|
-
* to read the content.
|
|
323
|
-
* - `restrictions.read.restrictions.group` returns the groups that have
|
|
324
|
-
* permission to read the content. Note that
|
|
325
|
-
* this may return deleted groups, because deleting a group doesn't remove
|
|
326
|
-
* associated restrictions.
|
|
327
|
-
* - `restrictions.update.restrictions.user` returns the users that have
|
|
328
|
-
* permission to update the content.
|
|
329
|
-
* - `restrictions.update.restrictions.group` returns the groups that have
|
|
330
|
-
* permission to update the content. Note that
|
|
331
|
-
* this may return deleted groups because deleting a group doesn't remove
|
|
332
|
-
* associated restrictions.
|
|
333
|
-
* - `history` returns the history of the content, including the date it was
|
|
334
|
-
* created.
|
|
335
|
-
* - `history.lastUpdated` returns information about the most recent update of the
|
|
336
|
-
* content, including
|
|
337
|
-
* who updated it and when it was updated.
|
|
338
|
-
* - `history.previousVersion` returns information about the update prior to the
|
|
339
|
-
* current content update.
|
|
340
|
-
* - `history.contributors` returns all of the users who have contributed to the
|
|
341
|
-
* content.
|
|
342
|
-
* - `history.nextVersion` returns information about the update after to the
|
|
343
|
-
* current content update.
|
|
344
|
-
* - `ancestors` returns the parent content, if the content is a page or
|
|
345
|
-
* whiteboard.
|
|
346
|
-
* - `body` returns the body of the content in different formats, including the
|
|
347
|
-
* editor format,
|
|
348
|
-
* view format, and export format.
|
|
349
|
-
* - `body.storage` returns the body of content in storage format.
|
|
350
|
-
* - `body.view` returns the body of content in view format.
|
|
351
|
-
* - `version` returns information about the most recent update of the content,
|
|
352
|
-
* including who updated it
|
|
353
|
-
* and when it was updated.
|
|
354
|
-
* - `descendants.page` returns pages that are descendants at any level below the
|
|
355
|
-
* content.
|
|
356
|
-
* - `descendants.whiteboard` returns whiteboards that are descendants at any
|
|
357
|
-
* level below the content.
|
|
358
|
-
* - `descendants.database` returns databases that are descendants at any level
|
|
359
|
-
* below the content.
|
|
360
|
-
* - `descendants.embed` returns embeds (smartlinks) that are descendants at any
|
|
361
|
-
* level below the content.
|
|
362
|
-
* - `descendants.folder` returns folders that are descendants at any level below
|
|
363
|
-
* the content.
|
|
364
|
-
* - `descendants.attachment` returns all attachments for the content, same as
|
|
365
|
-
* `children.attachment`.
|
|
366
|
-
* - `descendants.comment` returns all comments on the content, same as
|
|
367
|
-
* `children.comment`.
|
|
368
|
-
* - `space` returns the space that the content is in. This is the same as the
|
|
369
|
-
* information returned by
|
|
370
|
-
* [Get space](#api-space-spaceKey-get).
|
|
371
|
-
*
|
|
372
|
-
* In addition, the following comment-specific expansions can be used:
|
|
373
|
-
* - `extensions.inlineProperties` returns inline comment-specific properties.
|
|
374
|
-
* - `extensions.resolution` returns the resolution status of each comment.
|
|
375
|
-
*/
|
|
376
|
-
expand?: string[] | undefined;
|
|
377
|
-
/**
|
|
378
|
-
* The version of the parent content to retrieve children for.
|
|
379
|
-
* Currently, this only works for the latest version.
|
|
380
|
-
*/
|
|
381
|
-
parentVersion?: number | undefined;
|
|
382
|
-
/** The starting index of the returned content. */
|
|
383
|
-
start?: number | undefined;
|
|
384
|
-
/**
|
|
385
|
-
* The maximum number of content to return per page. Note,
|
|
386
|
-
* this may be restricted by fixed system limits.
|
|
387
|
-
*/
|
|
388
|
-
limit?: number | undefined;
|
|
389
|
-
}) => Promise<ContentArray>;
|
|
390
173
|
/**
|
|
391
174
|
* Returns a map of the descendants of a piece of content. This is similar
|
|
392
175
|
* to [Get content children](#api-content-id-child-get), except that this
|
|
@@ -417,6 +200,7 @@ export declare class ContentChildrenAndDescendantsService extends CommonHttpServ
|
|
|
417
200
|
* 'View' permission for the space, and permission to view the content if it
|
|
418
201
|
* is a page.
|
|
419
202
|
*
|
|
203
|
+
* @deprecated
|
|
420
204
|
* @returns Returned if the requested descendants are returned.
|
|
421
205
|
* @path GET `/wiki/rest/api/content/{id}/descendant`
|
|
422
206
|
* @scopes-current read:confluence-content.summary
|
|
@@ -473,6 +257,7 @@ export declare class ContentChildrenAndDescendantsService extends CommonHttpServ
|
|
|
473
257
|
* 'View' permission for the space, and permission to view the content if it
|
|
474
258
|
* is a page.
|
|
475
259
|
*
|
|
260
|
+
* @deprecated
|
|
476
261
|
* @returns Returned if the requested content is returned.
|
|
477
262
|
* @path GET `/wiki/rest/api/content/{id}/descendant/{type}`
|
|
478
263
|
* @scopes-current read:confluence-content.summary
|
|
@@ -28,6 +28,8 @@ class ContentChildrenAndDescendantsService extends CommonHttpService_1.CommonHtt
|
|
|
28
28
|
* - `space`: page will be copied to the specified space as a root page on the
|
|
29
29
|
* space
|
|
30
30
|
* - `parent_page`: page will be copied as a child of the specified parent page
|
|
31
|
+
* - `parent_content`: page will be copied as a child of the specified parent
|
|
32
|
+
* content
|
|
31
33
|
* - `existing_page`: page will be copied and replace the specified page
|
|
32
34
|
*
|
|
33
35
|
* By default, the following objects are expanded: `space`, `history`, `version`.
|
|
@@ -117,140 +119,6 @@ class ContentChildrenAndDescendantsService extends CommonHttpService_1.CommonHtt
|
|
|
117
119
|
}
|
|
118
120
|
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.copyPageHierarchy.response"))).then(commonHttpClient.getBody);
|
|
119
121
|
};
|
|
120
|
-
/**
|
|
121
|
-
* Deprecated, use [Confluence's v2
|
|
122
|
-
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
123
|
-
*
|
|
124
|
-
* Returns a map of the direct children of a piece of content. A piece of content
|
|
125
|
-
* has different types of child content, depending on its type. These are
|
|
126
|
-
* the default parent-child content type relationships:
|
|
127
|
-
*
|
|
128
|
-
* - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
|
|
129
|
-
* `comment`, `attachment`
|
|
130
|
-
* - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
131
|
-
* `folder`, `comment`, `attachment`
|
|
132
|
-
* - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
133
|
-
* `folder`, `comment`, `attachment`
|
|
134
|
-
* - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
135
|
-
* `folder`, `comment`, `attachment`
|
|
136
|
-
* - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
137
|
-
* `folder`, `comment`, `attachment`
|
|
138
|
-
* - `blogpost`: child content is `comment`, `attachment`
|
|
139
|
-
* - `attachment`: child content is `comment`
|
|
140
|
-
* - `comment`: child content is `attachment`
|
|
141
|
-
*
|
|
142
|
-
* Apps can override these default relationships. Apps can also introduce
|
|
143
|
-
* new content types that create new parent-child content relationships.
|
|
144
|
-
*
|
|
145
|
-
* Note, the map will always include all child content types that are valid
|
|
146
|
-
* for the content. However, if the content has no instances of a child content
|
|
147
|
-
* type, the map will contain an empty array for that child content type.
|
|
148
|
-
*
|
|
149
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
|
|
150
|
-
* permission for the space,
|
|
151
|
-
* and permission to view the content if it is a page.
|
|
152
|
-
*
|
|
153
|
-
* @deprecated
|
|
154
|
-
* @returns Returned if the requested content children are returned.
|
|
155
|
-
* @path GET `/wiki/rest/api/content/{id}/child`
|
|
156
|
-
* @scopes-current read:confluence-content.summary
|
|
157
|
-
* @scopes-beta read:content-details:confluence
|
|
158
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants#api-wiki-rest-api-content-id-child-get
|
|
159
|
-
* @param params
|
|
160
|
-
*/
|
|
161
|
-
this.getContentChildren = ({ id, expand, parentVersion }) => {
|
|
162
|
-
return this.getClientInstance().request({
|
|
163
|
-
path: "/wiki/rest/api/content/{id}/child",
|
|
164
|
-
method: "GET",
|
|
165
|
-
pathParams: {
|
|
166
|
-
id
|
|
167
|
-
},
|
|
168
|
-
query: {
|
|
169
|
-
expand,
|
|
170
|
-
parentVersion
|
|
171
|
-
},
|
|
172
|
-
parameters: {
|
|
173
|
-
query: {
|
|
174
|
-
expand: {
|
|
175
|
-
explode: false
|
|
176
|
-
}
|
|
177
|
-
}
|
|
178
|
-
}
|
|
179
|
-
}).then(this.getClientInstance().responseHandler({
|
|
180
|
-
200: {
|
|
181
|
-
"application/json": "json"
|
|
182
|
-
}
|
|
183
|
-
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.getContentChildren.response"))).then(commonHttpClient.getBody);
|
|
184
|
-
};
|
|
185
|
-
/**
|
|
186
|
-
* Deprecated, use [Confluence's v2
|
|
187
|
-
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
188
|
-
*
|
|
189
|
-
* Returns all children of a given type, for a piece of content.
|
|
190
|
-
* A piece of content has different types of child content, depending on its type:
|
|
191
|
-
*
|
|
192
|
-
* - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
|
|
193
|
-
* `comment`, `attachment`
|
|
194
|
-
* - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
195
|
-
* `folder`, `comment`, `attachment`
|
|
196
|
-
* - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
197
|
-
* `folder`, `comment`, `attachment`
|
|
198
|
-
* - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
199
|
-
* `folder`, `comment`, `attachment`
|
|
200
|
-
* - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
|
|
201
|
-
* `folder`, `comment`, `attachment`
|
|
202
|
-
* - `blogpost`: child content is `comment`, `attachment`
|
|
203
|
-
* - `attachment`: child content is `comment`
|
|
204
|
-
* - `comment`: child content is `attachment`
|
|
205
|
-
*
|
|
206
|
-
* Custom content types that are provided by apps can also be returned.
|
|
207
|
-
*
|
|
208
|
-
* Note, this method only returns direct children. To return children at all
|
|
209
|
-
* levels, use [Get descendants by type](#api-content-id-descendant-type-get).
|
|
210
|
-
*
|
|
211
|
-
* If the expand query parameter is used with the `body.export_view` and/or
|
|
212
|
-
* `body.styled_view` properties, then the query limit parameter will be
|
|
213
|
-
* restricted to a maximum value of 25.
|
|
214
|
-
*
|
|
215
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
|
|
216
|
-
* permission for the space,
|
|
217
|
-
* and permission to view the content if it is a page.
|
|
218
|
-
*
|
|
219
|
-
* @deprecated
|
|
220
|
-
* @returns Returned if the requested content is returned.
|
|
221
|
-
* @path GET `/wiki/rest/api/content/{id}/child/{type}`
|
|
222
|
-
* @scopes-current read:confluence-content.summary
|
|
223
|
-
* @scopes-beta read:content-details:confluence
|
|
224
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-children-and-descendants#api-wiki-rest-api-content-id-child-type-get
|
|
225
|
-
* @param params
|
|
226
|
-
*/
|
|
227
|
-
this.getContentChildrenByType = ({ id, type, expand, parentVersion, start, limit }) => {
|
|
228
|
-
return this.getClientInstance().request({
|
|
229
|
-
path: "/wiki/rest/api/content/{id}/child/{type}",
|
|
230
|
-
method: "GET",
|
|
231
|
-
pathParams: {
|
|
232
|
-
id,
|
|
233
|
-
type
|
|
234
|
-
},
|
|
235
|
-
query: {
|
|
236
|
-
expand,
|
|
237
|
-
parentVersion,
|
|
238
|
-
start,
|
|
239
|
-
limit
|
|
240
|
-
},
|
|
241
|
-
parameters: {
|
|
242
|
-
query: {
|
|
243
|
-
expand: {
|
|
244
|
-
explode: false
|
|
245
|
-
}
|
|
246
|
-
}
|
|
247
|
-
}
|
|
248
|
-
}).then(this.getClientInstance().responseHandler({
|
|
249
|
-
200: {
|
|
250
|
-
"application/json": "json"
|
|
251
|
-
}
|
|
252
|
-
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentChildrenAndDescendantsService.getContentChildrenByType.response"))).then(commonHttpClient.getBody);
|
|
253
|
-
};
|
|
254
122
|
/**
|
|
255
123
|
* Returns a map of the descendants of a piece of content. This is similar
|
|
256
124
|
* to [Get content children](#api-content-id-child-get), except that this
|
|
@@ -281,6 +149,7 @@ class ContentChildrenAndDescendantsService extends CommonHttpService_1.CommonHtt
|
|
|
281
149
|
* 'View' permission for the space, and permission to view the content if it
|
|
282
150
|
* is a page.
|
|
283
151
|
*
|
|
152
|
+
* @deprecated
|
|
284
153
|
* @returns Returned if the requested descendants are returned.
|
|
285
154
|
* @path GET `/wiki/rest/api/content/{id}/descendant`
|
|
286
155
|
* @scopes-current read:confluence-content.summary
|
|
@@ -343,6 +212,7 @@ class ContentChildrenAndDescendantsService extends CommonHttpService_1.CommonHtt
|
|
|
343
212
|
* 'View' permission for the space, and permission to view the content if it
|
|
344
213
|
* is a page.
|
|
345
214
|
*
|
|
215
|
+
* @deprecated
|
|
346
216
|
* @returns Returned if the requested content is returned.
|
|
347
217
|
* @path GET `/wiki/rest/api/content/{id}/descendant/{type}`
|
|
348
218
|
* @scopes-current read:confluence-content.summary
|
|
@@ -416,16 +286,6 @@ class ContentChildrenAndDescendantsService extends CommonHttpService_1.CommonHtt
|
|
|
416
286
|
};
|
|
417
287
|
}
|
|
418
288
|
static initialize() {
|
|
419
|
-
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.getContentChildren.response", zod_1.z.object({
|
|
420
|
-
status: zod_1.z.literal(200),
|
|
421
|
-
mediaType: zod_1.z.literal("application/json"),
|
|
422
|
-
body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentChildren")
|
|
423
|
-
}).describe("ContentChildrenAndDescendantsService.getContentChildren.response"));
|
|
424
|
-
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.getContentChildrenByType.response", zod_1.z.object({
|
|
425
|
-
status: zod_1.z.literal(200),
|
|
426
|
-
mediaType: zod_1.z.literal("application/json"),
|
|
427
|
-
body: validationSchemaStorage_1.validationSchemaStorage.lazy("ContentArray")
|
|
428
|
-
}).describe("ContentChildrenAndDescendantsService.getContentChildrenByType.response"));
|
|
429
289
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentChildrenAndDescendantsService.copyPage.response", zod_1.z.object({
|
|
430
290
|
status: zod_1.z.literal(200),
|
|
431
291
|
mediaType: zod_1.z.literal("application/json;charset=UTF-8"),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ContentChildrenAndDescendantsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentChildrenAndDescendantsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAAyI;AACzI,2FAAsL;AACtL,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,oCAAqC,SAAQ,qCAAiB;IAA3E;;QACE
|
|
1
|
+
{"version":3,"file":"ContentChildrenAndDescendantsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentChildrenAndDescendantsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAAyI;AACzI,2FAAsL;AACtL,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,oCAAqC,SAAQ,qCAAiB;IAA3E;;QACE;;;;;;;;;;;;;;;;;;;;;;;;;;;WA2BG;QACH,aAAQ,GAAG,CAAC,EACV,EAAE,EACF,MAAM,EACN,eAAe,EAqGhB,EAA2B,EAAE;YAC5B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,kCAAkC;gBACxC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;iBACP;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;gBACD,IAAI,EAAE,eAAe;aACtB,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBAC/C,GAAG,EAAE;oBACH,gCAAgC,EAAE,MAAM;iBACzC;aACF,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,YAAY,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,wDAAwD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC9K,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA6BG;QACH,sBAAiB,GAAG,CAAC,EACnB,EAAE,EACF,wBAAwB,EAKzB,EAAqB,EAAE;YACtB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,gDAAgD;gBACtD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,wBAAwB;aAC/B,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,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,iEAAiE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACvL,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAqCG;QACH,0BAAqB,GAAG,CAAC,EACvB,EAAE,EACF,MAAM,EAiBP,EAA4B,EAAE;YAC7B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,wCAAwC;gBAC9C,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;iBACP;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;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,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,qEAAqE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC3L,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WAuCG;QACH,yBAAoB,GAAG,CAAC,EACtB,EAAE,EACF,IAAI,EACJ,KAAK,EACL,MAAM,EACN,KAAK,EACL,KAAK,EAmHN,EAAyB,EAAE;YAC1B,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,+CAA+C;gBACrD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;oBACF,IAAI;iBACL;gBACD,KAAK,EAAE;oBACL,KAAK;oBACL,MAAM;oBACN,KAAK;oBACL,KAAK;iBACN;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;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,EAIlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,oEAAoE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC1L,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,aAAQ,GAAG,CAAC,EACV,MAAM,EACN,QAAQ,EACR,QAAQ,EAeT,EAIE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,4DAA4D;gBAClE,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,MAAM;oBACN,QAAQ;oBACR,QAAQ;iBACT;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,EAQlC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,UAAU,CAAC,iDAAuB,CAAC,SAAS,CAAC,wDAAwD,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QAC9K,CAAC,CAAC;IA+BJ,CAAC;IA9BW,MAAM,CAAC,UAAU;QACzB,iDAAuB,CAAC,kBAAkB,CAAC,wDAAwD,EAAE,OAAC,CAAC,MAAM,CAAC;YAC5G,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,gCAAgC,CAAC;YACtD,IAAI,EAAE,OAAC,CAAC,QAAQ,CAAC,iDAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC1D,CAAC,CAAC,QAAQ,CAAC,wDAAwD,CAAC,CAAC,CAAC;QACvE,iDAAuB,CAAC,kBAAkB,CAAC,qEAAqE,EAAE,OAAC,CAAC,MAAM,CAAC;YACzH,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC;SACtD,CAAC,CAAC,QAAQ,CAAC,qEAAqE,CAAC,CAAC,CAAC;QACpF,iDAAuB,CAAC,kBAAkB,CAAC,oEAAoE,EAAE,OAAC,CAAC,MAAM,CAAC;YACxH,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,cAAc,CAAC;SACnD,CAAC,CAAC,QAAQ,CAAC,oEAAoE,CAAC,CAAC,CAAC;QACnF,iDAAuB,CAAC,kBAAkB,CAAC,iEAAiE,EAAE,OAAC,CAAC,MAAM,CAAC;YACrH,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,UAAU,CAAC;SAC/C,CAAC,CAAC,QAAQ,CAAC,iEAAiE,CAAC,CAAC,CAAC;QAChF,iDAAuB,CAAC,kBAAkB,CAAC,wDAAwD,EAAE,OAAC,CAAC,MAAM,CAAC;YAC5G,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,MAAM,EAAE,iDAAuB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,QAAQ,EAAE;aAC7D,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC,CAAC,QAAQ,CAAC,wDAAwD,CAAC,CAAC,CAAC;QACvE,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,EAAE,sFAAsD,CAAC,CAAC,CAAC;IAClI,CAAC;CACF;AAnlBD,oFAmlBC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { CommonHttpService } from "../../core/CommonHttpService";
|
|
2
|
-
import { type
|
|
2
|
+
import { type LabelCreate, type LabelArray } from "../models/common";
|
|
3
3
|
import type { LabelCreateArray } from "../models/contentLabels";
|
|
4
4
|
/**
|
|
5
5
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels
|
|
@@ -34,49 +34,6 @@ export declare class ContentLabelsService extends CommonHttpService {
|
|
|
34
34
|
/** The labels to add to the content. */
|
|
35
35
|
requestBody: LabelCreateArray | LabelCreate;
|
|
36
36
|
}) => Promise<LabelArray>;
|
|
37
|
-
/**
|
|
38
|
-
* Deprecated, use [Confluence's v2
|
|
39
|
-
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
40
|
-
*
|
|
41
|
-
* Returns the labels on a piece of content.
|
|
42
|
-
*
|
|
43
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
44
|
-
* 'View' permission for the space and permission to view the content if it is a
|
|
45
|
-
* page.
|
|
46
|
-
*
|
|
47
|
-
* @deprecated
|
|
48
|
-
* @returns Returned if the requested labels are returned.
|
|
49
|
-
* @path GET `/wiki/rest/api/content/{id}/label`
|
|
50
|
-
* @scopes-current read:confluence-content.summary
|
|
51
|
-
* @scopes-beta read:label:confluence
|
|
52
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels#api-wiki-rest-api-content-id-label-get
|
|
53
|
-
* @param params
|
|
54
|
-
*/
|
|
55
|
-
getLabelsForContent: ({ id, prefix, start, limit }: {
|
|
56
|
-
/** The ID of the content to be queried for its labels. */
|
|
57
|
-
id: string;
|
|
58
|
-
/**
|
|
59
|
-
* Filters the results to labels with the specified prefix. If this parameter
|
|
60
|
-
* is not specified, then labels with any prefix will be returned.
|
|
61
|
-
*
|
|
62
|
-
* - `global` prefix is used by default when a user adds a label
|
|
63
|
-
* via the UI.
|
|
64
|
-
* - `my` prefix can be explicitly added by a user when adding a label
|
|
65
|
-
* via the UI, e.g. 'my:example-label'. Also, when a page is selected as
|
|
66
|
-
* a favourite, the 'my:favourite' label is automatically added.
|
|
67
|
-
* - `team` can used when adding labels via [Add labels to
|
|
68
|
-
* content](#api-content-id-label-post)
|
|
69
|
-
* but is not used in the UI.
|
|
70
|
-
*/
|
|
71
|
-
prefix?: "global" | "my" | "team" | undefined;
|
|
72
|
-
/** The starting index of the returned labels. */
|
|
73
|
-
start?: number | undefined;
|
|
74
|
-
/**
|
|
75
|
-
* The maximum number of labels to return per page. Note,
|
|
76
|
-
* this may be restricted by fixed system limits.
|
|
77
|
-
*/
|
|
78
|
-
limit?: number | undefined;
|
|
79
|
-
}) => Promise<LabelArray>;
|
|
80
37
|
/**
|
|
81
38
|
* Removes a label from a piece of content. Labels can't be deleted from archived
|
|
82
39
|
* content.
|
|
@@ -55,42 +55,6 @@ class ContentLabelsService extends CommonHttpService_1.CommonHttpService {
|
|
|
55
55
|
}
|
|
56
56
|
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentLabelsService.addLabelsToContent.response"))).then(commonHttpClient.getBody);
|
|
57
57
|
};
|
|
58
|
-
/**
|
|
59
|
-
* Deprecated, use [Confluence's v2
|
|
60
|
-
* API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
|
|
61
|
-
*
|
|
62
|
-
* Returns the labels on a piece of content.
|
|
63
|
-
*
|
|
64
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
65
|
-
* 'View' permission for the space and permission to view the content if it is a
|
|
66
|
-
* page.
|
|
67
|
-
*
|
|
68
|
-
* @deprecated
|
|
69
|
-
* @returns Returned if the requested labels are returned.
|
|
70
|
-
* @path GET `/wiki/rest/api/content/{id}/label`
|
|
71
|
-
* @scopes-current read:confluence-content.summary
|
|
72
|
-
* @scopes-beta read:label:confluence
|
|
73
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-labels#api-wiki-rest-api-content-id-label-get
|
|
74
|
-
* @param params
|
|
75
|
-
*/
|
|
76
|
-
this.getLabelsForContent = ({ id, prefix, start, limit }) => {
|
|
77
|
-
return this.getClientInstance().request({
|
|
78
|
-
path: "/wiki/rest/api/content/{id}/label",
|
|
79
|
-
method: "GET",
|
|
80
|
-
pathParams: {
|
|
81
|
-
id
|
|
82
|
-
},
|
|
83
|
-
query: {
|
|
84
|
-
prefix,
|
|
85
|
-
start,
|
|
86
|
-
limit
|
|
87
|
-
}
|
|
88
|
-
}).then(this.getClientInstance().responseHandler({
|
|
89
|
-
200: {
|
|
90
|
-
"application/json": "json"
|
|
91
|
-
}
|
|
92
|
-
})).then(commonHttpClient.castResponse()).then(this.getClientInstance().validation(validationSchemaStorage_1.validationSchemaStorage.validator("ContentLabelsService.getLabelsForContent.response"))).then(commonHttpClient.getBody);
|
|
93
|
-
};
|
|
94
58
|
/**
|
|
95
59
|
* Removes a label from a piece of content. Labels can't be deleted from archived
|
|
96
60
|
* content.
|
|
@@ -156,11 +120,6 @@ class ContentLabelsService extends CommonHttpService_1.CommonHttpService {
|
|
|
156
120
|
};
|
|
157
121
|
}
|
|
158
122
|
static initialize() {
|
|
159
|
-
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentLabelsService.getLabelsForContent.response", zod_1.z.object({
|
|
160
|
-
status: zod_1.z.literal(200),
|
|
161
|
-
mediaType: zod_1.z.literal("application/json"),
|
|
162
|
-
body: validationSchemaStorage_1.validationSchemaStorage.lazy("LabelArray")
|
|
163
|
-
}).describe("ContentLabelsService.getLabelsForContent.response"));
|
|
164
123
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentLabelsService.addLabelsToContent.response", zod_1.z.object({
|
|
165
124
|
status: zod_1.z.literal(200),
|
|
166
125
|
mediaType: zod_1.z.literal("application/json"),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ContentLabelsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentLabelsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAAsG;AAEtG,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,qCAAiB;IAA3D;;QACE;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,uBAAkB,GAAG,CAAC,EACpB,EAAE,EACF,WAAW,EAMZ,EAAuB,EAAE;YACxB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mCAAmC;gBACzC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;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,EAIlC,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
|
|
1
|
+
{"version":3,"file":"ContentLabelsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentLabelsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,gEAAgE;AAChE,oEAAiE;AACjE,6CAAsG;AAEtG,wEAAqE;AACrE,6BAAwB;AACxB;;;GAGG;AACH,MAAa,oBAAqB,SAAQ,qCAAiB;IAA3D;;QACE;;;;;;;;;;;;;;;;;;;;;WAqBG;QACH,uBAAkB,GAAG,CAAC,EACpB,EAAE,EACF,WAAW,EAMZ,EAAuB,EAAE;YACxB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mCAAmC;gBACzC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;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,EAIlC,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;;;;;;;;;;;;;;;;;;;;WAoBG;QACH,2BAAsB,GAAG,CAAC,EACxB,EAAE,EACF,KAAK,EAMN,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,2CAA2C;gBACjD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;oBACF,KAAK;iBACN;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;WAmBG;QACH,8CAAyC,GAAG,CAAC,EAC3C,EAAE,EACF,IAAI,EAML,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE,CAAC,OAAO,CAAC;gBACtC,IAAI,EAAE,mCAAmC;gBACzC,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,IAAI;iBACL;aACF,CAAC,CAAC,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;IASJ,CAAC;IARW,MAAM,CAAC,UAAU;QACzB,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,iDAAuB,CAAC,IAAI,CAAC,YAAY,CAAC;SACjD,CAAC,CAAC,QAAQ,CAAC,kDAAkD,CAAC,CAAC,CAAC;QACjE,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AA3ID,oDA2IC"}
|