@wix/groups 1.0.26 → 1.0.28
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/build/cjs/src/social-groups-v2-group-request.http.d.ts +31 -10
- package/build/cjs/src/social-groups-v2-group-request.http.js +31 -10
- package/build/cjs/src/social-groups-v2-group-request.http.js.map +1 -1
- package/build/cjs/src/social-groups-v2-group-request.public.d.ts +4 -4
- package/build/cjs/src/social-groups-v2-group-request.public.js +2 -2
- package/build/cjs/src/social-groups-v2-group-request.public.js.map +1 -1
- package/build/cjs/src/social-groups-v2-group-request.universal.d.ts +142 -75
- package/build/cjs/src/social-groups-v2-group-request.universal.js +48 -18
- package/build/cjs/src/social-groups-v2-group-request.universal.js.map +1 -1
- package/build/cjs/src/social-groups-v2-group-role.universal.d.ts +2 -0
- package/build/cjs/src/social-groups-v2-group-role.universal.js +2 -0
- package/build/cjs/src/social-groups-v2-group-role.universal.js.map +1 -1
- package/build/es/src/social-groups-v2-group-request.http.d.ts +31 -10
- package/build/es/src/social-groups-v2-group-request.http.js +31 -10
- package/build/es/src/social-groups-v2-group-request.http.js.map +1 -1
- package/build/es/src/social-groups-v2-group-request.public.d.ts +4 -4
- package/build/es/src/social-groups-v2-group-request.public.js +2 -2
- package/build/es/src/social-groups-v2-group-request.public.js.map +1 -1
- package/build/es/src/social-groups-v2-group-request.universal.d.ts +142 -75
- package/build/es/src/social-groups-v2-group-request.universal.js +48 -18
- package/build/es/src/social-groups-v2-group-request.universal.js.map +1 -1
- package/build/es/src/social-groups-v2-group-role.universal.d.ts +2 -0
- package/build/es/src/social-groups-v2-group-role.universal.js +2 -0
- package/build/es/src/social-groups-v2-group-role.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,24 +1,45 @@
|
|
|
1
1
|
import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
2
2
|
import { ApproveGroupRequestsRequest, ApproveGroupRequestsResponse, ListGroupRequestsRequest, ListGroupRequestsResponse, QueryGroupRequestsRequest, QueryGroupRequestsResponse, RejectGroupRequestsRequest, RejectGroupRequestsResponse } from './social-groups-v2-group-request.types';
|
|
3
3
|
/**
|
|
4
|
-
* Approves
|
|
5
|
-
*
|
|
4
|
+
* Approves requests to create a group.
|
|
5
|
+
*
|
|
6
|
+
* The `approveGroupRequests()` function returns a Promise that resolves when a site member's request to create a group is approved. Only site admins can approve requests to create a group. When the request is approved, the new group is added to the Groups List page of your site.
|
|
7
|
+
*
|
|
8
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
6
9
|
*/
|
|
7
10
|
export declare function approveGroupRequests(payload: ApproveGroupRequestsRequest): RequestOptionsFactory<ApproveGroupRequestsResponse>;
|
|
8
11
|
/**
|
|
9
|
-
* Rejects
|
|
10
|
-
*
|
|
12
|
+
* Rejects a request to create a group.
|
|
13
|
+
*
|
|
14
|
+
* The `rejectGroupRequests()` function returns a Promise that resolves when a member's request to create a group is rejected. Only site admins can reject requests to create a group.
|
|
15
|
+
*
|
|
16
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
11
17
|
*/
|
|
12
18
|
export declare function rejectGroupRequests(payload: RejectGroupRequestsRequest): RequestOptionsFactory<RejectGroupRequestsResponse>;
|
|
13
|
-
/**
|
|
19
|
+
/**
|
|
20
|
+
* Lists requests to create a group.
|
|
21
|
+
*
|
|
22
|
+
* The `listGroupRequests()` function returns a Promise that resolves to a list of up to 1,000 create group requests on your site.
|
|
23
|
+
*
|
|
24
|
+
* Using the options parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.
|
|
25
|
+
*
|
|
26
|
+
* By default, the list is sorted by `_createdDate` in descending order. Only admins can see create group requests. Members can access their own create group requests in their site.
|
|
27
|
+
*
|
|
28
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
29
|
+
*
|
|
30
|
+
*/
|
|
14
31
|
export declare function listGroupRequests(payload: ListGroupRequestsRequest): RequestOptionsFactory<ListGroupRequestsResponse>;
|
|
15
32
|
/**
|
|
16
|
-
*
|
|
33
|
+
* Creates a query to retrieve a list of create requests.
|
|
34
|
+
*
|
|
35
|
+
* The `queryGroupRequests()` function builds a query to retrieve a list of all requests to create a group, and returns a [`GroupRequestsQueryBuilder`](#grouprequestsquerybuilder) object.
|
|
36
|
+
*
|
|
37
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#grouprequestsquerybuilder/find) function. You can refine the query by chaining `GroupRequestQueryBuilder` functions onto the query. `GroupRequestQueryBuilder` functions enable you to sort, filter, and control the results that `queryGroupRequests()` returns.
|
|
17
38
|
*
|
|
18
|
-
*
|
|
19
|
-
* - `
|
|
39
|
+
* `queryGorupRequests()` runs with these `GroupRequestsQueryBuilder` defaults, which you can override:
|
|
40
|
+
* - [`limit(1000)`](#grouprequestsquerybuilder/limit)
|
|
41
|
+
* - [`descending('_createdDate')`](#grouprequestsquerybuilder/descending)
|
|
20
42
|
*
|
|
21
|
-
*
|
|
22
|
-
* - `createdDate`
|
|
43
|
+
* The following `GroupRequestsQueryBuilder` functions are supported for `queryGroupRequests()`. For a full description of the `GroupRequests` object, see the object returned for the [`items`](#grouprequestsqueryresult/items) property in [`GroupRequestsQueryResult`](#grouprequestsqueryresult).
|
|
23
44
|
*/
|
|
24
45
|
export declare function queryGroupRequests(payload: QueryGroupRequestsRequest): RequestOptionsFactory<QueryGroupRequestsResponse>;
|
|
@@ -194,8 +194,11 @@ function resolveWixSocialGroupsApiV2GroupRequestsServiceUrl(opts) {
|
|
|
194
194
|
return (0, metro_runtime_2.resolveUrl)(Object.assign(opts, { domainToMappings }));
|
|
195
195
|
}
|
|
196
196
|
/**
|
|
197
|
-
* Approves
|
|
198
|
-
*
|
|
197
|
+
* Approves requests to create a group.
|
|
198
|
+
*
|
|
199
|
+
* The `approveGroupRequests()` function returns a Promise that resolves when a site member's request to create a group is approved. Only site admins can approve requests to create a group. When the request is approved, the new group is added to the Groups List page of your site.
|
|
200
|
+
*
|
|
201
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
199
202
|
*/
|
|
200
203
|
function approveGroupRequests(payload) {
|
|
201
204
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_approveGroupRequestsRequest, {});
|
|
@@ -228,8 +231,11 @@ function approveGroupRequests(payload) {
|
|
|
228
231
|
}
|
|
229
232
|
exports.approveGroupRequests = approveGroupRequests;
|
|
230
233
|
/**
|
|
231
|
-
* Rejects
|
|
232
|
-
*
|
|
234
|
+
* Rejects a request to create a group.
|
|
235
|
+
*
|
|
236
|
+
* The `rejectGroupRequests()` function returns a Promise that resolves when a member's request to create a group is rejected. Only site admins can reject requests to create a group.
|
|
237
|
+
*
|
|
238
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
233
239
|
*/
|
|
234
240
|
function rejectGroupRequests(payload) {
|
|
235
241
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_rejectGroupRequestsRequest, {});
|
|
@@ -261,7 +267,18 @@ function rejectGroupRequests(payload) {
|
|
|
261
267
|
return __rejectGroupRequests;
|
|
262
268
|
}
|
|
263
269
|
exports.rejectGroupRequests = rejectGroupRequests;
|
|
264
|
-
/**
|
|
270
|
+
/**
|
|
271
|
+
* Lists requests to create a group.
|
|
272
|
+
*
|
|
273
|
+
* The `listGroupRequests()` function returns a Promise that resolves to a list of up to 1,000 create group requests on your site.
|
|
274
|
+
*
|
|
275
|
+
* Using the options parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.
|
|
276
|
+
*
|
|
277
|
+
* By default, the list is sorted by `_createdDate` in descending order. Only admins can see create group requests. Members can access their own create group requests in their site.
|
|
278
|
+
*
|
|
279
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
280
|
+
*
|
|
281
|
+
*/
|
|
265
282
|
function listGroupRequests(payload) {
|
|
266
283
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listGroupRequestsRequest, {});
|
|
267
284
|
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_listGroupRequestsResponse, {
|
|
@@ -293,13 +310,17 @@ function listGroupRequests(payload) {
|
|
|
293
310
|
}
|
|
294
311
|
exports.listGroupRequests = listGroupRequests;
|
|
295
312
|
/**
|
|
296
|
-
*
|
|
313
|
+
* Creates a query to retrieve a list of create requests.
|
|
314
|
+
*
|
|
315
|
+
* The `queryGroupRequests()` function builds a query to retrieve a list of all requests to create a group, and returns a [`GroupRequestsQueryBuilder`](#grouprequestsquerybuilder) object.
|
|
316
|
+
*
|
|
317
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#grouprequestsquerybuilder/find) function. You can refine the query by chaining `GroupRequestQueryBuilder` functions onto the query. `GroupRequestQueryBuilder` functions enable you to sort, filter, and control the results that `queryGroupRequests()` returns.
|
|
297
318
|
*
|
|
298
|
-
*
|
|
299
|
-
* - `
|
|
319
|
+
* `queryGorupRequests()` runs with these `GroupRequestsQueryBuilder` defaults, which you can override:
|
|
320
|
+
* - [`limit(1000)`](#grouprequestsquerybuilder/limit)
|
|
321
|
+
* - [`descending('_createdDate')`](#grouprequestsquerybuilder/descending)
|
|
300
322
|
*
|
|
301
|
-
*
|
|
302
|
-
* - `createdDate`
|
|
323
|
+
* The following `GroupRequestsQueryBuilder` functions are supported for `queryGroupRequests()`. For a full description of the `GroupRequests` object, see the object returned for the [`items`](#grouprequestsqueryresult/items) property in [`GroupRequestsQueryResult`](#grouprequestsqueryresult).
|
|
303
324
|
*/
|
|
304
325
|
function queryGroupRequests(payload) {
|
|
305
326
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryGroupRequestsRequest, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"social-groups-v2-group-request.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-request.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAchD,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,6BAA6B,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AACxE,MAAM,WAAW,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;AAC3E,MAAM,MAAM,GAAG;IACb,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,kBAAkB,EAAE,2BAA2B;IAC/C,gBAAgB,EAAE,2BAA2B;IAC7C,OAAO,EAAE,eAAe;IACxB,UAAU,EAAE,aAAa;CAC1B,CAAC;AACF,MAAM,aAAa,GAAG;IACpB,YAAY,EAAE,uBAAuB;IACrC,kBAAkB,EAAE,uBAAuB;CAC5C,CAAC;AACF,MAAM,qBAAqB,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;AACzD,MAAM,aAAa,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC1C,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC;AACtE,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;AAC7C,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,2BAA2B,GAAG,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC;AACvE,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAEvE,SAAS,kDAAkD,CACzD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,yBAAyB,EAAE;YACzB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED
|
|
1
|
+
{"version":3,"file":"social-groups-v2-group-request.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-request.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAchD,MAAM,4BAA4B,GAAG,EAAE,CAAC;AACxC,MAAM,6BAA6B,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AACxE,MAAM,WAAW,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;AAC3E,MAAM,MAAM,GAAG;IACb,WAAW,EAAE,2BAA2B;IACxC,WAAW,EAAE,2BAA2B;IACxC,kBAAkB,EAAE,2BAA2B;IAC/C,gBAAgB,EAAE,2BAA2B;IAC7C,OAAO,EAAE,eAAe;IACxB,UAAU,EAAE,aAAa;CAC1B,CAAC;AACF,MAAM,aAAa,GAAG;IACpB,YAAY,EAAE,uBAAuB;IACrC,kBAAkB,EAAE,uBAAuB;CAC5C,CAAC;AACF,MAAM,qBAAqB,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;AACzD,MAAM,aAAa,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC1C,MAAM,yBAAyB,GAAG,EAAE,CAAC;AACrC,MAAM,0BAA0B,GAAG,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC;AACtE,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;AAC7C,MAAM,0BAA0B,GAAG,EAAE,CAAC;AACtC,MAAM,2BAA2B,GAAG,EAAE,aAAa,EAAE,eAAe,EAAE,CAAC;AACvE,MAAM,2BAA2B,GAAG,EAAE,CAAC;AACvC,MAAM,4BAA4B,GAAG,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AAEvE,SAAS,kDAAkD,CACzD,IAA8C;IAE9C,MAAM,gBAAgB,GAAG;QACvB,uBAAuB,EAAE;YACvB;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,EAAE;aACb;SACF;QACD,CAAC,EAAE;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,mBAAmB,EAAE;YACnB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,gBAAgB,EAAE;YAChB;gBACE,OAAO,EAAE,yBAAyB;gBAClC,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,sBAAsB,EAAE;YACtB;gBACE,OAAO,EAAE,oBAAoB;gBAC7B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,qBAAqB;gBAC9B,QAAQ,EAAE,MAAM;aACjB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;SACF;QACD,yBAAyB,EAAE;YACzB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,iBAAiB,EAAE;YACjB;gBACE,OAAO,EAAE,mBAAmB;gBAC5B,QAAQ,EAAE,KAAK;aAChB;SACF;QACD,oBAAoB,EAAE;YACpB;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,KAAK;aAChB;YACD;gBACE,OAAO,EAAE,wBAAwB;gBACjC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,uBAAuB;gBAChC,QAAQ,EAAE,SAAS;aACpB;YACD;gBACE,OAAO,EAAE,4BAA4B;gBACrC,QAAQ,EAAE,SAAS;aACpB;SACF;KACF,CAAC;IAEF,OAAO,IAAA,0BAAU,EAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,gBAAgB,EAAE,CAAC,CAAC,CAAC;AAC/D,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,oBAAoB,CAClC,OAAoC;IAEpC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,4BAA4B,EAC5B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,6BAA6B,EAAE;QACtE,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,aAAa;QACb,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,sBAAsB,CAAC,EAAE,IAAI,EAAO;QAC3C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,oCAAoC;YAChD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,oEAAoE;YACtE,GAAG,EAAE,kDAAkD,CAAC;gBACtD,SAAS,EAAE,4BAA4B;gBACvC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,sBAAsB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEzC,OAAO,sBAAsB,CAAC;AAChC,CAAC;AAtCD,oDAsCC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,OAAmC;IAEnC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,2BAA2B,EAC3B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,4BAA4B,EAAE;QACrE,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,aAAa;QACb,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,qBAAqB,CAAC,EAAE,IAAI,EAAO;QAC1C,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,oCAAoC;YAChD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,mEAAmE;YACrE,GAAG,EAAE,kDAAkD,CAAC;gBACtD,SAAS,EAAE,2BAA2B;gBACtC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qBAAqB,CAAC,OAAO,GAAG,OAAO,CAAC;IAExC,OAAO,qBAAqB,CAAC;AAC/B,CAAC;AAtCD,kDAsCC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAC/B,OAAiC;IAEjC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,yBAAyB,EACzB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,0BAA0B,EAAE;QACnE,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,aAAa;QACb,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,mBAAmB,CAAC,EAAE,IAAI,EAAO;QACxC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,oCAAoC;YAChD,MAAM,EAAE,KAAY;YACpB,SAAS,EACP,iEAAiE;YACnE,GAAG,EAAE,kDAAkD,CAAC;gBACtD,SAAS,EAAE,oBAAoB;gBAC/B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,MAAM,EAAE,IAAA,iCAAiB,EAAC,cAAc,CAAC;YACzC,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,mBAAmB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEtC,OAAO,mBAAmB,CAAC;AAC7B,CAAC;AAtCD,8CAsCC;AAED;;;;;;;;;;;;GAYG;AACH,SAAgB,kBAAkB,CAChC,OAAkC;IAElC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,0BAA0B,EAC1B,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,2BAA2B,EAAE;QACpE,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,aAAa;QACb,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,oBAAoB,CAAC,EAAE,IAAI,EAAO;QACzC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,oCAAoC;YAChD,MAAM,EAAE,MAAa;YACrB,SAAS,EACP,kEAAkE;YACpE,GAAG,EAAE,kDAAkD,CAAC;gBACtD,SAAS,EAAE,0BAA0B;gBACrC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,oBAAoB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEvC,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAtCD,gDAsCC"}
|
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import {
|
|
2
|
+
import { Rejection, ListGroupRequestsOptions, QueryGroupRequestsOptions } from './social-groups-v2-group-request.universal';
|
|
3
3
|
export declare const __metadata: {
|
|
4
4
|
PACKAGE_NAME: string;
|
|
5
5
|
};
|
|
6
|
-
export declare function approveGroupRequests(httpClient: HttpClient): (
|
|
7
|
-
export declare function rejectGroupRequests(httpClient: HttpClient): (
|
|
6
|
+
export declare function approveGroupRequests(httpClient: HttpClient): (groupRequestIds: string[]) => Promise<import("./social-groups-v2-group-request.universal").ApproveGroupRequestsResponse>;
|
|
7
|
+
export declare function rejectGroupRequests(httpClient: HttpClient): (rejections: Rejection[]) => Promise<import("./social-groups-v2-group-request.universal").RejectGroupRequestsResponse>;
|
|
8
8
|
export declare function listGroupRequests(httpClient: HttpClient): (options?: ListGroupRequestsOptions | undefined) => Promise<import("./social-groups-v2-group-request.universal").ListGroupRequestsResponse>;
|
|
9
9
|
export declare function queryGroupRequests(httpClient: HttpClient): (options?: QueryGroupRequestsOptions | undefined) => import("./social-groups-v2-group-request.universal").GroupRequestsQueryBuilder;
|
|
10
10
|
export { Type, AllowPolicy, PrivacyStatus, IdentityType, RequestStatus, ItemsToUpdate, OwnershipFilter, SortOrder, } from './social-groups-v2-group-request.universal';
|
|
11
|
-
export { GroupRequest, Group, Events, Logo, GroupDetailsPosition, Image, Position, AccessRestriction, AccessRestrictionDataOneOf, GroupDetails, CoverImage, GroupSettings, Identity, RequestDetails, SubmitGroupRequestRequest, SubmitGroupRequestResponse, ApproveGroupRequestsRequest, ApproveGroupRequestsResponse, GroupRequestApproved, RejectGroupRequestsRequest, Rejection, RejectGroupRequestsResponse, GroupRequestRejected, CancelGroupRequestRequest, CancelGroupRequestResponse, ListGroupRequestsRequest, ListGroupRequestsResponse, PagingMetadata, QueryGroupRequestsRequest, Query, Sorting, Paging, QueryGroupRequestsResponse,
|
|
11
|
+
export { GroupRequest, Group, Events, Logo, GroupDetailsPosition, Image, Position, AccessRestriction, AccessRestrictionDataOneOf, GroupDetails, CoverImage, GroupSettings, Identity, RequestDetails, SubmitGroupRequestRequest, SubmitGroupRequestResponse, ApproveGroupRequestsRequest, ApproveGroupRequestsResponse, GroupRequestApproved, RejectGroupRequestsRequest, Rejection, RejectGroupRequestsResponse, GroupRequestRejected, CancelGroupRequestRequest, CancelGroupRequestResponse, ListGroupRequestsRequest, ListGroupRequestsResponse, PagingMetadata, QueryGroupRequestsRequest, Query, Sorting, Paging, QueryGroupRequestsResponse, ListGroupRequestsOptions, QueryGroupRequestsOptions, GroupRequestsQueryResult, GroupRequestsQueryBuilder, } from './social-groups-v2-group-request.universal';
|
|
@@ -4,13 +4,13 @@ exports.SortOrder = exports.OwnershipFilter = exports.ItemsToUpdate = exports.Re
|
|
|
4
4
|
const social_groups_v2_group_request_universal_1 = require("./social-groups-v2-group-request.universal");
|
|
5
5
|
exports.__metadata = { PACKAGE_NAME: '@wix/groups' };
|
|
6
6
|
function approveGroupRequests(httpClient) {
|
|
7
|
-
return (
|
|
7
|
+
return (groupRequestIds) => (0, social_groups_v2_group_request_universal_1.approveGroupRequests)(groupRequestIds,
|
|
8
8
|
// @ts-ignore
|
|
9
9
|
{ httpClient });
|
|
10
10
|
}
|
|
11
11
|
exports.approveGroupRequests = approveGroupRequests;
|
|
12
12
|
function rejectGroupRequests(httpClient) {
|
|
13
|
-
return (
|
|
13
|
+
return (rejections) => (0, social_groups_v2_group_request_universal_1.rejectGroupRequests)(rejections,
|
|
14
14
|
// @ts-ignore
|
|
15
15
|
{ httpClient });
|
|
16
16
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"social-groups-v2-group-request.public.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-request.public.ts"],"names":[],"mappings":";;;AACA,
|
|
1
|
+
{"version":3,"file":"social-groups-v2-group-request.public.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group-request.public.ts"],"names":[],"mappings":";;;AACA,yGAQoD;AAEvC,QAAA,UAAU,GAAG,EAAE,YAAY,EAAE,aAAa,EAAE,CAAC;AAE1D,SAAgB,oBAAoB,CAAC,UAAsB;IACzD,OAAO,CAAC,eAAyB,EAAE,EAAE,CACnC,IAAA,+DAA6B,EAC3B,eAAe;IACf,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,oDAOC;AAED,SAAgB,mBAAmB,CAAC,UAAsB;IACxD,OAAO,CAAC,UAAuB,EAAE,EAAE,CACjC,IAAA,8DAA4B,EAC1B,UAAU;IACV,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,kDAOC;AAED,SAAgB,iBAAiB,CAAC,UAAsB;IACtD,OAAO,CAAC,OAAkC,EAAE,EAAE,CAC5C,IAAA,4DAA0B,EACxB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,8CAOC;AAED,SAAgB,kBAAkB,CAAC,UAAsB;IACvD,OAAO,CAAC,OAAmC,EAAE,EAAE,CAC7C,IAAA,6DAA2B,EACzB,OAAO;IACP,aAAa;IACb,EAAE,UAAU,EAAE,CACf,CAAC;AACN,CAAC;AAPD,gDAOC;AAED,uGASoD;AARlD,gIAAA,IAAI,OAAA;AACJ,uIAAA,WAAW,OAAA;AACX,yIAAA,aAAa,OAAA;AACb,wIAAA,YAAY,OAAA;AACZ,yIAAA,aAAa,OAAA;AACb,yIAAA,aAAa,OAAA;AACb,2IAAA,eAAe,OAAA;AACf,qIAAA,SAAS,OAAA"}
|
|
@@ -14,21 +14,21 @@ export declare const __debug: {
|
|
|
14
14
|
*/
|
|
15
15
|
export interface GroupRequest {
|
|
16
16
|
/**
|
|
17
|
-
*
|
|
17
|
+
* ID of the request to create a group. Same as group ID.
|
|
18
18
|
* @readonly
|
|
19
19
|
*/
|
|
20
20
|
_id?: string | null;
|
|
21
|
-
/** Group requested
|
|
21
|
+
/** Group requested to create. */
|
|
22
22
|
group?: Group;
|
|
23
23
|
/**
|
|
24
|
-
* Status of
|
|
25
|
-
* - `PENDING` - Pending group request.
|
|
26
|
-
* - `APPROVED` - Approved group request.
|
|
27
|
-
* - `REJECTED` - Rejected group request.
|
|
28
|
-
* - `CANCELED` - Canceled group request.
|
|
24
|
+
* Status of the request to create a group. One of:
|
|
25
|
+
* - `"PENDING"` - Pending group request.
|
|
26
|
+
* - `"APPROVED"` - Approved group request.
|
|
27
|
+
* - `"REJECTED"` - Rejected group request.
|
|
28
|
+
* - `"CANCELED"` - Canceled group request.
|
|
29
29
|
*/
|
|
30
30
|
status?: RequestStatus;
|
|
31
|
-
/**
|
|
31
|
+
/** Details of request to create a group. */
|
|
32
32
|
requestDetails?: RequestDetails;
|
|
33
33
|
}
|
|
34
34
|
export interface Group {
|
|
@@ -37,78 +37,86 @@ export interface Group {
|
|
|
37
37
|
* @readonly
|
|
38
38
|
*/
|
|
39
39
|
_id?: string | null;
|
|
40
|
-
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
41
|
-
slug?: string | null;
|
|
42
40
|
/**
|
|
43
|
-
*
|
|
44
|
-
*
|
|
41
|
+
* Part of a group's URL.
|
|
42
|
+
*
|
|
43
|
+
* For example, `'https:/example.com/groups/{my-group-slug}'`. Generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `'https:/example.com/groups/{5D3yTX}'`. It is case-sensitive.
|
|
45
44
|
*/
|
|
45
|
+
slug?: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* @internal
|
|
48
|
+
* @internal */
|
|
46
49
|
privacyLevel?: PrivacyStatus;
|
|
47
50
|
/**
|
|
48
51
|
* Group privacy status.
|
|
49
|
-
* - `PUBLIC` -
|
|
50
|
-
* - `PRIVATE` -
|
|
51
|
-
* - `SECRET` - Only admins and members can see the group.
|
|
52
|
+
* - `"PUBLIC"` - Site visitors can see the group and its content in the list of groups. Members can join the group.
|
|
53
|
+
* - `"PRIVATE"` - Site visitors can see the group in the list of groups, but only site members can see its content. Members can request to join the group.
|
|
54
|
+
* - `"SECRET"` - Only admins and group members can see the group and its content in the list of groups. Members can only join a group if invited by group admins, or other group members.
|
|
52
55
|
*/
|
|
53
56
|
privacyStatus?: PrivacyStatus;
|
|
54
57
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
57
|
-
*/
|
|
58
|
+
* @interal
|
|
59
|
+
* @interal */
|
|
58
60
|
title?: string | null;
|
|
59
61
|
/** Group name. */
|
|
60
62
|
name?: string | null;
|
|
61
|
-
/** Group
|
|
63
|
+
/** Group Description. */
|
|
62
64
|
description?: string | null;
|
|
63
65
|
/** Group teaser. */
|
|
64
66
|
teaser?: string | null;
|
|
65
67
|
/**
|
|
66
|
-
*
|
|
67
|
-
*
|
|
68
|
-
* For `details.membersTitle`, `memberTitle` instead.
|
|
69
|
-
* This property will be removed on June 30, 2022.
|
|
70
|
-
*/
|
|
68
|
+
* @internal
|
|
69
|
+
* @internal */
|
|
71
70
|
details?: GroupDetails;
|
|
72
|
-
/**
|
|
71
|
+
/**
|
|
72
|
+
* What group members are called.
|
|
73
|
+
*
|
|
74
|
+
* For example, 'Coworkers', 'Friends', or 'Students'.
|
|
75
|
+
*/
|
|
73
76
|
memberTitle?: string | null;
|
|
74
|
-
/**
|
|
77
|
+
/**
|
|
78
|
+
* Group cover image. You cannot upload your own cover image.
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
75
81
|
coverImage?: CoverImage;
|
|
76
|
-
/** Group
|
|
82
|
+
/** Group settings. */
|
|
77
83
|
settings?: GroupSettings;
|
|
78
84
|
/**
|
|
79
|
-
* Total
|
|
85
|
+
* Total number of members in the group.
|
|
80
86
|
* @readonly
|
|
81
87
|
*/
|
|
82
88
|
membersCount?: number | null;
|
|
83
89
|
/**
|
|
84
|
-
*
|
|
85
|
-
*
|
|
90
|
+
* @internal
|
|
91
|
+
* @internal
|
|
86
92
|
* @readonly
|
|
87
93
|
*/
|
|
88
94
|
createdBy?: Identity;
|
|
89
95
|
/**
|
|
90
|
-
*
|
|
96
|
+
* Member ID of the group creator.
|
|
91
97
|
* @readonly
|
|
92
98
|
*/
|
|
93
99
|
ownerId?: string | null;
|
|
94
100
|
/**
|
|
95
|
-
*
|
|
101
|
+
* Date and time the group was created.
|
|
96
102
|
* @readonly
|
|
97
103
|
*/
|
|
98
104
|
_createdDate?: Date;
|
|
99
105
|
/**
|
|
100
|
-
* Date and time
|
|
106
|
+
* Date and time the group was last updated.
|
|
101
107
|
* @readonly
|
|
102
108
|
*/
|
|
103
109
|
_updatedDate?: Date;
|
|
104
110
|
/**
|
|
105
|
-
*
|
|
106
|
-
*
|
|
111
|
+
* @internal
|
|
112
|
+
* @internal
|
|
107
113
|
* @readonly
|
|
108
114
|
*/
|
|
109
115
|
recentActivityDate?: Date;
|
|
110
116
|
/**
|
|
111
|
-
* Date and time
|
|
117
|
+
* Date and time the group was last active.
|
|
118
|
+
*
|
|
119
|
+
* For example, a post or comment made in the group.
|
|
112
120
|
* @readonly
|
|
113
121
|
*/
|
|
114
122
|
lastActivityDate?: Date;
|
|
@@ -189,25 +197,38 @@ export interface CoverImage {
|
|
|
189
197
|
}
|
|
190
198
|
export interface GroupSettings {
|
|
191
199
|
/**
|
|
192
|
-
* Whether
|
|
193
|
-
*
|
|
200
|
+
* Whether group members can send an email inviting others to join the group. When `false`, only site admins and group admins can invite others to join the group.
|
|
201
|
+
*
|
|
202
|
+
* Default: `false`
|
|
194
203
|
*/
|
|
195
204
|
membersCanInvite?: boolean | null;
|
|
196
205
|
/**
|
|
197
|
-
* Whether
|
|
198
|
-
*
|
|
206
|
+
* Whether group members can approve or reject requests to join a group. When `false`, only site admins and group admins can approve or reject requests to join a group.
|
|
207
|
+
*
|
|
208
|
+
* Default: `false`
|
|
199
209
|
*/
|
|
200
210
|
membersCanApprove?: boolean | null;
|
|
201
211
|
/**
|
|
202
|
-
*
|
|
203
|
-
*
|
|
204
|
-
*/
|
|
212
|
+
* @internal
|
|
213
|
+
* @internal */
|
|
205
214
|
memberWelcomePostEnabled?: boolean | null;
|
|
206
|
-
/**
|
|
215
|
+
/**
|
|
216
|
+
* Whether to create a daily group post welcoming new members.
|
|
217
|
+
*
|
|
218
|
+
* Default: `true`
|
|
219
|
+
*/
|
|
207
220
|
welcomeMemberPostEnabled?: boolean | null;
|
|
208
|
-
/**
|
|
221
|
+
/**
|
|
222
|
+
* Whether to create an automatic group post when group details are changed.
|
|
223
|
+
*
|
|
224
|
+
* Default: `true`
|
|
225
|
+
*/
|
|
209
226
|
groupDetailsChangedPostEnabled?: boolean | null;
|
|
210
|
-
/**
|
|
227
|
+
/**
|
|
228
|
+
* Whether all group members can view the full list of group members.
|
|
229
|
+
*
|
|
230
|
+
* Default: `true`
|
|
231
|
+
*/
|
|
211
232
|
showMemberList?: boolean | null;
|
|
212
233
|
}
|
|
213
234
|
export interface Identity {
|
|
@@ -233,7 +254,7 @@ export declare enum RequestStatus {
|
|
|
233
254
|
CANCELED = "CANCELED"
|
|
234
255
|
}
|
|
235
256
|
export interface RequestDetails {
|
|
236
|
-
/** Reason the request
|
|
257
|
+
/** Reason the request to create a group is rejected. */
|
|
237
258
|
rejectionReason?: string | null;
|
|
238
259
|
}
|
|
239
260
|
export interface SubmitGroupRequestRequest {
|
|
@@ -245,7 +266,11 @@ export interface SubmitGroupRequestResponse {
|
|
|
245
266
|
groupRequest?: GroupRequest;
|
|
246
267
|
}
|
|
247
268
|
export interface ApproveGroupRequestsRequest {
|
|
248
|
-
/**
|
|
269
|
+
/**
|
|
270
|
+
* IDs of the requests create groups to approve.
|
|
271
|
+
*
|
|
272
|
+
* Max: 100 create group request IDs
|
|
273
|
+
*/
|
|
249
274
|
groupRequestIds?: string[];
|
|
250
275
|
}
|
|
251
276
|
export declare enum ItemsToUpdate {
|
|
@@ -255,7 +280,7 @@ export declare enum ItemsToUpdate {
|
|
|
255
280
|
ALL_ITEMS = "ALL_ITEMS"
|
|
256
281
|
}
|
|
257
282
|
export interface ApproveGroupRequestsResponse {
|
|
258
|
-
/** Approved
|
|
283
|
+
/** Approved request to create a group. */
|
|
259
284
|
groupRequest?: GroupRequest[];
|
|
260
285
|
}
|
|
261
286
|
export interface GroupRequestApproved {
|
|
@@ -267,9 +292,16 @@ export interface RejectGroupRequestsRequest {
|
|
|
267
292
|
rejections?: Rejection[];
|
|
268
293
|
}
|
|
269
294
|
export interface Rejection {
|
|
270
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* ID of the requests to create groups to reject.
|
|
297
|
+
*
|
|
298
|
+
*/
|
|
271
299
|
groupRequestId?: string;
|
|
272
|
-
/**
|
|
300
|
+
/**
|
|
301
|
+
* Reason the request to create a group is rejected. This text is displayed to the creator of the rejected request.
|
|
302
|
+
*
|
|
303
|
+
* Max: 1,000 characters.
|
|
304
|
+
*/
|
|
273
305
|
reason?: string | null;
|
|
274
306
|
}
|
|
275
307
|
export interface RejectGroupRequestsResponse {
|
|
@@ -301,8 +333,9 @@ export declare enum OwnershipFilter {
|
|
|
301
333
|
CURRENT_MEMBER = "CURRENT_MEMBER"
|
|
302
334
|
}
|
|
303
335
|
export interface ListGroupRequestsResponse {
|
|
304
|
-
/**
|
|
336
|
+
/** List of requests to create a group. */
|
|
305
337
|
groupRequests?: GroupRequest[];
|
|
338
|
+
/** Paging information. */
|
|
306
339
|
metadata?: PagingMetadata;
|
|
307
340
|
}
|
|
308
341
|
export interface PagingMetadata {
|
|
@@ -351,9 +384,16 @@ export declare enum SortOrder {
|
|
|
351
384
|
DESC = "DESC"
|
|
352
385
|
}
|
|
353
386
|
export interface Paging {
|
|
354
|
-
/**
|
|
387
|
+
/**
|
|
388
|
+
* Number of items to load.
|
|
389
|
+
*
|
|
390
|
+
* Max: `100`
|
|
391
|
+
*/
|
|
355
392
|
limit?: number | null;
|
|
356
|
-
/**
|
|
393
|
+
/**
|
|
394
|
+
* Number of items to skip in the current sort order.
|
|
395
|
+
*
|
|
396
|
+
*/
|
|
357
397
|
offset?: number | null;
|
|
358
398
|
}
|
|
359
399
|
export interface QueryGroupRequestsResponse {
|
|
@@ -362,53 +402,80 @@ export interface QueryGroupRequestsResponse {
|
|
|
362
402
|
metadata?: PagingMetadata;
|
|
363
403
|
}
|
|
364
404
|
/**
|
|
365
|
-
* Approves
|
|
366
|
-
*
|
|
405
|
+
* Approves requests to create a group.
|
|
406
|
+
*
|
|
407
|
+
* The `approveGroupRequests()` function returns a Promise that resolves when a site member's request to create a group is approved. Only site admins can approve requests to create a group. When the request is approved, the new group is added to the Groups List page of your site.
|
|
408
|
+
*
|
|
409
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
410
|
+
* @param groupRequestIds - IDs of the requests create groups to approve.
|
|
411
|
+
*
|
|
412
|
+
* Max: 100 create group request IDs
|
|
367
413
|
* @public
|
|
368
414
|
* @documentationMaturity preview
|
|
415
|
+
* @requiredField groupRequestIds
|
|
369
416
|
* @permissionScope Manage Social Groups
|
|
417
|
+
* @applicableIdentity APP
|
|
370
418
|
*/
|
|
371
|
-
export declare function approveGroupRequests(
|
|
372
|
-
export interface ApproveGroupRequestsOptions {
|
|
373
|
-
/** Group Request IDs to approve. Limited to `100`. */
|
|
374
|
-
groupRequestIds?: string[];
|
|
375
|
-
}
|
|
419
|
+
export declare function approveGroupRequests(groupRequestIds: string[]): Promise<ApproveGroupRequestsResponse>;
|
|
376
420
|
/**
|
|
377
|
-
* Rejects
|
|
378
|
-
*
|
|
421
|
+
* Rejects a request to create a group.
|
|
422
|
+
*
|
|
423
|
+
* The `rejectGroupRequests()` function returns a Promise that resolves when a member's request to create a group is rejected. Only site admins can reject requests to create a group.
|
|
424
|
+
*
|
|
425
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
426
|
+
* @param rejections - Rejection data.
|
|
379
427
|
* @public
|
|
380
428
|
* @documentationMaturity preview
|
|
429
|
+
* @requiredField rejections
|
|
381
430
|
* @permissionScope Manage Social Groups
|
|
431
|
+
* @applicableIdentity APP
|
|
382
432
|
*/
|
|
383
|
-
export declare function rejectGroupRequests(
|
|
384
|
-
export interface RejectGroupRequestsOptions {
|
|
385
|
-
/** Rejection data. */
|
|
386
|
-
rejections?: Rejection[];
|
|
387
|
-
}
|
|
433
|
+
export declare function rejectGroupRequests(rejections: Rejection[]): Promise<RejectGroupRequestsResponse>;
|
|
388
434
|
/**
|
|
389
|
-
* Lists
|
|
435
|
+
* Lists requests to create a group.
|
|
436
|
+
*
|
|
437
|
+
* The `listGroupRequests()` function returns a Promise that resolves to a list of up to 1,000 create group requests on your site.
|
|
438
|
+
*
|
|
439
|
+
* Using the options parameter, you can filter your list of posts, set the amount of posts to be returned, and sort your list in a specified order.
|
|
440
|
+
*
|
|
441
|
+
* By default, the list is sorted by `_createdDate` in descending order. Only admins can see create group requests. Members can access their own create group requests in their site.
|
|
442
|
+
*
|
|
443
|
+
* >**Note:** This function is only relevant if admin approval is required for creating a group.
|
|
444
|
+
*
|
|
390
445
|
* @public
|
|
391
446
|
* @documentationMaturity preview
|
|
447
|
+
* @param options - Paging options.
|
|
392
448
|
* @permissionScope Manage Social Groups
|
|
449
|
+
* @applicableIdentity APP
|
|
393
450
|
*/
|
|
394
451
|
export declare function listGroupRequests(options?: ListGroupRequestsOptions): Promise<ListGroupRequestsResponse>;
|
|
395
452
|
export interface ListGroupRequestsOptions {
|
|
396
|
-
/**
|
|
453
|
+
/**
|
|
454
|
+
* Number of items to load.
|
|
455
|
+
*
|
|
456
|
+
* Max: `100`
|
|
457
|
+
*
|
|
458
|
+
*/
|
|
397
459
|
limit?: number | null;
|
|
398
460
|
/** Number of items to skip in the current sort order. */
|
|
399
461
|
offset?: number | null;
|
|
400
462
|
}
|
|
401
463
|
/**
|
|
402
|
-
*
|
|
464
|
+
* Creates a query to retrieve a list of create requests.
|
|
465
|
+
*
|
|
466
|
+
* The `queryGroupRequests()` function builds a query to retrieve a list of all requests to create a group, and returns a [`GroupRequestsQueryBuilder`](#grouprequestsquerybuilder) object.
|
|
467
|
+
*
|
|
468
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#grouprequestsquerybuilder/find) function. You can refine the query by chaining `GroupRequestQueryBuilder` functions onto the query. `GroupRequestQueryBuilder` functions enable you to sort, filter, and control the results that `queryGroupRequests()` returns.
|
|
403
469
|
*
|
|
404
|
-
*
|
|
405
|
-
* - `
|
|
470
|
+
* `queryGorupRequests()` runs with these `GroupRequestsQueryBuilder` defaults, which you can override:
|
|
471
|
+
* - [`limit(1000)`](#grouprequestsquerybuilder/limit)
|
|
472
|
+
* - [`descending('_createdDate')`](#grouprequestsquerybuilder/descending)
|
|
406
473
|
*
|
|
407
|
-
*
|
|
408
|
-
* - `createdDate`
|
|
474
|
+
* The following `GroupRequestsQueryBuilder` functions are supported for `queryGroupRequests()`. For a full description of the `GroupRequests` object, see the object returned for the [`items`](#grouprequestsqueryresult/items) property in [`GroupRequestsQueryResult`](#grouprequestsqueryresult).
|
|
409
475
|
* @public
|
|
410
476
|
* @documentationMaturity preview
|
|
411
477
|
* @permissionScope Manage Social Groups
|
|
478
|
+
* @applicableIdentity APP
|
|
412
479
|
*/
|
|
413
480
|
export declare function queryGroupRequests(options?: QueryGroupRequestsOptions): GroupRequestsQueryBuilder;
|
|
414
481
|
export interface QueryGroupRequestsOptions {
|