@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
|
@@ -11,234 +11,237 @@ const relation_1 = require("../models/relation");
|
|
|
11
11
|
const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
12
12
|
/** @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation */
|
|
13
13
|
class RelationService 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
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
14
|
+
constructor() {
|
|
15
|
+
super(...arguments);
|
|
16
|
+
/**
|
|
17
|
+
* Creates a relationship between two entities (user, space, content). The
|
|
18
|
+
* 'favourite' relationship is supported by default, but you can use this method
|
|
19
|
+
* to create any type of relationship between two entities.
|
|
20
|
+
*
|
|
21
|
+
* For example, the following method creates a 'sibling' relationship between
|
|
22
|
+
* two pieces of content:
|
|
23
|
+
* `PUT /wiki/rest/api/relation/sibling/from/content/123/to/content/456`
|
|
24
|
+
*
|
|
25
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
26
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
27
|
+
*
|
|
28
|
+
* @returns Returned if the relationship is created.
|
|
29
|
+
* @path {PUT}
|
|
30
|
+
* /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
|
|
31
|
+
* @scopes-current write:confluence-content
|
|
32
|
+
* @scopes-beta read:relation:confluence, read:space:confluence, read:user:confluence,
|
|
33
|
+
* read:content:confluence, write:relation:confluence
|
|
34
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-put
|
|
35
|
+
*/
|
|
36
|
+
this.createRelationship = ({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }) => {
|
|
37
|
+
return this.getClientInstance()
|
|
38
|
+
.request({
|
|
39
|
+
path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}",
|
|
40
|
+
method: "PUT",
|
|
41
|
+
pathParams: {
|
|
42
|
+
relationName,
|
|
43
|
+
sourceType,
|
|
44
|
+
sourceKey,
|
|
45
|
+
targetType,
|
|
46
|
+
targetKey,
|
|
47
|
+
},
|
|
48
|
+
query: {
|
|
49
|
+
sourceStatus,
|
|
50
|
+
targetStatus,
|
|
51
|
+
sourceVersion,
|
|
52
|
+
targetVersion,
|
|
53
|
+
},
|
|
54
|
+
})
|
|
55
|
+
.then(this.getClientInstance().responseHandler({
|
|
56
|
+
200: {
|
|
57
|
+
"application/json": "json",
|
|
58
|
+
},
|
|
59
|
+
}))
|
|
60
|
+
.then(commonHttpClient.castResponse())
|
|
61
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.createRelationship.response"))
|
|
62
|
+
.then(commonHttpClient.getBody);
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
* Deletes a relationship between two entities (user, space, content).
|
|
66
|
+
*
|
|
67
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
68
|
+
* Permission to access the Confluence site ('Can use' global permission).
|
|
69
|
+
* For favourite relationships, the current user can only delete their own
|
|
70
|
+
* favourite relationships. A space administrator can delete favourite
|
|
71
|
+
* relationships for any user.
|
|
72
|
+
*
|
|
73
|
+
* @path {DELETE}
|
|
74
|
+
* /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
|
|
75
|
+
* @scopes-current write:confluence-content
|
|
76
|
+
* @scopes-beta write:relation:confluence
|
|
77
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-delete
|
|
78
|
+
*/
|
|
79
|
+
this.deleteRelationship = ({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, }) => {
|
|
80
|
+
return this.getClientInstance()
|
|
81
|
+
.request({
|
|
82
|
+
path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}",
|
|
83
|
+
method: "DELETE",
|
|
84
|
+
pathParams: {
|
|
85
|
+
relationName,
|
|
86
|
+
sourceType,
|
|
87
|
+
sourceKey,
|
|
88
|
+
targetType,
|
|
89
|
+
targetKey,
|
|
90
|
+
},
|
|
91
|
+
query: {
|
|
92
|
+
sourceStatus,
|
|
93
|
+
targetStatus,
|
|
94
|
+
sourceVersion,
|
|
95
|
+
targetVersion,
|
|
96
|
+
},
|
|
97
|
+
})
|
|
98
|
+
.then(commonHttpClient.discardResult);
|
|
99
|
+
};
|
|
100
|
+
/**
|
|
101
|
+
* Returns all target entities that have a particular relationship to the
|
|
102
|
+
* source entity. Note, relationships are one way.
|
|
103
|
+
*
|
|
104
|
+
* For example, the following method finds all users that have a 'collaborator'
|
|
105
|
+
* relationship to a piece of content with an ID of '1234':
|
|
106
|
+
* `GET /wiki/rest/api/relation/collaborator/to/content/1234/from/user`
|
|
107
|
+
* Note, 'collaborator' is an example custom relationship type.
|
|
108
|
+
*
|
|
109
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
110
|
+
* Permission to view both the target entity and source entity.
|
|
111
|
+
*
|
|
112
|
+
* @returns Returned if the requested relationships are returned.
|
|
113
|
+
* @path {GET}
|
|
114
|
+
* /wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}
|
|
115
|
+
* @scopes-current read:confluence-content.summary
|
|
116
|
+
* @scopes-beta read:relation:confluence, read:content-details:confluence
|
|
117
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-to-targettype-targetkey-from-sourcetype-get
|
|
118
|
+
*/
|
|
119
|
+
this.findSourcesForTarget = ({ relationName, sourceType, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }) => {
|
|
120
|
+
return this.getClientInstance()
|
|
121
|
+
.request({
|
|
122
|
+
path: "/wiki/rest/api/relation/{relationName}/to/{targetType}/{targetKey}/from/{sourceType}",
|
|
123
|
+
method: "GET",
|
|
124
|
+
pathParams: {
|
|
125
|
+
relationName,
|
|
126
|
+
sourceType,
|
|
127
|
+
targetType,
|
|
128
|
+
targetKey,
|
|
129
|
+
},
|
|
130
|
+
query: {
|
|
131
|
+
sourceStatus,
|
|
132
|
+
targetStatus,
|
|
133
|
+
sourceVersion,
|
|
134
|
+
targetVersion,
|
|
135
|
+
expand,
|
|
136
|
+
start,
|
|
137
|
+
limit,
|
|
138
|
+
},
|
|
139
|
+
})
|
|
140
|
+
.then(this.getClientInstance().responseHandler({
|
|
141
|
+
200: {
|
|
142
|
+
"application/json": "json",
|
|
143
|
+
},
|
|
144
|
+
}))
|
|
145
|
+
.then(commonHttpClient.castResponse())
|
|
146
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.findSourcesForTarget.response"))
|
|
147
|
+
.then(commonHttpClient.getBody);
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* Returns all target entities that have a particular relationship to the
|
|
151
|
+
* source entity. Note, relationships are one way.
|
|
152
|
+
*
|
|
153
|
+
* For example, the following method finds all content that the current user
|
|
154
|
+
* has an 'ignore' relationship with:
|
|
155
|
+
* `GET /wiki/rest/api/relation/ignore/from/user/current/to/content`
|
|
156
|
+
* Note, 'ignore' is an example custom relationship type.
|
|
157
|
+
*
|
|
158
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
159
|
+
* Permission to view both the target entity and source entity.
|
|
160
|
+
*
|
|
161
|
+
* @returns Returned if the requested relationships are returned.
|
|
162
|
+
* @path {GET}
|
|
163
|
+
* /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}
|
|
164
|
+
* @scopes-current read:confluence-content.summary
|
|
165
|
+
* @scopes-beta read:relation:confluence, read:content-details:confluence
|
|
166
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-get
|
|
167
|
+
*/
|
|
168
|
+
this.findTargetFromSource = ({ relationName, sourceType, sourceKey, targetType, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, start, limit, }) => {
|
|
169
|
+
return this.getClientInstance()
|
|
170
|
+
.request({
|
|
171
|
+
path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}",
|
|
172
|
+
method: "GET",
|
|
173
|
+
pathParams: {
|
|
174
|
+
relationName,
|
|
175
|
+
sourceType,
|
|
176
|
+
sourceKey,
|
|
177
|
+
targetType,
|
|
178
|
+
},
|
|
179
|
+
query: {
|
|
180
|
+
sourceStatus,
|
|
181
|
+
targetStatus,
|
|
182
|
+
sourceVersion,
|
|
183
|
+
targetVersion,
|
|
184
|
+
expand,
|
|
185
|
+
start,
|
|
186
|
+
limit,
|
|
187
|
+
},
|
|
188
|
+
})
|
|
189
|
+
.then(this.getClientInstance().responseHandler({
|
|
190
|
+
200: {
|
|
191
|
+
"application/json": "json",
|
|
192
|
+
},
|
|
193
|
+
}))
|
|
194
|
+
.then(commonHttpClient.castResponse())
|
|
195
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.findTargetFromSource.response"))
|
|
196
|
+
.then(commonHttpClient.getBody);
|
|
197
|
+
};
|
|
198
|
+
/**
|
|
199
|
+
* Find whether a particular type of relationship exists from a source
|
|
200
|
+
* entity to a target entity. Note, relationships are one way.
|
|
201
|
+
*
|
|
202
|
+
* For example, you can use this method to find whether the current user has
|
|
203
|
+
* selected a particular page as a favorite (i.e. 'save for later'):
|
|
204
|
+
* `GET /wiki/rest/api/relation/favourite/from/user/current/to/content/123`
|
|
205
|
+
*
|
|
206
|
+
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
207
|
+
* Permission to view both the target entity and source entity.
|
|
208
|
+
*
|
|
209
|
+
* @returns Returned if the relationship exists.
|
|
210
|
+
* @path {GET}
|
|
211
|
+
* /wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}
|
|
212
|
+
* @scopes-current read:confluence-content.summary
|
|
213
|
+
* @scopes-beta read:relation:confluence, read:content-details:confluence
|
|
214
|
+
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-relation#api-wiki-rest-api-relation-relationname-from-sourcetype-sourcekey-to-targettype-targetkey-get
|
|
215
|
+
*/
|
|
216
|
+
this.getRelationship = ({ relationName, sourceType, sourceKey, targetType, targetKey, sourceStatus, targetStatus, sourceVersion, targetVersion, expand, }) => {
|
|
217
|
+
return this.getClientInstance()
|
|
218
|
+
.request({
|
|
219
|
+
path: "/wiki/rest/api/relation/{relationName}/from/{sourceType}/{sourceKey}/to/{targetType}/{targetKey}",
|
|
220
|
+
method: "GET",
|
|
221
|
+
pathParams: {
|
|
222
|
+
relationName,
|
|
223
|
+
sourceType,
|
|
224
|
+
sourceKey,
|
|
225
|
+
targetType,
|
|
226
|
+
targetKey,
|
|
227
|
+
},
|
|
228
|
+
query: {
|
|
229
|
+
sourceStatus,
|
|
230
|
+
targetStatus,
|
|
231
|
+
sourceVersion,
|
|
232
|
+
targetVersion,
|
|
233
|
+
expand,
|
|
234
|
+
},
|
|
235
|
+
})
|
|
236
|
+
.then(this.getClientInstance().responseHandler({
|
|
237
|
+
200: {
|
|
238
|
+
"application/json": "json",
|
|
239
|
+
},
|
|
240
|
+
}))
|
|
241
|
+
.then(commonHttpClient.castResponse())
|
|
242
|
+
.then(validationSchemaStorage_1.validationSchemaStorage.validator("RelationService.getRelationship.response"))
|
|
243
|
+
.then(commonHttpClient.getBody);
|
|
244
|
+
};
|
|
242
245
|
}
|
|
243
246
|
static initialize() {
|
|
244
247
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("RelationService.findTargetFromSource.response", zod_1.z
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RelationService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/RelationService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAI4B;AAC5B,wEAAqE;AACrE,uFAAuF;AACvF,MAAa,eAAgB,SAAQ,qCAAiB;
|
|
1
|
+
{"version":3,"file":"RelationService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/RelationService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,6DAA6D;AAC7D,iEAA8D;AAC9D,iDAI4B;AAC5B,wEAAqE;AACrE,uFAAuF;AACvF,MAAa,eAAgB,SAAQ,qCAAiB;IAAtD;;QACE;;;;;;;;;;;;;;;;;;;WAmBG;QACH,uBAAkB,GAAG,CAAC,EACpB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,GAwDd,EAAqB,EAAE;YACtB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,kGAAkG;gBACxG,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,YAAY;oBACZ,UAAU;oBACV,SAAS;oBACT,UAAU;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,YAAY;oBACZ,YAAY;oBACZ,aAAa;oBACb,aAAa;iBACd;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,6CAA6C,CAC9C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;WAcG;QACH,uBAAkB,GAAG,CAAC,EACpB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,GAoDd,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,kGAAkG;gBACxG,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,YAAY;oBACZ,UAAU;oBACV,SAAS;oBACT,UAAU;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,YAAY;oBACZ,YAAY;oBACZ,aAAa;oBACb,aAAa;iBACd;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;WAkBG;QACH,yBAAoB,GAAG,CAAC,EACtB,YAAY,EACZ,UAAU,EACV,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,MAAM,EACN,KAAK,EACL,KAAK,GAgEN,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,sFAAsF;gBAC5F,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,YAAY;oBACZ,UAAU;oBACV,UAAU;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,YAAY;oBACZ,YAAY;oBACZ,aAAa;oBACb,aAAa;oBACb,MAAM;oBACN,KAAK;oBACL,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,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;WAkBG;QACH,yBAAoB,GAAG,CAAC,EACtB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,MAAM,EACN,KAAK,EACL,KAAK,GAgEN,EAA0B,EAAE;YAC3B,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,sFAAsF;gBAC5F,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,YAAY;oBACZ,UAAU;oBACV,SAAS;oBACT,UAAU;iBACX;gBACD,KAAK,EAAE;oBACL,YAAY;oBACZ,YAAY;oBACZ,aAAa;oBACb,aAAa;oBACb,MAAM;oBACN,KAAK;oBACL,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,EAIzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,+CAA+C,CAChD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;WAiBG;QACH,oBAAe,GAAG,CAAC,EACjB,YAAY,EACZ,UAAU,EACV,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,YAAY,EACZ,aAAa,EACb,aAAa,EACb,MAAM,GA6EP,EAAqB,EAAE;YACtB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,kGAAkG;gBACxG,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,YAAY;oBACZ,UAAU;oBACV,SAAS;oBACT,UAAU;oBACV,SAAS;iBACV;gBACD,KAAK,EAAE;oBACL,YAAY;oBACZ,YAAY;oBACZ,aAAa;oBACb,aAAa;oBACb,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,CAC/B,0CAA0C,CAC3C,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IA4CJ,CAAC;IA3CC,MAAM,CAAC,UAAU;QACf,iDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,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,+CAA+C,CAAC,CAC7D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,0CAA0C,EAC1C,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,UAAU,CAAC;SAC/C,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CACxD,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,6CAA6C,EAC7C,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,UAAU,CAAC;SAC/C,CAAC;aACD,QAAQ,CAAC,6CAA6C,CAAC,CAC3D,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,+CAA+C,EAC/C,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,+CAA+C,CAAC,CAC7D,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC,CAAC,4CAAiC,CAAC,CAAC,CAAC;IAC5E,CAAC;CACF;AA5qBD,0CA4qBC"}
|
|
@@ -66,7 +66,7 @@ export declare class SearchService extends CommonHttpService {
|
|
|
66
66
|
* @scopes-beta read:content-details:confluence
|
|
67
67
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-get
|
|
68
68
|
*/
|
|
69
|
-
searchByCql({ cql, cqlcontext, cursor, next, prev, limit, start, includeArchivedSpaces, excludeCurrentSpaces, excerpt, sitePermissionTypeFilter, _, expand, }: {
|
|
69
|
+
searchByCql: ({ cql, cqlcontext, cursor, next, prev, limit, start, includeArchivedSpaces, excludeCurrentSpaces, excerpt, sitePermissionTypeFilter, _, expand, }: {
|
|
70
70
|
/**
|
|
71
71
|
* The CQL query to be used for the search. See
|
|
72
72
|
* [Advanced Searching using
|
|
@@ -86,36 +86,36 @@ export declare class SearchService extends CommonHttpService {
|
|
|
86
86
|
* Specify these values in an object. For example,
|
|
87
87
|
* `cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}`
|
|
88
88
|
*/
|
|
89
|
-
cqlcontext?: string;
|
|
89
|
+
cqlcontext?: string | undefined;
|
|
90
90
|
/**
|
|
91
91
|
* Pointer to a set of search results, returned as part of the `next` or `prev`
|
|
92
92
|
* URL from the previous search call.
|
|
93
93
|
*/
|
|
94
|
-
cursor?: string;
|
|
95
|
-
next?: boolean;
|
|
96
|
-
prev?: boolean;
|
|
94
|
+
cursor?: string | undefined;
|
|
95
|
+
next?: boolean | undefined;
|
|
96
|
+
prev?: boolean | undefined;
|
|
97
97
|
/**
|
|
98
98
|
* The maximum number of content objects to return per page.
|
|
99
99
|
* Note, this may be restricted by fixed system limits.
|
|
100
100
|
*/
|
|
101
|
-
limit?: number;
|
|
101
|
+
limit?: number | undefined;
|
|
102
102
|
/** The start point of the collection to return */
|
|
103
|
-
start?: number;
|
|
103
|
+
start?: number | undefined;
|
|
104
104
|
/** Whether to include content from archived spaces in the results. */
|
|
105
|
-
includeArchivedSpaces?: boolean;
|
|
105
|
+
includeArchivedSpaces?: boolean | undefined;
|
|
106
106
|
/** Whether to exclude current spaces and only show archived spaces. */
|
|
107
|
-
excludeCurrentSpaces?: boolean;
|
|
107
|
+
excludeCurrentSpaces?: boolean | undefined;
|
|
108
108
|
/** The excerpt strategy to apply to the result */
|
|
109
|
-
excerpt?: "
|
|
109
|
+
excerpt?: "none" | "highlight" | "indexed" | "highlight_unescaped" | "indexed_unescaped" | undefined;
|
|
110
110
|
/**
|
|
111
111
|
* Filters users by permission type. Use `none` to default to licensed users,
|
|
112
112
|
* `externalCollaborator`
|
|
113
113
|
* for external/guest users, and `all` to include all permission types.
|
|
114
114
|
*/
|
|
115
|
-
sitePermissionTypeFilter?: "all" | "
|
|
116
|
-
_?: number;
|
|
117
|
-
expand?: string[];
|
|
118
|
-
})
|
|
115
|
+
sitePermissionTypeFilter?: "all" | "none" | "externalCollaborator" | undefined;
|
|
116
|
+
_?: number | undefined;
|
|
117
|
+
expand?: string[] | undefined;
|
|
118
|
+
}) => Promise<SearchPageResponseSearchResult>;
|
|
119
119
|
/**
|
|
120
120
|
* Searches for users using user-specific queries from the
|
|
121
121
|
* [Confluence Query Language
|
|
@@ -134,7 +134,7 @@ export declare class SearchService extends CommonHttpService {
|
|
|
134
134
|
* @scopes-current read:content-details:confluence
|
|
135
135
|
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search#api-wiki-rest-api-search-user-get
|
|
136
136
|
*/
|
|
137
|
-
searchUser({ cql, start, limit, expand, sitePermissionTypeFilter, }: {
|
|
137
|
+
searchUser: ({ cql, start, limit, expand, sitePermissionTypeFilter, }: {
|
|
138
138
|
/**
|
|
139
139
|
* The CQL query to be used for the search. See
|
|
140
140
|
* [Advanced Searching using
|
|
@@ -153,12 +153,12 @@ export declare class SearchService extends CommonHttpService {
|
|
|
153
153
|
*/
|
|
154
154
|
cql: string;
|
|
155
155
|
/** The starting index of the returned users. */
|
|
156
|
-
start?: number;
|
|
156
|
+
start?: number | undefined;
|
|
157
157
|
/**
|
|
158
158
|
* The maximum number of user objects to return per page.
|
|
159
159
|
* Note, this may be restricted by fixed system limits.
|
|
160
160
|
*/
|
|
161
|
-
limit?: number;
|
|
161
|
+
limit?: number | undefined;
|
|
162
162
|
/**
|
|
163
163
|
* A multi-value parameter indicating which properties of the user to expand.
|
|
164
164
|
*
|
|
@@ -166,13 +166,13 @@ export declare class SearchService extends CommonHttpService {
|
|
|
166
166
|
* when setting permissions.
|
|
167
167
|
* - `personalSpace` returns the personal space of the user.
|
|
168
168
|
*/
|
|
169
|
-
expand?: string[];
|
|
169
|
+
expand?: string[] | undefined;
|
|
170
170
|
/**
|
|
171
171
|
* Filters users by permission type. Use `none` to default to licensed users,
|
|
172
172
|
* `externalCollaborator`
|
|
173
173
|
* for external/guest users, and `all` to include all permission types.
|
|
174
174
|
*/
|
|
175
|
-
sitePermissionTypeFilter?: "all" | "
|
|
176
|
-
})
|
|
175
|
+
sitePermissionTypeFilter?: "all" | "none" | "externalCollaborator" | undefined;
|
|
176
|
+
}) => Promise<SearchPageResponseSearchResult>;
|
|
177
177
|
static initialize(): void;
|
|
178
178
|
}
|