@resolution/confluence-api-client 0.4.4 → 0.4.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +60 -1
- package/lib/openapi/v1/BaseConfluenceApiV1Client.d.ts +32 -33
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js +151 -88
- package/lib/openapi/v1/BaseConfluenceApiV1Client.js.map +1 -1
- package/lib/openapi/v1/core/CommonHttpService.d.ts +2 -0
- package/lib/openapi/v1/core/CommonHttpService.js +9 -0
- package/lib/openapi/v1/core/CommonHttpService.js.map +1 -1
- package/lib/openapi/v1/services/AnalyticsService.d.ts +10 -10
- package/lib/openapi/v1/services/AnalyticsService.js +62 -59
- package/lib/openapi/v1/services/AnalyticsService.js.map +1 -1
- package/lib/openapi/v1/services/AuditService.d.ts +25 -25
- package/lib/openapi/v1/services/AuditService.js +205 -202
- package/lib/openapi/v1/services/AuditService.js.map +1 -1
- package/lib/openapi/v1/services/ContentAttachmentsService.d.ts +20 -20
- package/lib/openapi/v1/services/ContentAttachmentsService.js +317 -314
- package/lib/openapi/v1/services/ContentAttachmentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentBodyService.d.ts +15 -15
- package/lib/openapi/v1/services/ContentBodyService.js +140 -137
- package/lib/openapi/v1/services/ContentBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.d.ts +27 -27
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js +391 -388
- package/lib/openapi/v1/services/ContentChildrenAndDescendantsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentCommentsService.d.ts +8 -8
- package/lib/openapi/v1/services/ContentCommentsService.js +49 -46
- package/lib/openapi/v1/services/ContentCommentsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentLabelsService.d.ts +11 -11
- package/lib/openapi/v1/services/ContentLabelsService.js +150 -147
- package/lib/openapi/v1/services/ContentLabelsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentMacroBodyService.d.ts +13 -13
- package/lib/openapi/v1/services/ContentMacroBodyService.js +155 -152
- package/lib/openapi/v1/services/ContentMacroBodyService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPermissionsService.d.ts +2 -2
- package/lib/openapi/v1/services/ContentPermissionsService.js +48 -45
- package/lib/openapi/v1/services/ContentPermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentPropertiesService.d.ts +18 -18
- package/lib/openapi/v1/services/ContentPropertiesService.js +237 -234
- package/lib/openapi/v1/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +49 -49
- package/lib/openapi/v1/services/ContentRestrictionsService.js +505 -502
- package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentService.d.ts +50 -50
- package/lib/openapi/v1/services/ContentService.js +475 -472
- package/lib/openapi/v1/services/ContentService.js.map +1 -1
- package/lib/openapi/v1/services/ContentStatesService.d.ts +25 -25
- package/lib/openapi/v1/services/ContentStatesService.js +359 -356
- package/lib/openapi/v1/services/ContentStatesService.js.map +1 -1
- package/lib/openapi/v1/services/ContentVersionsService.d.ts +13 -13
- package/lib/openapi/v1/services/ContentVersionsService.js +144 -141
- package/lib/openapi/v1/services/ContentVersionsService.js.map +1 -1
- package/lib/openapi/v1/services/ContentWatchesService.d.ts +57 -57
- package/lib/openapi/v1/services/ContentWatchesService.js +454 -451
- package/lib/openapi/v1/services/ContentWatchesService.js.map +1 -1
- package/lib/openapi/v1/services/DynamicModulesService.d.ts +5 -5
- package/lib/openapi/v1/services/DynamicModulesService.js +70 -67
- package/lib/openapi/v1/services/DynamicModulesService.js.map +1 -1
- package/lib/openapi/v1/services/ExperimentalService.d.ts +12 -12
- package/lib/openapi/v1/services/ExperimentalService.js +151 -148
- package/lib/openapi/v1/services/ExperimentalService.js.map +1 -1
- package/lib/openapi/v1/services/GroupService.d.ts +52 -52
- package/lib/openapi/v1/services/GroupService.js +445 -442
- package/lib/openapi/v1/services/GroupService.js.map +1 -1
- package/lib/openapi/v1/services/InlineTasksService.d.ts +20 -20
- package/lib/openapi/v1/services/InlineTasksService.js +118 -115
- package/lib/openapi/v1/services/InlineTasksService.js.map +1 -1
- package/lib/openapi/v1/services/LabelInfoService.d.ts +5 -5
- package/lib/openapi/v1/services/LabelInfoService.js +37 -34
- package/lib/openapi/v1/services/LabelInfoService.js.map +1 -1
- package/lib/openapi/v1/services/LongRunningTaskService.d.ts +8 -6
- package/lib/openapi/v1/services/LongRunningTaskService.js +67 -63
- package/lib/openapi/v1/services/LongRunningTaskService.js.map +1 -1
- package/lib/openapi/v1/services/RelationService.d.ts +37 -37
- package/lib/openapi/v1/services/RelationService.js +231 -228
- package/lib/openapi/v1/services/RelationService.js.map +1 -1
- package/lib/openapi/v1/services/SearchService.d.ts +20 -20
- package/lib/openapi/v1/services/SearchService.js +136 -133
- package/lib/openapi/v1/services/SearchService.js.map +1 -1
- package/lib/openapi/v1/services/SettingsService.d.ts +15 -15
- package/lib/openapi/v1/services/SettingsService.js +204 -201
- package/lib/openapi/v1/services/SettingsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePermissionsService.d.ts +6 -6
- package/lib/openapi/v1/services/SpacePermissionsService.js +99 -96
- package/lib/openapi/v1/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v1/services/SpacePropertiesService.d.ts +16 -16
- package/lib/openapi/v1/services/SpacePropertiesService.js +227 -224
- package/lib/openapi/v1/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceService.d.ts +38 -38
- package/lib/openapi/v1/services/SpaceService.js +320 -317
- package/lib/openapi/v1/services/SpaceService.js.map +1 -1
- package/lib/openapi/v1/services/SpaceSettingsService.d.ts +4 -4
- package/lib/openapi/v1/services/SpaceSettingsService.js +68 -65
- package/lib/openapi/v1/services/SpaceSettingsService.js.map +1 -1
- package/lib/openapi/v1/services/TemplateService.d.ts +20 -20
- package/lib/openapi/v1/services/TemplateService.js +214 -211
- package/lib/openapi/v1/services/TemplateService.js.map +1 -1
- package/lib/openapi/v1/services/ThemesService.d.ts +13 -13
- package/lib/openapi/v1/services/ThemesService.js +179 -176
- package/lib/openapi/v1/services/ThemesService.js.map +1 -1
- package/lib/openapi/v1/services/UserPropertiesService.d.ts +12 -12
- package/lib/openapi/v1/services/UserPropertiesService.js +165 -162
- package/lib/openapi/v1/services/UserPropertiesService.js.map +1 -1
- package/lib/openapi/v1/services/UsersService.d.ts +21 -21
- package/lib/openapi/v1/services/UsersService.js +229 -226
- package/lib/openapi/v1/services/UsersService.js.map +1 -1
- package/lib/openapi/v2/BaseConfluenceApiV2Client.d.ts +23 -24
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js +92 -47
- package/lib/openapi/v2/BaseConfluenceApiV2Client.js.map +1 -1
- package/lib/openapi/v2/core/CommonHttpService.d.ts +2 -0
- package/lib/openapi/v2/core/CommonHttpService.js +9 -0
- package/lib/openapi/v2/core/CommonHttpService.js.map +1 -1
- package/lib/openapi/v2/models/user.d.ts +0 -2
- package/lib/openapi/v2/models/user.js +0 -2
- package/lib/openapi/v2/models/user.js.map +1 -1
- package/lib/openapi/v2/services/AncestorsService.d.ts +17 -17
- package/lib/openapi/v2/services/AncestorsService.js +174 -171
- package/lib/openapi/v2/services/AncestorsService.js.map +1 -1
- package/lib/openapi/v2/services/AttachmentService.d.ts +62 -62
- package/lib/openapi/v2/services/AttachmentService.js +261 -258
- package/lib/openapi/v2/services/AttachmentService.js.map +1 -1
- package/lib/openapi/v2/services/BlogPostService.d.ts +70 -70
- package/lib/openapi/v2/services/BlogPostService.js +270 -267
- package/lib/openapi/v2/services/BlogPostService.js.map +1 -1
- package/lib/openapi/v2/services/ChildrenService.d.ts +14 -14
- package/lib/openapi/v2/services/ChildrenService.js +77 -74
- package/lib/openapi/v2/services/ChildrenService.js.map +1 -1
- package/lib/openapi/v2/services/ClassificationLevelService.d.ts +21 -21
- package/lib/openapi/v2/services/ClassificationLevelService.js +304 -301
- package/lib/openapi/v2/services/ClassificationLevelService.js.map +1 -1
- package/lib/openapi/v2/services/CommentService.d.ts +136 -136
- package/lib/openapi/v2/services/CommentService.js +635 -632
- package/lib/openapi/v2/services/CommentService.js.map +1 -1
- package/lib/openapi/v2/services/ContentPropertiesService.d.ts +128 -128
- package/lib/openapi/v2/services/ContentPropertiesService.js +1242 -1239
- package/lib/openapi/v2/services/ContentPropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/ContentService.d.ts +2 -2
- package/lib/openapi/v2/services/ContentService.js +40 -37
- package/lib/openapi/v2/services/ContentService.js.map +1 -1
- package/lib/openapi/v2/services/CustomContentService.d.ts +72 -72
- package/lib/openapi/v2/services/CustomContentService.js +299 -296
- package/lib/openapi/v2/services/CustomContentService.js.map +1 -1
- package/lib/openapi/v2/services/DataPoliciesService.d.ts +10 -10
- package/lib/openapi/v2/services/DataPoliciesService.js +67 -64
- package/lib/openapi/v2/services/DataPoliciesService.js.map +1 -1
- package/lib/openapi/v2/services/DatabaseService.d.ts +17 -17
- package/lib/openapi/v2/services/DatabaseService.js +90 -87
- package/lib/openapi/v2/services/DatabaseService.js.map +1 -1
- package/lib/openapi/v2/services/LabelService.d.ts +57 -57
- package/lib/openapi/v2/services/LabelService.js +263 -260
- package/lib/openapi/v2/services/LabelService.js.map +1 -1
- package/lib/openapi/v2/services/LikeService.d.ts +36 -36
- package/lib/openapi/v2/services/LikeService.js +250 -247
- package/lib/openapi/v2/services/LikeService.js.map +1 -1
- package/lib/openapi/v2/services/OperationService.d.ts +20 -20
- package/lib/openapi/v2/services/OperationService.js +298 -295
- package/lib/openapi/v2/services/OperationService.js.map +1 -1
- package/lib/openapi/v2/services/PageService.d.ts +73 -73
- package/lib/openapi/v2/services/PageService.js +272 -269
- package/lib/openapi/v2/services/PageService.js.map +1 -1
- package/lib/openapi/v2/services/SmartLinkService.d.ts +19 -17
- package/lib/openapi/v2/services/SmartLinkService.js +92 -89
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePermissionsService.d.ts +6 -6
- package/lib/openapi/v2/services/SpacePermissionsService.js +35 -32
- package/lib/openapi/v2/services/SpacePermissionsService.js.map +1 -1
- package/lib/openapi/v2/services/SpacePropertiesService.d.ts +15 -15
- package/lib/openapi/v2/services/SpacePropertiesService.js +165 -162
- package/lib/openapi/v2/services/SpacePropertiesService.js.map +1 -1
- package/lib/openapi/v2/services/SpaceService.d.ts +28 -28
- package/lib/openapi/v2/services/SpaceService.js +83 -80
- package/lib/openapi/v2/services/SpaceService.js.map +1 -1
- package/lib/openapi/v2/services/TaskService.d.ts +40 -40
- package/lib/openapi/v2/services/TaskService.js +120 -117
- package/lib/openapi/v2/services/TaskService.js.map +1 -1
- package/lib/openapi/v2/services/UserService.d.ts +11 -11
- package/lib/openapi/v2/services/UserService.js +91 -88
- package/lib/openapi/v2/services/UserService.js.map +1 -1
- package/lib/openapi/v2/services/VersionService.d.ts +59 -59
- package/lib/openapi/v2/services/VersionService.js +395 -392
- package/lib/openapi/v2/services/VersionService.js.map +1 -1
- package/lib/openapi/v2/services/WhiteboardService.d.ts +17 -17
- package/lib/openapi/v2/services/WhiteboardService.js +90 -87
- package/lib/openapi/v2/services/WhiteboardService.js.map +1 -1
- package/package.json +4 -3
|
@@ -14,12 +14,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
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
16
|
*/
|
|
17
|
-
createAttachmentProperty({ attachmentId, contentPropertyCreateRequest, }: {
|
|
17
|
+
createAttachmentProperty: ({ attachmentId, contentPropertyCreateRequest, }: {
|
|
18
18
|
/** The ID of the attachment to create a property for. */
|
|
19
19
|
attachmentId: string;
|
|
20
20
|
/** The content property to be created */
|
|
21
21
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
22
|
-
})
|
|
22
|
+
}) => Promise<ContentProperty>;
|
|
23
23
|
/**
|
|
24
24
|
* Creates a new property for a blogpost.
|
|
25
25
|
*
|
|
@@ -31,12 +31,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
31
31
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
32
32
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-post
|
|
33
33
|
*/
|
|
34
|
-
createBlogpostProperty({ blogpostId, contentPropertyCreateRequest, }: {
|
|
34
|
+
createBlogpostProperty: ({ blogpostId, contentPropertyCreateRequest, }: {
|
|
35
35
|
/** The ID of the blog post to create a property for. */
|
|
36
36
|
blogpostId: number;
|
|
37
37
|
/** The content property to be created */
|
|
38
38
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
39
|
-
})
|
|
39
|
+
}) => Promise<ContentProperty>;
|
|
40
40
|
/**
|
|
41
41
|
* Creates a new content property for a comment.
|
|
42
42
|
*
|
|
@@ -48,12 +48,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
48
48
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
49
49
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-post
|
|
50
50
|
*/
|
|
51
|
-
createCommentProperty({ commentId, contentPropertyCreateRequest, }: {
|
|
51
|
+
createCommentProperty: ({ commentId, contentPropertyCreateRequest, }: {
|
|
52
52
|
/** The ID of the comment to create a property for. */
|
|
53
53
|
commentId: number;
|
|
54
54
|
/** The content property to be created */
|
|
55
55
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
56
|
-
})
|
|
56
|
+
}) => Promise<ContentProperty>;
|
|
57
57
|
/**
|
|
58
58
|
* Creates a new content property for a piece of custom content.
|
|
59
59
|
*
|
|
@@ -65,12 +65,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
65
65
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
66
66
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-post
|
|
67
67
|
*/
|
|
68
|
-
createCustomContentProperty({ customContentId, contentPropertyCreateRequest, }: {
|
|
68
|
+
createCustomContentProperty: ({ customContentId, contentPropertyCreateRequest, }: {
|
|
69
69
|
/** The ID of the custom content to create a property for. */
|
|
70
70
|
customContentId: number;
|
|
71
71
|
/** The content property to be created */
|
|
72
72
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
73
|
-
})
|
|
73
|
+
}) => Promise<ContentProperty>;
|
|
74
74
|
/**
|
|
75
75
|
* Creates a new content property for a database.
|
|
76
76
|
*
|
|
@@ -82,12 +82,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
82
82
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
83
83
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-post
|
|
84
84
|
*/
|
|
85
|
-
createDatabaseProperty({ id, contentPropertyCreateRequest, }: {
|
|
85
|
+
createDatabaseProperty: ({ id, contentPropertyCreateRequest, }: {
|
|
86
86
|
/** The ID of the database to create a property for. */
|
|
87
87
|
id: number;
|
|
88
88
|
/** The content property to be created */
|
|
89
89
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
90
|
-
})
|
|
90
|
+
}) => Promise<ContentProperty>;
|
|
91
91
|
/**
|
|
92
92
|
* Creates a new content property for a page.
|
|
93
93
|
*
|
|
@@ -99,12 +99,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
99
99
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
100
100
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-post
|
|
101
101
|
*/
|
|
102
|
-
createPageProperty({ pageId, contentPropertyCreateRequest, }: {
|
|
102
|
+
createPageProperty: ({ pageId, contentPropertyCreateRequest, }: {
|
|
103
103
|
/** The ID of the page to create a property for. */
|
|
104
104
|
pageId: number;
|
|
105
105
|
/** The content property to be created */
|
|
106
106
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
107
|
-
})
|
|
107
|
+
}) => Promise<ContentProperty>;
|
|
108
108
|
/**
|
|
109
109
|
* Creates a new content property for a Smart Link in the content tree.
|
|
110
110
|
*
|
|
@@ -116,12 +116,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
116
116
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
117
117
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-post
|
|
118
118
|
*/
|
|
119
|
-
createSmartLinkProperty({ id, contentPropertyCreateRequest, }: {
|
|
119
|
+
createSmartLinkProperty: ({ id, contentPropertyCreateRequest, }: {
|
|
120
120
|
/** The ID of the Smart Link in the content tree to create a property for. */
|
|
121
121
|
id: number;
|
|
122
122
|
/** The content property to be created */
|
|
123
123
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
124
|
-
})
|
|
124
|
+
}) => Promise<ContentProperty>;
|
|
125
125
|
/**
|
|
126
126
|
* Creates a new content property for a whiteboard.
|
|
127
127
|
*
|
|
@@ -133,12 +133,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
133
133
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
134
134
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-post
|
|
135
135
|
*/
|
|
136
|
-
createWhiteboardProperty({ id, contentPropertyCreateRequest, }: {
|
|
136
|
+
createWhiteboardProperty: ({ id, contentPropertyCreateRequest, }: {
|
|
137
137
|
/** The ID of the whiteboard to create a property for. */
|
|
138
138
|
id: number;
|
|
139
139
|
/** The content property to be created */
|
|
140
140
|
contentPropertyCreateRequest: ContentPropertyCreateRequest;
|
|
141
|
-
})
|
|
141
|
+
}) => Promise<ContentProperty>;
|
|
142
142
|
/**
|
|
143
143
|
* Deletes a content property for an attachment by its id.
|
|
144
144
|
*
|
|
@@ -149,12 +149,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
149
149
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
150
150
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-delete
|
|
151
151
|
*/
|
|
152
|
-
deleteAttachmentPropertyById({ attachmentId, propertyId, }: {
|
|
152
|
+
deleteAttachmentPropertyById: ({ attachmentId, propertyId, }: {
|
|
153
153
|
/** The ID of the attachment the property belongs to. */
|
|
154
154
|
attachmentId: string;
|
|
155
155
|
/** The ID of the property to be deleted. */
|
|
156
156
|
propertyId: number;
|
|
157
|
-
})
|
|
157
|
+
}) => Promise<void>;
|
|
158
158
|
/**
|
|
159
159
|
* Deletes a content property for a blogpost by its id.
|
|
160
160
|
*
|
|
@@ -165,12 +165,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
165
165
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
166
166
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-delete
|
|
167
167
|
*/
|
|
168
|
-
deleteBlogpostPropertyById({ blogpostId, propertyId, }: {
|
|
168
|
+
deleteBlogpostPropertyById: ({ blogpostId, propertyId, }: {
|
|
169
169
|
/** The ID of the blog post the property belongs to. */
|
|
170
170
|
blogpostId: number;
|
|
171
171
|
/** The ID of the property to be deleted. */
|
|
172
172
|
propertyId: number;
|
|
173
|
-
})
|
|
173
|
+
}) => Promise<void>;
|
|
174
174
|
/**
|
|
175
175
|
* Deletes a content property for a comment by its id.
|
|
176
176
|
*
|
|
@@ -181,12 +181,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
181
181
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
182
182
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-delete
|
|
183
183
|
*/
|
|
184
|
-
deleteCommentPropertyById({ commentId, propertyId, }: {
|
|
184
|
+
deleteCommentPropertyById: ({ commentId, propertyId, }: {
|
|
185
185
|
/** The ID of the comment the property belongs to. */
|
|
186
186
|
commentId: number;
|
|
187
187
|
/** The ID of the property to be deleted. */
|
|
188
188
|
propertyId: number;
|
|
189
|
-
})
|
|
189
|
+
}) => Promise<void>;
|
|
190
190
|
/**
|
|
191
191
|
* Deletes a content property for a piece of custom content by its id.
|
|
192
192
|
*
|
|
@@ -197,12 +197,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
197
197
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
198
198
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-delete
|
|
199
199
|
*/
|
|
200
|
-
deleteCustomContentPropertyById({ customContentId, propertyId, }: {
|
|
200
|
+
deleteCustomContentPropertyById: ({ customContentId, propertyId, }: {
|
|
201
201
|
/** The ID of the custom content the property belongs to. */
|
|
202
202
|
customContentId: number;
|
|
203
203
|
/** The ID of the property to be deleted. */
|
|
204
204
|
propertyId: number;
|
|
205
|
-
})
|
|
205
|
+
}) => Promise<void>;
|
|
206
206
|
/**
|
|
207
207
|
* Deletes a content property for a database by its id.
|
|
208
208
|
*
|
|
@@ -213,12 +213,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
213
213
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
214
214
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-delete
|
|
215
215
|
*/
|
|
216
|
-
deleteDatabasePropertyById({ databaseId, propertyId, }: {
|
|
216
|
+
deleteDatabasePropertyById: ({ databaseId, propertyId, }: {
|
|
217
217
|
/** The ID of the database the property belongs to. */
|
|
218
218
|
databaseId: number;
|
|
219
219
|
/** The ID of the property to be deleted. */
|
|
220
220
|
propertyId: number;
|
|
221
|
-
})
|
|
221
|
+
}) => Promise<void>;
|
|
222
222
|
/**
|
|
223
223
|
* Deletes a content property for a page by its id.
|
|
224
224
|
*
|
|
@@ -229,12 +229,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
229
229
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
230
230
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-delete
|
|
231
231
|
*/
|
|
232
|
-
deletePagePropertyById({ pageId, propertyId, }: {
|
|
232
|
+
deletePagePropertyById: ({ pageId, propertyId, }: {
|
|
233
233
|
/** The ID of the page the property belongs to. */
|
|
234
234
|
pageId: number;
|
|
235
235
|
/** The ID of the property to be deleted. */
|
|
236
236
|
propertyId: number;
|
|
237
|
-
})
|
|
237
|
+
}) => Promise<void>;
|
|
238
238
|
/**
|
|
239
239
|
* Deletes a content property for a Smart Link in the content tree by its id.
|
|
240
240
|
*
|
|
@@ -245,12 +245,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
245
245
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
246
246
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-delete
|
|
247
247
|
*/
|
|
248
|
-
deleteSmartLinkPropertyById({ embedId, propertyId, }: {
|
|
248
|
+
deleteSmartLinkPropertyById: ({ embedId, propertyId, }: {
|
|
249
249
|
/** The ID of the Smart Link in the content tree the property belongs to. */
|
|
250
250
|
embedId: number;
|
|
251
251
|
/** The ID of the property to be deleted. */
|
|
252
252
|
propertyId: number;
|
|
253
|
-
})
|
|
253
|
+
}) => Promise<void>;
|
|
254
254
|
/**
|
|
255
255
|
* Deletes a content property for a whiteboard by its id.
|
|
256
256
|
*
|
|
@@ -261,12 +261,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
261
261
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
262
262
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-delete
|
|
263
263
|
*/
|
|
264
|
-
deleteWhiteboardPropertyById({ whiteboardId, propertyId, }: {
|
|
264
|
+
deleteWhiteboardPropertyById: ({ whiteboardId, propertyId, }: {
|
|
265
265
|
/** The ID of the whiteboard the property belongs to. */
|
|
266
266
|
whiteboardId: number;
|
|
267
267
|
/** The ID of the property to be deleted. */
|
|
268
268
|
propertyId: number;
|
|
269
|
-
})
|
|
269
|
+
}) => Promise<void>;
|
|
270
270
|
/**
|
|
271
271
|
* Retrieves all Content Properties tied to a specified attachment.
|
|
272
272
|
*
|
|
@@ -278,31 +278,31 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
278
278
|
* @scopes-current read:attachment:confluence
|
|
279
279
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-get
|
|
280
280
|
*/
|
|
281
|
-
getAttachmentContentProperties({ attachmentId, key, sort, cursor, limit, }: {
|
|
281
|
+
getAttachmentContentProperties: ({ attachmentId, key, sort, cursor, limit, }: {
|
|
282
282
|
/** The ID of the attachment for which content properties should be returned. */
|
|
283
283
|
attachmentId: string;
|
|
284
284
|
/**
|
|
285
285
|
* Filters the response to return a specific content property with matching key
|
|
286
286
|
* (case sensitive).
|
|
287
287
|
*/
|
|
288
|
-
key?: string;
|
|
288
|
+
key?: string | undefined;
|
|
289
289
|
/** Used to sort the result by a particular field. */
|
|
290
|
-
sort?: ContentPropertySortOrder;
|
|
290
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
291
291
|
/**
|
|
292
292
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
293
293
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
294
294
|
* retrieve the `next` set of results.
|
|
295
295
|
*/
|
|
296
|
-
cursor?: string;
|
|
296
|
+
cursor?: string | undefined;
|
|
297
297
|
/**
|
|
298
298
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
299
299
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
300
300
|
* results.
|
|
301
301
|
*/
|
|
302
|
-
limit?: number;
|
|
303
|
-
})
|
|
304
|
-
results?: ContentProperty[];
|
|
305
|
-
_links?: MultiEntityLinks;
|
|
302
|
+
limit?: number | undefined;
|
|
303
|
+
}) => Promise<{
|
|
304
|
+
results?: ContentProperty[] | undefined;
|
|
305
|
+
_links?: MultiEntityLinks | undefined;
|
|
306
306
|
} & {
|
|
307
307
|
[key: string]: unknown;
|
|
308
308
|
}>;
|
|
@@ -318,12 +318,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
318
318
|
* @scopes-current read:attachment:confluence
|
|
319
319
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-get
|
|
320
320
|
*/
|
|
321
|
-
getAttachmentContentPropertiesById({ attachmentId, propertyId, }: {
|
|
321
|
+
getAttachmentContentPropertiesById: ({ attachmentId, propertyId, }: {
|
|
322
322
|
/** The ID of the attachment for which content properties should be returned. */
|
|
323
323
|
attachmentId: string;
|
|
324
324
|
/** The ID of the content property to be returned */
|
|
325
325
|
propertyId: number;
|
|
326
|
-
})
|
|
326
|
+
}) => Promise<ContentProperty>;
|
|
327
327
|
/**
|
|
328
328
|
* Retrieves all Content Properties tied to a specified blog post.
|
|
329
329
|
*
|
|
@@ -335,31 +335,31 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
335
335
|
* @scopes-current read:page:confluence
|
|
336
336
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-get
|
|
337
337
|
*/
|
|
338
|
-
getBlogpostContentProperties({ blogpostId, key, sort, cursor, limit, }: {
|
|
338
|
+
getBlogpostContentProperties: ({ blogpostId, key, sort, cursor, limit, }: {
|
|
339
339
|
/** The ID of the blog post for which content properties should be returned. */
|
|
340
340
|
blogpostId: number;
|
|
341
341
|
/**
|
|
342
342
|
* Filters the response to return a specific content property with matching key
|
|
343
343
|
* (case sensitive).
|
|
344
344
|
*/
|
|
345
|
-
key?: string;
|
|
345
|
+
key?: string | undefined;
|
|
346
346
|
/** Used to sort the result by a particular field. */
|
|
347
|
-
sort?: ContentPropertySortOrder;
|
|
347
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
348
348
|
/**
|
|
349
349
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
350
350
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
351
351
|
* retrieve the `next` set of results.
|
|
352
352
|
*/
|
|
353
|
-
cursor?: string;
|
|
353
|
+
cursor?: string | undefined;
|
|
354
354
|
/**
|
|
355
355
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
356
356
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
357
357
|
* results.
|
|
358
358
|
*/
|
|
359
|
-
limit?: number;
|
|
360
|
-
})
|
|
361
|
-
results?: ContentProperty[];
|
|
362
|
-
_links?: MultiEntityLinks;
|
|
359
|
+
limit?: number | undefined;
|
|
360
|
+
}) => Promise<{
|
|
361
|
+
results?: ContentProperty[] | undefined;
|
|
362
|
+
_links?: MultiEntityLinks | undefined;
|
|
363
363
|
} & {
|
|
364
364
|
[key: string]: unknown;
|
|
365
365
|
}>;
|
|
@@ -375,12 +375,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
375
375
|
* @scopes-current read:page:confluence
|
|
376
376
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-get
|
|
377
377
|
*/
|
|
378
|
-
getBlogpostContentPropertiesById({ blogpostId, propertyId, }: {
|
|
378
|
+
getBlogpostContentPropertiesById: ({ blogpostId, propertyId, }: {
|
|
379
379
|
/** The ID of the blog post for which content properties should be returned. */
|
|
380
380
|
blogpostId: number;
|
|
381
381
|
/** The ID of the property being requested */
|
|
382
382
|
propertyId: number;
|
|
383
|
-
})
|
|
383
|
+
}) => Promise<ContentProperty>;
|
|
384
384
|
/**
|
|
385
385
|
* Retrieves Content Properties attached to a specified comment.
|
|
386
386
|
*
|
|
@@ -392,31 +392,31 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
392
392
|
* @scopes-current read:comment:confluence
|
|
393
393
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-get
|
|
394
394
|
*/
|
|
395
|
-
getCommentContentProperties({ commentId, key, sort, cursor, limit, }: {
|
|
395
|
+
getCommentContentProperties: ({ commentId, key, sort, cursor, limit, }: {
|
|
396
396
|
/** The ID of the comment for which content properties should be returned. */
|
|
397
397
|
commentId: number;
|
|
398
398
|
/**
|
|
399
399
|
* Filters the response to return a specific content property with matching key
|
|
400
400
|
* (case sensitive).
|
|
401
401
|
*/
|
|
402
|
-
key?: string;
|
|
402
|
+
key?: string | undefined;
|
|
403
403
|
/** Used to sort the result by a particular field. */
|
|
404
|
-
sort?: ContentPropertySortOrder;
|
|
404
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
405
405
|
/**
|
|
406
406
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
407
407
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
408
408
|
* retrieve the `next` set of results.
|
|
409
409
|
*/
|
|
410
|
-
cursor?: string;
|
|
410
|
+
cursor?: string | undefined;
|
|
411
411
|
/**
|
|
412
412
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
413
413
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
414
414
|
* results.
|
|
415
415
|
*/
|
|
416
|
-
limit?: number;
|
|
417
|
-
})
|
|
418
|
-
results?: ContentProperty[];
|
|
419
|
-
_links?: MultiEntityLinks;
|
|
416
|
+
limit?: number | undefined;
|
|
417
|
+
}) => Promise<{
|
|
418
|
+
results?: ContentProperty[] | undefined;
|
|
419
|
+
_links?: MultiEntityLinks | undefined;
|
|
420
420
|
} & {
|
|
421
421
|
[key: string]: unknown;
|
|
422
422
|
}>;
|
|
@@ -432,12 +432,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
432
432
|
* @scopes-current read:comment:confluence
|
|
433
433
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-get
|
|
434
434
|
*/
|
|
435
|
-
getCommentContentPropertiesById({ commentId, propertyId, }: {
|
|
435
|
+
getCommentContentPropertiesById: ({ commentId, propertyId, }: {
|
|
436
436
|
/** The ID of the comment for which content properties should be returned. */
|
|
437
437
|
commentId: number;
|
|
438
438
|
/** The ID of the content property being requested. */
|
|
439
439
|
propertyId: number;
|
|
440
|
-
})
|
|
440
|
+
}) => Promise<ContentProperty>;
|
|
441
441
|
/**
|
|
442
442
|
* Retrieves Content Properties tied to a specified custom content.
|
|
443
443
|
*
|
|
@@ -449,31 +449,31 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
449
449
|
* @scopes-current read:custom-content:confluence
|
|
450
450
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-get
|
|
451
451
|
*/
|
|
452
|
-
getCustomContentContentProperties({ customContentId, key, sort, cursor, limit, }: {
|
|
452
|
+
getCustomContentContentProperties: ({ customContentId, key, sort, cursor, limit, }: {
|
|
453
453
|
/** The ID of the custom content for which content properties should be returned. */
|
|
454
454
|
customContentId: number;
|
|
455
455
|
/**
|
|
456
456
|
* Filters the response to return a specific content property with matching key
|
|
457
457
|
* (case sensitive).
|
|
458
458
|
*/
|
|
459
|
-
key?: string;
|
|
459
|
+
key?: string | undefined;
|
|
460
460
|
/** Used to sort the result by a particular field. */
|
|
461
|
-
sort?: ContentPropertySortOrder;
|
|
461
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
462
462
|
/**
|
|
463
463
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
464
464
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
465
465
|
* retrieve the `next` set of results.
|
|
466
466
|
*/
|
|
467
|
-
cursor?: string;
|
|
467
|
+
cursor?: string | undefined;
|
|
468
468
|
/**
|
|
469
469
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
470
470
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
471
471
|
* results.
|
|
472
472
|
*/
|
|
473
|
-
limit?: number;
|
|
474
|
-
})
|
|
475
|
-
results?: ContentProperty[];
|
|
476
|
-
_links?: MultiEntityLinks;
|
|
473
|
+
limit?: number | undefined;
|
|
474
|
+
}) => Promise<{
|
|
475
|
+
results?: ContentProperty[] | undefined;
|
|
476
|
+
_links?: MultiEntityLinks | undefined;
|
|
477
477
|
} & {
|
|
478
478
|
[key: string]: unknown;
|
|
479
479
|
}>;
|
|
@@ -489,12 +489,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
489
489
|
* @scopes-current read:custom-content:confluence
|
|
490
490
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-get
|
|
491
491
|
*/
|
|
492
|
-
getCustomContentContentPropertiesById({ customContentId, propertyId, }: {
|
|
492
|
+
getCustomContentContentPropertiesById: ({ customContentId, propertyId, }: {
|
|
493
493
|
/** The ID of the custom content for which content properties should be returned. */
|
|
494
494
|
customContentId: number;
|
|
495
495
|
/** The ID of the content property being requested. */
|
|
496
496
|
propertyId: number;
|
|
497
|
-
})
|
|
497
|
+
}) => Promise<ContentProperty>;
|
|
498
498
|
/**
|
|
499
499
|
* Retrieves Content Properties tied to a specified database.
|
|
500
500
|
*
|
|
@@ -506,31 +506,31 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
506
506
|
* @scopes-current read:database:confluence
|
|
507
507
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-id-properties-get
|
|
508
508
|
*/
|
|
509
|
-
getDatabaseContentProperties({ id, key, sort, cursor, limit, }: {
|
|
509
|
+
getDatabaseContentProperties: ({ id, key, sort, cursor, limit, }: {
|
|
510
510
|
/** The ID of the database for which content properties should be returned. */
|
|
511
511
|
id: number;
|
|
512
512
|
/**
|
|
513
513
|
* Filters the response to return a specific content property with matching key
|
|
514
514
|
* (case sensitive).
|
|
515
515
|
*/
|
|
516
|
-
key?: string;
|
|
516
|
+
key?: string | undefined;
|
|
517
517
|
/** Used to sort the result by a particular field. */
|
|
518
|
-
sort?: ContentPropertySortOrder;
|
|
518
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
519
519
|
/**
|
|
520
520
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
521
521
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
522
522
|
* retrieve the `next` set of results.
|
|
523
523
|
*/
|
|
524
|
-
cursor?: string;
|
|
524
|
+
cursor?: string | undefined;
|
|
525
525
|
/**
|
|
526
526
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
527
527
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
528
528
|
* results.
|
|
529
529
|
*/
|
|
530
|
-
limit?: number;
|
|
531
|
-
})
|
|
532
|
-
results?: ContentProperty[];
|
|
533
|
-
_links?: MultiEntityLinks;
|
|
530
|
+
limit?: number | undefined;
|
|
531
|
+
}) => Promise<{
|
|
532
|
+
results?: ContentProperty[] | undefined;
|
|
533
|
+
_links?: MultiEntityLinks | undefined;
|
|
534
534
|
} & {
|
|
535
535
|
[key: string]: unknown;
|
|
536
536
|
}>;
|
|
@@ -546,12 +546,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
546
546
|
* @scopes-current read:database:confluence
|
|
547
547
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-get
|
|
548
548
|
*/
|
|
549
|
-
getDatabaseContentPropertiesById({ databaseId, propertyId, }: {
|
|
549
|
+
getDatabaseContentPropertiesById: ({ databaseId, propertyId, }: {
|
|
550
550
|
/** The ID of the database for which content properties should be returned. */
|
|
551
551
|
databaseId: number;
|
|
552
552
|
/** The ID of the content property being requested. */
|
|
553
553
|
propertyId: number;
|
|
554
|
-
})
|
|
554
|
+
}) => Promise<ContentProperty>;
|
|
555
555
|
/**
|
|
556
556
|
* Retrieves Content Properties tied to a specified page.
|
|
557
557
|
*
|
|
@@ -563,31 +563,31 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
563
563
|
* @scopes-current read:page:confluence
|
|
564
564
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-get
|
|
565
565
|
*/
|
|
566
|
-
getPageContentProperties({ pageId, key, sort, cursor, limit, }: {
|
|
566
|
+
getPageContentProperties: ({ pageId, key, sort, cursor, limit, }: {
|
|
567
567
|
/** The ID of the page for which content properties should be returned. */
|
|
568
568
|
pageId: number;
|
|
569
569
|
/**
|
|
570
570
|
* Filters the response to return a specific content property with matching key
|
|
571
571
|
* (case sensitive).
|
|
572
572
|
*/
|
|
573
|
-
key?: string;
|
|
573
|
+
key?: string | undefined;
|
|
574
574
|
/** Used to sort the result by a particular field. */
|
|
575
|
-
sort?: ContentPropertySortOrder;
|
|
575
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
576
576
|
/**
|
|
577
577
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
578
578
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
579
579
|
* retrieve the `next` set of results.
|
|
580
580
|
*/
|
|
581
|
-
cursor?: string;
|
|
581
|
+
cursor?: string | undefined;
|
|
582
582
|
/**
|
|
583
583
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
584
584
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
585
585
|
* results.
|
|
586
586
|
*/
|
|
587
|
-
limit?: number;
|
|
588
|
-
})
|
|
589
|
-
results?: ContentProperty[];
|
|
590
|
-
_links?: MultiEntityLinks;
|
|
587
|
+
limit?: number | undefined;
|
|
588
|
+
}) => Promise<{
|
|
589
|
+
results?: ContentProperty[] | undefined;
|
|
590
|
+
_links?: MultiEntityLinks | undefined;
|
|
591
591
|
} & {
|
|
592
592
|
[key: string]: unknown;
|
|
593
593
|
}>;
|
|
@@ -603,12 +603,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
603
603
|
* @scopes-current read:page:confluence
|
|
604
604
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-get
|
|
605
605
|
*/
|
|
606
|
-
getPageContentPropertiesById({ pageId, propertyId, }: {
|
|
606
|
+
getPageContentPropertiesById: ({ pageId, propertyId, }: {
|
|
607
607
|
/** The ID of the page for which content properties should be returned. */
|
|
608
608
|
pageId: number;
|
|
609
609
|
/** The ID of the content property being requested. */
|
|
610
610
|
propertyId: number;
|
|
611
|
-
})
|
|
611
|
+
}) => Promise<ContentProperty>;
|
|
612
612
|
/**
|
|
613
613
|
* Retrieves Content Properties tied to a specified Smart Link in the content tree.
|
|
614
614
|
*
|
|
@@ -620,7 +620,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
620
620
|
* @scopes-current read:embed:confluence
|
|
621
621
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-id-properties-get
|
|
622
622
|
*/
|
|
623
|
-
getSmartLinkContentProperties({ id, key, sort, cursor, limit, }: {
|
|
623
|
+
getSmartLinkContentProperties: ({ id, key, sort, cursor, limit, }: {
|
|
624
624
|
/**
|
|
625
625
|
* The ID of the Smart Link in the content tree for which content properties
|
|
626
626
|
* should be returned.
|
|
@@ -630,24 +630,24 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
630
630
|
* Filters the response to return a specific content property with matching key
|
|
631
631
|
* (case sensitive).
|
|
632
632
|
*/
|
|
633
|
-
key?: string;
|
|
633
|
+
key?: string | undefined;
|
|
634
634
|
/** Used to sort the result by a particular field. */
|
|
635
|
-
sort?: ContentPropertySortOrder;
|
|
635
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
636
636
|
/**
|
|
637
637
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
638
638
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
639
639
|
* retrieve the `next` set of results.
|
|
640
640
|
*/
|
|
641
|
-
cursor?: string;
|
|
641
|
+
cursor?: string | undefined;
|
|
642
642
|
/**
|
|
643
643
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
644
644
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
645
645
|
* results.
|
|
646
646
|
*/
|
|
647
|
-
limit?: number;
|
|
648
|
-
})
|
|
649
|
-
results?: ContentProperty[];
|
|
650
|
-
_links?: MultiEntityLinks;
|
|
647
|
+
limit?: number | undefined;
|
|
648
|
+
}) => Promise<{
|
|
649
|
+
results?: ContentProperty[] | undefined;
|
|
650
|
+
_links?: MultiEntityLinks | undefined;
|
|
651
651
|
} & {
|
|
652
652
|
[key: string]: unknown;
|
|
653
653
|
}>;
|
|
@@ -663,7 +663,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
663
663
|
* @scopes-current read:embed:confluence
|
|
664
664
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-get
|
|
665
665
|
*/
|
|
666
|
-
getSmartLinkContentPropertiesById({ embedId, propertyId, }: {
|
|
666
|
+
getSmartLinkContentPropertiesById: ({ embedId, propertyId, }: {
|
|
667
667
|
/**
|
|
668
668
|
* The ID of the Smart Link in the content tree for which content properties
|
|
669
669
|
* should be returned.
|
|
@@ -671,7 +671,7 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
671
671
|
embedId: number;
|
|
672
672
|
/** The ID of the content property being requested. */
|
|
673
673
|
propertyId: number;
|
|
674
|
-
})
|
|
674
|
+
}) => Promise<ContentProperty>;
|
|
675
675
|
/**
|
|
676
676
|
* Retrieves Content Properties tied to a specified whiteboard.
|
|
677
677
|
*
|
|
@@ -683,31 +683,31 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
683
683
|
* @scopes-current read:whiteboard:confluence
|
|
684
684
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-id-properties-get
|
|
685
685
|
*/
|
|
686
|
-
getWhiteboardContentProperties({ id, key, sort, cursor, limit, }: {
|
|
686
|
+
getWhiteboardContentProperties: ({ id, key, sort, cursor, limit, }: {
|
|
687
687
|
/** The ID of the whiteboard for which content properties should be returned. */
|
|
688
688
|
id: number;
|
|
689
689
|
/**
|
|
690
690
|
* Filters the response to return a specific content property with matching key
|
|
691
691
|
* (case sensitive).
|
|
692
692
|
*/
|
|
693
|
-
key?: string;
|
|
693
|
+
key?: string | undefined;
|
|
694
694
|
/** Used to sort the result by a particular field. */
|
|
695
|
-
sort?: ContentPropertySortOrder;
|
|
695
|
+
sort?: ContentPropertySortOrder | undefined;
|
|
696
696
|
/**
|
|
697
697
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
698
698
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
699
699
|
* retrieve the `next` set of results.
|
|
700
700
|
*/
|
|
701
|
-
cursor?: string;
|
|
701
|
+
cursor?: string | undefined;
|
|
702
702
|
/**
|
|
703
703
|
* Maximum number of attachments per result to return. If more results exist, use
|
|
704
704
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
705
705
|
* results.
|
|
706
706
|
*/
|
|
707
|
-
limit?: number;
|
|
708
|
-
})
|
|
709
|
-
results?: ContentProperty[];
|
|
710
|
-
_links?: MultiEntityLinks;
|
|
707
|
+
limit?: number | undefined;
|
|
708
|
+
}) => Promise<{
|
|
709
|
+
results?: ContentProperty[] | undefined;
|
|
710
|
+
_links?: MultiEntityLinks | undefined;
|
|
711
711
|
} & {
|
|
712
712
|
[key: string]: unknown;
|
|
713
713
|
}>;
|
|
@@ -723,12 +723,12 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
723
723
|
* @scopes-current read:whiteboard:confluence
|
|
724
724
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-get
|
|
725
725
|
*/
|
|
726
|
-
getWhiteboardContentPropertiesById({ whiteboardId, propertyId, }: {
|
|
726
|
+
getWhiteboardContentPropertiesById: ({ whiteboardId, propertyId, }: {
|
|
727
727
|
/** The ID of the whiteboard for which content properties should be returned. */
|
|
728
728
|
whiteboardId: number;
|
|
729
729
|
/** The ID of the content property being requested. */
|
|
730
730
|
propertyId: number;
|
|
731
|
-
})
|
|
731
|
+
}) => Promise<ContentProperty>;
|
|
732
732
|
/**
|
|
733
733
|
* Update a content property for attachment by its id.
|
|
734
734
|
*
|
|
@@ -740,14 +740,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
740
740
|
* @scopes-current read:attachment:confluence, write:attachment:confluence
|
|
741
741
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-attachments-attachment-id-properties-property-id-put
|
|
742
742
|
*/
|
|
743
|
-
updateAttachmentPropertyById({ attachmentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
743
|
+
updateAttachmentPropertyById: ({ attachmentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
744
744
|
/** The ID of the attachment the property belongs to. */
|
|
745
745
|
attachmentId: string;
|
|
746
746
|
/** The ID of the property to be updated. */
|
|
747
747
|
propertyId: number;
|
|
748
748
|
/** The content property to be updated. */
|
|
749
749
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
750
|
-
})
|
|
750
|
+
}) => Promise<ContentProperty>;
|
|
751
751
|
/**
|
|
752
752
|
* Update a content property for blog post by its id.
|
|
753
753
|
*
|
|
@@ -759,14 +759,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
759
759
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
760
760
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-blogposts-blogpost-id-properties-property-id-put
|
|
761
761
|
*/
|
|
762
|
-
updateBlogpostPropertyById({ blogpostId, propertyId, contentPropertyUpdateRequest, }: {
|
|
762
|
+
updateBlogpostPropertyById: ({ blogpostId, propertyId, contentPropertyUpdateRequest, }: {
|
|
763
763
|
/** The ID of the blog post the property belongs to. */
|
|
764
764
|
blogpostId: number;
|
|
765
765
|
/** The ID of the property to be updated. */
|
|
766
766
|
propertyId: number;
|
|
767
767
|
/** The content property to be updated. */
|
|
768
768
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
769
|
-
})
|
|
769
|
+
}) => Promise<ContentProperty>;
|
|
770
770
|
/**
|
|
771
771
|
* Update a content property for a comment by its id.
|
|
772
772
|
*
|
|
@@ -778,14 +778,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
778
778
|
* @scopes-current read:comment:confluence, write:comment:confluence
|
|
779
779
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-comments-comment-id-properties-property-id-put
|
|
780
780
|
*/
|
|
781
|
-
updateCommentPropertyById({ commentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
781
|
+
updateCommentPropertyById: ({ commentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
782
782
|
/** The ID of the comment the property belongs to. */
|
|
783
783
|
commentId: number;
|
|
784
784
|
/** The ID of the property to be updated. */
|
|
785
785
|
propertyId: number;
|
|
786
786
|
/** The content property to be updated. */
|
|
787
787
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
788
|
-
})
|
|
788
|
+
}) => Promise<ContentProperty>;
|
|
789
789
|
/**
|
|
790
790
|
* Update a content property for a piece of custom content by its id.
|
|
791
791
|
*
|
|
@@ -797,14 +797,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
797
797
|
* @scopes-current read:custom-content:confluence, write:custom-content:confluence
|
|
798
798
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-custom-content-custom-content-id-properties-property-id-put
|
|
799
799
|
*/
|
|
800
|
-
updateCustomContentPropertyById({ customContentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
800
|
+
updateCustomContentPropertyById: ({ customContentId, propertyId, contentPropertyUpdateRequest, }: {
|
|
801
801
|
/** The ID of the custom content the property belongs to. */
|
|
802
802
|
customContentId: number;
|
|
803
803
|
/** The ID of the property to be updated. */
|
|
804
804
|
propertyId: number;
|
|
805
805
|
/** The content property to be updated. */
|
|
806
806
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
807
|
-
})
|
|
807
|
+
}) => Promise<ContentProperty>;
|
|
808
808
|
/**
|
|
809
809
|
* Update a content property for a database by its id.
|
|
810
810
|
*
|
|
@@ -816,14 +816,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
816
816
|
* @scopes-current read:database:confluence, write:database:confluence
|
|
817
817
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-databases-database-id-properties-property-id-put
|
|
818
818
|
*/
|
|
819
|
-
updateDatabasePropertyById({ databaseId, propertyId, contentPropertyUpdateRequest, }: {
|
|
819
|
+
updateDatabasePropertyById: ({ databaseId, propertyId, contentPropertyUpdateRequest, }: {
|
|
820
820
|
/** The ID of the database the property belongs to. */
|
|
821
821
|
databaseId: number;
|
|
822
822
|
/** The ID of the property to be updated. */
|
|
823
823
|
propertyId: number;
|
|
824
824
|
/** The content property to be updated. */
|
|
825
825
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
826
|
-
})
|
|
826
|
+
}) => Promise<ContentProperty>;
|
|
827
827
|
/**
|
|
828
828
|
* Update a content property for a page by its id.
|
|
829
829
|
*
|
|
@@ -835,14 +835,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
835
835
|
* @scopes-current read:page:confluence, write:page:confluence
|
|
836
836
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-pages-page-id-properties-property-id-put
|
|
837
837
|
*/
|
|
838
|
-
updatePagePropertyById({ pageId, propertyId, contentPropertyUpdateRequest, }: {
|
|
838
|
+
updatePagePropertyById: ({ pageId, propertyId, contentPropertyUpdateRequest, }: {
|
|
839
839
|
/** The ID of the page the property belongs to. */
|
|
840
840
|
pageId: number;
|
|
841
841
|
/** The ID of the property to be updated. */
|
|
842
842
|
propertyId: number;
|
|
843
843
|
/** The content property to be updated. */
|
|
844
844
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
845
|
-
})
|
|
845
|
+
}) => Promise<ContentProperty>;
|
|
846
846
|
/**
|
|
847
847
|
* Update a content property for a Smart Link in the content tree by its id.
|
|
848
848
|
*
|
|
@@ -854,14 +854,14 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
854
854
|
* @scopes-current read:embed:confluence, write:embed:confluence
|
|
855
855
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-embeds-embed-id-properties-property-id-put
|
|
856
856
|
*/
|
|
857
|
-
updateSmartLinkPropertyById({ embedId, propertyId, contentPropertyUpdateRequest, }: {
|
|
857
|
+
updateSmartLinkPropertyById: ({ embedId, propertyId, contentPropertyUpdateRequest, }: {
|
|
858
858
|
/** The ID of the Smart Link in the content tree the property belongs to. */
|
|
859
859
|
embedId: number;
|
|
860
860
|
/** The ID of the property to be updated. */
|
|
861
861
|
propertyId: number;
|
|
862
862
|
/** The content property to be updated. */
|
|
863
863
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
864
|
-
})
|
|
864
|
+
}) => Promise<ContentProperty>;
|
|
865
865
|
/**
|
|
866
866
|
* Update a content property for a whiteboard by its id.
|
|
867
867
|
*
|
|
@@ -873,13 +873,13 @@ export declare class ContentPropertiesService extends CommonHttpService {
|
|
|
873
873
|
* @scopes-current read:whiteboard:confluence, write:whiteboard:confluence
|
|
874
874
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-content-properties#api-whiteboards-whiteboard-id-properties-property-id-put
|
|
875
875
|
*/
|
|
876
|
-
updateWhiteboardPropertyById({ whiteboardId, propertyId, contentPropertyUpdateRequest, }: {
|
|
876
|
+
updateWhiteboardPropertyById: ({ whiteboardId, propertyId, contentPropertyUpdateRequest, }: {
|
|
877
877
|
/** The ID of the whiteboard the property belongs to. */
|
|
878
878
|
whiteboardId: number;
|
|
879
879
|
/** The ID of the property to be updated. */
|
|
880
880
|
propertyId: number;
|
|
881
881
|
/** The content property to be updated. */
|
|
882
882
|
contentPropertyUpdateRequest: ContentPropertyUpdateRequest;
|
|
883
|
-
})
|
|
883
|
+
}) => Promise<ContentProperty>;
|
|
884
884
|
static initialize(): void;
|
|
885
885
|
}
|