@resolution/confluence-api-client 0.2.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 (352) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/LICENSE.md +19 -0
  3. package/README.md +12 -0
  4. package/lib/index.d.ts +36 -0
  5. package/lib/index.js +64 -0
  6. package/lib/index.js.map +1 -0
  7. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +133 -0
  8. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +122 -0
  9. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -0
  10. package/lib/openapi/v1/core/CommonHttpClient.d.ts +196 -0
  11. package/lib/openapi/v1/core/CommonHttpClient.js +390 -0
  12. package/lib/openapi/v1/core/CommonHttpClient.js.map +1 -0
  13. package/lib/openapi/v1/core/CommonHttpService.d.ts +7 -0
  14. package/lib/openapi/v1/core/CommonHttpService.js +20 -0
  15. package/lib/openapi/v1/core/CommonHttpService.js.map +1 -0
  16. package/lib/openapi/v1/core/CommonValidationSchemaStorage.d.ts +35 -0
  17. package/lib/openapi/v1/core/CommonValidationSchemaStorage.js +65 -0
  18. package/lib/openapi/v1/core/CommonValidationSchemaStorage.js.map +1 -0
  19. package/lib/openapi/v1/models/audit.d.ts +151 -0
  20. package/lib/openapi/v1/models/audit.js +133 -0
  21. package/lib/openapi/v1/models/audit.js.map +1 -0
  22. package/lib/openapi/v1/models/common.d.ts +645 -0
  23. package/lib/openapi/v1/models/common.js +654 -0
  24. package/lib/openapi/v1/models/common.js.map +1 -0
  25. package/lib/openapi/v1/models/content.d.ts +554 -0
  26. package/lib/openapi/v1/models/content.js +613 -0
  27. package/lib/openapi/v1/models/content.js.map +1 -0
  28. package/lib/openapi/v1/models/contentAttachments.d.ts +26 -0
  29. package/lib/openapi/v1/models/contentAttachments.js +33 -0
  30. package/lib/openapi/v1/models/contentAttachments.js.map +1 -0
  31. package/lib/openapi/v1/models/contentBody.d.ts +36 -0
  32. package/lib/openapi/v1/models/contentBody.js +63 -0
  33. package/lib/openapi/v1/models/contentBody.js.map +1 -0
  34. package/lib/openapi/v1/models/contentChildrenAndDescendants.d.ts +75 -0
  35. package/lib/openapi/v1/models/contentChildrenAndDescendants.js +66 -0
  36. package/lib/openapi/v1/models/contentChildrenAndDescendants.js.map +1 -0
  37. package/lib/openapi/v1/models/contentLabels.d.ts +5 -0
  38. package/lib/openapi/v1/models/contentLabels.js +16 -0
  39. package/lib/openapi/v1/models/contentLabels.js.map +1 -0
  40. package/lib/openapi/v1/models/contentMacroBody.d.ts +12 -0
  41. package/lib/openapi/v1/models/contentMacroBody.js +22 -0
  42. package/lib/openapi/v1/models/contentMacroBody.js.map +1 -0
  43. package/lib/openapi/v1/models/contentPermissions.d.ts +41 -0
  44. package/lib/openapi/v1/models/contentPermissions.js +35 -0
  45. package/lib/openapi/v1/models/contentPermissions.js.map +1 -0
  46. package/lib/openapi/v1/models/contentProperties.d.ts +73 -0
  47. package/lib/openapi/v1/models/contentProperties.js +94 -0
  48. package/lib/openapi/v1/models/contentProperties.js.map +1 -0
  49. package/lib/openapi/v1/models/contentRestrictions.d.ts +65 -0
  50. package/lib/openapi/v1/models/contentRestrictions.js +78 -0
  51. package/lib/openapi/v1/models/contentRestrictions.js.map +1 -0
  52. package/lib/openapi/v1/models/contentStates.d.ts +75 -0
  53. package/lib/openapi/v1/models/contentStates.js +72 -0
  54. package/lib/openapi/v1/models/contentStates.js.map +1 -0
  55. package/lib/openapi/v1/models/contentVersions.d.ts +28 -0
  56. package/lib/openapi/v1/models/contentVersions.js +36 -0
  57. package/lib/openapi/v1/models/contentVersions.js.map +1 -0
  58. package/lib/openapi/v1/models/contentWatches.d.ts +89 -0
  59. package/lib/openapi/v1/models/contentWatches.js +81 -0
  60. package/lib/openapi/v1/models/contentWatches.js.map +1 -0
  61. package/lib/openapi/v1/models/dynamicModules.d.ts +62 -0
  62. package/lib/openapi/v1/models/dynamicModules.js +24 -0
  63. package/lib/openapi/v1/models/dynamicModules.js.map +1 -0
  64. package/lib/openapi/v1/models/group.d.ts +9 -0
  65. package/lib/openapi/v1/models/group.js +23 -0
  66. package/lib/openapi/v1/models/group.js.map +1 -0
  67. package/lib/openapi/v1/models/inlineTasks.d.ts +30 -0
  68. package/lib/openapi/v1/models/inlineTasks.js +48 -0
  69. package/lib/openapi/v1/models/inlineTasks.js.map +1 -0
  70. package/lib/openapi/v1/models/labelInfo.d.ts +21 -0
  71. package/lib/openapi/v1/models/labelInfo.js +42 -0
  72. package/lib/openapi/v1/models/labelInfo.js.map +1 -0
  73. package/lib/openapi/v1/models/longRunningTask.d.ts +116 -0
  74. package/lib/openapi/v1/models/longRunningTask.js +82 -0
  75. package/lib/openapi/v1/models/longRunningTask.js.map +1 -0
  76. package/lib/openapi/v1/models/relation.d.ts +30 -0
  77. package/lib/openapi/v1/models/relation.js +61 -0
  78. package/lib/openapi/v1/models/relation.js.map +1 -0
  79. package/lib/openapi/v1/models/search.d.ts +41 -0
  80. package/lib/openapi/v1/models/search.js +65 -0
  81. package/lib/openapi/v1/models/search.js.map +1 -0
  82. package/lib/openapi/v1/models/settings.d.ts +36 -0
  83. package/lib/openapi/v1/models/settings.js +50 -0
  84. package/lib/openapi/v1/models/settings.js.map +1 -0
  85. package/lib/openapi/v1/models/space.d.ts +118 -0
  86. package/lib/openapi/v1/models/space.js +94 -0
  87. package/lib/openapi/v1/models/space.js.map +1 -0
  88. package/lib/openapi/v1/models/spacePermissions.d.ts +128 -0
  89. package/lib/openapi/v1/models/spacePermissions.js +102 -0
  90. package/lib/openapi/v1/models/spacePermissions.js.map +1 -0
  91. package/lib/openapi/v1/models/spaceProperties.d.ts +96 -0
  92. package/lib/openapi/v1/models/spaceProperties.js +93 -0
  93. package/lib/openapi/v1/models/spaceProperties.js.map +1 -0
  94. package/lib/openapi/v1/models/spaceSettings.d.ts +14 -0
  95. package/lib/openapi/v1/models/spaceSettings.js +17 -0
  96. package/lib/openapi/v1/models/spaceSettings.js.map +1 -0
  97. package/lib/openapi/v1/models/template.d.ts +201 -0
  98. package/lib/openapi/v1/models/template.js +163 -0
  99. package/lib/openapi/v1/models/template.js.map +1 -0
  100. package/lib/openapi/v1/models/themes.d.ts +26 -0
  101. package/lib/openapi/v1/models/themes.js +38 -0
  102. package/lib/openapi/v1/models/themes.js.map +1 -0
  103. package/lib/openapi/v1/models/userProperties.d.ts +41 -0
  104. package/lib/openapi/v1/models/userProperties.js +50 -0
  105. package/lib/openapi/v1/models/userProperties.js.map +1 -0
  106. package/lib/openapi/v1/models/users.d.ts +98 -0
  107. package/lib/openapi/v1/models/users.js +87 -0
  108. package/lib/openapi/v1/models/users.js.map +1 -0
  109. package/lib/openapi/v1/services/AnalyticsService.d.ts +54 -0
  110. package/lib/openapi/v1/services/AnalyticsService.js +98 -0
  111. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -0
  112. package/lib/openapi/v1/services/AuditService.d.ts +163 -0
  113. package/lib/openapi/v1/services/AuditService.js +269 -0
  114. package/lib/openapi/v1/services/AuditService.js.map +1 -0
  115. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +332 -0
  116. package/lib/openapi/v1/services/ContentAttachmentsService.js +362 -0
  117. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -0
  118. package/lib/openapi/v1/services/ContentBodyService.d.ts +227 -0
  119. package/lib/openapi/v1/services/ContentBodyService.js +178 -0
  120. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -0
  121. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +621 -0
  122. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +453 -0
  123. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -0
  124. package/lib/openapi/v1/services/ContentCommentsService.d.ts +147 -0
  125. package/lib/openapi/v1/services/ContentCommentsService.js +72 -0
  126. package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -0
  127. package/lib/openapi/v1/services/ContentLabelsService.d.ts +122 -0
  128. package/lib/openapi/v1/services/ContentLabelsService.js +176 -0
  129. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -0
  130. package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +268 -0
  131. package/lib/openapi/v1/services/ContentMacroBodyService.js +193 -0
  132. package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -0
  133. package/lib/openapi/v1/services/ContentPermissionsService.d.ts +34 -0
  134. package/lib/openapi/v1/services/ContentPermissionsService.js +72 -0
  135. package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -0
  136. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +187 -0
  137. package/lib/openapi/v1/services/ContentPropertiesService.js +285 -0
  138. package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -0
  139. package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +503 -0
  140. package/lib/openapi/v1/services/ContentRestrictionsService.js +552 -0
  141. package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -0
  142. package/lib/openapi/v1/services/ContentService.d.ts +1012 -0
  143. package/lib/openapi/v1/services/ContentService.js +548 -0
  144. package/lib/openapi/v1/services/ContentService.js.map +1 -0
  145. package/lib/openapi/v1/services/ContentStatesService.d.ts +220 -0
  146. package/lib/openapi/v1/services/ContentStatesService.js +439 -0
  147. package/lib/openapi/v1/services/ContentStatesService.js.map +1 -0
  148. package/lib/openapi/v1/services/ContentVersionsService.d.ts +121 -0
  149. package/lib/openapi/v1/services/ContentVersionsService.js +181 -0
  150. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -0
  151. package/lib/openapi/v1/services/ContentWatchesService.d.ts +550 -0
  152. package/lib/openapi/v1/services/ContentWatchesService.js +502 -0
  153. package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -0
  154. package/lib/openapi/v1/services/DynamicModulesService.d.ts +47 -0
  155. package/lib/openapi/v1/services/DynamicModulesService.js +92 -0
  156. package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -0
  157. package/lib/openapi/v1/services/ExperimentalService.d.ts +113 -0
  158. package/lib/openapi/v1/services/ExperimentalService.js +185 -0
  159. package/lib/openapi/v1/services/ExperimentalService.js.map +1 -0
  160. package/lib/openapi/v1/services/GroupService.d.ts +379 -0
  161. package/lib/openapi/v1/services/GroupService.js +515 -0
  162. package/lib/openapi/v1/services/GroupService.js.map +1 -0
  163. package/lib/openapi/v1/services/InlineTasksService.d.ts +91 -0
  164. package/lib/openapi/v1/services/InlineTasksService.js +155 -0
  165. package/lib/openapi/v1/services/InlineTasksService.js.map +1 -0
  166. package/lib/openapi/v1/services/LabelInfoService.d.ts +28 -0
  167. package/lib/openapi/v1/services/LabelInfoService.js +59 -0
  168. package/lib/openapi/v1/services/LabelInfoService.js.map +1 -0
  169. package/lib/openapi/v1/services/LongRunningTaskService.d.ts +43 -0
  170. package/lib/openapi/v1/services/LongRunningTaskService.js +96 -0
  171. package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -0
  172. package/lib/openapi/v1/services/RelationService.d.ts +404 -0
  173. package/lib/openapi/v1/services/RelationService.js +270 -0
  174. package/lib/openapi/v1/services/RelationService.js.map +1 -0
  175. package/lib/openapi/v1/services/SearchService.d.ts +175 -0
  176. package/lib/openapi/v1/services/SearchService.js +164 -0
  177. package/lib/openapi/v1/services/SearchService.js.map +1 -0
  178. package/lib/openapi/v1/services/SettingsService.d.ts +143 -0
  179. package/lib/openapi/v1/services/SettingsService.js +249 -0
  180. package/lib/openapi/v1/services/SettingsService.js.map +1 -0
  181. package/lib/openapi/v1/services/SpacePermissionsService.d.ts +68 -0
  182. package/lib/openapi/v1/services/SpacePermissionsService.js +121 -0
  183. package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -0
  184. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +161 -0
  185. package/lib/openapi/v1/services/SpacePropertiesService.js +275 -0
  186. package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -0
  187. package/lib/openapi/v1/services/SpaceService.d.ts +479 -0
  188. package/lib/openapi/v1/services/SpaceService.js +394 -0
  189. package/lib/openapi/v1/services/SpaceService.js.map +1 -0
  190. package/lib/openapi/v1/services/SpaceSettingsService.d.ts +40 -0
  191. package/lib/openapi/v1/services/SpaceSettingsService.js +96 -0
  192. package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -0
  193. package/lib/openapi/v1/services/TemplateService.d.ts +163 -0
  194. package/lib/openapi/v1/services/TemplateService.js +259 -0
  195. package/lib/openapi/v1/services/TemplateService.js.map +1 -0
  196. package/lib/openapi/v1/services/ThemesService.d.ts +101 -0
  197. package/lib/openapi/v1/services/ThemesService.js +228 -0
  198. package/lib/openapi/v1/services/ThemesService.js.map +1 -0
  199. package/lib/openapi/v1/services/UserPropertiesService.d.ts +129 -0
  200. package/lib/openapi/v1/services/UserPropertiesService.js +192 -0
  201. package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -0
  202. package/lib/openapi/v1/services/UsersService.d.ts +181 -0
  203. package/lib/openapi/v1/services/UsersService.js +291 -0
  204. package/lib/openapi/v1/services/UsersService.js.map +1 -0
  205. package/lib/openapi/v1/validationSchemaStorage.d.ts +3 -0
  206. package/lib/openapi/v1/validationSchemaStorage.js +144 -0
  207. package/lib/openapi/v1/validationSchemaStorage.js.map +1 -0
  208. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +88 -0
  209. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +87 -0
  210. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -0
  211. package/lib/openapi/v2/core/CommonHttpClient.d.ts +196 -0
  212. package/lib/openapi/v2/core/CommonHttpClient.js +390 -0
  213. package/lib/openapi/v2/core/CommonHttpClient.js.map +1 -0
  214. package/lib/openapi/v2/core/CommonHttpService.d.ts +7 -0
  215. package/lib/openapi/v2/core/CommonHttpService.js +20 -0
  216. package/lib/openapi/v2/core/CommonHttpService.js.map +1 -0
  217. package/lib/openapi/v2/core/CommonValidationSchemaStorage.d.ts +35 -0
  218. package/lib/openapi/v2/core/CommonValidationSchemaStorage.js +65 -0
  219. package/lib/openapi/v2/core/CommonValidationSchemaStorage.js.map +1 -0
  220. package/lib/openapi/v2/models/ancestors.d.ts +11 -0
  221. package/lib/openapi/v2/models/ancestors.js +21 -0
  222. package/lib/openapi/v2/models/ancestors.js.map +1 -0
  223. package/lib/openapi/v2/models/attachment.d.ts +148 -0
  224. package/lib/openapi/v2/models/attachment.js +116 -0
  225. package/lib/openapi/v2/models/attachment.js.map +1 -0
  226. package/lib/openapi/v2/models/blogPost.d.ts +106 -0
  227. package/lib/openapi/v2/models/blogPost.js +134 -0
  228. package/lib/openapi/v2/models/blogPost.js.map +1 -0
  229. package/lib/openapi/v2/models/children.d.ts +29 -0
  230. package/lib/openapi/v2/models/children.js +38 -0
  231. package/lib/openapi/v2/models/children.js.map +1 -0
  232. package/lib/openapi/v2/models/classificationLevel.d.ts +28 -0
  233. package/lib/openapi/v2/models/classificationLevel.js +45 -0
  234. package/lib/openapi/v2/models/classificationLevel.js.map +1 -0
  235. package/lib/openapi/v2/models/comment.d.ts +396 -0
  236. package/lib/openapi/v2/models/comment.js +378 -0
  237. package/lib/openapi/v2/models/comment.js.map +1 -0
  238. package/lib/openapi/v2/models/common.d.ts +200 -0
  239. package/lib/openapi/v2/models/common.js +225 -0
  240. package/lib/openapi/v2/models/common.js.map +1 -0
  241. package/lib/openapi/v2/models/content.d.ts +16 -0
  242. package/lib/openapi/v2/models/content.js +29 -0
  243. package/lib/openapi/v2/models/content.js.map +1 -0
  244. package/lib/openapi/v2/models/contentProperties.d.ts +33 -0
  245. package/lib/openapi/v2/models/contentProperties.js +33 -0
  246. package/lib/openapi/v2/models/contentProperties.js.map +1 -0
  247. package/lib/openapi/v2/models/customContent.d.ts +174 -0
  248. package/lib/openapi/v2/models/customContent.js +163 -0
  249. package/lib/openapi/v2/models/customContent.js.map +1 -0
  250. package/lib/openapi/v2/models/dataPolicies.d.ts +34 -0
  251. package/lib/openapi/v2/models/dataPolicies.js +38 -0
  252. package/lib/openapi/v2/models/dataPolicies.js.map +1 -0
  253. package/lib/openapi/v2/models/database.d.ts +35 -0
  254. package/lib/openapi/v2/models/database.js +38 -0
  255. package/lib/openapi/v2/models/database.js.map +1 -0
  256. package/lib/openapi/v2/models/operation.d.ts +8 -0
  257. package/lib/openapi/v2/models/operation.js +21 -0
  258. package/lib/openapi/v2/models/operation.js.map +1 -0
  259. package/lib/openapi/v2/models/page.d.ts +124 -0
  260. package/lib/openapi/v2/models/page.js +143 -0
  261. package/lib/openapi/v2/models/page.js.map +1 -0
  262. package/lib/openapi/v2/models/smartLink.d.ts +38 -0
  263. package/lib/openapi/v2/models/smartLink.js +38 -0
  264. package/lib/openapi/v2/models/smartLink.js.map +1 -0
  265. package/lib/openapi/v2/models/space.d.ts +87 -0
  266. package/lib/openapi/v2/models/space.js +100 -0
  267. package/lib/openapi/v2/models/space.js.map +1 -0
  268. package/lib/openapi/v2/models/spaceProperties.d.ts +27 -0
  269. package/lib/openapi/v2/models/spaceProperties.js +32 -0
  270. package/lib/openapi/v2/models/spaceProperties.js.map +1 -0
  271. package/lib/openapi/v2/models/task.d.ts +39 -0
  272. package/lib/openapi/v2/models/task.js +39 -0
  273. package/lib/openapi/v2/models/task.js.map +1 -0
  274. package/lib/openapi/v2/models/version.d.ts +139 -0
  275. package/lib/openapi/v2/models/version.js +91 -0
  276. package/lib/openapi/v2/models/version.js.map +1 -0
  277. package/lib/openapi/v2/models/whiteboard.d.ts +37 -0
  278. package/lib/openapi/v2/models/whiteboard.js +39 -0
  279. package/lib/openapi/v2/models/whiteboard.js.map +1 -0
  280. package/lib/openapi/v2/services/AncestorsService.d.ts +143 -0
  281. package/lib/openapi/v2/services/AncestorsService.js +245 -0
  282. package/lib/openapi/v2/services/AncestorsService.js.map +1 -0
  283. package/lib/openapi/v2/services/AttachmentService.d.ts +307 -0
  284. package/lib/openapi/v2/services/AttachmentService.js +370 -0
  285. package/lib/openapi/v2/services/AttachmentService.js.map +1 -0
  286. package/lib/openapi/v2/services/BlogPostService.d.ts +386 -0
  287. package/lib/openapi/v2/services/BlogPostService.js +379 -0
  288. package/lib/openapi/v2/services/BlogPostService.js.map +1 -0
  289. package/lib/openapi/v2/services/ChildrenService.d.ts +85 -0
  290. package/lib/openapi/v2/services/ChildrenService.js +127 -0
  291. package/lib/openapi/v2/services/ChildrenService.js.map +1 -0
  292. package/lib/openapi/v2/services/ClassificationLevelService.d.ts +213 -0
  293. package/lib/openapi/v2/services/ClassificationLevelService.js +340 -0
  294. package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -0
  295. package/lib/openapi/v2/services/CommentService.d.ts +713 -0
  296. package/lib/openapi/v2/services/CommentService.js +884 -0
  297. package/lib/openapi/v2/services/CommentService.js.map +1 -0
  298. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +844 -0
  299. package/lib/openapi/v2/services/ContentPropertiesService.js +1514 -0
  300. package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -0
  301. package/lib/openapi/v2/services/ContentService.d.ts +31 -0
  302. package/lib/openapi/v2/services/ContentService.js +62 -0
  303. package/lib/openapi/v2/services/ContentService.js.map +1 -0
  304. package/lib/openapi/v2/services/CustomContentService.d.ts +427 -0
  305. package/lib/openapi/v2/services/CustomContentService.js +423 -0
  306. package/lib/openapi/v2/services/CustomContentService.js.map +1 -0
  307. package/lib/openapi/v2/services/DataPoliciesService.d.ts +64 -0
  308. package/lib/openapi/v2/services/DataPoliciesService.js +108 -0
  309. package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -0
  310. package/lib/openapi/v2/services/DatabaseService.d.ts +82 -0
  311. package/lib/openapi/v2/services/DatabaseService.js +135 -0
  312. package/lib/openapi/v2/services/DatabaseService.js.map +1 -0
  313. package/lib/openapi/v2/services/LabelService.d.ts +271 -0
  314. package/lib/openapi/v2/services/LabelService.js +384 -0
  315. package/lib/openapi/v2/services/LabelService.js.map +1 -0
  316. package/lib/openapi/v2/services/LikeService.d.ts +205 -0
  317. package/lib/openapi/v2/services/LikeService.js +358 -0
  318. package/lib/openapi/v2/services/LikeService.js.map +1 -0
  319. package/lib/openapi/v2/services/OperationService.d.ts +154 -0
  320. package/lib/openapi/v2/services/OperationService.js +374 -0
  321. package/lib/openapi/v2/services/OperationService.js.map +1 -0
  322. package/lib/openapi/v2/services/PageService.d.ts +408 -0
  323. package/lib/openapi/v2/services/PageService.js +381 -0
  324. package/lib/openapi/v2/services/PageService.js.map +1 -0
  325. package/lib/openapi/v2/services/SmartLinkService.d.ts +84 -0
  326. package/lib/openapi/v2/services/SmartLinkService.js +137 -0
  327. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -0
  328. package/lib/openapi/v2/services/SpacePermissionsService.d.ts +36 -0
  329. package/lib/openapi/v2/services/SpacePermissionsService.js +66 -0
  330. package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -0
  331. package/lib/openapi/v2/services/SpacePropertiesService.d.ts +118 -0
  332. package/lib/openapi/v2/services/SpacePropertiesService.js +213 -0
  333. package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -0
  334. package/lib/openapi/v2/services/SpaceService.d.ts +141 -0
  335. package/lib/openapi/v2/services/SpaceService.js +133 -0
  336. package/lib/openapi/v2/services/SpaceService.js.map +1 -0
  337. package/lib/openapi/v2/services/TaskService.d.ts +184 -0
  338. package/lib/openapi/v2/services/TaskService.js +165 -0
  339. package/lib/openapi/v2/services/TaskService.js.map +1 -0
  340. package/lib/openapi/v2/services/UserService.d.ts +51 -0
  341. package/lib/openapi/v2/services/UserService.js +83 -0
  342. package/lib/openapi/v2/services/UserService.js.map +1 -0
  343. package/lib/openapi/v2/services/VersionService.d.ts +350 -0
  344. package/lib/openapi/v2/services/VersionService.js +541 -0
  345. package/lib/openapi/v2/services/VersionService.js.map +1 -0
  346. package/lib/openapi/v2/services/WhiteboardService.d.ts +82 -0
  347. package/lib/openapi/v2/services/WhiteboardService.js +135 -0
  348. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -0
  349. package/lib/openapi/v2/validationSchemaStorage.d.ts +3 -0
  350. package/lib/openapi/v2/validationSchemaStorage.js +144 -0
  351. package/lib/openapi/v2/validationSchemaStorage.js.map +1 -0
  352. package/package.json +44 -0
