@resolution/confluence-api-client 0.4.4 → 0.4.6

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 (183) hide show
  1. package/CHANGELOG.md +22 -0
  2. package/README.md +60 -1
  3. package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +32 -33
  4. package/lib/openapi/v1/BaseConfluenceApiV1Client.js +151 -88
  5. package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
  6. package/lib/openapi/v1/core/CommonHttpService.d.ts +2 -0
  7. package/lib/openapi/v1/core/CommonHttpService.js +9 -0
  8. package/lib/openapi/v1/core/CommonHttpService.js.map +1 -1
  9. package/lib/openapi/v1/services/AnalyticsService.d.ts +10 -10
  10. package/lib/openapi/v1/services/AnalyticsService.js +62 -59
  11. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  12. package/lib/openapi/v1/services/AuditService.d.ts +25 -25
  13. package/lib/openapi/v1/services/AuditService.js +205 -202
  14. package/lib/openapi/v1/services/AuditService.js.map +1 -1
  15. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +20 -20
  16. package/lib/openapi/v1/services/ContentAttachmentsService.js +317 -314
  17. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  18. package/lib/openapi/v1/services/ContentBodyService.d.ts +15 -15
  19. package/lib/openapi/v1/services/ContentBodyService.js +140 -137
  20. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  21. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +27 -27
  22. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +391 -388
  23. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  24. package/lib/openapi/v1/services/ContentCommentsService.d.ts +8 -8
  25. package/lib/openapi/v1/services/ContentCommentsService.js +49 -46
  26. package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
  27. package/lib/openapi/v1/services/ContentLabelsService.d.ts +11 -11
  28. package/lib/openapi/v1/services/ContentLabelsService.js +150 -147
  29. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  30. package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +13 -13
  31. package/lib/openapi/v1/services/ContentMacroBodyService.js +155 -152
  32. package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
  33. package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -2
  34. package/lib/openapi/v1/services/ContentPermissionsService.js +48 -45
  35. package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
  36. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +18 -18
  37. package/lib/openapi/v1/services/ContentPropertiesService.js +237 -234
  38. package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
  39. package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +49 -49
  40. package/lib/openapi/v1/services/ContentRestrictionsService.js +505 -502
  41. package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
  42. package/lib/openapi/v1/services/ContentService.d.ts +50 -50
  43. package/lib/openapi/v1/services/ContentService.js +475 -472
  44. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  45. package/lib/openapi/v1/services/ContentStatesService.d.ts +25 -25
  46. package/lib/openapi/v1/services/ContentStatesService.js +359 -356
  47. package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
  48. package/lib/openapi/v1/services/ContentVersionsService.d.ts +13 -13
  49. package/lib/openapi/v1/services/ContentVersionsService.js +144 -141
  50. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  51. package/lib/openapi/v1/services/ContentWatchesService.d.ts +57 -57
  52. package/lib/openapi/v1/services/ContentWatchesService.js +454 -451
  53. package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
  54. package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -5
  55. package/lib/openapi/v1/services/DynamicModulesService.js +70 -67
  56. package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
  57. package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -12
  58. package/lib/openapi/v1/services/ExperimentalService.js +151 -148
  59. package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
  60. package/lib/openapi/v1/services/GroupService.d.ts +52 -52
  61. package/lib/openapi/v1/services/GroupService.js +445 -442
  62. package/lib/openapi/v1/services/GroupService.js.map +1 -1
  63. package/lib/openapi/v1/services/InlineTasksService.d.ts +20 -20
  64. package/lib/openapi/v1/services/InlineTasksService.js +118 -115
  65. package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
  66. package/lib/openapi/v1/services/LabelInfoService.d.ts +5 -5
  67. package/lib/openapi/v1/services/LabelInfoService.js +37 -34
  68. package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
  69. package/lib/openapi/v1/services/LongRunningTaskService.d.ts +8 -6
  70. package/lib/openapi/v1/services/LongRunningTaskService.js +67 -63
  71. package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
  72. package/lib/openapi/v1/services/RelationService.d.ts +37 -37
  73. package/lib/openapi/v1/services/RelationService.js +231 -228
  74. package/lib/openapi/v1/services/RelationService.js.map +1 -1
  75. package/lib/openapi/v1/services/SearchService.d.ts +20 -20
  76. package/lib/openapi/v1/services/SearchService.js +136 -133
  77. package/lib/openapi/v1/services/SearchService.js.map +1 -1
  78. package/lib/openapi/v1/services/SettingsService.d.ts +15 -15
  79. package/lib/openapi/v1/services/SettingsService.js +204 -201
  80. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  81. package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -6
  82. package/lib/openapi/v1/services/SpacePermissionsService.js +99 -96
  83. package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
  84. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +16 -16
  85. package/lib/openapi/v1/services/SpacePropertiesService.js +227 -224
  86. package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
  87. package/lib/openapi/v1/services/SpaceService.d.ts +38 -38
  88. package/lib/openapi/v1/services/SpaceService.js +320 -317
  89. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  90. package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -4
  91. package/lib/openapi/v1/services/SpaceSettingsService.js +68 -65
  92. package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
  93. package/lib/openapi/v1/services/TemplateService.d.ts +20 -20
  94. package/lib/openapi/v1/services/TemplateService.js +214 -211
  95. package/lib/openapi/v1/services/TemplateService.js.map +1 -1
  96. package/lib/openapi/v1/services/ThemesService.d.ts +13 -13
  97. package/lib/openapi/v1/services/ThemesService.js +179 -176
  98. package/lib/openapi/v1/services/ThemesService.js.map +1 -1
  99. package/lib/openapi/v1/services/UserPropertiesService.d.ts +12 -12
  100. package/lib/openapi/v1/services/UserPropertiesService.js +165 -162
  101. package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
  102. package/lib/openapi/v1/services/UsersService.d.ts +21 -21
  103. package/lib/openapi/v1/services/UsersService.js +229 -226
  104. package/lib/openapi/v1/services/UsersService.js.map +1 -1
  105. package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +23 -24
  106. package/lib/openapi/v2/BaseConfluenceApiV2Client.js +92 -47
  107. package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
  108. package/lib/openapi/v2/core/CommonHttpService.d.ts +2 -0
  109. package/lib/openapi/v2/core/CommonHttpService.js +9 -0
  110. package/lib/openapi/v2/core/CommonHttpService.js.map +1 -1
  111. package/lib/openapi/v2/models/user.d.ts +0 -2
  112. package/lib/openapi/v2/models/user.js +0 -2
  113. package/lib/openapi/v2/models/user.js.map +1 -1
  114. package/lib/openapi/v2/services/AncestorsService.d.ts +17 -17
  115. package/lib/openapi/v2/services/AncestorsService.js +174 -171
  116. package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
  117. package/lib/openapi/v2/services/AttachmentService.d.ts +62 -62
  118. package/lib/openapi/v2/services/AttachmentService.js +261 -258
  119. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  120. package/lib/openapi/v2/services/BlogPostService.d.ts +70 -70
  121. package/lib/openapi/v2/services/BlogPostService.js +270 -267
  122. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  123. package/lib/openapi/v2/services/ChildrenService.d.ts +14 -14
  124. package/lib/openapi/v2/services/ChildrenService.js +77 -74
  125. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  126. package/lib/openapi/v2/services/ClassificationLevelService.d.ts +21 -21
  127. package/lib/openapi/v2/services/ClassificationLevelService.js +304 -301
  128. package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
  129. package/lib/openapi/v2/services/CommentService.d.ts +136 -136
  130. package/lib/openapi/v2/services/CommentService.js +635 -632
  131. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  132. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +128 -128
  133. package/lib/openapi/v2/services/ContentPropertiesService.js +1242 -1239
  134. package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
  135. package/lib/openapi/v2/services/ContentService.d.ts +2 -2
  136. package/lib/openapi/v2/services/ContentService.js +40 -37
  137. package/lib/openapi/v2/services/ContentService.js.map +1 -1
  138. package/lib/openapi/v2/services/CustomContentService.d.ts +72 -72
  139. package/lib/openapi/v2/services/CustomContentService.js +299 -296
  140. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  141. package/lib/openapi/v2/services/DataPoliciesService.d.ts +10 -10
  142. package/lib/openapi/v2/services/DataPoliciesService.js +67 -64
  143. package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
  144. package/lib/openapi/v2/services/DatabaseService.d.ts +17 -17
  145. package/lib/openapi/v2/services/DatabaseService.js +90 -87
  146. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  147. package/lib/openapi/v2/services/LabelService.d.ts +57 -57
  148. package/lib/openapi/v2/services/LabelService.js +263 -260
  149. package/lib/openapi/v2/services/LabelService.js.map +1 -1
  150. package/lib/openapi/v2/services/LikeService.d.ts +36 -36
  151. package/lib/openapi/v2/services/LikeService.js +250 -247
  152. package/lib/openapi/v2/services/LikeService.js.map +1 -1
  153. package/lib/openapi/v2/services/OperationService.d.ts +20 -20
  154. package/lib/openapi/v2/services/OperationService.js +298 -295
  155. package/lib/openapi/v2/services/OperationService.js.map +1 -1
  156. package/lib/openapi/v2/services/PageService.d.ts +73 -73
  157. package/lib/openapi/v2/services/PageService.js +272 -269
  158. package/lib/openapi/v2/services/PageService.js.map +1 -1
  159. package/lib/openapi/v2/services/SmartLinkService.d.ts +19 -17
  160. package/lib/openapi/v2/services/SmartLinkService.js +92 -89
  161. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  162. package/lib/openapi/v2/services/SpacePermissionsService.d.ts +6 -6
  163. package/lib/openapi/v2/services/SpacePermissionsService.js +35 -32
  164. package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
  165. package/lib/openapi/v2/services/SpacePropertiesService.d.ts +15 -15
  166. package/lib/openapi/v2/services/SpacePropertiesService.js +165 -162
  167. package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
  168. package/lib/openapi/v2/services/SpaceService.d.ts +28 -28
  169. package/lib/openapi/v2/services/SpaceService.js +83 -80
  170. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  171. package/lib/openapi/v2/services/TaskService.d.ts +40 -40
  172. package/lib/openapi/v2/services/TaskService.js +120 -117
  173. package/lib/openapi/v2/services/TaskService.js.map +1 -1
  174. package/lib/openapi/v2/services/UserService.d.ts +11 -11
  175. package/lib/openapi/v2/services/UserService.js +91 -88
  176. package/lib/openapi/v2/services/UserService.js.map +1 -1
  177. package/lib/openapi/v2/services/VersionService.d.ts +59 -59
  178. package/lib/openapi/v2/services/VersionService.js +395 -392
  179. package/lib/openapi/v2/services/VersionService.js.map +1 -1
  180. package/lib/openapi/v2/services/WhiteboardService.d.ts +17 -17
  181. package/lib/openapi/v2/services/WhiteboardService.js +90 -87
  182. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  183. package/package.json +4 -3
