@wix/groups 1.0.18 → 1.0.19
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-join-group-request.http.d.ts +11 -11
- package/build/cjs/src/social-groups-v2-join-group-request.http.js +11 -11
- package/build/cjs/src/social-groups-v2-join-group-request.universal.d.ts +11 -11
- package/build/cjs/src/social-groups-v2-join-group-request.universal.js +11 -11
- package/build/es/src/social-groups-v2-join-group-request.http.d.ts +11 -11
- package/build/es/src/social-groups-v2-join-group-request.http.js +11 -11
- package/build/es/src/social-groups-v2-join-group-request.universal.d.ts +11 -11
- package/build/es/src/social-groups-v2-join-group-request.universal.js +11 -11
- package/package.json +2 -2
|
@@ -5,7 +5,7 @@ import { ApproveJoinGroupRequestsRequest, ApproveJoinGroupRequestsResponse, List
|
|
|
5
5
|
*
|
|
6
6
|
* > **Note:** This function is only relevant for private groups.
|
|
7
7
|
*
|
|
8
|
-
* The `
|
|
8
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
9
9
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
10
10
|
*
|
|
11
11
|
* <!--
|
|
@@ -18,7 +18,7 @@ export declare function approveJoinGroupRequests(payload: ApproveJoinGroupReques
|
|
|
18
18
|
*
|
|
19
19
|
* > **Note:** This function is only relevant for private groups.
|
|
20
20
|
*
|
|
21
|
-
* The `
|
|
21
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
22
22
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
23
23
|
*
|
|
24
24
|
* <!--
|
|
@@ -32,7 +32,7 @@ export declare function rejectJoinGroupRequests(payload: RejectJoinGroupRequests
|
|
|
32
32
|
*
|
|
33
33
|
* > **Note:** This function is only relevant for private groups.
|
|
34
34
|
*
|
|
35
|
-
* The `
|
|
35
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
36
36
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
37
37
|
*
|
|
38
38
|
* > **Notes:**
|
|
@@ -46,22 +46,22 @@ export declare function listJoinGroupRequests(payload: ListJoinGroupRequestsRequ
|
|
|
46
46
|
* + This function is only relevant for private groups.
|
|
47
47
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
48
48
|
*
|
|
49
|
-
* The `
|
|
49
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
50
50
|
*
|
|
51
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
51
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
52
52
|
*
|
|
53
|
-
* You can refine the query by chaining `
|
|
53
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
54
54
|
*
|
|
55
|
-
* The results of the `
|
|
55
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
56
56
|
*
|
|
57
|
-
* `
|
|
58
|
-
* + [`limit(100)`](
|
|
57
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
58
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
59
59
|
*
|
|
60
|
-
* The following `
|
|
60
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
61
61
|
*
|
|
62
62
|
* | Property | Supported Filters & Sorting |
|
|
63
63
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
64
|
-
* | `status` | [`eq()`](
|
|
64
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
65
65
|
*
|
|
66
66
|
*/
|
|
67
67
|
export declare function queryJoinGroupRequests(payload: QueryJoinGroupRequestsRequest): RequestOptionsFactory<QueryJoinGroupRequestsResponse>;
|
|
@@ -191,7 +191,7 @@ function resolveWixSocialGroupsApiV2JoinGroupRequestsServiceUrl(opts) {
|
|
|
191
191
|
*
|
|
192
192
|
* > **Note:** This function is only relevant for private groups.
|
|
193
193
|
*
|
|
194
|
-
* The `
|
|
194
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
195
195
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
196
196
|
*
|
|
197
197
|
* <!--
|
|
@@ -228,7 +228,7 @@ exports.approveJoinGroupRequests = approveJoinGroupRequests;
|
|
|
228
228
|
*
|
|
229
229
|
* > **Note:** This function is only relevant for private groups.
|
|
230
230
|
*
|
|
231
|
-
* The `
|
|
231
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
232
232
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
233
233
|
*
|
|
234
234
|
* <!--
|
|
@@ -266,7 +266,7 @@ exports.rejectJoinGroupRequests = rejectJoinGroupRequests;
|
|
|
266
266
|
*
|
|
267
267
|
* > **Note:** This function is only relevant for private groups.
|
|
268
268
|
*
|
|
269
|
-
* The `
|
|
269
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
270
270
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
271
271
|
*
|
|
272
272
|
* > **Notes:**
|
|
@@ -304,22 +304,22 @@ exports.listJoinGroupRequests = listJoinGroupRequests;
|
|
|
304
304
|
* + This function is only relevant for private groups.
|
|
305
305
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
306
306
|
*
|
|
307
|
-
* The `
|
|
307
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
308
308
|
*
|
|
309
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
309
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
310
310
|
*
|
|
311
|
-
* You can refine the query by chaining `
|
|
311
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
312
312
|
*
|
|
313
|
-
* The results of the `
|
|
313
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
314
314
|
*
|
|
315
|
-
* `
|
|
316
|
-
* + [`limit(100)`](
|
|
315
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
316
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
317
317
|
*
|
|
318
|
-
* The following `
|
|
318
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
319
319
|
*
|
|
320
320
|
* | Property | Supported Filters & Sorting |
|
|
321
321
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
322
|
-
* | `status` | [`eq()`](
|
|
322
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
323
323
|
*
|
|
324
324
|
*/
|
|
325
325
|
function queryJoinGroupRequests(payload) {
|
|
@@ -271,7 +271,7 @@ export interface ListAllJoinGroupRequestsResponse {
|
|
|
271
271
|
*
|
|
272
272
|
* > **Note:** This function is only relevant for private groups.
|
|
273
273
|
*
|
|
274
|
-
* The `
|
|
274
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
275
275
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
276
276
|
*
|
|
277
277
|
* <!--
|
|
@@ -295,7 +295,7 @@ export interface ApproveJoinGroupRequestsOptions {
|
|
|
295
295
|
*
|
|
296
296
|
* > **Note:** This function is only relevant for private groups.
|
|
297
297
|
*
|
|
298
|
-
* The `
|
|
298
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
299
299
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
300
300
|
*
|
|
301
301
|
* <!--
|
|
@@ -314,7 +314,7 @@ export declare function rejectJoinGroupRequests(groupId: string, rejections: Rej
|
|
|
314
314
|
*
|
|
315
315
|
* > **Note:** This function is only relevant for private groups.
|
|
316
316
|
*
|
|
317
|
-
* The `
|
|
317
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
318
318
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
319
319
|
*
|
|
320
320
|
* > **Notes:**
|
|
@@ -335,22 +335,22 @@ export interface ListJoinGroupRequestsOptions {
|
|
|
335
335
|
* + This function is only relevant for private groups.
|
|
336
336
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
337
337
|
*
|
|
338
|
-
* The `
|
|
338
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
339
339
|
*
|
|
340
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
340
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
341
341
|
*
|
|
342
|
-
* You can refine the query by chaining `
|
|
342
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
343
343
|
*
|
|
344
|
-
* The results of the `
|
|
344
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
345
345
|
*
|
|
346
|
-
* `
|
|
347
|
-
* + [`limit(100)`](
|
|
346
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
347
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
348
348
|
*
|
|
349
|
-
* The following `
|
|
349
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
350
350
|
*
|
|
351
351
|
* | Property | Supported Filters & Sorting |
|
|
352
352
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
353
|
-
* | `status` | [`eq()`](
|
|
353
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
354
354
|
*
|
|
355
355
|
* @public
|
|
356
356
|
* @requiredField groupId
|
|
@@ -105,7 +105,7 @@ const _rejectJoinGroupRequestsResponse = {};
|
|
|
105
105
|
*
|
|
106
106
|
* > **Note:** This function is only relevant for private groups.
|
|
107
107
|
*
|
|
108
|
-
* The `
|
|
108
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
109
109
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
110
110
|
*
|
|
111
111
|
* <!--
|
|
@@ -172,7 +172,7 @@ exports.approveJoinGroupRequests = approveJoinGroupRequests;
|
|
|
172
172
|
*
|
|
173
173
|
* > **Note:** This function is only relevant for private groups.
|
|
174
174
|
*
|
|
175
|
-
* The `
|
|
175
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
176
176
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
177
177
|
*
|
|
178
178
|
* <!--
|
|
@@ -235,7 +235,7 @@ exports.rejectJoinGroupRequests = rejectJoinGroupRequests;
|
|
|
235
235
|
*
|
|
236
236
|
* > **Note:** This function is only relevant for private groups.
|
|
237
237
|
*
|
|
238
|
-
* The `
|
|
238
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
239
239
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
240
240
|
*
|
|
241
241
|
* > **Notes:**
|
|
@@ -300,22 +300,22 @@ exports.listJoinGroupRequests = listJoinGroupRequests;
|
|
|
300
300
|
* + This function is only relevant for private groups.
|
|
301
301
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
302
302
|
*
|
|
303
|
-
* The `
|
|
303
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
304
304
|
*
|
|
305
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
305
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
306
306
|
*
|
|
307
|
-
* You can refine the query by chaining `
|
|
307
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
308
308
|
*
|
|
309
|
-
* The results of the `
|
|
309
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
310
310
|
*
|
|
311
|
-
* `
|
|
312
|
-
* + [`limit(100)`](
|
|
311
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
312
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
313
313
|
*
|
|
314
|
-
* The following `
|
|
314
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
315
315
|
*
|
|
316
316
|
* | Property | Supported Filters & Sorting |
|
|
317
317
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
318
|
-
* | `status` | [`eq()`](
|
|
318
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
319
319
|
*
|
|
320
320
|
* @public
|
|
321
321
|
* @requiredField groupId
|
|
@@ -5,7 +5,7 @@ import { ApproveJoinGroupRequestsRequest, ApproveJoinGroupRequestsResponse, List
|
|
|
5
5
|
*
|
|
6
6
|
* > **Note:** This function is only relevant for private groups.
|
|
7
7
|
*
|
|
8
|
-
* The `
|
|
8
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
9
9
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
10
10
|
*
|
|
11
11
|
* <!--
|
|
@@ -18,7 +18,7 @@ export declare function approveJoinGroupRequests(payload: ApproveJoinGroupReques
|
|
|
18
18
|
*
|
|
19
19
|
* > **Note:** This function is only relevant for private groups.
|
|
20
20
|
*
|
|
21
|
-
* The `
|
|
21
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
22
22
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
23
23
|
*
|
|
24
24
|
* <!--
|
|
@@ -32,7 +32,7 @@ export declare function rejectJoinGroupRequests(payload: RejectJoinGroupRequests
|
|
|
32
32
|
*
|
|
33
33
|
* > **Note:** This function is only relevant for private groups.
|
|
34
34
|
*
|
|
35
|
-
* The `
|
|
35
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
36
36
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
37
37
|
*
|
|
38
38
|
* > **Notes:**
|
|
@@ -46,22 +46,22 @@ export declare function listJoinGroupRequests(payload: ListJoinGroupRequestsRequ
|
|
|
46
46
|
* + This function is only relevant for private groups.
|
|
47
47
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
48
48
|
*
|
|
49
|
-
* The `
|
|
49
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
50
50
|
*
|
|
51
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
51
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
52
52
|
*
|
|
53
|
-
* You can refine the query by chaining `
|
|
53
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
54
54
|
*
|
|
55
|
-
* The results of the `
|
|
55
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
56
56
|
*
|
|
57
|
-
* `
|
|
58
|
-
* + [`limit(100)`](
|
|
57
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
58
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
59
59
|
*
|
|
60
|
-
* The following `
|
|
60
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
61
61
|
*
|
|
62
62
|
* | Property | Supported Filters & Sorting |
|
|
63
63
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
64
|
-
* | `status` | [`eq()`](
|
|
64
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
65
65
|
*
|
|
66
66
|
*/
|
|
67
67
|
export declare function queryJoinGroupRequests(payload: QueryJoinGroupRequestsRequest): RequestOptionsFactory<QueryJoinGroupRequestsResponse>;
|
|
@@ -188,7 +188,7 @@ function resolveWixSocialGroupsApiV2JoinGroupRequestsServiceUrl(opts) {
|
|
|
188
188
|
*
|
|
189
189
|
* > **Note:** This function is only relevant for private groups.
|
|
190
190
|
*
|
|
191
|
-
* The `
|
|
191
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
192
192
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
193
193
|
*
|
|
194
194
|
* <!--
|
|
@@ -224,7 +224,7 @@ export function approveJoinGroupRequests(payload) {
|
|
|
224
224
|
*
|
|
225
225
|
* > **Note:** This function is only relevant for private groups.
|
|
226
226
|
*
|
|
227
|
-
* The `
|
|
227
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
228
228
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
229
229
|
*
|
|
230
230
|
* <!--
|
|
@@ -261,7 +261,7 @@ export function rejectJoinGroupRequests(payload) {
|
|
|
261
261
|
*
|
|
262
262
|
* > **Note:** This function is only relevant for private groups.
|
|
263
263
|
*
|
|
264
|
-
* The `
|
|
264
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
265
265
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
266
266
|
*
|
|
267
267
|
* > **Notes:**
|
|
@@ -298,22 +298,22 @@ export function listJoinGroupRequests(payload) {
|
|
|
298
298
|
* + This function is only relevant for private groups.
|
|
299
299
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
300
300
|
*
|
|
301
|
-
* The `
|
|
301
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
302
302
|
*
|
|
303
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
303
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
304
304
|
*
|
|
305
|
-
* You can refine the query by chaining `
|
|
305
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
306
306
|
*
|
|
307
|
-
* The results of the `
|
|
307
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
308
308
|
*
|
|
309
|
-
* `
|
|
310
|
-
* + [`limit(100)`](
|
|
309
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
310
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
311
311
|
*
|
|
312
|
-
* The following `
|
|
312
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
313
313
|
*
|
|
314
314
|
* | Property | Supported Filters & Sorting |
|
|
315
315
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
316
|
-
* | `status` | [`eq()`](
|
|
316
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
317
317
|
*
|
|
318
318
|
*/
|
|
319
319
|
export function queryJoinGroupRequests(payload) {
|
|
@@ -271,7 +271,7 @@ export interface ListAllJoinGroupRequestsResponse {
|
|
|
271
271
|
*
|
|
272
272
|
* > **Note:** This function is only relevant for private groups.
|
|
273
273
|
*
|
|
274
|
-
* The `
|
|
274
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
275
275
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
276
276
|
*
|
|
277
277
|
* <!--
|
|
@@ -295,7 +295,7 @@ export interface ApproveJoinGroupRequestsOptions {
|
|
|
295
295
|
*
|
|
296
296
|
* > **Note:** This function is only relevant for private groups.
|
|
297
297
|
*
|
|
298
|
-
* The `
|
|
298
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
299
299
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
300
300
|
*
|
|
301
301
|
* <!--
|
|
@@ -314,7 +314,7 @@ export declare function rejectJoinGroupRequests(groupId: string, rejections: Rej
|
|
|
314
314
|
*
|
|
315
315
|
* > **Note:** This function is only relevant for private groups.
|
|
316
316
|
*
|
|
317
|
-
* The `
|
|
317
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
318
318
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
319
319
|
*
|
|
320
320
|
* > **Notes:**
|
|
@@ -335,22 +335,22 @@ export interface ListJoinGroupRequestsOptions {
|
|
|
335
335
|
* + This function is only relevant for private groups.
|
|
336
336
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
337
337
|
*
|
|
338
|
-
* The `
|
|
338
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
339
339
|
*
|
|
340
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
340
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
341
341
|
*
|
|
342
|
-
* You can refine the query by chaining `
|
|
342
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
343
343
|
*
|
|
344
|
-
* The results of the `
|
|
344
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
345
345
|
*
|
|
346
|
-
* `
|
|
347
|
-
* + [`limit(100)`](
|
|
346
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
347
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
348
348
|
*
|
|
349
|
-
* The following `
|
|
349
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
350
350
|
*
|
|
351
351
|
* | Property | Supported Filters & Sorting |
|
|
352
352
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
353
|
-
* | `status` | [`eq()`](
|
|
353
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
354
354
|
*
|
|
355
355
|
* @public
|
|
356
356
|
* @requiredField groupId
|
|
@@ -83,7 +83,7 @@ const _rejectJoinGroupRequestsResponse = {};
|
|
|
83
83
|
*
|
|
84
84
|
* > **Note:** This function is only relevant for private groups.
|
|
85
85
|
*
|
|
86
|
-
* The `
|
|
86
|
+
* The `approvejoinGroupRequests()` function returns a Promise that resolves when a site member's request to join a group is approved.
|
|
87
87
|
* Only site admins and group admins can approve site member requests to join a group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
88
88
|
*
|
|
89
89
|
* <!--
|
|
@@ -149,7 +149,7 @@ export function approveJoinGroupRequests(groupId, memberIds, options) {
|
|
|
149
149
|
*
|
|
150
150
|
* > **Note:** This function is only relevant for private groups.
|
|
151
151
|
*
|
|
152
|
-
* The `
|
|
152
|
+
* The `rejectjoinGroupRequests()` function returns a Promise that resolves when the site member's request to join a group is rejected.
|
|
153
153
|
* Only site admins or group admins can reject site member requests to join the group, unless the group setting, `membersCanApprove` is set to `true`.
|
|
154
154
|
*
|
|
155
155
|
* <!--
|
|
@@ -211,7 +211,7 @@ export function rejectJoinGroupRequests(groupId, rejections) {
|
|
|
211
211
|
*
|
|
212
212
|
* > **Note:** This function is only relevant for private groups.
|
|
213
213
|
*
|
|
214
|
-
* The `
|
|
214
|
+
* The `listjoinGroupRequests()` function returns a Promise that resolves to a list of up to 100 requests to join a group. Sorts by default to `_createdDate` in descending order.
|
|
215
215
|
* Only site admins and group admins can see requests to join their group. Site members can access their own join requests in their site.
|
|
216
216
|
*
|
|
217
217
|
* > **Notes:**
|
|
@@ -275,22 +275,22 @@ export function listJoinGroupRequests(groupId, options) {
|
|
|
275
275
|
* + This function is only relevant for private groups.
|
|
276
276
|
* + For `SECRET` groups, only site admins and group admins can query requests to join their group. <!-- However, if the `suppressAuth` option is set to `true`, all permissions are overwritten, and all site members (including non-group members) can query requests to join a group. -->
|
|
277
277
|
*
|
|
278
|
-
* The `
|
|
278
|
+
* The `queryjoinGroupRequests()` function builds a query to retrieve a list of all requests to join a group, and returns a [joinGroupRequestsQueryBuilder](#joinGroupRequestsquerybuilder) object.
|
|
279
279
|
*
|
|
280
|
-
* The returned object contains the query definition which is typically used to run the query using the [`find()`](
|
|
280
|
+
* The returned object contains the query definition which is typically used to run the query using the [`find()`](#joinGroupRequestsquerybuilder/find) function.
|
|
281
281
|
*
|
|
282
|
-
* You can refine the query by chaining `
|
|
282
|
+
* You can refine the query by chaining `joinGroupRequestsQueryBuilder` functions onto the query. `joinGroupRequestsQueryBuilder` functions enable you to sort, filter, and control the results that `queryjoinGroupRequests()` returns.
|
|
283
283
|
*
|
|
284
|
-
* The results of the `
|
|
284
|
+
* The results of the `queryjoinGroupRequests()` function are sorted by `_createdDate` in descending order.
|
|
285
285
|
*
|
|
286
|
-
* `
|
|
287
|
-
* + [`limit(100)`](
|
|
286
|
+
* `queryjoinGroupRequests()` runs with this `joinGroupRequestsQueryBuilder` default, which you can override:
|
|
287
|
+
* + [`limit(100)`](#joinGroupRequestsquerybuilder/limit)
|
|
288
288
|
*
|
|
289
|
-
* The following `
|
|
289
|
+
* The following `joinGroupRequestsQueryBuilder` functions are supported for `queryjoinGroupRequests()`. For a full description of the joinGroupRequests object, see the object returned for the [`items`](#joinGroupRequestsqueryresult/items) property in [`joinGroupRequestsQueryResult`](#joinGroupRequestsqueryresult).
|
|
290
290
|
*
|
|
291
291
|
* | Property | Supported Filters & Sorting |
|
|
292
292
|
* | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
293
|
-
* | `status` | [`eq()`](
|
|
293
|
+
* | `status` | [`eq()`](#joinGroupRequestsquerybuilder/eq), [`ne()`](#joinGroupRequestsquerybuilder/ne), [`hasSome()`](#joinGroupRequestsquerybuilder/hasSome), [`or()`](#joinGroupRequestsquerybuilder/or) |
|
|
294
294
|
*
|
|
295
295
|
* @public
|
|
296
296
|
* @requiredField groupId
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wix/groups",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.19",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"registry": "https://registry.npmjs.org/",
|
|
6
6
|
"access": "public"
|
|
@@ -33,5 +33,5 @@
|
|
|
33
33
|
"groupId": "com.wixpress.public-sdk-autogen"
|
|
34
34
|
}
|
|
35
35
|
},
|
|
36
|
-
"falconPackageHash": "
|
|
36
|
+
"falconPackageHash": "ee1b545f35030703fa57e8b52c3c6faad25af2ddc173be3e88df1e6d"
|
|
37
37
|
}
|