@resolution/confluence-api-client 0.4.4 → 0.4.5

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 (170) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/lib/openapi/v1/services/AnalyticsService.d.ts +10 -10
  3. package/lib/openapi/v1/services/AnalyticsService.js +62 -59
  4. package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
  5. package/lib/openapi/v1/services/AuditService.d.ts +25 -25
  6. package/lib/openapi/v1/services/AuditService.js +205 -202
  7. package/lib/openapi/v1/services/AuditService.js.map +1 -1
  8. package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +20 -20
  9. package/lib/openapi/v1/services/ContentAttachmentsService.js +317 -314
  10. package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
  11. package/lib/openapi/v1/services/ContentBodyService.d.ts +15 -15
  12. package/lib/openapi/v1/services/ContentBodyService.js +140 -137
  13. package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
  14. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +27 -27
  15. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +391 -388
  16. package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
  17. package/lib/openapi/v1/services/ContentCommentsService.d.ts +8 -8
  18. package/lib/openapi/v1/services/ContentCommentsService.js +49 -46
  19. package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
  20. package/lib/openapi/v1/services/ContentLabelsService.d.ts +11 -11
  21. package/lib/openapi/v1/services/ContentLabelsService.js +150 -147
  22. package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
  23. package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +13 -13
  24. package/lib/openapi/v1/services/ContentMacroBodyService.js +155 -152
  25. package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
  26. package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -2
  27. package/lib/openapi/v1/services/ContentPermissionsService.js +48 -45
  28. package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
  29. package/lib/openapi/v1/services/ContentPropertiesService.d.ts +18 -18
  30. package/lib/openapi/v1/services/ContentPropertiesService.js +237 -234
  31. package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
  32. package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +49 -49
  33. package/lib/openapi/v1/services/ContentRestrictionsService.js +505 -502
  34. package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
  35. package/lib/openapi/v1/services/ContentService.d.ts +50 -50
  36. package/lib/openapi/v1/services/ContentService.js +475 -472
  37. package/lib/openapi/v1/services/ContentService.js.map +1 -1
  38. package/lib/openapi/v1/services/ContentStatesService.d.ts +25 -25
  39. package/lib/openapi/v1/services/ContentStatesService.js +359 -356
  40. package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
  41. package/lib/openapi/v1/services/ContentVersionsService.d.ts +13 -13
  42. package/lib/openapi/v1/services/ContentVersionsService.js +144 -141
  43. package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
  44. package/lib/openapi/v1/services/ContentWatchesService.d.ts +57 -57
  45. package/lib/openapi/v1/services/ContentWatchesService.js +454 -451
  46. package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
  47. package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -5
  48. package/lib/openapi/v1/services/DynamicModulesService.js +70 -67
  49. package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
  50. package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -12
  51. package/lib/openapi/v1/services/ExperimentalService.js +151 -148
  52. package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
  53. package/lib/openapi/v1/services/GroupService.d.ts +52 -52
  54. package/lib/openapi/v1/services/GroupService.js +445 -442
  55. package/lib/openapi/v1/services/GroupService.js.map +1 -1
  56. package/lib/openapi/v1/services/InlineTasksService.d.ts +20 -20
  57. package/lib/openapi/v1/services/InlineTasksService.js +118 -115
  58. package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
  59. package/lib/openapi/v1/services/LabelInfoService.d.ts +5 -5
  60. package/lib/openapi/v1/services/LabelInfoService.js +37 -34
  61. package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
  62. package/lib/openapi/v1/services/LongRunningTaskService.d.ts +8 -6
  63. package/lib/openapi/v1/services/LongRunningTaskService.js +67 -63
  64. package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
  65. package/lib/openapi/v1/services/RelationService.d.ts +37 -37
  66. package/lib/openapi/v1/services/RelationService.js +231 -228
  67. package/lib/openapi/v1/services/RelationService.js.map +1 -1
  68. package/lib/openapi/v1/services/SearchService.d.ts +20 -20
  69. package/lib/openapi/v1/services/SearchService.js +136 -133
  70. package/lib/openapi/v1/services/SearchService.js.map +1 -1
  71. package/lib/openapi/v1/services/SettingsService.d.ts +15 -15
  72. package/lib/openapi/v1/services/SettingsService.js +204 -201
  73. package/lib/openapi/v1/services/SettingsService.js.map +1 -1
  74. package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -6
  75. package/lib/openapi/v1/services/SpacePermissionsService.js +99 -96
  76. package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
  77. package/lib/openapi/v1/services/SpacePropertiesService.d.ts +16 -16
  78. package/lib/openapi/v1/services/SpacePropertiesService.js +227 -224
  79. package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
  80. package/lib/openapi/v1/services/SpaceService.d.ts +38 -38
  81. package/lib/openapi/v1/services/SpaceService.js +320 -317
  82. package/lib/openapi/v1/services/SpaceService.js.map +1 -1
  83. package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -4
  84. package/lib/openapi/v1/services/SpaceSettingsService.js +68 -65
  85. package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
  86. package/lib/openapi/v1/services/TemplateService.d.ts +20 -20
  87. package/lib/openapi/v1/services/TemplateService.js +214 -211
  88. package/lib/openapi/v1/services/TemplateService.js.map +1 -1
  89. package/lib/openapi/v1/services/ThemesService.d.ts +13 -13
  90. package/lib/openapi/v1/services/ThemesService.js +179 -176
  91. package/lib/openapi/v1/services/ThemesService.js.map +1 -1
  92. package/lib/openapi/v1/services/UserPropertiesService.d.ts +12 -12
  93. package/lib/openapi/v1/services/UserPropertiesService.js +165 -162
  94. package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
  95. package/lib/openapi/v1/services/UsersService.d.ts +21 -21
  96. package/lib/openapi/v1/services/UsersService.js +229 -226
  97. package/lib/openapi/v1/services/UsersService.js.map +1 -1
  98. package/lib/openapi/v2/models/user.d.ts +0 -2
  99. package/lib/openapi/v2/models/user.js +0 -2
  100. package/lib/openapi/v2/models/user.js.map +1 -1
  101. package/lib/openapi/v2/services/AncestorsService.d.ts +17 -17
  102. package/lib/openapi/v2/services/AncestorsService.js +174 -171
  103. package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
  104. package/lib/openapi/v2/services/AttachmentService.d.ts +62 -62
  105. package/lib/openapi/v2/services/AttachmentService.js +261 -258
  106. package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
  107. package/lib/openapi/v2/services/BlogPostService.d.ts +70 -70
  108. package/lib/openapi/v2/services/BlogPostService.js +270 -267
  109. package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
  110. package/lib/openapi/v2/services/ChildrenService.d.ts +14 -14
  111. package/lib/openapi/v2/services/ChildrenService.js +77 -74
  112. package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
  113. package/lib/openapi/v2/services/ClassificationLevelService.d.ts +21 -21
  114. package/lib/openapi/v2/services/ClassificationLevelService.js +304 -301
  115. package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
  116. package/lib/openapi/v2/services/CommentService.d.ts +136 -136
  117. package/lib/openapi/v2/services/CommentService.js +635 -632
  118. package/lib/openapi/v2/services/CommentService.js.map +1 -1
  119. package/lib/openapi/v2/services/ContentPropertiesService.d.ts +128 -128
  120. package/lib/openapi/v2/services/ContentPropertiesService.js +1242 -1239
  121. package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
  122. package/lib/openapi/v2/services/ContentService.d.ts +2 -2
  123. package/lib/openapi/v2/services/ContentService.js +40 -37
  124. package/lib/openapi/v2/services/ContentService.js.map +1 -1
  125. package/lib/openapi/v2/services/CustomContentService.d.ts +72 -72
  126. package/lib/openapi/v2/services/CustomContentService.js +299 -296
  127. package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
  128. package/lib/openapi/v2/services/DataPoliciesService.d.ts +10 -10
  129. package/lib/openapi/v2/services/DataPoliciesService.js +67 -64
  130. package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
  131. package/lib/openapi/v2/services/DatabaseService.d.ts +17 -17
  132. package/lib/openapi/v2/services/DatabaseService.js +90 -87
  133. package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
  134. package/lib/openapi/v2/services/LabelService.d.ts +57 -57
  135. package/lib/openapi/v2/services/LabelService.js +263 -260
  136. package/lib/openapi/v2/services/LabelService.js.map +1 -1
  137. package/lib/openapi/v2/services/LikeService.d.ts +36 -36
  138. package/lib/openapi/v2/services/LikeService.js +250 -247
  139. package/lib/openapi/v2/services/LikeService.js.map +1 -1
  140. package/lib/openapi/v2/services/OperationService.d.ts +20 -20
  141. package/lib/openapi/v2/services/OperationService.js +298 -295
  142. package/lib/openapi/v2/services/OperationService.js.map +1 -1
  143. package/lib/openapi/v2/services/PageService.d.ts +73 -73
  144. package/lib/openapi/v2/services/PageService.js +272 -269
  145. package/lib/openapi/v2/services/PageService.js.map +1 -1
  146. package/lib/openapi/v2/services/SmartLinkService.d.ts +19 -17
  147. package/lib/openapi/v2/services/SmartLinkService.js +92 -89
  148. package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
  149. package/lib/openapi/v2/services/SpacePermissionsService.d.ts +6 -6
  150. package/lib/openapi/v2/services/SpacePermissionsService.js +35 -32
  151. package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
  152. package/lib/openapi/v2/services/SpacePropertiesService.d.ts +15 -15
  153. package/lib/openapi/v2/services/SpacePropertiesService.js +165 -162
  154. package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
  155. package/lib/openapi/v2/services/SpaceService.d.ts +28 -28
  156. package/lib/openapi/v2/services/SpaceService.js +83 -80
  157. package/lib/openapi/v2/services/SpaceService.js.map +1 -1
  158. package/lib/openapi/v2/services/TaskService.d.ts +40 -40
  159. package/lib/openapi/v2/services/TaskService.js +120 -117
  160. package/lib/openapi/v2/services/TaskService.js.map +1 -1
  161. package/lib/openapi/v2/services/UserService.d.ts +11 -11
  162. package/lib/openapi/v2/services/UserService.js +91 -88
  163. package/lib/openapi/v2/services/UserService.js.map +1 -1
  164. package/lib/openapi/v2/services/VersionService.d.ts +59 -59
  165. package/lib/openapi/v2/services/VersionService.js +395 -392
  166. package/lib/openapi/v2/services/VersionService.js.map +1 -1
  167. package/lib/openapi/v2/services/WhiteboardService.d.ts +17 -17
  168. package/lib/openapi/v2/services/WhiteboardService.js +90 -87
  169. package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
  170. package/package.json +4 -3
@@ -11,1245 +11,1248 @@ const common_1 = require("../models/common");
11
11
  const validationSchemaStorage_1 = require("../validationSchemaStorage");
12
12
  /** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties */
13
13
  class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
