@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.
Files changed (128) hide show
  1. package/lib/openapi/core/CommonHttpClient.d.ts +1 -1
  2. package/lib/openapi/core/CommonHttpClient.js +1 -1
  3. package/lib/openapi/core/CommonHttpClient.js.map +1 -1
  4. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +6 -37
  5. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +3 -71
  6. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
  7. package/lib/openapi/v1/models/audit.js +2 -2
  8. package/lib/openapi/v1/models/audit.js.map +1 -1
  9. package/lib/openapi/v1/models/common.d.ts +1 -1
  10. package/lib/openapi/v1/models/common.js +3 -3
  11. package/lib/openapi/v1/models/common.js.map +1 -1
  12. package/lib/openapi/v1/models/content.d.ts +0 -543
  13. package/lib/openapi/v1/models/content.js +2 -309
  14. package/lib/openapi/v1/models/content.js.map +1 -1
  15. package/lib/openapi/v1/models/contentChildrenAndDescendants.d.ts +7 -3
  16. package/lib/openapi/v1/models/contentChildrenAndDescendants.js +1 -1
  17. package/lib/openapi/v1/models/contentChildrenAndDescendants.js.map +1 -1
  18. package/lib/openapi/v1/models/contentRestrictions.js +1 -1
  19. package/lib/openapi/v1/models/contentRestrictions.js.map +1 -1
  20. package/lib/openapi/v1/models/contentStates.d.ts +322 -0
  21. package/lib/openapi/v1/models/contentStates.js +219 -0
  22. package/lib/openapi/v1/models/contentStates.js.map +1 -1
  23. package/lib/openapi/v1/models/contentVersions.d.ts +0 -9
  24. package/lib/openapi/v1/models/contentVersions.js +1 -10
  25. package/lib/openapi/v1/models/contentVersions.js.map +1 -1
  26. package/lib/openapi/v1/models/dynamicModules.d.ts +3 -3
  27. package/lib/openapi/v1/models/space.d.ts +1 -9
  28. package/lib/openapi/v1/models/space.js +1 -8
  29. package/lib/openapi/v1/models/space.js.map +1 -1
  30. package/lib/openapi/v1/models/template.js +1 -1
  31. package/lib/openapi/v1/models/template.js.map +1 -1
  32. package/lib/openapi/v1/services/AnalyticsService.d.ts +4 -0
  33. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  34. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +0 -130
  35. package/lib/openapi/v1/services/ContentAttachmentsService.js +0 -52
  36. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  37. package/lib/openapi/v1/services/ContentBodyService.d.ts +1 -102
  38. package/lib/openapi/v1/services/ContentBodyService.js +1 -65
  39. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  40. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +5 -220
  41. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +4 -144
  42. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  43. package/lib/openapi/v1/services/ContentLabelsService.d.ts +1 -44
  44. package/lib/openapi/v1/services/ContentLabelsService.js +0 -41
  45. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  46. package/lib/openapi/v1/services/ContentService.d.ts +2 -560
  47. package/lib/openapi/v1/services/ContentService.js +1 -300
  48. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  49. package/lib/openapi/v1/services/ContentVersionsService.d.ts +1 -72
  50. package/lib/openapi/v1/services/ContentVersionsService.js +1 -97
  51. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  52. package/lib/openapi/v1/services/GroupService.d.ts +1 -1
  53. package/lib/openapi/v1/services/GroupService.js +1 -1
  54. package/lib/openapi/v1/services/SettingsService.d.ts +0 -26
  55. package/lib/openapi/v1/services/SettingsService.js +0 -38
  56. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  57. package/lib/openapi/v1/services/SpaceService.d.ts +2 -406
  58. package/lib/openapi/v1/services/SpaceService.js +1 -215
  59. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  60. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +22 -3
  61. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +25 -1
  62. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
  63. package/lib/openapi/v2/models/adminKey.d.ts +13 -0
  64. package/lib/openapi/v2/models/adminKey.js +12 -0
  65. package/lib/openapi/v2/models/adminKey.js.map +1 -0
  66. package/lib/openapi/v2/models/children.d.ts +21 -6
  67. package/lib/openapi/v2/models/children.js +10 -1
  68. package/lib/openapi/v2/models/children.js.map +1 -1
  69. package/lib/openapi/v2/models/common.d.ts +6 -0
  70. package/lib/openapi/v2/models/common.js +1 -0
  71. package/lib/openapi/v2/models/common.js.map +1 -1
  72. package/lib/openapi/v2/models/descendants.d.ts +29 -0
  73. package/lib/openapi/v2/models/descendants.js +19 -0
  74. package/lib/openapi/v2/models/descendants.js.map +1 -0
  75. package/lib/openapi/v2/services/AdminKeyService.d.ts +71 -0
  76. package/lib/openapi/v2/services/AdminKeyService.js +111 -0
  77. package/lib/openapi/v2/services/AdminKeyService.js.map +1 -0
  78. package/lib/openapi/v2/services/AttachmentService.d.ts +6 -5
  79. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  80. package/lib/openapi/v2/services/BlogPostService.d.ts +5 -4
  81. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  82. package/lib/openapi/v2/services/ChildrenService.d.ts +307 -1
  83. package/lib/openapi/v2/services/ChildrenService.js +321 -0
  84. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  85. package/lib/openapi/v2/services/CommentService.d.ts +10 -8
  86. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  87. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +1 -1
  88. package/lib/openapi/v2/services/CustomContentService.d.ts +18 -1
  89. package/lib/openapi/v2/services/CustomContentService.js +5 -0
  90. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  91. package/lib/openapi/v2/services/DatabaseService.d.ts +4 -6
  92. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  93. package/lib/openapi/v2/services/DescendantsService.d.ts +346 -0
  94. package/lib/openapi/v2/services/DescendantsService.js +362 -0
  95. package/lib/openapi/v2/services/DescendantsService.js.map +1 -0
  96. package/lib/openapi/v2/services/FolderService.d.ts +4 -6
  97. package/lib/openapi/v2/services/FolderService.js.map +1 -1
  98. package/lib/openapi/v2/services/PageService.d.ts +49 -6
  99. package/lib/openapi/v2/services/PageService.js +42 -2
  100. package/lib/openapi/v2/services/PageService.js.map +1 -1
  101. package/lib/openapi/v2/services/SmartLinkService.d.ts +4 -6
  102. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  103. package/lib/openapi/v2/services/SpaceService.d.ts +2 -1
  104. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  105. package/lib/openapi/v2/services/WhiteboardService.d.ts +6 -8
  106. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  107. package/package.json +3 -3
  108. package/lib/openapi/v1/models/contentProperties.d.ts +0 -78
  109. package/lib/openapi/v1/models/contentProperties.js +0 -48
  110. package/lib/openapi/v1/models/contentProperties.js.map +0 -1
  111. package/lib/openapi/v1/models/inlineTasks.d.ts +0 -33
  112. package/lib/openapi/v1/models/inlineTasks.js +0 -36
  113. package/lib/openapi/v1/models/inlineTasks.js.map +0 -1
  114. package/lib/openapi/v1/models/spaceProperties.d.ts +0 -103
  115. package/lib/openapi/v1/models/spaceProperties.js +0 -48
  116. package/lib/openapi/v1/models/spaceProperties.js.map +0 -1
  117. package/lib/openapi/v1/services/ContentCommentsService.d.ts +0 -153
  118. package/lib/openapi/v1/services/ContentCommentsService.js +0 -81
  119. package/lib/openapi/v1/services/ContentCommentsService.js.map +0 -1
  120. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +0 -203
  121. package/lib/openapi/v1/services/ContentPropertiesService.js +0 -279
  122. package/lib/openapi/v1/services/ContentPropertiesService.js.map +0 -1
  123. package/lib/openapi/v1/services/InlineTasksService.d.ts +0 -101
  124. package/lib/openapi/v1/services/InlineTasksService.js +0 -145
  125. package/lib/openapi/v1/services/InlineTasksService.js.map +0 -1
  126. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +0 -177
  127. package/lib/openapi/v1/services/SpacePropertiesService.js +0 -269
  128. package/lib/openapi/v1/services/SpacePropertiesService.js.map +0 -1
