@wix/groups 1.0.13 → 1.0.14
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.http.d.ts +55 -25
- package/build/cjs/src/social-groups-v2-group.http.js +55 -25
- package/build/cjs/src/social-groups-v2-group.http.js.map +1 -1
- package/build/cjs/src/social-groups-v2-group.universal.d.ts +74 -60
- package/build/cjs/src/social-groups-v2-group.universal.js +49 -25
- package/build/cjs/src/social-groups-v2-group.universal.js.map +1 -1
- package/build/es/src/social-groups-v2-group.http.d.ts +55 -25
- package/build/es/src/social-groups-v2-group.http.js +55 -25
- package/build/es/src/social-groups-v2-group.http.js.map +1 -1
- package/build/es/src/social-groups-v2-group.universal.d.ts +74 -60
- package/build/es/src/social-groups-v2-group.universal.js +49 -25
- package/build/es/src/social-groups-v2-group.universal.js.map +1 -1
- package/package.json +2 -2
|
@@ -2,45 +2,75 @@ import { RequestOptionsFactory } from '@wix/sdk-types';
|
|
|
2
2
|
import { CreateGroupRequest, CreateGroupResponse, DeleteGroupRequest, DeleteGroupResponse, GetGroupBySlugRequest, GetGroupBySlugResponse, GetGroupRequest, GetGroupResponse, ListGroupsRequest, ListGroupsResponse, QueryGroupsRequest, QueryGroupsResponse, UpdateGroupRequest, UpdateGroupResponse } from './social-groups-v2-group.types';
|
|
3
3
|
/**
|
|
4
4
|
* Creates a group.
|
|
5
|
-
*
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
*
|
|
5
|
+
*
|
|
6
|
+
*
|
|
7
|
+
* The `createGroup()` function returns a Promise that resolves to a newly-created group after it has successfully been created. The new group is added to the Groups List page of your site.
|
|
8
|
+
*
|
|
9
|
+
* Site admins can choose to allow site members to create a group. They can also require that site members request their approval when creating a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**. If set to admin approval required, a site member uses this function to create a group, and the group becomes a `createRequest` with a status of `PENDING` until the group is reviewed. The default is set to site members with admin approval.
|
|
10
|
+
*
|
|
11
|
+
* About the `owner` Parameter
|
|
12
|
+
*
|
|
13
|
+
* - The `owner` parameter in the `groupInfo` object is optional.
|
|
14
|
+
* - If the `owner` parameter is not specified, the value defaults to the site member ID of the creator of the group.
|
|
9
15
|
*/
|
|
10
16
|
export declare function createGroup(payload: CreateGroupRequest): RequestOptionsFactory<CreateGroupResponse>;
|
|
11
17
|
/**
|
|
12
18
|
* Updates a group.
|
|
13
|
-
*
|
|
14
|
-
*
|
|
15
|
-
*
|
|
16
|
-
*
|
|
19
|
+
*
|
|
20
|
+
*
|
|
21
|
+
* The `updateGroup()` function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
|
|
22
|
+
*
|
|
23
|
+
* > **Notes:**
|
|
24
|
+
*
|
|
25
|
+
* - When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.
|
|
26
|
+
* - When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.
|
|
27
|
+
* - When a public or private group's name is updated, the slug is updated to reflect the new group name.
|
|
17
28
|
*/
|
|
18
29
|
export declare function updateGroup(payload: UpdateGroupRequest): RequestOptionsFactory<UpdateGroupResponse>;
|
|
19
30
|
/**
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
*
|
|
24
|
-
*
|
|
25
|
-
* > + It is still possible to retrieve the group via the [Get Group](https://dev.wix.com/api/rest/wix-groups/groups/group/get-group), [List Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/list-groups) and [Query Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/query-groups) endpoints.
|
|
31
|
+
* Deletes a group.
|
|
32
|
+
*
|
|
33
|
+
*
|
|
34
|
+
* The `deleteGroup()` function returns a Promise resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard.
|
|
35
|
+
*
|
|
26
36
|
*/
|
|
27
37
|
export declare function deleteGroup(payload: DeleteGroupRequest): RequestOptionsFactory<DeleteGroupResponse>;
|
|
28
|
-
/**
|
|
38
|
+
/**
|
|
39
|
+
* Gets a group by ID.
|
|
40
|
+
*
|
|
41
|
+
*
|
|
42
|
+
* The `getGroup()` function returns a Promise that resolves to a group whose ID matches the given ID.
|
|
43
|
+
*
|
|
44
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
|
|
45
|
+
*/
|
|
29
46
|
export declare function getGroup(payload: GetGroupRequest): RequestOptionsFactory<GetGroupResponse>;
|
|
30
|
-
/**
|
|
47
|
+
/**
|
|
48
|
+
* Gets a group by slug.
|
|
49
|
+
*
|
|
50
|
+
*
|
|
51
|
+
* The `getGroupBySlug()` function returns a Promise that resolves to a group whose slug matches the given slug. The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `https:/example.com/groups/{5D3yTX}`.
|
|
52
|
+
*
|
|
53
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
|
|
54
|
+
*/
|
|
31
55
|
export declare function getGroupBySlug(payload: GetGroupBySlugRequest): RequestOptionsFactory<GetGroupBySlugResponse>;
|
|
32
|
-
/**
|
|
56
|
+
/**
|
|
57
|
+
* Lists groups.
|
|
58
|
+
*
|
|
59
|
+
*
|
|
60
|
+
* The `listGroups()` function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to `_createdDate` in descending order.
|
|
61
|
+
*
|
|
62
|
+
* > **Notes:**
|
|
63
|
+
*
|
|
64
|
+
* - For `SECRET` groups, only site admins, group admins, and group members can see a list of group and their content.
|
|
65
|
+
* - This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use `null` as a placeholder for any unspecified parameters. For example, to specify limit only, call `listGroups(paging, null)`.
|
|
66
|
+
*/
|
|
33
67
|
export declare function listGroups(payload: ListGroupsRequest): RequestOptionsFactory<ListGroupsResponse>;
|
|
34
68
|
/**
|
|
35
|
-
*
|
|
69
|
+
* Creates a query to retrieve a list of groups.
|
|
70
|
+
*
|
|
36
71
|
*
|
|
37
|
-
*
|
|
38
|
-
* - `title`
|
|
72
|
+
* Note: For `SECRET` groups, only site admins, group admins, and group members can query groups and their content.
|
|
39
73
|
*
|
|
40
|
-
*
|
|
41
|
-
* - `title`
|
|
42
|
-
* - `createdDate`
|
|
43
|
-
* - `membersCount`
|
|
44
|
-
* - `recentActivityDate`
|
|
74
|
+
* The `queryGroups()` function builds a query to retrieve a list of all groups, and returns a GroupsQueryBuilder object.
|
|
45
75
|
*/
|
|
46
76
|
export declare function queryGroups(payload: QueryGroupsRequest): RequestOptionsFactory<QueryGroupsResponse>;
|
|
@@ -200,10 +200,16 @@ function resolveWixSocialGroupsApiV2GroupsServiceUrl(opts) {
|
|
|
200
200
|
}
|
|
201
201
|
/**
|
|
202
202
|
* Creates a group.
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
206
|
-
*
|
|
203
|
+
*
|
|
204
|
+
*
|
|
205
|
+
* The `createGroup()` function returns a Promise that resolves to a newly-created group after it has successfully been created. The new group is added to the Groups List page of your site.
|
|
206
|
+
*
|
|
207
|
+
* Site admins can choose to allow site members to create a group. They can also require that site members request their approval when creating a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**. If set to admin approval required, a site member uses this function to create a group, and the group becomes a `createRequest` with a status of `PENDING` until the group is reviewed. The default is set to site members with admin approval.
|
|
208
|
+
*
|
|
209
|
+
* About the `owner` Parameter
|
|
210
|
+
*
|
|
211
|
+
* - The `owner` parameter in the `groupInfo` object is optional.
|
|
212
|
+
* - If the `owner` parameter is not specified, the value defaults to the site member ID of the creator of the group.
|
|
207
213
|
*/
|
|
208
214
|
function createGroup(payload) {
|
|
209
215
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_createGroupRequest, {
|
|
@@ -242,10 +248,15 @@ function createGroup(payload) {
|
|
|
242
248
|
exports.createGroup = createGroup;
|
|
243
249
|
/**
|
|
244
250
|
* Updates a group.
|
|
245
|
-
*
|
|
246
|
-
*
|
|
247
|
-
*
|
|
248
|
-
*
|
|
251
|
+
*
|
|
252
|
+
*
|
|
253
|
+
* The `updateGroup()` function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
|
|
254
|
+
*
|
|
255
|
+
* > **Notes:**
|
|
256
|
+
*
|
|
257
|
+
* - When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.
|
|
258
|
+
* - When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.
|
|
259
|
+
* - When a public or private group's name is updated, the slug is updated to reflect the new group name.
|
|
249
260
|
*/
|
|
250
261
|
function updateGroup(payload) {
|
|
251
262
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_updateGroupRequest, {
|
|
@@ -283,12 +294,11 @@ function updateGroup(payload) {
|
|
|
283
294
|
}
|
|
284
295
|
exports.updateGroup = updateGroup;
|
|
285
296
|
/**
|
|
286
|
-
*
|
|
287
|
-
*
|
|
288
|
-
*
|
|
289
|
-
*
|
|
290
|
-
*
|
|
291
|
-
* > + It is still possible to retrieve the group via the [Get Group](https://dev.wix.com/api/rest/wix-groups/groups/group/get-group), [List Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/list-groups) and [Query Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/query-groups) endpoints.
|
|
297
|
+
* Deletes a group.
|
|
298
|
+
*
|
|
299
|
+
*
|
|
300
|
+
* The `deleteGroup()` function returns a Promise resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard.
|
|
301
|
+
*
|
|
292
302
|
*/
|
|
293
303
|
function deleteGroup(payload) {
|
|
294
304
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_deleteGroupRequest, {});
|
|
@@ -319,7 +329,14 @@ function deleteGroup(payload) {
|
|
|
319
329
|
return __deleteGroup;
|
|
320
330
|
}
|
|
321
331
|
exports.deleteGroup = deleteGroup;
|
|
322
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Gets a group by ID.
|
|
334
|
+
*
|
|
335
|
+
*
|
|
336
|
+
* The `getGroup()` function returns a Promise that resolves to a group whose ID matches the given ID.
|
|
337
|
+
*
|
|
338
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
|
|
339
|
+
*/
|
|
323
340
|
function getGroup(payload) {
|
|
324
341
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getGroupRequest, {});
|
|
325
342
|
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getGroupResponse, {
|
|
@@ -349,7 +366,14 @@ function getGroup(payload) {
|
|
|
349
366
|
return __getGroup;
|
|
350
367
|
}
|
|
351
368
|
exports.getGroup = getGroup;
|
|
352
|
-
/**
|
|
369
|
+
/**
|
|
370
|
+
* Gets a group by slug.
|
|
371
|
+
*
|
|
372
|
+
*
|
|
373
|
+
* The `getGroupBySlug()` function returns a Promise that resolves to a group whose slug matches the given slug. The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `https:/example.com/groups/{5D3yTX}`.
|
|
374
|
+
*
|
|
375
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
|
|
376
|
+
*/
|
|
353
377
|
function getGroupBySlug(payload) {
|
|
354
378
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_getGroupBySlugRequest, {});
|
|
355
379
|
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_getGroupBySlugResponse, {
|
|
@@ -379,7 +403,17 @@ function getGroupBySlug(payload) {
|
|
|
379
403
|
return __getGroupBySlug;
|
|
380
404
|
}
|
|
381
405
|
exports.getGroupBySlug = getGroupBySlug;
|
|
382
|
-
/**
|
|
406
|
+
/**
|
|
407
|
+
* Lists groups.
|
|
408
|
+
*
|
|
409
|
+
*
|
|
410
|
+
* The `listGroups()` function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to `_createdDate` in descending order.
|
|
411
|
+
*
|
|
412
|
+
* > **Notes:**
|
|
413
|
+
*
|
|
414
|
+
* - For `SECRET` groups, only site admins, group admins, and group members can see a list of group and their content.
|
|
415
|
+
* - This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use `null` as a placeholder for any unspecified parameters. For example, to specify limit only, call `listGroups(paging, null)`.
|
|
416
|
+
*/
|
|
383
417
|
function listGroups(payload) {
|
|
384
418
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_listGroupsRequest, {});
|
|
385
419
|
const { fromJSON: fromRes } = (0, ambassador_1.serializer)(_listGroupsResponse, {
|
|
@@ -410,16 +444,12 @@ function listGroups(payload) {
|
|
|
410
444
|
}
|
|
411
445
|
exports.listGroups = listGroups;
|
|
412
446
|
/**
|
|
413
|
-
*
|
|
447
|
+
* Creates a query to retrieve a list of groups.
|
|
448
|
+
*
|
|
414
449
|
*
|
|
415
|
-
*
|
|
416
|
-
* - `title`
|
|
450
|
+
* Note: For `SECRET` groups, only site admins, group admins, and group members can query groups and their content.
|
|
417
451
|
*
|
|
418
|
-
*
|
|
419
|
-
* - `title`
|
|
420
|
-
* - `createdDate`
|
|
421
|
-
* - `membersCount`
|
|
422
|
-
* - `recentActivityDate`
|
|
452
|
+
* The `queryGroups()` function builds a query to retrieve a list of all groups, and returns a GroupsQueryBuilder object.
|
|
423
453
|
*/
|
|
424
454
|
function queryGroups(payload) {
|
|
425
455
|
const { toJSON: toReq, fromJSON: fromReq } = (0, ambassador_1.serializer)(_queryGroupsRequest, {});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"social-groups-v2-group.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAoBhD,MAAM,WAAW,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;AAC3E,MAAM,mBAAmB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAChD,MAAM,oBAAoB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACjD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACjD,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACpD,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,iBAAiB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC9C,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,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AACjD,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;AAC7C,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAClD,MAAM,mBAAmB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAChD,MAAM,oBAAoB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAEjD,SAAS,2CAA2C,CAClD,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.http.js","sourceRoot":"","sources":["../../../src/social-groups-v2-group.http.ts"],"names":[],"mappings":";;;AAAA,sDAAuD;AACvD,8DAA2D;AAC3D,sDAAgD;AAoBhD,MAAM,WAAW,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,CAAC;AAC3E,MAAM,mBAAmB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAChD,MAAM,oBAAoB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACjD,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACjD,MAAM,sBAAsB,GAAG,EAAE,CAAC;AAClC,MAAM,uBAAuB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AACpD,MAAM,gBAAgB,GAAG,EAAE,CAAC;AAC5B,MAAM,iBAAiB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAC9C,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,kBAAkB,GAAG,EAAE,CAAC;AAC9B,MAAM,mBAAmB,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AACjD,MAAM,SAAS,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC;AAC7C,MAAM,mBAAmB,GAAG,EAAE,CAAC;AAC/B,MAAM,oBAAoB,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC;AAClD,MAAM,mBAAmB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAChD,MAAM,oBAAoB,GAAG,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;AAEjD,SAAS,2CAA2C,CAClD,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;;;;;;;;;;;;GAYG;AACH,SAAgB,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE;QAC3E,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,oBAAoB,EAAE;QAC7D,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,GAAG,EAAE,2CAA2C,CAAC;gBAC/C,SAAS,EAAE,YAAY;gBACvB,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AAvCD,kCAuCC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE;QAC3E,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IACH,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,oBAAoB,EAAE;QAC7D,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,OAAc;YACtB,SAAS,EAAE,oDAAoD;YAC/D,GAAG,EAAE,2CAA2C,CAAC;gBAC/C,SAAS,EAAE,uBAAuB;gBAClC,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AAvCD,kCAuCC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,oBAAoB,EAAE;QAC7D,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,QAAe;YACvB,SAAS,EAAE,oDAAoD;YAC/D,GAAG,EAAE,2CAA2C,CAAC;gBAC/C,SAAS,EAAE,sBAAsB;gBACjC,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,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AApCD,kCAoCC;AAED;;;;;;;GAOG;AACH,SAAgB,QAAQ,CACtB,OAAwB;IAExB,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IAC9E,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,iBAAiB,EAAE;QAC1D,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,UAAU,CAAC,EAAE,IAAI,EAAO;QAC/B,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,iDAAiD;YAC5D,GAAG,EAAE,2CAA2C,CAAC;gBAC/C,SAAS,EAAE,sBAAsB;gBACjC,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,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAE7B,OAAO,UAAU,CAAC;AACpB,CAAC;AAjCD,4BAiCC;AAED;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC5B,OAA8B;IAE9B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,sBAAsB,EACtB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,uBAAuB,EAAE;QAChE,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,gBAAgB,CAAC,EAAE,IAAI,EAAO;QACrC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,uDAAuD;YAClE,GAAG,EAAE,2CAA2C,CAAC;gBAC/C,SAAS,EAAE,yBAAyB;gBACpC,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,gBAAgB,CAAC,OAAO,GAAG,OAAO,CAAC;IAEnC,OAAO,gBAAgB,CAAC;AAC1B,CAAC;AApCD,wCAoCC;AAED;;;;;;;;;;GAUG;AACH,SAAgB,UAAU,CACxB,OAA0B;IAE1B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,kBAAkB,EAClB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,mBAAmB,EAAE;QAC5D,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,YAAY,CAAC,EAAE,IAAI,EAAO;QACjC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,KAAY;YACpB,SAAS,EAAE,mDAAmD;YAC9D,GAAG,EAAE,2CAA2C,CAAC;gBAC/C,SAAS,EAAE,YAAY;gBACvB,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,YAAY,CAAC,OAAO,GAAG,OAAO,CAAC;IAE/B,OAAO,YAAY,CAAC;AACtB,CAAC;AApCD,gCAoCC;AAED;;;;;;;GAOG;AACH,SAAgB,WAAW,CACzB,OAA2B;IAE3B,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EACrD,mBAAmB,EACnB,EAAE,CACH,CAAC;IACF,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAA,uBAAU,EAAC,oBAAoB,EAAE;QAC7D,WAAW;QACX,MAAM;QACN,aAAa;QACb,qBAAqB;QACrB,SAAS;KACV,CAAC,CAAC;IAEH,SAAS,aAAa,CAAC,EAAE,IAAI,EAAO;QAClC,MAAM,cAAc,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;QACtC,MAAM,QAAQ,GAAG;YACf,UAAU,EAAE,4BAA4B;YACxC,MAAM,EAAE,MAAa;YACrB,SAAS,EAAE,oDAAoD;YAC/D,GAAG,EAAE,2CAA2C,CAAC;gBAC/C,SAAS,EAAE,kBAAkB;gBAC7B,IAAI,EAAE,cAAc;gBACpB,IAAI;aACL,CAAC;YACF,IAAI,EAAE,cAAc;YACpB,iBAAiB,EAAE,OAAO;SAC3B,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;IAEhC,OAAO,aAAa,CAAC;AACvB,CAAC;AApCD,kCAoCC"}
|
|
@@ -13,9 +13,8 @@ export interface Group {
|
|
|
13
13
|
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
14
14
|
slug?: string | null;
|
|
15
15
|
/**
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
*/
|
|
16
|
+
* @internal
|
|
17
|
+
* @internal */
|
|
19
18
|
privacyLevel?: PrivacyStatus;
|
|
20
19
|
/**
|
|
21
20
|
* Group privacy status.
|
|
@@ -25,9 +24,8 @@ export interface Group {
|
|
|
25
24
|
*/
|
|
26
25
|
privacyStatus?: PrivacyStatus;
|
|
27
26
|
/**
|
|
28
|
-
*
|
|
29
|
-
*
|
|
30
|
-
*/
|
|
27
|
+
* @internal
|
|
28
|
+
* @internal */
|
|
31
29
|
title?: string | null;
|
|
32
30
|
/** Group name. */
|
|
33
31
|
name?: string | null;
|
|
@@ -36,11 +34,8 @@ export interface Group {
|
|
|
36
34
|
/** Group teaser. */
|
|
37
35
|
teaser?: string | null;
|
|
38
36
|
/**
|
|
39
|
-
*
|
|
40
|
-
*
|
|
41
|
-
* For `details.membersTitle`, `memberTitle` instead.
|
|
42
|
-
* This property will be removed on June 30, 2022.
|
|
43
|
-
*/
|
|
37
|
+
* @internal
|
|
38
|
+
* @internal */
|
|
44
39
|
details?: GroupDetails;
|
|
45
40
|
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
46
41
|
memberTitle?: string | null;
|
|
@@ -54,8 +49,8 @@ export interface Group {
|
|
|
54
49
|
*/
|
|
55
50
|
membersCount?: number | null;
|
|
56
51
|
/**
|
|
57
|
-
*
|
|
58
|
-
*
|
|
52
|
+
* @internal
|
|
53
|
+
* @internal
|
|
59
54
|
* @readonly
|
|
60
55
|
*/
|
|
61
56
|
createdBy?: Identity;
|
|
@@ -75,8 +70,8 @@ export interface Group {
|
|
|
75
70
|
*/
|
|
76
71
|
_updatedDate?: Date;
|
|
77
72
|
/**
|
|
78
|
-
*
|
|
79
|
-
*
|
|
73
|
+
* @internal
|
|
74
|
+
* @internal
|
|
80
75
|
* @readonly
|
|
81
76
|
*/
|
|
82
77
|
recentActivityDate?: Date;
|
|
@@ -172,9 +167,8 @@ export interface GroupSettings {
|
|
|
172
167
|
*/
|
|
173
168
|
membersCanApprove?: boolean | null;
|
|
174
169
|
/**
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
*/
|
|
170
|
+
* @internal
|
|
171
|
+
* @internal */
|
|
178
172
|
memberWelcomePostEnabled?: boolean | null;
|
|
179
173
|
/** Whether a daily post about new members is enabled. */
|
|
180
174
|
welcomeMemberPostEnabled?: boolean | null;
|
|
@@ -195,7 +189,7 @@ export declare enum IdentityType {
|
|
|
195
189
|
export interface CreateGroupRequest {
|
|
196
190
|
/** Group to create. */
|
|
197
191
|
group?: Group;
|
|
198
|
-
/** ID of the member who created the group. This member will automatically become an admin.
|
|
192
|
+
/** ID of the member who created the group. This member will automatically become an admin. Required if permission elevation is used. */
|
|
199
193
|
creatorId?: string | null;
|
|
200
194
|
}
|
|
201
195
|
export interface CreateGroupResponse {
|
|
@@ -343,10 +337,16 @@ export interface QueryGroupsByMembershipResponse {
|
|
|
343
337
|
}
|
|
344
338
|
/**
|
|
345
339
|
* Creates a group.
|
|
346
|
-
*
|
|
347
|
-
*
|
|
348
|
-
*
|
|
349
|
-
*
|
|
340
|
+
*
|
|
341
|
+
*
|
|
342
|
+
* The `createGroup()` function returns a Promise that resolves to a newly-created group after it has successfully been created. The new group is added to the Groups List page of your site.
|
|
343
|
+
*
|
|
344
|
+
* Site admins can choose to allow site members to create a group. They can also require that site members request their approval when creating a group. This setting can be found in your site's Dashboard under **Groups Application > General Settings > Group Creation**. If set to admin approval required, a site member uses this function to create a group, and the group becomes a `createRequest` with a status of `PENDING` until the group is reviewed. The default is set to site members with admin approval.
|
|
345
|
+
*
|
|
346
|
+
* About the `owner` Parameter
|
|
347
|
+
*
|
|
348
|
+
* - The `owner` parameter in the `groupInfo` object is optional.
|
|
349
|
+
* - If the `owner` parameter is not specified, the value defaults to the site member ID of the creator of the group.
|
|
350
350
|
* @public
|
|
351
351
|
* @documentationMaturity preview
|
|
352
352
|
*/
|
|
@@ -354,15 +354,20 @@ export declare function createGroup(options?: CreateGroupOptions): Promise<Creat
|
|
|
354
354
|
export interface CreateGroupOptions {
|
|
355
355
|
/** Group to create. */
|
|
356
356
|
group?: Group;
|
|
357
|
-
/** ID of the member who created the group. This member will automatically become an admin.
|
|
357
|
+
/** ID of the member who created the group. This member will automatically become an admin. Required if permission elevation is used. */
|
|
358
358
|
creatorId?: string | null;
|
|
359
359
|
}
|
|
360
360
|
/**
|
|
361
361
|
* Updates a group.
|
|
362
|
-
*
|
|
363
|
-
*
|
|
364
|
-
*
|
|
365
|
-
*
|
|
362
|
+
*
|
|
363
|
+
*
|
|
364
|
+
* The `updateGroup()` function returns a Promise that resolves to the updated group. Only site admins and group admins can update their group. Only the fields in the groupInfo object parameter can be updated. Specify which fields to update. Unspecified fields remain the same.
|
|
365
|
+
*
|
|
366
|
+
* > **Notes:**
|
|
367
|
+
*
|
|
368
|
+
* - When a group's `privacyStatus` is updated from `PRIVATE` to `PUBLIC`, all pending join requests for that group are automatically approved.
|
|
369
|
+
* - When a group's `privacyStatus` is updated from `PRIVATE` to `SECRET`, all pending join requests for that group are automatically rejected.
|
|
370
|
+
* - When a public or private group's name is updated, the slug is updated to reflect the new group name.
|
|
366
371
|
* @param _id - Group ID.
|
|
367
372
|
* @public
|
|
368
373
|
* @documentationMaturity preview
|
|
@@ -370,6 +375,7 @@ export interface CreateGroupOptions {
|
|
|
370
375
|
*/
|
|
371
376
|
export declare function updateGroup(_id: string | null, options?: UpdateGroupOptions): Promise<UpdateGroupResponse>;
|
|
372
377
|
export interface UpdateGroupOptions {
|
|
378
|
+
/** Group information to update. */
|
|
373
379
|
group: {
|
|
374
380
|
/**
|
|
375
381
|
* Group ID.
|
|
@@ -379,9 +385,8 @@ export interface UpdateGroupOptions {
|
|
|
379
385
|
/** A unique part of a group's URL, for example `https:/example.com/groups/slug`. */
|
|
380
386
|
slug?: string | null;
|
|
381
387
|
/**
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
*/
|
|
388
|
+
* @internal
|
|
389
|
+
* @internal */
|
|
385
390
|
privacyLevel?: PrivacyStatus;
|
|
386
391
|
/**
|
|
387
392
|
* Group privacy status.
|
|
@@ -391,9 +396,8 @@ export interface UpdateGroupOptions {
|
|
|
391
396
|
*/
|
|
392
397
|
privacyStatus?: PrivacyStatus;
|
|
393
398
|
/**
|
|
394
|
-
*
|
|
395
|
-
*
|
|
396
|
-
*/
|
|
399
|
+
* @internal
|
|
400
|
+
* @internal */
|
|
397
401
|
title?: string | null;
|
|
398
402
|
/** Group name. */
|
|
399
403
|
name?: string | null;
|
|
@@ -402,11 +406,8 @@ export interface UpdateGroupOptions {
|
|
|
402
406
|
/** Group teaser. */
|
|
403
407
|
teaser?: string | null;
|
|
404
408
|
/**
|
|
405
|
-
*
|
|
406
|
-
*
|
|
407
|
-
* For `details.membersTitle`, `memberTitle` instead.
|
|
408
|
-
* This property will be removed on June 30, 2022.
|
|
409
|
-
*/
|
|
409
|
+
* @internal
|
|
410
|
+
* @internal */
|
|
410
411
|
details?: GroupDetails;
|
|
411
412
|
/** What group members are called, for example `Coworkers`, `Friends`, or `Students`. */
|
|
412
413
|
memberTitle?: string | null;
|
|
@@ -420,8 +421,8 @@ export interface UpdateGroupOptions {
|
|
|
420
421
|
*/
|
|
421
422
|
membersCount?: number | null;
|
|
422
423
|
/**
|
|
423
|
-
*
|
|
424
|
-
*
|
|
424
|
+
* @internal
|
|
425
|
+
* @internal
|
|
425
426
|
* @readonly
|
|
426
427
|
*/
|
|
427
428
|
createdBy?: Identity;
|
|
@@ -441,8 +442,8 @@ export interface UpdateGroupOptions {
|
|
|
441
442
|
*/
|
|
442
443
|
_updatedDate?: Date;
|
|
443
444
|
/**
|
|
444
|
-
*
|
|
445
|
-
*
|
|
445
|
+
* @internal
|
|
446
|
+
* @internal
|
|
446
447
|
* @readonly
|
|
447
448
|
*/
|
|
448
449
|
recentActivityDate?: Date;
|
|
@@ -454,12 +455,11 @@ export interface UpdateGroupOptions {
|
|
|
454
455
|
};
|
|
455
456
|
}
|
|
456
457
|
/**
|
|
457
|
-
*
|
|
458
|
-
*
|
|
459
|
-
*
|
|
460
|
-
*
|
|
461
|
-
*
|
|
462
|
-
* > + It is still possible to retrieve the group via the [Get Group](https://dev.wix.com/api/rest/wix-groups/groups/group/get-group), [List Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/list-groups) and [Query Groups](https://dev.wix.com/api/rest/wix-groups/groups/group/query-groups) endpoints.
|
|
458
|
+
* Deletes a group.
|
|
459
|
+
*
|
|
460
|
+
*
|
|
461
|
+
* The `deleteGroup()` function returns a Promise resolves to the deleted group after it has successfully been deleted. Only site admins and group admins can delete their group. After the group is deleted, it is removed from both your site and the site's Dashboard.
|
|
462
|
+
*
|
|
463
463
|
* @param groupId - ID of the group to delete.
|
|
464
464
|
* @public
|
|
465
465
|
* @documentationMaturity preview
|
|
@@ -467,7 +467,12 @@ export interface UpdateGroupOptions {
|
|
|
467
467
|
*/
|
|
468
468
|
export declare function deleteGroup(groupId: string): Promise<DeleteGroupResponse>;
|
|
469
469
|
/**
|
|
470
|
-
*
|
|
470
|
+
* Gets a group by ID.
|
|
471
|
+
*
|
|
472
|
+
*
|
|
473
|
+
* The `getGroup()` function returns a Promise that resolves to a group whose ID matches the given ID.
|
|
474
|
+
*
|
|
475
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
|
|
471
476
|
* @param groupId - ID of the group to retrieve.
|
|
472
477
|
* @public
|
|
473
478
|
* @documentationMaturity preview
|
|
@@ -475,7 +480,12 @@ export declare function deleteGroup(groupId: string): Promise<DeleteGroupRespons
|
|
|
475
480
|
*/
|
|
476
481
|
export declare function getGroup(groupId: string): Promise<GetGroupResponse>;
|
|
477
482
|
/**
|
|
478
|
-
*
|
|
483
|
+
* Gets a group by slug.
|
|
484
|
+
*
|
|
485
|
+
*
|
|
486
|
+
* The `getGroupBySlug()` function returns a Promise that resolves to a group whose slug matches the given slug. The slug is the end of a group's URL that refers to a specific group. For example, if a group's URL is `https:/example.com/groups/{my-fitness-group}`, the slug is `my-fitness-group`. The slug is case-sensitive. It is generally based on the group name, but for secret groups it is an autogenerated string of characters, for example, `https:/example.com/groups/{5D3yTX}`.
|
|
487
|
+
*
|
|
488
|
+
* > **Note:** For `SECRET` groups, only site admins, group admins, and group members can see a group and its content.
|
|
479
489
|
* @param slug - Unique part of the group's URL, for example `group-1` in `https:/example.com/groups/group-1`. Pass only the slug. Case-sensitive.
|
|
480
490
|
* @public
|
|
481
491
|
* @documentationMaturity preview
|
|
@@ -483,7 +493,15 @@ export declare function getGroup(groupId: string): Promise<GetGroupResponse>;
|
|
|
483
493
|
*/
|
|
484
494
|
export declare function getGroupBySlug(slug: string): Promise<GetGroupBySlugResponse>;
|
|
485
495
|
/**
|
|
486
|
-
*
|
|
496
|
+
* Lists groups.
|
|
497
|
+
*
|
|
498
|
+
*
|
|
499
|
+
* The `listGroups()` function returns a Promise that resolves to a list of up to 1,000 groups on your site. Sorts by default to `_createdDate` in descending order.
|
|
500
|
+
*
|
|
501
|
+
* > **Notes:**
|
|
502
|
+
*
|
|
503
|
+
* - For `SECRET` groups, only site admins, group admins, and group members can see a list of group and their content.
|
|
504
|
+
* - This function's parameters are positional, and must be specified in the sequence shown in the syntax below. When specifying a parameter, use `null` as a placeholder for any unspecified parameters. For example, to specify limit only, call `listGroups(paging, null)`.
|
|
487
505
|
* @public
|
|
488
506
|
* @documentationMaturity preview
|
|
489
507
|
*/
|
|
@@ -495,16 +513,12 @@ export interface ListGroupsOptions {
|
|
|
495
513
|
offset?: number | null;
|
|
496
514
|
}
|
|
497
515
|
/**
|
|
498
|
-
*
|
|
516
|
+
* Creates a query to retrieve a list of groups.
|
|
517
|
+
*
|
|
499
518
|
*
|
|
500
|
-
*
|
|
501
|
-
* - `title`
|
|
519
|
+
* Note: For `SECRET` groups, only site admins, group admins, and group members can query groups and their content.
|
|
502
520
|
*
|
|
503
|
-
*
|
|
504
|
-
* - `title`
|
|
505
|
-
* - `createdDate`
|
|
506
|
-
* - `membersCount`
|
|
507
|
-
* - `recentActivityDate`
|
|
521
|
+
* The `queryGroups()` function builds a query to retrieve a list of all groups, and returns a GroupsQueryBuilder object.
|
|
508
522
|
* @public
|
|
509
523
|
* @documentationMaturity preview
|
|
510
524
|
*/
|