14
- /**
15
- * Creates a new content property for an attachment.
16
- *
17
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
18
- * Permission to update the attachment.
19
- *
20
- * @returns Returned if the content property was created successfully.
21
- * @path {POST} /attachments/{attachment-id}/properties
22
- * @scopes-current read:attachment:confluence, write:attachment:confluence
23
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-post
24
- */
25
- createAttachmentProperty({ attachmentId, contentPropertyCreateRequest, }) {
26
- return this.getClientInstance()
27
- .request({
28
- path: "/attachments/{attachment-id}/properties",
29
- method: "POST",
30
- pathParams: {
31
- "attachment-id": attachmentId,
32
- },
33
- headers: {
34
- "Content-Type": "application/json",
35
- },
36
- body: contentPropertyCreateRequest,
37
- })
38
- .then(this.getClientInstance().responseHandler({
39
- 200: {
40
- "application/json": "json",
41
- },
42
- }))
43
- .then(commonHttpClient.castResponse())
44
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createAttachmentProperty.response"))
45
- .then(commonHttpClient.getBody);
46
- }
47
- /**
48
- * Creates a new property for a blogpost.
49
- *
50
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
51
- * Permission to update the blog post.
52
- *
53
- * @returns Returned if the content property was created successfully.
54
- * @path {POST} /blogposts/{blogpost-id}/properties
55
- * @scopes-current read:page:confluence, write:page:confluence
56
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-post
57
- */
58
- createBlogpostProperty({ blogpostId, contentPropertyCreateRequest, }) {
59
- return this.getClientInstance()
60
- .request({
61
- path: "/blogposts/{blogpost-id}/properties",
62
- method: "POST",
63
- pathParams: {
64
- "blogpost-id": blogpostId,
65
- },
66
- headers: {
67
- "Content-Type": "application/json",
68
- },
69
- body: contentPropertyCreateRequest,
70
- })
71
- .then(this.getClientInstance().responseHandler({
72
- 200: {
73
- "application/json": "json",
74
- },
75
- }))
76
- .then(commonHttpClient.castResponse())
77
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createBlogpostProperty.response"))
78
- .then(commonHttpClient.getBody);
79
- }
80
- /**
81
- * Creates a new content property for a comment.
82
- *
83
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
84
- * Permission to update the comment.
85
- *
86
- * @returns Returned if the content property was created successfully.
87
- * @path {POST} /comments/{comment-id}/properties
88
- * @scopes-current read:comment:confluence, write:comment:confluence
89
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-post
90
- */
91
- createCommentProperty({ commentId, contentPropertyCreateRequest, }) {
92
- return this.getClientInstance()
93
- .request({
94
- path: "/comments/{comment-id}/properties",
95
- method: "POST",
96
- pathParams: {
97
- "comment-id": commentId,
98
- },
99
- headers: {
100
- "Content-Type": "application/json",
101
- },
102
- body: contentPropertyCreateRequest,
103
- })
104
- .then(this.getClientInstance().responseHandler({
105
- 200: {
106
- "application/json": "json",
107
- },
108
- }))
109
- .then(commonHttpClient.castResponse())
110
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createCommentProperty.response"))
111
- .then(commonHttpClient.getBody);
112
- }
113
- /**
114
- * Creates a new content property for a piece of custom content.
115
- *
116
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
117
- * Permission to update the custom content.
118
- *
119
- * @returns Returned if the content property was created successfully.
120
- * @path {POST} /custom-content/{custom-content-id}/properties
121
- * @scopes-current read:custom-content:confluence, write:custom-content:confluence
122
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-post
123
- */
124
- createCustomContentProperty({ customContentId, contentPropertyCreateRequest, }) {
125
- return this.getClientInstance()
126
- .request({
127
- path: "/custom-content/{custom-content-id}/properties",
128
- method: "POST",
129
- pathParams: {
130
- "custom-content-id": customContentId,
131
- },
132
- headers: {
133
- "Content-Type": "application/json",
134
- },
135
- body: contentPropertyCreateRequest,
136
- })
137
- .then(this.getClientInstance().responseHandler({
138
- 200: {
139
- "application/json": "json",
140
- },
141
- }))
142
- .then(commonHttpClient.castResponse())
143
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createCustomContentProperty.response"))
144
- .then(commonHttpClient.getBody);
145
- }
146
- /**
147
- * Creates a new content property for a database.
148
- *
149
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
150
- * Permission to update the database.
151
- *
152
- * @returns Returned if the content property was created successfully.
153
- * @path {POST} /databases/{id}/properties
154
- * @scopes-current read:database:confluence, write:database:confluence
155
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-post
156
- */
157
- createDatabaseProperty({ id, contentPropertyCreateRequest, }) {
158
- return this.getClientInstance()
159
- .request({
160
- path: "/databases/{id}/properties",
161
- method: "POST",
162
- pathParams: {
163
- id,
164
- },
165
- headers: {
166
- "Content-Type": "application/json",
167
- },
168
- body: contentPropertyCreateRequest,
169
- })
170
- .then(this.getClientInstance().responseHandler({
171
- 200: {
172
- "application/json": "json",
173
- },
174
- }))
175
- .then(commonHttpClient.castResponse())
176
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createDatabaseProperty.response"))
177
- .then(commonHttpClient.getBody);
178
- }
179
- /**
180
- * Creates a new content property for a page.
181
- *
182
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
183
- * Permission to update the page.
184
- *
185
- * @returns Returned if the content property was created successfully.
186
- * @path {POST} /pages/{page-id}/properties
187
- * @scopes-current read:page:confluence, write:page:confluence
188
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-post
189
- */
190
- createPageProperty({ pageId, contentPropertyCreateRequest, }) {
191
- return this.getClientInstance()
192
- .request({
193
- path: "/pages/{page-id}/properties",
194
- method: "POST",
195
- pathParams: {
196
- "page-id": pageId,
197
- },
198
- headers: {
199
- "Content-Type": "application/json",
200
- },
201
- body: contentPropertyCreateRequest,
202
- })
203
- .then(this.getClientInstance().responseHandler({
204
- 200: {
205
- "application/json": "json",
206
- },
207
- }))
208
- .then(commonHttpClient.castResponse())
209
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createPageProperty.response"))
210
- .then(commonHttpClient.getBody);
211
- }
212
- /**
213
- * Creates a new content property for a Smart Link in the content tree.
214
- *
215
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
216
- * Permission to update the Smart Link in the content tree.
217
- *
218
- * @returns Returned if the content property was created successfully.
219
- * @path {POST} /embeds/{id}/properties
220
- * @scopes-current read:embed:confluence, write:embed:confluence
221
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-post
222
- */
223
- createSmartLinkProperty({ id, contentPropertyCreateRequest, }) {
224
- return this.getClientInstance()
225
- .request({
226
- path: "/embeds/{id}/properties",
227
- method: "POST",
228
- pathParams: {
229
- id,
230
- },
231
- headers: {
232
- "Content-Type": "application/json",
233
- },
234
- body: contentPropertyCreateRequest,
235
- })
236
- .then(this.getClientInstance().responseHandler({
237
- 200: {
238
- "application/json": "json",
239
- },
240
- }))
241
- .then(commonHttpClient.castResponse())
242
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createSmartLinkProperty.response"))
243
- .then(commonHttpClient.getBody);
244
- }
245
- /**
246
- * Creates a new content property for a whiteboard.
247
- *
248
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
249
- * Permission to update the whiteboard.
250
- *
251
- * @returns Returned if the content property was created successfully.
252
- * @path {POST} /whiteboards/{id}/properties
253
- * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
254
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-post
255
- */
256
- createWhiteboardProperty({ id, contentPropertyCreateRequest, }) {
257
- return this.getClientInstance()
258
- .request({
259
- path: "/whiteboards/{id}/properties",
260
- method: "POST",
261
- pathParams: {
262
- id,
263
- },
264
- headers: {
265
- "Content-Type": "application/json",
266
- },
267
- body: contentPropertyCreateRequest,
268
- })
269
- .then(this.getClientInstance().responseHandler({
270
- 200: {
271
- "application/json": "json",
272
- },
273
- }))
274
- .then(commonHttpClient.castResponse())
275
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createWhiteboardProperty.response"))
276
- .then(commonHttpClient.getBody);
277
- }
278
- /**
279
- * Deletes a content property for an attachment by its id.
280
- *
281
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
282
- * Permission to attachment the page.
283
- *
284
- * @path {DELETE} /attachments/{attachment-id}/properties/{property-id}
285
- * @scopes-current read:attachment:confluence, write:attachment:confluence
286
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-delete
287
- */
288
- deleteAttachmentPropertyById({ attachmentId, propertyId, }) {
289
- return this.getClientInstance()
290
- .request({
291
- path: "/attachments/{attachment-id}/properties/{property-id}",
292
- method: "DELETE",
293
- pathParams: {
294
- "attachment-id": attachmentId,
295
- "property-id": propertyId,
296
- },
297
- })
298
- .then(commonHttpClient.discardResult);
299
- }
300
- /**
301
- * Deletes a content property for a blogpost by its id.
302
- *
303
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
304
- * Permission to edit the blog post.
305
- *
306
- * @path {DELETE} /blogposts/{blogpost-id}/properties/{property-id}
307
- * @scopes-current read:page:confluence, write:page:confluence
308
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-delete
309
- */
310
- deleteBlogpostPropertyById({ blogpostId, propertyId, }) {
311
- return this.getClientInstance()
312
- .request({
313
- path: "/blogposts/{blogpost-id}/properties/{property-id}",
314
- method: "DELETE",
315
- pathParams: {
316
- "blogpost-id": blogpostId,
317
- "property-id": propertyId,
318
- },
319
- })
320
- .then(commonHttpClient.discardResult);
321
- }
322
- /**
323
- * Deletes a content property for a comment by its id.
324
- *
325
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
326
- * Permission to edit the comment.
327
- *
328
- * @path {DELETE} /comments/{comment-id}/properties/{property-id}
329
- * @scopes-current read:comment:confluence, write:comment:confluence
330
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-delete
331
- */
332
- deleteCommentPropertyById({ commentId, propertyId, }) {
333
- return this.getClientInstance()
334
- .request({
335
- path: "/comments/{comment-id}/properties/{property-id}",
336
- method: "DELETE",
337
- pathParams: {
338
- "comment-id": commentId,
339
- "property-id": propertyId,
340
- },
341
- })
342
- .then(commonHttpClient.discardResult);
343
- }
344
- /**
345
- * Deletes a content property for a piece of custom content by its id.
346
- *
347
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
348
- * Permission to edit the custom content.
349
- *
350
- * @path {DELETE} /custom-content/{custom-content-id}/properties/{property-id}
351
- * @scopes-current read:custom-content:confluence, write:custom-content:confluence
352
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-delete
353
- */
354
- deleteCustomContentPropertyById({ customContentId, propertyId, }) {
355
- return this.getClientInstance()
356
- .request({
357
- path: "/custom-content/{custom-content-id}/properties/{property-id}",
358
- method: "DELETE",
359
- pathParams: {
360
- "custom-content-id": customContentId,
361
- "property-id": propertyId,
362
- },
363
- })
364
- .then(commonHttpClient.discardResult);
365
- }
366
- /**
367
- * Deletes a content property for a database by its id.
368
- *
369
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
370
- * Permission to edit the database.
371
- *
372
- * @path {DELETE} /databases/{database-id}/properties/{property-id}
373
- * @scopes-current read:database:confluence, write:database:confluence
374
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-delete
375
- */
376
- deleteDatabasePropertyById({ databaseId, propertyId, }) {
377
- return this.getClientInstance()
378
- .request({
379
- path: "/databases/{database-id}/properties/{property-id}",
380
- method: "DELETE",
381
- pathParams: {
382
- "database-id": databaseId,
383
- "property-id": propertyId,
384
- },
385
- })
386
- .then(commonHttpClient.discardResult);
387
- }
388
- /**
389
- * Deletes a content property for a page by its id.
390
- *
391
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
392
- * Permission to edit the page.
393
- *
394
- * @path {DELETE} /pages/{page-id}/properties/{property-id}
395
- * @scopes-current read:page:confluence, write:page:confluence
396
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-delete
397
- */
398
- deletePagePropertyById({ pageId, propertyId, }) {
399
- return this.getClientInstance()
400
- .request({
401
- path: "/pages/{page-id}/properties/{property-id}",
402
- method: "DELETE",
403
- pathParams: {
404
- "page-id": pageId,
405
- "property-id": propertyId,
406
- },
407
- })
408
- .then(commonHttpClient.discardResult);
409
- }
410
- /**
411
- * Deletes a content property for a Smart Link in the content tree by its id.
412
- *
413
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
414
- * Permission to edit the Smart Link in the content tree.
415
- *
416
- * @path {DELETE} /embeds/{embed-id}/properties/{property-id}
417
- * @scopes-current read:embed:confluence, write:embed:confluence
418
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-delete
419
- */
420
- deleteSmartLinkPropertyById({ embedId, propertyId, }) {
421
- return this.getClientInstance()
422
- .request({
423
- path: "/embeds/{embed-id}/properties/{property-id}",
424
- method: "DELETE",
425
- pathParams: {
426
- "embed-id": embedId,
427
- "property-id": propertyId,
428
- },
429
- })
430
- .then(commonHttpClient.discardResult);
431
- }
432
- /**
433
- * Deletes a content property for a whiteboard by its id.
434
- *
435
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
436
- * Permission to edit the whiteboard.
437
- *
438
- * @path {DELETE} /whiteboards/{whiteboard-id}/properties/{property-id}
439
- * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
440
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-delete
441
- */
442
- deleteWhiteboardPropertyById({ whiteboardId, propertyId, }) {
443
- return this.getClientInstance()
444
- .request({
445
- path: "/whiteboards/{whiteboard-id}/properties/{property-id}",
446
- method: "DELETE",
447
- pathParams: {
448
- "whiteboard-id": whiteboardId,
449
- "property-id": propertyId,
450
- },
451
- })
452
- .then(commonHttpClient.discardResult);
453
- }
454
- /**
455
- * Retrieves all Content Properties tied to a specified attachment.
456
- *
457
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
458
- * Permission to view the attachment.
459
- *
460
- * @returns Returned if the requested content properties are successfully retrieved.
461
- * @path {GET} /attachments/{attachment-id}/properties
462
- * @scopes-current read:attachment:confluence
463
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-get
464
- */
465
- getAttachmentContentProperties({ attachmentId, key, sort, cursor, limit, }) {
466
- return this.getClientInstance()
467
- .request({
468
- path: "/attachments/{attachment-id}/properties",
469
- method: "GET",
470
- pathParams: {
471
- "attachment-id": attachmentId,
472
- },
473
- query: {
474
- key,
475
- sort,
476
- cursor,
477
- limit,
478
- },
479
- })
480
- .then(this.getClientInstance().responseHandler({
481
- 200: {
482
- "application/json": "json",
483
- },
484
- }))
485
- .then(commonHttpClient.castResponse())
486
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getAttachmentContentProperties.response"))
487
- .then(commonHttpClient.getBody);
488
- }
489
- /**
490
- * Retrieves a specific Content Property by ID that is attached to a specified
491
- * attachment.
492
- *
493
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
494
- * Permission to view the attachment.
495
- *
496
- * @returns Returned if the requested content property is successfully retrieved.
497
- * @path {GET} /attachments/{attachment-id}/properties/{property-id}
498
- * @scopes-current read:attachment:confluence
499
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-get
500
- */
501
- getAttachmentContentPropertiesById({ attachmentId, propertyId, }) {
502
- return this.getClientInstance()
503
- .request({
504
- path: "/attachments/{attachment-id}/properties/{property-id}",
505
- method: "GET",
506
- pathParams: {
507
- "attachment-id": attachmentId,
508
- "property-id": propertyId,
509
- },
510
- })
511
- .then(this.getClientInstance().responseHandler({
512
- 200: {
513
- "application/json": "json",
514
- },
515
- }))
516
- .then(commonHttpClient.castResponse())
517
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getAttachmentContentPropertiesById.response"))
518
- .then(commonHttpClient.getBody);
519
- }
520
- /**
521
- * Retrieves all Content Properties tied to a specified blog post.
522
- *
523
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
524
- * Permission to view the blog post.
525
- *
526
- * @returns Returned if the requested content properties are successfully retrieved.
527
- * @path {GET} /blogposts/{blogpost-id}/properties
528
- * @scopes-current read:page:confluence
529
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-get
530
- */
531
- getBlogpostContentProperties({ blogpostId, key, sort, cursor, limit, }) {
532
- return this.getClientInstance()
533
- .request({
534
- path: "/blogposts/{blogpost-id}/properties",
535
- method: "GET",
536
- pathParams: {
537
- "blogpost-id": blogpostId,
538
- },
539
- query: {
540
- key,
541
- sort,
542
- cursor,
543
- limit,
544
- },
545
- })
546
- .then(this.getClientInstance().responseHandler({
547
- 200: {
548
- "application/json": "json",
549
- },
550
- }))
551
- .then(commonHttpClient.castResponse())
552
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getBlogpostContentProperties.response"))
553
- .then(commonHttpClient.getBody);
554
- }
555
- /**
556
- * Retrieves a specific Content Property by ID that is attached to a specified
557
- * blog post.
558
- *
559
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
560
- * Permission to view the blog post.
561
- *
562
- * @returns Returned if the requested content property is successfully retrieved.
563
- * @path {GET} /blogposts/{blogpost-id}/properties/{property-id}
564
- * @scopes-current read:page:confluence
565
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-get
566
- */
567
- getBlogpostContentPropertiesById({ blogpostId, propertyId, }) {
568
- return this.getClientInstance()
569
- .request({
570
- path: "/blogposts/{blogpost-id}/properties/{property-id}",
571
- method: "GET",
572
- pathParams: {
573
- "blogpost-id": blogpostId,
574
- "property-id": propertyId,
575
- },
576
- })
577
- .then(this.getClientInstance().responseHandler({
578
- 200: {
579
- "application/json": "json",
580
- },
581
- }))
582
- .then(commonHttpClient.castResponse())
583
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getBlogpostContentPropertiesById.response"))
584
- .then(commonHttpClient.getBody);
585
- }
586
- /**
587
- * Retrieves Content Properties attached to a specified comment.
588
- *
589
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
590
- * Permission to view the comment.
591
- *
592
- * @returns Returned if the requested content properties are successfully retrieved.
593
- * @path {GET} /comments/{comment-id}/properties
594
- * @scopes-current read:comment:confluence
595
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-get
596
- */
597
- getCommentContentProperties({ commentId, key, sort, cursor, limit, }) {
598
- return this.getClientInstance()
599
- .request({
600
- path: "/comments/{comment-id}/properties",
601
- method: "GET",
602
- pathParams: {
603
- "comment-id": commentId,
604
- },
605
- query: {
606
- key,
607
- sort,
608
- cursor,
609
- limit,
610
- },
611
- })
612
- .then(this.getClientInstance().responseHandler({
613
- 200: {
614
- "application/json": "json",
615
- },
616
- }))
617
- .then(commonHttpClient.castResponse())
618
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCommentContentProperties.response"))
619
- .then(commonHttpClient.getBody);
620
- }
621
- /**
622
- * Retrieves a specific Content Property by ID that is attached to a specified
623
- * comment.
624
- *
625
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
626
- * Permission to view the comment.
627
- *
628
- * @returns Returned if the requested content property is successfully retrieved.
629
- * @path {GET} /comments/{comment-id}/properties/{property-id}
630
- * @scopes-current read:comment:confluence
631
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-get
632
- */
633
- getCommentContentPropertiesById({ commentId, propertyId, }) {
634
- return this.getClientInstance()
635
- .request({
636
- path: "/comments/{comment-id}/properties/{property-id}",
637
- method: "GET",
638
- pathParams: {
639
- "comment-id": commentId,
640
- "property-id": propertyId,
641
- },
642
- })
643
- .then(this.getClientInstance().responseHandler({
644
- 200: {
645
- "application/json": "json",
646
- },
647
- }))
648
- .then(commonHttpClient.castResponse())
649
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCommentContentPropertiesById.response"))
650
- .then(commonHttpClient.getBody);
651
- }
652
- /**
653
- * Retrieves Content Properties tied to a specified custom content.
654
- *
655
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
656
- * Permission to view the custom content.
657
- *
658
- * @returns Returned if the requested content properties are successfully retrieved.
659
- * @path {GET} /custom-content/{custom-content-id}/properties
660
- * @scopes-current read:custom-content:confluence
661
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-get
662
- */
663
- getCustomContentContentProperties({ customContentId, key, sort, cursor, limit, }) {
664
- return this.getClientInstance()
665
- .request({
666
- path: "/custom-content/{custom-content-id}/properties",
667
- method: "GET",
668
- pathParams: {
669
- "custom-content-id": customContentId,
670
- },
671
- query: {
672
- key,
673
- sort,
674
- cursor,
675
- limit,
676
- },
677
- })
678
- .then(this.getClientInstance().responseHandler({
679
- 200: {
680
- "application/json": "json",
681
- },
682
- }))
683
- .then(commonHttpClient.castResponse())
684
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCustomContentContentProperties.response"))
685
- .then(commonHttpClient.getBody);
686
- }
687
- /**
688
- * Retrieves a specific Content Property by ID that is attached to a specified
689
- * custom content.
690
- *
691
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
692
- * Permission to view the page.
693
- *
694
- * @returns Returned if the requested content property is successfully retrieved.
695
- * @path {GET} /custom-content/{custom-content-id}/properties/{property-id}
696
- * @scopes-current read:custom-content:confluence
697
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-get
698
- */
699
- getCustomContentContentPropertiesById({ customContentId, propertyId, }) {
700
- return this.getClientInstance()
701
- .request({
702
- path: "/custom-content/{custom-content-id}/properties/{property-id}",
703
- method: "GET",
704
- pathParams: {
705
- "custom-content-id": customContentId,
706
- "property-id": propertyId,
707
- },
708
- })
709
- .then(this.getClientInstance().responseHandler({
710
- 200: {
711
- "application/json": "json",
712
- },
713
- }))
714
- .then(commonHttpClient.castResponse())
715
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCustomContentContentPropertiesById.response"))
716
- .then(commonHttpClient.getBody);
717
- }
718
- /**
719
- * Retrieves Content Properties tied to a specified database.
720
- *
721
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
722
- * Permission to view the database.
723
- *
724
- * @returns Returned if the requested content properties are successfully retrieved.
725
- * @path {GET} /databases/{id}/properties
726
- * @scopes-current read:database:confluence
727
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-get
728
- */
729
- getDatabaseContentProperties({ id, key, sort, cursor, limit, }) {
730
- return this.getClientInstance()
731
- .request({
732
- path: "/databases/{id}/properties",
733
- method: "GET",
734
- pathParams: {
735
- id,
736
- },
737
- query: {
738
- key,
739
- sort,
740
- cursor,
741
- limit,
742
- },
743
- })
744
- .then(this.getClientInstance().responseHandler({
745
- 200: {
746
- "application/json": "json",
747
- },
748
- }))
749
- .then(commonHttpClient.castResponse())
750
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getDatabaseContentProperties.response"))
751
- .then(commonHttpClient.getBody);
752
- }
753
- /**
754
- * Retrieves a specific Content Property by ID that is attached to a specified
755
- * database.
756
- *
757
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
758
- * Permission to view the database.
759
- *
760
- * @returns Returned if the requested content property is successfully retrieved.
761
- * @path {GET} /databases/{database-id}/properties/{property-id}
762
- * @scopes-current read:database:confluence
763
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-get
764
- */
765
- getDatabaseContentPropertiesById({ databaseId, propertyId, }) {
766
- return this.getClientInstance()
767
- .request({
768
- path: "/databases/{database-id}/properties/{property-id}",
769
- method: "GET",
770
- pathParams: {
771
- "database-id": databaseId,
772
- "property-id": propertyId,
773
- },
774
- })
775
- .then(this.getClientInstance().responseHandler({
776
- 200: {
777
- "application/json": "json",
778
- },
779
- }))
780
- .then(commonHttpClient.castResponse())
781
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getDatabaseContentPropertiesById.response"))
782
- .then(commonHttpClient.getBody);
783
- }
784
- /**
785
- * Retrieves Content Properties tied to a specified page.
786
- *
787
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
788
- * Permission to view the page.
789
- *
790
- * @returns Returned if the requested content properties are successfully retrieved.
791
- * @path {GET} /pages/{page-id}/properties
792
- * @scopes-current read:page:confluence
793
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-get
794
- */
795
- getPageContentProperties({ pageId, key, sort, cursor, limit, }) {
796
- return this.getClientInstance()
797
- .request({
798
- path: "/pages/{page-id}/properties",
799
- method: "GET",
800
- pathParams: {
801
- "page-id": pageId,
802
- },
803
- query: {
804
- key,
805
- sort,
806
- cursor,
807
- limit,
808
- },
809
- })
810
- .then(this.getClientInstance().responseHandler({
811
- 200: {
812
- "application/json": "json",
813
- },
814
- }))
815
- .then(commonHttpClient.castResponse())
816
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getPageContentProperties.response"))
817
- .then(commonHttpClient.getBody);
818
- }
819
- /**
820
- * Retrieves a specific Content Property by ID that is attached to a specified
821
- * page.
822
- *
823
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
824
- * Permission to view the page.
825
- *
826
- * @returns Returned if the requested content property is successfully retrieved.
827
- * @path {GET} /pages/{page-id}/properties/{property-id}
828
- * @scopes-current read:page:confluence
829
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-get
830
- */
831
- getPageContentPropertiesById({ pageId, propertyId, }) {
832
- return this.getClientInstance()
833
- .request({
834
- path: "/pages/{page-id}/properties/{property-id}",
835
- method: "GET",
836
- pathParams: {
837
- "page-id": pageId,
838
- "property-id": propertyId,
839
- },
840
- })
841
- .then(this.getClientInstance().responseHandler({
842
- 200: {
843
- "application/json": "json",
844
- },
845
- }))
846
- .then(commonHttpClient.castResponse())
847
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getPageContentPropertiesById.response"))
848
- .then(commonHttpClient.getBody);
849
- }
850
- /**
851
- * Retrieves Content Properties tied to a specified Smart Link in the content tree.
852
- *
853
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
854
- * Permission to view the Smart Link in the content tree.
855
- *
856
- * @returns Returned if the requested content properties are successfully retrieved.
857
- * @path {GET} /embeds/{id}/properties
858
- * @scopes-current read:embed:confluence
859
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-get
860
- */
861
- getSmartLinkContentProperties({ id, key, sort, cursor, limit, }) {
862
- return this.getClientInstance()
863
- .request({
864
- path: "/embeds/{id}/properties",
865
- method: "GET",
866
- pathParams: {
867
- id,
868
- },
869
- query: {
870
- key,
871
- sort,
872
- cursor,
873
- limit,
874
- },
875
- })
876
- .then(this.getClientInstance().responseHandler({
877
- 200: {
878
- "application/json": "json",
879
- },
880
- }))
881
- .then(commonHttpClient.castResponse())
882
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getSmartLinkContentProperties.response"))
883
- .then(commonHttpClient.getBody);
884
- }
885
- /**
886
- * Retrieves a specific Content Property by ID that is attached to a specified
887
- * Smart Link in the content tree.
888
- *
889
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
890
- * Permission to view the Smart Link in the content tree.
891
- *
892
- * @returns Returned if the requested content property is successfully retrieved.
893
- * @path {GET} /embeds/{embed-id}/properties/{property-id}
894
- * @scopes-current read:embed:confluence
895
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-get
896
- */
897
- getSmartLinkContentPropertiesById({ embedId, propertyId, }) {
898
- return this.getClientInstance()
899
- .request({
900
- path: "/embeds/{embed-id}/properties/{property-id}",
901
- method: "GET",
902
- pathParams: {
903
- "embed-id": embedId,
904
- "property-id": propertyId,
905
- },
906
- })
907
- .then(this.getClientInstance().responseHandler({
908
- 200: {
909
- "application/json": "json",
910
- },
911
- }))
912
- .then(commonHttpClient.castResponse())
913
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getSmartLinkContentPropertiesById.response"))
914
- .then(commonHttpClient.getBody);
915
- }
916
- /**
917
- * Retrieves Content Properties tied to a specified whiteboard.
918
- *
919
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
920
- * Permission to view the whiteboard.
921
- *
922
- * @returns Returned if the requested content properties are successfully retrieved.
923
- * @path {GET} /whiteboards/{id}/properties
924
- * @scopes-current read:whiteboard:confluence
925
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-get
926
- */
927
- getWhiteboardContentProperties({ id, key, sort, cursor, limit, }) {
928
- return this.getClientInstance()
929
- .request({
930
- path: "/whiteboards/{id}/properties",
931
- method: "GET",
932
- pathParams: {
933
- id,
934
- },
935
- query: {
936
- key,
937
- sort,
938
- cursor,
939
- limit,
940
- },
941
- })
942
- .then(this.getClientInstance().responseHandler({
943
- 200: {
944
- "application/json": "json",
945
- },
946
- }))
947
- .then(commonHttpClient.castResponse())
948
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getWhiteboardContentProperties.response"))
949
- .then(commonHttpClient.getBody);
950
- }
951
- /**
952
- * Retrieves a specific Content Property by ID that is attached to a specified
953
- * whiteboard.
954
- *
955
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
956
- * Permission to view the whiteboard.
957
- *
958
- * @returns Returned if the requested content property is successfully retrieved.
959
- * @path {GET} /whiteboards/{whiteboard-id}/properties/{property-id}
960
- * @scopes-current read:whiteboard:confluence
961
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-get
962
- */
963
- getWhiteboardContentPropertiesById({ whiteboardId, propertyId, }) {
964
- return this.getClientInstance()
965
- .request({
966
- path: "/whiteboards/{whiteboard-id}/properties/{property-id}",
967
- method: "GET",
968
- pathParams: {
969
- "whiteboard-id": whiteboardId,
970
- "property-id": propertyId,
971
- },
972
- })
973
- .then(this.getClientInstance().responseHandler({
974
- 200: {
975
- "application/json": "json",
976
- },
977
- }))
978
- .then(commonHttpClient.castResponse())
979
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getWhiteboardContentPropertiesById.response"))
980
- .then(commonHttpClient.getBody);
981
- }
982
- /**
983
- * Update a content property for attachment by its id.
984
- *
985
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
986
- * Permission to edit the attachment.
987
- *
988
- * @returns Returned if the content property was updated successfully.
989
- * @path {PUT} /attachments/{attachment-id}/properties/{property-id}
990
- * @scopes-current read:attachment:confluence, write:attachment:confluence
991
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-put
992
- */
993
- updateAttachmentPropertyById({ attachmentId, propertyId, contentPropertyUpdateRequest, }) {
994
- return this.getClientInstance()
995
- .request({
996
- path: "/attachments/{attachment-id}/properties/{property-id}",
997
- method: "PUT",
998
- pathParams: {
999
- "attachment-id": attachmentId,
1000
- "property-id": propertyId,
1001
- },
1002
- headers: {
1003
- "Content-Type": "application/json",
1004
- },
1005
- body: contentPropertyUpdateRequest,
1006
- })
1007
- .then(this.getClientInstance().responseHandler({
1008
- 200: {
1009
- "application/json": "json",
1010
- },
1011
- }))
1012
- .then(commonHttpClient.castResponse())
1013
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateAttachmentPropertyById.response"))
1014
- .then(commonHttpClient.getBody);
1015
- }
1016
- /**
1017
- * Update a content property for blog post by its id.
1018
- *
1019
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1020
- * Permission to edit the blog post.
1021
- *
1022
- * @returns Returned if the content property was updated successfully.
1023
- * @path {PUT} /blogposts/{blogpost-id}/properties/{property-id}
1024
- * @scopes-current read:page:confluence, write:page:confluence
1025
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-put
1026
- */
1027
- updateBlogpostPropertyById({ blogpostId, propertyId, contentPropertyUpdateRequest, }) {
1028
- return this.getClientInstance()
1029
- .request({
1030
- path: "/blogposts/{blogpost-id}/properties/{property-id}",
1031
- method: "PUT",
1032
- pathParams: {
1033
- "blogpost-id": blogpostId,
1034
- "property-id": propertyId,
1035
- },
1036
- headers: {
1037
- "Content-Type": "application/json",
1038
- },
1039
- body: contentPropertyUpdateRequest,
1040
- })
1041
- .then(this.getClientInstance().responseHandler({
1042
- 200: {
1043
- "application/json": "json",
1044
- },
1045
- }))
1046
- .then(commonHttpClient.castResponse())
1047
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateBlogpostPropertyById.response"))
1048
- .then(commonHttpClient.getBody);
1049
- }
1050
- /**
1051
- * Update a content property for a comment by its id.
1052
- *
1053
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1054
- * Permission to edit the comment.
1055
- *
1056
- * @returns Returned if the content property was updated successfully.
1057
- * @path {PUT} /comments/{comment-id}/properties/{property-id}
1058
- * @scopes-current read:comment:confluence, write:comment:confluence
1059
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-put
1060
- */
1061
- updateCommentPropertyById({ commentId, propertyId, contentPropertyUpdateRequest, }) {
1062
- return this.getClientInstance()
1063
- .request({
1064
- path: "/comments/{comment-id}/properties/{property-id}",
1065
- method: "PUT",
1066
- pathParams: {
1067
- "comment-id": commentId,
1068
- "property-id": propertyId,
1069
- },
1070
- headers: {
1071
- "Content-Type": "application/json",
1072
- },
1073
- body: contentPropertyUpdateRequest,
1074
- })
1075
- .then(this.getClientInstance().responseHandler({
1076
- 200: {
1077
- "application/json": "json",
1078
- },
1079
- }))
1080
- .then(commonHttpClient.castResponse())
1081
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateCommentPropertyById.response"))
1082
- .then(commonHttpClient.getBody);
1083
- }
1084
- /**
1085
- * Update a content property for a piece of custom content by its id.
1086
- *
1087
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1088
- * Permission to edit the custom content.
1089
- *
1090
- * @returns Returned if the content property was updated successfully.
1091
- * @path {PUT} /custom-content/{custom-content-id}/properties/{property-id}
1092
- * @scopes-current read:custom-content:confluence, write:custom-content:confluence
1093
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-put
1094
- */
1095
- updateCustomContentPropertyById({ customContentId, propertyId, contentPropertyUpdateRequest, }) {
1096
- return this.getClientInstance()
1097
- .request({
1098
- path: "/custom-content/{custom-content-id}/properties/{property-id}",
1099
- method: "PUT",
1100
- pathParams: {
1101
- "custom-content-id": customContentId,
1102
- "property-id": propertyId,
1103
- },
1104
- headers: {
1105
- "Content-Type": "application/json",
1106
- },
1107
- body: contentPropertyUpdateRequest,
1108
- })
1109
- .then(this.getClientInstance().responseHandler({
1110
- 200: {
1111
- "application/json": "json",
1112
- },
1113
- }))
1114
- .then(commonHttpClient.castResponse())
1115
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateCustomContentPropertyById.response"))
1116
- .then(commonHttpClient.getBody);
1117
- }
1118
- /**
1119
- * Update a content property for a database by its id.
1120
- *
1121
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1122
- * Permission to edit the database.
1123
- *
1124
- * @returns Returned if the content property was updated successfully.
1125
- * @path {PUT} /databases/{database-id}/properties/{property-id}
1126
- * @scopes-current read:database:confluence, write:database:confluence
1127
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-put
1128
- */
1129
- updateDatabasePropertyById({ databaseId, propertyId, contentPropertyUpdateRequest, }) {
1130
- return this.getClientInstance()
1131
- .request({
1132
- path: "/databases/{database-id}/properties/{property-id}",
1133
- method: "PUT",
1134
- pathParams: {
1135
- "database-id": databaseId,
1136
- "property-id": propertyId,
1137
- },
1138
- headers: {
1139
- "Content-Type": "application/json",
1140
- },
1141
- body: contentPropertyUpdateRequest,
1142
- })
1143
- .then(this.getClientInstance().responseHandler({
1144
- 200: {
1145
- "application/json": "json",
1146
- },
1147
- }))
1148
- .then(commonHttpClient.castResponse())
1149
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateDatabasePropertyById.response"))
1150
- .then(commonHttpClient.getBody);
1151
- }
1152
- /**
1153
- * Update a content property for a page by its id.
1154
- *
1155
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1156
- * Permission to edit the page.
1157
- *
1158
- * @returns Returned if the content property was updated successfully.
1159
- * @path {PUT} /pages/{page-id}/properties/{property-id}
1160
- * @scopes-current read:page:confluence, write:page:confluence
1161
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-put
1162
- */
1163
- updatePagePropertyById({ pageId, propertyId, contentPropertyUpdateRequest, }) {
1164
- return this.getClientInstance()
1165
- .request({
1166
- path: "/pages/{page-id}/properties/{property-id}",
1167
- method: "PUT",
1168
- pathParams: {
1169
- "page-id": pageId,
1170
- "property-id": propertyId,
1171
- },
1172
- headers: {
1173
- "Content-Type": "application/json",
1174
- },
1175
- body: contentPropertyUpdateRequest,
1176
- })
1177
- .then(this.getClientInstance().responseHandler({
1178
- 200: {
1179
- "application/json": "json",
1180
- },
1181
- }))
1182
- .then(commonHttpClient.castResponse())
1183
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updatePagePropertyById.response"))
1184
- .then(commonHttpClient.getBody);
1185
- }
1186
- /**
1187
- * Update a content property for a Smart Link in the content tree by its id.
1188
- *
1189
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1190
- * Permission to edit the Smart Link in the content tree.
1191
- *
1192
- * @returns Returned if the content property was updated successfully.
1193
- * @path {PUT} /embeds/{embed-id}/properties/{property-id}
1194
- * @scopes-current read:embed:confluence, write:embed:confluence
1195
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-put
1196
- */
1197
- updateSmartLinkPropertyById({ embedId, propertyId, contentPropertyUpdateRequest, }) {
1198
- return this.getClientInstance()
1199
- .request({
1200
- path: "/embeds/{embed-id}/properties/{property-id}",
1201
- method: "PUT",
1202
- pathParams: {
1203
- "embed-id": embedId,
1204
- "property-id": propertyId,
1205
- },
1206
- headers: {
1207
- "Content-Type": "application/json",
1208
- },
1209
- body: contentPropertyUpdateRequest,
1210
- })
1211
- .then(this.getClientInstance().responseHandler({
1212
- 200: {
1213
- "application/json": "json",
1214
- },
1215
- }))
1216
- .then(commonHttpClient.castResponse())
1217
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateSmartLinkPropertyById.response"))
1218
- .then(commonHttpClient.getBody);
1219
- }
1220
- /**
1221
- * Update a content property for a whiteboard by its id.
1222
- *
1223
- * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1224
- * Permission to edit the whiteboard.
1225
- *
1226
- * @returns Returned if the content property was updated successfully.
1227
- * @path {PUT} /whiteboards/{whiteboard-id}/properties/{property-id}
1228
- * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
1229
- * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-put
1230
- */
1231
- updateWhiteboardPropertyById({ whiteboardId, propertyId, contentPropertyUpdateRequest, }) {
1232
- return this.getClientInstance()
1233
- .request({
1234
- path: "/whiteboards/{whiteboard-id}/properties/{property-id}",
1235
- method: "PUT",
1236
- pathParams: {
1237
- "whiteboard-id": whiteboardId,
1238
- "property-id": propertyId,
1239
- },
1240
- headers: {
1241
- "Content-Type": "application/json",
1242
- },
1243
- body: contentPropertyUpdateRequest,
1244
- })
1245
- .then(this.getClientInstance().responseHandler({
1246
- 200: {
1247
- "application/json": "json",
1248
- },
1249
- }))
1250
- .then(commonHttpClient.castResponse())
1251
- .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateWhiteboardPropertyById.response"))
1252
- .then(commonHttpClient.getBody);
14
+ constructor() {
15
+ super(...arguments);
16
+ /**
17
+ * Creates a new content property for an attachment.
18
+ *
19
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
20
+ * Permission to update the attachment.
21
+ *
22
+ * @returns Returned if the content property was created successfully.
23
+ * @path {POST} /attachments/{attachment-id}/properties
24
+ * @scopes-current read:attachment:confluence, write:attachment:confluence
25
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-post
26
+ */
27
+ this.createAttachmentProperty = ({ attachmentId, contentPropertyCreateRequest, }) => {
28
+ return this.getClientInstance()
29
+ .request({
30
+ path: "/attachments/{attachment-id}/properties",
31
+ method: "POST",
32
+ pathParams: {
33
+ "attachment-id": attachmentId,
34
+ },
35
+ headers: {
36
+ "Content-Type": "application/json",
37
+ },
38
+ body: contentPropertyCreateRequest,
39
+ })
40
+ .then(this.getClientInstance().responseHandler({
41
+ 200: {
42
+ "application/json": "json",
43
+ },
44
+ }))
45
+ .then(commonHttpClient.castResponse())
46
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createAttachmentProperty.response"))
47
+ .then(commonHttpClient.getBody);
48
+ };
49
+ /**
50
+ * Creates a new property for a blogpost.
51
+ *
52
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
53
+ * Permission to update the blog post.
54
+ *
55
+ * @returns Returned if the content property was created successfully.
56
+ * @path {POST} /blogposts/{blogpost-id}/properties
57
+ * @scopes-current read:page:confluence, write:page:confluence
58
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-post
59
+ */
60
+ this.createBlogpostProperty = ({ blogpostId, contentPropertyCreateRequest, }) => {
61
+ return this.getClientInstance()
62
+ .request({
63
+ path: "/blogposts/{blogpost-id}/properties",
64
+ method: "POST",
65
+ pathParams: {
66
+ "blogpost-id": blogpostId,
67
+ },
68
+ headers: {
69
+ "Content-Type": "application/json",
70
+ },
71
+ body: contentPropertyCreateRequest,
72
+ })
73
+ .then(this.getClientInstance().responseHandler({
74
+ 200: {
75
+ "application/json": "json",
76
+ },
77
+ }))
78
+ .then(commonHttpClient.castResponse())
79
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createBlogpostProperty.response"))
80
+ .then(commonHttpClient.getBody);
81
+ };
82
+ /**
83
+ * Creates a new content property for a comment.
84
+ *
85
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
86
+ * Permission to update the comment.
87
+ *
88
+ * @returns Returned if the content property was created successfully.
89
+ * @path {POST} /comments/{comment-id}/properties
90
+ * @scopes-current read:comment:confluence, write:comment:confluence
91
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-post
92
+ */
93
+ this.createCommentProperty = ({ commentId, contentPropertyCreateRequest, }) => {
94
+ return this.getClientInstance()
95
+ .request({
96
+ path: "/comments/{comment-id}/properties",
97
+ method: "POST",
98
+ pathParams: {
99
+ "comment-id": commentId,
100
+ },
101
+ headers: {
102
+ "Content-Type": "application/json",
103
+ },
104
+ body: contentPropertyCreateRequest,
105
+ })
106
+ .then(this.getClientInstance().responseHandler({
107
+ 200: {
108
+ "application/json": "json",
109
+ },
110
+ }))
111
+ .then(commonHttpClient.castResponse())
112
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createCommentProperty.response"))
113
+ .then(commonHttpClient.getBody);
114
+ };
115
+ /**
116
+ * Creates a new content property for a piece of custom content.
117
+ *
118
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
119
+ * Permission to update the custom content.
120
+ *
121
+ * @returns Returned if the content property was created successfully.
122
+ * @path {POST} /custom-content/{custom-content-id}/properties
123
+ * @scopes-current read:custom-content:confluence, write:custom-content:confluence
124
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-post
125
+ */
126
+ this.createCustomContentProperty = ({ customContentId, contentPropertyCreateRequest, }) => {
127
+ return this.getClientInstance()
128
+ .request({
129
+ path: "/custom-content/{custom-content-id}/properties",
130
+ method: "POST",
131
+ pathParams: {
132
+ "custom-content-id": customContentId,
133
+ },
134
+ headers: {
135
+ "Content-Type": "application/json",
136
+ },
137
+ body: contentPropertyCreateRequest,
138
+ })
139
+ .then(this.getClientInstance().responseHandler({
140
+ 200: {
141
+ "application/json": "json",
142
+ },
143
+ }))
144
+ .then(commonHttpClient.castResponse())
145
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createCustomContentProperty.response"))
146
+ .then(commonHttpClient.getBody);
147
+ };
148
+ /**
149
+ * Creates a new content property for a database.
150
+ *
151
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
152
+ * Permission to update the database.
153
+ *
154
+ * @returns Returned if the content property was created successfully.
155
+ * @path {POST} /databases/{id}/properties
156
+ * @scopes-current read:database:confluence, write:database:confluence
157
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-post
158
+ */
159
+ this.createDatabaseProperty = ({ id, contentPropertyCreateRequest, }) => {
160
+ return this.getClientInstance()
161
+ .request({
162
+ path: "/databases/{id}/properties",
163
+ method: "POST",
164
+ pathParams: {
165
+ id,
166
+ },
167
+ headers: {
168
+ "Content-Type": "application/json",
169
+ },
170
+ body: contentPropertyCreateRequest,
171
+ })
172
+ .then(this.getClientInstance().responseHandler({
173
+ 200: {
174
+ "application/json": "json",
175
+ },
176
+ }))
177
+ .then(commonHttpClient.castResponse())
178
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createDatabaseProperty.response"))
179
+ .then(commonHttpClient.getBody);
180
+ };
181
+ /**
182
+ * Creates a new content property for a page.
183
+ *
184
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
185
+ * Permission to update the page.
186
+ *
187
+ * @returns Returned if the content property was created successfully.
188
+ * @path {POST} /pages/{page-id}/properties
189
+ * @scopes-current read:page:confluence, write:page:confluence
190
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-post
191
+ */
192
+ this.createPageProperty = ({ pageId, contentPropertyCreateRequest, }) => {
193
+ return this.getClientInstance()
194
+ .request({
195
+ path: "/pages/{page-id}/properties",
196
+ method: "POST",
197
+ pathParams: {
198
+ "page-id": pageId,
199
+ },
200
+ headers: {
201
+ "Content-Type": "application/json",
202
+ },
203
+ body: contentPropertyCreateRequest,
204
+ })
205
+ .then(this.getClientInstance().responseHandler({
206
+ 200: {
207
+ "application/json": "json",
208
+ },
209
+ }))
210
+ .then(commonHttpClient.castResponse())
211
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createPageProperty.response"))
212
+ .then(commonHttpClient.getBody);
213
+ };
214
+ /**
215
+ * Creates a new content property for a Smart Link in the content tree.
216
+ *
217
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
218
+ * Permission to update the Smart Link in the content tree.
219
+ *
220
+ * @returns Returned if the content property was created successfully.
221
+ * @path {POST} /embeds/{id}/properties
222
+ * @scopes-current read:embed:confluence, write:embed:confluence
223
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-post
224
+ */
225
+ this.createSmartLinkProperty = ({ id, contentPropertyCreateRequest, }) => {
226
+ return this.getClientInstance()
227
+ .request({
228
+ path: "/embeds/{id}/properties",
229
+ method: "POST",
230
+ pathParams: {
231
+ id,
232
+ },
233
+ headers: {
234
+ "Content-Type": "application/json",
235
+ },
236
+ body: contentPropertyCreateRequest,
237
+ })
238
+ .then(this.getClientInstance().responseHandler({
239
+ 200: {
240
+ "application/json": "json",
241
+ },
242
+ }))
243
+ .then(commonHttpClient.castResponse())
244
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createSmartLinkProperty.response"))
245
+ .then(commonHttpClient.getBody);
246
+ };
247
+ /**
248
+ * Creates a new content property for a whiteboard.
249
+ *
250
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
251
+ * Permission to update the whiteboard.
252
+ *
253
+ * @returns Returned if the content property was created successfully.
254
+ * @path {POST} /whiteboards/{id}/properties
255
+ * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
256
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-post
257
+ */
258
+ this.createWhiteboardProperty = ({ id, contentPropertyCreateRequest, }) => {
259
+ return this.getClientInstance()
260
+ .request({
261
+ path: "/whiteboards/{id}/properties",
262
+ method: "POST",
263
+ pathParams: {
264
+ id,
265
+ },
266
+ headers: {
267
+ "Content-Type": "application/json",
268
+ },
269
+ body: contentPropertyCreateRequest,
270
+ })
271
+ .then(this.getClientInstance().responseHandler({
272
+ 200: {
273
+ "application/json": "json",
274
+ },
275
+ }))
276
+ .then(commonHttpClient.castResponse())
277
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.createWhiteboardProperty.response"))
278
+ .then(commonHttpClient.getBody);
279
+ };
280
+ /**
281
+ * Deletes a content property for an attachment by its id.
282
+ *
283
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
284
+ * Permission to attachment the page.
285
+ *
286
+ * @path {DELETE} /attachments/{attachment-id}/properties/{property-id}
287
+ * @scopes-current read:attachment:confluence, write:attachment:confluence
288
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-delete
289
+ */
290
+ this.deleteAttachmentPropertyById = ({ attachmentId, propertyId, }) => {
291
+ return this.getClientInstance()
292
+ .request({
293
+ path: "/attachments/{attachment-id}/properties/{property-id}",
294
+ method: "DELETE",
295
+ pathParams: {
296
+ "attachment-id": attachmentId,
297
+ "property-id": propertyId,
298
+ },
299
+ })
300
+ .then(commonHttpClient.discardResult);
301
+ };
302
+ /**
303
+ * Deletes a content property for a blogpost by its id.
304
+ *
305
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
306
+ * Permission to edit the blog post.
307
+ *
308
+ * @path {DELETE} /blogposts/{blogpost-id}/properties/{property-id}
309
+ * @scopes-current read:page:confluence, write:page:confluence
310
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-delete
311
+ */
312
+ this.deleteBlogpostPropertyById = ({ blogpostId, propertyId, }) => {
313
+ return this.getClientInstance()
314
+ .request({
315
+ path: "/blogposts/{blogpost-id}/properties/{property-id}",
316
+ method: "DELETE",
317
+ pathParams: {
318
+ "blogpost-id": blogpostId,
319
+ "property-id": propertyId,
320
+ },
321
+ })
322
+ .then(commonHttpClient.discardResult);
323
+ };
324
+ /**
325
+ * Deletes a content property for a comment by its id.
326
+ *
327
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
328
+ * Permission to edit the comment.
329
+ *
330
+ * @path {DELETE} /comments/{comment-id}/properties/{property-id}
331
+ * @scopes-current read:comment:confluence, write:comment:confluence
332
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-delete
333
+ */
334
+ this.deleteCommentPropertyById = ({ commentId, propertyId, }) => {
335
+ return this.getClientInstance()
336
+ .request({
337
+ path: "/comments/{comment-id}/properties/{property-id}",
338
+ method: "DELETE",
339
+ pathParams: {
340
+ "comment-id": commentId,
341
+ "property-id": propertyId,
342
+ },
343
+ })
344
+ .then(commonHttpClient.discardResult);
345
+ };
346
+ /**
347
+ * Deletes a content property for a piece of custom content by its id.
348
+ *
349
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
350
+ * Permission to edit the custom content.
351
+ *
352
+ * @path {DELETE} /custom-content/{custom-content-id}/properties/{property-id}
353
+ * @scopes-current read:custom-content:confluence, write:custom-content:confluence
354
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-delete
355
+ */
356
+ this.deleteCustomContentPropertyById = ({ customContentId, propertyId, }) => {
357
+ return this.getClientInstance()
358
+ .request({
359
+ path: "/custom-content/{custom-content-id}/properties/{property-id}",
360
+ method: "DELETE",
361
+ pathParams: {
362
+ "custom-content-id": customContentId,
363
+ "property-id": propertyId,
364
+ },
365
+ })
366
+ .then(commonHttpClient.discardResult);
367
+ };
368
+ /**
369
+ * Deletes a content property for a database by its id.
370
+ *
371
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
372
+ * Permission to edit the database.
373
+ *
374
+ * @path {DELETE} /databases/{database-id}/properties/{property-id}
375
+ * @scopes-current read:database:confluence, write:database:confluence
376
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-delete
377
+ */
378
+ this.deleteDatabasePropertyById = ({ databaseId, propertyId, }) => {
379
+ return this.getClientInstance()
380
+ .request({
381
+ path: "/databases/{database-id}/properties/{property-id}",
382
+ method: "DELETE",
383
+ pathParams: {
384
+ "database-id": databaseId,
385
+ "property-id": propertyId,
386
+ },
387
+ })
388
+ .then(commonHttpClient.discardResult);
389
+ };
390
+ /**
391
+ * Deletes a content property for a page by its id.
392
+ *
393
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
394
+ * Permission to edit the page.
395
+ *
396
+ * @path {DELETE} /pages/{page-id}/properties/{property-id}
397
+ * @scopes-current read:page:confluence, write:page:confluence
398
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-delete
399
+ */
400
+ this.deletePagePropertyById = ({ pageId, propertyId, }) => {
401
+ return this.getClientInstance()
402
+ .request({
403
+ path: "/pages/{page-id}/properties/{property-id}",
404
+ method: "DELETE",
405
+ pathParams: {
406
+ "page-id": pageId,
407
+ "property-id": propertyId,
408
+ },
409
+ })
410
+ .then(commonHttpClient.discardResult);
411
+ };
412
+ /**
413
+ * Deletes a content property for a Smart Link in the content tree by its id.
414
+ *
415
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
416
+ * Permission to edit the Smart Link in the content tree.
417
+ *
418
+ * @path {DELETE} /embeds/{embed-id}/properties/{property-id}
419
+ * @scopes-current read:embed:confluence, write:embed:confluence
420
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-delete
421
+ */
422
+ this.deleteSmartLinkPropertyById = ({ embedId, propertyId, }) => {
423
+ return this.getClientInstance()
424
+ .request({
425
+ path: "/embeds/{embed-id}/properties/{property-id}",
426
+ method: "DELETE",
427
+ pathParams: {
428
+ "embed-id": embedId,
429
+ "property-id": propertyId,
430
+ },
431
+ })
432
+ .then(commonHttpClient.discardResult);
433
+ };
434
+ /**
435
+ * Deletes a content property for a whiteboard by its id.
436
+ *
437
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
438
+ * Permission to edit the whiteboard.
439
+ *
440
+ * @path {DELETE} /whiteboards/{whiteboard-id}/properties/{property-id}
441
+ * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
442
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-delete
443
+ */
444
+ this.deleteWhiteboardPropertyById = ({ whiteboardId, propertyId, }) => {
445
+ return this.getClientInstance()
446
+ .request({
447
+ path: "/whiteboards/{whiteboard-id}/properties/{property-id}",
448
+ method: "DELETE",
449
+ pathParams: {
450
+ "whiteboard-id": whiteboardId,
451
+ "property-id": propertyId,
452
+ },
453
+ })
454
+ .then(commonHttpClient.discardResult);
455
+ };
456
+ /**
457
+ * Retrieves all Content Properties tied to a specified attachment.
458
+ *
459
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
460
+ * Permission to view the attachment.
461
+ *
462
+ * @returns Returned if the requested content properties are successfully retrieved.
463
+ * @path {GET} /attachments/{attachment-id}/properties
464
+ * @scopes-current read:attachment:confluence
465
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-get
466
+ */
467
+ this.getAttachmentContentProperties = ({ attachmentId, key, sort, cursor, limit, }) => {
468
+ return this.getClientInstance()
469
+ .request({
470
+ path: "/attachments/{attachment-id}/properties",
471
+ method: "GET",
472
+ pathParams: {
473
+ "attachment-id": attachmentId,
474
+ },
475
+ query: {
476
+ key,
477
+ sort,
478
+ cursor,
479
+ limit,
480
+ },
481
+ })
482
+ .then(this.getClientInstance().responseHandler({
483
+ 200: {
484
+ "application/json": "json",
485
+ },
486
+ }))
487
+ .then(commonHttpClient.castResponse())
488
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getAttachmentContentProperties.response"))
489
+ .then(commonHttpClient.getBody);
490
+ };
491
+ /**
492
+ * Retrieves a specific Content Property by ID that is attached to a specified
493
+ * attachment.
494
+ *
495
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
496
+ * Permission to view the attachment.
497
+ *
498
+ * @returns Returned if the requested content property is successfully retrieved.
499
+ * @path {GET} /attachments/{attachment-id}/properties/{property-id}
500
+ * @scopes-current read:attachment:confluence
501
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-get
502
+ */
503
+ this.getAttachmentContentPropertiesById = ({ attachmentId, propertyId, }) => {
504
+ return this.getClientInstance()
505
+ .request({
506
+ path: "/attachments/{attachment-id}/properties/{property-id}",
507
+ method: "GET",
508
+ pathParams: {
509
+ "attachment-id": attachmentId,
510
+ "property-id": propertyId,
511
+ },
512
+ })
513
+ .then(this.getClientInstance().responseHandler({
514
+ 200: {
515
+ "application/json": "json",
516
+ },
517
+ }))
518
+ .then(commonHttpClient.castResponse())
519
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getAttachmentContentPropertiesById.response"))
520
+ .then(commonHttpClient.getBody);
521
+ };
522
+ /**
523
+ * Retrieves all Content Properties tied to a specified blog post.
524
+ *
525
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
526
+ * Permission to view the blog post.
527
+ *
528
+ * @returns Returned if the requested content properties are successfully retrieved.
529
+ * @path {GET} /blogposts/{blogpost-id}/properties
530
+ * @scopes-current read:page:confluence
531
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-get
532
+ */
533
+ this.getBlogpostContentProperties = ({ blogpostId, key, sort, cursor, limit, }) => {
534
+ return this.getClientInstance()
535
+ .request({
536
+ path: "/blogposts/{blogpost-id}/properties",
537
+ method: "GET",
538
+ pathParams: {
539
+ "blogpost-id": blogpostId,
540
+ },
541
+ query: {
542
+ key,
543
+ sort,
544
+ cursor,
545
+ limit,
546
+ },
547
+ })
548
+ .then(this.getClientInstance().responseHandler({
549
+ 200: {
550
+ "application/json": "json",
551
+ },
552
+ }))
553
+ .then(commonHttpClient.castResponse())
554
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getBlogpostContentProperties.response"))
555
+ .then(commonHttpClient.getBody);
556
+ };
557
+ /**
558
+ * Retrieves a specific Content Property by ID that is attached to a specified
559
+ * blog post.
560
+ *
561
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
562
+ * Permission to view the blog post.
563
+ *
564
+ * @returns Returned if the requested content property is successfully retrieved.
565
+ * @path {GET} /blogposts/{blogpost-id}/properties/{property-id}
566
+ * @scopes-current read:page:confluence
567
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-get
568
+ */
569
+ this.getBlogpostContentPropertiesById = ({ blogpostId, propertyId, }) => {
570
+ return this.getClientInstance()
571
+ .request({
572
+ path: "/blogposts/{blogpost-id}/properties/{property-id}",
573
+ method: "GET",
574
+ pathParams: {
575
+ "blogpost-id": blogpostId,
576
+ "property-id": propertyId,
577
+ },
578
+ })
579
+ .then(this.getClientInstance().responseHandler({
580
+ 200: {
581
+ "application/json": "json",
582
+ },
583
+ }))
584
+ .then(commonHttpClient.castResponse())
585
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getBlogpostContentPropertiesById.response"))
586
+ .then(commonHttpClient.getBody);
587
+ };
588
+ /**
589
+ * Retrieves Content Properties attached to a specified comment.
590
+ *
591
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
592
+ * Permission to view the comment.
593
+ *
594
+ * @returns Returned if the requested content properties are successfully retrieved.
595
+ * @path {GET} /comments/{comment-id}/properties
596
+ * @scopes-current read:comment:confluence
597
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-get
598
+ */
599
+ this.getCommentContentProperties = ({ commentId, key, sort, cursor, limit, }) => {
600
+ return this.getClientInstance()
601
+ .request({
602
+ path: "/comments/{comment-id}/properties",
603
+ method: "GET",
604
+ pathParams: {
605
+ "comment-id": commentId,
606
+ },
607
+ query: {
608
+ key,
609
+ sort,
610
+ cursor,
611
+ limit,
612
+ },
613
+ })
614
+ .then(this.getClientInstance().responseHandler({
615
+ 200: {
616
+ "application/json": "json",
617
+ },
618
+ }))
619
+ .then(commonHttpClient.castResponse())
620
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCommentContentProperties.response"))
621
+ .then(commonHttpClient.getBody);
622
+ };
623
+ /**
624
+ * Retrieves a specific Content Property by ID that is attached to a specified
625
+ * comment.
626
+ *
627
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
628
+ * Permission to view the comment.
629
+ *
630
+ * @returns Returned if the requested content property is successfully retrieved.
631
+ * @path {GET} /comments/{comment-id}/properties/{property-id}
632
+ * @scopes-current read:comment:confluence
633
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-get
634
+ */
635
+ this.getCommentContentPropertiesById = ({ commentId, propertyId, }) => {
636
+ return this.getClientInstance()
637
+ .request({
638
+ path: "/comments/{comment-id}/properties/{property-id}",
639
+ method: "GET",
640
+ pathParams: {
641
+ "comment-id": commentId,
642
+ "property-id": propertyId,
643
+ },
644
+ })
645
+ .then(this.getClientInstance().responseHandler({
646
+ 200: {
647
+ "application/json": "json",
648
+ },
649
+ }))
650
+ .then(commonHttpClient.castResponse())
651
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCommentContentPropertiesById.response"))
652
+ .then(commonHttpClient.getBody);
653
+ };
654
+ /**
655
+ * Retrieves Content Properties tied to a specified custom content.
656
+ *
657
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
658
+ * Permission to view the custom content.
659
+ *
660
+ * @returns Returned if the requested content properties are successfully retrieved.
661
+ * @path {GET} /custom-content/{custom-content-id}/properties
662
+ * @scopes-current read:custom-content:confluence
663
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-get
664
+ */
665
+ this.getCustomContentContentProperties = ({ customContentId, key, sort, cursor, limit, }) => {
666
+ return this.getClientInstance()
667
+ .request({
668
+ path: "/custom-content/{custom-content-id}/properties",
669
+ method: "GET",
670
+ pathParams: {
671
+ "custom-content-id": customContentId,
672
+ },
673
+ query: {
674
+ key,
675
+ sort,
676
+ cursor,
677
+ limit,
678
+ },
679
+ })
680
+ .then(this.getClientInstance().responseHandler({
681
+ 200: {
682
+ "application/json": "json",
683
+ },
684
+ }))
685
+ .then(commonHttpClient.castResponse())
686
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCustomContentContentProperties.response"))
687
+ .then(commonHttpClient.getBody);
688
+ };
689
+ /**
690
+ * Retrieves a specific Content Property by ID that is attached to a specified
691
+ * custom content.
692
+ *
693
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
694
+ * Permission to view the page.
695
+ *
696
+ * @returns Returned if the requested content property is successfully retrieved.
697
+ * @path {GET} /custom-content/{custom-content-id}/properties/{property-id}
698
+ * @scopes-current read:custom-content:confluence
699
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-get
700
+ */
701
+ this.getCustomContentContentPropertiesById = ({ customContentId, propertyId, }) => {
702
+ return this.getClientInstance()
703
+ .request({
704
+ path: "/custom-content/{custom-content-id}/properties/{property-id}",
705
+ method: "GET",
706
+ pathParams: {
707
+ "custom-content-id": customContentId,
708
+ "property-id": propertyId,
709
+ },
710
+ })
711
+ .then(this.getClientInstance().responseHandler({
712
+ 200: {
713
+ "application/json": "json",
714
+ },
715
+ }))
716
+ .then(commonHttpClient.castResponse())
717
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getCustomContentContentPropertiesById.response"))
718
+ .then(commonHttpClient.getBody);
719
+ };
720
+ /**
721
+ * Retrieves Content Properties tied to a specified database.
722
+ *
723
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
724
+ * Permission to view the database.
725
+ *
726
+ * @returns Returned if the requested content properties are successfully retrieved.
727
+ * @path {GET} /databases/{id}/properties
728
+ * @scopes-current read:database:confluence
729
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-get
730
+ */
731
+ this.getDatabaseContentProperties = ({ id, key, sort, cursor, limit, }) => {
732
+ return this.getClientInstance()
733
+ .request({
734
+ path: "/databases/{id}/properties",
735
+ method: "GET",
736
+ pathParams: {
737
+ id,
738
+ },
739
+ query: {
740
+ key,
741
+ sort,
742
+ cursor,
743
+ limit,
744
+ },
745
+ })
746
+ .then(this.getClientInstance().responseHandler({
747
+ 200: {
748
+ "application/json": "json",
749
+ },
750
+ }))
751
+ .then(commonHttpClient.castResponse())
752
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getDatabaseContentProperties.response"))
753
+ .then(commonHttpClient.getBody);
754
+ };
755
+ /**
756
+ * Retrieves a specific Content Property by ID that is attached to a specified
757
+ * database.
758
+ *
759
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
760
+ * Permission to view the database.
761
+ *
762
+ * @returns Returned if the requested content property is successfully retrieved.
763
+ * @path {GET} /databases/{database-id}/properties/{property-id}
764
+ * @scopes-current read:database:confluence
765
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-get
766
+ */
767
+ this.getDatabaseContentPropertiesById = ({ databaseId, propertyId, }) => {
768
+ return this.getClientInstance()
769
+ .request({
770
+ path: "/databases/{database-id}/properties/{property-id}",
771
+ method: "GET",
772
+ pathParams: {
773
+ "database-id": databaseId,
774
+ "property-id": propertyId,
775
+ },
776
+ })
777
+ .then(this.getClientInstance().responseHandler({
778
+ 200: {
779
+ "application/json": "json",
780
+ },
781
+ }))
782
+ .then(commonHttpClient.castResponse())
783
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getDatabaseContentPropertiesById.response"))
784
+ .then(commonHttpClient.getBody);
785
+ };
786
+ /**
787
+ * Retrieves Content Properties tied to a specified page.
788
+ *
789
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
790
+ * Permission to view the page.
791
+ *
792
+ * @returns Returned if the requested content properties are successfully retrieved.
793
+ * @path {GET} /pages/{page-id}/properties
794
+ * @scopes-current read:page:confluence
795
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-get
796
+ */
797
+ this.getPageContentProperties = ({ pageId, key, sort, cursor, limit, }) => {
798
+ return this.getClientInstance()
799
+ .request({
800
+ path: "/pages/{page-id}/properties",
801
+ method: "GET",
802
+ pathParams: {
803
+ "page-id": pageId,
804
+ },
805
+ query: {
806
+ key,
807
+ sort,
808
+ cursor,
809
+ limit,
810
+ },
811
+ })
812
+ .then(this.getClientInstance().responseHandler({
813
+ 200: {
814
+ "application/json": "json",
815
+ },
816
+ }))
817
+ .then(commonHttpClient.castResponse())
818
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getPageContentProperties.response"))
819
+ .then(commonHttpClient.getBody);
820
+ };
821
+ /**
822
+ * Retrieves a specific Content Property by ID that is attached to a specified
823
+ * page.
824
+ *
825
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
826
+ * Permission to view the page.
827
+ *
828
+ * @returns Returned if the requested content property is successfully retrieved.
829
+ * @path {GET} /pages/{page-id}/properties/{property-id}
830
+ * @scopes-current read:page:confluence
831
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-get
832
+ */
833
+ this.getPageContentPropertiesById = ({ pageId, propertyId, }) => {
834
+ return this.getClientInstance()
835
+ .request({
836
+ path: "/pages/{page-id}/properties/{property-id}",
837
+ method: "GET",
838
+ pathParams: {
839
+ "page-id": pageId,
840
+ "property-id": propertyId,
841
+ },
842
+ })
843
+ .then(this.getClientInstance().responseHandler({
844
+ 200: {
845
+ "application/json": "json",
846
+ },
847
+ }))
848
+ .then(commonHttpClient.castResponse())
849
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getPageContentPropertiesById.response"))
850
+ .then(commonHttpClient.getBody);
851
+ };
852
+ /**
853
+ * Retrieves Content Properties tied to a specified Smart Link in the content tree.
854
+ *
855
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
856
+ * Permission to view the Smart Link in the content tree.
857
+ *
858
+ * @returns Returned if the requested content properties are successfully retrieved.
859
+ * @path {GET} /embeds/{id}/properties
860
+ * @scopes-current read:embed:confluence
861
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-get
862
+ */
863
+ this.getSmartLinkContentProperties = ({ id, key, sort, cursor, limit, }) => {
864
+ return this.getClientInstance()
865
+ .request({
866
+ path: "/embeds/{id}/properties",
867
+ method: "GET",
868
+ pathParams: {
869
+ id,
870
+ },
871
+ query: {
872
+ key,
873
+ sort,
874
+ cursor,
875
+ limit,
876
+ },
877
+ })
878
+ .then(this.getClientInstance().responseHandler({
879
+ 200: {
880
+ "application/json": "json",
881
+ },
882
+ }))
883
+ .then(commonHttpClient.castResponse())
884
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getSmartLinkContentProperties.response"))
885
+ .then(commonHttpClient.getBody);
886
+ };
887
+ /**
888
+ * Retrieves a specific Content Property by ID that is attached to a specified
889
+ * Smart Link in the content tree.
890
+ *
891
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
892
+ * Permission to view the Smart Link in the content tree.
893
+ *
894
+ * @returns Returned if the requested content property is successfully retrieved.
895
+ * @path {GET} /embeds/{embed-id}/properties/{property-id}
896
+ * @scopes-current read:embed:confluence
897
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-get
898
+ */
899
+ this.getSmartLinkContentPropertiesById = ({ embedId, propertyId, }) => {
900
+ return this.getClientInstance()
901
+ .request({
902
+ path: "/embeds/{embed-id}/properties/{property-id}",
903
+ method: "GET",
904
+ pathParams: {
905
+ "embed-id": embedId,
906
+ "property-id": propertyId,
907
+ },
908
+ })
909
+ .then(this.getClientInstance().responseHandler({
910
+ 200: {
911
+ "application/json": "json",
912
+ },
913
+ }))
914
+ .then(commonHttpClient.castResponse())
915
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getSmartLinkContentPropertiesById.response"))
916
+ .then(commonHttpClient.getBody);
917
+ };
918
+ /**
919
+ * Retrieves Content Properties tied to a specified whiteboard.
920
+ *
921
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
922
+ * Permission to view the whiteboard.
923
+ *
924
+ * @returns Returned if the requested content properties are successfully retrieved.
925
+ * @path {GET} /whiteboards/{id}/properties
926
+ * @scopes-current read:whiteboard:confluence
927
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-get
928
+ */
929
+ this.getWhiteboardContentProperties = ({ id, key, sort, cursor, limit, }) => {
930
+ return this.getClientInstance()
931
+ .request({
932
+ path: "/whiteboards/{id}/properties",
933
+ method: "GET",
934
+ pathParams: {
935
+ id,
936
+ },
937
+ query: {
938
+ key,
939
+ sort,
940
+ cursor,
941
+ limit,
942
+ },
943
+ })
944
+ .then(this.getClientInstance().responseHandler({
945
+ 200: {
946
+ "application/json": "json",
947
+ },
948
+ }))
949
+ .then(commonHttpClient.castResponse())
950
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getWhiteboardContentProperties.response"))
951
+ .then(commonHttpClient.getBody);
952
+ };
953
+ /**
954
+ * Retrieves a specific Content Property by ID that is attached to a specified
955
+ * whiteboard.
956
+ *
957
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
958
+ * Permission to view the whiteboard.
959
+ *
960
+ * @returns Returned if the requested content property is successfully retrieved.
961
+ * @path {GET} /whiteboards/{whiteboard-id}/properties/{property-id}
962
+ * @scopes-current read:whiteboard:confluence
963
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-get
964
+ */
965
+ this.getWhiteboardContentPropertiesById = ({ whiteboardId, propertyId, }) => {
966
+ return this.getClientInstance()
967
+ .request({
968
+ path: "/whiteboards/{whiteboard-id}/properties/{property-id}",
969
+ method: "GET",
970
+ pathParams: {
971
+ "whiteboard-id": whiteboardId,
972
+ "property-id": propertyId,
973
+ },
974
+ })
975
+ .then(this.getClientInstance().responseHandler({
976
+ 200: {
977
+ "application/json": "json",
978
+ },
979
+ }))
980
+ .then(commonHttpClient.castResponse())
981
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.getWhiteboardContentPropertiesById.response"))
982
+ .then(commonHttpClient.getBody);
983
+ };
984
+ /**
985
+ * Update a content property for attachment by its id.
986
+ *
987
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
988
+ * Permission to edit the attachment.
989
+ *
990
+ * @returns Returned if the content property was updated successfully.
991
+ * @path {PUT} /attachments/{attachment-id}/properties/{property-id}
992
+ * @scopes-current read:attachment:confluence, write:attachment:confluence
993
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-put
994
+ */
995
+ this.updateAttachmentPropertyById = ({ attachmentId, propertyId, contentPropertyUpdateRequest, }) => {
996
+ return this.getClientInstance()
997
+ .request({
998
+ path: "/attachments/{attachment-id}/properties/{property-id}",
999
+ method: "PUT",
1000
+ pathParams: {
1001
+ "attachment-id": attachmentId,
1002
+ "property-id": propertyId,
1003
+ },
1004
+ headers: {
1005
+ "Content-Type": "application/json",
1006
+ },
1007
+ body: contentPropertyUpdateRequest,
1008
+ })
1009
+ .then(this.getClientInstance().responseHandler({
1010
+ 200: {
1011
+ "application/json": "json",
1012
+ },
1013
+ }))
1014
+ .then(commonHttpClient.castResponse())
1015
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateAttachmentPropertyById.response"))
1016
+ .then(commonHttpClient.getBody);
1017
+ };
1018
+ /**
1019
+ * Update a content property for blog post by its id.
1020
+ *
1021
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1022
+ * Permission to edit the blog post.
1023
+ *
1024
+ * @returns Returned if the content property was updated successfully.
1025
+ * @path {PUT} /blogposts/{blogpost-id}/properties/{property-id}
1026
+ * @scopes-current read:page:confluence, write:page:confluence
1027
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-put
1028
+ */
1029
+ this.updateBlogpostPropertyById = ({ blogpostId, propertyId, contentPropertyUpdateRequest, }) => {
1030
+ return this.getClientInstance()
1031
+ .request({
1032
+ path: "/blogposts/{blogpost-id}/properties/{property-id}",
1033
+ method: "PUT",
1034
+ pathParams: {
1035
+ "blogpost-id": blogpostId,
1036
+ "property-id": propertyId,
1037
+ },
1038
+ headers: {
1039
+ "Content-Type": "application/json",
1040
+ },
1041
+ body: contentPropertyUpdateRequest,
1042
+ })
1043
+ .then(this.getClientInstance().responseHandler({
1044
+ 200: {
1045
+ "application/json": "json",
1046
+ },
1047
+ }))
1048
+ .then(commonHttpClient.castResponse())
1049
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateBlogpostPropertyById.response"))
1050
+ .then(commonHttpClient.getBody);
1051
+ };
1052
+ /**
1053
+ * Update a content property for a comment by its id.
1054
+ *
1055
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1056
+ * Permission to edit the comment.
1057
+ *
1058
+ * @returns Returned if the content property was updated successfully.
1059
+ * @path {PUT} /comments/{comment-id}/properties/{property-id}
1060
+ * @scopes-current read:comment:confluence, write:comment:confluence
1061
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-put
1062
+ */
1063
+ this.updateCommentPropertyById = ({ commentId, propertyId, contentPropertyUpdateRequest, }) => {
1064
+ return this.getClientInstance()
1065
+ .request({
1066
+ path: "/comments/{comment-id}/properties/{property-id}",
1067
+ method: "PUT",
1068
+ pathParams: {
1069
+ "comment-id": commentId,
1070
+ "property-id": propertyId,
1071
+ },
1072
+ headers: {
1073
+ "Content-Type": "application/json",
1074
+ },
1075
+ body: contentPropertyUpdateRequest,
1076
+ })
1077
+ .then(this.getClientInstance().responseHandler({
1078
+ 200: {
1079
+ "application/json": "json",
1080
+ },
1081
+ }))
1082
+ .then(commonHttpClient.castResponse())
1083
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateCommentPropertyById.response"))
1084
+ .then(commonHttpClient.getBody);
1085
+ };
1086
+ /**
1087
+ * Update a content property for a piece of custom content by its id.
1088
+ *
1089
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1090
+ * Permission to edit the custom content.
1091
+ *
1092
+ * @returns Returned if the content property was updated successfully.
1093
+ * @path {PUT} /custom-content/{custom-content-id}/properties/{property-id}
1094
+ * @scopes-current read:custom-content:confluence, write:custom-content:confluence
1095
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-put
1096
+ */
1097
+ this.updateCustomContentPropertyById = ({ customContentId, propertyId, contentPropertyUpdateRequest, }) => {
1098
+ return this.getClientInstance()
1099
+ .request({
1100
+ path: "/custom-content/{custom-content-id}/properties/{property-id}",
1101
+ method: "PUT",
1102
+ pathParams: {
1103
+ "custom-content-id": customContentId,
1104
+ "property-id": propertyId,
1105
+ },
1106
+ headers: {
1107
+ "Content-Type": "application/json",
1108
+ },
1109
+ body: contentPropertyUpdateRequest,
1110
+ })
1111
+ .then(this.getClientInstance().responseHandler({
1112
+ 200: {
1113
+ "application/json": "json",
1114
+ },
1115
+ }))
1116
+ .then(commonHttpClient.castResponse())
1117
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateCustomContentPropertyById.response"))
1118
+ .then(commonHttpClient.getBody);
1119
+ };
1120
+ /**
1121
+ * Update a content property for a database by its id.
1122
+ *
1123
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1124
+ * Permission to edit the database.
1125
+ *
1126
+ * @returns Returned if the content property was updated successfully.
1127
+ * @path {PUT} /databases/{database-id}/properties/{property-id}
1128
+ * @scopes-current read:database:confluence, write:database:confluence
1129
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-put
1130
+ */
1131
+ this.updateDatabasePropertyById = ({ databaseId, propertyId, contentPropertyUpdateRequest, }) => {
1132
+ return this.getClientInstance()
1133
+ .request({
1134
+ path: "/databases/{database-id}/properties/{property-id}",
1135
+ method: "PUT",
1136
+ pathParams: {
1137
+ "database-id": databaseId,
1138
+ "property-id": propertyId,
1139
+ },
1140
+ headers: {
1141
+ "Content-Type": "application/json",
1142
+ },
1143
+ body: contentPropertyUpdateRequest,
1144
+ })
1145
+ .then(this.getClientInstance().responseHandler({
1146
+ 200: {
1147
+ "application/json": "json",
1148
+ },
1149
+ }))
1150
+ .then(commonHttpClient.castResponse())
1151
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateDatabasePropertyById.response"))
1152
+ .then(commonHttpClient.getBody);
1153
+ };
1154
+ /**
1155
+ * Update a content property for a page by its id.
1156
+ *
1157
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1158
+ * Permission to edit the page.
1159
+ *
1160
+ * @returns Returned if the content property was updated successfully.
1161
+ * @path {PUT} /pages/{page-id}/properties/{property-id}
1162
+ * @scopes-current read:page:confluence, write:page:confluence
1163
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-put
1164
+ */
1165
+ this.updatePagePropertyById = ({ pageId, propertyId, contentPropertyUpdateRequest, }) => {
1166
+ return this.getClientInstance()
1167
+ .request({
1168
+ path: "/pages/{page-id}/properties/{property-id}",
1169
+ method: "PUT",
1170
+ pathParams: {
1171
+ "page-id": pageId,
1172
+ "property-id": propertyId,
1173
+ },
1174
+ headers: {
1175
+ "Content-Type": "application/json",
1176
+ },
1177
+ body: contentPropertyUpdateRequest,
1178
+ })
1179
+ .then(this.getClientInstance().responseHandler({
1180
+ 200: {
1181
+ "application/json": "json",
1182
+ },
1183
+ }))
1184
+ .then(commonHttpClient.castResponse())
1185
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updatePagePropertyById.response"))
1186
+ .then(commonHttpClient.getBody);
1187
+ };
1188
+ /**
1189
+ * Update a content property for a Smart Link in the content tree by its id.
1190
+ *
1191
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1192
+ * Permission to edit the Smart Link in the content tree.
1193
+ *
1194
+ * @returns Returned if the content property was updated successfully.
1195
+ * @path {PUT} /embeds/{embed-id}/properties/{property-id}
1196
+ * @scopes-current read:embed:confluence, write:embed:confluence
1197
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-put
1198
+ */
1199
+ this.updateSmartLinkPropertyById = ({ embedId, propertyId, contentPropertyUpdateRequest, }) => {
1200
+ return this.getClientInstance()
1201
+ .request({
1202
+ path: "/embeds/{embed-id}/properties/{property-id}",
1203
+ method: "PUT",
1204
+ pathParams: {
1205
+ "embed-id": embedId,
1206
+ "property-id": propertyId,
1207
+ },
1208
+ headers: {
1209
+ "Content-Type": "application/json",
1210
+ },
1211
+ body: contentPropertyUpdateRequest,
1212
+ })
1213
+ .then(this.getClientInstance().responseHandler({
1214
+ 200: {
1215
+ "application/json": "json",
1216
+ },
1217
+ }))
1218
+ .then(commonHttpClient.castResponse())
1219
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateSmartLinkPropertyById.response"))
1220
+ .then(commonHttpClient.getBody);
1221
+ };
1222
+ /**
1223
+ * Update a content property for a whiteboard by its id.
1224
+ *
1225
+ * **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
1226
+ * Permission to edit the whiteboard.
1227
+ *
1228
+ * @returns Returned if the content property was updated successfully.
1229
+ * @path {PUT} /whiteboards/{whiteboard-id}/properties/{property-id}
1230
+ * @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
1231
+ * @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-put
1232
+ */
1233
+ this.updateWhiteboardPropertyById = ({ whiteboardId, propertyId, contentPropertyUpdateRequest, }) => {
1234
+ return this.getClientInstance()
1235
+ .request({
1236
+ path: "/whiteboards/{whiteboard-id}/properties/{property-id}",
1237
+ method: "PUT",
1238
+ pathParams: {
1239
+ "whiteboard-id": whiteboardId,
1240
+ "property-id": propertyId,
1241
+ },
1242
+ headers: {
1243
+ "Content-Type": "application/json",
1244
+ },
1245
+ body: contentPropertyUpdateRequest,
1246
+ })
1247
+ .then(this.getClientInstance().responseHandler({
1248
+ 200: {
1249
+ "application/json": "json",
1250
+ },
1251
+ }))
1252
+ .then(commonHttpClient.castResponse())
1253
+ .then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentPropertiesService.updateWhiteboardPropertyById.response"))
1254
+ .then(commonHttpClient.getBody);
1255
+ };
1253
1256
  }
1254
1257
  static initialize() {
1255
1258
  validationSchemaStorage_1.validationSchemaStorage.registerExtensible("ContentPropertiesService.getAttachmentContentProperties.response", zod_1.z