@@ -1,6 +1,6 @@
1
1
  import { CommonHttpService } from "../../core/CommonHttpService";
2
- import { type ContentArray, type Content, type LongTask } from "../models/common";
3
- import { type ContentCreate, type ContentUpdate, type ContentHistory, type ContentBlueprintDraft } from "../models/content";
2
+ import { type LongTask, type Content, type ContentArray } from "../models/common";
3
+ import type { ContentBlueprintDraft } from "../models/content";
4
4
  /**
5
5
  * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content
6
6
  * @category Services
@@ -41,528 +41,6 @@ export declare class ContentService extends CommonHttpService {
41
41
  [key: string]: unknown;
42
42
  };
43
43
  }) => Promise<LongTask>;
44
- /**
45
- * Deprecated, use [Confluence's v2
46
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
47
- *
48
- * Creates a new piece of content or publishes an existing draft.
49
- *
50
- * To publish a draft, add the `id` and `status` properties to the body of the
51
- * request.
52
- * Set the `id` to the ID of the draft and set the `status` to 'current'. When the
53
- * request is sent, a new piece of content will be created and the metadata from
54
- * the
55
- * draft will be transferred into it.
56
- *
57
- * By default, the following objects are expanded: `space`, `history`, `version`.
58
- *
59
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add'
60
- * permission for the
61
- * space that the content will be created in, and permission to view the draft if
62
- * publishing a draft.
63
- *
64
- * @deprecated
65
- * @returns Returned if the content is created.
66
- * @path POST `/wiki/rest/api/content`
67
- * @scopes-current write:confluence-content
68
- * @scopes-beta read:content-details:confluence, write:content:confluence
69
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content#api-wiki-rest-api-content-post
70
- * @param params
71
- */
72
- createContent: ({ status, expand, contentCreate }: {
73
- /** Filter the returned content by status. */
74
- status?: string | undefined;
75
- /**
76
- * A multi-value parameter indicating which properties of the content to expand.
77
- * Maximum sub-expansions allowed is `8`.
78
- *
79
- * - `childTypes.all` returns whether the content has attachments, comments, or
80
- * child pages/whiteboards.
81
- * Use this if you only need to check whether the content has children of a
82
- * particular type.
83
- * - `childTypes.attachment` returns whether the content has attachments.
84
- * - `childTypes.comment` returns whether the content has comments.
85
- * - `childTypes.page` returns whether the content has child pages.
86
- * - `childTypes.whiteboard` returns whether the content has child whiteboards.
87
- * - `childTypes.database` returns whether the content has child databases.
88
- * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
89
- * - `childTypes.folder` returns whether the content has child folder.
90
- * - `container` returns the space that the content is in. This is the same as the
91
- * information
92
- * returned by [Get space](#api-space-spaceKey-get).
93
- * - `metadata.currentuser` returns information about the current user in relation
94
- * to the content,
95
- * including when they last viewed it, modified it, contributed to it, or added it
96
- * as a favorite.
97
- * - `metadata.properties` returns content properties that have been set via the
98
- * Confluence REST API.
99
- * - `metadata.labels` returns the labels that have been added to the content.
100
- * - `metadata.frontend` this property is only used by Atlassian.
101
- * - `operations` returns the operations for the content, which are used when
102
- * setting permissions.
103
- * - `children.page` returns pages that are descendants at the level immediately
104
- * below the content.
105
- * - `children.whiteboard` returns whiteboards that are descendants at the level
106
- * immediately below the content.
107
- * - `children.database` returns databases that are descendants at the level
108
- * immediately below the content.
109
- * - `children.embed` returns embeds (smartlinks) that are descendants at the
110
- * level immediately below the content.
111
- * - `children.folder` returns folders that are descendants at the level
112
- * immediately below the content.
113
- * - `children.attachment` returns all attachments for the content.
114
- * - `children.comment` returns all comments on the content.
115
- * - `restrictions.read.restrictions.user` returns the users that have permission
116
- * to read the content.
117
- * - `restrictions.read.restrictions.group` returns the groups that have
118
- * permission to read the content. Note that
119
- * this may return deleted groups, because deleting a group doesn't remove
120
- * associated restrictions.
121
- * - `restrictions.update.restrictions.user` returns the users that have
122
- * permission to update the content.
123
- * - `restrictions.update.restrictions.group` returns the groups that have
124
- * permission to update the content. Note that
125
- * this may return deleted groups because deleting a group doesn't remove
126
- * associated restrictions.
127
- * - `history` returns the history of the content, including the date it was
128
- * created.
129
- * - `history.lastUpdated` returns information about the most recent update of the
130
- * content, including
131
- * who updated it and when it was updated.
132
- * - `history.previousVersion` returns information about the update prior to the
133
- * current content update.
134
- * - `history.contributors` returns all of the users who have contributed to the
135
- * content.
136
- * - `history.nextVersion` returns information about the update after to the
137
- * current content update.
138
- * - `ancestors` returns the parent content, if the content is a page or
139
- * whiteboard.
140
- * - `body` returns the body of the content in different formats, including the
141
- * editor format,
142
- * view format, and export format.
143
- * - `body.storage` returns the body of content in storage format.
144
- * - `body.view` returns the body of content in view format.
145
- * - `version` returns information about the most recent update of the content,
146
- * including who updated it
147
- * and when it was updated.
148
- * - `descendants.page` returns pages that are descendants at any level below the
149
- * content.
150
- * - `descendants.whiteboard` returns whiteboards that are descendants at any
151
- * level below the content.
152
- * - `descendants.database` returns databases that are descendants at any level
153
- * below the content.
154
- * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
155
- * level below the content.
156
- * - `descendants.folder` returns folders that are descendants at any level below
157
- * the content.
158
- * - `descendants.attachment` returns all attachments for the content, same as
159
- * `children.attachment`.
160
- * - `descendants.comment` returns all comments on the content, same as
161
- * `children.comment`.
162
- * - `space` returns the space that the content is in. This is the same as the
163
- * information returned by
164
- * [Get space](#api-space-spaceKey-get).
165
- *
166
- * In addition, the following comment-specific expansions can be used:
167
- * - `extensions.inlineProperties` returns inline comment-specific properties.
168
- * - `extensions.resolution` returns the resolution status of each comment.
169
- */
170
- expand?: string[] | undefined;
171
- /**
172
- * The new content to be created. Set the `representation` to the name of the body
173
- * format type. For example, if you use `storage` for the body format, set
174
- * '`representation`=`storage`'. See
175
- * [Confluence storage format](https://confluence.atlassian.com/x/AJkiLw).
176
- *
177
- * If you are not sure how to generate the different formats, you can create a
178
- * page in the
179
- * Confluence application, retrieve the content using [Get
180
- * content](#api-content-get),
181
- * and expand the desired content format, e.g. `expand=body.storage`.
182
- */
183
- contentCreate: ContentCreate | null;
184
- }) => Promise<Content | null>;
185
- /**
186
- * Deprecated, use [Confluence's v2
187
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
188
- *
189
- * Moves a piece of content to the space's trash or purges it from the trash,
190
- * depending on the content's type and status:
191
- *
192
- * - If the content's type is `page`,`blogpost`, or `attachment` and its status is
193
- * `current`,
194
- * it will be trashed.
195
- * - If the content's type is `page`,`blogpost`, or `attachment` and its status is
196
- * `trashed`,
197
- * the content will be purged from the trash and deleted permanently. Note,
198
- * you must also set the `status` query parameter to `trashed` in your request.
199
- * - If the content's type is `comment`, it will be deleted
200
- * permanently without being trashed.
201
- *
202
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
203
- * 'Delete' permission for the space that the content is in.
204
- *
205
- * @deprecated
206
- * @path DELETE `/wiki/rest/api/content/{id}`
207
- * @scopes-current write:confluence-content
208
- * @scopes-beta delete:content:confluence
209
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content#api-wiki-rest-api-content-id-delete
210
- * @param params
211
- */
212
- deleteContent: ({ id, status }: {
213
- /** The ID of the content to be deleted. */
214
- id: string;
215
- /**
216
- * Set this to `trashed`, if the content's status is `trashed` and you want to
217
- * purge it.
218
- */
219
- status?: string | undefined;
220
- }) => Promise<void>;
221
- /**
222
- * Deprecated, use [Confluence's v2
223
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
224
- *
225
- * Returns all content in a Confluence instance.
226
- *
227
- * By default, the following objects are expanded: `space`, `history`, `version`.
228
- *
229
- * If the expand query parameter is used with the `body.export_view` and/or
230
- * `body.styled_view` properties, then the query limit parameter will be
231
- * restricted to a maximum value of 25.
232
- *
233
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
234
- * Permission to access the Confluence site ('Can use' global permission).
235
- * Only content that the user has permission to view will be returned.
236
- *
237
- * @deprecated
238
- * @returns Returned if the requested list of content is returned.
239
- * @path GET `/wiki/rest/api/content`
240
- * @scopes-current read:confluence-content.summary
241
- * @scopes-beta read:content-details:confluence
242
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content#api-wiki-rest-api-content-get
243
- * @param params
244
- */
245
- getContent: ({ type, spaceKey, title, status, postingDay, expand, trigger, orderby, start, limit }?: {
246
- /**
247
- * The type of content to return. For example:
248
- * - page
249
- * - blogpost
250
- */
251
- type?: string | undefined;
252
- /** The key of the space to be queried for its content. */
253
- spaceKey?: string | undefined;
254
- /** The title of the page to be returned. Required for <code>page</code> type. */
255
- title?: string | undefined;
256
- /**
257
- * Filter the results to a set of content based on their status. If set to `any`,
258
- * content with any status is returned. Note, the `historical` status is currently
259
- * not supported.
260
- */
261
- status?: "current" | "any" | "deleted" | "historical" | "draft" | "trashed" | undefined;
262
- /**
263
- * The posting date of the blog post to be returned. Required for
264
- * <code>blogpost</code> type. Format: <code>yyyy-mm-dd</code>.
265
- */
266
- postingDay?: string | undefined;
267
- /**
268
- * A multi-value parameter indicating which properties of the content to expand.
269
- * Maximum sub-expansions allowed is `8`.
270
- *
271
- * - `childTypes.all` returns whether the content has attachments, comments, or
272
- * child pages/whiteboards.
273
- * Use this if you only need to check whether the content has children of a
274
- * particular type.
275
- * - `childTypes.attachment` returns whether the content has attachments.
276
- * - `childTypes.comment` returns whether the content has comments.
277
- * - `childTypes.page` returns whether the content has child pages.
278
- * - `childTypes.whiteboard` returns whether the content has child whiteboards.
279
- * - `childTypes.database` returns whether the content has child databases.
280
- * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
281
- * - `childTypes.folder` returns whether the content has child folder.
282
- * - `container` returns the space that the content is in. This is the same as the
283
- * information
284
- * returned by [Get space](#api-space-spaceKey-get).
285
- * - `metadata.currentuser` returns information about the current user in relation
286
- * to the content,
287
- * including when they last viewed it, modified it, contributed to it, or added it
288
- * as a favorite.
289
- * - `metadata.properties` returns content properties that have been set via the
290
- * Confluence REST API.
291
- * - `metadata.labels` returns the labels that have been added to the content.
292
- * - `metadata.frontend` this property is only used by Atlassian.
293
- * - `operations` returns the operations for the content, which are used when
294
- * setting permissions.
295
- * - `children.page` returns pages that are descendants at the level immediately
296
- * below the content.
297
- * - `children.whiteboard` returns whiteboards that are descendants at the level
298
- * immediately below the content.
299
- * - `children.database` returns databases that are descendants at the level
300
- * immediately below the content.
301
- * - `children.embed` returns embeds (smartlinks) that are descendants at the
302
- * level immediately below the content.
303
- * - `children.folder` returns folders that are descendants at the level
304
- * immediately below the content.
305
- * - `children.attachment` returns all attachments for the content.
306
- * - `children.comment` returns all comments on the content.
307
- * - `restrictions.read.restrictions.user` returns the users that have permission
308
- * to read the content.
309
- * - `restrictions.read.restrictions.group` returns the groups that have
310
- * permission to read the content. Note that
311
- * this may return deleted groups, because deleting a group doesn't remove
312
- * associated restrictions.
313
- * - `restrictions.update.restrictions.user` returns the users that have
314
- * permission to update the content.
315
- * - `restrictions.update.restrictions.group` returns the groups that have
316
- * permission to update the content. Note that
317
- * this may return deleted groups because deleting a group doesn't remove
318
- * associated restrictions.
319
- * - `history` returns the history of the content, including the date it was
320
- * created.
321
- * - `history.lastUpdated` returns information about the most recent update of the
322
- * content, including
323
- * who updated it and when it was updated.
324
- * - `history.previousVersion` returns information about the update prior to the
325
- * current content update.
326
- * - `history.contributors` returns all of the users who have contributed to the
327
- * content.
328
- * - `history.nextVersion` returns information about the update after to the
329
- * current content update.
330
- * - `ancestors` returns the parent content, if the content is a page or
331
- * whiteboard.
332
- * - `body` returns the body of the content in different formats, including the
333
- * editor format,
334
- * view format, and export format.
335
- * - `body.storage` returns the body of content in storage format.
336
- * - `body.view` returns the body of content in view format.
337
- * - `version` returns information about the most recent update of the content,
338
- * including who updated it
339
- * and when it was updated.
340
- * - `descendants.page` returns pages that are descendants at any level below the
341
- * content.
342
- * - `descendants.whiteboard` returns whiteboards that are descendants at any
343
- * level below the content.
344
- * - `descendants.database` returns databases that are descendants at any level
345
- * below the content.
346
- * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
347
- * level below the content.
348
- * - `descendants.folder` returns folders that are descendants at any level below
349
- * the content.
350
- * - `descendants.attachment` returns all attachments for the content, same as
351
- * `children.attachment`.
352
- * - `descendants.comment` returns all comments on the content, same as
353
- * `children.comment`.
354
- * - `space` returns the space that the content is in. This is the same as the
355
- * information returned by
356
- * [Get space](#api-space-spaceKey-get).
357
- *
358
- * In addition, the following comment-specific expansions can be used:
359
- * - `extensions.inlineProperties` returns inline comment-specific properties.
360
- * - `extensions.resolution` returns the resolution status of each comment.
361
- */
362
- expand?: string[] | undefined;
363
- /**
364
- * If set to `viewed`, the request will trigger a 'viewed' event for the content.
365
- * When this event is triggered, the page/blogpost will appear on the 'Recently
366
- * visited'
367
- * tab of the user's Confluence dashboard.
368
- */
369
- trigger?: "viewed" | undefined;
370
- /**
371
- * Orders the content by a particular field. Specify the field and sort direction
372
- * for
373
- * this parameter, as follows: 'fieldpath asc/desc'. For example,
374
- * 'history.createdDate desc'.
375
- */
376
- orderby?: string | undefined;
377
- /** The starting index of the returned content. */
378
- start?: number | undefined;
379
- /**
380
- * The maximum number of content objects to return per page.
381
- * Note, this may be restricted by fixed system limits.
382
- */
383
- limit?: number | undefined;
384
- }) => Promise<ContentArray>;
385
- /**
386
- * Deprecated, use [Confluence's v2
387
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
388
- *
389
- * Returns a single piece of content, like a page or a blog post.
390
- *
391
- * By default, the following objects are expanded: `space`, `history`, `version`.
392
- *
393
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
394
- * Permission to view the content. If the content is a blog post, 'View' permission
395
- * for the space is required.
396
- *
397
- * @deprecated
398
- * @returns Returned if the requested content is returned.
399
- * @path GET `/wiki/rest/api/content/{id}`
400
- * @scopes-current read:confluence-content.summary
401
- * @scopes-beta read:content-details:confluence
402
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content#api-wiki-rest-api-content-id-get
403
- * @param params
404
- */
405
- getContentById: ({ id, status, version, embeddedContentRender, expand, trigger }: {
406
- /**
407
- * The ID of the content to be returned. If you don't know the content ID,
408
- * use [Get content](#api-content-get) and filter the results.
409
- */
410
- id: string;
411
- /**
412
- * Filter the results to a set of content based on their status.
413
- * If set to `any`, content with any status is returned. Note, the
414
- * `historical` status is currently not supported.
415
- */
416
- status?: "current" | "any" | "deleted" | "historical" | "draft" | "trashed" | "archived" | undefined;
417
- /** The version number of the content to be returned. */
418
- version?: number | undefined;
419
- /**
420
- * The version of embedded content (e.g. attachments) to render.
421
- *
422
- * - <code>current</code> renders the latest version of the embedded content.
423
- * - <code>version-at-save</code> renders the version of the embedded content
424
- * at the time of save.
425
- */
426
- embeddedContentRender?: "current" | "version-at-save" | undefined;
427
- /**
428
- * A multi-value parameter indicating which properties of the content to expand.
429
- * Maximum sub-expansions allowed is `8`.
430
- *
431
- * - `childTypes.all` returns whether the content has attachments, comments, or
432
- * child pages/whiteboards.
433
- * Use this if you only need to check whether the content has children of a
434
- * particular type.
435
- * - `childTypes.attachment` returns whether the content has attachments.
436
- * - `childTypes.comment` returns whether the content has comments.
437
- * - `childTypes.page` returns whether the content has child pages.
438
- * - `childTypes.whiteboard` returns whether the content has child whiteboards.
439
- * - `childTypes.database` returns whether the content has child databases.
440
- * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
441
- * - `childTypes.folder` returns whether the content has child folder.
442
- * - `container` returns the space that the content is in. This is the same as the
443
- * information
444
- * returned by [Get space](#api-space-spaceKey-get).
445
- * - `metadata.currentuser` returns information about the current user in relation
446
- * to the content,
447
- * including when they last viewed it, modified it, contributed to it, or added it
448
- * as a favorite.
449
- * - `metadata.properties` returns content properties that have been set via the
450
- * Confluence REST API.
451
- * - `metadata.labels` returns the labels that have been added to the content.
452
- * - `metadata.frontend` this property is only used by Atlassian.
453
- * - `operations` returns the operations for the content, which are used when
454
- * setting permissions.
455
- * - `children.page` returns pages that are descendants at the level immediately
456
- * below the content.
457
- * - `children.whiteboard` returns whiteboards that are descendants at the level
458
- * immediately below the content.
459
- * - `children.database` returns databases that are descendants at the level
460
- * immediately below the content.
461
- * - `children.embed` returns embeds (smartlinks) that are descendants at the
462
- * level immediately below the content.
463
- * - `children.folder` returns folders that are descendants at the level
464
- * immediately below the content.
465
- * - `children.attachment` returns all attachments for the content.
466
- * - `children.comment` returns all comments on the content.
467
- * - `restrictions.read.restrictions.user` returns the users that have permission
468
- * to read the content.
469
- * - `restrictions.read.restrictions.group` returns the groups that have
470
- * permission to read the content. Note that
471
- * this may return deleted groups, because deleting a group doesn't remove
472
- * associated restrictions.
473
- * - `restrictions.update.restrictions.user` returns the users that have
474
- * permission to update the content.
475
- * - `restrictions.update.restrictions.group` returns the groups that have
476
- * permission to update the content. Note that
477
- * this may return deleted groups because deleting a group doesn't remove
478
- * associated restrictions.
479
- * - `history` returns the history of the content, including the date it was
480
- * created.
481
- * - `history.lastUpdated` returns information about the most recent update of the
482
- * content, including
483
- * who updated it and when it was updated.
484
- * - `history.previousVersion` returns information about the update prior to the
485
- * current content update.
486
- * - `history.contributors` returns all of the users who have contributed to the
487
- * content.
488
- * - `history.nextVersion` returns information about the update after to the
489
- * current content update.
490
- * - `ancestors` returns the parent content, if the content is a page or
491
- * whiteboard.
492
- * - `body` returns the body of the content in different formats, including the
493
- * editor format,
494
- * view format, and export format.
495
- * - `body.storage` returns the body of content in storage format.
496
- * - `body.view` returns the body of content in view format.
497
- * - `version` returns information about the most recent update of the content,
498
- * including who updated it
499
- * and when it was updated.
500
- * - `descendants.page` returns pages that are descendants at any level below the
501
- * content.
502
- * - `descendants.whiteboard` returns whiteboards that are descendants at any
503
- * level below the content.
504
- * - `descendants.database` returns databases that are descendants at any level
505
- * below the content.
506
- * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
507
- * level below the content.
508
- * - `descendants.folder` returns folders that are descendants at any level below
509
- * the content.
510
- * - `descendants.attachment` returns all attachments for the content, same as
511
- * `children.attachment`.
512
- * - `descendants.comment` returns all comments on the content, same as
513
- * `children.comment`.
514
- * - `space` returns the space that the content is in. This is the same as the
515
- * information returned by
516
- * [Get space](#api-space-spaceKey-get).
517
- *
518
- * In addition, the following comment-specific expansions can be used:
519
- * - `extensions.inlineProperties` returns inline comment-specific properties.
520
- * - `extensions.resolution` returns the resolution status of each comment.
521
- */
522
- expand?: string[] | undefined;
523
- /**
524
- * If set to `viewed`, the request will trigger a 'viewed' event for the content.
525
- * When this event is triggered, the page/blogpost will appear on the 'Recently
526
- * visited'
527
- * tab of the user's Confluence dashboard.
528
- */
529
- trigger?: "viewed" | undefined;
530
- }) => Promise<Content | null>;
531
- /**
532
- * Deprecated, use [Confluence's v2
533
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
534
- *
535
- * Returns the most recent update for a piece of content.
536
- *
537
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
538
- * Permission to view the content.
539
- *
540
- * @deprecated
541
- * @returns Returned if the requested content history is returned.
542
- * @path GET `/wiki/rest/api/content/{id}/history`
543
- * @scopes-current read:confluence-content.summary
544
- * @scopes-beta read:content.metadata:confluence, read:user:confluence
545
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content#api-wiki-rest-api-content-id-history-get
546
- * @param params
547
- */
548
- getHistoryForContent: ({ id, expand }: {
549
- /** The ID of the content to be queried for its history. */
550
- id: string;
551
- /**
552
- * A multi-value parameter indicating which properties of the content history to
553
- * expand.
554
- * Maximum sub-expansions allowed is `8`.
555
- *
556
- * - `lastUpdated` returns information about the most recent update of the content,
557
- * including who updated it and when it was updated.
558
- * - `previousVersion` returns information about the update prior to the current
559
- * content
560
- * update. For this method, it contains the same information as `lastUpdated`.
561
- * - `contributors` returns all of the users who have contributed to the content.
562
- * - `nextVersion` This parameter is not used for this method.
563
- */
564
- expand?: ("lastUpdated" | "previousVersion" | "contributors" | "nextVersion")[] | undefined;
565
- }) => Promise<ContentHistory | null>;
566
44
  /**
567
45
  * Publishes a legacy draft of a page created from a blueprint. Legacy drafts
568
46
  * will eventually be removed in favor of shared drafts. For now, this method
@@ -996,41 +474,5 @@ export declare class ContentService extends CommonHttpService {
996
474
  */