@@ -0,0 +1,621 @@
1
+ import { CommonHttpService } from "../core/CommonHttpService";
2
+ import { type Content, type ContentArray, type ContentChildren, type ContentId, type LongTask } from "../models/common";
3
+ import type { CopyPageHierarchyRequest, CopyPageRequest } from "../models/contentChildrenAndDescendants";
4
+ export declare class ContentChildrenAndDescendantsService extends CommonHttpService {
5
+ /**
6
+ * Copies a single page and its associated properties, permissions, attachments,
7
+ * and custom contents.
8
+ * The `id` path parameter refers to the content ID of the page to copy. The
9
+ * target of the page to be copied
10
+ * is defined using the `destination` in the request body and can be one of the
11
+ * following types.
12
+ *
13
+ * - `space`: page will be copied to the specified space as a root page on the
14
+ * space
15
+ * - `parent_page`: page will be copied as a child of the specified parent page
16
+ * - `existing_page`: page will be copied and replace the specified page
17
+ *
18
+ * By default, the following objects are expanded: `space`, `history`, `version`.
19
+ *
20
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'Add'
21
+ * permission for the space that the content will be copied in and permission to
22
+ * update the content if copying to an `existing_page`.
23
+ *
24
+ * @returns Returned if the content is copied.
25
+ * @path {POST} /wiki/rest/api/content/{id}/copy
26
+ * @scopes-current write:confluence-content
27
+ * @scopes-beta read:content-details:confluence, write:page:confluence
28
+ */
29
+ copyPage({ id, expand, copyPageRequest, }: {
30
+ id: string;
31
+ /**
32
+ * A multi-value parameter indicating which properties of the content to expand.
33
+ * Maximum sub-expansions allowed is `8`.
34
+ *
35
+ * - `childTypes.all` returns whether the content has attachments, comments, or
36
+ * child pages/whiteboards.
37
+ * Use this if you only need to check whether the content has children of a
38
+ * particular type.
39
+ * - `childTypes.attachment` returns whether the content has attachments.
40
+ * - `childTypes.comment` returns whether the content has comments.
41
+ * - `childTypes.page` returns whether the content has child pages.
42
+ * - `childTypes.whiteboard` returns whether the content has child whiteboards.
43
+ * - `childTypes.database` returns whether the content has child databases.
44
+ * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
45
+ * - `childTypes.folder` returns whether the content has child folder.
46
+ * - `container` returns the space that the content is in. This is the same as the
47
+ * information
48
+ * returned by [Get space](#api-space-spaceKey-get).
49
+ * - `metadata.currentuser` returns information about the current user in relation
50
+ * to the content,
51
+ * including when they last viewed it, modified it, contributed to it, or added it
52
+ * as a favorite.
53
+ * - `metadata.properties` returns content properties that have been set via the
54
+ * Confluence REST API.
55
+ * - `metadata.labels` returns the labels that have been added to the content.
56
+ * - `metadata.frontend` this property is only used by Atlassian.
57
+ * - `operations` returns the operations for the content, which are used when
58
+ * setting permissions.
59
+ * - `children.page` returns pages that are descendants at the level immediately
60
+ * below the content.
61
+ * - `children.whiteboard` returns whiteboards that are descendants at the level
62
+ * immediately below the content.
63
+ * - `children.database` returns databases that are descendants at the level
64
+ * immediately below the content.
65
+ * - `children.embed` returns embeds (smartlinks) that are descendants at the
66
+ * level immediately below the content.
67
+ * - `children.folder` returns folders that are descendants at the level
68
+ * immediately below the content.
69
+ * - `children.attachment` returns all attachments for the content.
70
+ * - `children.comment` returns all comments on the content.
71
+ * - `restrictions.read.restrictions.user` returns the users that have permission
72
+ * to read the content.
73
+ * - `restrictions.read.restrictions.group` returns the groups that have
74
+ * permission to read the content. Note that
75
+ * this may return deleted groups, because deleting a group doesn't remove
76
+ * associated restrictions.
77
+ * - `restrictions.update.restrictions.user` returns the users that have
78
+ * permission to update the content.
79
+ * - `restrictions.update.restrictions.group` returns the groups that have
80
+ * permission to update the content. Note that
81
+ * this may return deleted groups because deleting a group doesn't remove
82
+ * associated restrictions.
83
+ * - `history` returns the history of the content, including the date it was
84
+ * created.
85
+ * - `history.lastUpdated` returns information about the most recent update of the
86
+ * content, including
87
+ * who updated it and when it was updated.
88
+ * - `history.previousVersion` returns information about the update prior to the
89
+ * current content update.
90
+ * - `history.contributors` returns all of the users who have contributed to the
91
+ * content.
92
+ * - `history.nextVersion` returns information about the update after to the
93
+ * current content update.
94
+ * - `ancestors` returns the parent content, if the content is a page or
95
+ * whiteboard.
96
+ * - `body` returns the body of the content in different formats, including the
97
+ * editor format,
98
+ * view format, and export format.
99
+ * - `body.storage` returns the body of content in storage format.
100
+ * - `body.view` returns the body of content in view format.
101
+ * - `version` returns information about the most recent update of the content,
102
+ * including who updated it
103
+ * and when it was updated.
104
+ * - `descendants.page` returns pages that are descendants at any level below the
105
+ * content.
106
+ * - `descendants.whiteboard` returns whiteboards that are descendants at any
107
+ * level below the content.
108
+ * - `descendants.database` returns databases that are descendants at any level
109
+ * below the content.
110
+ * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
111
+ * level below the content.
112
+ * - `descendants.folder` returns folders that are descendants at any level below
113
+ * the content.
114
+ * - `descendants.attachment` returns all attachments for the content, same as
115
+ * `children.attachment`.
116
+ * - `descendants.comment` returns all comments on the content, same as
117
+ * `children.comment`.
118
+ * - `space` returns the space that the content is in. This is the same as the
119
+ * information returned by
120
+ * [Get space](#api-space-spaceKey-get).
121
+ *
122
+ * In addition, the following comment-specific expansions can be used:
123
+ * - `extensions.inlineProperties` returns inline comment-specific properties.
124
+ * - `extensions.resolution` returns the resolution status of each comment.
125
+ */
126
+ expand?: string[];
127
+ /** Request object from json post body */
128
+ copyPageRequest: CopyPageRequest;
129
+ }): Promise<Content | null>;
130
+ /**
131
+ * Copy page hierarchy allows the copying of an entire hierarchy of pages and
132
+ * their associated properties, permissions and attachments.
133
+ * The id path parameter refers to the content id of the page to copy, and the
134
+ * new parent of this copied page is defined using the destinationPageId in the
135
+ * request body.
136
+ * The titleOptions object defines the rules of renaming page titles during the
137
+ * copy;
138
+ * for example, search and replace can be used in conjunction to rewrite the
139
+ * copied page titles.
140
+ *
141
+ * Response example:
142
+ * <pre><code>
143
+ * {
144
+ * "id" : "1180606",
145
+ * "links" : {
146
+ * "status" : "/rest/api/longtask/1180606"
147
+ * }
148
+ * }
149
+ * </code></pre>
150
+ * Use the /longtask/<taskId> REST API to get the copy task status.
151
+ *
152
+ * @returns Returns a full JSON representation of a long running task
153
+ * @path {POST} /wiki/rest/api/content/{id}/pagehierarchy/copy
154
+ * @scopes-current write:confluence-content
155
+ * @scopes-beta read:content.metadata:confluence, write:page:confluence
156
+ */
157
+ copyPageHierarchy({ id, copyPageHierarchyRequest, }: {
158
+ id: string;
159
+ /** Request object from json post body */
160
+ copyPageHierarchyRequest: CopyPageHierarchyRequest;
161
+ }): Promise<LongTask>;
162
+ /**
163
+ * Deprecated, use [Confluence's v2
164
+ * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
165
+ *
166
+ * Returns a map of the direct children of a piece of content. A piece of content
167
+ * has different types of child content, depending on its type. These are
168
+ * the default parent-child content type relationships:
169
+ *
170
+ * - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
171
+ * `comment`, `attachment`
172
+ * - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
173
+ * `folder`, `comment`, `attachment`
174
+ * - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
175
+ * `folder`, `comment`, `attachment`
176
+ * - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
177
+ * `folder`, `comment`, `attachment`
178
+ * - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
179
+ * `folder`, `comment`, `attachment`
180
+ * - `blogpost`: child content is `comment`, `attachment`
181
+ * - `attachment`: child content is `comment`
182
+ * - `comment`: child content is `attachment`
183
+ *
184
+ * Apps can override these default relationships. Apps can also introduce
185
+ * new content types that create new parent-child content relationships.
186
+ *
187
+ * Note, the map will always include all child content types that are valid
188
+ * for the content. However, if the content has no instances of a child content
189
+ * type, the map will contain an empty array for that child content type.
190
+ *
191
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
192
+ * permission for the space,
193
+ * and permission to view the content if it is a page.
194
+ *
195
+ * @deprecated
196
+ * @returns Returned if the requested content children are returned.
197
+ * @path {GET} /wiki/rest/api/content/{id}/child
198
+ * @scopes-current read:confluence-content.summary
199
+ * @scopes-beta read:content-details:confluence
200
+ */
201
+ getContentChildren({ id, expand, parentVersion, }: {
202
+ /** The ID of the content to be queried for its children. */
203
+ id: string;
204
+ /**
205
+ * A multi-value parameter indicating which properties of the children to expand,
206
+ * where:
207
+ *
208
+ * - `attachment` returns all attachments for the content.
209
+ * - `comments` returns all comments for the content.
210
+ * - `page` returns all child pages of the content.
211
+ * - `whiteboard` returns all child whiteboards of the content.
212
+ * - `database` returns all child databases of the content.
213
+ * - `embed` returns all child embeds of the content.
214
+ * - `folder` returns all child folders of the content.
215
+ * - Custom content types that are provided by apps are also supported.
216
+ */
217
+ expand?: string[];
218
+ /**
219
+ * The version of the parent content to retrieve children for.
220
+ * Currently, this only works for the latest version.
221
+ */
222
+ parentVersion?: number;
223
+ }): Promise<ContentChildren>;
224
+ /**
225
+ * Deprecated, use [Confluence's v2
226
+ * API](https://developer.atlassian.com/cloud/confluence/rest/v2/intro/).
227
+ *
228
+ * Returns all children of a given type, for a piece of content.
229
+ * A piece of content has different types of child content, depending on its type:
230
+ *
231
+ * - `page`: child content is `page`, `whiteboard`, `database`, `embed`, `folder`,
232
+ * `comment`, `attachment`
233
+ * - `whiteboard`: child content is `page`, `whiteboard`, `database`, `embed`,
234
+ * `folder`, `comment`, `attachment`
235
+ * - `database`: child content is `page`, `whiteboard`, `database`, `embed`,
236
+ * `folder`, `comment`, `attachment`
237
+ * - `embed`: child content is `page`, `whiteboard`, `database`, `embed`,
238
+ * `folder`, `comment`, `attachment`
239
+ * - `folder`: child content is `page`, `whiteboard`, `database`, `embed`,
240
+ * `folder`, `comment`, `attachment`
241
+ * - `blogpost`: child content is `comment`, `attachment`
242
+ * - `attachment`: child content is `comment`
243
+ * - `comment`: child content is `attachment`
244
+ *
245
+ * Custom content types that are provided by apps can also be returned.
246
+ *
247
+ * Note, this method only returns direct children. To return children at all
248
+ * levels, use [Get descendants by type](#api-content-id-descendant-type-get).
249
+ *
250
+ * Starting on Dec 10, 2024, if the expand query parameter is used with the
251
+ * `body.export_view` and/or `body.styled_view` properties, then the query limit
252
+ * parameter will be restricted to a maximum value of 25.
253
+ *
254
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: 'View'
255
+ * permission for the space,
256
+ * and permission to view the content if it is a page.
257
+ *
258
+ * @deprecated
259
+ * @returns Returned if the requested content is returned.
260
+ * @path {GET} /wiki/rest/api/content/{id}/child/{type}
261
+ * @scopes-current read:confluence-content.summary
262
+ * @scopes-beta read:content-details:confluence
263
+ */
264
+ getContentChildrenByType({ id, type, expand, parentVersion, start, limit, }: {
265
+ /** The ID of the content to be queried for its children. */
266
+ id: string;
267
+ /** The type of children to return. */
268
+ type: string;
269
+ /**
270
+ * A multi-value parameter indicating which properties of the content to expand.
271
+ *
272
+ * - `childTypes.all` returns whether the content has attachments, comments, or
273
+ * child pages/whiteboards.
274
+ * Use this if you only need to check whether the content has children of a
275
+ * particular type.
276
+ * - `childTypes.attachment` returns whether the content has attachments.
277
+ * - `childTypes.comment` returns whether the content has comments.
278
+ * - `childTypes.page` returns whether the content has child pages.
279
+ * - `childTypes.whiteboard` returns whether the content has child whiteboards.
280
+ * - `childTypes.database` returns whether the content has child databases.
281
+ * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
282
+ * - `childTypes.folder` returns whether the content has child folders.
283
+ * - `container` returns the space that the content is in. This is the same as the
284
+ * information
285
+ * returned by [Get space](#api-space-spaceKey-get).
286
+ * - `metadata.currentuser` returns information about the current user in relation
287
+ * to the content,
288
+ * including when they last viewed it, modified it, contributed to it, or added it
289
+ * as a favorite.
290
+ * - `metadata.properties` returns content properties that have been set via the
291
+ * Confluence REST API.
292
+ * - `metadata.labels` returns the labels that have been added to the content.
293
+ * - `metadata.frontend` this property is only used by Atlassian.
294
+ * - `operations` returns the operations for the content, which are used when
295
+ * setting permissions.
296
+ * - `children.page` returns pages that are descendants at the level immediately
297
+ * below the content.
298
+ * - `children.whiteboard` returns whiteboards that are descendants at the level
299
+ * immediately below the content.
300
+ * - `children.database` returns databases that are descendants at the level
301
+ * immediately below the content.
302
+ * - `children.embed` returns embeds (smartlinks) that are descendants at the
303
+ * level immediately below the content.
304
+ * - `children.folder` returns folders that are descendants at the level
305
+ * immediately below the content.
306
+ * - `children.attachment` returns all attachments for the content.
307
+ * - `children.comment` returns all comments on the content.
308
+ * - `restrictions.read.restrictions.user` returns the users that have permission
309
+ * to read the content.
310
+ * - `restrictions.read.restrictions.group` returns the groups that have
311
+ * permission to read the content. Note that
312
+ * this may return deleted groups, because deleting a group doesn't remove
313
+ * associated restrictions.
314
+ * - `restrictions.update.restrictions.user` returns the users that have
315
+ * permission to update the content.
316
+ * - `restrictions.update.restrictions.group` returns the groups that have
317
+ * permission to update the content. Note that
318
+ * this may return deleted groups because deleting a group doesn't remove
319
+ * associated restrictions.
320
+ * - `history` returns the history of the content, including the date it was
321
+ * created.
322
+ * - `history.lastUpdated` returns information about the most recent update of the
323
+ * content, including
324
+ * who updated it and when it was updated.
325
+ * - `history.previousVersion` returns information about the update prior to the
326
+ * current content update.
327
+ * - `history.contributors` returns all of the users who have contributed to the
328
+ * content.
329
+ * - `history.nextVersion` returns information about the update after to the
330
+ * current content update.
331
+ * - `ancestors` returns the parent content, if the content is a page or
332
+ * whiteboard.
333
+ * - `body` returns the body of the content in different formats, including the
334
+ * editor format,
335
+ * view format, and export format.
336
+ * - `body.storage` returns the body of content in storage format.
337
+ * - `body.view` returns the body of content in view format.
338
+ * - `version` returns information about the most recent update of the content,
339
+ * including who updated it
340
+ * and when it was updated.
341
+ * - `descendants.page` returns pages that are descendants at any level below the
342
+ * content.
343
+ * - `descendants.whiteboard` returns whiteboards that are descendants at any
344
+ * level below the content.
345
+ * - `descendants.database` returns databases that are descendants at any level
346
+ * below the content.
347
+ * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
348
+ * level below the content.
349
+ * - `descendants.folder` returns folders that are descendants at any level below
350
+ * the content.
351
+ * - `descendants.attachment` returns all attachments for the content, same as
352
+ * `children.attachment`.
353
+ * - `descendants.comment` returns all comments on the content, same as
354
+ * `children.comment`.
355
+ * - `space` returns the space that the content is in. This is the same as the
356
+ * information returned by
357
+ * [Get space](#api-space-spaceKey-get).
358
+ *
359
+ * In addition, the following comment-specific expansions can be used:
360
+ * - `extensions.inlineProperties` returns inline comment-specific properties.
361
+ * - `extensions.resolution` returns the resolution status of each comment.
362
+ */
363
+ expand?: string[];
364
+ /**
365
+ * The version of the parent content to retrieve children for.
366
+ * Currently, this only works for the latest version.
367
+ */
368
+ parentVersion?: number;
369
+ /** The starting index of the returned content. */
370
+ start?: number;
371
+ /**
372
+ * The maximum number of content to return per page. Note,
373
+ * this may be restricted by fixed system limits.
374
+ */
375
+ limit?: number;
376
+ }): Promise<ContentArray>;
377
+ /**
378
+ * Returns a map of the descendants of a piece of content. This is similar
379
+ * to [Get content children](#api-content-id-child-get), except that this
380
+ * method returns child pages at all levels, rather than just the direct
381
+ * child pages.
382
+ *
383
+ * A piece of content has different types of descendants, depending on its type:
384
+ *
385
+ * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
386
+ * `comment`, `attachment`
387
+ * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`,
388
+ * `folder`, `comment`, `attachment`
389
+ * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`,
390
+ * `folder`, `comment`, `attachment`
391
+ * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
392
+ * `comment`, `attachment`
393
+ * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
394
+ * `comment`, `attachment`
395
+ * - `blogpost`: descendant is `comment`, `attachment`
396
+ * - `attachment`: descendant is `comment`
397
+ * - `comment`: descendant is `attachment`
398
+ *
399
+ * The map will always include all descendant types that are valid for the content.
400
+ * However, if the content has no instances of a descendant type, the map will
401
+ * contain an empty array for that descendant type.
402
+ *
403
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
404
+ * 'View' permission for the space, and permission to view the content if it
405
+ * is a page.
406
+ *
407
+ * @returns Returned if the requested descendants are returned.
408
+ * @path {GET} /wiki/rest/api/content/{id}/descendant
409
+ * @scopes-current read:confluence-content.summary
410
+ * @scopes-beta read:content-details:confluence
411
+ */
412
+ getContentDescendants({ id, expand, }: {
413
+ /** The ID of the content to be queried for its descendants. */
414
+ id: string;
415
+ /**
416
+ * A multi-value parameter indicating which properties of the children to
417
+ * expand, where:
418
+ *
419
+ * - `attachment` returns all attachments for the content.
420
+ * - `comments` returns all comments for the content.
421
+ * - `page` returns all child pages of the content.
422
+ * - `whiteboard` returns all child whiteboards of the content.
423
+ * - `database` returns all child databases of the content.
424
+ * - `embed` returns all child embeds of the content.
425
+ * - `folder` returns all child folders of the content.
426
+ */
427
+ expand?: ("attachment" | "comment" | "page")[];
428
+ }): Promise<ContentChildren>;
429
+ /**
430
+ * Returns all descendants of a given type, for a piece of content. This is
431
+ * similar to [Get content children by type](#api-content-id-child-type-get),
432
+ * except that this method returns child pages at all levels, rather than just
433
+ * the direct child pages.
434
+ *
435
+ * A piece of content has different types of descendants, depending on its type:
436
+ *
437
+ * - `page`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
438
+ * `comment`, `attachment`
439
+ * - `whiteboard`: descendant is `page`, `whiteboard`, `database`, `embed`,
440
+ * `folder`, `comment`, `attachment`
441
+ * - `database`: descendant is `page`, `whiteboard`, `database`, `embed`,
442
+ * `folder`, `comment`, `attachment`
443
+ * - `embed`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
444
+ * `comment`, `attachment`
445
+ * - `folder`: descendant is `page`, `whiteboard`, `database`, `embed`, `folder`,
446
+ * `comment`, `attachment`
447
+ * - `blogpost`: descendant is `comment`, `attachment`
448
+ * - `attachment`: descendant is `comment`
449
+ * - `comment`: descendant is `attachment`
450
+ *
451
+ * Custom content types that are provided by apps can also be returned.
452
+ *
453
+ * Starting on Dec 10, 2024, if the expand query parameter is used with the
454
+ * `body.export_view` and/or `body.styled_view` properties, then the query limit
455
+ * parameter will be restricted to a maximum value of 25.
456
+ *
457
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
458
+ * 'View' permission for the space, and permission to view the content if it
459
+ * is a page.
460
+ *
461
+ * @returns Returned if the requested content is returned.
462
+ * @path {GET} /wiki/rest/api/content/{id}/descendant/{type}
463
+ * @scopes-current read:confluence-content.summary
464
+ * @scopes-beta read:content-details:confluence
465
+ */
466
+ getDescendantsOfType({ id, type, depth, expand, start, limit, }: {
467
+ /** The ID of the content to be queried for its descendants. */
468
+ id: string;
469
+ /** The type of descendants to return. */
470
+ type: "page" | "comment" | "attachment";
471
+ /**
472
+ * Filter the results to descendants upto a desired level of the content. Note,
473
+ * the maximum value supported is 100. root level of the content means immediate
474
+ * (level 1) descendants of the type requested. all represents returning all
475
+ * descendants of the type requested.
476
+ */
477
+ depth?: "all" | "root" | "<any positive integer argument in the range of 1 and 100>";
478
+ /**
479
+ * A multi-value parameter indicating which properties of the content to expand.
480
+ *
481
+ * - `childTypes.all` returns whether the content has attachments, comments, or
482
+ * child pages/whiteboards.
483
+ * Use this if you only need to check whether the content has children of a
484
+ * particular type.
485
+ * - `childTypes.attachment` returns whether the content has attachments.
486
+ * - `childTypes.comment` returns whether the content has comments.
487
+ * - `childTypes.page` returns whether the content has child pages.
488
+ * - `childTypes.whiteboard` returns whether the content has child whiteboards.
489
+ * - `childTypes.database` returns whether the content has child databases.
490
+ * - `childTypes.embed` returns whether the content has child embeds (smartlinks).
491
+ * - `childTypes.folder` returns whether the content has child folders.
492
+ * - `container` returns the space that the content is in. This is the same as the
493
+ * information
494
+ * returned by [Get space](#api-space-spaceKey-get).
495
+ * - `metadata.currentuser` returns information about the current user in relation
496
+ * to the content,
497
+ * including when they last viewed it, modified it, contributed to it, or added it
498
+ * as a favorite.
499
+ * - `metadata.properties` returns content properties that have been set via the
500
+ * Confluence REST API.
501
+ * - `metadata.labels` returns the labels that have been added to the content.
502
+ * - `metadata.frontend` this property is only used by Atlassian.
503
+ * - `operations` returns the operations for the content, which are used when
504
+ * setting permissions.
505
+ * - `children.page` returns pages that are descendants at the level immediately
506
+ * below the content.
507
+ * - `children.whiteboard` returns whiteboards that are descendants at the level
508
+ * immediately below the content.
509
+ * - `children.database` returns databases that are descendants at the level
510
+ * immediately below the content.
511
+ * - `children.embed` returns embeds (smartlinks) that are descendants at the
512
+ * level immediately below the content.
513
+ * - `children.folder` returns folders that are descendants at the level
514
+ * immediately below the content.
515
+ * - `children.attachment` returns all attachments for the content.
516
+ * - `children.comment` returns all comments on the content.
517
+ * - `restrictions.read.restrictions.user` returns the users that have permission
518
+ * to read the content.
519
+ * - `restrictions.read.restrictions.group` returns the groups that have
520
+ * permission to read the content. Note that
521
+ * this may return deleted groups, because deleting a group doesn't remove
522
+ * associated restrictions.
523
+ * - `restrictions.update.restrictions.user` returns the users that have
524
+ * permission to update the content.
525
+ * - `restrictions.update.restrictions.group` returns the groups that have
526
+ * permission to update the content. Note that
527
+ * this may return deleted groups because deleting a group doesn't remove
528
+ * associated restrictions.
529
+ * - `history` returns the history of the content, including the date it was
530
+ * created.
531
+ * - `history.lastUpdated` returns information about the most recent update of the
532
+ * content, including
533
+ * who updated it and when it was updated.
534
+ * - `history.previousVersion` returns information about the update prior to the
535
+ * current content update.
536
+ * - `history.contributors` returns all of the users who have contributed to the
537
+ * content.
538
+ * - `history.nextVersion` returns information about the update after to the
539
+ * current content update.
540
+ * - `ancestors` returns the parent content, if the content is a page or
541
+ * whiteboard.
542
+ * - `body` returns the body of the content in different formats, including the
543
+ * editor format,
544
+ * view format, and export format.
545
+ * - `body.storage` returns the body of content in storage format.
546
+ * - `body.view` returns the body of content in view format.
547
+ * - `version` returns information about the most recent update of the content,
548
+ * including who updated it
549
+ * and when it was updated.
550
+ * - `descendants.page` returns pages that are descendants at any level below the
551
+ * content.
552
+ * - `descendants.whiteboard` returns whiteboards that are descendants at any
553
+ * level below the content.
554
+ * - `descendants.database` returns databases that are descendants at any level
555
+ * below the content.
556
+ * - `descendants.embed` returns embeds (smartlinks) that are descendants at any
557
+ * level below the content.
558
+ * - `descendants.folder` returns folders that are descendants at any level below
559
+ * the content.
560
+ * - `descendants.attachment` returns all attachments for the content, same as
561
+ * `children.attachment`.
562
+ * - `descendants.comment` returns all comments on the content, same as
563
+ * `children.comment`.
564
+ * - `space` returns the space that the content is in. This is the same as the
565
+ * information returned by
566
+ * [Get space](#api-space-spaceKey-get).
567
+ *
568
+ * In addition, the following comment-specific expansions can be used:
569
+ * - `extensions.inlineProperties` returns inline comment-specific properties.
570
+ * - `extensions.resolution` returns the resolution status of each comment.
571
+ */
572
+ expand?: string[];
573
+ /** The starting index of the returned content. */
574
+ start?: number;
575
+ /**
576
+ * The maximum number of content to return per page. Note,
577
+ * this may be restricted by fixed system limits.
578
+ */
579
+ limit?: number;
580
+ }): Promise<ContentArray>;
581
+ /**
582
+ * Move a page to a new location relative to a target page:
583
+ *
584
+ * * `before` - move the page under the same parent as the target, before the
585
+ * target in the list of children
586
+ * * `after` - move the page under the same parent as the target, after the target
587
+ * in the list of children
588
+ * * `append` - move the page to be a child of the target
589
+ *
590
+ * Caution: This API can move pages to the top level of a space. Top-level pages
591
+ * are difficult to find in the UI
592
+ * because they do not show up in the page tree display. To avoid this, never use
593
+ * `before` or `after` positions
594
+ * when the `targetId` is a top-level page.
595
+ *
596
+ * @returns Page was successfully moved
597
+ * @path {PUT} /wiki/rest/api/content/{pageId}/move/{position}/{targetId}
598
+ * @scopes-current write:confluence-content
599
+ * @scopes-beta write:page:confluence
600
+ */
601
+ movePage({ pageId, position, targetId, }: {
602
+ /** The ID of the page to be moved */
603
+ pageId: string;
604
+ /**
605
+ * The position to move the page to relative to the target page:
606
+ * * `before` - move the page under the same parent as the target, before the
607
+ * target in the list of children
608
+ * * `after` - move the page under the same parent as the target, after the target
609
+ * in the list of children
610
+ * * `append` - move the page to be a child of the target
611
+ */
612
+ position: "before" | "after" | "append";
613
+ /** The ID of the target page for this operation */
614
+ targetId: string;
615
+ }): Promise<{
616
+ pageId?: ContentId;
617
+ } & {
618
+ [key: string]: unknown;
619
+ }>;
620
+ static initialize(): void;
621
+ }