@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,404 @@
1
+ import { CommonHttpService } from "../core/CommonHttpService";
2
+ import { type Relation, type RelationArray } from "../models/relation";
3
+ export declare class RelationService extends CommonHttpService {
4
+ /**
5
+ * Creates a relationship between two entities (user, space, content). The
6
+ * 'favourite' relationship is supported by default, but you can use this method
7
+ * to create any type of relationship between two entities.
8
+ *
9
+ * For example, the following method creates a 'sibling' relationship between
10
+ * two pieces of content:
11
+ * `PUT /wiki/rest/api/relation/sibling/from/content/123/to/content/456`
12
+ *
13
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
14
+ * Permission to access the Confluence site ('Can use' global permission).
15
+ *
16
+ * @returns Returned if the relationship is created.
17
+ * @path {PUT}
18
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
19
+ * @scopes-current write:confluence-content
20
+ * @scopes-beta read:relation:confluence, read:space:confluence, read:user:confluence,
21
+ * read:content:confluence, write:relation:confluence
22
+ */
23
+ createRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }: {
24
+ /**
25
+ * The name of the relationship. This method supports the 'favourite'
26
+ * (i.e. 'save for later') relationship. You can also specify any other
27
+ * value for this parameter to create a custom relationship type.
28
+ */
29
+ relationName: string;
30
+ /**
31
+ * The source entity type of the relationship. This must be 'user', if
32
+ * the `relationName` is 'favourite'.
33
+ */
34
+ sourceType: "user" | "content" | "space";
35
+ /**
36
+ * - The identifier for the source entity:
37
+ *
38
+ * - If `sourceType` is 'user', then specify either 'current' (logged-in
39
+ * user) or the user key.
40
+ * - If `sourceType` is 'content', then specify the content ID.
41
+ * - If `sourceType` is 'space', then specify the space key.
42
+ */
43
+ sourceKey: string;
44
+ /**
45
+ * The target entity type of the relationship. This must be 'space' or
46
+ * 'content', if the `relationName` is 'favourite'.
47
+ */
48
+ targetType: "user" | "content" | "space";
49
+ /**
50
+ * - The identifier for the target entity:
51
+ *
52
+ * - If `sourceType` is 'user', then specify either 'current' (logged-in
53
+ * user) or the user key.
54
+ * - If `sourceType` is 'content', then specify the content ID.
55
+ * - If `sourceType` is 'space', then specify the space key.
56
+ */
57
+ targetKey: string;
58
+ /**
59
+ * The status of the source. This parameter is only used when the
60
+ * `sourceType` is 'content'.
61
+ */
62
+ sourceStatus?: string;
63
+ /**
64
+ * The status of the target. This parameter is only used when the
65
+ * `targetType` is 'content'.
66
+ */
67
+ targetStatus?: string;
68
+ /**
69
+ * The version of the source. This parameter is only used when the
70
+ * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
71
+ */
72
+ sourceVersion?: number;
73
+ /**
74
+ * The version of the target. This parameter is only used when the
75
+ * `targetType` is 'content' and the `targetStatus` is 'historical'.
76
+ */
77
+ targetVersion?: number;
78
+ }): Promise<Relation>;
79
+ /**
80
+ * Deletes a relationship between two entities (user, space, content).
81
+ *
82
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
83
+ * Permission to access the Confluence site ('Can use' global permission).
84
+ * For favourite relationships, the current user can only delete their own
85
+ * favourite relationships. A space administrator can delete favourite
86
+ * relationships for any user.
87
+ *
88
+ * @path {DELETE}
89
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
90
+ * @scopes-current write:confluence-content
91
+ * @scopes-beta write:relation:confluence
92
+ */
93
+ deleteRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }: {
94
+ /** The name of the relationship. */
95
+ relationName: string;
96
+ /**
97
+ * The source entity type of the relationship. This must be 'user', if
98
+ * the `relationName` is 'favourite'.
99
+ */
100
+ sourceType: "user" | "content" | "space";
101
+ /**
102
+ * - The identifier for the source entity:
103
+ *
104
+ * - If `sourceType` is 'user', then specify either 'current' (logged-in
105
+ * user) or the user key.
106
+ * - If `sourceType` is 'content', then specify the content ID.
107
+ * - If `sourceType` is 'space', then specify the space key.
108
+ */
109
+ sourceKey: string;
110
+ /**
111
+ * The target entity type of the relationship. This must be 'space' or
112
+ * 'content', if the `relationName` is 'favourite'.
113
+ */
114
+ targetType: "user" | "content" | "space";
115
+ /**
116
+ * - The identifier for the target entity:
117
+ *
118
+ * - If `sourceType` is 'user', then specify either 'current' (logged-in
119
+ * user) or the user key.
120
+ * - If `sourceType` is 'content', then specify the content ID.
121
+ * - If `sourceType` is 'space', then specify the space key.
122
+ */
123
+ targetKey: string;
124
+ /**
125
+ * The status of the source. This parameter is only used when the
126
+ * `sourceType` is 'content'.
127
+ */
128
+ sourceStatus?: string;
129
+ /**
130
+ * The status of the target. This parameter is only used when the
131
+ * `targetType` is 'content'.
132
+ */
133
+ targetStatus?: string;
134
+ /**
135
+ * The version of the source. This parameter is only used when the
136
+ * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
137
+ */
138
+ sourceVersion?: number;
139
+ /**
140
+ * The version of the target. This parameter is only used when the
141
+ * `targetType` is 'content' and the `targetStatus` is 'historical'.
142
+ */
143
+ targetVersion?: number;
144
+ }): Promise<void>;
145
+ /**
146
+ * Returns all target entities that have a particular relationship to the
147
+ * source entity. Note, relationships are one way.
148
+ *
149
+ * For example, the following method finds all users that have a 'collaborator'
150
+ * relationship to a piece of content with an ID of '1234':
151
+ * `GET /wiki/rest/api/relation/collaborator/to/content/1234/from/user`
152
+ * Note, 'collaborator' is an example custom relationship type.
153
+ *
154
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
155
+ * Permission to view both the target entity and source entity.
156
+ *
157
+ * @returns Returned if the requested relationships are returned.
158
+ * @path {GET}
159
+ * /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}
160
+ * @scopes-current read:confluence-content.summary
161
+ * @scopes-beta read:relation:confluence, read:content-details:confluence
162
+ */
163
+ findSourcesForTarget({ relationName, sourceType, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }: {
164
+ /**
165
+ * The name of the relationship. This method supports relationships created via
166
+ * [Create
167
+ * relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).
168
+ * Note, this method does not support 'like' or 'favourite' relationships.
169
+ */
170
+ relationName: string;
171
+ /** The source entity type of the relationship. */
172
+ sourceType: "user" | "content" | "space";
173
+ /** The target entity type of the relationship. */
174
+ targetType: "user" | "content" | "space";
175
+ /**
176
+ * The identifier for the target entity:
177
+ *
178
+ * - If `targetType` is `user`, then specify either `current` (logged-in user),
179
+ * the user key of the user, or
180
+ * the account ID of the user. Note that the user key has been deprecated in favor
181
+ * of the account ID for this parameter. See the
182
+ * [migration
183
+ * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
184
+ * for details.
185
+ * - If `targetType` is 'content', then specify the content ID.
186
+ * - If `targetType` is 'space', then specify the space key.
187
+ */
188
+ targetKey: string;
189
+ /**
190
+ * The status of the source. This parameter is only used when the
191
+ * `sourceType` is 'content'.
192
+ */
193
+ sourceStatus?: string;
194
+ /**
195
+ * The status of the target. This parameter is only used when the
196
+ * `targetType` is 'content'.
197
+ */
198
+ targetStatus?: string;
199
+ /**
200
+ * The version of the source. This parameter is only used when the
201
+ * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
202
+ */
203
+ sourceVersion?: number;
204
+ /**
205
+ * The version of the target. This parameter is only used when the
206
+ * `targetType` is 'content' and the `targetStatus` is 'historical'.
207
+ */
208
+ targetVersion?: number;
209
+ /**
210
+ * A multi-value parameter indicating which properties of the response
211
+ * object to expand.
212
+ *
213
+ * - `relationData` returns information about the relationship, such as
214
+ * who created it and when it was created.
215
+ * - `source` returns the source entity.
216
+ * - `target` returns the target entity.
217
+ */
218
+ expand?: ("relationData" | "source" | "target")[];
219
+ /** The starting index of the returned relationships. */
220
+ start?: number;
221
+ /**
222
+ * The maximum number of relationships to return per page.
223
+ * Note, this may be restricted by fixed system limits.
224
+ */
225
+ limit?: number;
226
+ }): Promise<RelationArray>;
227
+ /**
228
+ * Returns all target entities that have a particular relationship to the
229
+ * source entity. Note, relationships are one way.
230
+ *
231
+ * For example, the following method finds all content that the current user
232
+ * has an 'ignore' relationship with:
233
+ * `GET /wiki/rest/api/relation/ignore/from/user/current/to/content`
234
+ * Note, 'ignore' is an example custom relationship type.
235
+ *
236
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
237
+ * Permission to view both the target entity and source entity.
238
+ *
239
+ * @returns Returned if the requested relationships are returned.
240
+ * @path {GET}
241
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}
242
+ * @scopes-current read:confluence-content.summary
243
+ * @scopes-beta read:relation:confluence, read:content-details:confluence
244
+ */
245
+ findTargetFromSource({ relationName, sourceType, sourceKey, targetType, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }: {
246
+ /**
247
+ * The name of the relationship. This method supports relationships created via
248
+ * [Create
249
+ * relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).
250
+ * Note, this method does not support 'like' or 'favourite' relationships.
251
+ */
252
+ relationName: string;
253
+ /** The source entity type of the relationship. */
254
+ sourceType: "user" | "content" | "space";
255
+ /**
256
+ * The identifier for the source entity:
257
+ *
258
+ * - If `sourceType` is `user`, then specify either `current` (logged-in user),
259
+ * the user key of the user, or
260
+ * the account ID of the user. Note that the user key has been deprecated in favor
261
+ * of the account ID for this parameter. See the
262
+ * [migration
263
+ * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
264
+ * for details.
265
+ * - If `sourceType` is 'content', then specify the content ID.
266
+ * - If `sourceType` is 'space', then specify the space key.
267
+ */
268
+ sourceKey: string;
269
+ /** The target entity type of the relationship. */
270
+ targetType: "user" | "content" | "space";
271
+ /**
272
+ * The status of the source. This parameter is only used when the
273
+ * `sourceType` is 'content'.
274
+ */
275
+ sourceStatus?: string;
276
+ /**
277
+ * The status of the target. This parameter is only used when the
278
+ * `targetType` is 'content'.
279
+ */
280
+ targetStatus?: string;
281
+ /**
282
+ * The version of the source. This parameter is only used when the
283
+ * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
284
+ */
285
+ sourceVersion?: number;
286
+ /**
287
+ * The version of the target. This parameter is only used when the
288
+ * `targetType` is 'content' and the `targetStatus` is 'historical'.
289
+ */
290
+ targetVersion?: number;
291
+ /**
292
+ * A multi-value parameter indicating which properties of the response
293
+ * object to expand.
294
+ *
295
+ * - `relationData` returns information about the relationship, such as
296
+ * who created it and when it was created.
297
+ * - `source` returns the source entity.
298
+ * - `target` returns the target entity.
299
+ */
300
+ expand?: ("relationData" | "source" | "target")[];
301
+ /** The starting index of the returned relationships. */
302
+ start?: number;
303
+ /**
304
+ * The maximum number of relationships to return per page.
305
+ * Note, this may be restricted by fixed system limits.
306
+ */
307
+ limit?: number;
308
+ }): Promise<RelationArray>;
309
+ /**
310
+ * Find whether a particular type of relationship exists from a source
311
+ * entity to a target entity. Note, relationships are one way.
312
+ *
313
+ * For example, you can use this method to find whether the current user has
314
+ * selected a particular page as a favorite (i.e. 'save for later'):
315
+ * `GET /wiki/rest/api/relation/favourite/from/user/current/to/content/123`
316
+ *
317
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
318
+ * Permission to view both the target entity and source entity.
319
+ *
320
+ * @returns Returned if the relationship exists.
321
+ * @path {GET}
322
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
323
+ * @scopes-current read:confluence-content.summary
324
+ * @scopes-beta read:relation:confluence, read:content-details:confluence
325
+ */
326
+ getRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, }: {
327
+ /**
328
+ * The name of the relationship. This method supports the 'favourite'
329
+ * (i.e. 'save for later') relationship as well as any other relationship
330
+ * types created via [Create
331
+ * relationship](#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put).
332
+ */
333
+ relationName: string;
334
+ /**
335
+ * The source entity type of the relationship. This must be 'user', if
336
+ * the `relationName` is 'favourite'.
337
+ */
338
+ sourceType: "user" | "content" | "space";
339
+ /**
340
+ * - The identifier for the source entity:
341
+ *
342
+ * - If `sourceType` is `user`, then specify either `current` (logged-in user),
343
+ * the user key of the user, or
344
+ * the account ID of the user. Note that the user key has been deprecated in favor
345
+ * of the account ID for this parameter. See the
346
+ * [migration
347
+ * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
348
+ * for details.
349
+ * - If `sourceType` is 'content', then specify the content ID.
350
+ * - If `sourceType` is 'space', then specify the space key.
351
+ */
352
+ sourceKey: string;
353
+ /**
354
+ * The target entity type of the relationship. This must be 'space' or
355
+ * 'content', if the `relationName` is 'favourite'.
356
+ */
357
+ targetType: "user" | "content" | "space";
358
+ /**
359
+ * The identifier for the target entity:
360
+ *
361
+ * - If `targetType` is `user`, then specify either `current` (logged-in user),
362
+ * the user key of the user, or
363
+ * the account ID of the user. Note that the user key has been deprecated in favor
364
+ * of the account ID for this parameter. See the
365
+ * [migration
366
+ * guide](https://developer.atlassian.com/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
367
+ * for details.
368
+ * - If `targetType` is 'content', then specify the content ID.
369
+ * - If `targetType` is 'space', then specify the space key.
370
+ */
371
+ targetKey: string;
372
+ /**
373
+ * The status of the source. This parameter is only used when the
374
+ * `sourceType` is 'content'.
375
+ */
376
+ sourceStatus?: string;
377
+ /**
378
+ * The status of the target. This parameter is only used when the
379
+ * `targetType` is 'content'.
380
+ */
381
+ targetStatus?: string;
382
+ /**
383
+ * The version of the source. This parameter is only used when the
384
+ * `sourceType` is 'content' and the `sourceStatus` is 'historical'.
385
+ */
386
+ sourceVersion?: number;
387
+ /**
388
+ * The version of the target. This parameter is only used when the
389
+ * `targetType` is 'content' and the `targetStatus` is 'historical'.
390
+ */
391
+ targetVersion?: number;
392
+ /**
393
+ * A multi-value parameter indicating which properties of the response
394
+ * object to expand.
395
+ *
396
+ * - `relationData` returns information about the relationship, such as
397
+ * who created it and when it was created.
398
+ * - `source` returns the source entity.
399
+ * - `target` returns the target entity.
400
+ */
401
+ expand?: ("relationData" | "source" | "target")[];
402
+ }): Promise<Relation>;
403
+ static initialize(): void;
404
+ }
@@ -0,0 +1,270 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RelationService = 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 relation_1 = require("../models/relation");
11
+ const validationSchemaStorage_1 = require("../validationSchemaStorage");
12
+ class RelationService extends CommonHttpService_1.CommonHttpService {
13
+ /**
14
+ * Creates a relationship between two entities (user, space, content). The
15
+ * 'favourite' relationship is supported by default, but you can use this method
16
+ * to create any type of relationship between two entities.
17
+ *
18
+ * For example, the following method creates a 'sibling' relationship between
19
+ * two pieces of content:
20
+ * `PUT /wiki/rest/api/relation/sibling/from/content/123/to/content/456`
21
+ *
22
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
23
+ * Permission to access the Confluence site ('Can use' global permission).
24
+ *
25
+ * @returns Returned if the relationship is created.
26
+ * @path {PUT}
27
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
28
+ * @scopes-current write:confluence-content
29
+ * @scopes-beta read:relation:confluence, read:space:confluence, read:user:confluence,
30
+ * read:content:confluence, write:relation:confluence
31
+ */
32
+ createRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }) {
33
+ return this.getClientInstance()
34
+ .request({
35
+ path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}",
36
+ method: "PUT",
37
+ pathParams: {
38
+ relationName,
39
+ sourceType,
40
+ sourceKey,
41
+ targetType,
42
+ targetKey,
43
+ },
44
+ query: {
45
+ sourceStatus,
46
+ targetStatus,
47
+ sourceVersion,
48
+ targetVersion,
49
+ },
50
+ })
51
+ .then(this.getClientInstance().responseHandler({
52
+ 200: {
53
+ "application/json": "json",
54
+ },
55
+ }))
56
+ .then(commonHttpClient.castResponse())
57
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.createRelationship.response"))
58
+ .then(commonHttpClient.getBody);
59
+ }
60
+ /**
61
+ * Deletes a relationship between two entities (user, space, content).
62
+ *
63
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
64
+ * Permission to access the Confluence site ('Can use' global permission).
65
+ * For favourite relationships, the current user can only delete their own
66
+ * favourite relationships. A space administrator can delete favourite
67
+ * relationships for any user.
68
+ *
69
+ * @path {DELETE}
70
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
71
+ * @scopes-current write:confluence-content
72
+ * @scopes-beta write:relation:confluence
73
+ */
74
+ deleteRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }) {
75
+ return this.getClientInstance()
76
+ .request({
77
+ path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}",
78
+ method: "DELETE",
79
+ pathParams: {
80
+ relationName,
81
+ sourceType,
82
+ sourceKey,
83
+ targetType,
84
+ targetKey,
85
+ },
86
+ query: {
87
+ sourceStatus,
88
+ targetStatus,
89
+ sourceVersion,
90
+ targetVersion,
91
+ },
92
+ })
93
+ .then(commonHttpClient.discardResult);
94
+ }
95
+ /**
96
+ * Returns all target entities that have a particular relationship to the
97
+ * source entity. Note, relationships are one way.
98
+ *
99
+ * For example, the following method finds all users that have a 'collaborator'
100
+ * relationship to a piece of content with an ID of '1234':
101
+ * `GET /wiki/rest/api/relation/collaborator/to/content/1234/from/user`
102
+ * Note, 'collaborator' is an example custom relationship type.
103
+ *
104
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
105
+ * Permission to view both the target entity and source entity.
106
+ *
107
+ * @returns Returned if the requested relationships are returned.
108
+ * @path {GET}
109
+ * /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}
110
+ * @scopes-current read:confluence-content.summary
111
+ * @scopes-beta read:relation:confluence, read:content-details:confluence
112
+ */
113
+ findSourcesForTarget({ relationName, sourceType, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }) {
114
+ return this.getClientInstance()
115
+ .request({
116
+ path: "/wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}",
117
+ method: "GET",
118
+ pathParams: {
119
+ relationName,
120
+ sourceType,
121
+ targetType,
122
+ targetKey,
123
+ },
124
+ query: {
125
+ sourceStatus,
126
+ targetStatus,
127
+ sourceVersion,
128
+ targetVersion,
129
+ expand,
130
+ start,
131
+ limit,
132
+ },
133
+ })
134
+ .then(this.getClientInstance().responseHandler({
135
+ 200: {
136
+ "application/json": "json",
137
+ },
138
+ }))
139
+ .then(commonHttpClient.castResponse())
140
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.findSourcesForTarget.response"))
141
+ .then(commonHttpClient.getBody);
142
+ }
143
+ /**
144
+ * Returns all target entities that have a particular relationship to the
145
+ * source entity. Note, relationships are one way.
146
+ *
147
+ * For example, the following method finds all content that the current user
148
+ * has an 'ignore' relationship with:
149
+ * `GET /wiki/rest/api/relation/ignore/from/user/current/to/content`
150
+ * Note, 'ignore' is an example custom relationship type.
151
+ *
152
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
153
+ * Permission to view both the target entity and source entity.
154
+ *
155
+ * @returns Returned if the requested relationships are returned.
156
+ * @path {GET}
157
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}
158
+ * @scopes-current read:confluence-content.summary
159
+ * @scopes-beta read:relation:confluence, read:content-details:confluence
160
+ */
161
+ findTargetFromSource({ relationName, sourceType, sourceKey, targetType, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }) {
162
+ return this.getClientInstance()
163
+ .request({
164
+ path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}",
165
+ method: "GET",
166
+ pathParams: {
167
+ relationName,
168
+ sourceType,
169
+ sourceKey,
170
+ targetType,
171
+ },
172
+ query: {
173
+ sourceStatus,
174
+ targetStatus,
175
+ sourceVersion,
176
+ targetVersion,
177
+ expand,
178
+ start,
179
+ limit,
180
+ },
181
+ })
182
+ .then(this.getClientInstance().responseHandler({
183
+ 200: {
184
+ "application/json": "json",
185
+ },
186
+ }))
187
+ .then(commonHttpClient.castResponse())
188
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.findTargetFromSource.response"))
189
+ .then(commonHttpClient.getBody);
190
+ }
191
+ /**
192
+ * Find whether a particular type of relationship exists from a source
193
+ * entity to a target entity. Note, relationships are one way.
194
+ *
195
+ * For example, you can use this method to find whether the current user has
196
+ * selected a particular page as a favorite (i.e. 'save for later'):
197
+ * `GET /wiki/rest/api/relation/favourite/from/user/current/to/content/123`
198
+ *
199
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
200
+ * Permission to view both the target entity and source entity.
201
+ *
202
+ * @returns Returned if the relationship exists.
203
+ * @path {GET}
204
+ * /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
205
+ * @scopes-current read:confluence-content.summary
206
+ * @scopes-beta read:relation:confluence, read:content-details:confluence
207
+ */
208
+ getRelationship({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, }) {
209
+ return this.getClientInstance()
210
+ .request({
211
+ path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}",
212
+ method: "GET",
213
+ pathParams: {
214
+ relationName,
215
+ sourceType,
216
+ sourceKey,
217
+ targetType,
218
+ targetKey,
219
+ },
220
+ query: {
221
+ sourceStatus,
222
+ targetStatus,
223
+ sourceVersion,
224
+ targetVersion,
225
+ expand,
226
+ },
227
+ })
228
+ .then(this.getClientInstance().responseHandler({
229
+ 200: {
230
+ "application/json": "json",
231
+ },
232
+ }))
233
+ .then(commonHttpClient.castResponse())
234
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.getRelationship.response"))
235
+ .then(commonHttpClient.getBody);
236
+ }
237
+ static initialize() {
238
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("RelationService.findTargetFromSource.response", zod_1.z
239
+ .object({
240
+ status: zod_1.z.literal(200),
241
+ mediaType: zod_1.z.literal("application/json"),
242
+ body: validationSchemaStorage_1.validationSchemaStorage.lazy("RelationArray"),
243
+ })
244
+ .describe("RelationService.findTargetFromSource.response"));
245
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("RelationService.getRelationship.response", zod_1.z
246
+ .object({
247
+ status: zod_1.z.literal(200),
248
+ mediaType: zod_1.z.literal("application/json"),
249
+ body: validationSchemaStorage_1.validationSchemaStorage.lazy("Relation"),
250
+ })
251
+ .describe("RelationService.getRelationship.response"));
252
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("RelationService.createRelationship.response", zod_1.z
253
+ .object({
254
+ status: zod_1.z.literal(200),
255
+ mediaType: zod_1.z.literal("application/json"),
256
+ body: validationSchemaStorage_1.validationSchemaStorage.lazy("Relation"),
257
+ })
258
+ .describe("RelationService.createRelationship.response"));
259
+ validationSchemaStorage_1.validationSchemaStorage.registerExtensible("RelationService.findSourcesForTarget.response", zod_1.z
260
+ .object({
261
+ status: zod_1.z.literal(200),
262
+ mediaType: zod_1.z.literal("application/json"),
263
+ body: validationSchemaStorage_1.validationSchemaStorage.lazy("RelationArray"),
264
+ })
265
+ .describe("RelationService.findSourcesForTarget.response"));
266
+ validationSchemaStorage_1.validationSchemaStorage.registerOnce([relation_1.registerRelationValidationSchemas]);
267
+ }
268
+ }
269
+ exports.RelationService = RelationService;
270
+ //# sourceMappingURL=RelationService.js.map