@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 @@
1
+ {"version":3,"file":"AttachmentService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/AttachmentService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,qDAK8B;AAC9B,6CAG0B;AAC1B,wEAAqE;AACrE,MAAa,iBAAkB,SAAQ,qCAAiB;IACtD;;;;;;;;;;;;;;;OAeG;IACH,gBAAgB,CAAC,EACf,EAAE,EACF,KAAK,GAMN;QACC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,QAAQ;YAChB,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,KAAK;aACN;SACF,CAAC;aACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;IAC1C,CAAC;IACD;;;;;;;;;OASG;IACH,iBAAiB,CAAC,EAChB,EAAE,EACF,OAAO,EACP,aAAa,EACb,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,cAAc,GAiDf;QAaC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,mBAAmB;YACzB,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,OAAO;gBACP,gBAAgB,EAAE,aAAa;gBAC/B,oBAAoB,EAAE,iBAAiB;gBACvC,oBAAoB,EAAE,iBAAiB;gBACvC,kBAAkB,EAAE,eAAe;gBACnC,iBAAiB,EAAE,cAAc;aAClC;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAazB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,8CAA8C,CAC/C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EACb,IAAI,EACJ,MAAM,EACN,MAAM,EACN,SAAS,EACT,QAAQ,EACR,KAAK,GAyBN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,cAAc;YACpB,MAAM,EAAE,KAAK;YACb,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;gBACN,MAAM;gBACN,SAAS;gBACT,QAAQ;gBACR,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,2CAA2C,CAC5C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,sBAAsB,CAAC,EACrB,EAAE,EACF,IAAI,EACJ,MAAM,EACN,MAAM,EACN,SAAS,EACT,QAAQ,EACR,KAAK,GA2BN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,6BAA6B;YACnC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;gBACN,MAAM;gBACN,SAAS;gBACT,QAAQ;gBACR,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,mDAAmD,CACpD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,2BAA2B,CAAC,EAC1B,EAAE,EACF,IAAI,EACJ,MAAM,EACN,MAAM,EACN,SAAS,EACT,QAAQ,EACR,KAAK,GA2BN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,kCAAkC;YACxC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;gBACN,MAAM;gBACN,SAAS;gBACT,QAAQ;gBACR,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,wDAAwD,CACzD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;OAYG;IACH,mBAAmB,CAAC,EAClB,EAAE,EACF,IAAI,EACJ,MAAM,EACN,KAAK,GAkBN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,0BAA0B;YAChC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;gBACN,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EACjB,EAAE,EACF,IAAI,EACJ,MAAM,EACN,MAAM,EACN,SAAS,EACT,QAAQ,EACR,KAAK,GA2BN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,yBAAyB;YAC/B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,IAAI;gBACJ,MAAM;gBACN,MAAM;gBACN,SAAS;gBACT,QAAQ;gBACR,KAAK;aACN;SACF,CAAC;aACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;YACvC,GAAG,EAAE;gBACH,kBAAkB,EAAE,MAAM;aAC3B;SACF,CAAC,CACH;aACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,2CAA2C,EAC3C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;qBACrD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,2CAA2C,CAAC,CACzD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,8CAA8C,EAC9C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC,CAAC,YAAY,CAClB,iDAAuB,CAAC,IAAI,CAAC,kBAAkB,CAAC,EAChD,OAAC;iBACE,MAAM,CAAC;gBACN,MAAM,EAAE,OAAC;qBACN,MAAM,CAAC;oBACN,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;iBAC5B,CAAC;qBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;qBACrB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC,CACzB;SACF,CAAC;aACD,QAAQ,CAAC,8CAA8C,CAAC,CAC5D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,mDAAmD,EACnD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;qBACrD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,mDAAmD,CAAC,CACjE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;qBACrD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gDAAgD,EAChD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;qBACrD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,gDAAgD,CAAC,CAC9D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;qBACrD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,+CAA+C,CAAC,CAC7D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,gDAAmC;YACnC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA5uBD,8CA4uBC"}
@@ -0,0 +1,386 @@
1
+ import { CommonHttpService } from "../core/CommonHttpService";
2
+ import { type BlogPostBodyWrite, type BlogPostBulk, type BlogPostNestedBodyWrite, type BlogPostSingle, type BlogPostSortOrder } from "../models/blogPost";
3
+ import { type MultiEntityLinks, type PrimaryBodyRepresentation, type PrimaryBodyRepresentationSingle } from "../models/common";
4
+ export declare class BlogPostService extends CommonHttpService {
5
+ /**
6
+ * Creates a new blog post in the space specified by the spaceId.
7
+ *
8
+ * By default this will create the blog post as a non-draft, unless the status is
9
+ * specified as draft.
10
+ * If creating a non-draft, the title must not be empty.
11
+ *
12
+ * Currently only supports the storage representation specified in the
13
+ * body.representation enums below
14
+ *
15
+ * @returns Returned if the blog post was created successfully.
16
+ * @path {POST} /blogposts
17
+ * @scopes-current write:page:confluence
18
+ */
19
+ createBlogPost({ private: privateQuery, requestBody, }: {
20
+ /**
21
+ * The blog post will be private. Only the user who creates this blog post will
22
+ * have permission to view and edit one.
23
+ */
24
+ private?: boolean;
25
+ requestBody: {
26
+ /** ID of the space */
27
+ spaceId: string;
28
+ /**
29
+ * The status of the blog post, specifies if the blog post will be created as a
30
+ * new blog post or a draft
31
+ */
32
+ status?: "current" | "draft";
33
+ /** Title of the blog post, required if creating non-draft. */
34
+ title?: string;
35
+ body?: BlogPostBodyWrite | BlogPostNestedBodyWrite;
36
+ } & {
37
+ [key: string]: unknown;
38
+ };
39
+ }): Promise<BlogPostSingle & ({
40
+ _links?: {
41
+ /** Base url of the Confluence site. */
42
+ base?: string;
43
+ } & {
44
+ [key: string]: unknown;
45
+ };
46
+ } & {
47
+ [key: string]: unknown;
48
+ })>;
49
+ /**
50
+ * Delete a blog post by id.
51
+ *
52
+ * By default this will delete blog posts that are non-drafts. To delete a blog
53
+ * post that is a draft, the endpoint must be called on a
54
+ * draft with the following param `draft=true`. Discarded drafts are not sent to
55
+ * the trash and are permanently deleted.
56
+ *
57
+ * Deleting a blog post that is not a draft moves the blog post to the trash,
58
+ * where it can be restored later.
59
+ * To permanently delete a blog post (or "purge" it), the endpoint must be called
60
+ * on a **trashed** blog post with the following param `purge=true`.
61
+ *
62
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
63
+ * Permission to view the blog post and its corresponding space.
64
+ * Permission to delete blog posts in the space.
65
+ * Permission to administer the space (if attempting to purge).
66
+ *
67
+ * @path {DELETE} /blogposts/{id}
68
+ * @scopes-current delete:page:confluence
69
+ */
70
+ deleteBlogPost({ id, purge, draft, }: {
71
+ /** The ID of the blog post to be deleted. */
72
+ id: number;
73
+ /** If attempting to purge the blog post. */
74
+ purge?: boolean;
75
+ /** If attempting to delete a blog post that is a draft. */
76
+ draft?: boolean;
77
+ }): Promise<void>;
78
+ /**
79
+ * Returns a specific blog post.
80
+ *
81
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
82
+ * Permission to view the blog post and its corresponding space.
83
+ *
84
+ * @returns Returned if the requested blog post is returned.
85
+ * @path {GET} /blogposts/{id}
86
+ * @scopes-current read:page:confluence
87
+ */
88
+ getBlogPostById({ id, bodyFormat, getDraft, version, includeLabels, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, includeFavoritedByCurrentUserStatus, }: {
89
+ /**
90
+ * The ID of the blog post to be returned. If you don't know the blog post ID, use
91
+ * Get blog posts and filter the results.
92
+ */
93
+ id: number;
94
+ /**
95
+ * The content format types to be returned in the `body` field of the response. If
96
+ * available, the representation will be available under a response field of the
97
+ * same name under the `body` field.
98
+ */
99
+ bodyFormat?: PrimaryBodyRepresentationSingle;
100
+ /** Retrieve the draft version of this blog post. */
101
+ getDraft?: boolean;
102
+ /**
103
+ * Allows you to retrieve a previously published version. Specify the previous
104
+ * version's number to retrieve its details.
105
+ */
106
+ version?: number;
107
+ /**
108
+ * Includes labels associated with this blog post in the response.
109
+ * The number of results will be limited to 50 and sorted in the default sort
110
+ * order.
111
+ * A `meta` and `_links` property will be present to indicate if more results are
112
+ * available and a link to retrieve the rest of the results.
113
+ */
114
+ includeLabels?: boolean;
115
+ /**
116
+ * Includes content properties associated with this blog post in the response.
117
+ * The number of results will be limited to 50 and sorted in the default sort
118
+ * order.
119
+ * A `meta` and `_links` property will be present to indicate if more results are
120
+ * available and a link to retrieve the rest of the results.
121
+ */
122
+ includeProperties?: boolean;
123
+ /**
124
+ * Includes operations associated with this blog post in the response.
125
+ * The number of results will be limited to 50 and sorted in the default sort
126
+ * order.
127
+ * A `meta` and `_links` property will be present to indicate if more results are
128
+ * available and a link to retrieve the rest of the results.
129
+ */
130
+ includeOperations?: boolean;
131
+ /**
132
+ * Includes likes associated with this blog post in the response.
133
+ * The number of results will be limited to 50 and sorted in the default sort
134
+ * order.
135
+ * A `meta` and `_links` property will be present to indicate if more results are
136
+ * available and a link to retrieve the rest of the results.
137
+ */
138
+ includeLikes?: boolean;
139
+ /**
140
+ * Includes versions associated with this blog post in the response.
141
+ * The number of results will be limited to 50 and sorted in the default sort
142
+ * order.
143
+ * A `meta` and `_links` property will be present to indicate if more results are
144
+ * available and a link to retrieve the rest of the results.
145
+ */
146
+ includeVersions?: boolean;
147
+ /**
148
+ * Includes the current version associated with this blog post in the response.
149
+ * By default this is included and can be omitted by setting the value to `false`.
150
+ */
151
+ includeVersion?: boolean;
152
+ /** Includes whether this blog post has been favorited by the current user. */
153
+ includeFavoritedByCurrentUserStatus?: boolean;
154
+ }): Promise<BlogPostSingle & ({
155
+ _links?: {
156
+ /** Base url of the Confluence site. */
157
+ base?: string;
158
+ } & {
159
+ [key: string]: unknown;
160
+ };
161
+ } & {
162
+ [key: string]: unknown;
163
+ })>;
164
+ /**
165
+ * Returns all blog posts. The number of results is limited by the `limit`
166
+ * parameter and additional results (if available)
167
+ * will be available through the `next` URL present in the `Link` response header.
168
+ *
169
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
170
+ * Permission to access the Confluence site ('Can use' global permission).
171
+ * Only blog posts that the user has permission to view will be returned.
172
+ *
173
+ * @returns Returned if the requested blog posts are returned.
174
+ * @path {GET} /blogposts
175
+ * @scopes-current read:page:confluence
176
+ */
177
+ getBlogPosts({ id, spaceId, sort, status, title, bodyFormat, cursor, limit, }: {
178
+ /**
179
+ * Filter the results based on blog post ids. Multiple blog post ids can be
180
+ * specified as a comma-separated list.
181
+ */
182
+ id?: number[];
183
+ /**
184
+ * Filter the results based on space ids. Multiple space ids can be specified as a
185
+ * comma-separated list.
186
+ */
187
+ spaceId?: number[];
188
+ /** Used to sort the result by a particular field. */
189
+ sort?: BlogPostSortOrder;
190
+ /**
191
+ * Filter the results to blog posts based on their status. By default, `current`
192
+ * is used.
193
+ */
194
+ status?: ("current" | "deleted" | "trashed")[];
195
+ /** Filter the results to blog posts based on their title. */
196
+ title?: string;
197
+ /**
198
+ * The content format types to be returned in the `body` field of the response. If
199
+ * available, the representation will be available under a response field of the
200
+ * same name under the `body` field.
201
+ */
202
+ bodyFormat?: PrimaryBodyRepresentation;
203
+ /**
204
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
205
+ * the `Link` response header. Use the relative URL in the `Link` header to
206
+ * retrieve the `next` set of results.
207
+ */
208
+ cursor?: string;
209
+ /**
210
+ * Maximum number of blog posts per result to return. If more results exist, use
211
+ * the `Link` response header to retrieve a relative URL that will return the next
212
+ * set of results.
213
+ */
214
+ limit?: number;
215
+ }): Promise<{
216
+ results?: BlogPostBulk[];
217
+ _links?: MultiEntityLinks;
218
+ } & {
219
+ [key: string]: unknown;
220
+ }>;
221
+ /**
222
+ * Returns all blog posts in a space. The number of results is limited by the
223
+ * `limit` parameter and additional results (if available)
224
+ * will be available through the `next` URL present in the `Link` response header.
225
+ *
226
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
227
+ * Permission to access the Confluence site ('Can use' global permission) and view
228
+ * the space.
229
+ * Only blog posts that the user has permission to view will be returned.
230
+ *
231
+ * @returns Returned if the requested blog posts are returned.
232
+ * @path {GET} /spaces/{id}/blogposts
233
+ * @scopes-current read:page:confluence
234
+ */
235
+ getBlogPostsInSpace({ id, sort, status, title, bodyFormat, cursor, limit, }: {
236
+ /** The ID of the space for which blog posts should be returned. */
237
+ id: number;
238
+ /** Used to sort the result by a particular field. */
239
+ sort?: BlogPostSortOrder;
240
+ /**
241
+ * Filter the results to blog posts based on their status. By default, `current`
242
+ * is used.
243
+ */
244
+ status?: ("current" | "deleted" | "trashed")[];
245
+ /** Filter the results to blog posts based on their title. */
246
+ title?: string;
247
+ /**
248
+ * The content format types to be returned in the `body` field of the response. If
249
+ * available, the representation will be available under a response field of the
250
+ * same name under the `body` field.
251
+ */
252
+ bodyFormat?: PrimaryBodyRepresentation;
253
+ /**
254
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
255
+ * the `Link` response header. Use the relative URL in the `Link` header to
256
+ * retrieve the `next` set of results.
257
+ */
258
+ cursor?: string;
259
+ /**
260
+ * Maximum number of blog posts per result to return. If more results exist, use
261
+ * the `Link` header to retrieve a relative URL that will return the next set of
262
+ * results.
263
+ */
264
+ limit?: number;
265
+ }): Promise<{
266
+ results?: BlogPostBulk[];
267
+ _links?: MultiEntityLinks;
268
+ } & {
269
+ [key: string]: unknown;
270
+ }>;
271
+ /**
272
+ * Returns the blogposts of specified label. The number of results is limited by
273
+ * the `limit` parameter and additional results (if available)
274
+ * will be available through the `next` URL present in the `Link` response header.
275
+ *
276
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
277
+ * Permission to view the content of the page and its corresponding space.
278
+ *
279
+ * @returns Returned if the requested blog posts for specified label were successfully
280
+ * fetched.
281
+ * @path {GET} /labels/{id}/blogposts
282
+ * @scopes-current read:page:confluence
283
+ */
284
+ getLabelBlogPosts({ id, spaceId, bodyFormat, sort, cursor, limit, }: {
285
+ /** The ID of the label for which blog posts should be returned. */
286
+ id: number;
287
+ /**
288
+ * Filter the results based on space ids. Multiple space ids can be specified as a
289
+ * comma-separated list.
290
+ */
291
+ spaceId?: number[];
292
+ /**
293
+ * The content format types to be returned in the `body` field of the response. If
294
+ * available, the representation will be available under a response field of the
295
+ * same name under the `body` field.
296
+ */
297
+ bodyFormat?: PrimaryBodyRepresentation;
298
+ /** Used to sort the result by a particular field. */
299
+ sort?: BlogPostSortOrder;
300
+ /**
301
+ * Used for pagination, this opaque cursor will be returned in the `next` URL in
302
+ * the `Link` response header. Use the relative URL in the `Link` header to
303
+ * retrieve the `next` set of results.
304
+ */
305
+ cursor?: string;
306
+ /**
307
+ * Maximum number of blog posts per result to return. If more results exist, use
308
+ * the `Link` header to retrieve a relative URL that will return the next set of
309
+ * results.
310
+ */
311
+ limit?: number;
312
+ }): Promise<{
313
+ results?: BlogPostBulk[];
314
+ _links?: MultiEntityLinks;
315
+ } & {
316
+ [key: string]: unknown;
317
+ }>;
318
+ /**
319
+ * Update a blog post by id.
320
+ *
321
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
322
+ * Permission to view the blog post and its corresponding space. Permission to
323
+ * update blog posts in the space.
324
+ *
325
+ * @returns Returned if the requested blog post is successfully updated.
326
+ * @path {PUT} /blogposts/{id}
327
+ * @scopes-current write:page:confluence
328
+ */
329
+ updateBlogPost({ id, requestBody, }: {
330
+ /**
331
+ * The ID of the blog post to be updated. If you don't know the blog post ID, use
332
+ * Get Blog Posts and filter the results.
333
+ */
334
+ id: number;
335
+ requestBody: {
336
+ /** Id of the blog post. */
337
+ id: string;
338
+ /**
339
+ * The updated status of the blog post.
340
+ *
341
+ * Note, if you change the status of a blog post from 'current' to 'draft' and it
342
+ * has an existing draft, the existing draft will be deleted in favor of the
343
+ * updated draft.
344
+ * Additionally, this endpoint can be used to restore a 'trashed' or 'deleted'
345
+ * blog post to 'current' status. For restoration, blog post contents will not be
346
+ * updated and only the blog post status will be changed.
347
+ */
348
+ status: "current" | "draft";
349
+ /** Title of the blog post. */
350
+ title: string;
351
+ /**
352
+ * ID of the containing space.
353
+ *
354
+ * This currently **does not support moving the blog post to a different space**.
355
+ */
356
+ spaceId?: string;
357
+ body: BlogPostBodyWrite | BlogPostNestedBodyWrite;
358
+ version: {
359
+ /**
360
+ * The new version number of the updated blog post.
361
+ * Set this to the current version number plus one, unless you are updating the
362
+ * status to 'draft' which requires a version number of 1.
363
+ *
364
+ * If you don't know the current version number, use Get blog post by id.
365
+ */
366
+ number?: number;
367
+ /** An optional message to be stored with the version. */
368
+ message?: string;
369
+ } & {
370
+ [key: string]: unknown;
371
+ };
372
+ } & {
373
+ [key: string]: unknown;
374
+ };
375
+ }): Promise<BlogPostSingle & ({
376
+ _links?: {
377
+ /** Base url of the Confluence site. */
378
+ base?: string;
379
+ } & {
380
+ [key: string]: unknown;
381
+ };
382
+ } & {
383
+ [key: string]: unknown;
384
+ })>;
385
+ static initialize(): void;
386
+ }