@@ -12,398 +12,401 @@ const version_1 = require("../models/version");
12
12
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
13
13
  /** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version */
14
14
  class VersionService extends CommonHttpService_1.CommonHttpService {
15
- /**
16
- * Retrieves version details for the specified attachment and version number.
17
- *
18
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
19
- * Permission to view the attachment.
20
- *
21
- * @returns Returned if the requested version details are successfully retrieved.
22
- * @path {GET} /attachments/{attachment-id}/versions/{version-number}
23
- * @scopes-current read:attachment:confluence
24
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-attachments-attachment-id-versions-version-number-get
25
- */
26
- getAttachmentVersionDetails({ attachmentId, versionNumber, }) {
27
- return this.getClientInstance()
28
- .request({
29
- path: "/attachments/{attachment-id}/versions/{version-number}",
30
- method: "GET",
31
- pathParams: {
32
- "attachment-id": attachmentId,
33
- "version-number": versionNumber,
34
- },
35
- })
36
- .then(this.getClientInstance().responseHandler({
37
- 200: {
38
- "application/json": "json",
39
- },
40
- }))
41
- .then(commonHttpClient.castResponse())
42
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getAttachmentVersionDetails.response"))
43
- .then(commonHttpClient.getBody);
44
- }
45
- /**
46
- * Returns the versions of specific attachment.
47
- *
48
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
49
- * Permission to view the attachment and its corresponding space.
50
- *
51
- * @returns Returned if the requested attachment versions are returned.
52
- * @path {GET} /attachments/{id}/versions
53
- * @scopes-current read:attachment:confluence
54
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-attachments-id-versions-get
55
- */
56
- getAttachmentVersions({ id, cursor, limit, sort, }) {
57
- return this.getClientInstance()
58
- .request({
59
- path: "/attachments/{id}/versions",
60
- method: "GET",
61
- pathParams: {
62
- id,
63
- },
64
- query: {
65
- cursor,
66
- limit,
67
- sort,
68
- },
69
- })
70
- .then(this.getClientInstance().responseHandler({
71
- 200: {
72
- "application/json": "json",
73
- },
74
- }))
75
- .then(commonHttpClient.castResponse())
76
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getAttachmentVersions.response"))
77
- .then(commonHttpClient.getBody);
78
- }
79
- /**
80
- * Retrieves version details for the specified blog post and version number.
81
- *
82
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
83
- * Permission to view the blog post.
84
- *
85
- * @returns Returned if the requested version details are successfully retrieved.
86
- * @path {GET} /blogposts/{blogpost-id}/versions/{version-number}
87
- * @scopes-current read:page:confluence
88
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-blogposts-blogpost-id-versions-version-number-get
89
- */
90
- getBlogPostVersionDetails({ blogpostId, versionNumber, }) {
91
- return this.getClientInstance()
92
- .request({
93
- path: "/blogposts/{blogpost-id}/versions/{version-number}",
94
- method: "GET",
95
- pathParams: {
96
- "blogpost-id": blogpostId,
97
- "version-number": versionNumber,
98
- },
99
- })
100
- .then(this.getClientInstance().responseHandler({
101
- 200: {
102
- "application/json": "json",
103
- },
104
- }))
105
- .then(commonHttpClient.castResponse())
106
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getBlogPostVersionDetails.response"))
107
- .then(commonHttpClient.getBody);
108
- }
109
- /**
110
- * Returns the versions of specific blog post.
111
- *
112
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
113
- * Permission to view the blog post and its corresponding space.
114
- *
115
- * @returns Returned if the requested blog post versions are returned.
116
- * @path {GET} /blogposts/{id}/versions
117
- * @scopes-current read:page:confluence
118
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-blogposts-id-versions-get
119
- */
120
- getBlogPostVersions({ id, bodyFormat, cursor, limit, sort, }) {
121
- return this.getClientInstance()
122
- .request({
123
- path: "/blogposts/{id}/versions",
124
- method: "GET",
125
- pathParams: {
126
- id,
127
- },
128
- query: {
129
- "body-format": bodyFormat,
130
- cursor,
131
- limit,
132
- sort,
133
- },
134
- })
135
- .then(this.getClientInstance().responseHandler({
136
- 200: {
137
- "application/json": "json",
138
- },
139
- }))
140
- .then(commonHttpClient.castResponse())
141
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getBlogPostVersions.response"))
142
- .then(commonHttpClient.getBody);
143
- }
144
- /**
145
- * Retrieves version details for the specified custom content and version number.
146
- *
147
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
148
- * Permission to view the page.
149
- *
150
- * @returns Returned if the requested version details are successfully retrieved.
151
- * @path {GET} /custom-content/{custom-content-id}/versions/{version-number}
152
- * @scopes-current read:custom-content:confluence
153
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-custom-content-custom-content-id-versions-version-number-get
154
- */
155
- getCustomContentVersionDetails({ customContentId, versionNumber, }) {
156
- return this.getClientInstance()
157
- .request({
158
- path: "/custom-content/{custom-content-id}/versions/{version-number}",
159
- method: "GET",
160
- pathParams: {
161
- "custom-content-id": customContentId,
162
- "version-number": versionNumber,
163
- },
164
- })
165
- .then(this.getClientInstance().responseHandler({
166
- 200: {
167
- "application/json": "json",
168
- },
169
- }))
170
- .then(commonHttpClient.castResponse())
171
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getCustomContentVersionDetails.response"))
172
- .then(commonHttpClient.getBody);
173
- }
174
- /**
175
- * Returns the versions of specific custom content.
176
- *
177
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
178
- * Permission to view the custom content and its corresponding page and space.
179
- *
180
- * @returns Returned if the requested custom content versions are returned.
181
- * @path {GET} /custom-content/{custom-content-id}/versions
182
- * @scopes-current read:custom-content:confluence
183
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-custom-content-custom-content-id-versions-get
184
- */
185
- getCustomContentVersions({ customContentId, bodyFormat, cursor, limit, sort, }) {
186
- return this.getClientInstance()
187
- .request({
188
- path: "/custom-content/{custom-content-id}/versions",
189
- method: "GET",
190
- pathParams: {
191
- "custom-content-id": customContentId,
192
- },
193
- query: {
194
- "body-format": bodyFormat,
195
- cursor,
196
- limit,
197
- sort,
198
- },
199
- })
200
- .then(this.getClientInstance().responseHandler({
201
- 200: {
202
- "application/json": "json",
203
- },
204
- }))
205
- .then(commonHttpClient.castResponse())
206
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getCustomContentVersions.response"))
207
- .then(commonHttpClient.getBody);
208
- }
209
- /**
210
- * Retrieves version details for the specified footer comment version.
211
- *
212
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
213
- * Permission to view the content of the page or blog post and its corresponding
214
- * space.
215
- *
216
- * @returns Returned if the requested version details are successfully retrieved.
217
- * @path {GET} /footer-comments/{id}/versions/{version-number}
218
- * @scopes-current read:comment:confluence
219
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-footer-comments-id-versions-version-number-get
220
- */
221
- getFooterCommentVersionDetails({ id, versionNumber, }) {
222
- return this.getClientInstance()
223
- .request({
224
- path: "/footer-comments/{id}/versions/{version-number}",
225
- method: "GET",
226
- pathParams: {
227
- id,
228
- "version-number": versionNumber,
229
- },
230
- })
231
- .then(this.getClientInstance().responseHandler({
232
- 200: {
233
- "application/json": "json",
234
- },
235
- }))
236
- .then(commonHttpClient.castResponse())
237
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getFooterCommentVersionDetails.response"))
238
- .then(commonHttpClient.getBody);
239
- }
240
- /**
241
- * Retrieves the versions of the specified footer comment.
242
- *
243
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
244
- * Permission to view the content of the page or blog post and its corresponding
245
- * space.
246
- *
247
- * @returns Returned if the requested footer comment versions are returned.
248
- * @path {GET} /footer-comments/{id}/versions
249
- * @scopes-current read:comment:confluence
250
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-footer-comments-id-versions-get
251
- */
252
- getFooterCommentVersions({ id, bodyFormat, cursor, limit, sort, }) {
253
- return this.getClientInstance()
254
- .request({
255
- path: "/footer-comments/{id}/versions",
256
- method: "GET",
257
- pathParams: {
258
- id,
259
- },
260
- query: {
261
- "body-format": bodyFormat,
262
- cursor,
263
- limit,
264
- sort,
265
- },
266
- })
267
- .then(this.getClientInstance().responseHandler({
268
- 200: {
269
- "application/json": "json",
270
- },
271
- }))
272
- .then(commonHttpClient.castResponse())
273
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getFooterCommentVersions.response"))
274
- .then(commonHttpClient.getBody);
275
- }
276
- /**
277
- * Retrieves version details for the specified inline comment version.
278
- *
279
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
280
- * Permission to view the content of the page or blog post and its corresponding
281
- * space.
282
- *
283
- * @returns Returned if the requested version details are successfully retrieved.
284
- * @path {GET} /inline-comments/{id}/versions/{version-number}
285
- * @scopes-current read:comment:confluence
286
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-inline-comments-id-versions-version-number-get
287
- */
288
- getInlineCommentVersionDetails({ id, versionNumber, }) {
289
- return this.getClientInstance()
290
- .request({
291
- path: "/inline-comments/{id}/versions/{version-number}",
292
- method: "GET",
293
- pathParams: {
294
- id,
295
- "version-number": versionNumber,
296
- },
297
- })
298
- .then(this.getClientInstance().responseHandler({
299
- 200: {
300
- "application/json": "json",
301
- },
302
- }))
303
- .then(commonHttpClient.castResponse())
304
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getInlineCommentVersionDetails.response"))
305
- .then(commonHttpClient.getBody);
306
- }
307
- /**
308
- * Retrieves the versions of the specified inline comment.
309
- *
310
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
311
- * Permission to view the content of the page or blog post and its corresponding
312
- * space.
313
- *
314
- * @returns Returned if the requested inline comment versions are returned.
315
- * @path {GET} /inline-comments/{id}/versions
316
- * @scopes-current read:comment:confluence
317
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-inline-comments-id-versions-get
318
- */
319
- getInlineCommentVersions({ id, bodyFormat, cursor, limit, sort, }) {
320
- return this.getClientInstance()
321
- .request({
322
- path: "/inline-comments/{id}/versions",
323
- method: "GET",
324
- pathParams: {
325
- id,
326
- },
327
- query: {
328
- "body-format": bodyFormat,
329
- cursor,
330
- limit,
331
- sort,
332
- },
333
- })
334
- .then(this.getClientInstance().responseHandler({
335
- 200: {
336
- "application/json": "json",
337
- },
338
- }))
339
- .then(commonHttpClient.castResponse())
340
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getInlineCommentVersions.response"))
341
- .then(commonHttpClient.getBody);
342
- }
343
- /**
344
- * Retrieves version details for the specified page and version number.
345
- *
346
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
347
- * Permission to view the page.
348
- *
349
- * @returns Returned if the requested version details are successfully retrieved.
350
- * @path {GET} /pages/{page-id}/versions/{version-number}
351
- * @scopes-current read:page:confluence
352
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-pages-page-id-versions-version-number-get
353
- */
354
- getPageVersionDetails({ pageId, versionNumber, }) {
355
- return this.getClientInstance()
356
- .request({
357
- path: "/pages/{page-id}/versions/{version-number}",
358
- method: "GET",
359
- pathParams: {
360
- "page-id": pageId,
361
- "version-number": versionNumber,
362
- },
363
- })
364
- .then(this.getClientInstance().responseHandler({
365
- 200: {
366
- "application/json": "json",
367
- },
368
- }))
369
- .then(commonHttpClient.castResponse())
370
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getPageVersionDetails.response"))
371
- .then(commonHttpClient.getBody);
372
- }
373
- /**
374
- * Returns the versions of specific page.
375
- *
376
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
377
- * Permission to view the page and its corresponding space.
378
- *
379
- * @returns Returned if the requested page versions are returned.
380
- * @path {GET} /pages/{id}/versions
381
- * @scopes-current read:page:confluence
382
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-pages-id-versions-get
383
- */
384
- getPageVersions({ id, bodyFormat, cursor, limit, sort, }) {
385
- return this.getClientInstance()
386
- .request({
387
- path: "/pages/{id}/versions",
388
- method: "GET",
389
- pathParams: {
390
- id,
391
- },
392
- query: {
393
- "body-format": bodyFormat,
394
- cursor,
395
- limit,
396
- sort,
397
- },
398
- })
399
- .then(this.getClientInstance().responseHandler({
400
- 200: {
401
- "application/json": "json",
402
- },
403
- }))
404
- .then(commonHttpClient.castResponse())
405
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getPageVersions.response"))
406
- .then(commonHttpClient.getBody);
15
+ constructor() {
16
+ super(...arguments);
17
+ /**
18
+ * Retrieves version details for the specified attachment and version number.
19
+ *
20
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
21
+ * Permission to view the attachment.
22
+ *
23
+ * @returns Returned if the requested version details are successfully retrieved.
24
+ * @path {GET} /attachments/{attachment-id}/versions/{version-number}
25
+ * @scopes-current read:attachment:confluence
26
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-attachments-attachment-id-versions-version-number-get
27
+ */
28
+ this.getAttachmentVersionDetails = ({ attachmentId, versionNumber, }) => {
29
+ return this.getClientInstance()
30
+ .request({
31
+ path: "/attachments/{attachment-id}/versions/{version-number}",
32
+ method: "GET",
33
+ pathParams: {
34
+ "attachment-id": attachmentId,
35
+ "version-number": versionNumber,
36
+ },
37
+ })
38
+ .then(this.getClientInstance().responseHandler({
39
+ 200: {
40
+ "application/json": "json",
41
+ },
42
+ }))
43
+ .then(commonHttpClient.castResponse())
44
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getAttachmentVersionDetails.response"))
45
+ .then(commonHttpClient.getBody);
46
+ };
47
+ /**
48
+ * Returns the versions of specific attachment.
49
+ *
50
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
51
+ * Permission to view the attachment and its corresponding space.
52
+ *
53
+ * @returns Returned if the requested attachment versions are returned.
54
+ * @path {GET} /attachments/{id}/versions
55
+ * @scopes-current read:attachment:confluence
56
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-attachments-id-versions-get
57
+ */
58
+ this.getAttachmentVersions = ({ id, cursor, limit, sort, }) => {
59
+ return this.getClientInstance()
60
+ .request({
61
+ path: "/attachments/{id}/versions",
62
+ method: "GET",
63
+ pathParams: {
64
+ id,
65
+ },
66
+ query: {
67
+ cursor,
68
+ limit,
69
+ sort,
70
+ },
71
+ })
72
+ .then(this.getClientInstance().responseHandler({
73
+ 200: {
74
+ "application/json": "json",
75
+ },
76
+ }))
77
+ .then(commonHttpClient.castResponse())
78
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getAttachmentVersions.response"))
79
+ .then(commonHttpClient.getBody);
80
+ };
81
+ /**
82
+ * Retrieves version details for the specified blog post and version number.
83
+ *
84
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
85
+ * Permission to view the blog post.
86
+ *
87
+ * @returns Returned if the requested version details are successfully retrieved.
88
+ * @path {GET} /blogposts/{blogpost-id}/versions/{version-number}
89
+ * @scopes-current read:page:confluence
90
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-blogposts-blogpost-id-versions-version-number-get
91
+ */
92
+ this.getBlogPostVersionDetails = ({ blogpostId, versionNumber, }) => {
93
+ return this.getClientInstance()
94
+ .request({
95
+ path: "/blogposts/{blogpost-id}/versions/{version-number}",
96
+ method: "GET",
97
+ pathParams: {
98
+ "blogpost-id": blogpostId,
99
+ "version-number": versionNumber,
100
+ },
101
+ })
102
+ .then(this.getClientInstance().responseHandler({
103
+ 200: {
104
+ "application/json": "json",
105
+ },
106
+ }))
107
+ .then(commonHttpClient.castResponse())
108
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getBlogPostVersionDetails.response"))
109
+ .then(commonHttpClient.getBody);
110
+ };
111
+ /**
112
+ * Returns the versions of specific blog post.
113
+ *
114
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
115
+ * Permission to view the blog post and its corresponding space.
116
+ *
117
+ * @returns Returned if the requested blog post versions are returned.
118
+ * @path {GET} /blogposts/{id}/versions
119
+ * @scopes-current read:page:confluence
120
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-blogposts-id-versions-get
121
+ */
122
+ this.getBlogPostVersions = ({ id, bodyFormat, cursor, limit, sort, }) => {
123
+ return this.getClientInstance()
124
+ .request({
125
+ path: "/blogposts/{id}/versions",
126
+ method: "GET",
127
+ pathParams: {
128
+ id,
129
+ },
130
+ query: {
131
+ "body-format": bodyFormat,
132
+ cursor,
133
+ limit,
134
+ sort,
135
+ },
136
+ })
137
+ .then(this.getClientInstance().responseHandler({
138
+ 200: {
139
+ "application/json": "json",
140
+ },
141
+ }))
142
+ .then(commonHttpClient.castResponse())
143
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getBlogPostVersions.response"))
144
+ .then(commonHttpClient.getBody);
145
+ };
146
+ /**
147
+ * Retrieves version details for the specified custom content and version number.
148
+ *
149
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
150
+ * Permission to view the page.
151
+ *
152
+ * @returns Returned if the requested version details are successfully retrieved.
153
+ * @path {GET} /custom-content/{custom-content-id}/versions/{version-number}
154
+ * @scopes-current read:custom-content:confluence
155
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-custom-content-custom-content-id-versions-version-number-get
156
+ */
157
+ this.getCustomContentVersionDetails = ({ customContentId, versionNumber, }) => {
158
+ return this.getClientInstance()
159
+ .request({
160
+ path: "/custom-content/{custom-content-id}/versions/{version-number}",
161
+ method: "GET",
162
+ pathParams: {
163
+ "custom-content-id": customContentId,
164
+ "version-number": versionNumber,
165
+ },
166
+ })
167
+ .then(this.getClientInstance().responseHandler({
168
+ 200: {
169
+ "application/json": "json",
170
+ },
171
+ }))
172
+ .then(commonHttpClient.castResponse())
173
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getCustomContentVersionDetails.response"))
174
+ .then(commonHttpClient.getBody);
175
+ };
176
+ /**
177
+ * Returns the versions of specific custom content.
178
+ *
179
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
180
+ * Permission to view the custom content and its corresponding page and space.
181
+ *
182
+ * @returns Returned if the requested custom content versions are returned.
183
+ * @path {GET} /custom-content/{custom-content-id}/versions
184
+ * @scopes-current read:custom-content:confluence
185
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-custom-content-custom-content-id-versions-get
186
+ */
187
+ this.getCustomContentVersions = ({ customContentId, bodyFormat, cursor, limit, sort, }) => {
188
+ return this.getClientInstance()
189
+ .request({
190
+ path: "/custom-content/{custom-content-id}/versions",
191
+ method: "GET",
192
+ pathParams: {
193
+ "custom-content-id": customContentId,
194
+ },
195
+ query: {
196
+ "body-format": bodyFormat,
197
+ cursor,
198
+ limit,
199
+ sort,
200
+ },
201
+ })
202
+ .then(this.getClientInstance().responseHandler({
203
+ 200: {
204
+ "application/json": "json",
205
+ },
206
+ }))
207
+ .then(commonHttpClient.castResponse())
208
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getCustomContentVersions.response"))
209
+ .then(commonHttpClient.getBody);
210
+ };
211
+ /**
212
+ * Retrieves version details for the specified footer comment version.
213
+ *
214
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
215
+ * Permission to view the content of the page or blog post and its corresponding
216
+ * space.
217
+ *
218
+ * @returns Returned if the requested version details are successfully retrieved.
219
+ * @path {GET} /footer-comments/{id}/versions/{version-number}
220
+ * @scopes-current read:comment:confluence
221
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-footer-comments-id-versions-version-number-get
222
+ */
223
+ this.getFooterCommentVersionDetails = ({ id, versionNumber, }) => {
224
+ return this.getClientInstance()
225
+ .request({
226
+ path: "/footer-comments/{id}/versions/{version-number}",
227
+ method: "GET",
228
+ pathParams: {
229
+ id,
230
+ "version-number": versionNumber,
231
+ },
232
+ })
233
+ .then(this.getClientInstance().responseHandler({
234
+ 200: {
235
+ "application/json": "json",
236
+ },
237
+ }))
238
+ .then(commonHttpClient.castResponse())
239
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getFooterCommentVersionDetails.response"))
240
+ .then(commonHttpClient.getBody);
241
+ };
242
+ /**
243
+ * Retrieves the versions of the specified footer comment.
244
+ *
245
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
246
+ * Permission to view the content of the page or blog post and its corresponding
247
+ * space.
248
+ *
249
+ * @returns Returned if the requested footer comment versions are returned.
250
+ * @path {GET} /footer-comments/{id}/versions
251
+ * @scopes-current read:comment:confluence
252
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-footer-comments-id-versions-get
253
+ */
254
+ this.getFooterCommentVersions = ({ id, bodyFormat, cursor, limit, sort, }) => {
255
+ return this.getClientInstance()
256
+ .request({
257
+ path: "/footer-comments/{id}/versions",
258
+ method: "GET",
259
+ pathParams: {
260
+ id,
261
+ },
262
+ query: {
263
+ "body-format": bodyFormat,
264
+ cursor,
265
+ limit,
266
+ sort,
267
+ },
268
+ })
269
+ .then(this.getClientInstance().responseHandler({
270
+ 200: {
271
+ "application/json": "json",
272
+ },
273
+ }))
274
+ .then(commonHttpClient.castResponse())
275
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getFooterCommentVersions.response"))
276
+ .then(commonHttpClient.getBody);
277
+ };
278
+ /**
279
+ * Retrieves version details for the specified inline comment version.
280
+ *
281
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
282
+ * Permission to view the content of the page or blog post and its corresponding
283
+ * space.
284
+ *
285
+ * @returns Returned if the requested version details are successfully retrieved.
286
+ * @path {GET} /inline-comments/{id}/versions/{version-number}
287
+ * @scopes-current read:comment:confluence
288
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-inline-comments-id-versions-version-number-get
289
+ */
290
+ this.getInlineCommentVersionDetails = ({ id, versionNumber, }) => {
291
+ return this.getClientInstance()
292
+ .request({
293
+ path: "/inline-comments/{id}/versions/{version-number}",
294
+ method: "GET",
295
+ pathParams: {
296
+ id,
297
+ "version-number": versionNumber,
298
+ },
299
+ })
300
+ .then(this.getClientInstance().responseHandler({
301
+ 200: {
302
+ "application/json": "json",
303
+ },
304
+ }))
305
+ .then(commonHttpClient.castResponse())
306
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getInlineCommentVersionDetails.response"))
307
+ .then(commonHttpClient.getBody);
308
+ };
309
+ /**
310
+ * Retrieves the versions of the specified inline comment.
311
+ *
312
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
313
+ * Permission to view the content of the page or blog post and its corresponding
314
+ * space.
315
+ *
316
+ * @returns Returned if the requested inline comment versions are returned.
317
+ * @path {GET} /inline-comments/{id}/versions
318
+ * @scopes-current read:comment:confluence
319
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-inline-comments-id-versions-get
320
+ */
321
+ this.getInlineCommentVersions = ({ id, bodyFormat, cursor, limit, sort, }) => {
322
+ return this.getClientInstance()
323
+ .request({
324
+ path: "/inline-comments/{id}/versions",
325
+ method: "GET",
326
+ pathParams: {
327
+ id,
328
+ },
329
+ query: {
330
+ "body-format": bodyFormat,
331
+ cursor,
332
+ limit,
333
+ sort,
334
+ },
335
+ })
336
+ .then(this.getClientInstance().responseHandler({
337
+ 200: {
338
+ "application/json": "json",
339
+ },
340
+ }))
341
+ .then(commonHttpClient.castResponse())
342
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getInlineCommentVersions.response"))
343
+ .then(commonHttpClient.getBody);
344
+ };
345
+ /**
346
+ * Retrieves version details for the specified page and version number.
347
+ *
348
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
349
+ * Permission to view the page.
350
+ *
351
+ * @returns Returned if the requested version details are successfully retrieved.
352
+ * @path {GET} /pages/{page-id}/versions/{version-number}
353
+ * @scopes-current read:page:confluence
354
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-pages-page-id-versions-version-number-get
355
+ */
356
+ this.getPageVersionDetails = ({ pageId, versionNumber, }) => {
357
+ return this.getClientInstance()
358
+ .request({
359
+ path: "/pages/{page-id}/versions/{version-number}",
360
+ method: "GET",
361
+ pathParams: {
362
+ "page-id": pageId,
363
+ "version-number": versionNumber,
364
+ },
365
+ })
366
+ .then(this.getClientInstance().responseHandler({
367
+ 200: {
368
+ "application/json": "json",
369
+ },
370
+ }))
371
+ .then(commonHttpClient.castResponse())
372
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getPageVersionDetails.response"))
373
+ .then(commonHttpClient.getBody);
374
+ };
375
+ /**
376
+ * Returns the versions of specific page.
377
+ *
378
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
379
+ * Permission to view the page and its corresponding space.
380
+ *
381
+ * @returns Returned if the requested page versions are returned.
382
+ * @path {GET} /pages/{id}/versions
383
+ * @scopes-current read:page:confluence
384
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-version#api-pages-id-versions-get
385
+ */
386
+ this.getPageVersions = ({ id, bodyFormat, cursor, limit, sort, }) => {
387
+ return this.getClientInstance()
388
+ .request({
389
+ path: "/pages/{id}/versions",
390
+ method: "GET",
391
+ pathParams: {
392
+ id,
393
+ },
394
+ query: {
395
+ "body-format": bodyFormat,
396
+ cursor,
397
+ limit,
398
+ sort,
399
+ },
400
+ })
401
+ .then(this.getClientInstance().responseHandler({
402
+ 200: {
403
+ "application/json": "json",
404
+ },
405
+ }))
406
+ .then(commonHttpClient.castResponse())
407
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("VersionService.getPageVersions.response"))
408
+ .then(commonHttpClient.getBody);
409
+ };
407
410
  }
408
411
  static initialize() {
409
412
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("VersionService.getAttachmentVersionDetails.response", zod_1.z