@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,884 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.CommentService = void 0;
4
+ // DO NOT EDIT!
5
+ // This file is generated by "api-typescript-generator".
6
+ // To update this file run "yarn build:openapi".
7
+ const zod_1 = require("zod");
8
+ const commonHttpClient = require("../core/CommonHttpClient");
9
+ const CommonHttpService_1 = require("../core/CommonHttpService");
10
+ const comment_1 = require("../models/comment");
11
+ const common_1 = require("../models/common");
12
+ const validationSchemaStorage_1 = require("../validationSchemaStorage");
13
+ class CommentService extends CommonHttpService_1.CommonHttpService {
14
+ /**
15
+ * Create a footer comment.
16
+ *
17
+ * The footer comment can be made against several locations:
18
+ * - at the top level (specifying pageId or blogPostId in the request body)
19
+ * - as a reply (specifying parentCommentId in the request body)
20
+ * - against an attachment (note: this is different than the comments added via
21
+ * the attachment properties page on the UI, which are referred to as version
22
+ * comments)
23
+ * - against a custom content
24
+ *
25
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
26
+ * Permission to view the content of the page or blogpost and its corresponding
27
+ * space. Permission to create comments in the space.
28
+ *
29
+ * @returns Returned if the footer comment is created.
30
+ * @path {POST} /footer-comments
31
+ * @scopes-current write:comment:confluence
32
+ */
33
+ createFooterComment({ createFooterCommentModel, }) {
34
+ return this.getClientInstance()
35
+ .request({
36
+ path: "/footer-comments",
37
+ method: "POST",
38
+ headers: {
39
+ "Content-Type": "application/json",
40
+ },
41
+ body: createFooterCommentModel,
42
+ })
43
+ .then(this.getClientInstance().responseHandler({
44
+ 201: {
45
+ "application/json": "json",
46
+ },
47
+ }))
48
+ .then(commonHttpClient.castResponse())
49
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.createFooterComment.response"))
50
+ .then(commonHttpClient.getBody);
51
+ }
52
+ /**
53
+ * Create an inline comment. This can be at the top level (specifying pageId or
54
+ * blogPostId in the request body)
55
+ * or as a reply (specifying parentCommentId in the request body). Note the
56
+ * inlineCommentProperties object in the
57
+ * request body is used to select the text the inline comment should be tied to.
58
+ * This is what determines the text
59
+ * highlighting when viewing a page in Confluence.
60
+ *
61
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
62
+ * Permission to view the content of the page or blogpost and its corresponding
63
+ * space. Permission to create comments in the space.
64
+ *
65
+ * @returns Returned if the inline comment is created.
66
+ * @path {POST} /inline-comments
67
+ * @scopes-current write:comment:confluence
68
+ */
69
+ createInlineComment({ createInlineCommentModel, }) {
70
+ return this.getClientInstance()
71
+ .request({
72
+ path: "/inline-comments",
73
+ method: "POST",
74
+ headers: {
75
+ "Content-Type": "application/json",
76
+ },
77
+ body: createInlineCommentModel,
78
+ })
79
+ .then(this.getClientInstance().responseHandler({
80
+ 201: {
81
+ "application/json": "json",
82
+ },
83
+ }))
84
+ .then(commonHttpClient.castResponse())
85
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.createInlineComment.response"))
86
+ .then(commonHttpClient.getBody);
87
+ }
88
+ /**
89
+ * Deletes a footer comment. This is a permanent deletion and cannot be reverted.
90
+ *
91
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
92
+ * Permission to view the content of the page or blogpost and its corresponding
93
+ * space. Permission to delete comments in the space.
94
+ *
95
+ * @path {DELETE} /footer-comments/{comment-id}
96
+ * @scopes-current delete:comment:confluence
97
+ */
98
+ deleteFooterComment({ commentId, }) {
99
+ return this.getClientInstance()
100
+ .request({
101
+ path: "/footer-comments/{comment-id}",
102
+ method: "DELETE",
103
+ pathParams: {
104
+ "comment-id": commentId,
105
+ },
106
+ })
107
+ .then(commonHttpClient.discardResult);
108
+ }
109
+ /**
110
+ * Deletes an inline comment. This is a permanent deletion and cannot be reverted.
111
+ *
112
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
113
+ * Permission to view the content of the page or blogpost and its corresponding
114
+ * space. Permission to delete comments in the space.
115
+ *
116
+ * @path {DELETE} /inline-comments/{comment-id}
117
+ * @scopes-current delete:comment:confluence
118
+ */
119
+ deleteInlineComment({ commentId, }) {
120
+ return this.getClientInstance()
121
+ .request({
122
+ path: "/inline-comments/{comment-id}",
123
+ method: "DELETE",
124
+ pathParams: {
125
+ "comment-id": commentId,
126
+ },
127
+ })
128
+ .then(commonHttpClient.discardResult);
129
+ }
130
+ /**
131
+ * Returns the comments of the specific attachment.
132
+ * The number of results is limited by the `limit` parameter and additional
133
+ * results (if available) will be available through
134
+ * the `next` URL present in the `Link` response header.
135
+ *
136
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
137
+ * Permission to view the attachment and its corresponding containers.
138
+ *
139
+ * @returns Returned if the attachment comments were successfully retrieved
140
+ * @path {GET} /attachments/{id}/footer-comments
141
+ * @scopes-current read:comment:confluence
142
+ */
143
+ getAttachmentComments({ id, bodyFormat, cursor, limit, sort, version, }) {
144
+ return this.getClientInstance()
145
+ .request({
146
+ path: "/attachments/{id}/footer-comments",
147
+ method: "GET",
148
+ pathParams: {
149
+ id,
150
+ },
151
+ query: {
152
+ "body-format": bodyFormat,
153
+ cursor,
154
+ limit,
155
+ sort,
156
+ version,
157
+ },
158
+ })
159
+ .then(this.getClientInstance().responseHandler({
160
+ 200: {
161
+ "application/json": "json",
162
+ },
163
+ }))
164
+ .then(commonHttpClient.castResponse())
165
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getAttachmentComments.response"))
166
+ .then(commonHttpClient.getBody);
167
+ }
168
+ /**
169
+ * Returns the root footer comments of specific blog post. The number of results
170
+ * is limited by the `limit` parameter and additional results (if available)
171
+ * will be available through the `next` URL present in the `Link` response header.
172
+ *
173
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
174
+ * Permission to view the content of the blog post and its corresponding space.
175
+ *
176
+ * @returns Returned if the requested footer comments are returned.
177
+ * @path {GET} /blogposts/{id}/footer-comments
178
+ * @scopes-current read:comment:confluence
179
+ */
180
+ getBlogPostFooterComments({ id, bodyFormat, sort, cursor, limit, }) {
181
+ return this.getClientInstance()
182
+ .request({
183
+ path: "/blogposts/{id}/footer-comments",
184
+ method: "GET",
185
+ pathParams: {
186
+ id,
187
+ },
188
+ query: {
189
+ "body-format": bodyFormat,
190
+ sort,
191
+ cursor,
192
+ limit,
193
+ },
194
+ })
195
+ .then(this.getClientInstance().responseHandler({
196
+ 200: {
197
+ "application/json": "json",
198
+ },
199
+ }))
200
+ .then(commonHttpClient.castResponse())
201
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getBlogPostFooterComments.response"))
202
+ .then(commonHttpClient.getBody);
203
+ }
204
+ /**
205
+ * Returns the root inline comments of specific blog post. The number of results
206
+ * is limited by the `limit` parameter and additional results (if available)
207
+ * will be available through the `next` URL present in the `Link` response header.
208
+ *
209
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
210
+ * Permission to view the content of the blog post and its corresponding space.
211
+ *
212
+ * @returns Returned if the requested inline comments are returned.
213
+ * @path {GET} /blogposts/{id}/inline-comments
214
+ * @scopes-current read:comment:confluence
215
+ */
216
+ getBlogPostInlineComments({ id, bodyFormat, sort, cursor, limit, }) {
217
+ return this.getClientInstance()
218
+ .request({
219
+ path: "/blogposts/{id}/inline-comments",
220
+ method: "GET",
221
+ pathParams: {
222
+ id,
223
+ },
224
+ query: {
225
+ "body-format": bodyFormat,
226
+ sort,
227
+ cursor,
228
+ limit,
229
+ },
230
+ })
231
+ .then(this.getClientInstance().responseHandler({
232
+ 200: {
233
+ "application/json": "json",
234
+ },
235
+ }))
236
+ .then(commonHttpClient.castResponse())
237
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getBlogPostInlineComments.response"))
238
+ .then(commonHttpClient.getBody);
239
+ }
240
+ /**
241
+ * Returns the comments of the specific custom content.
242
+ * The number of results is limited by the `limit` parameter and additional
243
+ * results (if available) will be available through
244
+ * the `next` URL present in the `Link` response header.
245
+ *
246
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
247
+ * Permission to view the custom content and its corresponding containers.
248
+ *
249
+ * @returns Returned if the custom content comments were successfully retrieved
250
+ * @path {GET} /custom-content/{id}/footer-comments
251
+ * @scopes-current read:comment:confluence
252
+ */
253
+ getCustomContentComments({ id, bodyFormat, cursor, limit, sort, }) {
254
+ return this.getClientInstance()
255
+ .request({
256
+ path: "/custom-content/{id}/footer-comments",
257
+ method: "GET",
258
+ pathParams: {
259
+ id,
260
+ },
261
+ query: {
262
+ "body-format": bodyFormat,
263
+ cursor,
264
+ limit,
265
+ sort,
266
+ },
267
+ })
268
+ .then(this.getClientInstance().responseHandler({
269
+ 200: {
270
+ "application/json": "json",
271
+ },
272
+ }))
273
+ .then(commonHttpClient.castResponse())
274
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getCustomContentComments.response"))
275
+ .then(commonHttpClient.getBody);
276
+ }
277
+ /**
278
+ * Retrieves a footer comment by id
279
+ *
280
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
281
+ * Permission to view the content of the container and its corresponding space.
282
+ *
283
+ * @returns Returned if the footer comment is successfully retrieved.
284
+ * @path {GET} /footer-comments/{comment-id}
285
+ * @scopes-current read:comment:confluence
286
+ */
287
+ getFooterCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }) {
288
+ return this.getClientInstance()
289
+ .request({
290
+ path: "/footer-comments/{comment-id}",
291
+ method: "GET",
292
+ pathParams: {
293
+ "comment-id": commentId,
294
+ },
295
+ query: {
296
+ "body-format": bodyFormat,
297
+ version,
298
+ "include-properties": includeProperties,
299
+ "include-operations": includeOperations,
300
+ "include-likes": includeLikes,
301
+ "include-versions": includeVersions,
302
+ "include-version": includeVersion,
303
+ },
304
+ })
305
+ .then(this.getClientInstance().responseHandler({
306
+ 200: {
307
+ "application/json": "json",
308
+ },
309
+ }))
310
+ .then(commonHttpClient.castResponse())
311
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterCommentById.response"))
312
+ .then(commonHttpClient.getBody);
313
+ }
314
+ /**
315
+ * Returns the children footer comments of specific comment. The number of results
316
+ * is limited by the `limit` parameter and additional results (if available)
317
+ * will be available through the `next` URL present in the `Link` response header.
318
+ *
319
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
320
+ * Permission to view the content of the page and its corresponding space.
321
+ *
322
+ * @returns Returned if the requested footer comments are returned.
323
+ * @path {GET} /footer-comments/{id}/children
324
+ * @scopes-current read:comment:confluence
325
+ */
326
+ getFooterCommentChildren({ id, bodyFormat, sort, cursor, limit, }) {
327
+ return this.getClientInstance()
328
+ .request({
329
+ path: "/footer-comments/{id}/children",
330
+ method: "GET",
331
+ pathParams: {
332
+ id,
333
+ },
334
+ query: {
335
+ "body-format": bodyFormat,
336
+ sort,
337
+ cursor,
338
+ limit,
339
+ },
340
+ })
341
+ .then(this.getClientInstance().responseHandler({
342
+ 200: {
343
+ "application/json": "json",
344
+ },
345
+ }))
346
+ .then(commonHttpClient.castResponse())
347
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterCommentChildren.response"))
348
+ .then(commonHttpClient.getBody);
349
+ }
350
+ /**
351
+ * Returns all footer comments. The number of results is limited by the `limit`
352
+ * parameter and additional results (if available)
353
+ * will be available through the `next` URL present in the `Link` response header.
354
+ *
355
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
356
+ * Permission to view the content of the container and its corresponding space.
357
+ *
358
+ * @returns Returned if the requested footer comments are returned.
359
+ * @path {GET} /footer-comments
360
+ * @scopes-current read:comment:confluence
361
+ */
362
+ getFooterComments({ bodyFormat, sort, cursor, limit, }) {
363
+ return this.getClientInstance()
364
+ .request({
365
+ path: "/footer-comments",
366
+ method: "GET",
367
+ query: {
368
+ "body-format": bodyFormat,
369
+ sort,
370
+ cursor,
371
+ limit,
372
+ },
373
+ })
374
+ .then(this.getClientInstance().responseHandler({
375
+ 200: {
376
+ "application/json": "json",
377
+ },
378
+ }))
379
+ .then(commonHttpClient.castResponse())
380
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getFooterComments.response"))
381
+ .then(commonHttpClient.getBody);
382
+ }
383
+ /**
384
+ * Retrieves an inline comment by id
385
+ *
386
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
387
+ * Permission to view the content of the page or blogpost and its corresponding
388
+ * space.
389
+ *
390
+ * @returns Returned if the inline comment is successfully retrieved.
391
+ * @path {GET} /inline-comments/{comment-id}
392
+ * @scopes-current read:comment:confluence
393
+ */
394
+ getInlineCommentById({ commentId, bodyFormat, version, includeProperties, includeOperations, includeLikes, includeVersions, includeVersion, }) {
395
+ return this.getClientInstance()
396
+ .request({
397
+ path: "/inline-comments/{comment-id}",
398
+ method: "GET",
399
+ pathParams: {
400
+ "comment-id": commentId,
401
+ },
402
+ query: {
403
+ "body-format": bodyFormat,
404
+ version,
405
+ "include-properties": includeProperties,
406
+ "include-operations": includeOperations,
407
+ "include-likes": includeLikes,
408
+ "include-versions": includeVersions,
409
+ "include-version": includeVersion,
410
+ },
411
+ })
412
+ .then(this.getClientInstance().responseHandler({
413
+ 200: {
414
+ "application/json": "json",
415
+ },
416
+ }))
417
+ .then(commonHttpClient.castResponse())
418
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineCommentById.response"))
419
+ .then(commonHttpClient.getBody);
420
+ }
421
+ /**
422
+ * Returns the children inline comments of specific comment. The number of results
423
+ * is limited by the `limit` parameter and additional results (if available)
424
+ * will be available through the `next` URL present in the `Link` response header.
425
+ *
426
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
427
+ * Permission to view the content of the page and its corresponding space.
428
+ *
429
+ * @returns Returned if the requested footer comments are returned.
430
+ * @path {GET} /inline-comments/{id}/children
431
+ * @scopes-current read:comment:confluence
432
+ */
433
+ getInlineCommentChildren({ id, bodyFormat, sort, cursor, limit, }) {
434
+ return this.getClientInstance()
435
+ .request({
436
+ path: "/inline-comments/{id}/children",
437
+ method: "GET",
438
+ pathParams: {
439
+ id,
440
+ },
441
+ query: {
442
+ "body-format": bodyFormat,
443
+ sort,
444
+ cursor,
445
+ limit,
446
+ },
447
+ })
448
+ .then(this.getClientInstance().responseHandler({
449
+ 200: {
450
+ "application/json": "json",
451
+ },
452
+ }))
453
+ .then(commonHttpClient.castResponse())
454
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineCommentChildren.response"))
455
+ .then(commonHttpClient.getBody);
456
+ }
457
+ /**
458
+ * Returns all inline comments. The number of results is limited by the `limit`
459
+ * parameter and additional results (if available)
460
+ * will be available through the `next` URL present in the `Link` response header.
461
+ *
462
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
463
+ * Permission to view the content of the page and its corresponding space.
464
+ *
465
+ * @returns Returned if the requested inline comments are returned.
466
+ * @path {GET} /inline-comments
467
+ * @scopes-current read:comment:confluence
468
+ */
469
+ getInlineComments({ bodyFormat, sort, cursor, limit, }) {
470
+ return this.getClientInstance()
471
+ .request({
472
+ path: "/inline-comments",
473
+ method: "GET",
474
+ query: {
475
+ "body-format": bodyFormat,
476
+ sort,
477
+ cursor,
478
+ limit,
479
+ },
480
+ })
481
+ .then(this.getClientInstance().responseHandler({
482
+ 200: {
483
+ "application/json": "json",
484
+ },
485
+ }))
486
+ .then(commonHttpClient.castResponse())
487
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getInlineComments.response"))
488
+ .then(commonHttpClient.getBody);
489
+ }
490
+ /**
491
+ * Returns the root footer comments of specific page. The number of results is
492
+ * limited by the `limit` parameter and additional results (if available)
493
+ * will be available through the `next` URL present in the `Link` response header.
494
+ *
495
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
496
+ * Permission to view the content of the page and its corresponding space.
497
+ *
498
+ * @returns Returned if the requested footer comments are returned.
499
+ * @path {GET} /pages/{id}/footer-comments
500
+ * @scopes-current read:comment:confluence
501
+ */
502
+ getPageFooterComments({ id, bodyFormat, sort, cursor, limit, }) {
503
+ return this.getClientInstance()
504
+ .request({
505
+ path: "/pages/{id}/footer-comments",
506
+ method: "GET",
507
+ pathParams: {
508
+ id,
509
+ },
510
+ query: {
511
+ "body-format": bodyFormat,
512
+ sort,
513
+ cursor,
514
+ limit,
515
+ },
516
+ })
517
+ .then(this.getClientInstance().responseHandler({
518
+ 200: {
519
+ "application/json": "json",
520
+ },
521
+ }))
522
+ .then(commonHttpClient.castResponse())
523
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getPageFooterComments.response"))
524
+ .then(commonHttpClient.getBody);
525
+ }
526
+ /**
527
+ * Returns the root inline comments of specific page. The number of results is
528
+ * limited by the `limit` parameter and additional results (if available)
529
+ * will be available through the `next` URL present in the `Link` response header.
530
+ *
531
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
532
+ * Permission to view the content of the page and its corresponding space.
533
+ *
534
+ * @returns Returned if the requested inline comments are returned.
535
+ * @path {GET} /pages/{id}/inline-comments
536
+ * @scopes-current read:comment:confluence
537
+ */
538
+ getPageInlineComments({ id, bodyFormat, sort, cursor, limit, }) {
539
+ return this.getClientInstance()
540
+ .request({
541
+ path: "/pages/{id}/inline-comments",
542
+ method: "GET",
543
+ pathParams: {
544
+ id,
545
+ },
546
+ query: {
547
+ "body-format": bodyFormat,
548
+ sort,
549
+ cursor,
550
+ limit,
551
+ },
552
+ })
553
+ .then(this.getClientInstance().responseHandler({
554
+ 200: {
555
+ "application/json": "json",
556
+ },
557
+ }))
558
+ .then(commonHttpClient.castResponse())
559
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.getPageInlineComments.response"))
560
+ .then(commonHttpClient.getBody);
561
+ }
562
+ /**
563
+ * Update a footer comment. This can be used to update the body text of a comment.
564
+ *
565
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
566
+ * Permission to view the content of the page or blogpost and its corresponding
567
+ * space. Permission to create comments in the space.
568
+ *
569
+ * @returns Returned if the footer comment is updated successfully
570
+ * @path {PUT} /footer-comments/{comment-id}
571
+ * @scopes-current write:comment:confluence
572
+ */
573
+ updateFooterComment({ commentId, requestBody, }) {
574
+ return this.getClientInstance()
575
+ .request({
576
+ path: "/footer-comments/{comment-id}",
577
+ method: "PUT",
578
+ pathParams: {
579
+ "comment-id": commentId,
580
+ },
581
+ headers: {
582
+ "Content-Type": "application/json",
583
+ },
584
+ body: requestBody,
585
+ })
586
+ .then(this.getClientInstance().responseHandler({
587
+ 200: {
588
+ "application/json": "json",
589
+ },
590
+ }))
591
+ .then(commonHttpClient.castResponse())
592
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.updateFooterComment.response"))
593
+ .then(commonHttpClient.getBody);
594
+ }
595
+ /**
596
+ * Update an inline comment. This can be used to update the body text of a comment
597
+ * and/or to resolve the comment
598
+ *
599
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
600
+ * Permission to view the content of the page or blogpost and its corresponding
601
+ * space. Permission to create comments in the space.
602
+ *
603
+ * @returns Returned if the inline comment is updated successfully.
604
+ * @path {PUT} /inline-comments/{comment-id}
605
+ * @scopes-current write:comment:confluence
606
+ */
607
+ updateInlineComment({ commentId, updateInlineCommentModel, }) {
608
+ return this.getClientInstance()
609
+ .request({
610
+ path: "/inline-comments/{comment-id}",
611
+ method: "PUT",
612
+ pathParams: {
613
+ "comment-id": commentId,
614
+ },
615
+ headers: {
616
+ "Content-Type": "application/json",
617
+ },
618
+ body: updateInlineCommentModel,
619
+ })
620
+ .then(this.getClientInstance().responseHandler({
621
+ 200: {
622
+ "application/json": "json",
623
+ },
624
+ }))
625
+ .then(commonHttpClient.castResponse())
626
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("CommentService.updateInlineComment.response"))
627
+ .then(commonHttpClient.getBody);
628
+ }
629
+ static initialize() {
630
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getAttachmentComments.response", zod_1.z
631
+ .object({
632
+ status: zod_1.z.literal(200),
633
+ mediaType: zod_1.z.literal("application/json"),
634
+ body: zod_1.z
635
+ .object({
636
+ results: zod_1.z
637
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("AttachmentCommentModel"))
638
+ .optional(),
639
+ _links: validationSchemaStorage_1.validationSchemaStorage
640
+ .lazy("MultiEntityLinks")
641
+ .optional(),
642
+ })
643
+ .catchall(zod_1.z.unknown()),
644
+ })
645
+ .describe("CommentService.getAttachmentComments.response"));
646
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getBlogPostFooterComments.response", zod_1.z
647
+ .object({
648
+ status: zod_1.z.literal(200),
649
+ mediaType: zod_1.z.literal("application/json"),
650
+ body: zod_1.z
651
+ .object({
652
+ results: zod_1.z
653
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostCommentModel"))
654
+ .optional(),
655
+ _links: validationSchemaStorage_1.validationSchemaStorage
656
+ .lazy("MultiEntityLinks")
657
+ .optional(),
658
+ })
659
+ .catchall(zod_1.z.unknown()),
660
+ })
661
+ .describe("CommentService.getBlogPostFooterComments.response"));
662
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getBlogPostInlineComments.response", zod_1.z
663
+ .object({
664
+ status: zod_1.z.literal(200),
665
+ mediaType: zod_1.z.literal("application/json"),
666
+ body: zod_1.z
667
+ .object({
668
+ results: zod_1.z
669
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("BlogPostInlineCommentModel"))
670
+ .optional(),
671
+ _links: validationSchemaStorage_1.validationSchemaStorage
672
+ .lazy("MultiEntityLinks")
673
+ .optional(),
674
+ })
675
+ .catchall(zod_1.z.unknown()),
676
+ })
677
+ .describe("CommentService.getBlogPostInlineComments.response"));
678
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getCustomContentComments.response", zod_1.z
679
+ .object({
680
+ status: zod_1.z.literal(200),
681
+ mediaType: zod_1.z.literal("application/json"),
682
+ body: zod_1.z
683
+ .object({
684
+ results: zod_1.z
685
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("CustomContentCommentModel"))
686
+ .optional(),
687
+ _links: validationSchemaStorage_1.validationSchemaStorage
688
+ .lazy("MultiEntityLinks")
689
+ .optional(),
690
+ })
691
+ .catchall(zod_1.z.unknown()),
692
+ })
693
+ .describe("CommentService.getCustomContentComments.response"));
694
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getFooterComments.response", zod_1.z
695
+ .object({
696
+ status: zod_1.z.literal(200),
697
+ mediaType: zod_1.z.literal("application/json"),
698
+ body: zod_1.z
699
+ .object({
700
+ results: zod_1.z
701
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("FooterCommentModel"))
702
+ .optional(),
703
+ _links: validationSchemaStorage_1.validationSchemaStorage
704
+ .lazy("MultiEntityLinks")
705
+ .optional(),
706
+ })
707
+ .catchall(zod_1.z.unknown()),
708
+ })
709
+ .describe("CommentService.getFooterComments.response"));
710
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.createFooterComment.response", zod_1.z
711
+ .object({
712
+ status: zod_1.z.literal(201),
713
+ mediaType: zod_1.z.literal("application/json"),
714
+ body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("FooterCommentModel"), zod_1.z
715
+ .object({
716
+ _links: zod_1.z
717
+ .object({
718
+ base: zod_1.z.string().optional(),
719
+ })
720
+ .catchall(zod_1.z.unknown())
721
+ .optional(),
722
+ })
723
+ .catchall(zod_1.z.unknown())),
724
+ })
725
+ .describe("CommentService.createFooterComment.response"));
726
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getFooterCommentById.response", zod_1.z
727
+ .object({
728
+ status: zod_1.z.literal(200),
729
+ mediaType: zod_1.z.literal("application/json"),
730
+ body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("FooterCommentModel"), zod_1.z
731
+ .object({
732
+ _links: zod_1.z
733
+ .object({
734
+ base: zod_1.z.string().optional(),
735
+ })
736
+ .catchall(zod_1.z.unknown())
737
+ .optional(),
738
+ })
739
+ .catchall(zod_1.z.unknown())),
740
+ })
741
+ .describe("CommentService.getFooterCommentById.response"));
742
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.updateFooterComment.response", zod_1.z
743
+ .object({
744
+ status: zod_1.z.literal(200),
745
+ mediaType: zod_1.z.literal("application/json"),
746
+ body: validationSchemaStorage_1.validationSchemaStorage.lazy("FooterCommentModel"),
747
+ })
748
+ .describe("CommentService.updateFooterComment.response"));
749
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getFooterCommentChildren.response", zod_1.z
750
+ .object({
751
+ status: zod_1.z.literal(200),
752
+ mediaType: zod_1.z.literal("application/json"),
753
+ body: zod_1.z
754
+ .object({
755
+ results: zod_1.z
756
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("ChildrenCommentModel"))
757
+ .optional(),
758
+ _links: validationSchemaStorage_1.validationSchemaStorage
759
+ .lazy("MultiEntityLinks")
760
+ .optional(),
761
+ })
762
+ .catchall(zod_1.z.unknown()),
763
+ })
764
+ .describe("CommentService.getFooterCommentChildren.response"));
765
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getInlineComments.response", zod_1.z
766
+ .object({
767
+ status: zod_1.z.literal(200),
768
+ mediaType: zod_1.z.literal("application/json"),
769
+ body: zod_1.z
770
+ .object({
771
+ results: zod_1.z
772
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("InlineCommentModel"))
773
+ .optional(),
774
+ _links: validationSchemaStorage_1.validationSchemaStorage
775
+ .lazy("MultiEntityLinks")
776
+ .optional(),
777
+ })
778
+ .catchall(zod_1.z.unknown()),
779
+ })
780
+ .describe("CommentService.getInlineComments.response"));
781
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.createInlineComment.response", zod_1.z
782
+ .object({
783
+ status: zod_1.z.literal(201),
784
+ mediaType: zod_1.z.literal("application/json"),
785
+ body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("InlineCommentModel"), zod_1.z
786
+ .object({
787
+ _links: zod_1.z
788
+ .object({
789
+ base: zod_1.z.string().optional(),
790
+ })
791
+ .catchall(zod_1.z.unknown())
792
+ .optional(),
793
+ })
794
+ .catchall(zod_1.z.unknown())),
795
+ })
796
+ .describe("CommentService.createInlineComment.response"));
797
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getInlineCommentById.response", zod_1.z
798
+ .object({
799
+ status: zod_1.z.literal(200),
800
+ mediaType: zod_1.z.literal("application/json"),
801
+ body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("InlineCommentModel"), zod_1.z
802
+ .object({
803
+ _links: zod_1.z
804
+ .object({
805
+ base: zod_1.z.string().optional(),
806
+ })
807
+ .catchall(zod_1.z.unknown())
808
+ .optional(),
809
+ })
810
+ .catchall(zod_1.z.unknown())),
811
+ })
812
+ .describe("CommentService.getInlineCommentById.response"));
813
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.updateInlineComment.response", zod_1.z
814
+ .object({
815
+ status: zod_1.z.literal(200),
816
+ mediaType: zod_1.z.literal("application/json"),
817
+ body: zod_1.z.intersection(validationSchemaStorage_1.validationSchemaStorage.lazy("InlineCommentModel"), zod_1.z
818
+ .object({
819
+ _links: zod_1.z
820
+ .object({
821
+ base: zod_1.z.string().optional(),
822
+ })
823
+ .catchall(zod_1.z.unknown())
824
+ .optional(),
825
+ })
826
+ .catchall(zod_1.z.unknown())),
827
+ })
828
+ .describe("CommentService.updateInlineComment.response"));
829
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getInlineCommentChildren.response", zod_1.z
830
+ .object({
831
+ status: zod_1.z.literal(200),
832
+ mediaType: zod_1.z.literal("application/json"),
833
+ body: zod_1.z
834
+ .object({
835
+ results: zod_1.z
836
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("InlineCommentChildrenModel"))
837
+ .optional(),
838
+ _links: validationSchemaStorage_1.validationSchemaStorage
839
+ .lazy("MultiEntityLinks")
840
+ .optional(),
841
+ })
842
+ .catchall(zod_1.z.unknown()),
843
+ })
844
+ .describe("CommentService.getInlineCommentChildren.response"));
845
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getPageFooterComments.response", zod_1.z
846
+ .object({
847
+ status: zod_1.z.literal(200),
848
+ mediaType: zod_1.z.literal("application/json"),
849
+ body: zod_1.z
850
+ .object({
851
+ results: zod_1.z
852
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("PageCommentModel"))
853
+ .optional(),
854
+ _links: validationSchemaStorage_1.validationSchemaStorage
855
+ .lazy("MultiEntityLinks")
856
+ .optional(),
857
+ })
858
+ .catchall(zod_1.z.unknown()),
859
+ })
860
+ .describe("CommentService.getPageFooterComments.response"));
861
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("CommentService.getPageInlineComments.response", zod_1.z
862
+ .object({
863
+ status: zod_1.z.literal(200),
864
+ mediaType: zod_1.z.literal("application/json"),
865
+ body: zod_1.z
866
+ .object({
867
+ results: zod_1.z
868
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("PageInlineCommentModel"))
869
+ .optional(),
870
+ _links: validationSchemaStorage_1.validationSchemaStorage
871
+ .lazy("MultiEntityLinks")
872
+ .optional(),
873
+ })
874
+ .catchall(zod_1.z.unknown()),
875
+ })
876
+ .describe("CommentService.getPageInlineComments.response"));
877
+ validationSchemaStorage_1.validationSchemaStorage.registerOnce([
878
+ comment_1.registerCommentValidationSchemas,
879
+ common_1.registerCommonValidationSchemas,
880
+ ]);
881
+ }
882
+ }
883
+ exports.CommentService = CommentService;
884
+ //# sourceMappingURL=CommentService.js.map