@resolution/confluence-api-client 0.4.3 → 0.4.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +22 -0
- package/README.md +4 -0
- 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/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
|
@@ -13,12 +13,12 @@ export declare class LikeService extends CommonHttpService {
|
|
|
13
13
|
* @scopes-current read:page:confluence
|
|
14
14
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-blogposts-id-likes-count-get
|
|
15
15
|
*/
|
|
16
|
-
getBlogPostLikeCount({ id, }: {
|
|
16
|
+
getBlogPostLikeCount: ({ id, }: {
|
|
17
17
|
/** The ID of the blog post for which like count should be returned. */
|
|
18
18
|
id: number;
|
|
19
|
-
})
|
|
19
|
+
}) => Promise<{
|
|
20
20
|
/** The count number */
|
|
21
|
-
count?: number;
|
|
21
|
+
count?: number | undefined;
|
|
22
22
|
} & {
|
|
23
23
|
[key: string]: unknown;
|
|
24
24
|
}>;
|
|
@@ -33,7 +33,7 @@ export declare class LikeService extends CommonHttpService {
|
|
|
33
33
|
* @scopes-current read:page:confluence
|
|
34
34
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-blogposts-id-likes-users-get
|
|
35
35
|
*/
|
|
36
|
-
getBlogPostLikeUsers({ id, cursor, limit, }: {
|
|
36
|
+
getBlogPostLikeUsers: ({ id, cursor, limit, }: {
|
|
37
37
|
/** The ID of the blog post for which account IDs should be returned. */
|
|
38
38
|
id: number;
|
|
39
39
|
/**
|
|
@@ -41,16 +41,16 @@ export declare class LikeService extends CommonHttpService {
|
|
|
41
41
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
42
42
|
* retrieve the `next` set of results.
|
|
43
43
|
*/
|
|
44
|
-
cursor?: string;
|
|
44
|
+
cursor?: string | undefined;
|
|
45
45
|
/**
|
|
46
46
|
* Maximum number of account IDs per result to return. If more results exist, use
|
|
47
47
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
48
48
|
* results.
|
|
49
49
|
*/
|
|
50
|
-
limit?: number;
|
|
51
|
-
})
|
|
52
|
-
results?: Like[];
|
|
53
|
-
_links?: MultiEntityLinks;
|
|
50
|
+
limit?: number | undefined;
|
|
51
|
+
}) => Promise<{
|
|
52
|
+
results?: Like[] | undefined;
|
|
53
|
+
_links?: MultiEntityLinks | undefined;
|
|
54
54
|
} & {
|
|
55
55
|
[key: string]: unknown;
|
|
56
56
|
}>;
|
|
@@ -65,12 +65,12 @@ export declare class LikeService extends CommonHttpService {
|
|
|
65
65
|
* @scopes-current read:comment:confluence
|
|
66
66
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-footer-comments-id-likes-count-get
|
|
67
67
|
*/
|
|
68
|
-
getFooterLikeCount({ id, }: {
|
|
68
|
+
getFooterLikeCount: ({ id, }: {
|
|
69
69
|
/** The ID of the footer comment for which like count should be returned. */
|
|
70
70
|
id: number;
|
|
71
|
-
})
|
|
71
|
+
}) => Promise<{
|
|
72
72
|
/** The count number */
|
|
73
|
-
count?: number;
|
|
73
|
+
count?: number | undefined;
|
|
74
74
|
} & {
|
|
75
75
|
[key: string]: unknown;
|
|
76
76
|
}>;
|
|
@@ -85,7 +85,7 @@ export declare class LikeService extends CommonHttpService {
|
|
|
85
85
|
* @scopes-current read:comment:confluence
|
|
86
86
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-footer-comments-id-likes-users-get
|
|
87
87
|
*/
|
|
88
|
-
getFooterLikeUsers({ id, cursor, limit, }: {
|
|
88
|
+
getFooterLikeUsers: ({ id, cursor, limit, }: {
|
|
89
89
|
/** The ID of the footer comment for which like count should be returned. */
|
|
90
90
|
id: number;
|
|
91
91
|
/**
|
|
@@ -93,16 +93,16 @@ export declare class LikeService extends CommonHttpService {
|
|
|
93
93
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
94
94
|
* retrieve the `next` set of results.
|
|
95
95
|
*/
|
|
96
|
-
cursor?: string;
|
|
96
|
+
cursor?: string | undefined;
|
|
97
97
|
/**
|
|
98
98
|
* Maximum number of account IDs per result to return. If more results exist, use
|
|
99
99
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
100
100
|
* results.
|
|
101
101
|
*/
|
|
102
|
-
limit?: number;
|
|
103
|
-
})
|
|
104
|
-
results?: Like[];
|
|
105
|
-
_links?: MultiEntityLinks;
|
|
102
|
+
limit?: number | undefined;
|
|
103
|
+
}) => Promise<{
|
|
104
|
+
results?: Like[] | undefined;
|
|
105
|
+
_links?: MultiEntityLinks | undefined;
|
|
106
106
|
} & {
|
|
107
107
|
[key: string]: unknown;
|
|
108
108
|
}>;
|
|
@@ -117,12 +117,12 @@ export declare class LikeService extends CommonHttpService {
|
|
|
117
117
|
* @scopes-current read:comment:confluence
|
|
118
118
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-inline-comments-id-likes-count-get
|
|
119
119
|
*/
|
|
120
|
-
getInlineLikeCount({ id, }: {
|
|
120
|
+
getInlineLikeCount: ({ id, }: {
|
|
121
121
|
/** The ID of the inline comment for which like count should be returned. */
|
|
122
122
|
id: number;
|
|
123
|
-
})
|
|
123
|
+
}) => Promise<{
|
|
124
124
|
/** The count number */
|
|
125
|
-
count?: number;
|
|
125
|
+
count?: number | undefined;
|
|
126
126
|
} & {
|
|
127
127
|
[key: string]: unknown;
|
|
128
128
|
}>;
|
|
@@ -137,7 +137,7 @@ export declare class LikeService extends CommonHttpService {
|
|
|
137
137
|
* @scopes-current read:comment:confluence
|
|
138
138
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-inline-comments-id-likes-users-get
|
|
139
139
|
*/
|
|
140
|
-
getInlineLikeUsers({ id, cursor, limit, }: {
|
|
140
|
+
getInlineLikeUsers: ({ id, cursor, limit, }: {
|
|
141
141
|
/** The ID of the inline comment for which like count should be returned. */
|
|
142
142
|
id: number;
|
|
143
143
|
/**
|
|
@@ -145,16 +145,16 @@ export declare class LikeService extends CommonHttpService {
|
|
|
145
145
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
146
146
|
* retrieve the `next` set of results.
|
|
147
147
|
*/
|
|
148
|
-
cursor?: string;
|
|
148
|
+
cursor?: string | undefined;
|
|
149
149
|
/**
|
|
150
150
|
* Maximum number of account IDs per result to return. If more results exist, use
|
|
151
151
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
152
152
|
* results.
|
|
153
153
|
*/
|
|
154
|
-
limit?: number;
|
|
155
|
-
})
|
|
156
|
-
results?: Like[];
|
|
157
|
-
_links?: MultiEntityLinks;
|
|
154
|
+
limit?: number | undefined;
|
|
155
|
+
}) => Promise<{
|
|
156
|
+
results?: Like[] | undefined;
|
|
157
|
+
_links?: MultiEntityLinks | undefined;
|
|
158
158
|
} & {
|
|
159
159
|
[key: string]: unknown;
|
|
160
160
|
}>;
|
|
@@ -169,12 +169,12 @@ export declare class LikeService extends CommonHttpService {
|
|
|
169
169
|
* @scopes-current read:page:confluence
|
|
170
170
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-pages-id-likes-count-get
|
|
171
171
|
*/
|
|
172
|
-
getPageLikeCount({ id, }: {
|
|
172
|
+
getPageLikeCount: ({ id, }: {
|
|
173
173
|
/** The ID of the page for which like count should be returned. */
|
|
174
174
|
id: number;
|
|
175
|
-
})
|
|
175
|
+
}) => Promise<{
|
|
176
176
|
/** The count number */
|
|
177
|
-
count?: number;
|
|
177
|
+
count?: number | undefined;
|
|
178
178
|
} & {
|
|
179
179
|
[key: string]: unknown;
|
|
180
180
|
}>;
|
|
@@ -189,7 +189,7 @@ export declare class LikeService extends CommonHttpService {
|
|
|
189
189
|
* @scopes-current read:page:confluence
|
|
190
190
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-like#api-pages-id-likes-users-get
|
|
191
191
|
*/
|
|
192
|
-
getPageLikeUsers({ id, cursor, limit, }: {
|
|
192
|
+
getPageLikeUsers: ({ id, cursor, limit, }: {
|
|
193
193
|
/** The ID of the page for which like count should be returned. */
|
|
194
194
|
id: number;
|
|
195
195
|
/**
|
|
@@ -197,16 +197,16 @@ export declare class LikeService extends CommonHttpService {
|
|
|
197
197
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
198
198
|
* retrieve the `next` set of results.
|
|
199
199
|
*/
|
|
200
|
-
cursor?: string;
|
|
200
|
+
cursor?: string | undefined;
|
|
201
201
|
/**
|
|
202
202
|
* Maximum number of account IDs per result to return. If more results exist, use
|
|
203
203
|
* the `Link` header to retrieve a relative URL that will return the next set of
|
|
204
204
|
* results.
|
|
205
205
|
*/
|
|
206
|
-
limit?: number;
|
|
207
|
-
})
|
|
208
|
-
results?: Like[];
|
|
209
|
-
_links?: MultiEntityLinks;
|
|
206
|
+
limit?: number | undefined;
|
|
207
|
+
}) => Promise<{
|
|
208
|
+
results?: Like[] | undefined;
|
|
209
|
+
_links?: MultiEntityLinks | undefined;
|
|
210
210
|
} & {
|
|
211
211
|
[key: string]: unknown;
|
|
212
212
|
}>;
|