@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
|
@@ -11,168 +11,171 @@ const common_1 = require("../models/common");
|
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
12
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties */
|
|
13
13
|
class SpacePropertiesService extends CommonHttpService_1.CommonHttpService {
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
"
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
"
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
"
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
"
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
"
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
/**
|
|
17
|
+
* Creates a new space property.
|
|
18
|
+
*
|
|
19
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
20
|
+
* Permission to access the Confluence site ('Can use' global permission) and
|
|
21
|
+
* 'Admin' permission for the space.
|
|
22
|
+
*
|
|
23
|
+
* @returns Returned if the space property was created successfully.
|
|
24
|
+
* @path {POST} /spaces/{space-id}/properties
|
|
25
|
+
* @scopes-current read:space:confluence, write:space:confluence
|
|
26
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-post
|
|
27
|
+
*/
|
|
28
|
+
this.createSpaceProperty = ({ spaceId, spacePropertyCreateRequest, }) => {
|
|
29
|
+
return this.getClientInstance()
|
|
30
|
+
.request({
|
|
31
|
+
path: "/spaces/{space-id}/properties",
|
|
32
|
+
method: "POST",
|
|
33
|
+
pathParams: {
|
|
34
|
+
"space-id": spaceId,
|
|
35
|
+
},
|
|
36
|
+
headers: {
|
|
37
|
+
"Content-Type": "application/json",
|
|
38
|
+
},
|
|
39
|
+
body: spacePropertyCreateRequest,
|
|
40
|
+
})
|
|
41
|
+
.then(this.getClientInstance().responseHandler({
|
|
42
|
+
201: {
|
|
43
|
+
"application/json": "json",
|
|
44
|
+
},
|
|
45
|
+
}))
|
|
46
|
+
.then(commonHttpClient.castResponse())
|
|
47
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.createSpaceProperty.response"))
|
|
48
|
+
.then(commonHttpClient.getBody);
|
|
49
|
+
};
|
|
50
|
+
/**
|
|
51
|
+
* Deletes a space property by its id.
|
|
52
|
+
*
|
|
53
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
54
|
+
* Permission to access the Confluence site ('Can use' global permission) and
|
|
55
|
+
* 'Admin' permission for the space.
|
|
56
|
+
*
|
|
57
|
+
* @path {DELETE} /spaces/{space-id}/properties/{property-id}
|
|
58
|
+
* @scopes-current read:space:confluence, write:space:confluence
|
|
59
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-delete
|
|
60
|
+
*/
|
|
61
|
+
this.deleteSpacePropertyById = ({ spaceId, propertyId, }) => {
|
|
62
|
+
return this.getClientInstance()
|
|
63
|
+
.request({
|
|
64
|
+
path: "/spaces/{space-id}/properties/{property-id}",
|
|
65
|
+
method: "DELETE",
|
|
66
|
+
pathParams: {
|
|
67
|
+
"space-id": spaceId,
|
|
68
|
+
"property-id": propertyId,
|
|
69
|
+
},
|
|
70
|
+
})
|
|
71
|
+
.then(commonHttpClient.discardResult);
|
|
72
|
+
};
|
|
73
|
+
/**
|
|
74
|
+
* Returns all properties for the given space. Space properties are a key-value
|
|
75
|
+
* storage associated with a space.
|
|
76
|
+
* The limit parameter specifies the maximum number of results returned in a
|
|
77
|
+
* single response. Use the `link` response header
|
|
78
|
+
* to paginate through additional results.
|
|
79
|
+
*
|
|
80
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
81
|
+
* Permission to access the Confluence site ('Can use' global permission) and
|
|
82
|
+
* 'View' permission for the space.
|
|
83
|
+
*
|
|
84
|
+
* @returns Returned if the requested space properties are returned. `results` may be empty
|
|
85
|
+
* if no results were found.
|
|
86
|
+
* @path {GET} /spaces/{space-id}/properties
|
|
87
|
+
* @scopes-current read:space:confluence
|
|
88
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-get
|
|
89
|
+
*/
|
|
90
|
+
this.getSpaceProperties = ({ spaceId, key, cursor, limit, }) => {
|
|
91
|
+
return this.getClientInstance()
|
|
92
|
+
.request({
|
|
93
|
+
path: "/spaces/{space-id}/properties",
|
|
94
|
+
method: "GET",
|
|
95
|
+
pathParams: {
|
|
96
|
+
"space-id": spaceId,
|
|
97
|
+
},
|
|
98
|
+
query: {
|
|
99
|
+
key,
|
|
100
|
+
cursor,
|
|
101
|
+
limit,
|
|
102
|
+
},
|
|
103
|
+
})
|
|
104
|
+
.then(this.getClientInstance().responseHandler({
|
|
105
|
+
200: {
|
|
106
|
+
"application/json": "json",
|
|
107
|
+
},
|
|
108
|
+
}))
|
|
109
|
+
.then(commonHttpClient.castResponse())
|
|
110
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpaceProperties.response"))
|
|
111
|
+
.then(commonHttpClient.getBody);
|
|
112
|
+
};
|
|
113
|
+
/**
|
|
114
|
+
* Retrieve a space property by its id.
|
|
115
|
+
*
|
|
116
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
117
|
+
* Permission to access the Confluence site ('Can use' global permission) and
|
|
118
|
+
* 'View' permission for the space.
|
|
119
|
+
*
|
|
120
|
+
* @returns Returned if the space property was retrieved.
|
|
121
|
+
* @path {GET} /spaces/{space-id}/properties/{property-id}
|
|
122
|
+
* @scopes-current read:space:confluence
|
|
123
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-get
|
|
124
|
+
*/
|
|
125
|
+
this.getSpacePropertyById = ({ spaceId, propertyId, }) => {
|
|
126
|
+
return this.getClientInstance()
|
|
127
|
+
.request({
|
|
128
|
+
path: "/spaces/{space-id}/properties/{property-id}",
|
|
129
|
+
method: "GET",
|
|
130
|
+
pathParams: {
|
|
131
|
+
"space-id": spaceId,
|
|
132
|
+
"property-id": propertyId,
|
|
133
|
+
},
|
|
134
|
+
})
|
|
135
|
+
.then(this.getClientInstance().responseHandler({
|
|
136
|
+
200: {
|
|
137
|
+
"application/json": "json",
|
|
138
|
+
},
|
|
139
|
+
}))
|
|
140
|
+
.then(commonHttpClient.castResponse())
|
|
141
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.getSpacePropertyById.response"))
|
|
142
|
+
.then(commonHttpClient.getBody);
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
* Update a space property by its id.
|
|
146
|
+
*
|
|
147
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
148
|
+
* Permission to access the Confluence site ('Can use' global permission) and
|
|
149
|
+
* 'Admin' permission for the space.
|
|
150
|
+
*
|
|
151
|
+
* @returns Returned if the space property was updated successfully.
|
|
152
|
+
* @path {PUT} /spaces/{space-id}/properties/{property-id}
|
|
153
|
+
* @scopes-current read:space:confluence, write:space:confluence
|
|
154
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space-properties#api-spaces-space-id-properties-property-id-put
|
|
155
|
+
*/
|
|
156
|
+
this.updateSpacePropertyById = ({ spaceId, propertyId, spacePropertyUpdateRequest, }) => {
|
|
157
|
+
return this.getClientInstance()
|
|
158
|
+
.request({
|
|
159
|
+
path: "/spaces/{space-id}/properties/{property-id}",
|
|
160
|
+
method: "PUT",
|
|
161
|
+
pathParams: {
|
|
162
|
+
"space-id": spaceId,
|
|
163
|
+
"property-id": propertyId,
|
|
164
|
+
},
|
|
165
|
+
headers: {
|
|
166
|
+
"Content-Type": "application/json",
|
|
167
|
+
},
|
|
168
|
+
body: spacePropertyUpdateRequest,
|
|
169
|
+
})
|
|
170
|
+
.then(this.getClientInstance().responseHandler({
|
|
171
|
+
200: {
|
|
172
|
+
"application/json": "json",
|
|
173
|
+
},
|
|
174
|
+
}))
|
|
175
|
+
.then(commonHttpClient.castResponse())
|
|
176
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SpacePropertiesService.updateSpacePropertyById.response"))
|
|
177
|
+
.then(commonHttpClient.getBody);
|
|
178
|
+
};
|
|
176
179
|
}
|
|
177
180
|
static initialize() {
|
|
178
181
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SpacePropertiesService.getSpaceProperties.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SpacePropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAK1B,wEAAqE;AACrE,+FAA+F;AAC/F,MAAa,sBAAuB,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"SpacePropertiesService.js","sourceRoot":"","sources":["../../../../src/openapi/v2/services/SpacePropertiesService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAI0B;AAK1B,wEAAqE;AACrE,+FAA+F;AAC/F,MAAa,sBAAuB,SAAQ,qCAAiB;IAA7D;;QACE;;;;;;;;;;;WAWG;QACH,wBAAmB,GAAG,CAAC,EACrB,OAAO,EACP,0BAA0B,GAM3B,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;iBACpB;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,0BAA0B;aACjC,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,qDAAqD,CACtD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;WAUG;QACH,4BAAuB,GAAG,CAAC,EACzB,OAAO,EACP,UAAU,GAMX,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;oBACnB,aAAa,EAAE,UAAU;iBAC1B;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;WAgBG;QACH,uBAAkB,GAAG,CAAC,EACpB,OAAO,EACP,GAAG,EACH,MAAM,EACN,KAAK,GAsBN,EAOC,EAAE;YACF,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,+BAA+B;gBACrC,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;iBACpB;gBACD,KAAK,EAAE;oBACL,GAAG;oBACH,MAAM;oBACN,KAAK;iBACN;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EASzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,oDAAoD,CACrD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,yBAAoB,GAAG,CAAC,EACtB,OAAO,EACP,UAAU,GAMX,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;oBACnB,aAAa,EAAE,UAAU;iBAC1B;aACF,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,sDAAsD,CACvD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;WAWG;QACH,4BAAuB,GAAG,CAAC,EACzB,OAAO,EACP,UAAU,EACV,0BAA0B,GAQ3B,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,6CAA6C;gBACnD,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,UAAU,EAAE,OAAO;oBACnB,aAAa,EAAE,UAAU;iBAC1B;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,IAAI,EAAE,0BAA0B;aACjC,CAAC;iBACD,IAAI,CACH,IAAI,CAAC,iBAAiB,EAAE,CAAC,eAAe,CAAC;gBACvC,GAAG,EAAE;oBACH,kBAAkB,EAAE,MAAM;iBAC3B;aACF,CAAC,CACH;iBACA,IAAI,CACH,gBAAgB,CAAC,YAAY,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,yDAAyD,CAC1D,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAqDJ,CAAC;IApDC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oDAAoD,EACpD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,OAAC;iBACJ,MAAM,CAAC;gBACN,OAAO,EAAE,OAAC;qBACP,KAAK,CAAC,iDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;qBACpD,QAAQ,EAAE;gBACb,MAAM,EAAE,iDAAuB;qBAC5B,IAAI,CAAC,kBAAkB,CAAC;qBACxB,QAAQ,EAAE;aACd,CAAC;iBACD,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzB,CAAC;aACD,QAAQ,CAAC,oDAAoD,CAAC,CAClE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,qDAAqD,EACrD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,sDAAsD,EACtD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CACpE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,yDAAyD,EACzD,OAAC;aACE,MAAM,CAAC;YACN,MAAM,EAAE,OAAC,CAAC,OAAO,CAAC,GAAG,CAAC;YACtB,SAAS,EAAE,OAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC;YACxC,IAAI,EAAE,iDAAuB,CAAC,IAAI,CAAC,eAAe,CAAC;SACpD,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CACvE,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAjVD,wDAiVC"}
|
|
@@ -14,7 +14,7 @@ export declare class SpaceService extends CommonHttpService {
|
|
|
14
14
|
* @scopes-current read:space:confluence
|
|
15
15
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space#api-spaces-id-get
|
|
16
16
|
*/
|
|
17
|
-
getSpaceById({ id, descriptionFormat, includeIcon, includeOperations, includeProperties, includePermissions, includeLabels, }: {
|
|
17
|
+
getSpaceById: ({ id, descriptionFormat, includeIcon, includeOperations, includeProperties, includePermissions, includeLabels, }: {
|
|
18
18
|
/** The ID of the space to be returned. */
|
|
19
19
|
id: number;
|
|
20
20
|
/**
|
|
@@ -22,9 +22,9 @@ export declare class SpaceService extends CommonHttpService {
|
|
|
22
22
|
* response. If available, the representation will be available under a response
|
|
23
23
|
* field of the same name under the `description` field.
|
|
24
24
|
*/
|
|
25
|
-
descriptionFormat?: SpaceDescriptionBodyRepresentation;
|
|
25
|
+
descriptionFormat?: SpaceDescriptionBodyRepresentation | undefined;
|
|
26
26
|
/** If the icon for the space should be fetched or not. */
|
|
27
|
-
includeIcon?: boolean;
|
|
27
|
+
includeIcon?: boolean | undefined;
|
|
28
28
|
/**
|
|
29
29
|
* Includes operations associated with this space in the response.
|
|
30
30
|
* The number of results will be limited to 50 and sorted in the default sort
|
|
@@ -32,7 +32,7 @@ export declare class SpaceService extends CommonHttpService {
|
|
|
32
32
|
* A `meta` and `_links` property will be present to indicate if more results are
|
|
33
33
|
* available and a link to retrieve the rest of the results.
|
|
34
34
|
*/
|
|
35
|
-
includeOperations?: boolean;
|
|
35
|
+
includeOperations?: boolean | undefined;
|
|
36
36
|
/**
|
|
37
37
|
* Includes space properties associated with this space in the response.
|
|
38
38
|
* The number of results will be limited to 50 and sorted in the default sort
|
|
@@ -40,7 +40,7 @@ export declare class SpaceService extends CommonHttpService {
|
|
|
40
40
|
* A `meta` and `_links` property will be present to indicate if more results are
|
|
41
41
|
* available and a link to retrieve the rest of the results.
|
|
42
42
|
*/
|
|
43
|
-
includeProperties?: boolean;
|
|
43
|
+
includeProperties?: boolean | undefined;
|
|
44
44
|
/**
|
|
45
45
|
* Includes space permissions associated with this space in the response.
|
|
46
46
|
* The number of results will be limited to 50 and sorted in the default sort
|
|
@@ -48,7 +48,7 @@ export declare class SpaceService extends CommonHttpService {
|
|
|
48
48
|
* A `meta` and `_links` property will be present to indicate if more results are
|
|
49
49
|
* available and a link to retrieve the rest of the results.
|
|
50
50
|
*/
|
|
51
|
-
includePermissions?: boolean;
|
|
51
|
+
includePermissions?: boolean | undefined;
|
|
52
52
|
/**
|
|
53
53
|
* Includes labels associated with this space in the response.
|
|
54
54
|
* The number of results will be limited to 50 and sorted in the default sort
|
|
@@ -56,17 +56,17 @@ export declare class SpaceService extends CommonHttpService {
|
|
|
56
56
|
* A `meta` and `_links` property will be present to indicate if more results are
|
|
57
57
|
* available and a link to retrieve the rest of the results.
|
|
58
58
|
*/
|
|
59
|
-
includeLabels?: boolean;
|
|
60
|
-
})
|
|
61
|
-
_links?: {
|
|
59
|
+
includeLabels?: boolean | undefined;
|
|
60
|
+
}) => Promise<SpaceSingle & {
|
|
61
|
+
_links?: ({
|
|
62
62
|
/** Base url of the Confluence site. */
|
|
63
|
-
base?: string;
|
|
63
|
+
base?: string | undefined;
|
|
64
64
|
} & {
|
|
65
65
|
[key: string]: unknown;
|
|
66
|
-
};
|
|
66
|
+
}) | undefined;
|
|
67
67
|
} & {
|
|
68
68
|
[key: string]: unknown;
|
|
69
|
-
}
|
|
69
|
+
}>;
|
|
70
70
|
/**
|
|
71
71
|
* Returns all spaces. The results will be sorted by id ascending. The number of
|
|
72
72
|
* results is limited by the `limit` parameter and
|
|
@@ -82,61 +82,61 @@ export declare class SpaceService extends CommonHttpService {
|
|
|
82
82
|
* @scopes-current read:space:confluence
|
|
83
83
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v2/api-group-space#api-spaces-get
|
|
84
84
|
*/
|
|
85
|
-
getSpaces({ ids, keys, type, status, labels, favoritedBy, notFavoritedBy, sort, descriptionFormat, includeIcon, cursor, limit, }?: {
|
|
85
|
+
getSpaces: ({ ids, keys, type, status, labels, favoritedBy, notFavoritedBy, sort, descriptionFormat, includeIcon, cursor, limit, }?: {
|
|
86
86
|
/**
|
|
87
87
|
* Filter the results to spaces based on their IDs. Multiple IDs can be specified
|
|
88
88
|
* as a comma-separated list.
|
|
89
89
|
*/
|
|
90
|
-
ids?: number[];
|
|
90
|
+
ids?: number[] | undefined;
|
|
91
91
|
/**
|
|
92
92
|
* Filter the results to spaces based on their keys. Multiple keys can be
|
|
93
93
|
* specified as a comma-separated list.
|
|
94
94
|
*/
|
|
95
|
-
keys?: string[];
|
|
95
|
+
keys?: string[] | undefined;
|
|
96
96
|
/** Filter the results to spaces based on their type. */
|
|
97
|
-
type?: "global" | "collaboration" | "knowledge_base" |
|
|
97
|
+
type?: "global" | "personal" | "collaboration" | "knowledge_base" | undefined;
|
|
98
98
|
/** Filter the results to spaces based on their status. */
|
|
99
|
-
status?: "current" | "archived";
|
|
99
|
+
status?: "current" | "archived" | undefined;
|
|
100
100
|
/**
|
|
101
101
|
* Filter the results to spaces based on their labels. Multiple labels can be
|
|
102
102
|
* specified as a comma-separated list.
|
|
103
103
|
*/
|
|
104
|
-
labels?: string[];
|
|
104
|
+
labels?: string[] | undefined;
|
|
105
105
|
/**
|
|
106
106
|
* Filter the results to spaces favorited by the user with the specified account
|
|
107
107
|
* ID.
|
|
108
108
|
*/
|
|
109
|
-
favoritedBy?: string;
|
|
109
|
+
favoritedBy?: string | undefined;
|
|
110
110
|
/**
|
|
111
111
|
* Filter the results to spaces NOT favorited by the user with the specified
|
|
112
112
|
* account ID.
|
|
113
113
|
*/
|
|
114
|
-
notFavoritedBy?: string;
|
|
114
|
+
notFavoritedBy?: string | undefined;
|
|
115
115
|
/** Used to sort the result by a particular field. */
|
|
116
|
-
sort?: SpaceSortOrder;
|
|
116
|
+
sort?: SpaceSortOrder | undefined;
|
|
117
117
|
/**
|
|
118
118
|
* The content format type to be returned in the `description` field of the
|
|
119
119
|
* response. If available, the representation will be available under a response
|
|
120
120
|
* field of the same name under the `description` field.
|
|
121
121
|
*/
|
|
122
|
-
descriptionFormat?: SpaceDescriptionBodyRepresentation;
|
|
122
|
+
descriptionFormat?: SpaceDescriptionBodyRepresentation | undefined;
|
|
123
123
|
/** If the icon for the space should be fetched or not. */
|
|
124
|
-
includeIcon?: boolean;
|
|
124
|
+
includeIcon?: boolean | undefined;
|
|
125
125
|
/**
|
|
126
126
|
* Used for pagination, this opaque cursor will be returned in the `next` URL in
|
|
127
127
|
* the `Link` response header. Use the relative URL in the `Link` header to
|
|
128
128
|
* retrieve the `next` set of results.
|
|
129
129
|
*/
|
|
130
|
-
cursor?: string;
|
|
130
|
+
cursor?: string | undefined;
|
|
131
131
|
/**
|
|
132
132
|
* Maximum number of spaces per result to return. If more results exist, use the
|
|
133
133
|
* `Link` response header to retrieve a relative URL that will return the next set
|
|
134
134
|
* of results.
|
|
135
135
|
*/
|
|
136
|
-
limit?: number;
|
|
137
|
-
})
|
|
138
|
-
results?: SpaceBulk[];
|
|
139
|
-
_links?: MultiEntityLinks;
|
|
136
|
+
limit?: number | undefined;
|
|
137
|
+
}) => Promise<{
|
|
138
|
+
results?: SpaceBulk[] | undefined;
|
|
139
|
+
_links?: MultiEntityLinks | undefined;
|
|
140
140
|
} & {
|
|
141
141
|
[key: string]: unknown;
|
|
142
142
|
}>;
|