@resolution/confluence-api-client 0.5.2 → 0.5.3
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.
- package/CHANGELOG.md +11 -0
- package/lib/openapi/v1/models/common.d.ts +1 -0
- package/lib/openapi/v1/models/common.js +1 -0
- package/lib/openapi/v1/models/common.js.map +1 -1
- package/lib/openapi/v1/models/dynamicModules.d.ts +6 -3
- package/lib/openapi/v1/models/dynamicModules.js.map +1 -1
- package/lib/openapi/v1/models/space.d.ts +10 -3
- package/lib/openapi/v1/models/space.js +2 -1
- package/lib/openapi/v1/models/space.js.map +1 -1
- package/lib/openapi/v1/services/AnalyticsService.d.ts +8 -4
- package/lib/openapi/v1/services/AnalyticsService.js +4 -2
- package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
- package/lib/openapi/v1/services/AuditService.d.ts +13 -7
- package/lib/openapi/v1/services/AuditService.js +13 -7
- package/lib/openapi/v1/services/AuditService.js.map +1 -1
- package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +12 -6
- package/lib/openapi/v1/services/ContentAttachmentsService.js +12 -6
- package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentBodyService.d.ts +7 -5
- package/lib/openapi/v1/services/ContentBodyService.js +7 -5
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +17 -9
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +17 -9
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentCommentsService.d.ts +2 -1
- package/lib/openapi/v1/services/ContentCommentsService.js +2 -1
- package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentLabelsService.d.ts +8 -4
- package/lib/openapi/v1/services/ContentLabelsService.js +8 -4
- package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +6 -5
- package/lib/openapi/v1/services/ContentMacroBodyService.js +6 -5
- package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -1
- package/lib/openapi/v1/services/ContentPermissionsService.js +2 -1
- package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPropertiesService.d.ts +12 -6
- package/lib/openapi/v1/services/ContentPropertiesService.js +12 -6
- package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +30 -21
- package/lib/openapi/v1/services/ContentRestrictionsService.js +30 -21
- package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentService.d.ts +20 -10
- package/lib/openapi/v1/services/ContentService.js +20 -10
- package/lib/openapi/v1/services/ContentService.js.map +1 -1
- package/lib/openapi/v1/services/ContentStatesService.d.ts +20 -11
- package/lib/openapi/v1/services/ContentStatesService.js +20 -11
- package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentVersionsService.d.ts +8 -4
- package/lib/openapi/v1/services/ContentVersionsService.js +8 -4
- package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentWatchesService.d.ts +24 -12
- package/lib/openapi/v1/services/ContentWatchesService.js +24 -12
- package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
- package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -3
- package/lib/openapi/v1/services/DynamicModulesService.js +5 -3
- package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
- package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -8
- package/lib/openapi/v1/services/ExperimentalService.js +12 -8
- package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
- package/lib/openapi/v1/services/GroupService.d.ts +30 -15
- package/lib/openapi/v1/services/GroupService.js +30 -15
- package/lib/openapi/v1/services/GroupService.js.map +1 -1
- package/lib/openapi/v1/services/InlineTasksService.d.ts +6 -3
- package/lib/openapi/v1/services/InlineTasksService.js +6 -3
- package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
- package/lib/openapi/v1/services/LabelInfoService.d.ts +2 -1
- package/lib/openapi/v1/services/LabelInfoService.js +2 -1
- package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
- package/lib/openapi/v1/services/LongRunningTaskService.d.ts +4 -2
- package/lib/openapi/v1/services/LongRunningTaskService.js +4 -2
- package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
- package/lib/openapi/v1/services/RelationService.d.ts +11 -12
- package/lib/openapi/v1/services/RelationService.js +11 -12
- package/lib/openapi/v1/services/RelationService.js.map +1 -1
- package/lib/openapi/v1/services/SearchService.d.ts +4 -2
- package/lib/openapi/v1/services/SearchService.js +4 -2
- package/lib/openapi/v1/services/SearchService.js.map +1 -1
- package/lib/openapi/v1/services/SettingsService.d.ts +13 -10
- package/lib/openapi/v1/services/SettingsService.js +13 -10
- package/lib/openapi/v1/services/SettingsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -3
- package/lib/openapi/v1/services/SpacePermissionsService.js +6 -3
- package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePropertiesService.d.ts +12 -6
- package/lib/openapi/v1/services/SpacePropertiesService.js +12 -6
- package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceService.d.ts +19 -14
- package/lib/openapi/v1/services/SpaceService.js +19 -14
- package/lib/openapi/v1/services/SpaceService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -2
- package/lib/openapi/v1/services/SpaceSettingsService.js +4 -2
- package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
- package/lib/openapi/v1/services/TemplateService.d.ts +14 -10
- package/lib/openapi/v1/services/TemplateService.js +14 -10
- package/lib/openapi/v1/services/TemplateService.js.map +1 -1
- package/lib/openapi/v1/services/ThemesService.d.ts +11 -6
- package/lib/openapi/v1/services/ThemesService.js +11 -6
- package/lib/openapi/v1/services/ThemesService.js.map +1 -1
- package/lib/openapi/v1/services/UserPropertiesService.d.ts +10 -5
- package/lib/openapi/v1/services/UserPropertiesService.js +10 -5
- package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/UsersService.d.ts +14 -7
- package/lib/openapi/v1/services/UsersService.js +14 -7
- package/lib/openapi/v1/services/UsersService.js.map +1 -1
- package/lib/openapi/v2/services/AncestorsService.d.ts +8 -4
- package/lib/openapi/v2/services/AncestorsService.js +8 -4
- package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
- package/lib/openapi/v2/services/AttachmentService.d.ts +15 -9
- package/lib/openapi/v2/services/AttachmentService.js +15 -9
- package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
- package/lib/openapi/v2/services/BlogPostService.d.ts +15 -9
- package/lib/openapi/v2/services/BlogPostService.js +15 -9
- package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
- package/lib/openapi/v2/services/ChildrenService.d.ts +4 -2
- package/lib/openapi/v2/services/ChildrenService.js +4 -2
- package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
- package/lib/openapi/v2/services/ClassificationLevelService.d.ts +19 -10
- package/lib/openapi/v2/services/ClassificationLevelService.js +19 -10
- package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
- package/lib/openapi/v2/services/CommentService.d.ts +36 -18
- package/lib/openapi/v2/services/CommentService.js +36 -18
- package/lib/openapi/v2/services/CommentService.js.map +1 -1
- package/lib/openapi/v2/services/ContentPropertiesService.d.ts +80 -40
- package/lib/openapi/v2/services/ContentPropertiesService.js +80 -40
- package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/ContentService.d.ts +3 -3
- package/lib/openapi/v2/services/ContentService.js +3 -3
- package/lib/openapi/v2/services/CustomContentService.d.ts +16 -8
- package/lib/openapi/v2/services/CustomContentService.js +16 -8
- package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
- package/lib/openapi/v2/services/DataPoliciesService.d.ts +3 -2
- package/lib/openapi/v2/services/DataPoliciesService.js +3 -2
- package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
- package/lib/openapi/v2/services/DatabaseService.d.ts +6 -3
- package/lib/openapi/v2/services/DatabaseService.js +6 -3
- package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
- package/lib/openapi/v2/services/LabelService.d.ts +14 -7
- package/lib/openapi/v2/services/LabelService.js +14 -7
- package/lib/openapi/v2/services/LabelService.js.map +1 -1
- package/lib/openapi/v2/services/LikeService.d.ts +16 -8
- package/lib/openapi/v2/services/LikeService.js +16 -8
- package/lib/openapi/v2/services/LikeService.js.map +1 -1
- package/lib/openapi/v2/services/OperationService.d.ts +20 -10
- package/lib/openapi/v2/services/OperationService.js +20 -10
- package/lib/openapi/v2/services/OperationService.js.map +1 -1
- package/lib/openapi/v2/services/PageService.d.ts +23 -9
- package/lib/openapi/v2/services/PageService.js +14 -7
- package/lib/openapi/v2/services/PageService.js.map +1 -1
- package/lib/openapi/v2/services/SmartLinkService.d.ts +6 -3
- package/lib/openapi/v2/services/SmartLinkService.js +6 -3
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePermissionsService.d.ts +2 -1
- package/lib/openapi/v2/services/SpacePermissionsService.js +2 -1
- package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePropertiesService.d.ts +11 -7
- package/lib/openapi/v2/services/SpacePropertiesService.js +11 -7
- package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/SpaceService.d.ts +4 -2
- package/lib/openapi/v2/services/SpaceService.js +4 -2
- package/lib/openapi/v2/services/SpaceService.js.map +1 -1
- package/lib/openapi/v2/services/TaskService.d.ts +6 -3
- package/lib/openapi/v2/services/TaskService.js +6 -3
- package/lib/openapi/v2/services/TaskService.js.map +1 -1
- package/lib/openapi/v2/services/UserService.d.ts +7 -5
- package/lib/openapi/v2/services/UserService.js +7 -5
- package/lib/openapi/v2/services/UserService.js.map +1 -1
- package/lib/openapi/v2/services/VersionService.d.ts +24 -12
- package/lib/openapi/v2/services/VersionService.js +24 -12
- package/lib/openapi/v2/services/VersionService.js.map +1 -1
- package/lib/openapi/v2/services/WhiteboardService.d.ts +6 -3
- package/lib/openapi/v2/services/WhiteboardService.js +6 -3
- package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
- package/package.json +3 -3
|
@@ -10,9 +10,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
10
10
|
* Permission to update the attachment.
|
|
11
11
|
*
|
|
12
12
|
* @returns Returned if the content property was created successfully.
|
|
13
|
-
* @path
|
|
13
|
+
* @path POST `/attachments/{attachment-id}/properties`
|
|
14
14
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
15
15
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-post
|
|
16
|
+
* @param params
|
|
16
17
|
*/
|
|
17
18
|
createAttachmentProperty: ({ attachmentId, contentPropertyCreateRequest, }: {
|
|
18
19
|
/** The ID of the attachment to create a property for. */
|
|
@@ -27,9 +28,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
27
28
|
* Permission to update the blog post.
|
|
28
29
|
*
|
|
29
30
|
* @returns Returned if the content property was created successfully.
|
|
30
|
-
* @path
|
|
31
|
+
* @path POST `/blogposts/{blogpost-id}/properties`
|
|
31
32
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
32
33
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-post
|
|
34
|
+
* @param params
|
|
33
35
|
*/
|
|
34
36
|
createBlogpostProperty: ({ blogpostId, contentPropertyCreateRequest, }: {
|
|
35
37
|
/** The ID of the blog post to create a property for. */
|
|
@@ -44,9 +46,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
44
46
|
* Permission to update the comment.
|
|
45
47
|
*
|
|
46
48
|
* @returns Returned if the content property was created successfully.
|
|
47
|
-
* @path
|
|
49
|
+
* @path POST `/comments/{comment-id}/properties`
|
|
48
50
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
49
51
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-post
|
|
52
|
+
* @param params
|
|
50
53
|
*/
|
|
51
54
|
createCommentProperty: ({ commentId, contentPropertyCreateRequest, }: {
|
|
52
55
|
/** The ID of the comment to create a property for. */
|
|
@@ -61,9 +64,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
61
64
|
* Permission to update the custom content.
|
|
62
65
|
*
|
|
63
66
|
* @returns Returned if the content property was created successfully.
|
|
64
|
-
* @path
|
|
67
|
+
* @path POST `/custom-content/{custom-content-id}/properties`
|
|
65
68
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
66
69
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-post
|
|
70
|
+
* @param params
|
|
67
71
|
*/
|
|
68
72
|
createCustomContentProperty: ({ customContentId, contentPropertyCreateRequest, }: {
|
|
69
73
|
/** The ID of the custom content to create a property for. */
|
|
@@ -78,9 +82,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
78
82
|
* Permission to update the database.
|
|
79
83
|
*
|
|
80
84
|
* @returns Returned if the content property was created successfully.
|
|
81
|
-
* @path
|
|
85
|
+
* @path POST `/databases/{id}/properties`
|
|
82
86
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
83
87
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-post
|
|
88
|
+
* @param params
|
|
84
89
|
*/
|
|
85
90
|
createDatabaseProperty: ({ id, contentPropertyCreateRequest, }: {
|
|
86
91
|
/** The ID of the database to create a property for. */
|
|
@@ -95,9 +100,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
95
100
|
* Permission to update the page.
|
|
96
101
|
*
|
|
97
102
|
* @returns Returned if the content property was created successfully.
|
|
98
|
-
* @path
|
|
103
|
+
* @path POST `/pages/{page-id}/properties`
|
|
99
104
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
100
105
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-post
|
|
106
|
+
* @param params
|
|
101
107
|
*/
|
|
102
108
|
createPageProperty: ({ pageId, contentPropertyCreateRequest, }: {
|
|
103
109
|
/** The ID of the page to create a property for. */
|
|
@@ -112,9 +118,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
112
118
|
* Permission to update the Smart Link in the content tree.
|
|
113
119
|
*
|
|
114
120
|
* @returns Returned if the content property was created successfully.
|
|
115
|
-
* @path
|
|
121
|
+
* @path POST `/embeds/{id}/properties`
|
|
116
122
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
117
123
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-post
|
|
124
|
+
* @param params
|
|
118
125
|
*/
|
|
119
126
|
createSmartLinkProperty: ({ id, contentPropertyCreateRequest, }: {
|
|
120
127
|
/** The ID of the Smart Link in the content tree to create a property for. */
|
|
@@ -129,9 +136,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
129
136
|
* Permission to update the whiteboard.
|
|
130
137
|
*
|
|
131
138
|
* @returns Returned if the content property was created successfully.
|
|
132
|
-
* @path
|
|
139
|
+
* @path POST `/whiteboards/{id}/properties`
|
|
133
140
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
134
141
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-post
|
|
142
|
+
* @param params
|
|
135
143
|
*/
|
|
136
144
|
createWhiteboardProperty: ({ id, contentPropertyCreateRequest, }: {
|
|
137
145
|
/** The ID of the whiteboard to create a property for. */
|
|
@@ -145,9 +153,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
145
153
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
146
154
|
* Permission to attachment the page.
|
|
147
155
|
*
|
|
148
|
-
* @path
|
|
156
|
+
* @path DELETE `/attachments/{attachment-id}/properties/{property-id}`
|
|
149
157
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
150
158
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-delete
|
|
159
|
+
* @param params
|
|
151
160
|
*/
|
|
152
161
|
deleteAttachmentPropertyById: ({ attachmentId, propertyId, }: {
|
|
153
162
|
/** The ID of the attachment the property belongs to. */
|
|
@@ -161,9 +170,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
161
170
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
162
171
|
* Permission to edit the blog post.
|
|
163
172
|
*
|
|
164
|
-
* @path
|
|
173
|
+
* @path DELETE `/blogposts/{blogpost-id}/properties/{property-id}`
|
|
165
174
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
166
175
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-delete
|
|
176
|
+
* @param params
|
|
167
177
|
*/
|
|
168
178
|
deleteBlogpostPropertyById: ({ blogpostId, propertyId, }: {
|
|
169
179
|
/** The ID of the blog post the property belongs to. */
|
|
@@ -177,9 +187,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
177
187
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
178
188
|
* Permission to edit the comment.
|
|
179
189
|
*
|
|
180
|
-
* @path
|
|
190
|
+
* @path DELETE `/comments/{comment-id}/properties/{property-id}`
|
|
181
191
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
182
192
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-delete
|
|
193
|
+
* @param params
|
|
183
194
|
*/
|
|
184
195
|
deleteCommentPropertyById: ({ commentId, propertyId, }: {
|
|
185
196
|
/** The ID of the comment the property belongs to. */
|
|
@@ -193,9 +204,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
193
204
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
194
205
|
* Permission to edit the custom content.
|
|
195
206
|
*
|
|
196
|
-
* @path
|
|
207
|
+
* @path DELETE `/custom-content/{custom-content-id}/properties/{property-id}`
|
|
197
208
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
198
209
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-delete
|
|
210
|
+
* @param params
|
|
199
211
|
*/
|
|
200
212
|
deleteCustomContentPropertyById: ({ customContentId, propertyId, }: {
|
|
201
213
|
/** The ID of the custom content the property belongs to. */
|
|
@@ -209,9 +221,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
209
221
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
210
222
|
* Permission to edit the database.
|
|
211
223
|
*
|
|
212
|
-
* @path
|
|
224
|
+
* @path DELETE `/databases/{database-id}/properties/{property-id}`
|
|
213
225
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
214
226
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-delete
|
|
227
|
+
* @param params
|
|
215
228
|
*/
|
|
216
229
|
deleteDatabasePropertyById: ({ databaseId, propertyId, }: {
|
|
217
230
|
/** The ID of the database the property belongs to. */
|
|
@@ -225,9 +238,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
225
238
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
226
239
|
* Permission to edit the page.
|
|
227
240
|
*
|
|
228
|
-
* @path
|
|
241
|
+
* @path DELETE `/pages/{page-id}/properties/{property-id}`
|
|
229
242
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
230
243
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-delete
|
|
244
|
+
* @param params
|
|
231
245
|
*/
|
|
232
246
|
deletePagePropertyById: ({ pageId, propertyId, }: {
|
|
233
247
|
/** The ID of the page the property belongs to. */
|
|
@@ -241,9 +255,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
241
255
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
242
256
|
* Permission to edit the Smart Link in the content tree.
|
|
243
257
|
*
|
|
244
|
-
* @path
|
|
258
|
+
* @path DELETE `/embeds/{embed-id}/properties/{property-id}`
|
|
245
259
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
246
260
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-delete
|
|
261
|
+
* @param params
|
|
247
262
|
*/
|
|
248
263
|
deleteSmartLinkPropertyById: ({ embedId, propertyId, }: {
|
|
249
264
|
/** The ID of the Smart Link in the content tree the property belongs to. */
|
|
@@ -257,9 +272,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
257
272
|
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
258
273
|
* Permission to edit the whiteboard.
|
|
259
274
|
*
|
|
260
|
-
* @path
|
|
275
|
+
* @path DELETE `/whiteboards/{whiteboard-id}/properties/{property-id}`
|
|
261
276
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
262
277
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-delete
|
|
278
|
+
* @param params
|
|
263
279
|
*/
|
|
264
280
|
deleteWhiteboardPropertyById: ({ whiteboardId, propertyId, }: {
|
|
265
281
|
/** The ID of the whiteboard the property belongs to. */
|
|
@@ -274,9 +290,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
274
290
|
* Permission to view the attachment.
|
|
275
291
|
*
|
|
276
292
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
277
|
-
* @path
|
|
293
|
+
* @path GET `/attachments/{attachment-id}/properties`
|
|
278
294
|
* @scopes-current read:attachment:confluence
|
|
279
295
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-get
|
|
296
|
+
* @param params
|
|
280
297
|
*/
|
|
281
298
|
getAttachmentContentProperties: ({ attachmentId, key, sort, cursor, limit, }: {
|
|
282
299
|
/** The ID of the attachment for which content properties should be returned. */
|
|
@@ -314,9 +331,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
314
331
|
* Permission to view the attachment.
|
|
315
332
|
*
|
|
316
333
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
317
|
-
* @path
|
|
334
|
+
* @path GET `/attachments/{attachment-id}/properties/{property-id}`
|
|
318
335
|
* @scopes-current read:attachment:confluence
|
|
319
336
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-get
|
|
337
|
+
* @param params
|
|
320
338
|
*/
|
|
321
339
|
getAttachmentContentPropertiesById: ({ attachmentId, propertyId, }: {
|
|
322
340
|
/** The ID of the attachment for which content properties should be returned. */
|
|
@@ -331,9 +349,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
331
349
|
* Permission to view the blog post.
|
|
332
350
|
*
|
|
333
351
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
334
|
-
* @path
|
|
352
|
+
* @path GET `/blogposts/{blogpost-id}/properties`
|
|
335
353
|
* @scopes-current read:page:confluence
|
|
336
354
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-get
|
|
355
|
+
* @param params
|
|
337
356
|
*/
|
|
338
357
|
getBlogpostContentProperties: ({ blogpostId, key, sort, cursor, limit, }: {
|
|
339
358
|
/** The ID of the blog post for which content properties should be returned. */
|
|
@@ -371,9 +390,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
371
390
|
* Permission to view the blog post.
|
|
372
391
|
*
|
|
373
392
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
374
|
-
* @path
|
|
393
|
+
* @path GET `/blogposts/{blogpost-id}/properties/{property-id}`
|
|
375
394
|
* @scopes-current read:page:confluence
|
|
376
395
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-get
|
|
396
|
+
* @param params
|
|
377
397
|
*/
|
|
378
398
|
getBlogpostContentPropertiesById: ({ blogpostId, propertyId, }: {
|
|
379
399
|
/** The ID of the blog post for which content properties should be returned. */
|
|
@@ -388,9 +408,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
388
408
|
* Permission to view the comment.
|
|
389
409
|
*
|
|
390
410
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
391
|
-
* @path
|
|
411
|
+
* @path GET `/comments/{comment-id}/properties`
|
|
392
412
|
* @scopes-current read:comment:confluence
|
|
393
413
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-get
|
|
414
|
+
* @param params
|
|
394
415
|
*/
|
|
395
416
|
getCommentContentProperties: ({ commentId, key, sort, cursor, limit, }: {
|
|
396
417
|
/** The ID of the comment for which content properties should be returned. */
|
|
@@ -428,9 +449,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
428
449
|
* Permission to view the comment.
|
|
429
450
|
*
|
|
430
451
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
431
|
-
* @path
|
|
452
|
+
* @path GET `/comments/{comment-id}/properties/{property-id}`
|
|
432
453
|
* @scopes-current read:comment:confluence
|
|
433
454
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-get
|
|
455
|
+
* @param params
|
|
434
456
|
*/
|
|
435
457
|
getCommentContentPropertiesById: ({ commentId, propertyId, }: {
|
|
436
458
|
/** The ID of the comment for which content properties should be returned. */
|
|
@@ -445,9 +467,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
445
467
|
* Permission to view the custom content.
|
|
446
468
|
*
|
|
447
469
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
448
|
-
* @path
|
|
470
|
+
* @path GET `/custom-content/{custom-content-id}/properties`
|
|
449
471
|
* @scopes-current read:custom-content:confluence
|
|
450
472
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-get
|
|
473
|
+
* @param params
|
|
451
474
|
*/
|
|
452
475
|
getCustomContentContentProperties: ({ customContentId, key, sort, cursor, limit, }: {
|
|
453
476
|
/** The ID of the custom content for which content properties should be returned. */
|
|
@@ -485,9 +508,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
485
508
|
* Permission to view the page.
|
|
486
509
|
*
|
|
487
510
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
488
|
-
* @path
|
|
511
|
+
* @path GET `/custom-content/{custom-content-id}/properties/{property-id}`
|
|
489
512
|
* @scopes-current read:custom-content:confluence
|
|
490
513
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-get
|
|
514
|
+
* @param params
|
|
491
515
|
*/
|
|
492
516
|
getCustomContentContentPropertiesById: ({ customContentId, propertyId, }: {
|
|
493
517
|
/** The ID of the custom content for which content properties should be returned. */
|
|
@@ -502,9 +526,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
502
526
|
* Permission to view the database.
|
|
503
527
|
*
|
|
504
528
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
505
|
-
* @path
|
|
529
|
+
* @path GET `/databases/{id}/properties`
|
|
506
530
|
* @scopes-current read:database:confluence
|
|
507
531
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-get
|
|
532
|
+
* @param params
|
|
508
533
|
*/
|
|
509
534
|
getDatabaseContentProperties: ({ id, key, sort, cursor, limit, }: {
|
|
510
535
|
/** The ID of the database for which content properties should be returned. */
|
|
@@ -542,9 +567,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
542
567
|
* Permission to view the database.
|
|
543
568
|
*
|
|
544
569
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
545
|
-
* @path
|
|
570
|
+
* @path GET `/databases/{database-id}/properties/{property-id}`
|
|
546
571
|
* @scopes-current read:database:confluence
|
|
547
572
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-get
|
|
573
|
+
* @param params
|
|
548
574
|
*/
|
|
549
575
|
getDatabaseContentPropertiesById: ({ databaseId, propertyId, }: {
|
|
550
576
|
/** The ID of the database for which content properties should be returned. */
|
|
@@ -559,9 +585,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
559
585
|
* Permission to view the page.
|
|
560
586
|
*
|
|
561
587
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
562
|
-
* @path
|
|
588
|
+
* @path GET `/pages/{page-id}/properties`
|
|
563
589
|
* @scopes-current read:page:confluence
|
|
564
590
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-get
|
|
591
|
+
* @param params
|
|
565
592
|
*/
|
|
566
593
|
getPageContentProperties: ({ pageId, key, sort, cursor, limit, }: {
|
|
567
594
|
/** The ID of the page for which content properties should be returned. */
|
|
@@ -599,9 +626,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
599
626
|
* Permission to view the page.
|
|
600
627
|
*
|
|
601
628
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
602
|
-
* @path
|
|
629
|
+
* @path GET `/pages/{page-id}/properties/{property-id}`
|
|
603
630
|
* @scopes-current read:page:confluence
|
|
604
631
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-get
|
|
632
|
+
* @param params
|
|
605
633
|
*/
|
|
606
634
|
getPageContentPropertiesById: ({ pageId, propertyId, }: {
|
|
607
635
|
/** The ID of the page for which content properties should be returned. */
|
|
@@ -616,9 +644,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
616
644
|
* Permission to view the Smart Link in the content tree.
|
|
617
645
|
*
|
|
618
646
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
619
|
-
* @path
|
|
647
|
+
* @path GET `/embeds/{id}/properties`
|
|
620
648
|
* @scopes-current read:embed:confluence
|
|
621
649
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-get
|
|
650
|
+
* @param params
|
|
622
651
|
*/
|
|
623
652
|
getSmartLinkContentProperties: ({ id, key, sort, cursor, limit, }: {
|
|
624
653
|
/**
|
|
@@ -659,9 +688,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
659
688
|
* Permission to view the Smart Link in the content tree.
|
|
660
689
|
*
|
|
661
690
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
662
|
-
* @path
|
|
691
|
+
* @path GET `/embeds/{embed-id}/properties/{property-id}`
|
|
663
692
|
* @scopes-current read:embed:confluence
|
|
664
693
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-get
|
|
694
|
+
* @param params
|
|
665
695
|
*/
|
|
666
696
|
getSmartLinkContentPropertiesById: ({ embedId, propertyId, }: {
|
|
667
697
|
/**
|
|
@@ -679,9 +709,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
679
709
|
* Permission to view the whiteboard.
|
|
680
710
|
*
|
|
681
711
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
682
|
-
* @path
|
|
712
|
+
* @path GET `/whiteboards/{id}/properties`
|
|
683
713
|
* @scopes-current read:whiteboard:confluence
|
|
684
714
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-get
|
|
715
|
+
* @param params
|
|
685
716
|
*/
|
|
686
717
|
getWhiteboardContentProperties: ({ id, key, sort, cursor, limit, }: {
|
|
687
718
|
/** The ID of the whiteboard for which content properties should be returned. */
|
|
@@ -719,9 +750,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
719
750
|
* Permission to view the whiteboard.
|
|
720
751
|
*
|
|
721
752
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
722
|
-
* @path
|
|
753
|
+
* @path GET `/whiteboards/{whiteboard-id}/properties/{property-id}`
|
|
723
754
|
* @scopes-current read:whiteboard:confluence
|
|
724
755
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-get
|
|
756
|
+
* @param params
|
|
725
757
|
*/
|
|
726
758
|
getWhiteboardContentPropertiesById: ({ whiteboardId, propertyId, }: {
|
|
727
759
|
/** The ID of the whiteboard for which content properties should be returned. */
|
|
@@ -736,9 +768,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
736
768
|
* Permission to edit the attachment.
|
|
737
769
|
*
|
|
738
770
|
* @returns Returned if the content property was updated successfully.
|
|
739
|
-
* @path
|
|
771
|
+
* @path PUT `/attachments/{attachment-id}/properties/{property-id}`
|
|
740
772
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
741
773
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-put
|
|
774
|
+
* @param params
|
|
742
775
|
*/
|
|
743
776
|
updateAttachmentPropertyById: ({ attachmentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
744
777
|
/** The ID of the attachment the property belongs to. */
|
|
@@ -755,9 +788,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
755
788
|
* Permission to edit the blog post.
|
|
756
789
|
*
|
|
757
790
|
* @returns Returned if the content property was updated successfully.
|
|
758
|
-
* @path
|
|
791
|
+
* @path PUT `/blogposts/{blogpost-id}/properties/{property-id}`
|
|
759
792
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
760
793
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-put
|
|
794
|
+
* @param params
|
|
761
795
|
*/
|
|
762
796
|
updateBlogpostPropertyById: ({ blogpostId, propertyId, contentPropertyUpdateRequest, }: {
|
|
763
797
|
/** The ID of the blog post the property belongs to. */
|
|
@@ -774,9 +808,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
774
808
|
* Permission to edit the comment.
|
|
775
809
|
*
|
|
776
810
|
* @returns Returned if the content property was updated successfully.
|
|
777
|
-
* @path
|
|
811
|
+
* @path PUT `/comments/{comment-id}/properties/{property-id}`
|
|
778
812
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
779
813
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-put
|
|
814
|
+
* @param params
|
|
780
815
|
*/
|
|
781
816
|
updateCommentPropertyById: ({ commentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
782
817
|
/** The ID of the comment the property belongs to. */
|
|
@@ -793,9 +828,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
793
828
|
* Permission to edit the custom content.
|
|
794
829
|
*
|
|
795
830
|
* @returns Returned if the content property was updated successfully.
|
|
796
|
-
* @path
|
|
831
|
+
* @path PUT `/custom-content/{custom-content-id}/properties/{property-id}`
|
|
797
832
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
798
833
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-put
|
|
834
|
+
* @param params
|
|
799
835
|
*/
|
|
800
836
|
updateCustomContentPropertyById: ({ customContentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
801
837
|
/** The ID of the custom content the property belongs to. */
|
|
@@ -812,9 +848,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
812
848
|
* Permission to edit the database.
|
|
813
849
|
*
|
|
814
850
|
* @returns Returned if the content property was updated successfully.
|
|
815
|
-
* @path
|
|
851
|
+
* @path PUT `/databases/{database-id}/properties/{property-id}`
|
|
816
852
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
817
853
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-put
|
|
854
|
+
* @param params
|
|
818
855
|
*/
|
|
819
856
|
updateDatabasePropertyById: ({ databaseId, propertyId, contentPropertyUpdateRequest, }: {
|
|
820
857
|
/** The ID of the database the property belongs to. */
|
|
@@ -831,9 +868,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
831
868
|
* Permission to edit the page.
|
|
832
869
|
*
|
|
833
870
|
* @returns Returned if the content property was updated successfully.
|
|
834
|
-
* @path
|
|
871
|
+
* @path PUT `/pages/{page-id}/properties/{property-id}`
|
|
835
872
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
836
873
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-put
|
|
874
|
+
* @param params
|
|
837
875
|
*/
|
|
838
876
|
updatePagePropertyById: ({ pageId, propertyId, contentPropertyUpdateRequest, }: {
|
|
839
877
|
/** The ID of the page the property belongs to. */
|
|
@@ -850,9 +888,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
850
888
|
* Permission to edit the Smart Link in the content tree.
|
|
851
889
|
*
|
|
852
890
|
* @returns Returned if the content property was updated successfully.
|
|
853
|
-
* @path
|
|
891
|
+
* @path PUT `/embeds/{embed-id}/properties/{property-id}`
|
|
854
892
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
855
893
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-put
|
|
894
|
+
* @param params
|
|
856
895
|
*/
|
|
857
896
|
updateSmartLinkPropertyById: ({ embedId, propertyId, contentPropertyUpdateRequest, }: {
|
|
858
897
|
/** The ID of the Smart Link in the content tree the property belongs to. */
|
|
@@ -869,9 +908,10 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
869
908
|
* Permission to edit the whiteboard.
|
|
870
909
|
*
|
|
871
910
|
* @returns Returned if the content property was updated successfully.
|
|
872
|
-
* @path
|
|
911
|
+
* @path PUT `/whiteboards/{whiteboard-id}/properties/{property-id}`
|
|
873
912
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
874
913
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-put
|
|
914
|
+
* @param params
|
|
875
915
|
*/
|
|
876
916
|
updateWhiteboardPropertyById: ({ whiteboardId, propertyId, contentPropertyUpdateRequest, }: {
|
|
877
917
|
/** The ID of the whiteboard the property belongs to. */
|