@resolution/confluence-api-client 0.5.8 → 0.5.11
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 +16 -0
- package/lib/openapi/v1/models/audit.d.ts +7 -1
- package/lib/openapi/v1/models/audit.js +1 -0
- package/lib/openapi/v1/models/audit.js.map +1 -1
- package/lib/openapi/v1/models/common.d.ts +11 -3
- package/lib/openapi/v1/models/common.js +2 -1
- package/lib/openapi/v1/models/common.js.map +1 -1
- package/lib/openapi/v1/models/contentRestrictions.d.ts +1 -9
- package/lib/openapi/v1/models/contentRestrictions.js +0 -1
- package/lib/openapi/v1/models/contentRestrictions.js.map +1 -1
- package/lib/openapi/v1/models/contentWatches.d.ts +2 -1
- package/lib/openapi/v1/models/contentWatches.js +2 -1
- package/lib/openapi/v1/models/contentWatches.js.map +1 -1
- package/lib/openapi/v1/models/space.d.ts +1 -7
- package/lib/openapi/v1/models/space.js +0 -1
- package/lib/openapi/v1/models/space.js.map +1 -1
- package/lib/openapi/v1/models/spacePermissions.d.ts +1 -3
- package/lib/openapi/v1/models/spacePermissions.js.map +1 -1
- package/lib/openapi/v1/models/users.d.ts +6 -3
- package/lib/openapi/v1/models/users.js +1 -1
- package/lib/openapi/v1/models/users.js.map +1 -1
- package/lib/openapi/v1/services/ContentRestrictionsService.d.ts +0 -86
- package/lib/openapi/v1/services/ContentRestrictionsService.js +0 -98
- package/lib/openapi/v1/services/ContentRestrictionsService.js.map +1 -1
- package/lib/openapi/v1/services/GroupService.d.ts +2 -191
- package/lib/openapi/v1/services/GroupService.js +0 -248
- package/lib/openapi/v1/services/GroupService.js.map +1 -1
- package/lib/openapi/v1/services/UsersService.d.ts +6 -6
- package/lib/openapi/v2/services/LabelService.d.ts +6 -0
- package/lib/openapi/v2/services/LabelService.js +6 -0
- package/lib/openapi/v2/services/LabelService.js.map +1 -1
- package/lib/openapi/v2/services/SmartLinkService.d.ts +1 -6
- package/lib/openapi/v2/services/SmartLinkService.js +1 -4
- package/lib/openapi/v2/services/SmartLinkService.js.map +1 -1
- package/lib/openapi/v2/services/UserService.d.ts +1 -1
- package/package.json +3 -3
|
@@ -17,35 +17,6 @@ const validationSchemaStorage_1 = require("../validationSchemaStorage");
|
|
|
17
17
|
class ContentRestrictionsService extends CommonHttpService_1.CommonHttpService {
|
|
18
18
|
constructor() {
|
|
19
19
|
super(...arguments);
|
|
20
|
-
/**
|
|
21
|
-
* Deprecated, use [Add group to content restriction via
|
|
22
|
-
* groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-put).
|
|
23
|
-
* Adds a group to a content restriction. That is, grant read or update
|
|
24
|
-
* permission to the group for a piece of content.
|
|
25
|
-
*
|
|
26
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
27
|
-
* Permission to edit the content.
|
|
28
|
-
*
|
|
29
|
-
* @deprecated
|
|
30
|
-
* @path PUT `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}`
|
|
31
|
-
* @scopes-current write:confluence-content
|
|
32
|
-
* @scopes-beta write:content.restriction:confluence
|
|
33
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-group-groupname-put
|
|
34
|
-
* @param params
|
|
35
|
-
*/
|
|
36
|
-
this.addGroupToContentRestriction = ({ id, operationKey, groupName, }) => {
|
|
37
|
-
return this.getClientInstance()
|
|
38
|
-
.request({
|
|
39
|
-
path: "/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}",
|
|
40
|
-
method: "PUT",
|
|
41
|
-
pathParams: {
|
|
42
|
-
id,
|
|
43
|
-
operationKey,
|
|
44
|
-
groupName,
|
|
45
|
-
},
|
|
46
|
-
})
|
|
47
|
-
.then(commonHttpClient.discardResult);
|
|
48
|
-
};
|
|
49
20
|
/**
|
|
50
21
|
* Adds a group to a content restriction by Group Id. That is, grant read or update
|
|
51
22
|
* permission to the group for a piece of content.
|
|
@@ -189,46 +160,6 @@ class ContentRestrictionsService extends CommonHttpService_1.CommonHttpService {
|
|
|
189
160
|
.then(validationSchemaStorage_1.validationSchemaStorage.validator("ContentRestrictionsService.deleteRestrictions.response"))
|
|
190
161
|
.then(commonHttpClient.getBody);
|
|
191
162
|
};
|
|
192
|
-
/**
|
|
193
|
-
* Deprecated, use [Get content restriction status for group via
|
|
194
|
-
* groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-bygroupid-groupid-get).
|
|
195
|
-
* Returns whether the specified content restriction applies to a group.
|
|
196
|
-
* For example, if a page with `id=123` has a `read` restriction for the `admins`
|
|
197
|
-
* group,
|
|
198
|
-
* the following request will return `true`:
|
|
199
|
-
*
|
|
200
|
-
* `/wiki/rest/api/content/123/restriction/byOperation/read/group/admins`
|
|
201
|
-
*
|
|
202
|
-
* Note that a response of `true` does not guarantee that the group can view the
|
|
203
|
-
* page, as it does not account for
|
|
204
|
-
* account-inherited restrictions, space permissions, or even product access. For
|
|
205
|
-
* more
|
|
206
|
-
* information, see [Confluence
|
|
207
|
-
* permissions](https://confluence.atlassian.com/x/_AozKw).
|
|
208
|
-
*
|
|
209
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
210
|
-
* Permission to view the content.
|
|
211
|
-
*
|
|
212
|
-
* @deprecated
|
|
213
|
-
* @path GET `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}`
|
|
214
|
-
* @scopes-current read:confluence-content.all
|
|
215
|
-
* @scopes-beta read:content.restriction:confluence
|
|
216
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-group-groupname-get
|
|
217
|
-
* @param params
|
|
218
|
-
*/
|
|
219
|
-
this.getContentRestrictionStatusForGroup = ({ id, operationKey, groupName, }) => {
|
|
220
|
-
return this.getClientInstance()
|
|
221
|
-
.request({
|
|
222
|
-
path: "/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}",
|
|
223
|
-
method: "GET",
|
|
224
|
-
pathParams: {
|
|
225
|
-
id,
|
|
226
|
-
operationKey,
|
|
227
|
-
groupName,
|
|
228
|
-
},
|
|
229
|
-
})
|
|
230
|
-
.then(commonHttpClient.discardResult);
|
|
231
|
-
};
|
|
232
163
|
/**
|
|
233
164
|
* Returns whether the specified content restriction applies to a user.
|
|
234
165
|
* For example, if a page with `id=123` has a `read` restriction for a user with
|
|
@@ -466,35 +397,6 @@ class ContentRestrictionsService extends CommonHttpService_1.CommonHttpService {
|
|
|
466
397
|
})
|
|
467
398
|
.then(commonHttpClient.discardResult);
|
|
468
399
|
};
|
|
469
|
-
/**
|
|
470
|
-
* Deprecated, use [Remove group from content restriction by
|
|
471
|
-
* groupId](https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions/#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-user-delete).
|
|
472
|
-
* Removes a group from a content restriction. That is, remove read or update
|
|
473
|
-
* permission for the group for a piece of content.
|
|
474
|
-
*
|
|
475
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
476
|
-
* Permission to edit the content.
|
|
477
|
-
*
|
|
478
|
-
* @deprecated
|
|
479
|
-
* @path DELETE `/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}`
|
|
480
|
-
* @scopes-current write:confluence-content
|
|
481
|
-
* @scopes-beta write:content.restriction:confluence
|
|
482
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-content-restrictions#api-wiki-rest-api-content-id-restriction-byoperation-operationkey-group-groupname-delete
|
|
483
|
-
* @param params
|
|
484
|
-
*/
|
|
485
|
-
this.removeGroupFromContentRestrictionById = ({ id, operationKey, groupName, }) => {
|
|
486
|
-
return this.getClientInstance()
|
|
487
|
-
.request({
|
|
488
|
-
path: "/wiki/rest/api/content/{id}/restriction/byOperation/{operationKey}/group/{groupName}",
|
|
489
|
-
method: "DELETE",
|
|
490
|
-
pathParams: {
|
|
491
|
-
id,
|
|
492
|
-
operationKey,
|
|
493
|
-
groupName,
|
|
494
|
-
},
|
|
495
|
-
})
|
|
496
|
-
.then(commonHttpClient.discardResult);
|
|
497
|
-
};
|
|
498
400
|
/**
|
|
499
401
|
* Removes a group from a content restriction. That is, remove read or update
|
|
500
402
|
* permission for the group for a piece of content.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ContentRestrictionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentRestrictionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAG0B;AAC1B,uEAIuC;AACvC,wEAAqE;AACrE;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,qCAAiB;IAAjE;;QACE
|
|
1
|
+
{"version":3,"file":"ContentRestrictionsService.js","sourceRoot":"","sources":["../../../../src/openapi/v1/services/ContentRestrictionsService.ts"],"names":[],"mappings":";;;AAAA,eAAe;AACf,wDAAwD;AACxD,gDAAgD;AAChD,6BAAwB;AAExB,gEAAgE;AAChE,oEAAiE;AACjE,6CAG0B;AAC1B,uEAIuC;AACvC,wEAAqE;AACrE;;;GAGG;AACH,MAAa,0BAA2B,SAAQ,qCAAiB;IAAjE;;QACE;;;;;;;;;;;;WAYG;QACH,0CAAqC,GAAG,CAAC,EACvC,EAAE,EACF,YAAY,EACZ,OAAO,GAQR,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,wFAAwF;gBAC9F,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;oBACF,YAAY;oBACZ,OAAO;iBACR;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,oBAAe,GAAG,CAAC,EACjB,EAAE,EACF,MAAM,EACN,kCAAkC,GA0BnC,EAAoC,EAAE;YACrC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;iBACP;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;gBACD,IAAI,EAAE,kCAAkC;aACzC,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;;;;;;;;;;;;WAYG;QACH,gCAA2B,GAAG,CAAC,EAC7B,EAAE,EACF,YAAY,EACZ,GAAG,EACH,QAAQ,EACR,SAAS,GAkCV,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yEAAyE;gBAC/E,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;oBACF,YAAY;iBACb;gBACD,KAAK,EAAE;oBACL,GAAG;oBACH,QAAQ;oBACR,SAAS;iBACV;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,uBAAkB,GAAG,CAAC,EACpB,EAAE,EACF,MAAM,GAwBP,EAAoC,EAAE;YACrC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;iBACP;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;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,wDAAwD,CACzD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;;WAwBG;QACH,uCAAkC,GAAG,CAAC,EACpC,EAAE,EACF,YAAY,EACZ,GAAG,EACH,QAAQ,EACR,SAAS,GAkCV,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yEAAyE;gBAC/E,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;oBACF,YAAY;iBACb;gBACD,KAAK,EAAE;oBACL,GAAG;oBACH,QAAQ;oBACR,SAAS;iBACV;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;;;;;;;;;;;WAuBG;QACH,iDAA4C,GAAG,CAAC,EAC9C,EAAE,EACF,YAAY,EACZ,OAAO,GAWR,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,wFAAwF;gBAC9F,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;oBACF,YAAY;oBACZ,OAAO;iBACR;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,oBAAe,GAAG,CAAC,EACjB,EAAE,EACF,MAAM,EACN,KAAK,EACL,KAAK,GAiCN,EAAoC,EAAE;YACrC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;oBACL,KAAK;iBACN;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;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,qDAAqD,CACtD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;;;WAeG;QACH,+BAA0B,GAAG,CAAC,EAC5B,EAAE,EACF,MAAM,GAgBP,EAEE,EAAE;YACH,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,qDAAqD;gBAC3D,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;iBACP;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;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,EAMzB,CACL;iBACA,IAAI,CACH,iDAAuB,CAAC,SAAS,CAC/B,gEAAgE,CACjE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,gCAA2B,GAAG,CAAC,EAC7B,EAAE,EACF,YAAY,EACZ,MAAM,EACN,KAAK,EACL,KAAK,GA0BN,EAA+B,EAAE;YAChC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,oEAAoE;gBAC1E,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;oBACF,YAAY;iBACb;gBACD,KAAK,EAAE;oBACL,MAAM;oBACN,KAAK;oBACL,KAAK;iBACN;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;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,iEAAiE,CAClE,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,sCAAiC,GAAG,CAAC,EACnC,EAAE,EACF,YAAY,EACZ,OAAO,GAQR,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,wFAAwF;gBAC9F,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;oBACF,YAAY;oBACZ,OAAO;iBACR;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;WAYG;QACH,qCAAgC,GAAG,CAAC,EAClC,EAAE,EACF,YAAY,EACZ,GAAG,EACH,QAAQ,EACR,SAAS,GAkCV,EAAiB,EAAE;YAClB,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yEAAyE;gBAC/E,MAAM,EAAE,QAAQ;gBAChB,UAAU,EAAE;oBACV,EAAE;oBACF,YAAY;iBACb;gBACD,KAAK,EAAE;oBACL,GAAG;oBACH,QAAQ;oBACR,SAAS;iBACV;aACF,CAAC;iBACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,CAAC;QAC1C,CAAC,CAAC;QACF;;;;;;;;;;;;;WAaG;QACH,uBAAkB,GAAG,CAAC,EACpB,EAAE,EACF,MAAM,EACN,kCAAkC,GA0BnC,EAAoC,EAAE;YACrC,OAAO,IAAI,CAAC,iBAAiB,EAAE;iBAC5B,OAAO,CAAC;gBACP,IAAI,EAAE,yCAAyC;gBAC/C,MAAM,EAAE,KAAK;gBACb,UAAU,EAAE;oBACV,EAAE;iBACH;gBACD,KAAK,EAAE;oBACL,MAAM;iBACP;gBACD,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;iBACnC;gBACD,UAAU,EAAE;oBACV,KAAK,EAAE;wBACL,MAAM,EAAE;4BACN,OAAO,EAAE,KAAK;yBACf;qBACF;iBACF;gBACD,IAAI,EAAE,kCAAkC;aACzC,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,wDAAwD,CACzD,CACF;iBACA,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;QACpC,CAAC,CAAC;IAuEJ,CAAC;IAtEW,MAAM,CAAC,UAAU;QACzB,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,yBAAyB,CAAC;SAC9D,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,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,yBAAyB,CAAC;SAC9D,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,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,yBAAyB,CAAC;SAC9D,CAAC;aACD,QAAQ,CAAC,qDAAqD,CAAC,CACnE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,wDAAwD,EACxD,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,yBAAyB,CAAC;SAC9D,CAAC;aACD,QAAQ,CAAC,wDAAwD,CAAC,CACtE,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,gEAAgE,EAChE,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,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAC,CAAC,OAAO,EAAE,CAAC;SACzC,CAAC;aACD,QAAQ,CACP,gEAAgE,CACjE,CACJ,CAAC;QACF,iDAAuB,CAAC,kBAAkB,CACxC,iEAAiE,EACjE,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,oBAAoB,CAAC;SACzD,CAAC;aACD,QAAQ,CACP,iEAAiE,CAClE,CACJ,CAAC;QACF,iDAAuB,CAAC,YAAY,CAAC;YACnC,kEAA4C;YAC5C,wCAA+B;SAChC,CAAC,CAAC;IACL,CAAC;CACF;AA95BD,gEA85BC"}
|
|
@@ -30,24 +30,6 @@ export declare class GroupService extends CommonHttpService {
|
|
|
30
30
|
/** AccountId of the user who needs to be added as member. */
|
|
31
31
|
accountId: AccountId;
|
|
32
32
|
}) => Promise<void>;
|
|
33
|
-
/**
|
|
34
|
-
* Adds a user as a member in a group represented by its groupId
|
|
35
|
-
*
|
|
36
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
37
|
-
* User must be a site admin.
|
|
38
|
-
*
|
|
39
|
-
* @path POST `/wiki/rest/api/group/userByGroupId`
|
|
40
|
-
* @scopes-current write:confluence-groups
|
|
41
|
-
* @scopes-beta write:group:confluence
|
|
42
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-post
|
|
43
|
-
* @param params
|
|
44
|
-
*/
|
|
45
|
-
addUserToGroupByGroupId: ({ groupId, accountId, }: {
|
|
46
|
-
/** GroupId of the group whose membership is updated */
|
|
47
|
-
groupId: string;
|
|
48
|
-
/** AccountId of the user who needs to be added as member. */
|
|
49
|
-
accountId: AccountId;
|
|
50
|
-
}) => Promise<void>;
|
|
51
33
|
/**
|
|
52
34
|
* Creates a new user group.
|
|
53
35
|
*
|
|
@@ -82,73 +64,6 @@ export declare class GroupService extends CommonHttpService {
|
|
|
82
64
|
/** The id of the group. */
|
|
83
65
|
id: string;
|
|
84
66
|
}) => Promise<Group>;
|
|
85
|
-
/**
|
|
86
|
-
* Returns a user group for a given group name.
|
|
87
|
-
*
|
|
88
|
-
* Use updated Get group API
|
|
89
|
-
*
|
|
90
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
91
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
92
|
-
*
|
|
93
|
-
* @deprecated
|
|
94
|
-
* @returns Returned if the requested group is returned.
|
|
95
|
-
* @path GET `/wiki/rest/api/group/{groupName}`
|
|
96
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-groupname-get
|
|
97
|
-
* @param params
|
|
98
|
-
*/
|
|
99
|
-
getGroupByName: ({ groupName, }: {
|
|
100
|
-
/**
|
|
101
|
-
* The name of the group. This is the same as the group name shown in
|
|
102
|
-
* the Confluence administration console.
|
|
103
|
-
*/
|
|
104
|
-
groupName: string;
|
|
105
|
-
}) => Promise<Group>;
|
|
106
|
-
/**
|
|
107
|
-
* Returns a user group for a given group name.
|
|
108
|
-
*
|
|
109
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
110
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
111
|
-
*
|
|
112
|
-
* @deprecated
|
|
113
|
-
* @returns Returned if the requested group is returned.
|
|
114
|
-
* @path GET `/wiki/rest/api/group/by-name`
|
|
115
|
-
* @scopes-current read:confluence-groups
|
|
116
|
-
* @scopes-beta read:group:confluence
|
|
117
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-by-name-get
|
|
118
|
-
* @param params
|
|
119
|
-
*/
|
|
120
|
-
getGroupByQueryParam: ({ name, }: {
|
|
121
|
-
/**
|
|
122
|
-
* The name of the group. This is the same as the group name shown in
|
|
123
|
-
* the Confluence administration console.
|
|
124
|
-
*/
|
|
125
|
-
name: string;
|
|
126
|
-
}) => Promise<Group>;
|
|
127
|
-
/**
|
|
128
|
-
* Returns the users that are members of a group.
|
|
129
|
-
*
|
|
130
|
-
* Use updated Get group API
|
|
131
|
-
*
|
|
132
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
133
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
134
|
-
*
|
|
135
|
-
* @deprecated
|
|
136
|
-
* @returns Returned if the requested users are returned.
|
|
137
|
-
* @path GET `/wiki/rest/api/group/{groupName}/member`
|
|
138
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-groupname-member-get
|
|
139
|
-
* @param params
|
|
140
|
-
*/
|
|
141
|
-
getGroupMembers: ({ groupName, start, limit, }: {
|
|
142
|
-
/** The name of the group to be queried for its members. */
|
|
143
|
-
groupName: string;
|
|
144
|
-
/** The starting index of the returned users. */
|
|
145
|
-
start?: number | undefined;
|
|
146
|
-
/**
|
|
147
|
-
* The maximum number of users to return per page.
|
|
148
|
-
* Note, this may be restricted by fixed system limits.
|
|
149
|
-
*/
|
|
150
|
-
limit?: number | undefined;
|
|
151
|
-
}) => Promise<UserArray>;
|
|
152
67
|
/**
|
|
153
68
|
* Returns the users that are members of a group.
|
|
154
69
|
*
|
|
@@ -186,8 +101,8 @@ export declare class GroupService extends CommonHttpService {
|
|
|
186
101
|
*
|
|
187
102
|
* - `operations` returns the operations that the user is allowed to do.
|
|
188
103
|
* - `personalSpace` returns the user's personal space, if it exists.
|
|
189
|
-
* - `isExternalCollaborator`
|
|
190
|
-
*
|
|
104
|
+
* - `isExternalCollaborator`(@deprecated) see `isGuest` in response to find out
|
|
105
|
+
* whether the user is a guest.
|
|
191
106
|
*/
|
|
192
107
|
expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[] | undefined;
|
|
193
108
|
}) => Promise<UserArray>;
|
|
@@ -216,66 +131,6 @@ export declare class GroupService extends CommonHttpService {
|
|
|
216
131
|
/** The group permission level for which to filter results. */
|
|
217
132
|
accessType?: "user" | "admin" | "site-admin" | undefined;
|
|
218
133
|
}) => Promise<GroupArrayWithLinks>;
|
|
219
|
-
/**
|
|
220
|
-
* Returns the users that are members of a group.
|
|
221
|
-
*
|
|
222
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
223
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
224
|
-
*
|
|
225
|
-
* @deprecated
|
|
226
|
-
* @returns Returned if the requested users are returned.
|
|
227
|
-
* @path GET `/wiki/rest/api/group/member`
|
|
228
|
-
* @scopes-current read:confluence-groups
|
|
229
|
-
* @scopes-beta read:group:confluence, read:user:confluence
|
|
230
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-member-get
|
|
231
|
-
* @param params
|
|
232
|
-
*/
|
|
233
|
-
getMembersByQueryParam: ({ name, start, limit, shouldReturnTotalSize, expand, }: {
|
|
234
|
-
/** The name of the group to be queried for its members. */
|
|
235
|
-
name: string;
|
|
236
|
-
/** The starting index of the returned users. */
|
|
237
|
-
start?: number | undefined;
|
|
238
|
-
/**
|
|
239
|
-
* The maximum number of users to return per page.
|
|
240
|
-
* Note, this is restricted by fixed system limit of 200 which is to say if the
|
|
241
|
-
* limit parameter
|
|
242
|
-
* exceeds 200, this API will return a maximum of 200 users per page.
|
|
243
|
-
*/
|
|
244
|
-
limit?: number | undefined;
|
|
245
|
-
/**
|
|
246
|
-
* Whether to include total size parameter in the results.
|
|
247
|
-
* Note, fetching total size property is an expensive operation; use it if your
|
|
248
|
-
* use case needs this value.
|
|
249
|
-
*/
|
|
250
|
-
shouldReturnTotalSize?: boolean | undefined;
|
|
251
|
-
/**
|
|
252
|
-
* A multi-value parameter indicating which properties of the user to
|
|
253
|
-
* expand.
|
|
254
|
-
*
|
|
255
|
-
* - `operations` returns the operations that the user is allowed to do.
|
|
256
|
-
* - `personalSpace` returns the user's personal space, if it exists.
|
|
257
|
-
* - `isExternalCollaborator` returns whether the user is an external
|
|
258
|
-
* collaborator user.
|
|
259
|
-
*/
|
|
260
|
-
expand?: ("operations" | "isExternalCollaborator" | "personalSpace")[] | undefined;
|
|
261
|
-
}) => Promise<UserArray>;
|
|
262
|
-
/**
|
|
263
|
-
* Delete user group.
|
|
264
|
-
*
|
|
265
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
266
|
-
* User must be a site admin.
|
|
267
|
-
*
|
|
268
|
-
* @deprecated
|
|
269
|
-
* @path DELETE `/wiki/rest/api/group`
|
|
270
|
-
* @scopes-current write:confluence-groups
|
|
271
|
-
* @scopes-beta write:group:confluence
|
|
272
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-delete
|
|
273
|
-
* @param params
|
|
274
|
-
*/
|
|
275
|
-
removeGroup: ({ name, }: {
|
|
276
|
-
/** Name of the group to delete. */
|
|
277
|
-
name: string;
|
|
278
|
-
}) => Promise<void>;
|
|
279
134
|
/**
|
|
280
135
|
* Delete user group.
|
|
281
136
|
*
|
|
@@ -337,50 +192,6 @@ export declare class GroupService extends CommonHttpService {
|
|
|
337
192
|
*/
|
|
338
193
|
accountId?: string | undefined;
|
|
339
194
|
}) => Promise<void>;
|
|
340
|
-
/**
|
|
341
|
-
* Remove user as a member from a group.
|
|
342
|
-
*
|
|
343
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
344
|
-
* User must be a site admin.
|
|
345
|
-
*
|
|
346
|
-
* @path DELETE `/wiki/rest/api/group/userByGroupId`
|
|
347
|
-
* @scopes-current write:confluence-groups
|
|
348
|
-
* @scopes-beta write:group:confluence
|
|
349
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-delete
|
|
350
|
-
* @param params
|
|
351
|
-
*/
|
|
352
|
-
removeMemberFromGroupByGroupId: ({ groupId, key, username, accountId, }: {
|
|
353
|
-
/** Id of the group whose membership is updated. */
|
|
354
|
-
groupId: string;
|
|
355
|
-
/**
|
|
356
|
-
* This parameter is no longer available and will be removed from the
|
|
357
|
-
* documentation soon.
|
|
358
|
-
* Use `accountId` instead.
|
|
359
|
-
* See the [deprecation
|
|
360
|
-
* notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
|
|
361
|
-
* for details.
|
|
362
|
-
*
|
|
363
|
-
* @deprecated
|
|
364
|
-
*/
|
|
365
|
-
key?: string | undefined;
|
|
366
|
-
/**
|
|
367
|
-
* This parameter is no longer available and will be removed from the
|
|
368
|
-
* documentation soon.
|
|
369
|
-
* Use `accountId` instead.
|
|
370
|
-
* See the [deprecation
|
|
371
|
-
* notice](/cloud/confluence/deprecation-notice-user-privacy-api-migration-guide/)
|
|
372
|
-
* for details.
|
|
373
|
-
*
|
|
374
|
-
* @deprecated
|
|
375
|
-
*/
|
|
376
|
-
username?: string | undefined;
|
|
377
|
-
/**
|
|
378
|
-
* The account ID of the user. The accountId uniquely identifies the user across
|
|
379
|
-
* all Atlassian products.
|
|
380
|
-
* For example, `384093:32b4d9w0-f6a5-3535-11a3-9c8c88d10192`.
|
|
381
|
-
*/
|
|
382
|
-
accountId?: string | undefined;
|
|
383
|
-
}) => Promise<void>;
|
|
384
195
|
/**
|
|
385
196
|
* Get search results of groups by partial query provided.
|
|
386
197
|
*
|
|
@@ -49,33 +49,6 @@ class GroupService extends CommonHttpService_1.CommonHttpService {
|
|
|
49
49
|
})
|
|
50
50
|
.then(commonHttpClient.discardResult);
|
|
51
51
|
};
|
|
52
|
-
/**
|
|
53
|
-
* Adds a user as a member in a group represented by its groupId
|
|
54
|
-
*
|
|
55
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
56
|
-
* User must be a site admin.
|
|
57
|
-
*
|
|
58
|
-
* @path POST `/wiki/rest/api/group/userByGroupId`
|
|
59
|
-
* @scopes-current write:confluence-groups
|
|
60
|
-
* @scopes-beta write:group:confluence
|
|
61
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-post
|
|
62
|
-
* @param params
|
|
63
|
-
*/
|
|
64
|
-
this.addUserToGroupByGroupId = ({ groupId, accountId, }) => {
|
|
65
|
-
return this.getClientInstance()
|
|
66
|
-
.request({
|
|
67
|
-
path: "/wiki/rest/api/group/userByGroupId",
|
|
68
|
-
method: "POST",
|
|
69
|
-
query: {
|
|
70
|
-
groupId,
|
|
71
|
-
},
|
|
72
|
-
headers: {
|
|
73
|
-
"Content-Type": "application/json",
|
|
74
|
-
},
|
|
75
|
-
body: accountId,
|
|
76
|
-
})
|
|
77
|
-
.then(commonHttpClient.discardResult);
|
|
78
|
-
};
|
|
79
52
|
/**
|
|
80
53
|
* Creates a new user group.
|
|
81
54
|
*
|
|
@@ -139,106 +112,6 @@ class GroupService extends CommonHttpService_1.CommonHttpService {
|
|
|
139
112
|
.then(validationSchemaStorage_1.validationSchemaStorage.validator("GroupService.getGroupByGroupId.response"))
|
|
140
113
|
.then(commonHttpClient.getBody);
|
|
141
114
|
};
|
|
142
|
-
/**
|
|
143
|
-
* Returns a user group for a given group name.
|
|
144
|
-
*
|
|
145
|
-
* Use updated Get group API
|
|
146
|
-
*
|
|
147
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
148
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
149
|
-
*
|
|
150
|
-
* @deprecated
|
|
151
|
-
* @returns Returned if the requested group is returned.
|
|
152
|
-
* @path GET `/wiki/rest/api/group/{groupName}`
|
|
153
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-groupname-get
|
|
154
|
-
* @param params
|
|
155
|
-
*/
|
|
156
|
-
this.getGroupByName = ({ groupName, }) => {
|
|
157
|
-
return this.getClientInstance()
|
|
158
|
-
.request({
|
|
159
|
-
path: "/wiki/rest/api/group/{groupName}",
|
|
160
|
-
method: "GET",
|
|
161
|
-
pathParams: {
|
|
162
|
-
groupName,
|
|
163
|
-
},
|
|
164
|
-
})
|
|
165
|
-
.then(this.getClientInstance().responseHandler({
|
|
166
|
-
200: {
|
|
167
|
-
"application/json": "json",
|
|
168
|
-
},
|
|
169
|
-
}))
|
|
170
|
-
.then(commonHttpClient.castResponse())
|
|
171
|
-
.then(validationSchemaStorage_1.validationSchemaStorage.validator("GroupService.getGroupByName.response"))
|
|
172
|
-
.then(commonHttpClient.getBody);
|
|
173
|
-
};
|
|
174
|
-
/**
|
|
175
|
-
* Returns a user group for a given group name.
|
|
176
|
-
*
|
|
177
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
178
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
179
|
-
*
|
|
180
|
-
* @deprecated
|
|
181
|
-
* @returns Returned if the requested group is returned.
|
|
182
|
-
* @path GET `/wiki/rest/api/group/by-name`
|
|
183
|
-
* @scopes-current read:confluence-groups
|
|
184
|
-
* @scopes-beta read:group:confluence
|
|
185
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-by-name-get
|
|
186
|
-
* @param params
|
|
187
|
-
*/
|
|
188
|
-
this.getGroupByQueryParam = ({ name, }) => {
|
|
189
|
-
return this.getClientInstance()
|
|
190
|
-
.request({
|
|
191
|
-
path: "/wiki/rest/api/group/by-name",
|
|
192
|
-
method: "GET",
|
|
193
|
-
query: {
|
|
194
|
-
name,
|
|
195
|
-
},
|
|
196
|
-
})
|
|
197
|
-
.then(this.getClientInstance().responseHandler({
|
|
198
|
-
200: {
|
|
199
|
-
"application/json": "json",
|
|
200
|
-
},
|
|
201
|
-
}))
|
|
202
|
-
.then(commonHttpClient.castResponse())
|
|
203
|
-
.then(validationSchemaStorage_1.validationSchemaStorage.validator("GroupService.getGroupByQueryParam.response"))
|
|
204
|
-
.then(commonHttpClient.getBody);
|
|
205
|
-
};
|
|
206
|
-
/**
|
|
207
|
-
* Returns the users that are members of a group.
|
|
208
|
-
*
|
|
209
|
-
* Use updated Get group API
|
|
210
|
-
*
|
|
211
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
212
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
213
|
-
*
|
|
214
|
-
* @deprecated
|
|
215
|
-
* @returns Returned if the requested users are returned.
|
|
216
|
-
* @path GET `/wiki/rest/api/group/{groupName}/member`
|
|
217
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-groupname-member-get
|
|
218
|
-
* @param params
|
|
219
|
-
*/
|
|
220
|
-
this.getGroupMembers = ({ groupName, start, limit, }) => {
|
|
221
|
-
return this.getClientInstance()
|
|
222
|
-
.request({
|
|
223
|
-
path: "/wiki/rest/api/group/{groupName}/member",
|
|
224
|
-
method: "GET",
|
|
225
|
-
pathParams: {
|
|
226
|
-
groupName,
|
|
227
|
-
},
|
|
228
|
-
query: {
|
|
229
|
-
start,
|
|
230
|
-
limit,
|
|
231
|
-
},
|
|
232
|
-
})
|
|
233
|
-
.then(this.getClientInstance().responseHandler({
|
|
234
|
-
200: {
|
|
235
|
-
"application/json": "json",
|
|
236
|
-
},
|
|
237
|
-
}))
|
|
238
|
-
.then(commonHttpClient.castResponse())
|
|
239
|
-
.then(validationSchemaStorage_1.validationSchemaStorage.validator("GroupService.getGroupMembers.response"))
|
|
240
|
-
.then(commonHttpClient.getBody);
|
|
241
|
-
};
|
|
242
115
|
/**
|
|
243
116
|
* Returns the users that are members of a group.
|
|
244
117
|
*
|
|
@@ -319,73 +192,6 @@ class GroupService extends CommonHttpService_1.CommonHttpService {
|
|
|
319
192
|
.then(validationSchemaStorage_1.validationSchemaStorage.validator("GroupService.getGroups.response"))
|
|
320
193
|
.then(commonHttpClient.getBody);
|
|
321
194
|
};
|
|
322
|
-
/**
|
|
323
|
-
* Returns the users that are members of a group.
|
|
324
|
-
*
|
|
325
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
326
|
-
* Permission to access the Confluence site ('Can use' global permission).
|
|
327
|
-
*
|
|
328
|
-
* @deprecated
|
|
329
|
-
* @returns Returned if the requested users are returned.
|
|
330
|
-
* @path GET `/wiki/rest/api/group/member`
|
|
331
|
-
* @scopes-current read:confluence-groups
|
|
332
|
-
* @scopes-beta read:group:confluence, read:user:confluence
|
|
333
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-member-get
|
|
334
|
-
* @param params
|
|
335
|
-
*/
|
|
336
|
-
this.getMembersByQueryParam = ({ name, start, limit, shouldReturnTotalSize, expand, }) => {
|
|
337
|
-
return this.getClientInstance()
|
|
338
|
-
.request({
|
|
339
|
-
path: "/wiki/rest/api/group/member",
|
|
340
|
-
method: "GET",
|
|
341
|
-
query: {
|
|
342
|
-
name,
|
|
343
|
-
start,
|
|
344
|
-
limit,
|
|
345
|
-
shouldReturnTotalSize,
|
|
346
|
-
expand,
|
|
347
|
-
},
|
|
348
|
-
parameters: {
|
|
349
|
-
query: {
|
|
350
|
-
expand: {
|
|
351
|
-
explode: false,
|
|
352
|
-
},
|
|
353
|
-
},
|
|
354
|
-
},
|
|
355
|
-
})
|
|
356
|
-
.then(this.getClientInstance().responseHandler({
|
|
357
|
-
200: {
|
|
358
|
-
"application/json": "json",
|
|
359
|
-
},
|
|
360
|
-
}))
|
|
361
|
-
.then(commonHttpClient.castResponse())
|
|
362
|
-
.then(validationSchemaStorage_1.validationSchemaStorage.validator("GroupService.getMembersByQueryParam.response"))
|
|
363
|
-
.then(commonHttpClient.getBody);
|
|
364
|
-
};
|
|
365
|
-
/**
|
|
366
|
-
* Delete user group.
|
|
367
|
-
*
|
|
368
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
369
|
-
* User must be a site admin.
|
|
370
|
-
*
|
|
371
|
-
* @deprecated
|
|
372
|
-
* @path DELETE `/wiki/rest/api/group`
|
|
373
|
-
* @scopes-current write:confluence-groups
|
|
374
|
-
* @scopes-beta write:group:confluence
|
|
375
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-delete
|
|
376
|
-
* @param params
|
|
377
|
-
*/
|
|
378
|
-
this.removeGroup = ({ name, }) => {
|
|
379
|
-
return this.getClientInstance()
|
|
380
|
-
.request({
|
|
381
|
-
path: "/wiki/rest/api/group",
|
|
382
|
-
method: "DELETE",
|
|
383
|
-
query: {
|
|
384
|
-
name,
|
|
385
|
-
},
|
|
386
|
-
})
|
|
387
|
-
.then(commonHttpClient.discardResult);
|
|
388
|
-
};
|
|
389
195
|
/**
|
|
390
196
|
* Delete user group.
|
|
391
197
|
*
|
|
@@ -436,32 +242,6 @@ class GroupService extends CommonHttpService_1.CommonHttpService {
|
|
|
436
242
|
})
|
|
437
243
|
.then(commonHttpClient.discardResult);
|
|
438
244
|
};
|
|
439
|
-
/**
|
|
440
|
-
* Remove user as a member from a group.
|
|
441
|
-
*
|
|
442
|
-
* **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**:
|
|
443
|
-
* User must be a site admin.
|
|
444
|
-
*
|
|
445
|
-
* @path DELETE `/wiki/rest/api/group/userByGroupId`
|
|
446
|
-
* @scopes-current write:confluence-groups
|
|
447
|
-
* @scopes-beta write:group:confluence
|
|
448
|
-
* @see https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group#api-wiki-rest-api-group-userbygroupid-delete
|
|
449
|
-
* @param params
|
|
450
|
-
*/
|
|
451
|
-
this.removeMemberFromGroupByGroupId = ({ groupId, key, username, accountId, }) => {
|
|
452
|
-
return this.getClientInstance()
|
|
453
|
-
.request({
|
|
454
|
-
path: "/wiki/rest/api/group/userByGroupId",
|
|
455
|
-
method: "DELETE",
|
|
456
|
-
query: {
|
|
457
|
-
groupId,
|
|
458
|
-
key,
|
|
459
|
-
username,
|
|
460
|
-
accountId,
|
|
461
|
-
},
|
|
462
|
-
})
|
|
463
|
-
.then(commonHttpClient.discardResult);
|
|
464
|
-
};
|
|
465
245
|
/**
|
|
466
246
|
* Get search results of groups by partial query provided.
|
|
467
247
|
*
|
|
@@ -516,20 +296,6 @@ class GroupService extends CommonHttpService_1.CommonHttpService {
|
|
|
516
296
|
body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserArray"),
|
|
517
297
|
})
|
|
518
298
|
.describe("GroupService.getGroupMembersByGroupId.response"));
|
|
519
|
-
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupService.getGroupByName.response", zod_1.z
|
|
520
|
-
.object({
|
|
521
|
-
status: zod_1.z.literal(200),
|
|
522
|
-
mediaType: zod_1.z.literal("application/json"),
|
|
523
|
-
body: validationSchemaStorage_1.validationSchemaStorage.lazy("Group"),
|
|
524
|
-
})
|
|
525
|
-
.describe("GroupService.getGroupByName.response"));
|
|
526
|
-
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupService.getGroupMembers.response", zod_1.z
|
|
527
|
-
.object({
|
|
528
|
-
status: zod_1.z.literal(200),
|
|
529
|
-
mediaType: zod_1.z.literal("application/json"),
|
|
530
|
-
body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserArray"),
|
|
531
|
-
})
|
|
532
|
-
.describe("GroupService.getGroupMembers.response"));
|
|
533
299
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupService.getGroupByGroupId.response", zod_1.z
|
|
534
300
|
.object({
|
|
535
301
|
status: zod_1.z.literal(200),
|
|
@@ -537,20 +303,6 @@ class GroupService extends CommonHttpService_1.CommonHttpService {
|
|
|
537
303
|
body: validationSchemaStorage_1.validationSchemaStorage.lazy("Group"),
|
|
538
304
|
})
|
|
539
305
|
.describe("GroupService.getGroupByGroupId.response"));
|
|
540
|
-
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupService.getGroupByQueryParam.response", zod_1.z
|
|
541
|
-
.object({
|
|
542
|
-
status: zod_1.z.literal(200),
|
|
543
|
-
mediaType: zod_1.z.literal("application/json"),
|
|
544
|
-
body: validationSchemaStorage_1.validationSchemaStorage.lazy("Group"),
|
|
545
|
-
})
|
|
546
|
-
.describe("GroupService.getGroupByQueryParam.response"));
|
|
547
|
-
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupService.getMembersByQueryParam.response", zod_1.z
|
|
548
|
-
.object({
|
|
549
|
-
status: zod_1.z.literal(200),
|
|
550
|
-
mediaType: zod_1.z.literal("application/json"),
|
|
551
|
-
body: validationSchemaStorage_1.validationSchemaStorage.lazy("UserArray"),
|
|
552
|
-
})
|
|
553
|
-
.describe("GroupService.getMembersByQueryParam.response"));
|
|
554
306
|
validationSchemaStorage_1.validationSchemaStorage.registerExtensible("GroupService.searchGroups.response", zod_1.z
|
|
555
307
|
.object({
|
|
556
308
|
status: zod_1.z.literal(200),
|