@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,139 +11,142 @@ const search_1 = require("../models/search");
|
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
12
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search */
|
|
13
13
|
class SearchService 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
|
-
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
/**
|
|
17
|
+
* Searches for content using the
|
|
18
|
+
* [Confluence Query Language
|
|
19
|
+
* (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
|
|
20
|
+
*
|
|
21
|
+
* **Note that CQL input queries submitted through the `/wiki/rest/api/search`
|
|
22
|
+
* endpoint no longer support user-specific fields like `user`, `user.fullname`,
|
|
23
|
+
* `user.accountid`, and `user.userkey`.**
|
|
24
|
+
* See this [deprecation
|
|
25
|
+
* notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/)
|
|
26
|
+
* for more details.
|
|
27
|
+
*
|
|
28
|
+
* Example initial call:
|
|
29
|
+
* ```
|
|
30
|
+
* /wiki/rest/api/search?cql=type=page&limit=25
|
|
31
|
+
* ```
|
|
32
|
+
*
|
|
33
|
+
* Example response:
|
|
34
|
+
* ```
|
|
35
|
+
* {
|
|
36
|
+
* "results": [
|
|
37
|
+
* { ... },
|
|
38
|
+
* { ... },
|
|
39
|
+
* ...
|
|
40
|
+
* { ... }
|
|
41
|
+
* ],
|
|
42
|
+
* "limit": 25,
|
|
43
|
+
* "size": 25,
|
|
44
|
+
* ...
|
|
45
|
+
* "_links": {
|
|
46
|
+
* "base": "<url>",
|
|
47
|
+
* "context": "<url>",
|
|
48
|
+
* "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg",
|
|
49
|
+
* "self": "<url>"
|
|
50
|
+
* }
|
|
51
|
+
* }
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* When additional results are available, returns `next` and `prev` URLs to
|
|
55
|
+
* retrieve them in subsequent calls. The URLs each contain a cursor that points
|
|
56
|
+
* to the appropriate set of results. Use `limit` to specify the number of results
|
|
57
|
+
* returned in each call.
|
|
58
|
+
*
|
|
59
|
+
* Example subsequent call (taken from example response):
|
|
60
|
+
* ```
|
|
61
|
+
* /wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg
|
|
62
|
+
* ```
|
|
63
|
+
* The response to this will have a `prev` URL similar to the `next` in the
|
|
64
|
+
* example response.
|
|
65
|
+
*
|
|
66
|
+
* Starting on Dec 10, 2024, if the expand query parameter is used with the
|
|
67
|
+
* `body.export_view` and/or `body.styled_view` properties, then the query limit
|
|
68
|
+
* parameter will be restricted to a maximum value of 25.
|
|
69
|
+
*
|
|
70
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
71
|
+
* Permission to view the entities. Note, only entities that the user has
|
|
72
|
+
* permission to view will be returned.
|
|
73
|
+
*
|
|
74
|
+
* @returns Returned if the requested results are returned.
|
|
75
|
+
* @path {GET} /wiki/rest/api/search
|
|
76
|
+
* @scopes-current search:confluence
|
|
77
|
+
* @scopes-beta read:content-details:confluence
|
|
78
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-get
|
|
79
|
+
*/
|
|
80
|
+
this.searchByCql = ({ cql, cqlcontext, cursor, next, prev, limit, start, includeArchivedSpaces, excludeCurrentSpaces, excerpt, sitePermissionTypeFilter, _, expand, }) => {
|
|
81
|
+
return this.getClientInstance()
|
|
82
|
+
.request({
|
|
83
|
+
path: "/wiki/rest/api/search",
|
|
84
|
+
method: "GET",
|
|
85
|
+
query: {
|
|
86
|
+
cql,
|
|
87
|
+
cqlcontext,
|
|
88
|
+
cursor,
|
|
89
|
+
next,
|
|
90
|
+
prev,
|
|
91
|
+
limit,
|
|
92
|
+
start,
|
|
93
|
+
includeArchivedSpaces,
|
|
94
|
+
excludeCurrentSpaces,
|
|
95
|
+
excerpt,
|
|
96
|
+
sitePermissionTypeFilter,
|
|
97
|
+
_,
|
|
98
|
+
expand,
|
|
99
|
+
},
|
|
100
|
+
})
|
|
101
|
+
.then(this.getClientInstance().responseHandler({
|
|
102
|
+
200: {
|
|
103
|
+
"application/json": "json",
|
|
104
|
+
},
|
|
105
|
+
}))
|
|
106
|
+
.then(commonHttpClient.castResponse())
|
|
107
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchByCQL.response"))
|
|
108
|
+
.then(commonHttpClient.getBody);
|
|
109
|
+
};
|
|
110
|
+
/**
|
|
111
|
+
* Searches for users using user-specific queries from the
|
|
112
|
+
* [Confluence Query Language
|
|
113
|
+
* (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
|
|
114
|
+
*
|
|
115
|
+
* Note that CQL input queries submitted through the `/wiki/rest/api/search/user`
|
|
116
|
+
* endpoint only support user-specific fields like `user`, `user.fullname`,
|
|
117
|
+
* `user.accountid`, and `user.userkey`.
|
|
118
|
+
*
|
|
119
|
+
* Note that some user fields may be set to null depending on the user's privacy
|
|
120
|
+
* settings.
|
|
121
|
+
* These are: email, profilePicture, displayName, and timeZone.
|
|
122
|
+
*
|
|
123
|
+
* @returns Returned if the requested results are returned.
|
|
124
|
+
* @path {GET} /wiki/rest/api/search/user
|
|
125
|
+
* @scopes-current read:content-details:confluence
|
|
126
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-user-get
|
|
127
|
+
*/
|
|
128
|
+
this.searchUser = ({ cql, start, limit, expand, sitePermissionTypeFilter, }) => {
|
|
129
|
+
return this.getClientInstance()
|
|
130
|
+
.request({
|
|
131
|
+
path: "/wiki/rest/api/search/user",
|
|
132
|
+
method: "GET",
|
|
133
|
+
query: {
|
|
134
|
+
cql,
|
|
135
|
+
start,
|
|
136
|
+
limit,
|
|
137
|
+
expand,
|
|
138
|
+
sitePermissionTypeFilter,
|
|
139
|
+
},
|
|
140
|
+
})
|
|
141
|
+
.then(this.getClientInstance().responseHandler({
|
|
142
|
+
200: {
|
|
143
|
+
"application/json": "json",
|
|
144
|
+
},
|
|
145
|
+
}))
|
|
146
|
+
.then(commonHttpClient.castResponse())
|
|
147
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("SearchService.searchUser.response"))
|
|
148
|
+
.then(commonHttpClient.getBody);
|
|
149
|
+
};
|
|
147
150
|
}
|
|
148
151
|
static initialize() {
|
|
149
152
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("SearchService.searchByCQL.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SearchService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SearchService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE,qFAAqF;AACrF,MAAa,aAAc,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"SearchService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/SearchService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,6CAG0B;AAC1B,wEAAqE;AACrE,qFAAqF;AACrF,MAAa,aAAc,SAAQ,qCAAiB;IAApD;;QACE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;WA+DG;QACH,gBAAW,GAAG,CAAC,EACb,GAAG,EACH,UAAU,EACV,MAAM,EACN,IAAI,EACJ,IAAI,EACJ,KAAK,EACL,KAAK,EACL,qBAAqB,EACrB,oBAAoB,EACpB,OAAO,EACP,wBAAwB,EACxB,CAAC,EACD,MAAM,GAuDP,EAA2C,EAAE;YAC5C,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,uBAAuB;gBAC7B,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;oBACH,UAAU;oBACV,MAAM;oBACN,IAAI;oBACJ,IAAI;oBACJ,KAAK;oBACL,KAAK;oBACL,qBAAqB;oBACrB,oBAAoB;oBACpB,OAAO;oBACP,wBAAwB;oBACxB,CAAC;oBACD,MAAM;iBACP;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,CAAC,oCAAoC,CAAC,CACxE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,eAAU,GAAG,CAAC,EACZ,GAAG,EACH,KAAK,EACL,KAAK,EACL,MAAM,EACN,wBAAwB,GAwCzB,EAA2C,EAAE;YAC5C,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,4BAA4B;gBAClC,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE;oBACL,GAAG;oBACH,KAAK;oBACL,KAAK;oBACL,MAAM;oBACN,wBAAwB;iBACzB;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,CAAC,mCAAmC,CAAC,CACvE;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAwBJ,CAAC;IAvBC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,oCAAoC,EACpC,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,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,oCAAoC,CAAC,CAClD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,mCAAmC,EACnC,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,gCAAgC,CAAC;SACrE,CAAC;aACD,QAAQ,CAAC,mCAAmC,CAAC,CACjD,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,wCAA+B,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF;AAnSD,sCAmSC"}
|
|
@@ -19,14 +19,14 @@ export declare class SettingsService extends CommonHttpService {
|
|
|
19
19
|
* @scopes-beta read:configuration:confluence, read:space.setting:confluence
|
|
20
20
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-get
|
|
21
21
|
*/
|
|
22
|
-
getLookAndFeelSettings({ spaceKey, }?: {
|
|
22
|
+
getLookAndFeelSettings: ({ spaceKey, }?: {
|
|
23
23
|
/**
|
|
24
24
|
* The key of the space for which the look and feel settings will be
|
|
25
25
|
* returned. If this is not set, only the global look and feel settings
|
|
26
26
|
* are returned.
|
|
27
27
|
*/
|
|
28
|
-
spaceKey?: string;
|
|
29
|
-
})
|
|
28
|
+
spaceKey?: string | undefined;
|
|
29
|
+
}) => Promise<LookAndFeelSettings>;
|
|
30
30
|
/**
|
|
31
31
|
* Returns the system information for the Confluence Cloud tenant. This
|
|
32
32
|
* information is used by Atlassian.
|
|
@@ -41,7 +41,7 @@ export declare class SettingsService extends CommonHttpService {
|
|
|
41
41
|
* @scopes-beta read:configuration:confluence
|
|
42
42
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-systeminfo-get
|
|
43
43
|
*/
|
|
44
|
-
getSystemInfo()
|
|
44
|
+
getSystemInfo: () => Promise<SystemInfoEntity | null>;
|
|
45
45
|
/**
|
|
46
46
|
* Resets the custom look and feel settings for the site or a single space.
|
|
47
47
|
* This changes the values of the custom settings to be the same as the
|
|
@@ -57,14 +57,14 @@ export declare class SettingsService extends CommonHttpService {
|
|
|
57
57
|
* @scopes-beta write:configuration:confluence, write:space.setting:confluence
|
|
58
58
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-delete
|
|
59
59
|
*/
|
|
60
|
-
resetLookAndFeelSettings({ spaceKey, }?: {
|
|
60
|
+
resetLookAndFeelSettings: ({ spaceKey, }?: {
|
|
61
61
|
/**
|
|
62
62
|
* The key of the space for which the look and feel settings will be
|
|
63
63
|
* reset. If this is not set, the global look and feel settings will
|
|
64
64
|
* be reset.
|
|
65
65
|
*/
|
|
66
|
-
spaceKey?: string;
|
|
67
|
-
})
|
|
66
|
+
spaceKey?: string | undefined;
|
|
67
|
+
}) => Promise<void>;
|
|
68
68
|
/**
|
|
69
69
|
* Sets the look and feel settings to either the default settings or the
|
|
70
70
|
* custom settings, for the site or a single space. Note, the default
|
|
@@ -81,16 +81,16 @@ export declare class SettingsService extends CommonHttpService {
|
|
|
81
81
|
* write:configuration:confluence, write:space.setting:confluence
|
|
82
82
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-selected-put
|
|
83
83
|
*/
|
|
84
|
-
setLookAndFeelSettings({ spaceKey, requestBody, }: {
|
|
84
|
+
setLookAndFeelSettings: ({ spaceKey, requestBody, }: {
|
|
85
85
|
/**
|
|
86
86
|
* The key of the space for which the look and feel settings will be
|
|
87
87
|
* set. If this is not set, the global look and feel settings will be
|
|
88
88
|
* set.
|
|
89
89
|
*/
|
|
90
|
-
spaceKey?: string;
|
|
90
|
+
spaceKey?: string | undefined;
|
|
91
91
|
/** The look and feel type to be set. */
|
|
92
92
|
requestBody: "global" | "custom" | "theme";
|
|
93
|
-
})
|
|
93
|
+
}) => Promise<string>;
|
|
94
94
|
/**
|
|
95
95
|
* Sets the look and feel settings to the default (global) settings, the
|
|
96
96
|
* custom settings, or the current theme's settings for a space.
|
|
@@ -107,10 +107,10 @@ export declare class SettingsService extends CommonHttpService {
|
|
|
107
107
|
* @scopes-beta read:space.setting:confluence, write:space.setting:confluence
|
|
108
108
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-put
|
|
109
109
|
*/
|
|
110
|
-
updateLookAndFeel({ lookAndFeelSelection, }: {
|
|
110
|
+
updateLookAndFeel: ({ lookAndFeelSelection, }: {
|
|
111
111
|
/** The look and feel type to be set. */
|
|
112
112
|
lookAndFeelSelection: LookAndFeelSelection;
|
|
113
|
-
})
|
|
113
|
+
}) => Promise<LookAndFeelSelection>;
|
|
114
114
|
/**
|
|
115
115
|
* Updates the look and feel settings for the site or for a single space.
|
|
116
116
|
* If custom settings exist, they are updated. If no custom settings exist,
|
|
@@ -129,13 +129,13 @@ export declare class SettingsService extends CommonHttpService {
|
|
|
129
129
|
* write:configuration:confluence, write:space.setting:confluence
|
|
130
130
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-settings#api-wiki-rest-api-settings-lookandfeel-custom-post
|
|
131
131
|
*/
|
|
132
|
-
updateLookAndFeelSettings({ spaceKey, lookAndFeel, }: {
|
|
132
|
+
updateLookAndFeelSettings: ({ spaceKey, lookAndFeel, }: {
|
|
133
133
|
/**
|
|
134
134
|
* The key of the space for which the look and feel settings will be
|
|
135
135
|
* updated. If this is not set, the global look and feel settings will
|
|
136
136
|
* be updated.
|
|
137
137
|
*/
|
|
138
|
-
spaceKey?: string;
|
|
138
|
+
spaceKey?: string | undefined;
|
|
139
139
|
/**
|
|
140
140
|
* The updated settings. All values for the settings must be included,
|
|
141
141
|
* regardless of whether they are being changed.
|
|
@@ -145,6 +145,6 @@ export declare class SettingsService extends CommonHttpService {
|
|
|
145
145
|
* and modify it as needed.
|
|
146
146
|
*/
|
|
147
147
|
lookAndFeel: LookAndFeel;
|
|
148
|
-
})
|
|
148
|
+
}) => Promise<LookAndFeelWithLinks>;
|
|
149
149
|
static initialize(): void;
|
|
150
150
|
}
|