997
475
  limit?: number | undefined;
998
476
  }) => Promise<ContentArray>;
999
- /**
1000
- * Deprecated, use [Confluence's v2
1001
- * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
1002
- *
1003
- * Updates a piece of content. Use this method to update the title or body
1004
- * of a piece of content, change the status, change the parent page, and more.
1005
- *
1006
- * Note, updating draft content is currently not supported.
1007
- *
1008
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1009
- * Permission to update the content.
1010
- *
1011
- * @deprecated
1012
- * @returns Returned if the content is updated.
1013
- * @path PUT `/wiki/rest/api/content/{id}`
1014
- * @scopes-current write:confluence-content
1015
- * @scopes-beta read:content-details:confluence, write:content:confluence
1016
- * @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content#api-wiki-rest-api-content-id-put
1017
- * @param params
1018
- */
1019
- updateContent: ({ id, status, conflictPolicy, contentUpdate }: {
1020
- /** The ID of the content to be updated. */
1021
- id: string;
1022
- /**
1023
- * The updated status of the content. Use this parameter to change the
1024
- * status of a piece of content without passing the entire request body.
1025
- */
1026
- status?: "current" | "deleted" | "historical" | "draft" | "trashed" | undefined;
1027
- /**
1028
- * The action that should be taken when conflicts are discovered.
1029
- * Only used when publishing a draft page.
1030
- */
1031
- conflictPolicy?: "abort" | undefined;
1032
- /** The updated content. */
1033
- contentUpdate: ContentUpdate;
1034
- }) => Promise<Content | null>;
1035
477
  protected static initialize(): void;
1036
478
  }