@resolution/confluence-api-client 0.4.0 → 0.4.2
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 +23 -0
- package/README.md +125 -1
- package/lib/index.js +1 -1
- package/lib/index.js.map +1 -1
- package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +49 -5
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js +49 -5
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
- package/lib/openapi/v1/services/AnalyticsService.d.ts +3 -0
- package/lib/openapi/v1/services/AnalyticsService.js +3 -0
- package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
- package/lib/openapi/v1/services/AuditService.d.ts +10 -3
- package/lib/openapi/v1/services/AuditService.js +10 -3
- package/lib/openapi/v1/services/AuditService.js.map +1 -1
- package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +7 -0
- package/lib/openapi/v1/services/ContentAttachmentsService.js +7 -0
- package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentBodyService.d.ts +4 -0
- package/lib/openapi/v1/services/ContentBodyService.js +4 -0
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +8 -0
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +8 -0
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentCommentsService.d.ts +5 -1
- package/lib/openapi/v1/services/ContentCommentsService.js +5 -1
- package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentLabelsService.d.ts +5 -0
- package/lib/openapi/v1/services/ContentLabelsService.js +5 -0
- package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +4 -0
- package/lib/openapi/v1/services/ContentMacroBodyService.js +4 -0
- package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -0
- package/lib/openapi/v1/services/ContentPermissionsService.js +2 -0
- package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPropertiesService.d.ts +10 -1
- package/lib/openapi/v1/services/ContentPropertiesService.js +10 -1
- package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +16 -0
- package/lib/openapi/v1/services/ContentRestrictionsService.js +16 -0
- package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentService.d.ts +12 -1
- package/lib/openapi/v1/services/ContentService.js +12 -1
- package/lib/openapi/v1/services/ContentService.js.map +1 -1
- package/lib/openapi/v1/services/ContentStatesService.d.ts +11 -0
- package/lib/openapi/v1/services/ContentStatesService.js +11 -0
- package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentVersionsService.d.ts +5 -0
- package/lib/openapi/v1/services/ContentVersionsService.js +5 -0
- package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentWatchesService.d.ts +13 -0
- package/lib/openapi/v1/services/ContentWatchesService.js +13 -0
- package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
- package/lib/openapi/v1/services/DynamicModulesService.d.ts +4 -0
- package/lib/openapi/v1/services/DynamicModulesService.js +4 -0
- package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
- package/lib/openapi/v1/services/ExperimentalService.d.ts +9 -1
- package/lib/openapi/v1/services/ExperimentalService.js +9 -1
- package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
- package/lib/openapi/v1/services/GroupService.d.ts +18 -1
- package/lib/openapi/v1/services/GroupService.js +18 -1
- package/lib/openapi/v1/services/GroupService.js.map +1 -1
- package/lib/openapi/v1/services/InlineTasksService.d.ts +8 -2
- package/lib/openapi/v1/services/InlineTasksService.js +8 -2
- package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
- package/lib/openapi/v1/services/LabelInfoService.d.ts +2 -0
- package/lib/openapi/v1/services/LabelInfoService.js +2 -0
- package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
- package/lib/openapi/v1/services/LongRunningTaskService.d.ts +4 -1
- package/lib/openapi/v1/services/LongRunningTaskService.js +4 -1
- package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
- package/lib/openapi/v1/services/RelationService.d.ts +6 -0
- package/lib/openapi/v1/services/RelationService.js +6 -0
- package/lib/openapi/v1/services/RelationService.js.map +1 -1
- package/lib/openapi/v1/services/SearchService.d.ts +3 -0
- package/lib/openapi/v1/services/SearchService.js +3 -0
- package/lib/openapi/v1/services/SearchService.js.map +1 -1
- package/lib/openapi/v1/services/SettingsService.d.ts +9 -2
- package/lib/openapi/v1/services/SettingsService.js +9 -2
- package/lib/openapi/v1/services/SettingsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePermissionsService.d.ts +4 -0
- package/lib/openapi/v1/services/SpacePermissionsService.js +4 -0
- package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePropertiesService.d.ts +10 -1
- package/lib/openapi/v1/services/SpacePropertiesService.js +10 -1
- package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceService.d.ts +10 -1
- package/lib/openapi/v1/services/SpaceService.js +10 -1
- package/lib/openapi/v1/services/SpaceService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceSettingsService.d.ts +3 -0
- package/lib/openapi/v1/services/SpaceSettingsService.js +3 -0
- package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
- package/lib/openapi/v1/services/TemplateService.d.ts +9 -2
- package/lib/openapi/v1/services/TemplateService.js +9 -2
- package/lib/openapi/v1/services/TemplateService.js.map +1 -1
- package/lib/openapi/v1/services/ThemesService.d.ts +8 -1
- package/lib/openapi/v1/services/ThemesService.js +8 -1
- package/lib/openapi/v1/services/ThemesService.js.map +1 -1
- package/lib/openapi/v1/services/UserPropertiesService.d.ts +6 -0
- package/lib/openapi/v1/services/UserPropertiesService.js +6 -0
- package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/UsersService.d.ts +10 -2
- package/lib/openapi/v1/services/UsersService.js +10 -2
- package/lib/openapi/v1/services/UsersService.js.map +1 -1
- package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +23 -0
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js +23 -0
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
- package/lib/openapi/v2/services/AncestorsService.d.ts +5 -0
- package/lib/openapi/v2/services/AncestorsService.js +5 -0
- package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
- package/lib/openapi/v2/services/AttachmentService.d.ts +9 -1
- package/lib/openapi/v2/services/AttachmentService.js +9 -1
- package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
- package/lib/openapi/v2/services/BlogPostService.d.ts +9 -1
- package/lib/openapi/v2/services/BlogPostService.js +9 -1
- package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
- package/lib/openapi/v2/services/ChildrenService.d.ts +3 -0
- package/lib/openapi/v2/services/ChildrenService.js +3 -0
- package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
- package/lib/openapi/v2/services/ClassificationLevelService.d.ts +11 -0
- package/lib/openapi/v2/services/ClassificationLevelService.js +11 -0
- package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
- package/lib/openapi/v2/services/CommentService.d.ts +21 -2
- package/lib/openapi/v2/services/CommentService.js +21 -2
- package/lib/openapi/v2/services/CommentService.js.map +1 -1
- package/lib/openapi/v2/services/ContentPropertiesService.d.ts +41 -0
- package/lib/openapi/v2/services/ContentPropertiesService.js +41 -0
- package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/ContentService.d.ts +2 -0
- package/lib/openapi/v2/services/ContentService.js +2 -0
- package/lib/openapi/v2/services/ContentService.js.map +1 -1
- package/lib/openapi/v2/services/CustomContentService.d.ts +9 -0
- package/lib/openapi/v2/services/CustomContentService.js +9 -0
- package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
- package/lib/openapi/v2/services/DataPoliciesService.d.ts +4 -1
- package/lib/openapi/v2/services/DataPoliciesService.js +4 -1
- package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
- package/lib/openapi/v2/services/DatabaseService.d.ts +4 -0
- package/lib/openapi/v2/services/DatabaseService.js +4 -0
- package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
- package/lib/openapi/v2/services/LabelService.d.ts +9 -1
- package/lib/openapi/v2/services/LabelService.js +9 -1
- package/lib/openapi/v2/services/LabelService.js.map +1 -1
- package/lib/openapi/v2/services/LikeService.d.ts +9 -0
- package/lib/openapi/v2/services/LikeService.js +9 -0
- package/lib/openapi/v2/services/LikeService.js.map +1 -1
- package/lib/openapi/v2/services/OperationService.d.ts +11 -0
- package/lib/openapi/v2/services/OperationService.js +11 -0
- package/lib/openapi/v2/services/OperationService.js.map +1 -1
- package/lib/openapi/v2/services/PageService.d.ts +9 -1
- package/lib/openapi/v2/services/PageService.js +9 -1
- package/lib/openapi/v2/services/PageService.js.map +1 -1
- package/lib/openapi/v2/services/SmartLinkService.d.ts +4 -0
- package/lib/openapi/v2/services/SmartLinkService.js +4 -0
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePermissionsService.d.ts +2 -0
- package/lib/openapi/v2/services/SpacePermissionsService.js +2 -0
- package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePropertiesService.d.ts +6 -0
- package/lib/openapi/v2/services/SpacePropertiesService.js +6 -0
- package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/SpaceService.d.ts +4 -1
- package/lib/openapi/v2/services/SpaceService.js +4 -1
- package/lib/openapi/v2/services/SpaceService.js.map +1 -1
- package/lib/openapi/v2/services/TaskService.d.ts +5 -1
- package/lib/openapi/v2/services/TaskService.js +5 -1
- package/lib/openapi/v2/services/TaskService.js.map +1 -1
- package/lib/openapi/v2/services/UserService.d.ts +3 -0
- package/lib/openapi/v2/services/UserService.js +3 -0
- package/lib/openapi/v2/services/UserService.js.map +1 -1
- package/lib/openapi/v2/services/VersionService.d.ts +13 -0
- package/lib/openapi/v2/services/VersionService.js +13 -0
- package/lib/openapi/v2/services/VersionService.js.map +1 -1
- package/lib/openapi/v2/services/WhiteboardService.d.ts +4 -0
- package/lib/openapi/v2/services/WhiteboardService.js +4 -0
- package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
- package/package.json +4 -4
- package/lib/openapi/v1/BaseConfluenceV1ApiClient.d.ts +0 -133
- package/lib/openapi/v1/BaseConfluenceV1ApiClient.js +0 -122
- package/lib/openapi/v1/BaseConfluenceV1ApiClient.js.map +0 -1
- package/lib/openapi/v2/BaseConfluenceV2ApiClient.d.ts +0 -67
- package/lib/openapi/v2/BaseConfluenceV2ApiClient.js +0 -87
- package/lib/openapi/v2/BaseConfluenceV2ApiClient.js.map +0 -1
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { CommonHttpService } from "../core/CommonHttpService";
|
|
2
2
|
import { type ContentProperty, type MultiEntityLinks } from "../models/common";
|
|
3
3
|
import type { ContentPropertyCreateRequest, ContentPropertySortOrder, ContentPropertyUpdateRequest } from "../models/contentProperties";
|
|
4
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties */
|
|
4
5
|
export declare class ContentPropertiesService extends CommonHttpService {
|
|
5
6
|
/**
|
|
6
7
|
* Creates a new content property for an attachment.
|
|
@@ -11,6 +12,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
11
12
|
* @returns Returned if the content property was created successfully.
|
|
12
13
|
* @path {POST} /attachments/{attachment-id}/properties
|
|
13
14
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
15
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-post
|
|
14
16
|
*/
|
|
15
17
|
createAttachmentProperty({ attachmentId, contentPropertyCreateRequest, }: {
|
|
16
18
|
/** The ID of the attachment to create a property for. */
|
|
@@ -27,6 +29,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
27
29
|
* @returns Returned if the content property was created successfully.
|
|
28
30
|
* @path {POST} /blogposts/{blogpost-id}/properties
|
|
29
31
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
32
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-post
|
|
30
33
|
*/
|
|
31
34
|
createBlogpostProperty({ blogpostId, contentPropertyCreateRequest, }: {
|
|
32
35
|
/** The ID of the blog post to create a property for. */
|
|
@@ -43,6 +46,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
43
46
|
* @returns Returned if the content property was created successfully.
|
|
44
47
|
* @path {POST} /comments/{comment-id}/properties
|
|
45
48
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
49
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-post
|
|
46
50
|
*/
|
|
47
51
|
createCommentProperty({ commentId, contentPropertyCreateRequest, }: {
|
|
48
52
|
/** The ID of the comment to create a property for. */
|
|
@@ -59,6 +63,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
59
63
|
* @returns Returned if the content property was created successfully.
|
|
60
64
|
* @path {POST} /custom-content/{custom-content-id}/properties
|
|
61
65
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
66
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-post
|
|
62
67
|
*/
|
|
63
68
|
createCustomContentProperty({ customContentId, contentPropertyCreateRequest, }: {
|
|
64
69
|
/** The ID of the custom content to create a property for. */
|
|
@@ -75,6 +80,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
75
80
|
* @returns Returned if the content property was created successfully.
|
|
76
81
|
* @path {POST} /databases/{id}/properties
|
|
77
82
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
83
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-post
|
|
78
84
|
*/
|
|
79
85
|
createDatabaseProperty({ id, contentPropertyCreateRequest, }: {
|
|
80
86
|
/** The ID of the database to create a property for. */
|
|
@@ -91,6 +97,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
91
97
|
* @returns Returned if the content property was created successfully.
|
|
92
98
|
* @path {POST} /pages/{page-id}/properties
|
|
93
99
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
100
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-post
|
|
94
101
|
*/
|
|
95
102
|
createPageProperty({ pageId, contentPropertyCreateRequest, }: {
|
|
96
103
|
/** The ID of the page to create a property for. */
|
|
@@ -107,6 +114,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
107
114
|
* @returns Returned if the content property was created successfully.
|
|
108
115
|
* @path {POST} /embeds/{id}/properties
|
|
109
116
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
117
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-post
|
|
110
118
|
*/
|
|
111
119
|
createSmartLinkProperty({ id, contentPropertyCreateRequest, }: {
|
|
112
120
|
/** The ID of the Smart Link in the content tree to create a property for. */
|
|
@@ -123,6 +131,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
123
131
|
* @returns Returned if the content property was created successfully.
|
|
124
132
|
* @path {POST} /whiteboards/{id}/properties
|
|
125
133
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
134
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-post
|
|
126
135
|
*/
|
|
127
136
|
createWhiteboardProperty({ id, contentPropertyCreateRequest, }: {
|
|
128
137
|
/** The ID of the whiteboard to create a property for. */
|
|
@@ -138,6 +147,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
138
147
|
*
|
|
139
148
|
* @path {DELETE} /attachments/{attachment-id}/properties/{property-id}
|
|
140
149
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
150
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-delete
|
|
141
151
|
*/
|
|
142
152
|
deleteAttachmentPropertyById({ attachmentId, propertyId, }: {
|
|
143
153
|
/** The ID of the attachment the property belongs to. */
|
|
@@ -153,6 +163,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
153
163
|
*
|
|
154
164
|
* @path {DELETE} /blogposts/{blogpost-id}/properties/{property-id}
|
|
155
165
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
166
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-delete
|
|
156
167
|
*/
|
|
157
168
|
deleteBlogpostPropertyById({ blogpostId, propertyId, }: {
|
|
158
169
|
/** The ID of the blog post the property belongs to. */
|
|
@@ -168,6 +179,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
168
179
|
*
|
|
169
180
|
* @path {DELETE} /comments/{comment-id}/properties/{property-id}
|
|
170
181
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
182
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-delete
|
|
171
183
|
*/
|
|
172
184
|
deleteCommentPropertyById({ commentId, propertyId, }: {
|
|
173
185
|
/** The ID of the comment the property belongs to. */
|
|
@@ -183,6 +195,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
183
195
|
*
|
|
184
196
|
* @path {DELETE} /custom-content/{custom-content-id}/properties/{property-id}
|
|
185
197
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
198
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-delete
|
|
186
199
|
*/
|
|
187
200
|
deleteCustomContentPropertyById({ customContentId, propertyId, }: {
|
|
188
201
|
/** The ID of the custom content the property belongs to. */
|
|
@@ -198,6 +211,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
198
211
|
*
|
|
199
212
|
* @path {DELETE} /databases/{database-id}/properties/{property-id}
|
|
200
213
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
214
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-delete
|
|
201
215
|
*/
|
|
202
216
|
deleteDatabasePropertyById({ databaseId, propertyId, }: {
|
|
203
217
|
/** The ID of the database the property belongs to. */
|
|
@@ -213,6 +227,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
213
227
|
*
|
|
214
228
|
* @path {DELETE} /pages/{page-id}/properties/{property-id}
|
|
215
229
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
230
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-delete
|
|
216
231
|
*/
|
|
217
232
|
deletePagePropertyById({ pageId, propertyId, }: {
|
|
218
233
|
/** The ID of the page the property belongs to. */
|
|
@@ -228,6 +243,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
228
243
|
*
|
|
229
244
|
* @path {DELETE} /embeds/{embed-id}/properties/{property-id}
|
|
230
245
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
246
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-delete
|
|
231
247
|
*/
|
|
232
248
|
deleteSmartLinkPropertyById({ embedId, propertyId, }: {
|
|
233
249
|
/** The ID of the Smart Link in the content tree the property belongs to. */
|
|
@@ -243,6 +259,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
243
259
|
*
|
|
244
260
|
* @path {DELETE} /whiteboards/{whiteboard-id}/properties/{property-id}
|
|
245
261
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
262
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-delete
|
|
246
263
|
*/
|
|
247
264
|
deleteWhiteboardPropertyById({ whiteboardId, propertyId, }: {
|
|
248
265
|
/** The ID of the whiteboard the property belongs to. */
|
|
@@ -259,6 +276,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
259
276
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
260
277
|
* @path {GET} /attachments/{attachment-id}/properties
|
|
261
278
|
* @scopes-current read:attachment:confluence
|
|
279
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-get
|
|
262
280
|
*/
|
|
263
281
|
getAttachmentContentProperties({ attachmentId, key, sort, cursor, limit, }: {
|
|
264
282
|
/** The ID of the attachment for which content properties should be returned. */
|
|
@@ -298,6 +316,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
298
316
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
299
317
|
* @path {GET} /attachments/{attachment-id}/properties/{property-id}
|
|
300
318
|
* @scopes-current read:attachment:confluence
|
|
319
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-get
|
|
301
320
|
*/
|
|
302
321
|
getAttachmentContentPropertiesById({ attachmentId, propertyId, }: {
|
|
303
322
|
/** The ID of the attachment for which content properties should be returned. */
|
|
@@ -314,6 +333,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
314
333
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
315
334
|
* @path {GET} /blogposts/{blogpost-id}/properties
|
|
316
335
|
* @scopes-current read:page:confluence
|
|
336
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-get
|
|
317
337
|
*/
|
|
318
338
|
getBlogpostContentProperties({ blogpostId, key, sort, cursor, limit, }: {
|
|
319
339
|
/** The ID of the blog post for which content properties should be returned. */
|
|
@@ -353,6 +373,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
353
373
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
354
374
|
* @path {GET} /blogposts/{blogpost-id}/properties/{property-id}
|
|
355
375
|
* @scopes-current read:page:confluence
|
|
376
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-get
|
|
356
377
|
*/
|
|
357
378
|
getBlogpostContentPropertiesById({ blogpostId, propertyId, }: {
|
|
358
379
|
/** The ID of the blog post for which content properties should be returned. */
|
|
@@ -369,6 +390,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
369
390
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
370
391
|
* @path {GET} /comments/{comment-id}/properties
|
|
371
392
|
* @scopes-current read:comment:confluence
|
|
393
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-get
|
|
372
394
|
*/
|
|
373
395
|
getCommentContentProperties({ commentId, key, sort, cursor, limit, }: {
|
|
374
396
|
/** The ID of the comment for which content properties should be returned. */
|
|
@@ -408,6 +430,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
408
430
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
409
431
|
* @path {GET} /comments/{comment-id}/properties/{property-id}
|
|
410
432
|
* @scopes-current read:comment:confluence
|
|
433
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-get
|
|
411
434
|
*/
|
|
412
435
|
getCommentContentPropertiesById({ commentId, propertyId, }: {
|
|
413
436
|
/** The ID of the comment for which content properties should be returned. */
|
|
@@ -424,6 +447,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
424
447
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
425
448
|
* @path {GET} /custom-content/{custom-content-id}/properties
|
|
426
449
|
* @scopes-current read:custom-content:confluence
|
|
450
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-get
|
|
427
451
|
*/
|
|
428
452
|
getCustomContentContentProperties({ customContentId, key, sort, cursor, limit, }: {
|
|
429
453
|
/** The ID of the custom content for which content properties should be returned. */
|
|
@@ -463,6 +487,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
463
487
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
464
488
|
* @path {GET} /custom-content/{custom-content-id}/properties/{property-id}
|
|
465
489
|
* @scopes-current read:custom-content:confluence
|
|
490
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-get
|
|
466
491
|
*/
|
|
467
492
|
getCustomContentContentPropertiesById({ customContentId, propertyId, }: {
|
|
468
493
|
/** The ID of the custom content for which content properties should be returned. */
|
|
@@ -479,6 +504,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
479
504
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
480
505
|
* @path {GET} /databases/{id}/properties
|
|
481
506
|
* @scopes-current read:database:confluence
|
|
507
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-get
|
|
482
508
|
*/
|
|
483
509
|
getDatabaseContentProperties({ id, key, sort, cursor, limit, }: {
|
|
484
510
|
/** The ID of the database for which content properties should be returned. */
|
|
@@ -518,6 +544,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
518
544
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
519
545
|
* @path {GET} /databases/{database-id}/properties/{property-id}
|
|
520
546
|
* @scopes-current read:database:confluence
|
|
547
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-get
|
|
521
548
|
*/
|
|
522
549
|
getDatabaseContentPropertiesById({ databaseId, propertyId, }: {
|
|
523
550
|
/** The ID of the database for which content properties should be returned. */
|
|
@@ -534,6 +561,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
534
561
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
535
562
|
* @path {GET} /pages/{page-id}/properties
|
|
536
563
|
* @scopes-current read:page:confluence
|
|
564
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-get
|
|
537
565
|
*/
|
|
538
566
|
getPageContentProperties({ pageId, key, sort, cursor, limit, }: {
|
|
539
567
|
/** The ID of the page for which content properties should be returned. */
|
|
@@ -573,6 +601,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
573
601
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
574
602
|
* @path {GET} /pages/{page-id}/properties/{property-id}
|
|
575
603
|
* @scopes-current read:page:confluence
|
|
604
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-get
|
|
576
605
|
*/
|
|
577
606
|
getPageContentPropertiesById({ pageId, propertyId, }: {
|
|
578
607
|
/** The ID of the page for which content properties should be returned. */
|
|
@@ -589,6 +618,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
589
618
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
590
619
|
* @path {GET} /embeds/{id}/properties
|
|
591
620
|
* @scopes-current read:embed:confluence
|
|
621
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-get
|
|
592
622
|
*/
|
|
593
623
|
getSmartLinkContentProperties({ id, key, sort, cursor, limit, }: {
|
|
594
624
|
/**
|
|
@@ -631,6 +661,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
631
661
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
632
662
|
* @path {GET} /embeds/{embed-id}/properties/{property-id}
|
|
633
663
|
* @scopes-current read:embed:confluence
|
|
664
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-get
|
|
634
665
|
*/
|
|
635
666
|
getSmartLinkContentPropertiesById({ embedId, propertyId, }: {
|
|
636
667
|
/**
|
|
@@ -650,6 +681,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
650
681
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
651
682
|
* @path {GET} /whiteboards/{id}/properties
|
|
652
683
|
* @scopes-current read:whiteboard:confluence
|
|
684
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-get
|
|
653
685
|
*/
|
|
654
686
|
getWhiteboardContentProperties({ id, key, sort, cursor, limit, }: {
|
|
655
687
|
/** The ID of the whiteboard for which content properties should be returned. */
|
|
@@ -689,6 +721,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
689
721
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
690
722
|
* @path {GET} /whiteboards/{whiteboard-id}/properties/{property-id}
|
|
691
723
|
* @scopes-current read:whiteboard:confluence
|
|
724
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-get
|
|
692
725
|
*/
|
|
693
726
|
getWhiteboardContentPropertiesById({ whiteboardId, propertyId, }: {
|
|
694
727
|
/** The ID of the whiteboard for which content properties should be returned. */
|
|
@@ -705,6 +738,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
705
738
|
* @returns Returned if the content property was updated successfully.
|
|
706
739
|
* @path {PUT} /attachments/{attachment-id}/properties/{property-id}
|
|
707
740
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
741
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-put
|
|
708
742
|
*/
|
|
709
743
|
updateAttachmentPropertyById({ attachmentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
710
744
|
/** The ID of the attachment the property belongs to. */
|
|
@@ -723,6 +757,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
723
757
|
* @returns Returned if the content property was updated successfully.
|
|
724
758
|
* @path {PUT} /blogposts/{blogpost-id}/properties/{property-id}
|
|
725
759
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
760
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-put
|
|
726
761
|
*/
|
|
727
762
|
updateBlogpostPropertyById({ blogpostId, propertyId, contentPropertyUpdateRequest, }: {
|
|
728
763
|
/** The ID of the blog post the property belongs to. */
|
|
@@ -741,6 +776,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
741
776
|
* @returns Returned if the content property was updated successfully.
|
|
742
777
|
* @path {PUT} /comments/{comment-id}/properties/{property-id}
|
|
743
778
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
779
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-put
|
|
744
780
|
*/
|
|
745
781
|
updateCommentPropertyById({ commentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
746
782
|
/** The ID of the comment the property belongs to. */
|
|
@@ -759,6 +795,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
759
795
|
* @returns Returned if the content property was updated successfully.
|
|
760
796
|
* @path {PUT} /custom-content/{custom-content-id}/properties/{property-id}
|
|
761
797
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
798
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-put
|
|
762
799
|
*/
|
|
763
800
|
updateCustomContentPropertyById({ customContentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
764
801
|
/** The ID of the custom content the property belongs to. */
|
|
@@ -777,6 +814,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
777
814
|
* @returns Returned if the content property was updated successfully.
|
|
778
815
|
* @path {PUT} /databases/{database-id}/properties/{property-id}
|
|
779
816
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
817
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-put
|
|
780
818
|
*/
|
|
781
819
|
updateDatabasePropertyById({ databaseId, propertyId, contentPropertyUpdateRequest, }: {
|
|
782
820
|
/** The ID of the database the property belongs to. */
|
|
@@ -795,6 +833,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
795
833
|
* @returns Returned if the content property was updated successfully.
|
|
796
834
|
* @path {PUT} /pages/{page-id}/properties/{property-id}
|
|
797
835
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
836
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-put
|
|
798
837
|
*/
|
|
799
838
|
updatePagePropertyById({ pageId, propertyId, contentPropertyUpdateRequest, }: {
|
|
800
839
|
/** The ID of the page the property belongs to. */
|
|
@@ -813,6 +852,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
813
852
|
* @returns Returned if the content property was updated successfully.
|
|
814
853
|
* @path {PUT} /embeds/{embed-id}/properties/{property-id}
|
|
815
854
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
855
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-put
|
|
816
856
|
*/
|
|
817
857
|
updateSmartLinkPropertyById({ embedId, propertyId, contentPropertyUpdateRequest, }: {
|
|
818
858
|
/** The ID of the Smart Link in the content tree the property belongs to. */
|
|
@@ -831,6 +871,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
831
871
|
* @returns Returned if the content property was updated successfully.
|
|
832
872
|
* @path {PUT} /whiteboards/{whiteboard-id}/properties/{property-id}
|
|
833
873
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
874
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-put
|
|
834
875
|
*/
|
|
835
876
|
updateWhiteboardPropertyById({ whiteboardId, propertyId, contentPropertyUpdateRequest, }: {
|
|
836
877
|
/** The ID of the whiteboard the property belongs to. */
|
|
@@ -9,6 +9,7 @@ const commonHttpClient = require("../core/CommonHttpClient");
|
|
|
9
9
|
const CommonHttpService_1 = require("../core/CommonHttpService");
|
|
10
10
|
const common_1 = require("../models/common");
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
|
+
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties */
|
|
12
13
|
class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
13
14
|
/**
|
|
14
15
|
* Creates a new content property for an attachment.
|
|
@@ -19,6 +20,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
19
20
|
* @returns Returned if the content property was created successfully.
|
|
20
21
|
* @path {POST} /attachments/{attachment-id}/properties
|
|
21
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
|
|
22
24
|
*/
|
|
23
25
|
createAttachmentProperty({ attachmentId, contentPropertyCreateRequest, }) {
|
|
24
26
|
return this.getClientInstance()
|
|
@@ -51,6 +53,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
51
53
|
* @returns Returned if the content property was created successfully.
|
|
52
54
|
* @path {POST} /blogposts/{blogpost-id}/properties
|
|
53
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
|
|
54
57
|
*/
|
|
55
58
|
createBlogpostProperty({ blogpostId, contentPropertyCreateRequest, }) {
|
|
56
59
|
return this.getClientInstance()
|
|
@@ -83,6 +86,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
83
86
|
* @returns Returned if the content property was created successfully.
|
|
84
87
|
* @path {POST} /comments/{comment-id}/properties
|
|
85
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
|
|
86
90
|
*/
|
|
87
91
|
createCommentProperty({ commentId, contentPropertyCreateRequest, }) {
|
|
88
92
|
return this.getClientInstance()
|
|
@@ -115,6 +119,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
115
119
|
* @returns Returned if the content property was created successfully.
|
|
116
120
|
* @path {POST} /custom-content/{custom-content-id}/properties
|
|
117
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
|
|
118
123
|
*/
|
|
119
124
|
createCustomContentProperty({ customContentId, contentPropertyCreateRequest, }) {
|
|
120
125
|
return this.getClientInstance()
|
|
@@ -147,6 +152,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
147
152
|
* @returns Returned if the content property was created successfully.
|
|
148
153
|
* @path {POST} /databases/{id}/properties
|
|
149
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
|
|
150
156
|
*/
|
|
151
157
|
createDatabaseProperty({ id, contentPropertyCreateRequest, }) {
|
|
152
158
|
return this.getClientInstance()
|
|
@@ -179,6 +185,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
179
185
|
* @returns Returned if the content property was created successfully.
|
|
180
186
|
* @path {POST} /pages/{page-id}/properties
|
|
181
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
|
|
182
189
|
*/
|
|
183
190
|
createPageProperty({ pageId, contentPropertyCreateRequest, }) {
|
|
184
191
|
return this.getClientInstance()
|
|
@@ -211,6 +218,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
211
218
|
* @returns Returned if the content property was created successfully.
|
|
212
219
|
* @path {POST} /embeds/{id}/properties
|
|
213
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
|
|
214
222
|
*/
|
|
215
223
|
createSmartLinkProperty({ id, contentPropertyCreateRequest, }) {
|
|
216
224
|
return this.getClientInstance()
|
|
@@ -243,6 +251,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
243
251
|
* @returns Returned if the content property was created successfully.
|
|
244
252
|
* @path {POST} /whiteboards/{id}/properties
|
|
245
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
|
|
246
255
|
*/
|
|
247
256
|
createWhiteboardProperty({ id, contentPropertyCreateRequest, }) {
|
|
248
257
|
return this.getClientInstance()
|
|
@@ -274,6 +283,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
274
283
|
*
|
|
275
284
|
* @path {DELETE} /attachments/{attachment-id}/properties/{property-id}
|
|
276
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
|
|
277
287
|
*/
|
|
278
288
|
deleteAttachmentPropertyById({ attachmentId, propertyId, }) {
|
|
279
289
|
return this.getClientInstance()
|
|
@@ -295,6 +305,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
295
305
|
*
|
|
296
306
|
* @path {DELETE} /blogposts/{blogpost-id}/properties/{property-id}
|
|
297
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
|
|
298
309
|
*/
|
|
299
310
|
deleteBlogpostPropertyById({ blogpostId, propertyId, }) {
|
|
300
311
|
return this.getClientInstance()
|
|
@@ -316,6 +327,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
316
327
|
*
|
|
317
328
|
* @path {DELETE} /comments/{comment-id}/properties/{property-id}
|
|
318
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
|
|
319
331
|
*/
|
|
320
332
|
deleteCommentPropertyById({ commentId, propertyId, }) {
|
|
321
333
|
return this.getClientInstance()
|
|
@@ -337,6 +349,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
337
349
|
*
|
|
338
350
|
* @path {DELETE} /custom-content/{custom-content-id}/properties/{property-id}
|
|
339
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
|
|
340
353
|
*/
|
|
341
354
|
deleteCustomContentPropertyById({ customContentId, propertyId, }) {
|
|
342
355
|
return this.getClientInstance()
|
|
@@ -358,6 +371,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
358
371
|
*
|
|
359
372
|
* @path {DELETE} /databases/{database-id}/properties/{property-id}
|
|
360
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
|
|
361
375
|
*/
|
|
362
376
|
deleteDatabasePropertyById({ databaseId, propertyId, }) {
|
|
363
377
|
return this.getClientInstance()
|
|
@@ -379,6 +393,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
379
393
|
*
|
|
380
394
|
* @path {DELETE} /pages/{page-id}/properties/{property-id}
|
|
381
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
|
|
382
397
|
*/
|
|
383
398
|
deletePagePropertyById({ pageId, propertyId, }) {
|
|
384
399
|
return this.getClientInstance()
|
|
@@ -400,6 +415,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
400
415
|
*
|
|
401
416
|
* @path {DELETE} /embeds/{embed-id}/properties/{property-id}
|
|
402
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
|
|
403
419
|
*/
|
|
404
420
|
deleteSmartLinkPropertyById({ embedId, propertyId, }) {
|
|
405
421
|
return this.getClientInstance()
|
|
@@ -421,6 +437,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
421
437
|
*
|
|
422
438
|
* @path {DELETE} /whiteboards/{whiteboard-id}/properties/{property-id}
|
|
423
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
|
|
424
441
|
*/
|
|
425
442
|
deleteWhiteboardPropertyById({ whiteboardId, propertyId, }) {
|
|
426
443
|
return this.getClientInstance()
|
|
@@ -443,6 +460,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
443
460
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
444
461
|
* @path {GET} /attachments/{attachment-id}/properties
|
|
445
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
|
|
446
464
|
*/
|
|
447
465
|
getAttachmentContentProperties({ attachmentId, key, sort, cursor, limit, }) {
|
|
448
466
|
return this.getClientInstance()
|
|
@@ -478,6 +496,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
478
496
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
479
497
|
* @path {GET} /attachments/{attachment-id}/properties/{property-id}
|
|
480
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
|
|
481
500
|
*/
|
|
482
501
|
getAttachmentContentPropertiesById({ attachmentId, propertyId, }) {
|
|
483
502
|
return this.getClientInstance()
|
|
@@ -507,6 +526,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
507
526
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
508
527
|
* @path {GET} /blogposts/{blogpost-id}/properties
|
|
509
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
|
|
510
530
|
*/
|
|
511
531
|
getBlogpostContentProperties({ blogpostId, key, sort, cursor, limit, }) {
|
|
512
532
|
return this.getClientInstance()
|
|
@@ -542,6 +562,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
542
562
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
543
563
|
* @path {GET} /blogposts/{blogpost-id}/properties/{property-id}
|
|
544
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
|
|
545
566
|
*/
|
|
546
567
|
getBlogpostContentPropertiesById({ blogpostId, propertyId, }) {
|
|
547
568
|
return this.getClientInstance()
|
|
@@ -571,6 +592,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
571
592
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
572
593
|
* @path {GET} /comments/{comment-id}/properties
|
|
573
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
|
|
574
596
|
*/
|
|
575
597
|
getCommentContentProperties({ commentId, key, sort, cursor, limit, }) {
|
|
576
598
|
return this.getClientInstance()
|
|
@@ -606,6 +628,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
606
628
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
607
629
|
* @path {GET} /comments/{comment-id}/properties/{property-id}
|
|
608
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
|
|
609
632
|
*/
|
|
610
633
|
getCommentContentPropertiesById({ commentId, propertyId, }) {
|
|
611
634
|
return this.getClientInstance()
|
|
@@ -635,6 +658,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
635
658
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
636
659
|
* @path {GET} /custom-content/{custom-content-id}/properties
|
|
637
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
|
|
638
662
|
*/
|
|
639
663
|
getCustomContentContentProperties({ customContentId, key, sort, cursor, limit, }) {
|
|
640
664
|
return this.getClientInstance()
|
|
@@ -670,6 +694,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
670
694
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
671
695
|
* @path {GET} /custom-content/{custom-content-id}/properties/{property-id}
|
|
672
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
|
|
673
698
|
*/
|
|
674
699
|
getCustomContentContentPropertiesById({ customContentId, propertyId, }) {
|
|
675
700
|
return this.getClientInstance()
|
|
@@ -699,6 +724,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
699
724
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
700
725
|
* @path {GET} /databases/{id}/properties
|
|
701
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
|
|
702
728
|
*/
|
|
703
729
|
getDatabaseContentProperties({ id, key, sort, cursor, limit, }) {
|
|
704
730
|
return this.getClientInstance()
|
|
@@ -734,6 +760,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
734
760
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
735
761
|
* @path {GET} /databases/{database-id}/properties/{property-id}
|
|
736
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
|
|
737
764
|
*/
|
|
738
765
|
getDatabaseContentPropertiesById({ databaseId, propertyId, }) {
|
|
739
766
|
return this.getClientInstance()
|
|
@@ -763,6 +790,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
763
790
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
764
791
|
* @path {GET} /pages/{page-id}/properties
|
|
765
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
|
|
766
794
|
*/
|
|
767
795
|
getPageContentProperties({ pageId, key, sort, cursor, limit, }) {
|
|
768
796
|
return this.getClientInstance()
|
|
@@ -798,6 +826,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
798
826
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
799
827
|
* @path {GET} /pages/{page-id}/properties/{property-id}
|
|
800
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
|
|
801
830
|
*/
|
|
802
831
|
getPageContentPropertiesById({ pageId, propertyId, }) {
|
|
803
832
|
return this.getClientInstance()
|
|
@@ -827,6 +856,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
827
856
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
828
857
|
* @path {GET} /embeds/{id}/properties
|
|
829
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
|
|
830
860
|
*/
|
|
831
861
|
getSmartLinkContentProperties({ id, key, sort, cursor, limit, }) {
|
|
832
862
|
return this.getClientInstance()
|
|
@@ -862,6 +892,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
862
892
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
863
893
|
* @path {GET} /embeds/{embed-id}/properties/{property-id}
|
|
864
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
|
|
865
896
|
*/
|
|
866
897
|
getSmartLinkContentPropertiesById({ embedId, propertyId, }) {
|
|
867
898
|
return this.getClientInstance()
|
|
@@ -891,6 +922,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
891
922
|
* @returns Returned if the requested content properties are successfully retrieved.
|
|
892
923
|
* @path {GET} /whiteboards/{id}/properties
|
|
893
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
|
|
894
926
|
*/
|
|
895
927
|
getWhiteboardContentProperties({ id, key, sort, cursor, limit, }) {
|
|
896
928
|
return this.getClientInstance()
|
|
@@ -926,6 +958,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
926
958
|
* @returns Returned if the requested content property is successfully retrieved.
|
|
927
959
|
* @path {GET} /whiteboards/{whiteboard-id}/properties/{property-id}
|
|
928
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
|
|
929
962
|
*/
|
|
930
963
|
getWhiteboardContentPropertiesById({ whiteboardId, propertyId, }) {
|
|
931
964
|
return this.getClientInstance()
|
|
@@ -955,6 +988,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
955
988
|
* @returns Returned if the content property was updated successfully.
|
|
956
989
|
* @path {PUT} /attachments/{attachment-id}/properties/{property-id}
|
|
957
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
|
|
958
992
|
*/
|
|
959
993
|
updateAttachmentPropertyById({ attachmentId, propertyId, contentPropertyUpdateRequest, }) {
|
|
960
994
|
return this.getClientInstance()
|
|
@@ -988,6 +1022,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
988
1022
|
* @returns Returned if the content property was updated successfully.
|
|
989
1023
|
* @path {PUT} /blogposts/{blogpost-id}/properties/{property-id}
|
|
990
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
|
|
991
1026
|
*/
|
|
992
1027
|
updateBlogpostPropertyById({ blogpostId, propertyId, contentPropertyUpdateRequest, }) {
|
|
993
1028
|
return this.getClientInstance()
|
|
@@ -1021,6 +1056,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
1021
1056
|
* @returns Returned if the content property was updated successfully.
|
|
1022
1057
|
* @path {PUT} /comments/{comment-id}/properties/{property-id}
|
|
1023
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
|
|
1024
1060
|
*/
|
|
1025
1061
|
updateCommentPropertyById({ commentId, propertyId, contentPropertyUpdateRequest, }) {
|
|
1026
1062
|
return this.getClientInstance()
|
|
@@ -1054,6 +1090,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
1054
1090
|
* @returns Returned if the content property was updated successfully.
|
|
1055
1091
|
* @path {PUT} /custom-content/{custom-content-id}/properties/{property-id}
|
|
1056
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
|
|
1057
1094
|
*/
|
|
1058
1095
|
updateCustomContentPropertyById({ customContentId, propertyId, contentPropertyUpdateRequest, }) {
|
|
1059
1096
|
return this.getClientInstance()
|
|
@@ -1087,6 +1124,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
1087
1124
|
* @returns Returned if the content property was updated successfully.
|
|
1088
1125
|
* @path {PUT} /databases/{database-id}/properties/{property-id}
|
|
1089
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
|
|
1090
1128
|
*/
|
|
1091
1129
|
updateDatabasePropertyById({ databaseId, propertyId, contentPropertyUpdateRequest, }) {
|
|
1092
1130
|
return this.getClientInstance()
|
|
@@ -1120,6 +1158,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
1120
1158
|
* @returns Returned if the content property was updated successfully.
|
|
1121
1159
|
* @path {PUT} /pages/{page-id}/properties/{property-id}
|
|
1122
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
|
|
1123
1162
|
*/
|
|
1124
1163
|
updatePagePropertyById({ pageId, propertyId, contentPropertyUpdateRequest, }) {
|
|
1125
1164
|
return this.getClientInstance()
|
|
@@ -1153,6 +1192,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
1153
1192
|
* @returns Returned if the content property was updated successfully.
|
|
1154
1193
|
* @path {PUT} /embeds/{embed-id}/properties/{property-id}
|
|
1155
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
|
|
1156
1196
|
*/
|
|
1157
1197
|
updateSmartLinkPropertyById({ embedId, propertyId, contentPropertyUpdateRequest, }) {
|
|
1158
1198
|
return this.getClientInstance()
|
|
@@ -1186,6 +1226,7 @@ class ContentPropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
|
1186
1226
|
* @returns Returned if the content property was updated successfully.
|
|
1187
1227
|
* @path {PUT} /whiteboards/{whiteboard-id}/properties/{property-id}
|
|
1188
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
|
|
1189
1230
|
*/
|
|
1190
1231
|
updateWhiteboardPropertyById({ whiteboardId, propertyId, contentPropertyUpdateRequest, }) {
|
|
1191
1232
|
return this.getClientInstance()
|