@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":"version.js","sourceRoot":"","sources":["../../../../src/openapi/v2/models/version.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAA0E;AAwI1E,SAAgB,gCAAgC,CAC9C,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,mBAAmB,EACnB,OAAC;SACE,MAAM,CAAC;QACN,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACnC,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACjC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,UAAU,EAAE,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;KACvE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,mBAAmB,CAAC,CACjC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,iBAAiB,EACjB,OAAC;SACE,MAAM,CAAC;QACN,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACnC,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACjC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,QAAQ,EAAE,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;KACrE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,iBAAiB,CAAC,CAC/B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,gBAAgB,EAChB,OAAC;SACE,MAAM,CAAC;QACN,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACnC,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACjC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;KACpE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,gBAAgB,CAAC,CAC9B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,sBAAsB,EACtB,OAAC;SACE,MAAM,CAAC;QACN,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACnC,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACjC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;KACnE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,sBAAsB,CAAC,CACpC,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,iBAAiB,EACjB,OAAC;SACE,MAAM,CAAC;QACN,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACnC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACjC,mBAAmB,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QAC3C,aAAa,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE;QAC7C,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACxC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;KACzC,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,iBAAiB,CAAC,CAC/B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,aAAa,EACb,OAAC;SACE,MAAM,CAAC;QACN,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;QACnC,SAAS,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;QACjC,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;KACjE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,aAAa,CAAC,CAC3B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,iBAAiB,EACjB,OAAC;SACE,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzB,IAAI,EAAE,uBAAuB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,QAAQ,EAAE;KAC1D,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,iBAAiB,CAAC,CAC/B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,kBAAkB,EAClB,OAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,CAAC,CACzE,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AA1GD,4EA0GC"}
@@ -0,0 +1,37 @@
1
+ import { type ZodTypeAny } from "zod";
2
+ import type { CommonValidationSchemaStorage } from "../core/CommonValidationSchemaStorage";
3
+ import { type ContentStatus, type ParentContentType, type Version } from "./common";
4
+ export interface WhiteboardLinks extends Record<string, unknown> {
5
+ /** Web UI link of the content. */
6
+ webui?: string;
7
+ /** Edit UI link of the content. */
8
+ editui?: string;
9
+ }
10
+ export interface WhiteboardSingle extends Record<string, unknown> {
11
+ /** ID of the whiteboard. */
12
+ id?: string;
13
+ /** The content type of the object. */
14
+ type?: string;
15
+ /** The status of the content. */
16
+ status?: ContentStatus;
17
+ /** Title of the whiteboard. */
18
+ title?: string;
19
+ /** ID of the parent content, or null if there is no parent content. */
20
+ parentId?: string;
21
+ /** Content type of the parent, or null if there is no parent. */
22
+ parentType?: ParentContentType;
23
+ /** Position of the whiteboard within the given parent page tree. */
24
+ position?: number | null;
25
+ /** The account ID of the user who created this whiteboard originally. */
26
+ authorId?: string;
27
+ /** The account ID of the user who owns this whiteboard. */
28
+ ownerId?: string;
29
+ /**
30
+ * Date and time when the whiteboard was created. In format
31
+ * "YYYY-MM-DDTHH:mm:ss.sssZ".
32
+ */
33
+ createdAt?: string;
34
+ version?: Version;
35
+ _links?: WhiteboardLinks;
36
+ }
37
+ export declare function registerWhiteboardValidationSchemas(validationSchemaStorage: CommonValidationSchemaStorage<ZodTypeAny>): void;
@@ -0,0 +1,39 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.registerWhiteboardValidationSchemas = 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 common_1 = require("./common");
9
+ function registerWhiteboardValidationSchemas(validationSchemaStorage) {
10
+ validationSchemaStorage.register("WhiteboardLinks", zod_1.z
11
+ .object({
12
+ webui: zod_1.z.string().optional(),
13
+ editui: zod_1.z.string().optional(),
14
+ })
15
+ .catchall(zod_1.z.unknown())
16
+ .describe("WhiteboardLinks"));
17
+ validationSchemaStorage.register("WhiteboardSingle", zod_1.z
18
+ .object({
19
+ id: zod_1.z.string().optional(),
20
+ type: zod_1.z.string().optional(),
21
+ status: validationSchemaStorage.lazy("ContentStatus").optional(),
22
+ title: zod_1.z.string().optional(),
23
+ parentId: zod_1.z.string().optional(),
24
+ parentType: validationSchemaStorage
25
+ .lazy("ParentContentType")
26
+ .optional(),
27
+ position: zod_1.z.nullable(zod_1.z.number().int()).optional(),
28
+ authorId: zod_1.z.string().optional(),
29
+ ownerId: zod_1.z.string().optional(),
30
+ createdAt: zod_1.z.string().optional(),
31
+ version: validationSchemaStorage.lazy("Version").optional(),
32
+ _links: validationSchemaStorage.lazy("WhiteboardLinks").optional(),
33
+ })
34
+ .catchall(zod_1.z.unknown())
35
+ .describe("WhiteboardSingle"));
36
+ validationSchemaStorage.registerOnce([common_1.registerCommonValidationSchemas]);
37
+ }
38
+ exports.registerWhiteboardValidationSchemas = registerWhiteboardValidationSchemas;
39
+ //# sourceMappingURL=whiteboard.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"whiteboard.js","sourceRoot":"","sources":["../../../../src/openapi/v2/models/whiteboard.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAyC;AAGzC,qCAKkB;AAkClB,SAAgB,mCAAmC,CACjD,uBAAkE;IAElE,uBAAuB,CAAC,QAAQ,CAC9B,iBAAiB,EACjB,OAAC;SACE,MAAM,CAAC;QACN,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,MAAM,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,iBAAiB,CAAC,CAC/B,CAAC;IACF,uBAAuB,CAAC,QAAQ,CAC9B,kBAAkB,EAClB,OAAC;SACE,MAAM,CAAC;QACN,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACzB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC3B,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;QAChE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC5B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,UAAU,EAAE,uBAAuB;aAChC,IAAI,CAAC,mBAAmB,CAAC;aACzB,QAAQ,EAAE;QACb,QAAQ,EAAE,OAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE;QACjD,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC/B,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAC9B,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QAChC,OAAO,EAAE,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE;QAC3D,MAAM,EAAE,uBAAuB,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,QAAQ,EAAE;KACnE,CAAC;SACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACrB,QAAQ,CAAC,kBAAkB,CAAC,CAChC,CAAC;IACF,uBAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;AAC1E,CAAC;AApCD,kFAoCC"}
@@ -0,0 +1,143 @@
1
+ import { CommonHttpService } from "../core/CommonHttpService";
2
+ import { type Ancestor } from "../models/ancestors";
3
+ import { type MultiEntityLinks } from "../models/common";
4
+ export declare class AncestorsService extends CommonHttpService {
5
+ /**
6
+ * Returns all ancestors for a given database by ID in top-to-bottom order (that
7
+ * is, the highest ancestor is the first
8
+ * item in the response payload). The number of results is limited by the `limit`
9
+ * parameter and additional results (if available)
10
+ * will be available by calling this endpoint with the ID of first ancestor in the
11
+ * response payload.
12
+ *
13
+ * This endpoint returns minimal information about each ancestor. To fetch more
14
+ * details, use a related endpoint, such
15
+ * as [Get database by
16
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get).
17
+ *
18
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
19
+ * Permission to access the Confluence site ('Can use' global permission).
20
+ * Permission to view the database and its corresponding space
21
+ *
22
+ * @returns Returned if the requested ancestors are returned.
23
+ * @path {GET} /databases/{id}/ancestors
24
+ * @scopes-current read:content.metadata:confluence
25
+ */
26
+ getDatabaseAncestors({ id, limit, }: {
27
+ /** The ID of the database. */
28
+ id: number;
29
+ /**
30
+ * Maximum number of items per result to return. If more results exist, call the
31
+ * endpoint with the highest ancestor's ID to fetch the next set of results.
32
+ */
33
+ limit?: number;
34
+ }): Promise<{
35
+ results?: Ancestor[];
36
+ } & {
37
+ [key: string]: unknown;
38
+ }>;
39
+ /**
40
+ * Returns all ancestors for a given page by ID in top-to-bottom order (that is,
41
+ * the highest ancestor is the first
42
+ * item in the response payload). The number of results is limited by the `limit`
43
+ * parameter and additional results (if available)
44
+ * will be available by calling this endpoint with the ID of first ancestor in the
45
+ * response payload.
46
+ *
47
+ * This endpoint returns minimal information about each ancestor. To fetch more
48
+ * details, use a related endpoint, such
49
+ * as [Get page by
50
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get).
51
+ *
52
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
53
+ * Permission to access the Confluence site ('Can use' global permission).
54
+ *
55
+ * @returns Returned if the requested ancestors are returned.
56
+ * @path {GET} /pages/{id}/ancestors
57
+ * @scopes-current read:content.metadata:confluence
58
+ */
59
+ getPageAncestors({ id, limit, }: {
60
+ /** The ID of the page. */
61
+ id: number;
62
+ /**
63
+ * Maximum number of pages per result to return. If more results exist, call this
64
+ * endpoint with the highest ancestor's ID to fetch the next set of results.
65
+ */
66
+ limit?: number;
67
+ }): Promise<{
68
+ results?: Ancestor[];
69
+ _links?: MultiEntityLinks;
70
+ } & {
71
+ [key: string]: unknown;
72
+ }>;
73
+ /**
74
+ * Returns all ancestors for a given Smart Link in the content tree by ID in
75
+ * top-to-bottom order (that is, the highest ancestor is
76
+ * the first item in the response payload). The number of results is limited by
77
+ * the `limit` parameter and additional results
78
+ * (if available) will be available by calling this endpoint with the ID of first
79
+ * ancestor in the response payload.
80
+ *
81
+ * This endpoint returns minimal information about each ancestor. To fetch more
82
+ * details, use a related endpoint, such
83
+ * as [Get Smart Link in the content tree by
84
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get).
85
+ *
86
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
87
+ * Permission to access the Confluence site ('Can use' global permission).
88
+ * Permission to view the Smart Link in the content tree and its corresponding
89
+ * space
90
+ *
91
+ * @returns Returned if the requested ancestors are returned.
92
+ * @path {GET} /embeds/{id}/ancestors
93
+ * @scopes-current read:content.metadata:confluence
94
+ */
95
+ getSmartLinkAncestors({ id, limit, }: {
96
+ /** The ID of the Smart Link in the content tree. */
97
+ id: number;
98
+ /**
99
+ * Maximum number of items per result to return. If more results exist, call the
100
+ * endpoint with the highest ancestor's ID to fetch the next set of results.
101
+ */
102
+ limit?: number;
103
+ }): Promise<{
104
+ results?: Ancestor[];
105
+ } & {
106
+ [key: string]: unknown;
107
+ }>;
108
+ /**
109
+ * Returns all ancestors for a given whiteboard by ID in top-to-bottom order (that
110
+ * is, the highest ancestor is the first
111
+ * item in the response payload). The number of results is limited by the `limit`
112
+ * parameter and additional results (if available)
113
+ * will be available by calling this endpoint with the ID of first ancestor in the
114
+ * response payload.
115
+ *
116
+ * This endpoint returns minimal information about each ancestor. To fetch more
117
+ * details, use a related endpoint, such
118
+ * as [Get whiteboard by
119
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
120
+ *
121
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
122
+ * Permission to access the Confluence site ('Can use' global permission).
123
+ * Permission to view the whiteboard and its corresponding space
124
+ *
125
+ * @returns Returned if the requested ancestors are returned.
126
+ * @path {GET} /whiteboards/{id}/ancestors
127
+ * @scopes-current read:content.metadata:confluence
128
+ */
129
+ getWhiteboardAncestors({ id, limit, }: {
130
+ /** The ID of the whiteboard. */
131
+ id: number;
132
+ /**
133
+ * Maximum number of items per result to return. If more results exist, call the
134
+ * endpoint with the highest ancestor's ID to fetch the next set of results.
135
+ */
136
+ limit?: number;
137
+ }): Promise<{
138
+ results?: Ancestor[];
139
+ } & {
140
+ [key: string]: unknown;
141
+ }>;
142
+ static initialize(): void;
143
+ }
@@ -0,0 +1,245 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AncestorsService = 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 ancestors_1 = require("../models/ancestors");
11
+ const common_1 = require("../models/common");
12
+ const validationSchemaStorage_1 = require("../validationSchemaStorage");
13
+ class AncestorsService extends CommonHttpService_1.CommonHttpService {
14
+ /**
15
+ * Returns all ancestors for a given database by ID in top-to-bottom order (that
16
+ * is, the highest ancestor is the first
17
+ * item in the response payload). The number of results is limited by the `limit`
18
+ * parameter and additional results (if available)
19
+ * will be available by calling this endpoint with the ID of first ancestor in the
20
+ * response payload.
21
+ *
22
+ * This endpoint returns minimal information about each ancestor. To fetch more
23
+ * details, use a related endpoint, such
24
+ * as [Get database by
25
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-database/#api-databases-id-get).
26
+ *
27
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
28
+ * Permission to access the Confluence site ('Can use' global permission).
29
+ * Permission to view the database and its corresponding space
30
+ *
31
+ * @returns Returned if the requested ancestors are returned.
32
+ * @path {GET} /databases/{id}/ancestors
33
+ * @scopes-current read:content.metadata:confluence
34
+ */
35
+ getDatabaseAncestors({ id, limit, }) {
36
+ return this.getClientInstance()
37
+ .request({
38
+ path: "/databases/{id}/ancestors",
39
+ method: "GET",
40
+ pathParams: {
41
+ id,
42
+ },
43
+ query: {
44
+ limit,
45
+ },
46
+ })
47
+ .then(this.getClientInstance().responseHandler({
48
+ 200: {
49
+ "application/json": "json",
50
+ },
51
+ }))
52
+ .then(commonHttpClient.castResponse())
53
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getDatabaseAncestors.response"))
54
+ .then(commonHttpClient.getBody);
55
+ }
56
+ /**
57
+ * Returns all ancestors for a given page by ID in top-to-bottom order (that is,
58
+ * the highest ancestor is the first
59
+ * item in the response payload). The number of results is limited by the `limit`
60
+ * parameter and additional results (if available)
61
+ * will be available by calling this endpoint with the ID of first ancestor in the
62
+ * response payload.
63
+ *
64
+ * This endpoint returns minimal information about each ancestor. To fetch more
65
+ * details, use a related endpoint, such
66
+ * as [Get page by
67
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-page/#api-pages-id-get).
68
+ *
69
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
70
+ * Permission to access the Confluence site ('Can use' global permission).
71
+ *
72
+ * @returns Returned if the requested ancestors are returned.
73
+ * @path {GET} /pages/{id}/ancestors
74
+ * @scopes-current read:content.metadata:confluence
75
+ */
76
+ getPageAncestors({ id, limit, }) {
77
+ return this.getClientInstance()
78
+ .request({
79
+ path: "/pages/{id}/ancestors",
80
+ method: "GET",
81
+ pathParams: {
82
+ id,
83
+ },
84
+ query: {
85
+ limit,
86
+ },
87
+ })
88
+ .then(this.getClientInstance().responseHandler({
89
+ 200: {
90
+ "application/json": "json",
91
+ },
92
+ }))
93
+ .then(commonHttpClient.castResponse())
94
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getPageAncestors.response"))
95
+ .then(commonHttpClient.getBody);
96
+ }
97
+ /**
98
+ * Returns all ancestors for a given Smart Link in the content tree by ID in
99
+ * top-to-bottom order (that is, the highest ancestor is
100
+ * the first item in the response payload). The number of results is limited by
101
+ * the `limit` parameter and additional results
102
+ * (if available) will be available by calling this endpoint with the ID of first
103
+ * ancestor in the response payload.
104
+ *
105
+ * This endpoint returns minimal information about each ancestor. To fetch more
106
+ * details, use a related endpoint, such
107
+ * as [Get Smart Link in the content tree by
108
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-smart-link/#api-embeds-id-get).
109
+ *
110
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
111
+ * Permission to access the Confluence site ('Can use' global permission).
112
+ * Permission to view the Smart Link in the content tree and its corresponding
113
+ * space
114
+ *
115
+ * @returns Returned if the requested ancestors are returned.
116
+ * @path {GET} /embeds/{id}/ancestors
117
+ * @scopes-current read:content.metadata:confluence
118
+ */
119
+ getSmartLinkAncestors({ id, limit, }) {
120
+ return this.getClientInstance()
121
+ .request({
122
+ path: "/embeds/{id}/ancestors",
123
+ method: "GET",
124
+ pathParams: {
125
+ id,
126
+ },
127
+ query: {
128
+ limit,
129
+ },
130
+ })
131
+ .then(this.getClientInstance().responseHandler({
132
+ 200: {
133
+ "application/json": "json",
134
+ },
135
+ }))
136
+ .then(commonHttpClient.castResponse())
137
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getSmartLinkAncestors.response"))
138
+ .then(commonHttpClient.getBody);
139
+ }
140
+ /**
141
+ * Returns all ancestors for a given whiteboard by ID in top-to-bottom order (that
142
+ * is, the highest ancestor is the first
143
+ * item in the response payload). The number of results is limited by the `limit`
144
+ * parameter and additional results (if available)
145
+ * will be available by calling this endpoint with the ID of first ancestor in the
146
+ * response payload.
147
+ *
148
+ * This endpoint returns minimal information about each ancestor. To fetch more
149
+ * details, use a related endpoint, such
150
+ * as [Get whiteboard by
151
+ * id](https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-whiteboard/#api-whiteboards-id-get).
152
+ *
153
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
154
+ * Permission to access the Confluence site ('Can use' global permission).
155
+ * Permission to view the whiteboard and its corresponding space
156
+ *
157
+ * @returns Returned if the requested ancestors are returned.
158
+ * @path {GET} /whiteboards/{id}/ancestors
159
+ * @scopes-current read:content.metadata:confluence
160
+ */
161
+ getWhiteboardAncestors({ id, limit, }) {
162
+ return this.getClientInstance()
163
+ .request({
164
+ path: "/whiteboards/{id}/ancestors",
165
+ method: "GET",
166
+ pathParams: {
167
+ id,
168
+ },
169
+ query: {
170
+ limit,
171
+ },
172
+ })
173
+ .then(this.getClientInstance().responseHandler({
174
+ 200: {
175
+ "application/json": "json",
176
+ },
177
+ }))
178
+ .then(commonHttpClient.castResponse())
179
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("AncestorsService.getWhiteboardAncestors.response"))
180
+ .then(commonHttpClient.getBody);
181
+ }
182
+ static initialize() {
183
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AncestorsService.getDatabaseAncestors.response", zod_1.z
184
+ .object({
185
+ status: zod_1.z.literal(200),
186
+ mediaType: zod_1.z.literal("application/json"),
187
+ body: zod_1.z
188
+ .object({
189
+ results: zod_1.z
190
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("Ancestor"))
191
+ .optional(),
192
+ })
193
+ .catchall(zod_1.z.unknown()),
194
+ })
195
+ .describe("AncestorsService.getDatabaseAncestors.response"));
196
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AncestorsService.getSmartLinkAncestors.response", zod_1.z
197
+ .object({
198
+ status: zod_1.z.literal(200),
199
+ mediaType: zod_1.z.literal("application/json"),
200
+ body: zod_1.z
201
+ .object({
202
+ results: zod_1.z
203
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("Ancestor"))
204
+ .optional(),
205
+ })
206
+ .catchall(zod_1.z.unknown()),
207
+ })
208
+ .describe("AncestorsService.getSmartLinkAncestors.response"));
209
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AncestorsService.getPageAncestors.response", zod_1.z
210
+ .object({
211
+ status: zod_1.z.literal(200),
212
+ mediaType: zod_1.z.literal("application/json"),
213
+ body: zod_1.z
214
+ .object({
215
+ results: zod_1.z
216
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("Ancestor"))
217
+ .optional(),
218
+ _links: validationSchemaStorage_1.validationSchemaStorage
219
+ .lazy("MultiEntityLinks")
220
+ .optional(),
221
+ })
222
+ .catchall(zod_1.z.unknown()),
223
+ })
224
+ .describe("AncestorsService.getPageAncestors.response"));
225
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("AncestorsService.getWhiteboardAncestors.response", zod_1.z
226
+ .object({
227
+ status: zod_1.z.literal(200),
228
+ mediaType: zod_1.z.literal("application/json"),
229
+ body: zod_1.z
230
+ .object({
231
+ results: zod_1.z
232
+ .array(validationSchemaStorage_1.validationSchemaStorage.lazy("Ancestor"))
233
+ .optional(),
234
+ })
235
+ .catchall(zod_1.z.unknown()),
236
+ })
237
+ .describe("AncestorsService.getWhiteboardAncestors.response"));
238
+ validationSchemaStorage_1.validationSchemaStorage.registerOnce([
239
+ ancestors_1.registerAncestorsValidationSchemas,
240
+ common_1.registerCommonValidationSchemas,
241
+ ]);
242
+ }
243
+ }
244
+ exports.AncestorsService = AncestorsService;
245
+ //# sourceMappingURL=AncestorsService.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"AncestorsService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/AncestorsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,mDAG6B;AAC7B,6CAG0B;AAC1B,wEAAqE;AACrE,MAAa,gBAAiB,SAAQ,qCAAiB;IACrD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,oBAAoB,CAAC,EACnB,EAAE,EACF,KAAK,GASN;QAOC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,2BAA2B;YACjC,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,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,EAQzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,gDAAgD,CACjD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,gBAAgB,CAAC,EACf,EAAE,EACF,KAAK,GASN;QAQC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,uBAAuB;YAC7B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,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,4CAA4C,CAC7C,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,qBAAqB,CAAC,EACpB,EAAE,EACF,KAAK,GASN;QAOC,OAAO,IAAI,CAAC,iBAAiB,EAAE;aAC5B,OAAO,CAAC;YACP,IAAI,EAAE,wBAAwB;YAC9B,MAAM,EAAE,KAAK;YACb,UAAU,EAAE;gBACV,EAAE;aACH;YACD,KAAK,EAAE;gBACL,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,EAQzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,iDAAiD,CAClD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,sBAAsB,CAAC,EACrB,EAAE,EACF,KAAK,GASN;QAOC,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,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,EAQzB,CACL;aACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,kDAAkD,CACnD,CACF;aACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACpC,CAAC;IACD,MAAM,CAAC,UAAU;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,UAAU,CAAC,CAAC;qBAC/C,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,iDAAiD,EACjD,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,UAAU,CAAC,CAAC;qBAC/C,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,iDAAiD,CAAC,CAC/D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,4CAA4C,EAC5C,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,UAAU,CAAC,CAAC;qBAC/C,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,4CAA4C,CAAC,CAC1D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,kDAAkD,EAClD,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,UAAU,CAAC,CAAC;qBAC/C,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,kDAAkD,CAAC,CAChE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,8CAAkC;YAClC,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AAxXD,4CAwXC"}